NAME

rp2ps - Region-profile to Postscript generator.

Part of the MLKit Standard ML compiler.

SYNOPSIS

rp2ps [-region [filename]]
[-stack [filename]]
[-object regionNo [filename]]
[-sampleMax n]
[-sortByTime | -sortBySize]
[-vert] [-eps width (in|mm|pt)]
[-noOfBands n]
[-comment time string] [-mark time]
[-pregion regionNo] [-print] [-stat] [-findPrgPoint n]
[-source filename] [-name name] [-interact] [-help]

A description of the options are given below.

DESCRIPTION

When invoked, rp2ps reads a profile data file (default is profile.rp) and outputs a Postscript file according to the provided options. Given a profile data file profile.rp, executing

rp2ps -region

will generate a region profile, which will be stored in a file region.ps. To get an overview of which program points allocate data in a particular region, use the -object option (see below).

For the MLKit compiler to generate a profile data file to process with rp2ps , it is necessary to pass the option -prof to the MLKit executable.

To learn more about region profiling with the MLKit, consult the MLKit manual "Programming with Regions in the MLKit", which is available from the MLKit home page and from the distributions. For more information about the MLKit, consult the MLKit home page:

http://melsman.github.io/mlkit

EXAMPLES

For examples, consult the MLKit manual "Programming with Regions in the MLKit", which is available from the MLKit home page and from the distributions.

OPTIONS

-region: Profile all regions with respect to size (default output filename is region.ps).
-stack: Profile stack with respect to size (default output filename is stack.ps).
-object N: Profile all objects in region N. (default output filename is objectN.ps, where N is a region number (region variable id).
-sampleMax: Use only n samples (default is 64).
-sortByTime: Choose samples equally distributed over sample time. This is the default behavior.
-sortBySize: Choose the largest samples. This is not the default behavior.
-vert: Put a vertical line in the region graph for each sample used.
-eps: Produce encapsulated postscript with specified width w in inches (in), millimeters (mm) or points(pt).
-noOfBands N: Maximum number of bands shown on the region graph. Default (and possible maximum) is 20.
-fixedYRange N: Use N (bytes) as fixed range of y-axis, -1 means no fixed range on y-axis.
-useTickNo: Use tick numbers on x-axis instead of elapsed time.
-comment t str: Insert comment str (one word only) at time t in the region graph.
-mark t: Insert mark at time t in the region graph.
-pregion N: Print region information about region variable N on stdout.
-print: Print all profiling data on stdout.
-stat: Print statistics on stdout.
-findPrgPoint N: Print regions containing program point N.
-source name: Specify name of profile data file (default is profile.rp).
-name name: Name to print on top of region graph (default is rp2ps).
-interactive: Enter interactive mode.
-help: Print help information and exit.

EXIT STATUS

Exits with status 0 on success and -1 on failure.

CREDITS

The MLKit (version 2 and beyond) was developed by Lars Birkedal, Martin Elsman, Niels Hallenberg, Tommy H. Olesen, Mads Tofte, and Carsten Varming. People who have contributed with bug-fixes and improvements include Peter Bertelsen, Ken Friis Larsen, Henning Niss, and Peter Sestoft. Nick Rothwell and David N. Turner took part in the development of the MLKit version 1.