/
fprof.html
1351 lines (1025 loc) · 52.4 KB
/
fprof.html
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>fprof</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="css/main.css" type="text/css" media="screen" />
<script src="js/main.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'>
<tr>
<td class="file-title"><span class="file-title-prefix">Module</span><br />fprof</td>
<td align="right">
</td>
</tr>
</table>
<div id="bodyContent">
<div id="content">
<div class="description">
<p>This module is used to profile a program
to find out how the execution time is used.
Trace to file is used to minimize
runtime performance impact.
</p>
<p>The <tt>fprof</tt> module uses tracing to collect profiling data,
hence there is no need for special compilation of any module to
be profiled. When it starts tracing, <tt>fprof</tt> will erase all
previous tracing in the node and set the necessary trace flags
on the profiling target processes as well as local call trace on
all functions in all loaded modules and all modules to be loaded.
<tt>fprof</tt> erases all tracing in the node when it stops tracing.
</p>
<p><tt>fprof</tt> presents both <em>own time</em> i.e how much time a
function has used for its own execution, and
<em>accumulated time</em> i.e including called functions.
All presented times are
collected using trace timestamps. <tt>fprof</tt> tries to collect
cpu time timestamps, if the host machine OS supports it.
Therefore the times may be wallclock times and OS scheduling will
randomly strike all called functions in a presumably fair way.
</p>
<p>If, however, the profiling time is short, and the host machine
OS does not support high resolution cpu time measurements, some
few OS schedulings may show up as ridicously long execution
times for functions doing practically nothing. An example of a
function more or less just composing a tuple in about 100 times
the normal execution time has been seen, and when the tracing
was repeated, the execution time became normal.
</p>
<p>Profiling is essentially done in 3 steps:</p>
<taglist>
<tag><tt>1</tt></tag>
<item>Tracing; to file, as mentioned in the previous
paragraph. The trace contains entries for function calls,
returns to function, process scheduling, other process related
(spawn, etc) events, and garbage collection. All trace entries
are timestamped.</item>
<tag><tt>2</tt></tag>
<item>Profiling; the trace file is read, the execution call
stack is simulated, and raw profile data is calculated from
the simulated call stack and the trace timestamps. The profile
data is stored in the <tt>fprof</tt> server state. During this
step the trace data may be dumped in text format to file or
console. </item>
<tag><tt>3</tt></tag>
<item>Analysing; the raw profile data is sorted, filtered and
dumped in text format either to file or console. The text
format intended to be both readable for a human reader, as
well as parsable with the standard erlang parsing tools.</item>
</taglist>
<p>Since <tt>fprof</tt> uses trace to file, the runtime performance
degradation is minimized, but still far from negligible,
especially for programs that use the filesystem heavily by
themselves. Where you place the trace file is also important,
e.g on Solaris <tt>/tmp</tt> is usually a good choice since it is
essentially a RAM disk, while any NFS (network) mounted disk is
a bad idea.
</p>
<p><tt>fprof</tt> can also skip the file step and trace to a tracer
process that does the profiling in runtime.
<marker id="start"/>
</p>
</div>
<div class="sectiontitle">Contents</div>
<ul>
<li><a href="#">Analysis format</a></li>
<li><a href="#">Notes</a></li>
<li><a href="#">See Also</a></li>
</ul>
<div class="sectiontitle">Functions</div>
<ul>
<li><a href="#analyseOptiongtokerrorReasonEXITServerPidReason">analyse([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#analyseOptionNameOptionValuegtokerrorReasonEXITServerPidReason">analyse({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#analyseOptionNamegtokerrorReasonEXITServerPidReason">analyse(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#analysegtokerrorReasonEXITServerPidReason">analyse() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#analyseOptionNameOptionValuegtokerrorReasonEXITServerPidReason">analyse(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#applyFuncArgsOptionListgtterm">apply(Func, Args, OptionList) -> term()</a></li>
<li><a href="#applyModuleFunctionArgsOptionListgtterm">apply(Module, Function, Args, OptionList) -> term()</a></li>
<li><a href="#applyModuleFunctionArgsgtterm">apply(Module, Function, Args) -> term()</a></li>
<li><a href="#applyFuncArgsgtterm">apply(Func, Args) -> term()</a></li>
<li><a href="#profileOptiongtokokTracererrorReasonEXITServerPidReason">profile([Option]) -> ok | {ok, Tracer} | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#profileOptionNameOptionValuegtokerrorReasonEXITServerPidReason">profile({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#profileOptionNamegtokerrorReasonEXITServerPidReason">profile(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#profilegtokerrorReasonEXITServerPidReason">profile() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#profileOptionNameOptionValuegtokerrorReasonEXITServerPidReason">profile(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#startgtokPiderroralready_startedPid">start() -> {ok, Pid} | {error, {already_started, Pid}}</a></li>
<li><a href="#stopReasongtok">stop(Reason) -> ok</a></li>
<li><a href="#stopgtok">stop() -> ok</a></li>
<li><a href="#traceverboseFilenamegtokerrorReasonEXITServerPidReason">trace(verbose, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#traceOptionNameOptionValuegtokerrorReasonEXITServerPidReason">trace(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#traceverbosegtokerrorReasonEXITServerPidReason">trace(verbose) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#tracestartFilenamegtokerrorReasonEXITServerPidReason">trace(start, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#traceOptiongtokerrorReasonEXITServerPidReason">trace([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#traceOptionNamegtokerrorReasonEXITServerPidReason">trace(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
<li><a href="#traceOptionNameOptionValuegtokerrorReasonEXITServerPidReason">trace({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</a></li>
</ul>
<div class="sectiontitle">Analysis format</div>
<div class="description">
<marker id="analysis"/>
<title>Analysis format</title>
<p>This section describes the output format of the analyse
command. See <seealso marker="#analyse">analyse/0</seealso>.
</p>
<p>The format is parsable with the standard Erlang parsing tools
<tt>erl_scan</tt> and <tt>erl_parse</tt>, <tt>file:consult/1</tt> or
<tt>io:read/2</tt>. The parse format is not explained here - it
should be easy for the interested to try it out. Note that some
flags to <tt>analyse/1</tt> will affect the format.
</p>
<p>The following example was run on OTP/R8 on Solaris 8, all OTP
internals in this example are very version dependent.
</p>
<p>As an example, we will use the following function, that you may
recogise as a slightly modified benchmark function from the
manpage file(3):</p>
<pre><![CDATA[
-module(foo).
-export([create_file_slow/2]).
create_file_slow(Name, N) when integer(N), N >= 0 ->
{ok, FD} =
file:open(Name, [raw, write, delayed_write, binary]),
if N > 256 ->
ok = file:write(FD,
lists:map(fun (X) -> <<X:32/unsigned>> end,
lists:seq(0, 255))),
ok = create_file_slow(FD, 256, N);
true ->
ok = create_file_slow(FD, 0, N)
end,
ok = file:close(FD).
create_file_slow(FD, M, M) ->
ok;
create_file_slow(FD, M, N) ->
ok = file:write(FD, <<M:32/unsigned>>),
create_file_slow(FD, M+1, N).]]></pre>
<p>Let us have a look at the printout after running:</p>
<pre>
1> <tt>fprof:apply(foo, create_file_slow, [junk, 1024]).</tt><br/>
2> <tt>fprof:profile().</tt><br/>
3> <tt>fprof:analyse().</tt><br/></pre>
<p>The printout starts with:</p>
<pre>
%% Analysis results:
{ analysis_options,
[{callers, true},
{sort, acc},
{totals, false},
{details, true}]}.
% CNT ACC OWN
[{ totals, 9627, 1691.119, 1659.074}]. %%%</pre>
<p>The CNT column shows the total number of function calls that
was found in the trace. In the ACC column is the total time of
the trace from first timestamp to last. And in the OWN
column is the sum of the execution time in functions found in the
trace, not including called functions. In this case it is very
close to the ACC time since the emulator had practically nothing
else to do than to execute our test program.
</p>
<p>All time values in the printout are in milliseconds.
</p>
<p>The printout continues:</p>
<pre>
% CNT ACC OWN
[{ "<0.28.0>", 9627,undefined, 1659.074}]. %%</pre>
<p>This is the printout header of one process. The printout
contains only this one process since we did <tt>fprof:apply/3</tt>
which traces only the current process. Therefore the CNT and
OWN columns perfectly matches the totals above. The ACC column is
undefined since summing the ACC times of all calls in the process
makes no sense - you would get something like the ACC value from
totals above multiplied by the average depth of the call stack,
or something.
</p>
<p>All paragraphs up to the next process header only concerns
function calls within this process.
</p>
<p>Now we come to something more interesting:</p>
<pre>
{[{undefined, 0, 1691.076, 0.030}],
{ {fprof,apply_start_stop,4}, 0, 1691.076, 0.030}, %
[{{foo,create_file_slow,2}, 1, 1691.046, 0.103},
{suspend, 1, 0.000, 0.000}]}.
{[{{fprof,apply_start_stop,4}, 1, 1691.046, 0.103}],
{ {foo,create_file_slow,2}, 1, 1691.046, 0.103}, %
[{{file,close,1}, 1, 1398.873, 0.019},
{{foo,create_file_slow,3}, 1, 249.678, 0.029},
{{file,open,2}, 1, 20.778, 0.055},
{{lists,map,2}, 1, 16.590, 0.043},
{{lists,seq,2}, 1, 4.708, 0.017},
{{file,write,2}, 1, 0.316, 0.021}]}. </pre>
<p>The printout consists of one paragraph per called function. The
function <em>marked</em> with '%' is the one the paragraph
concerns - <tt>foo:create_file_slow/2</tt>. Above the marked
function are the <em>calling</em> functions - those that has
called the marked, and below are those <em>called</em> by the
marked function.
</p>
<p>The paragraphs are per default sorted in decreasing order of
the ACC column for the marked function. The calling list and
called list within one paragraph are also per default sorted in
decreasing order of their ACC column.
</p>
<p>The columns are: CNT - the number of times the funcion
has been called, ACC - the time spent in the
function including called functions, and OWN - the
time spent in the function not including called
functions.
</p>
<p>The rows for the <em>calling</em> functions contain statistics
for the <em>marked</em> function with the constraint that only
the occasions when a call was made from the <em>row's</em>
function to the <em>marked</em> function are accounted for.
</p>
<p>The row for the <em>marked</em> function simply contains the
sum of all <em>calling</em> rows.
</p>
<p>The rows for the <em>called</em> functions contains statistics
for the <em>row's</em> function with the constraint that only the
occasions when a call was made from the <em>marked</em> to the
<em>row's</em> function are accounted for.
</p>
<p>So, we see that <tt>foo:create_file_slow/2</tt> used very little
time for its own execution. It spent most of its time in
<tt>file:close/1</tt>. The function <tt>foo:create_file_slow/3</tt>
that writes 3/4 of the file contents is the second biggest time
thief.
</p>
<p>We also see that the call to <tt>file:write/2</tt> that writes
1/4 of the file contents takes very little time in itself. What
takes time is to build the data (<tt>lists:seq/2</tt> and
<tt>lists:map/2</tt>).
</p>
<p>The function 'undefined' that has called
<tt>fprof:apply_start_stop/4</tt> is an unknown function because that
call was not recorded in the trace. It was only recorded
that the execution returned from
<tt>fprof:apply_start_stop/4</tt> to some other function above in
the call stack, or that the process exited from there.
</p>
<p>Let us continue down the printout to find:</p>
<pre>
{[{{foo,create_file_slow,2}, 1, 249.678, 0.029},
{{foo,create_file_slow,3}, 768, 0.000, 23.294}],
{ {foo,create_file_slow,3}, 769, 249.678, 23.323}, %
[{{file,write,2}, 768, 220.314, 14.539},
{suspend, 57, 6.041, 0.000},
{{foo,create_file_slow,3}, 768, 0.000, 23.294}]}. </pre>
<p>If you compare with the code you will see there also that
<tt>foo:create_file_slow/3</tt> was called only from
<tt>foo:create_file_slow/2</tt> and itself, and called only
<tt>file:write/2</tt>, note the number of calls to
<tt>file:write/2</tt>. But here we see that <tt>suspend</tt> was
called a few times. This is a pseudo function that indicates
that the process was suspended while executing in
<tt>foo:create_file_slow/3</tt>, and since there is no
<tt>receive</tt> or <tt>erlang:yield/0</tt> in the code, it must be
Erlang scheduling suspensions, or the trace file driver
compensating for large file write operations (these are regarded
as a shedule out followed by a shedule in to the same process).
</p>
<p/>
<p>Let us find the <tt>suspend</tt> entry:</p>
<pre>
{[{{file,write,2}, 53, 6.281, 0.000},
{{foo,create_file_slow,3}, 57, 6.041, 0.000},
{{prim_file,drv_command,4}, 50, 4.582, 0.000},
{{prim_file,drv_get_response,1}, 34, 2.986, 0.000},
{{lists,map,2}, 10, 2.104, 0.000},
{{prim_file,write,2}, 17, 1.852, 0.000},
{{erlang,port_command,2}, 15, 1.713, 0.000},
{{prim_file,drv_command,2}, 22, 1.482, 0.000},
{{prim_file,translate_response,2}, 11, 1.441, 0.000},
{{prim_file,'-drv_command/2-fun-0-',1}, 15, 1.340, 0.000},
{{lists,seq,4}, 3, 0.880, 0.000},
{{foo,'-create_file_slow/2-fun-0-',1}, 5, 0.523, 0.000},
{{erlang,bump_reductions,1}, 4, 0.503, 0.000},
{{prim_file,open_int_setopts,3}, 1, 0.165, 0.000},
{{prim_file,i32,4}, 1, 0.109, 0.000},
{{fprof,apply_start_stop,4}, 1, 0.000, 0.000}],
{ suspend, 299, 32.002, 0.000}, %
[ ]}.</pre>
<p>We find no particulary long suspend times, so no function seems
to have waited in a receive statement. Actually,
<tt>prim_file:drv_command/4</tt> contains a receive statement, but
in this test program, the message lies in the process receive
buffer when the receive statement is entered. We also see that
the total suspend time for the test run is small.
</p>
<p>The <tt>suspend</tt> pseudo function has got an OWN time of
zero. This is to prevent the process total OWN time from
including time in suspension. Whether suspend time is really ACC
or OWN time is more of a philosophical question.
</p>
<p>Now we look at another interesting pesudo function,
<tt>garbage_collect</tt>:</p>
<pre>
{[{{prim_file,drv_command,4}, 25, 0.873, 0.873},
{{prim_file,write,2}, 16, 0.692, 0.692},
{{lists,map,2}, 2, 0.195, 0.195}],
{ garbage_collect, 43, 1.760, 1.760}, %
[ ]}.</pre>
<p>Here we see that no function distinguishes itself considerably,
which is very normal.
</p>
<p>The <tt>garbage_collect</tt> pseudo function has not got an OWN
time of zero like <tt>suspend</tt>, instead it is equal to the ACC
time.
</p>
<p>Garbage collect often occurs while a process is suspended, but
<tt>fprof</tt> hides this fact by pretending that the suspended
function was first unsuspended and then garbage
collected. Otherwise the printout would show
<tt>garbage_collect</tt> being called from <tt>suspend</tt> but not
not which function that might have caused the garbage
collection.
</p>
<p>Let us now get back to the test code:</p>
<pre>
{[{{foo,create_file_slow,3}, 768, 220.314, 14.539},
{{foo,create_file_slow,2}, 1, 0.316, 0.021}],
{ {file,write,2}, 769, 220.630, 14.560}, %
[{{prim_file,write,2}, 769, 199.789, 22.573},
{suspend, 53, 6.281, 0.000}]}. </pre>
<p>Not unexpectedly, we see that <tt>file:write/2</tt> was called
from <tt>foo:create_file_slow/3</tt> and
<tt>foo:create_file_slow/2</tt>. The number of calls in each case as
well as the used time are also just confirms the previous results.
</p>
<p>We see that <tt>file:write/2</tt> only calls
<tt>prim_file:write/2</tt>, but let us refrain from digging into the
internals of the kernel application.
</p>
<p>But, if we nevertheless <em>do</em> dig down we find
the call to the linked in driver that does the file operations
towards the host operating system:</p>
<pre>
{[{{prim_file,drv_command,4}, 772, 1458.356, 1456.643}],
{ {erlang,port_command,2}, 772, 1458.356, 1456.643}, %
[{suspend, 15, 1.713, 0.000}]}. </pre>
<p>This is 86 % of the total run time, and as we saw before it
is the close operation the absolutely biggest contributor. We
find a comparision ratio a little bit up in the call stack:</p>
<pre>
{[{{prim_file,close,1}, 1, 1398.748, 0.024},
{{prim_file,write,2}, 769, 174.672, 12.810},
{{prim_file,open_int,4}, 1, 19.755, 0.017},
{{prim_file,open_int_setopts,3}, 1, 0.147, 0.016}],
{ {prim_file,drv_command,2}, 772, 1593.322, 12.867}, %
[{{prim_file,drv_command,4}, 772, 1578.973, 27.265},
{suspend, 22, 1.482, 0.000}]}. </pre>
<p>The time for file operations in the linked in driver
distributes itself as 1 % for open, 11 % for write and 87 % for
close. All data is probably buffered in the operating system
until the close.
</p>
<p>The unsleeping reader may notice that the ACC times for
<tt>prim_file:drv_command/2</tt> and
<tt>prim_file:drv_command/4</tt> is not equal between the
paragraphs above, even though it is easy to beleive that
<tt>prim_file:drv_command/2</tt> is just a passthrough function.
</p>
<p>The missing time can be found in the paragraph
for <tt>prim_file:drv_command/4</tt> where it is evident that not
only <tt>prim_file:drv_command/2</tt> is called but also a fun:
</p>
<pre>
{[{{prim_file,drv_command,2}, 772, 1578.973, 27.265}],
{ {prim_file,drv_command,4}, 772, 1578.973, 27.265}, %
[{{erlang,port_command,2}, 772, 1458.356, 1456.643},
{{prim_file,'-drv_command/2-fun-0-',1}, 772, 87.897, 12.736},
{suspend, 50, 4.582, 0.000},
{garbage_collect, 25, 0.873, 0.873}]}. </pre>
<p>And some more missing time can be explained by the fact that
<tt>prim_file:open_int/4</tt> both calls
<tt>prim_file:drv_command/2</tt> directly as well as through
<tt>prim_file:open_int_setopts/3</tt>, which complicates the
picture.
</p>
<pre>
{[{{prim_file,open,2}, 1, 20.309, 0.029},
{{prim_file,open_int,4}, 1, 0.000, 0.057}],
{ {prim_file,open_int,4}, 2, 20.309, 0.086}, %
[{{prim_file,drv_command,2}, 1, 19.755, 0.017},
{{prim_file,open_int_setopts,3}, 1, 0.360, 0.032},
{{prim_file,drv_open,2}, 1, 0.071, 0.030},
{{erlang,list_to_binary,1}, 1, 0.020, 0.020},
{{prim_file,i32,1}, 1, 0.017, 0.017},
{{prim_file,open_int,4}, 1, 0.000, 0.057}]}.
.
.
.
{[{{prim_file,open_int,4}, 1, 0.360, 0.032},
{{prim_file,open_int_setopts,3}, 1, 0.000, 0.016}],
{ {prim_file,open_int_setopts,3}, 2, 0.360, 0.048}, %
[{suspend, 1, 0.165, 0.000},
{{prim_file,drv_command,2}, 1, 0.147, 0.016},
{{prim_file,open_int_setopts,3}, 1, 0.000, 0.016}]}. </pre>
</div>
<div class="sectiontitle">Notes</div>
<div class="description">
<title>Notes</title>
<p>The actual supervision of execution times is in itself a
CPU intensive activity. A message is written on the trace file
for every function call that is made by the profiled code.
</p>
<p>The ACC time calculation is sometimes difficult to make
correct, since it is difficult to define. This happens
especially when a function occurs in several instances in the
call stack, for example by calling itself perhaps through other
functions and perhaps even non-tail recursively.
</p>
<p>To produce sensible results, <tt>fprof</tt> tries not to charge
any function more than once for ACC time. The instance highest
up (with longest duration) in the call stack is chosen.
</p>
<p>Sometimes a function may unexpectedly waste a lot (some 10 ms
or more depending on host machine OS) of OWN (and ACC) time, even
functions that does practically nothing at all. The problem may
be that the OS has chosen to schedule out the
Erlang runtime system process for a while, and if the OS does
not support high resolution cpu time measurements
<tt>fprof</tt> will use wallclock time for its calculations, and
it will appear as functions randomly burn virtual machine time.</p>
</div>
<div class="sectiontitle">See Also</div>
<div class="description">
<title>See Also</title>
<p>dbg(3), <seealso marker="eprof">eprof</seealso>(3), erlang(3),
io(3),
<seealso marker="fprof_chapter">Tools User's Guide</seealso></p>
</div>
<div class="sectiontitle">Exports</div>
<div class="method">
<div class="title">
<a name="startgtokPiderroralready_startedPid"></a><b>start() -> {ok, Pid} | {error, {already_started, Pid}}</b>
</div>
<div class="func_types">
Types:
<p>
<b>Pid = pid()</b><br/>
</p>
</div>
<div class="description">
<p>Starts the <tt>fprof</tt> server.
</p>
<p>Note that it seldom
needs to be started explicitly since it is automatically
started by the functions that need a running server.
<marker id="stop"/>
</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="stopgtok"></a><b>stop() -> ok</b>
</div>
<div class="description">
<p>Same as <tt>stop(normal)</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="stopReasongtok"></a><b>stop(Reason) -> ok</b>
</div>
<div class="func_types">
Types:
<p>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Stops the <tt>fprof</tt> server.
</p>
<p>The supplied <tt>Reason</tt> becomes the exit reason for the
server process. Default Any
<tt>Reason</tt> other than <tt>kill</tt> sends a request to the
server and waits for it to clean up, reply and exit. If
<tt>Reason</tt> is <tt>kill</tt>, the server is bluntly killed.
</p>
<p>If the <tt>fprof</tt> server is not running, this
function returns immediately with the same return value.
</p>
<note>
<p>When the <tt>fprof</tt> server is stopped the
collected raw profile data is lost.</p>
</note>
<marker id="apply"/>
</div>
</div>
<div class="method">
<div class="title">
<a name="applyFuncArgsgtterm"></a><b>apply(Func, Args) -> term()</b>
</div>
<div class="func_types">
Types:
<p>
<b>Func = function() | {Module, Function}</b><br/>
<b>Args = [term()]</b><br/>
<b>Module = atom()</b><br/>
<b>Function = atom()</b><br/>
</p>
</div>
<div class="description">
<p>Same as <tt>apply(Func, Args, [])</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="applyModuleFunctionArgsgtterm"></a><b>apply(Module, Function, Args) -> term()</b>
</div>
<div class="func_types">
Types:
<p>
<b>Args = [term()]</b><br/>
<b>Module = atom()</b><br/>
<b>Function = atom()</b><br/>
</p>
</div>
<div class="description">
<p>Same as <tt>apply({Module, Function}, Args, [])</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="applyFuncArgsOptionListgtterm"></a><b>apply(Func, Args, OptionList) -> term()</b>
</div>
<div class="func_types">
Types:
<p>
<b>Func = function() | {Module, Function}</b><br/>
<b>Args = [term()]</b><br/>
<b>OptionList = [Option]</b><br/>
<b>Module = atom()</b><br/>
<b>Function = atom()</b><br/>
<b>Option = continue | start | {procs, PidList} | TraceStartOption</b><br/>
</p>
</div>
<div class="description">
<p>Calls <tt>erlang:apply(Func, Args)</tt> surrounded by
<tt>trace([start, ...])</tt> and
<tt>trace(stop)</tt>.
</p>
<p>Some effort is made to keep the trace clean from unnecessary
trace messages; tracing is started and stopped from a spawned
process while the <tt>erlang:apply/2</tt> call is made in the
current process, only surrounded by <tt>receive</tt> and
<tt>send</tt> statements towards the trace starting
process. The trace starting process exits when not needed
any more.
</p>
<p>The <tt>TraceStartOption</tt> is any option allowed for
<tt>trace/1</tt>. The options
<tt>[start, {procs, [self() | PidList]} | OptList]</tt>
are given to <tt>trace/1</tt>, where <tt>OptList</tt> is
<tt>OptionList</tt> with <tt>continue</tt>, <tt>start</tt>
and <tt>{procs, _}</tt> options removed.
</p>
<p>The <tt>continue</tt> option inhibits the call to
<tt>trace(stop)</tt> and leaves it up to the caller to stop
tracing at a suitable time.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="applyModuleFunctionArgsOptionListgtterm"></a><b>apply(Module, Function, Args, OptionList) -> term()</b>
</div>
<div class="func_types">
Types:
<p>
<b>Module = atom()</b><br/>
<b>Function = atom()</b><br/>
<b>Args = [term()]</b><br/>
</p>
</div>
<div class="description">
<p>Same as
<tt>apply({Module, Function}, Args, OptionList)</tt>.
</p>
<p><tt>OptionList</tt> is an option list allowed for
<tt>apply/3</tt>.
<marker id="trace"/>
</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="tracestartFilenamegtokerrorReasonEXITServerPidReason"></a><b>trace(start, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Same as <tt>trace([start, {file, Filename}])</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="traceverboseFilenamegtokerrorReasonEXITServerPidReason"></a><b>trace(verbose, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Same as
<tt>trace([start, verbose, {file, Filename}])</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="traceOptionNameOptionValuegtokerrorReasonEXITServerPidReason"></a><b>trace(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>OptionName = atom()</b><br/>
<b>OptionValue = term()</b><br/>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Same as
<tt>trace([{OptionName, OptionValue}])</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="traceverbosegtokerrorReasonEXITServerPidReason"></a><b>trace(verbose) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Same as <tt>trace([start, verbose])</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="traceOptionNamegtokerrorReasonEXITServerPidReason"></a><b>trace(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>OptionName = atom()</b><br/>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Same as <tt>trace([OptionName])</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="traceOptionNameOptionValuegtokerrorReasonEXITServerPidReason"></a><b>trace({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>OptionName = atom()</b><br/>
<b>OptionValue = term()</b><br/>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Same as
<tt>trace([{OptionName, OptionValue}])</tt>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="traceOptiongtokerrorReasonEXITServerPidReason"></a><b>trace([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>Option = start | stop | {procs, PidSpec} | {procs, [PidSpec]} | verbose | {verbose, bool()} | file | {file, Filename} | {tracer, Tracer}</b><br/>
<b>PidSpec = pid() | atom()</b><br/>
<b>Tracer = pid() | port()</b><br/>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Starts or stops tracing.
</p>
<p><tt>PidSpec</tt> and <tt>Tracer</tt> are used in calls to
<tt>erlang:trace(PidSpec, true, [{tracer, Tracer} | Flags])</tt>, and <tt>Filename</tt> is used to call
<tt>dbg:trace_port(file, Filename)</tt>. Please see the
appropriate documentation.</p>
<p>Option description:</p>
<taglist>
<tag><tt>stop</tt></tag>
<item>Stops a running <tt>fprof</tt> trace and clears all tracing
from the node. Either option <tt>stop</tt> or <tt>start</tt> must be
specified, but not both.</item>
<tag><tt>start</tt></tag>
<item>Clears all tracing from the node and starts a new
<tt>fprof</tt> trace. Either option <tt>start</tt> or
<tt>stop</tt> must be specified, but not both.</item>
<tag><tt>verbose</tt>| <tt>{verbose, bool()}</tt></tag>
<item>The options <tt>verbose</tt> or <tt>{verbose, true}</tt>
adds some trace flags that <tt>fprof</tt> does not need, but
that may be interesting for general debugging
purposes. This option is only
allowed with the <tt>start</tt> option.</item>
<tag><tt>cpu_time</tt>| <tt>{cpu_time, bool()}</tt></tag>
<item>The options <tt>cpu_time</tt> or <tt>{cpu_time, true></tt>
makes the timestamps in the trace be in CPU time instead
of wallclock time which is the default. This option is
only allowed with the <tt>start</tt> option.</item>
<tag><tt>{procs, PidSpec}</tt>| <tt>{procs, [PidSpec]}</tt></tag>
<item>Specifies which processes that shall be traced. If
this option is not given, the calling process is
traced. All processes spawned by the traced processes are
also traced.
This option is only allowed with the <tt>start</tt> option.</item>
<tag><tt>file</tt>| <tt>{file, Filename}</tt></tag>
<item>Specifies the filename of the trace.
If the option <tt>file</tt> is given, or none of these
options are given, the file <tt>"fprof.trace"</tt> is used.
This option is only allowed with the <tt>start</tt> option,
but not with the <tt>{tracer, Tracer}</tt> option.</item>
<tag><tt>{tracer, Tracer}</tt></tag>
<item>Specifies that trace to process or port shall be done
instead of trace to file.
This option is only allowed with the <tt>start</tt> option,
but not with the <tt>{file, Filename}</tt> option.</item>
</taglist>
<marker id="profile"/>
</div>
</div>
<div class="method">
<div class="title">
<a name="profilegtokerrorReasonEXITServerPidReason"></a><b>profile() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Same as <tt>profile([])</tt>.</p>
</div>
</div>
<div class="method">