[lttng-tools.git] / include / lttng / event-rule / kernel-probe.h

/*
 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef LTTNG_EVENT_RULE_KERNEL_PROBE_H
#define LTTNG_EVENT_RULE_KERNEL_PROBE_H

#include <lttng/event-rule/event-rule.h>

#ifdef __cplusplus
extern "C" {
#endif

struct lttng_kernel_probe_location;

/*
 * Create a newly allocated kernel probe event rule.
 *
 * The location is copied internally.
 *
 * Returns a new event rule on success, NULL on failure. The returned event rule
 * must be destroyed using lttng_event_rule_destroy().
 */
extern struct lttng_event_rule *lttng_event_rule_kernel_probe_create(
		const struct lttng_kernel_probe_location *location);

/*
 * Get the kernel probe location of a kernel probe event rule.
 *
 * The caller does not assume the ownership of the returned location.
 * The location shall only be used for the duration of the event
 * rule's lifetime, or before a different location is set.
 *
 * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's location
 * on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is
 * passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a location was not set prior to
 * this call.
 */
extern enum lttng_event_rule_status lttng_event_rule_kernel_probe_get_location(
		const struct lttng_event_rule *rule,
		const struct lttng_kernel_probe_location **location);

/*
 * Set the name of a kernel probe event rule.
 *
 * The name is copied internally.
 *
 * Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
 * if invalid parameters are passed.
 */
extern enum lttng_event_rule_status lttng_event_rule_kernel_probe_set_event_name(
		struct lttng_event_rule *rule, const char *name);

/*
 * Get the name of a kernel probe event rule.
 *
 * The caller does not assume the ownership of the returned name.
 * The name shall only only be used for the duration of the event
 * rule's lifetime, or before a different name is set.
 *
 * Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's name on
 * success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is passed,
 * or LTTNG_EVENT_RULE_STATUS_UNSET if a name was not set prior to this call.
 */
extern enum lttng_event_rule_status lttng_event_rule_kernel_probe_get_event_name(
		const struct lttng_event_rule *rule, const char **name);

#ifdef __cplusplus
}
#endif

#endif /* LTTNG_EVENT_RULE_KERNEL_PROBE_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
	3	*
	4	* SPDX-License-Identifier: LGPL-2.1-only
	5	*
	6	*/
	7
	8	#ifndef LTTNG_EVENT_RULE_KERNEL_PROBE_H
	9	#define LTTNG_EVENT_RULE_KERNEL_PROBE_H
	10
	11	#include <lttng/event-rule/event-rule.h>
	12
	13	#ifdef __cplusplus
	14	extern "C" {
	15	#endif
	16
	17	struct lttng_kernel_probe_location;
	18
	19	/*
	20	* Create a newly allocated kernel probe event rule.
	21	*
	22	* The location is copied internally.
	23	*
	24	* Returns a new event rule on success, NULL on failure. The returned event rule
	25	* must be destroyed using lttng_event_rule_destroy().
	26	*/
	27	extern struct lttng_event_rule *lttng_event_rule_kernel_probe_create(
	28	const struct lttng_kernel_probe_location *location);
	29
	30	/*
	31	* Get the kernel probe location of a kernel probe event rule.
	32	*
	33	* The caller does not assume the ownership of the returned location.
	34	* The location shall only be used for the duration of the event
	35	* rule's lifetime, or before a different location is set.
	36	*
	37	* Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's location
	38	* on success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is
	39	* passed, or LTTNG_EVENT_RULE_STATUS_UNSET if a location was not set prior to
	40	* this call.
	41	*/
	42	extern enum lttng_event_rule_status lttng_event_rule_kernel_probe_get_location(
	43	const struct lttng_event_rule *rule,
	44	const struct lttng_kernel_probe_location **location);
	45
	46	/*
	47	* Set the name of a kernel probe event rule.
	48	*
	49	* The name is copied internally.
	50	*
	51	* Returns LTTNG_EVENT_RULE_STATUS_OK on success, LTTNG_EVENT_RULE_STATUS_INVALID
	52	* if invalid parameters are passed.
	53	*/
	54	extern enum lttng_event_rule_status lttng_event_rule_kernel_probe_set_event_name(
	55	struct lttng_event_rule rule, const char name);
	56
	57	/*
	58	* Get the name of a kernel probe event rule.
	59	*
	60	* The caller does not assume the ownership of the returned name.
	61	* The name shall only only be used for the duration of the event
	62	* rule's lifetime, or before a different name is set.
	63	*
	64	* Returns LTTNG_EVENT_RULE_STATUS_OK and a pointer to the event rule's name on
	65	* success, LTTNG_EVENT_RULE_STATUS_INVALID if an invalid parameter is passed,
	66	* or LTTNG_EVENT_RULE_STATUS_UNSET if a name was not set prior to this call.
	67	*/
	68	extern enum lttng_event_rule_status lttng_event_rule_kernel_probe_get_event_name(
	69	const struct lttng_event_rule rule, const char *name);
	70
	71	#ifdef __cplusplus
	72	}
	73	#endif
	74
	75	#endif /* LTTNG_EVENT_RULE_KERNEL_PROBE_H */