File: exe_verilator_profcfunc.rst

package info (click to toggle)
verilator 5.038-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 162,552 kB
  • sloc: cpp: 139,204; python: 20,931; ansic: 10,222; yacc: 6,000; lex: 1,925; makefile: 1,260; sh: 494; perl: 282; fortran: 22
file content (40 lines) | stat: -rw-r--r-- 1,095 bytes parent folder | download
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
.. Copyright 2003-2025 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0

verilator_profcfunc
===================

Verilator_profcfunc reads a profile report created by gprof.  The names of
the functions are then transformed, assuming the user used Verilator's
--prof-cfuncs, and a report printed showing the percentage of the time,
etc., in each Verilog block.

Due to rounding errors in gprof reports, the input report's percentages may
not total 100%.  In the verilator_profcfunc report this will get
reported as a rounding error.

For an overview of the use of verilator_profcfunc, see :ref:`Profiling`.

verilator_profcfunc Example Usage
---------------------------------

..

    verilator_profcfunc --help
    verilator_profcfunc --version

    verilator_profcfunc gprof.out


verilator_profcfunc Arguments
-----------------------------

.. program:: verilator_profcfunc

.. option:: <filename>

   The :command:`gprof`-generated filename to read data from. Typically "gprof.out".

.. option:: --help

   Displays a help summary, the program version, and exits.