.. SPDX-FileCopyrightText: 2003-2026 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
---------------------------------

.. code-block:: bash

   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.
