PMC_NAME_OF_CAPABILITY(3)

πŸ“¦ version 15.1, in freebsd 14.5, freebsd 15.1

πŸ’… PMC_NAME_OF_CAPABILITY(3) β€” human readable names for numeric constants used by pmc(3) and hwpmc(4)

okay so this page is from the Library Functions Manual, and it is giving β€œbestie, what does this number even mean?” energy. It’s all about the little converter functions in libpmc that turn numeric constants into strings you can actually read. no cap, they are useful. πŸ’–


✨ NAME ✨

  • pmc_name_of_capability, pmc_name_of_class, pmc_name_of_cputype, pmc_name_of_disposition, pmc_name_of_event, pmc_name_of_mode, pmc_name_of_state β€” human readable names for numeric constants used by pmc(3) and hwpmc(4)

πŸ“š LIBRARY πŸ“š

Performance Counters Library (libpmc, -lpmc)

🧚 SYNOPSIS 🧚

#include <pmc.h>

const char *
pmc_name_of_capability(enum pmc_caps pc);

const char *
pmc_name_of_class(enum pmc_class pc);

const char *
pmc_name_of_cputype(enum pmc_cputype ct);

const char *
pmc_name_of_disposition(enum pmc_disp pd);

const char *
pmc_name_of_event(enum pmc_event pe);

const char *
pmc_name_of_mode(enum pmc_mode pm);

const char *
pmc_name_of_state(enum pmc_state ps);

🌸 DESCRIPTION 🌸

These convenience functions translate numeric constants used by the Performance Counters Library (libpmc, -lpmc) to const char * pointers to human readable representations of their arguments. Basically they’re the translators, and they ate. πŸ’…

  • pmc_name_of_capability() β€” takes the PMC capability flag given in argument pc and translates it to a human readable string. PMC capabilities are described in pmc(3). ✨
  • pmc_name_of_class() β€” translates the PMC class value specified in argument pc to a human readable name. PMC classes are described in pmc(3). πŸŽ€
  • pmc_name_of_cputype() β€” translates the CPU type value specified in argument ct to a human readable name. CPU types known to the library are described in pmc(3). πŸ¦‹
  • pmc_name_of_disposition() β€” translates the PMC row disposition specified in argument pd to a human readable name. PMC row dispositions are described in hwpmc(4). 🌈
  • pmc_name_of_event() β€” translates the PMC event number specified by argument pe to a string. PMC event names are documented in section β€œEVENT SPECIFIERS” of pmc(3). πŸ”₯
  • pmc_name_of_mode() β€” translates the PMC mode specified by argument pm to a human readable string. PMC modes are described in pmc(3). πŸ‘‘
  • pmc_name_of_state() β€” translates the value of argument ps to a human readable name. ⭐

🫢 IMPLEMENTATION NOTES 🫢

The returned pointers point to static storage inside the PMC library and should not be freed by the caller.

bestie, do NOT free() these pointers, okay? They point to static storage inside the PMC library. Not yours to free. πŸ™ˆ

⭐ RETURN VALUES ⭐

These functions return a non-NULL pointer on successful completion. In case of an error, a NULL pointer is returned and the global variable errno is set to indicate the error.

πŸ’€ ERRORS πŸ’€

A call to these functions may fail with the following errors:

  • [EINVAL] β€” The function argument specified an invalid value.

🌈 SEE ALSO 🌈

pmc(3), pmc_cpuinfo(3), pmc_pmcinfo(3), hwpmc(4)


xoxo, your Debian bestie πŸ’– this page is stamped November 24, 2007, and the footer title is PMC_NAME_OF_CAPABILITY(3). slay. πŸŽ€

πŸ“¦ where this page comes from