Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, March 14, 2019
 
 

ocamlcp (1)

Name

ocamlcp - The Objective Caml profiling compiler

Synopsis

ocamlcp [ ocamlc options ] [ -p flags ] filename ...

Description



OCAMLCP(1)                  General Commands Manual                 OCAMLCP(1)



NAME
       ocamlcp - The Objective Caml profiling compiler


SYNOPSIS
       ocamlcp [ ocamlc options ] [ -p flags ] filename ...


DESCRIPTION
       The  ocamlcp  command  is a front-end to ocamlc(1) that instruments the
       source code, adding code to record how many times functions are called,
       branches of conditionals are taken, ...  Execution of instrumented code
       produces an execution profile in the file ocamlprof.dump, which can  be
       read using ocamlprof(1).

       ocamlcp accepts the same arguments and options as ocamlc(1).


OPTIONS
       In  addition  to  the  ocamlc(1) options, ocamlcp accepts the following
       option controlling the amount of profiling information:

       -p letters
              The letters indicate which parts of the program should  be  pro-
              filed:

       a      all options

       f      function  calls  : a count point is set at the beginning of each
              function body

       i      if ... then ... else: count points are set in both then and else
              branches

       l      0 loops: a count point is set at the beginning of the loop body

       m      match  branches:  a  count  point is set at the beginning of the
              body of each branch of a pattern-matching

       t      try ... with branches: a count point is set at the beginning  of
              the body of each branch of an exception catcher


       For  instance,  compiling  with ocamlcp -pfilm profiles function calls,
       if ... then ... else ..., loops, and pattern matching.

       Calling ocamlcp(1) without the -p option defaults to -p fm meaning that
       only function calls and pattern matching are profiled.

       Note:  due to the implementation of streams and stream patterns as syn-
       tactic sugar, it is hard to predict what parts  of  stream  expressions
       and  patterns  will  be profiled by a given flag.  To profile a program
       with streams, we recommend using ocamlcp -p a.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/ocaml    |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       ocamlc(1), ocamlprof(1).
       The Objective Caml user's manual, chapter "Profiling".



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source     was     downloaded      from       http://caml.inria.fr/dis-
       trib/ocaml-3.11/ocaml-3.11.2.tar.bz2

       Further information about this software can be found on the open source
       community website at http://www.ocaml.org.



                                                                    OCAMLCP(1)