osfmk/pmc/pmc.h

47  * 4. Performance Counter Reservations (pmc_reservation_t) - represents a config along
157  * @discussion Method should free a pmc config object created with a pmc_create_config_method_t above
158  * @param pmc The pmc object used to create the config
159  * @param config The config object to release
161 typedef void (*pmc_free_config_method_t)(pmc_object_t pmc, pmc_config_object_t config);
164  * @abstract A pointer to a method to set a key-value pair on a config object.
167  * @param config Pointer to config object.
172 typedef kern_return_t (*pmc_config_set_value_method_t)(pmc_config_object_t config, uint8_t id, uint64_t value);
184  * @param config A configuration object
188 typedef kern_return_t (*pmc_config_set_interrupt_threshold_method_t)(pmc_config_object_t config, uint64_t threshold);
192  * @param config A configuration object.
197 typedef kern_return_t (*pmc_config_set_interrupt_threshold_handler_method_t)(pmc_config_object_t config, void *target, pmc_interrupt_method_t method, void *refCon);
203  * @param config A configuration object.
205 typedef kern_return_t (*pmc_set_config_method_t)(pmc_object_t pmc, pmc_config_object_t config);
401  * Basic usage is as follows: find your target counter, create a config for it, setup the config,
402  * reserve the counter using that config in a given execution context (system, or 1 task, or 1 thread),
528 	pmc_config_t config;			// counter configuration
556  * @param config A value-return configuration object.
558 kern_return_t pmc_create_config(pmc_t pmc, pmc_config_t *config);
564  * @param config A configuration object to be released.
566 void pmc_free_config(pmc_t pmc, pmc_config_t config);
574 kern_return_t pmc_config_set_value(pmc_t pmc, pmc_config_t config, uint8_t id, uint64_t value);
582 kern_return_t pmc_config_set_interrupt_threshold(pmc_t pmc, pmc_config_t config, uint64_t threshold, pmc_interrupt_method_t method, void *refCon);
640  * @param config The configuration object to use with the given pmc.
643  *	KERN_SUCCESS: The given pmc was successfully reserved in system-scope; the given config object has been consumed and should not be freed by the caller,
648 kern_return_t pmc_reserve(pmc_t pmc, pmc_config_t config, pmc_reservation_t *reservation);
656  * @param config The configuration object to use.
661 kern_return_t pmc_reserve_task(pmc_t pmc, pmc_config_t config, task_t task, pmc_reservation_t *reservation);
668  * @param config The configuration object to use.
673 kern_return_t pmc_reserve_thread(pmc_t pmc, pmc_config_t config, thread_t thread, pmc_reservation_t *reservation);