1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
(************************************************************************)
(* v * The Coq Proof Assistant / The Coq Development Team *)
(* <O___,, * CNRS-Ecole Polytechnique-INRIA Futurs-Universite Paris Sud *)
(* \VV/ **************************************************************)
(* // * This file is distributed under the terms of the *)
(* * GNU Lesser General Public License Version 2.1 *)
(************************************************************************)
(*i $Id: profile.mli 6621 2005-01-21 17:24:37Z herbelin $ i*)
(*s This program is a small time and allocation profiler for Objective Caml *)
(*i It requires the UNIX library *)
(* Adapted from Christophe Raffalli *)
(* To use it, link it with the program you want to profile (do not forget
"-cclib -lunix -custom unix.cma" among the link options).
To trace a function "f" you first need to get a key for it by using :
let fkey = declare_profile "f";;
(the string is used to print the profile infomation). Warning: this
function does a side effect. Choose the ident you want instead "fkey".
Then if the function has ONE argument add the following just after
the definition of "f" or just after the declare_profile if this one
follows the definition of f.
let f = profile1 fkey f;;
If f has two arguments do the same with profile2, idem with 3, ...
For more arguments than provided in this module, make a new copy of
function profile and adapt for the needed arity.
If you want to profile two mutually recursive functions, you had better
to rename them :
let fkey = declare_profile "f";;
let gkey = declare_profile "g";;
let f' = .... f' ... g'
and g' = .... f' .... g'
;;
let f = profile fkey f';;
let g = profile gkey g';;
Before the program quits, you should call "print_profile ();;". It
produces a result of the following kind:
Function name Own time Total time Own alloc Tot. alloc Calls
f 0.28 0.47 116 116 5 4
h 0.19 0.19 0 0 4 0
g 0.00 0.00 0 0 0 0
others 0.00 0.47 392 508 9
Est. overhead/total 0.00 0.47 2752 3260
- The first column is the name of the function.
- The third column give the time (utime + stime) spent inside the function.
- The second column give the time spend inside the function minus the
time spend in other profiled functions called by it
- The 4th and 5th columns give the same for allocated words
- The 6th and 7th columns give the number of calls to the function and
the number of calls to profiled functions inside the scope of the
current function
Remarks:
- If a function has a polymorphic type, you need to supply it with at
least one argument as in "let f a = profile1 fkey f a;;" (instead of
"let f = profile1 fkey f;;") in order to get generalization of the
type.
- Each line of the form "let f a = profile1 fkey f a;;" in your code
counts for 5 words and each line of the form "let f
= profile1 fkey f;;" counts for 6 words (a word is 4 or 8 bytes
according to the architecture); this is counted for "others".
- Time fields for functions doing a little job is usually non pertinent.
i*)
type profile_key
val set_recording : string -> unit
val print_profile : unit -> unit
val reset_profile : unit -> unit
val init_profile : unit -> unit
val declare_profile : string -> profile_key
val profile1 : profile_key -> ('a -> 'b) -> 'a -> 'b
val profile2 : profile_key -> ('a -> 'b -> 'c) -> 'a -> 'b -> 'c
val profile3 :
profile_key -> ('a -> 'b -> 'c -> 'd) -> 'a -> 'b -> 'c -> 'd
val profile4 :
profile_key -> ('a -> 'b -> 'c -> 'd -> 'e) -> 'a -> 'b -> 'c -> 'd -> 'e
val profile5 :
profile_key ->
('a -> 'b -> 'c -> 'd -> 'e -> 'f) -> 'a -> 'b -> 'c -> 'd -> 'e -> 'f
val profile6 :
profile_key ->
('a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g)
-> 'a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g
val profile7 :
profile_key ->
('a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g -> 'h)
-> 'a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g -> 'h
(* Some utilities to compute the logical and physical sizes and depth
of ML objects *)
(* Print logical size (in words) and depth of its argument *)
(* This function does not disturb the heap *)
val print_logical_stats : 'a -> unit
(* Print physical size, logical size (in words) and depth of its argument *)
(* This function allocates itself a lot (the same order of magnitude
as the physical size of its argument) *)
val print_stats : 'a -> unit
(* Return logical size (first for strings, then for not strings),
(in words) and depth of its argument *)
(* This function allocates itself a lot *)
val obj_stats : 'a -> int * int * int
(* Return physical size of its argument (string part and rest) *)
(* This function allocates itself a lot *)
val obj_shared_size : 'a -> int * int
|
