coz/docs/coz.1
Emery Berger 297d5b37bf Added.
2022-08-11 17:38:18 -04:00

100 lines
2.9 KiB
Groff

.\" Man page generated from reStructuredText.
.
.TH COZ 1 "2017-08-06" "0.2" "User Commands"
.SH NAME
coz \- profiler running experiments on multithreaded code
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
coz run [profiling options] \-\-\- <command> [args]
.sp
coz plot [\-h]
.SH DESCRIPTION
.sp
Coz is a new kind of profiler that unlocks optimization opportunities
missed by traditional profilers. Coz employs a novel technique we call
\fIcausal profiling\fP that measures optimization potential. This
measurement matches developers\(aq assumptions about profilers: that
optimizing highly\-ranked code will have the greatest impact on
performance. Causal profiling measures optimization potential for
serial, parallel, and asynchronous programs without instrumentation of
special handling for library calls and concurrency
primitives. Instead, a causal profiler uses performance experiments to
predict the effect of optimizations. This allows the profiler to
establish causality: "optimizing function X will have effect Y,"
exactly the measurement developers had assumed they were getting all
along.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-\-binary\-scope \ <file pattern>\fR,\fB \ \-b \ <file pattern>
Profile matching executables. Use \(aq%\(aq as a wildcard, or \(aqMAIN\(aq to
include the main executable (default=MAIN)
.TP
.BI \-\-source\-scope \ <file pattern>\fR,\fB \ \-s \ <file pattern>
Profile matching source files. Use \(aq%\(aq as a wildcard. (default=%)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-progress <source file>:<line number>, \-p <source file>:<line number>
[NOT SUPPORTED] Add a sampling\-based progress point
.UNINDENT
.INDENT 0.0
.TP
.BI \-\-output \ <profile output>\fR,\fB \ \-o \ <profile output>
Profiler output (default=\(gaprofile.coz\(ga)
.TP
.B \-\-end\-to\-end
Run a single performance experiment per\-execution
.UNINDENT
.INDENT 0.0
.TP
.B \-\-fixed\-line <source file>:<line number>
Evaluate optimizations of a specific source line
.TP
.B \-\-fixed\-speedup <speedup> (0\-100)
Evaluate optimizations of a specific amount
.UNINDENT
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
\fI\%http://coz\-profiler.org\fP
.IP \(bu 2
\fBman gdb\fP
.UNINDENT
.SH AUTHOR
Emery Berger - emery@cs.umass.edu, Charlie Curtsinger - curtsinger@grinnell.edu
.SH COPYRIGHT
public domain
.\" Generated by docutils manpage writer.
.