2007-11-23 12:30:55 +00:00
|
|
|
.\" Copyright (c) 2007 Joseph Koshy. All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" This software is provided by Joseph Koshy ``as is'' and
|
|
|
|
|
.\" any express or implied warranties, including, but not limited to, the
|
|
|
|
|
.\" implied warranties of merchantability and fitness for a particular purpose
|
|
|
|
|
.\" are disclaimed. in no event shall Joseph Koshy be liable
|
|
|
|
|
.\" for any direct, indirect, incidental, special, exemplary, or consequential
|
|
|
|
|
.\" damages (including, but not limited to, procurement of substitute goods
|
|
|
|
|
.\" or services; loss of use, data, or profits; or business interruption)
|
|
|
|
|
.\" however caused and on any theory of liability, whether in contract, strict
|
|
|
|
|
.\" liability, or tort (including negligence or otherwise) arising in any way
|
|
|
|
|
.\" out of the use of this software, even if advised of the possibility of
|
|
|
|
|
.\" such damage.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
|
|
|
|
.Dd November 23, 2007
|
|
|
|
|
.Dt PMC_EVENT_NAMES_OF_CLASS 3
|
2010-04-14 19:08:06 +00:00
|
|
|
.Os
|
2007-11-23 12:30:55 +00:00
|
|
|
.Sh NAME
|
|
|
|
|
.Nm pmc_event_names_of_class
|
|
|
|
|
.Nd return a list of event names supported by a PMC class.
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libpmc
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In pmc.h
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fo pmc_event_names_of_class
|
|
|
|
|
.Fa "enum pmc_class cl"
|
|
|
|
|
.Fa "const char ***eventnames"
|
|
|
|
|
.Fa "int *nevents"
|
|
|
|
|
.Fc
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
Function
|
|
|
|
|
.Fn pmc_event_names_of_class
|
|
|
|
|
retrieves the hardware event names supported by the class of PMC hardware
|
|
|
|
|
specified by argument
|
|
|
|
|
.Fa cl .
|
|
|
|
|
.Pp
|
|
|
|
|
It returns an array of
|
|
|
|
|
.Vt "const char *"
|
|
|
|
|
pointers to names of events supported by the specified class of PMC
|
|
|
|
|
hardware.
|
|
|
|
|
The location pointed to by argument
|
|
|
|
|
.Fa nevents
|
|
|
|
|
is set to the number of event names returned.
|
|
|
|
|
.Pp
|
|
|
|
|
The returned array is allocated using
|
|
|
|
|
.Xr malloc 3 .
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
.Rv -std pmc_event_names_of_class
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
A call to
|
|
|
|
|
.Fn pmc_event_names_of_class
|
|
|
|
|
may fail with the following errors:
|
|
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er EINVAL
|
|
|
|
|
Argument
|
|
|
|
|
.Fa cl
|
|
|
|
|
was invalid.
|
|
|
|
|
.It Bq Er ENOMEM
|
2010-08-16 15:18:30 +00:00
|
|
|
Allocation of a memory area to hold the result failed.
|
2007-11-23 12:30:55 +00:00
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr pmc 3 ,
|
|
|
|
|
.Xr hwpmc 4
|
