[lttng-ust.git] / liblttng-ust / ust-events-internal.h

#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
#define _LTTNG_UST_EVENTS_INTERNAL_H

/*
 * ust-events-internal.h
 *
 * Copyright 2019 (c) - Francis Deslauriers <francis.deslauriers@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <stdint.h>

#include <urcu/list.h>
#include <urcu/hlist.h>

#include <helper.h>
#include <lttng/ust-events.h>

struct lttng_event_enabler {
	struct lttng_enabler base;
	struct cds_list_head node;	/* per-session list of enablers */
	struct lttng_channel *chan;
	/*
	 * Unused, but kept around to make it explicit that the tracer can do
	 * it.
	 */
	struct lttng_ctx *ctx;
};

struct lttng_event_notifier_enabler {
	struct lttng_enabler base;
	uint64_t error_counter_index;
	struct cds_list_head node;	/* per-app list of event_notifier enablers */
	struct cds_list_head capture_bytecode_head;
	struct lttng_event_notifier_group *group; /* weak ref */
	uint64_t user_token;		/* User-provided token */
	uint64_t num_captures;
};

enum lttng_ust_bytecode_node_type {
	LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
	LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
};

struct lttng_ust_bytecode_node {
	enum lttng_ust_bytecode_node_type type;
	struct cds_list_head node;
	struct lttng_enabler *enabler;
	struct  {
		uint32_t len;
		uint32_t reloc_offset;
		uint64_t seqnum;
		char data[];
	} bc;
};

struct lttng_ust_excluder_node {
	struct cds_list_head node;
	struct lttng_enabler *enabler;
	/*
	 * struct lttng_ust_event_exclusion had variable sized array,
	 * must be last field.
	 */
	struct lttng_ust_event_exclusion excluder;
};

static inline
struct lttng_enabler *lttng_event_enabler_as_enabler(
		struct lttng_event_enabler *event_enabler)
{
	return &event_enabler->base;
}

static inline
struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
		struct lttng_event_notifier_enabler *event_notifier_enabler)
{
	return &event_notifier_enabler->base;
}

/*
 * Allocate and initialize a `struct lttng_event_enabler` object.
 *
 * On success, returns a `struct lttng_event_enabler`,
 * On memory error, returns NULL.
 */
LTTNG_HIDDEN
struct lttng_event_enabler *lttng_event_enabler_create(
		enum lttng_enabler_format_type format_type,
		struct lttng_ust_event *event_param,
		struct lttng_channel *chan);

/*
 * Destroy a `struct lttng_event_enabler` object.
 */
LTTNG_HIDDEN
void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);

/*
 * Enable a `struct lttng_event_enabler` object and all events related to this
 * enabler.
 */
LTTNG_HIDDEN
int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);

/*
 * Disable a `struct lttng_event_enabler` object and all events related to this
 * enabler.
 */
LTTNG_HIDDEN
int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);

/*
 * Attach filter bytecode program to `struct lttng_event_enabler` and all
 * events related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_enabler_attach_filter_bytecode(
		struct lttng_event_enabler *enabler,
		struct lttng_ust_bytecode_node **bytecode);

/*
 * Attach an application context to an event enabler.
 *
 * Not implemented.
 */
LTTNG_HIDDEN
int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
		struct lttng_ust_context *ctx);

/*
 * Attach exclusion list to `struct lttng_event_enabler` and all
 * events related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
		struct lttng_ust_excluder_node **excluder);

/*
 * Synchronize bytecodes for the enabler and the instance (event or
 * event_notifier).
 *
 * This function goes over all bytecode programs of the enabler (event or
 * event_notifier enabler) to ensure each is linked to the provided instance.
 */
LTTNG_HIDDEN
void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
		struct lttng_ctx **ctx,
		struct cds_list_head *instance_bytecode_runtime_head,
		struct cds_list_head *enabler_bytecode_runtime_head);

/*
 * Allocate and initialize a `struct lttng_event_notifier_group` object.
 *
 * On success, returns a `struct lttng_triggre_group`,
 * on memory error, returns NULL.
 */
LTTNG_HIDDEN
struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);

/*
 * Destroy a `struct lttng_event_notifier_group` object.
 */
LTTNG_HIDDEN
void lttng_event_notifier_group_destroy(
		struct lttng_event_notifier_group *event_notifier_group);

/*
 * Allocate and initialize a `struct lttng_event_notifier_enabler` object.
 *
 * On success, returns a `struct lttng_event_notifier_enabler`,
 * On memory error, returns NULL.
 */
LTTNG_HIDDEN
struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
		struct lttng_event_notifier_group *event_notifier_group,
		enum lttng_enabler_format_type format_type,
		struct lttng_ust_event_notifier *event_notifier_param);

/*
 * Destroy a `struct lttng_event_notifier_enabler` object.
 */
LTTNG_HIDDEN
void lttng_event_notifier_enabler_destroy(
		struct lttng_event_notifier_enabler *event_notifier_enabler);

/*
 * Enable a `struct lttng_event_notifier_enabler` object and all event
 * notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_enable(
		struct lttng_event_notifier_enabler *event_notifier_enabler);

/*
 * Disable a `struct lttng_event_notifier_enabler` object and all event
 * notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_disable(
		struct lttng_event_notifier_enabler *event_notifier_enabler);

/*
 * Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
 * all event notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_attach_filter_bytecode(
		struct lttng_event_notifier_enabler *event_notifier_enabler,
		struct lttng_ust_bytecode_node **bytecode);

/*
 * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
 * all event_notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_attach_capture_bytecode(
		struct lttng_event_notifier_enabler *event_notifier_enabler,
		struct lttng_ust_bytecode_node *bytecode);

/*
 * Attach exclusion list to `struct lttng_event_notifier_enabler` and all
 * event notifiers related to this enabler.
 */
LTTNG_HIDDEN
int lttng_event_notifier_enabler_attach_exclusion(
		struct lttng_event_notifier_enabler *event_notifier_enabler,
		struct lttng_ust_excluder_node **excluder);

LTTNG_HIDDEN
void lttng_free_event_notifier_filter_runtime(
		struct lttng_event_notifier *event_notifier);

/*
 * Connect the probe on all enablers matching this event description.
 * Called on library load.
 */
LTTNG_HIDDEN
int lttng_fix_pending_event_notifiers(void);

LTTNG_HIDDEN
struct lttng_counter *lttng_ust_counter_create(
		const char *counter_transport_name,
		size_t number_dimensions, const struct lttng_counter_dimension *dimensions);

#endif /* _LTTNG_UST_EVENTS_INTERNAL_H */
Commit	Line	Data
d871c65b FD	1	#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
	2	#define _LTTNG_UST_EVENTS_INTERNAL_H
	3
	4	/*
	5	* ust-events-internal.h
	6	*
	7	* Copyright 2019 (c) - Francis Deslauriers <francis.deslauriers@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*/
	27
	28	#include <stdint.h>
	29
	30	#include <urcu/list.h>
	31	#include <urcu/hlist.h>
	32
	33	#include <helper.h>
	34	#include <lttng/ust-events.h>
	35
	36	struct lttng_event_enabler {
	37	struct lttng_enabler base;
	38	struct cds_list_head node; /* per-session list of enablers */
	39	struct lttng_channel *chan;
	40	/*
	41	* Unused, but kept around to make it explicit that the tracer can do
	42	* it.
	43	*/
	44	struct lttng_ctx *ctx;
	45	};
	46
d8d2416d FD	47	struct lttng_event_notifier_enabler {
d8d2416d FD	48	struct lttng_enabler base;
6566528b	49	uint64_t error_counter_index;
d37ecb3f FD	50	struct cds_list_head node; /* per-app list of event_notifier enablers */
d37ecb3f FD	51	struct cds_list_head capture_bytecode_head;
d8d2416d FD	52	struct lttng_event_notifier_group group; / weak ref */
d8d2416d FD	53	uint64_t user_token; /* User-provided token */
d37ecb3f	54	uint64_t num_captures;
d8d2416d FD	55	};
d8d2416d FD	56
ab249ecf FD	57	enum lttng_ust_bytecode_node_type {
ab249ecf FD	58	LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
d37ecb3f	59	LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
ab249ecf FD	60	};
	61
	62	struct lttng_ust_bytecode_node {
	63	enum lttng_ust_bytecode_node_type type;
92495593 FD	64	struct cds_list_head node;
92495593 FD	65	struct lttng_enabler *enabler;
ab249ecf FD	66	struct {
	67	uint32_t len;
	68	uint32_t reloc_offset;
	69	uint64_t seqnum;
	70	char data[];
	71	} bc;
92495593 FD	72	};
	73
	74	struct lttng_ust_excluder_node {
	75	struct cds_list_head node;
	76	struct lttng_enabler *enabler;
	77	/*
	78	* struct lttng_ust_event_exclusion had variable sized array,
	79	* must be last field.
	80	*/
	81	struct lttng_ust_event_exclusion excluder;
	82	};
	83
d871c65b FD	84	static inline
	85	struct lttng_enabler *lttng_event_enabler_as_enabler(
	86	struct lttng_event_enabler *event_enabler)
	87	{
	88	return &event_enabler->base;
	89	}
	90
d8d2416d FD	91	static inline
	92	struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
	93	struct lttng_event_notifier_enabler *event_notifier_enabler)
	94	{
	95	return &event_notifier_enabler->base;
	96	}
d871c65b FD	97
	98	/*
	99	* Allocate and initialize a `struct lttng_event_enabler` object.
	100	*
	101	* On success, returns a `struct lttng_event_enabler`,
	102	* On memory error, returns NULL.
	103	*/
	104	LTTNG_HIDDEN
	105	struct lttng_event_enabler *lttng_event_enabler_create(
	106	enum lttng_enabler_format_type format_type,
	107	struct lttng_ust_event *event_param,
	108	struct lttng_channel *chan);
	109
	110	/*
	111	* Destroy a `struct lttng_event_enabler` object.
	112	*/
	113	LTTNG_HIDDEN
	114	void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);
	115
	116	/*
	117	* Enable a `struct lttng_event_enabler` object and all events related to this
	118	* enabler.
	119	*/
	120	LTTNG_HIDDEN
	121	int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);
	122
	123	/*
	124	* Disable a `struct lttng_event_enabler` object and all events related to this
	125	* enabler.
	126	*/
	127	LTTNG_HIDDEN
	128	int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);
	129
	130	/*
	131	* Attach filter bytecode program to `struct lttng_event_enabler` and all
	132	* events related to this enabler.
	133	*/
	134	LTTNG_HIDDEN
a56fd376 FD	135	int lttng_event_enabler_attach_filter_bytecode(
a56fd376 FD	136	struct lttng_event_enabler *enabler,
ab89263e	137	struct lttng_ust_bytecode_node **bytecode);
d871c65b FD	138
	139	/*
	140	* Attach an application context to an event enabler.
	141	*
	142	* Not implemented.
	143	*/
	144	LTTNG_HIDDEN
	145	int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
	146	struct lttng_ust_context *ctx);
	147
	148	/*
	149	* Attach exclusion list to `struct lttng_event_enabler` and all
	150	* events related to this enabler.
	151	*/
	152	LTTNG_HIDDEN
	153	int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
e9fe6aad	154	struct lttng_ust_excluder_node **excluder);
d871c65b FD	155
d871c65b FD	156	/*
d37ecb3f FD	157	* Synchronize bytecodes for the enabler and the instance (event or
d37ecb3f FD	158	* event_notifier).
d871c65b	159	*
621c07fc	160	* This function goes over all bytecode programs of the enabler (event or
d37ecb3f	161	* event_notifier enabler) to ensure each is linked to the provided instance.
d871c65b FD	162	*/
d871c65b FD	163	LTTNG_HIDDEN
53b9d7db FD	164	void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
53b9d7db FD	165	struct lttng_ctx **ctx,
621c07fc FD	166	struct cds_list_head *instance_bytecode_runtime_head,
621c07fc FD	167	struct cds_list_head *enabler_bytecode_runtime_head);
d871c65b	168
d8d2416d FD	169	/*
	170	* Allocate and initialize a `struct lttng_event_notifier_group` object.
	171	*
	172	* On success, returns a `struct lttng_triggre_group`,
	173	* on memory error, returns NULL.
	174	*/
	175	LTTNG_HIDDEN
	176	struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
	177
	178	/*
	179	* Destroy a `struct lttng_event_notifier_group` object.
	180	*/
	181	LTTNG_HIDDEN
	182	void lttng_event_notifier_group_destroy(
	183	struct lttng_event_notifier_group *event_notifier_group);
	184
	185	/*
	186	* Allocate and initialize a `struct lttng_event_notifier_enabler` object.
	187	*
	188	* On success, returns a `struct lttng_event_notifier_enabler`,
	189	* On memory error, returns NULL.
	190	*/
	191	LTTNG_HIDDEN
	192	struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
	193	struct lttng_event_notifier_group *event_notifier_group,
	194	enum lttng_enabler_format_type format_type,
	195	struct lttng_ust_event_notifier *event_notifier_param);
	196
	197	/*
	198	* Destroy a `struct lttng_event_notifier_enabler` object.
	199	*/
	200	LTTNG_HIDDEN
	201	void lttng_event_notifier_enabler_destroy(
	202	struct lttng_event_notifier_enabler *event_notifier_enabler);
	203
	204	/*
	205	* Enable a `struct lttng_event_notifier_enabler` object and all event
	206	* notifiers related to this enabler.
	207	*/
	208	LTTNG_HIDDEN
	209	int lttng_event_notifier_enabler_enable(
	210	struct lttng_event_notifier_enabler *event_notifier_enabler);
	211
	212	/*
	213	* Disable a `struct lttng_event_notifier_enabler` object and all event
	214	* notifiers related to this enabler.
	215	*/
	216	LTTNG_HIDDEN
	217	int lttng_event_notifier_enabler_disable(
	218	struct lttng_event_notifier_enabler *event_notifier_enabler);
	219
	220	/*
	221	* Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
	222	* all event notifiers related to this enabler.
	223	*/
	224	LTTNG_HIDDEN
a56fd376	225	int lttng_event_notifier_enabler_attach_filter_bytecode(
d8d2416d	226	struct lttng_event_notifier_enabler *event_notifier_enabler,
ab89263e	227	struct lttng_ust_bytecode_node **bytecode);
d8d2416d	228
d37ecb3f FD	229	/*
	230	* Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
	231	* all event_notifiers related to this enabler.
	232	*/
	233	LTTNG_HIDDEN
	234	int lttng_event_notifier_enabler_attach_capture_bytecode(
	235	struct lttng_event_notifier_enabler *event_notifier_enabler,
	236	struct lttng_ust_bytecode_node *bytecode);
	237
d8d2416d FD	238	/*
	239	* Attach exclusion list to `struct lttng_event_notifier_enabler` and all
	240	* event notifiers related to this enabler.
	241	*/
	242	LTTNG_HIDDEN
	243	int lttng_event_notifier_enabler_attach_exclusion(
	244	struct lttng_event_notifier_enabler *event_notifier_enabler,
e9fe6aad	245	struct lttng_ust_excluder_node **excluder);
d8d2416d FD	246
	247	LTTNG_HIDDEN
	248	void lttng_free_event_notifier_filter_runtime(
	249	struct lttng_event_notifier *event_notifier);
	250
	251	/*
	252	* Connect the probe on all enablers matching this event description.
	253	* Called on library load.
	254	*/
	255	LTTNG_HIDDEN
	256	int lttng_fix_pending_event_notifiers(void);
	257
67d4e8f5 MJ	258	LTTNG_HIDDEN
	259	struct lttng_counter *lttng_ust_counter_create(
	260	const char *counter_transport_name,
	261	size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
	262
d871c65b	263	#endif /* _LTTNG_UST_EVENTS_INTERNAL_H */