perfalloc(1) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | BUGS | SEE ALSO | COLOPHON

PERFALLOC(1)             General Commands Manual            PERFALLOC(1)

NAME         top

       perfalloc - notify pmdaperfevent(1) to disable hardware counter
       allocation.

SYNOPSIS         top

       $PCP_PMDAS_DIR/perfevent/perfalloc [-D] [-d] [-f lockfile] [-h]
       [-v] [COMMAND]

DESCRIPTION         top

       perfalloc is a command that notifies the pmdaperfevent(1) to
       disable hardware counter event collection.  This allow
       unprivileged processes to use the hardware counters.

       If the reservation request fails, then perfalloc exits
       immediately with exit code EXIT_FAILURE.  If successful, the
       perfalloc will run until a kill signal is received.  The
       reservation request persists while perfalloc is running.

       Note that pmdaperfevent is affected by the value of the
       kernel.perf_event_paranoid setting, which can be adjusted by
       sysctl(8).

       If a commandline is given, this is executed as a subprocess of
       the agent.  When the command dies, so does the agent.

       A brief description of the command line options follows:

       -D   run in the foreground (the default)

       -d   run in the background

       -f FILE
            use FILE as the lock file (default
            $PCP_PMDAS_DIR/perfevent/perflock)

       -h   display a help message and exit

       -v   output version number and exit

BUGS         top

       There may be a delay of up to 100 miliseconds between perfalloc
       requesting the hardware counter disabling and the perfevent PMDA
       processing the request.

       The perfalloc process does not check the status of the request
       and therefore is not able to provide a positive confirmation that
       the request succeeded and the hardware counters are disabled.

SEE ALSO         top

       pmdaperfevent(1), perfevent.conf(3) and sysctl(8).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at 
       ⟨http://www.pcp.io/⟩.  If you have a bug report for this manual
       page, send it to pcp@groups.io.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2023-12-22.
       (At that time, the date of the most recent commit that was found
       in the repository was 2023-12-16.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

Performance Co-Pilot               PCP                      PERFALLOC(1)

Pages that refer to this page: pmdaperfevent(1)