gator: Version 5.18
[android-sdk/arm-ds5-gator.git] / README_Streamline.txt
1 \r
2 *** Purpose ***\r
3 \r
4 Instructions on setting up ARM Streamline on the target.\r
5 The gator driver and gator daemon are required to run on the ARM Linux target in order for ARM Streamline to operate. A new early access feature allows the gator daemon can run without the gator driver by using userspace APIs with reduced functionality when using Linux 3.12 or later.\r
6 The driver should be built as a module and the daemon must run with root permissions on the target.\r
7 \r
8 *** Introduction ***\r
9 \r
10 A Linux development environment with cross compiling tools is most likely required, depending on what is already created and provided.\r
11 -For users, the ideal environment is to be given a BSP with gatord and gator.ko already running on a properly configured kernel. In such a scenario, a development environment is not needed, root permission may or may not be needed (gatord must be executed with root permissions but can be automatically started, see below), and the user can run Streamline and profile the system without any setup.\r
12 -The ideal development environment has the kernel source code available to be rebuilt, usually by cross-compiling on a host machine. This environment allows the greatest flexibility in configuring the kernel and building the gator driver module.\r
13 -However, it is possible that a user/developer has a kernel but does not have the source code. In this scenario it may or may not be possible to obtain a valid profile.\r
14         -First, check if the kernel has the proper configuration options (see below). Profiling cannot occur using a kernel that is not configured properly, a new kernel must be created. See if /proc/config.gz exists on the target.\r
15         -Second, given a properly configured kernel, check if the filesystem contains the kernel source/headers, which can be used to re-create the gator driver. These files may be located in different areas, but common locations are /lib/modules/ and /usr/src.\r
16         -If the kernel is not properly configured or sources/headers are not available, the developer is on their own and kernel creation is beyond the scope of this document. Note: It is possible for a module to work when compiled against a similar kernel source code, though this is not guaranteed to work due to differences in kernel structures, exported symbols and incompatible configuration parameters.\r
17         -If the target is running Linux 3.12 or later the kernel driver is not required and userspace APIs will be used instead.\r
18 \r
19 *** Kernel configuration ***\r
20 \r
21 menuconfig options (depending on the kernel version, the location of these configuration settings within menuconfig may differ)\r
22 - General Setup\r
23   - Kernel Performance Events And Counters\r
24     - [*] Kernel performance events and counters (enables CONFIG_PERF_EVENTS)\r
25   - [*] Profiling Support (enables CONFIG_PROFILING)\r
26 - Kernel Features\r
27   - [*] High Resolution Timer Support (enables CONFIG_HIGH_RES_TIMERS)\r
28   - [*] Use local timer interrupts (only required for SMP and for version before Linux 3.12, enables CONFIG_LOCAL_TIMERS)\r
29   - [*] Enable hardware performance counter support for perf events (enables CONFIG_HW_PERF_EVENTS)\r
30 - CPU Power Management\r
31   - CPU Frequency scaling\r
32     - [*] CPU Frequency scaling (enables CONFIG_CPU_FREQ)\r
33 - Kernel hacking\r
34   - [*] Compile the kernel with debug info (optional, enables CONFIG_DEBUG_INFO)\r
35   - [*] Tracers\r
36     - [*] Trace process context switches and events (#)\r
37 \r
38 (#) The "Trace process context switches and events" is not the only option that enables tracing (CONFIG_GENERIC_TRACER or CONFIG_TRACING) and may not be visible in menuconfig as an option if other trace configurations are enabled. Other trace configurations being enabled is sufficient to turn on tracing.\r
39 \r
40 The configuration options:\r
41 CONFIG_GENERIC_TRACER or CONFIG_TRACING\r
42 CONFIG_PROFILING\r
43 CONFIG_HIGH_RES_TIMERS\r
44 CONFIG_LOCAL_TIMERS (for SMP systems)\r
45 CONFIG_PERF_EVENTS and CONFIG_HW_PERF_EVENTS (kernel versions 3.0 and greater)\r
46 CONFIG_DEBUG_INFO (optional, used for analyzing the kernel)\r
47 CONFIG_CPU_FREQ (optional, provides frequency setting of the CPU)\r
48 \r
49 These may be verified on a running system using /proc/config.gz (if this file exists) by running 'zcat /proc/config.gz | grep <option>'. For example, confirming that CONFIG_PROFILING is enabled\r
50         > zcat /proc/config.gz | grep CONFIG_PROFILING\r
51         CONFIG_PROFILING=y\r
52 \r
53 If a device tree is used it must include the pmu bindings, see Documentation/devicetree/bindings/arm/pmu.txt for details.\r
54 \r
55 *** Checking the gator requirements ***\r
56 \r
57 (optional) Use the hrtimer_module utility to validate the kernel High Resolution Timer requirement.\r
58 \r
59 *** Building the gator module ***\r
60 \r
61 To create the gator.ko module,\r
62         cd /path/to/gator/driver-src\r
63         tar xzf gator-driver.tar.gz\r
64         cd gator-driver\r
65         make -C <kernel_build_dir> M=`pwd` ARCH=arm CROSS_COMPILE=<...> modules\r
66 for example when using the linaro-toolchain-binaries\r
67         make -C /home/username/kernel_2.6.32/ M=`pwd` ARCH=arm CROSS_COMPILE=/home/username/gcc-linaro-arm-linux-gnueabihf-4.7-2013.01-20130125_linux/bin/arm-linux-gnueabihf- modules\r
68 If successful, a gator.ko module should be generated\r
69 \r
70 It is also possible to integrate the gator.ko module into the kernel build system\r
71         cd /path/to/kernel/build/dir\r
72         cd drivers\r
73         mkdir gator\r
74         cp -r /path/to/gator/driver-src/* gator\r
75 Edit Makefile in the kernel drivers folder and add this to the end\r
76         obj-$(CONFIG_GATOR)             += gator/\r
77 Edit Kconfig in the kernel drivers folder and add this before the last endmenu\r
78         source "drivers/gator/Kconfig"\r
79 You can now select gator when using menuconfig while configuring the kernel and rebuild as directed\r
80 \r
81 *** Building the gator daemon ***\r
82 \r
83 cd /path/to/gator/daemon-src\r
84 tar -xzf gator-daemon.tar.gz (may need to issue with 'sudo')\r
85 For Linux targets,\r
86         cd gator-daemon\r
87         make CROSS_COMPILE=<...> # For ARMv7 targets\r
88         make -f Makefile_aarch64 CROSS_COMPILE=<...> # For ARMv8 targets\r
89         gatord should now be created\r
90 For Android targets (install the android ndk, see developer.android.com)\r
91         mv gator-daemon jni\r
92         ndk-build\r
93                 or execute /path/to/ndk/ndk-build if the ndk is not on your path\r
94         gatord should now be created and located in libs/armeabi\r
95         If you get an error like the following, upgrade to a more recent version of the android ndk\r
96                 jni/PerfGroup.cpp: In function 'int sys_perf_event_open(perf_event_attr*, pid_t, int, int, long unsigned int)':\r
97                 jni/PerfGroup.cpp:36:17: error: '__NR_perf_event_open' was not declared in this scope\r
98 \r
99 *** Running gator ***\r
100 \r
101 Load the kernel onto the target and copy gatord and gator.ko into the target's filesystem.\r
102 Ensure gatord has execute permissions\r
103         chmod +x gatord\r
104 gator.ko must be located in the same directory as gatord on the target or the location specified with the -m option or already insmod'ed.\r
105 With root privileges, run the daemon\r
106         sudo ./gatord &\r
107 Note: gatord requires libstdc++.so.6 which is usually supplied by the Linux distribution on the target. A copy of libstdc++.so.6 is available in the DS-5 Linux example distribution.\r
108 If gator.ko is not loaded and is not in the same directory as gatord when using Linux 3.12 or later, gatord can run without gator.ko by using userspace APIs. Not all features are supported by userspace gator. If /dev/gator/version does not exist after starting gatord it is running userspace gator.\r
109 \r
110 *** Customizing the l2c-310 Counter ***\r
111 \r
112 The l2c-310 counter in gator_events_l2c-310.c contains hard coded offsets where the L2 cache counter registers are located.  This offset can also be configured via a module parameter specified when gator.ko is loaded, ex:\r
113         insmod gator.ko l2c310_addr=<offset>\r
114 Further, the l2c-310 counter can be disabled by providing an offset of zero, ex:\r
115         insmod gator.ko l2c310_addr=0\r
116 \r
117 *** CCN-504 ***\r
118 \r
119 CCN-504 is disabled by default. To enable CCN-504, insmod gator module with the ccn504_addr=<addr> parameter where addr is the base address of the CCN-504 configuration register space (PERIPHBASE), ex: insmod gator.ko ccn504_addr=0x2E000000.\r
120 \r
121 *** Compiling an application or shared library ***\r
122 \r
123 Recommended compiler settings:\r
124         "-g": Debug information, such as line numbers, needed for best analysis results.\r
125         "-fno-inline": Speed improvement when processing the image files and most accurate analysis results.\r
126         "-fno-omit-frame-pointer": ARM EABI frame pointers (Code Sourcery cross compiler) allow recording of the call stack with each sample taken when in ARM state (i.e. not -mthumb).\r
127         "-marm": This option is required if your compiler is configured with --with-mode=thumb, otherwise call stack unwinding will not work.\r
128 \r
129 *** Hardfloat EABI ***\r
130 Binary applications built for the soft or softfp ABI are not compatible on a hardfloat system. All soft/softfp applications need to be rebuilt for hardfloat. To see if your ARM compiler supports hardfloat, run "gcc -v" and look for --with-float=hard.\r
131 To compile for non-hardfloat targets it is necessary to add options '-marm -march=armv4t -mfloat-abi=soft'. It may also be necessary to provide a softfloat filesystem by adding the option --sysroot, ex: '--sysroot=../DS-5Examples/distribution/filesystem/armv5t_mtx'. The gatord makefile will do this when run as 'make SOFTFLOAT=1 SYSROOT=/path/to/sysroot'\r
132 The armv5t_mtx filesystem is provided as part of the "DS-5 Linux Example Distribution" package which can be downloaded from the DS-5 Downloads page.\r
133 Attempting to run an incompatible binary often results in the confusing error message "No such file or directory" when clearly the file exists.\r
134 \r
135 *** Bugs ***\r
136 \r
137 There is a bug in some Linux kernels where perf misidentifies the CPU type. To see if you are affected by this, run ls /sys/bus/event_source/devices/ and verify the listed processor type matches what is expected. For example, an A9 should show the following.\r
138         # ls /sys/bus/event_source/devices/\r
139         ARMv7_Cortex_A9  breakpoint  software  tracepoint\r
140 To work around the issue try upgrading to a later kernel or comment out the gator_events_perf_pmu_cpu_init(gator_cpu, type); call in gator_events_perf_pmu.c\r
141 \r
142 There is a bug in some Linux kernels where an Oops may occurs when using userspace gator and a core is offlined. The fix was merged into mainline in 3.14-rc5, see http://git.kernel.org/tip/e3703f8cdfcf39c25c4338c3ad8e68891cca3731, and as been backported to older kernels.\r
143 \r
144 If you see this error when using SELinux, ex: Android 4.4 or later\r
145         # ./gatord\r
146         Unable to load (insmod) gator.ko driver:\r
147           >>> gator.ko must be built against the current kernel version & configuration\r
148           >>> See dmesg for more details\r
149         # dmesg\r
150         ...\r
151         <7>[ 6745.475110] SELinux: initialized (dev gatorfs, type gatorfs), not configured for labeling\r
152         <5>[ 6745.477434] type=1400 audit(1393005053.336:10): avc:  denied  { mount } for  pid=1996 comm="gatord-main" name="/" dev="gatorfs" ino=8733 scontext=u:r:shell:s0 tcontext=u:object_r:unlabeled:s0 tclass=filesystem\r
153 disable SELinux so that gatorfs can be mounted by running\r
154         # setenforce 0\r
155 Once gator is started, SELinux can be reenabled\r
156 \r
157 *** Profiling the kernel (optional) ***\r
158 \r
159 CONFIG_DEBUG_INFO must be enabled, see "Kernel configuration" section above.\r
160 Use vmlinux as the image for debug symbols in Streamline.\r
161 Drivers may be profiled using this method by statically linking the driver into the kernel image or adding the driver as an image to Streamline.\r
162 To perform kernel stack unwinding and module unwinding, edit the Makefile to enable GATOR_KERNEL_STACK_UNWINDING and rebuild gator.ko or run "echo 1 > /sys/module/gator/parameters/kernel_stack_unwinding" as root on the target after gatord is started.\r
163 \r
164 *** Automatically start gator on boot (optional) ***\r
165 \r
166 cd /etc/init.d\r
167 vi rungator.sh\r
168         #!/bin/bash\r
169         /path/to/gatord &\r
170 update-rc.d rungator.sh defaults\r
171 \r
172 *** GPL License ***\r
173 \r
174 For license information, please see the file LICENSE after unzipping driver-src/gator-driver.tar.gz.\r