NAME | SYNOPSIS | DESCRIPTION | RETURN | ERRORS | SEE ALSO | AUTHOR | COLOPHON

LIBPFM(3)                 Linux Programmer's Manual                LIBPFM(3)

NAME         top

       pfm_get_event_next - iterate over events

SYNOPSIS         top

       #include <perfmon/pfmlib.h>

       int pfm_get_event_next(int idx);

DESCRIPTION         top

       Events are uniquely identified with opaque integer identifiers.
       There is no guaranteed order within identifiers. Thus, to list all
       the events, it is necessary to use iterators.

       Events are grouped in tables within the library. A table usually
       corresponds to a PMU model or family. The library contains support
       for multiple PMU models, thus it has multiple tables. Based on the
       host hardware and software environments, tables get activated when
       the library is initialized via pfm_initialize(). Events from
       activated tables are called active events. Events from non-activated
       tables are called supported events.

       Event identifiers are usually retrieved via pfm_find_event() or when
       encoding events.

       To iterate over a list of events for a given PMU model, all that is
       needed is an initial identifier for the PMU. The first event
       identifier is usually obtained via pfm_get_pmu_info().

       The pfm_get_event_next() function returns the identifier of next
       supported event after the one passed in idx. This iterator stops when
       the last event for the PMU is passed as argument, in which case the
       function returns -1.

       void list_pmu_events(pfm_pmu_t pmu)
       {
          struct pfm_event_info info;
          struct pfm_pmu_info pinfo;
          int i, ret;

          memset(&info, 0, sizeof(info));
          memset(&pinfo, 0, sizeof(pinfo));

          info.size = sizeof(info);
          pinfo.size = sizeof(pinfo);

          ret = pfm_get_pmu_info(pmu, &pinfo);
          if (ret != PFM_SUCCESS)
             errx(1, "cannot get pmu info");

          for (i = pinfo.first_event; i != -1; i = pfm_get_event_next(i)) {
             ret = pfm_get_event_info(i, &info);
             if (ret != PFM_SUCCESS)
               errx(1, "cannot get event info");

               printf("%s Event: %s::%s\n",
                      pinfo.present ? "Active" : "Supported",
                      pinfo.name, info.name);
         }
       }

RETURN         top

       The function returns the identifier of the next supported event. It
       returns -1 when the argument is already the last event for the PMU.

ERRORS         top

       No error code, besides -1, is returned by this function.

SEE ALSO         top

       pfm_find_event(3)

AUTHOR         top

       Stephane Eranian <eranian@gmail.com>

COLOPHON         top

       This page is part of the perfmon2 (a performance monitoring library)
       project.  Information about the project can be found at 
       ⟨http://perfmon2.sourceforge.net/⟩.  If you have a bug report for this
       manual page, send it to perfmon2-devel@lists.sourceforge.net.  This
       page was obtained from the project's upstream Git repository 
       ⟨git://git.code.sf.net/p/perfmon2/libpfm4⟩ on 2017-03-13.  If you dis‐
       cover 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

                               September, 2009                     LIBPFM(3)