| Upstream | cc2ee17 | 1970-01-12 13:46:40 +0000 | [diff] [blame^] | 1 | .TH OPCONTROL 1 "@DATE@" "oprofile @VERSION@" |
| 2 | .UC 4 |
| 3 | .SH NAME |
| 4 | opcontrol \- control OProfile profiling |
| 5 | .SH SYNOPSIS |
| 6 | .br |
| 7 | .B opcontrol |
| 8 | [ |
| 9 | .I options |
| 10 | ] |
| 11 | .SH DESCRIPTION |
| 12 | .B opcontrol |
| 13 | can be used to start profiling, end a profiling session, |
| 14 | dump profile data, and set up the profiling parameters. |
| 15 | |
| 16 | .SH OPTIONS |
| 17 | .TP |
| 18 | .BI "--help" |
| 19 | Show help message. |
| 20 | .br |
| 21 | .TP |
| 22 | .BI "--version" |
| 23 | Show version. |
| 24 | .br |
| 25 | .TP |
| 26 | .BI "--list-events" |
| 27 | Shows the monitorable events. |
| 28 | .br |
| 29 | .TP |
| 30 | .BI "--init" |
| 31 | Load the OProfile module if required and make the OProfile driver |
| 32 | interface available. |
| 33 | .br |
| 34 | .TP |
| 35 | .BI "--setup" |
| 36 | Followed by list options for profiling setup. Store setup |
| 37 | in ~root/.oprofile/daemonrc. Optional. |
| 38 | .br |
| 39 | .TP |
| 40 | .BI "--status" |
| 41 | Show configuration information. |
| 42 | .br |
| 43 | .TP |
| 44 | .BI "--start-daemon" |
| 45 | Start the oprofile daemon without starting profiling. Not available |
| 46 | in 2.2/2.4 kernels. |
| 47 | .br |
| 48 | .TP |
| 49 | .BI "--start" |
| 50 | Start data collection with either arguments provided by --setup |
| 51 | of information saved in ~root/.oprofile/daemonrc. |
| 52 | .br |
| 53 | .TP |
| 54 | .BI "--dump" |
| 55 | Force a flush of the collected profiling data to the daemon. |
| 56 | .br |
| 57 | .TP |
| 58 | .BI "--stop" |
| 59 | Stop data collection. Not available in 2.2/2.4 kernels. |
| 60 | .br |
| 61 | .TP |
| 62 | .BI "--shutdown" |
| 63 | Stop data collection and kill the daemon. |
| 64 | .br |
| 65 | .TP |
| 66 | .BI "--reset" |
| 67 | Clear out data from current session, but leaves saved sessions. |
| 68 | .br |
| 69 | .TP |
| 70 | .BI "--save="sessionname |
| 71 | Save data from current session to sessionname. |
| 72 | .br |
| 73 | .TP |
| 74 | .BI "--deinit" |
| 75 | Shut down daemon. Unload the oprofile module and oprofilefs. |
| 76 | .br |
| 77 | .TP |
| 78 | .BI "--buffer-size="num |
| 79 | Set kernel buffer to num samples. |
| 80 | .br |
| 81 | .TP |
| 82 | .BI "--cpu-buffer-size="num |
| 83 | Set kernel per cpu buffer to num samples (2.6 only). If you profile at high |
| 84 | rate it can help to increase this if the log file show excessive count of |
| 85 | sample lost cpu buffer overflow. |
| 86 | .br |
| 87 | .TP |
| 88 | .BI "--event="[event|"default"] |
| 89 | Add an event to measure for the hardware performance counters, |
| 90 | or "default" for the default event. The event is of the form |
| 91 | "CPU_CLK_UNHALTED:30000:0:1:1" where the numeric values are |
| 92 | count, unit mask, kernel-space counting, user-space counting, |
| 93 | respectively. |
| 94 | .br |
| 95 | .TP |
| 96 | .BI "--separate="[none,lib,kernel,thread,cpu,all] |
| 97 | Separate samples based on the given separator. 'lib' separates |
| 98 | dynamically linked library samples per application. 'kernel' separates |
| 99 | kernel and kernel module samples per application; 'kernel' |
| 100 | implies 'library'. 'thread' gives separation for each thread and |
| 101 | task. 'cpu' separates for each CPU. 'all' implies all of the above |
| 102 | options and 'none' turns off separation. |
| 103 | .br |
| 104 | .TP |
| 105 | .BI "--callgraph=#depth" |
| 106 | Enable callgraph sample collection with a maximum depth. Use 0 to disable |
| 107 | callgraph profiling. This option is currently only usable on x86, using a |
| 108 | 2.6+ kernel with callgraph support enabled. |
| 109 | .br |
| 110 | .TP |
| 111 | .BI "--image="[name,name...|"all"] |
| 112 | Only profile the given absolute paths to binaries, or "all" to profile |
| 113 | everything (the default). |
| 114 | .br |
| 115 | .TP |
| 116 | .BI "--vmlinux="file |
| 117 | vmlinux kernel image. |
| 118 | .br |
| 119 | .TP |
| 120 | .BI "--no-vmlinux" |
| 121 | Use this when you don't have a kernel vmlinux file, and you don't want to |
| 122 | profile the kernel. |
| 123 | .br |
| 124 | .TP |
| 125 | .BI "--verbose" |
| 126 | Be verbose in the daemon log. This has a high overhead. |
| 127 | .br |
| 128 | .TP |
| 129 | .BI "--kernel-range="start,end |
| 130 | Set kernel range vma address in hexadecimal. |
| 131 | |
| 132 | .SH ENVIRONMENT |
| 133 | No special environment variables are recognised by opreport. |
| 134 | |
| 135 | .SH FILES |
| 136 | .TP |
| 137 | .I /root/.oprofile/daemonrc |
| 138 | Configuration file for opcontrol |
| 139 | .TP |
| 140 | .I /var/lib/oprofile/samples/ |
| 141 | The location of the generated sample files. |
| 142 | |
| 143 | .SH VERSION |
| 144 | .TP |
| 145 | This man page is current for @PACKAGE@-@VERSION@. |
| 146 | |
| 147 | .SH SEE ALSO |
| 148 | .BR @OP_DOCDIR@, |
| 149 | .BR oprofile(1) |