opcontrol.1.in revision cc2ee177dbb3befca43e36cfc56778b006c3d050
OPCONTROL 1 "@DATE@" "oprofile @VERSION@"
C 4
NAME
opcontrol - control OProfile profiling
SYNOPSIS

opcontrol [ options ]

DESCRIPTION
opcontrol can be used to start profiling, end a profiling session, dump profile data, and set up the profiling parameters.
OPTIONS

"--help" Show help message.

"--version" Show version.

"--list-events" Shows the monitorable events.

"--init" Load the OProfile module if required and make the OProfile driver interface available.

"--setup" Followed by list options for profiling setup. Store setup in ~root/.oprofile/daemonrc. Optional.

"--status" Show configuration information.

"--start-daemon" Start the oprofile daemon without starting profiling. Not available in 2.2/2.4 kernels.

"--start" Start data collection with either arguments provided by --setup of information saved in ~root/.oprofile/daemonrc.

"--dump" Force a flush of the collected profiling data to the daemon.

"--stop" Stop data collection. Not available in 2.2/2.4 kernels.

"--shutdown" Stop data collection and kill the daemon.

"--reset" Clear out data from current session, but leaves saved sessions.

"--save="sessionname Save data from current session to sessionname.

"--deinit" Shut down daemon. Unload the oprofile module and oprofilefs.

"--buffer-size="num Set kernel buffer to num samples.

"--cpu-buffer-size="num Set kernel per cpu buffer to num samples (2.6 only). If you profile at high rate it can help to increase this if the log file show excessive count of sample lost cpu buffer overflow.

"--event="[event|"default"] Add an event to measure for the hardware performance counters, or "default" for the default event. The event is of the form "CPU_CLK_UNHALTED:30000:0:1:1" where the numeric values are count, unit mask, kernel-space counting, user-space counting, respectively.

"--separate="[none,lib,kernel,thread,cpu,all] Separate samples based on the given separator. 'lib' separates dynamically linked library samples per application. 'kernel' separates kernel and kernel module samples per application; 'kernel' implies 'library'. 'thread' gives separation for each thread and task. 'cpu' separates for each CPU. 'all' implies all of the above options and 'none' turns off separation.

"--callgraph=#depth" Enable callgraph sample collection with a maximum depth. Use 0 to disable callgraph profiling. This option is currently only usable on x86, using a 2.6+ kernel with callgraph support enabled.

"--image="[name,name...|"all"] Only profile the given absolute paths to binaries, or "all" to profile everything (the default).

"--vmlinux="file vmlinux kernel image.

"--no-vmlinux" Use this when you don't have a kernel vmlinux file, and you don't want to profile the kernel.

"--verbose" Be verbose in the daemon log. This has a high overhead.

"--kernel-range="start,end Set kernel range vma address in hexadecimal.

ENVIRONMENT
No special environment variables are recognised by opreport.
FILES

/root/.oprofile/daemonrc Configuration file for opcontrol

/var/lib/oprofile/samples/ The location of the generated sample files.

VERSION

This man page is current for @PACKAGE@-@VERSION@.

SEE ALSO
@OP_DOCDIR@, oprofile(1)