ftrace_reader: Add End-to-end test

Add an end-to-end integration test for the round trip:
Enabling events -> Start tracing -> Write protozero
-> Stop Tracing -> Disable Events
We test by parsing the resulting proto stream with
real proto to check it is valid.

Getting an end to end test working required a number of tweaks:
0) Turns out you can't stat/seak procfs on Android. So this modifies
   the table building code to avoid that.
1) Move code for dealing with procfs out of ProtoTranslationTable into
   FtraceProcfs where it belongs.
2) Adds code to handle kTypePadding in ParsePage.
3) (Temporary) Add hand rolled parsing code for sched_switch.
4) (Temporary) Adds a testing wrapper proto to protos/ftrace,
   to be replaced with TraceEvent when that lands.
5) (Temporary) Adds a hack to ensure we register ftrace/print even
   when not present in available events.
6) Protozero: Fixes a typo in scattered_stream_writer.h.
7) Protozero: Generate additional methods for fixed length strings.
8) Adjusts the scattered_stream_delegate_for_testing.h to remove gaps
   left by protozero.
9) Changes parsing of print event to be more correct.

Change-Id: I7d588bd4a52072e2c34b00c31124cdde555f6f8d
22 files changed
tree: 09d15d6394259f7882b645850a4ad204d3f02a93
  1. base/
  2. build/
  3. buildtools/
  4. ftrace_reader/
  5. infra/
  6. ipc/
  7. protos/
  8. protozero/
  9. tools/
  10. tracing/
  11. .clang-format
  12. .gitignore
  13. .gn
  14. .travis.yml
  15. BUILD.gn
  16. codereview.settings
  17. MODULE_LICENSE_APACHE2
  18. NOTICE
  19. OWNERS
  20. PRESUBMIT.py
  21. README.md
README.md

Perfetto - Performance instrumentation and logging for POSIX platforms

This project is meant to be built both as part of the Android tree and from a standalone checkout

For internal docs see this page

Supported platforms

Android is the platform targeted in the first milestones. Right now Linux desktop and OSX are maintained best-effort.

Get the code

Prerequisites

All dependent libraries are self-hosted and pulled by the build/install-build-deps script.
The only requirements on the host are python, git and a compiler (preferably clang, gcc is maintained best-effort):
$ sudo apt-get update && sudo apt-get install git clang python

Then:
$ git clone https://android.googlesource.com/platform/external/perfetto.git

Contributing

This project uses Android AOSP Gerrit for code reviews and uses the Google C++ style. Currently targets -std=c++11.

You can use both git cl upload from Chromium depot tools or Android repo to upload patches.

git cl is quite convenient as it supports code auto-formatting via git cl format.

See https://source.android.com/source/contributing for more details about external contributions and CLA signing.

Build instructions

Build from a standalone checkout

If you are a chromium developer and have depot_tools installed you can avoid the build/ prefix below and just use gn/ninja from depot_tools.

$ build/install-build-deps to install third-party build deps (NDK etc)

$ build/gn args out/android to generate build files and enter in the editor:

target_os = "android"          # Leave empty for local testing
target_cpu = "arm" or "arm64"  # Only when building for Android

(See the Build Configurations section below for more)

$ build/ninja -C out/android all

Build from the Android tree

TODO. The plan is to autogenerate the Android.bp build files from the master GN build files (or temporarily maintain both until we can autogenerate them).

Run tests

On the host (Linux / OSX)

$ build/ninja -C out/default (tracing_unittests | tracing_benchmarks)
$ out/default/tracing_unittests --gtest_help

On Android

Either connect a device in ADB mode or use the bundled emulator.

To start the emulator:
$ build/run_android_emulator (arm | arm64) &

To run the tests (either on the emulator or physical device):
$ build/run_android_test out/default tracing_unittests

Build configurations

The following GN args are supported:

target_os = "android" | "linux" | "mac":
Defaults to the current host, set "android" to build for Android.

target_cpu = "arm" | "arm64" | "x86" | "x64":
Defaults to "arm" when target_os == "android", "x64" when targeting the host. 32-bit host builds are not supported.

is_debug = true | false:
Toggles Debug (default) / Release mode.

is_clang = true | false:
Use Clang (default) / GCC. It requires clang 3.5+ to be installed on the host. Clang is the default compiler on Mac (% having installed Xcode). On Linux: sudo apt-get update && sudo apt-get install clang

cc = "gcc" / cxx = "g++":
Uses a different compiler binary (default: autodetected depending on is_clang).

is_asan = true:
Enables Address Sanitizer

is_lsan = true:
Enables Leak Sanitizer
(Linux/Mac only)

is_msan = true:
Enables Memory Sanitizer
(Linux only)

is_tsan = true:
Enables Thread Sanitizer
(Linux/Mac only)

is_ubsan = true:
Enables Undefined Behavior Sanitizer