[lttng-tools.git] / src / bin / lttng-sessiond / trace-kernel.hpp

/*
 * Copyright (C) 2011 EfficiOS Inc.
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _LTT_TRACE_KERNEL_H
#define _LTT_TRACE_KERNEL_H

#include "consumer.hpp"
#include "tracker.hpp"

#include <common/defaults.hpp>
#include <common/lttng-kernel-old.hpp>
#include <common/lttng-kernel.hpp>

#include <lttng/lttng.h>

#include <urcu/list.h>

/* Kernel event list */
struct ltt_kernel_event_list {
	struct cds_list_head head;
};

/* Channel stream list */
struct ltt_kernel_stream_list {
	struct cds_list_head head;
};

/* Channel list */
struct ltt_kernel_channel_list {
	struct cds_list_head head;
};

struct ltt_kernel_context {
	struct lttng_kernel_abi_context ctx;
	struct cds_list_head list;
	/* Indicates whether or not the context is in a list. */
	bool in_list;
};

/* Kernel event */
struct ltt_kernel_event {
	int fd;
	bool enabled;
	enum lttng_event_type type;
	struct lttng_kernel_abi_event *event;
	struct cds_list_head list;
	char *filter_expression;
	struct lttng_bytecode *filter;
	struct lttng_userspace_probe_location *userspace_probe_location;
};

/* Kernel event */
struct ltt_kernel_event_notifier_rule {
	int fd;
	uint64_t error_counter_index;
	bool enabled;
	enum lttng_event_type type;
	struct lttng_trigger *trigger;
	uint64_t token;
	const struct lttng_bytecode *filter;
	struct lttng_userspace_probe_location *userspace_probe_location;
	struct cds_lfht_node ht_node;
	/* call_rcu delayed reclaim. */
	struct rcu_head rcu_node;
};

/* Kernel channel */
struct ltt_kernel_channel {
	int fd;
	uint64_t key; /* Key to reference this channel with the consumer. */
	bool enabled;
	unsigned int stream_count;
	unsigned int event_count;
	bool published_to_notification_thread;
	struct cds_list_head ctx_list;
	struct lttng_channel *channel;
	struct ltt_kernel_event_list events_list;
	struct ltt_kernel_stream_list stream_list;
	struct cds_list_head list;
	/* Session pointer which has a reference to this object. */
	struct ltt_kernel_session *session;
	bool sent_to_consumer;
};

/* Metadata */
struct ltt_kernel_metadata {
	int fd;
	uint64_t key; /* Key to reference this channel with the consumer. */
	struct lttng_channel *conf;
};

/* Channel stream */
struct ltt_kernel_stream {
	int fd;
	int state;
	int cpu;
	bool sent_to_consumer;
	/* Format is %s_%d respectively channel name and CPU number. */
	char name[DEFAULT_STREAM_NAME_LEN];
	uint64_t tracefile_size;
	uint64_t tracefile_count;
	struct cds_list_head list;
};

/* Kernel session */
struct ltt_kernel_session {
	int fd;
	int metadata_stream_fd;
	int consumer_fds_sent;
	unsigned int channel_count;
	unsigned int stream_count_global;
	struct ltt_kernel_metadata *metadata;
	struct ltt_kernel_channel_list channel_list;
	/* UID/GID of the user owning the session */
	uid_t uid;
	gid_t gid;
	struct consumer_output *consumer;
	/* Tracing session id */
	uint64_t id;
	/* Session is active or not meaning it has been started or stopped. */
	bool active;
	/* Tell or not if the session has to output the traces. */
	unsigned int output_traces;
	unsigned int snapshot_mode;
	unsigned int has_non_default_channel;
	bool is_live_session;
	/* Current trace chunk of the ltt_session. */
	struct lttng_trace_chunk *current_trace_chunk;
	/* Tracker lists */
	struct process_attr_tracker *tracker_pid;
	struct process_attr_tracker *tracker_vpid;
	struct process_attr_tracker *tracker_uid;
	struct process_attr_tracker *tracker_vuid;
	struct process_attr_tracker *tracker_gid;
	struct process_attr_tracker *tracker_vgid;
};

/*
 * Lookup functions. NULL is returned if not found.
 */
struct ltt_kernel_event *trace_kernel_get_event_by_name(char *name,
							struct ltt_kernel_channel *channel,
							enum lttng_event_type type);
struct ltt_kernel_event *trace_kernel_find_event(char *name,
						 struct ltt_kernel_channel *channel,
						 enum lttng_event_type type,
						 struct lttng_bytecode *filter);
struct ltt_kernel_channel *trace_kernel_get_channel_by_name(const char *name,
							    struct ltt_kernel_session *session);

/*
 * Create functions malloc() the data structure.
 */
struct ltt_kernel_session *trace_kernel_create_session();
struct ltt_kernel_channel *trace_kernel_create_channel(struct lttng_channel *chan);
enum lttng_error_code trace_kernel_create_event(struct lttng_event *ev,
						char *filter_expression,
						struct lttng_bytecode *filter,
						struct ltt_kernel_event **kernel_event);
struct ltt_kernel_metadata *trace_kernel_create_metadata();
struct ltt_kernel_stream *trace_kernel_create_stream(const char *name, unsigned int count);
struct ltt_kernel_context *trace_kernel_create_context(struct lttng_kernel_abi_context *ctx);
/* Trigger is only non-const to acquire a reference. */
enum lttng_error_code trace_kernel_create_event_notifier_rule(
	struct lttng_trigger *trigger,
	uint64_t token,
	uint64_t error_counter_index,
	struct ltt_kernel_event_notifier_rule **event_notifier_rule);
struct ltt_kernel_context *trace_kernel_copy_context(struct ltt_kernel_context *ctx);
enum lttng_error_code trace_kernel_init_event_notifier_from_event_rule(
	const struct lttng_event_rule *rule,
	struct lttng_kernel_abi_event_notifier *kernel_event_notifier);

/*
 * Destroy functions free() the data structure and remove from linked list if
 * it's applies.
 */
void trace_kernel_destroy_session(struct ltt_kernel_session *session);
void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
void trace_kernel_destroy_event(struct ltt_kernel_event *event);
void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
void trace_kernel_destroy_context(struct ltt_kernel_context *ctx);
void trace_kernel_destroy_event_notifier_rule(struct ltt_kernel_event_notifier_rule *rule);
void trace_kernel_free_session(struct ltt_kernel_session *session);

#endif /* _LTT_TRACE_KERNEL_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 EfficiOS Inc.
	3	*
	4	* SPDX-License-Identifier: GPL-2.0-only
	5	*
	6	*/
	7
	8	#ifndef _LTT_TRACE_KERNEL_H
	9	#define _LTT_TRACE_KERNEL_H
	10
	11	#include "consumer.hpp"
	12	#include "tracker.hpp"
	13
	14	#include <common/defaults.hpp>
	15	#include <common/lttng-kernel-old.hpp>
	16	#include <common/lttng-kernel.hpp>
	17
	18	#include <lttng/lttng.h>
	19
	20	#include <urcu/list.h>
	21
	22	/* Kernel event list */
	23	struct ltt_kernel_event_list {
	24	struct cds_list_head head;
	25	};
	26
	27	/* Channel stream list */
	28	struct ltt_kernel_stream_list {
	29	struct cds_list_head head;
	30	};
	31
	32	/* Channel list */
	33	struct ltt_kernel_channel_list {
	34	struct cds_list_head head;
	35	};
	36
	37	struct ltt_kernel_context {
	38	struct lttng_kernel_abi_context ctx;
	39	struct cds_list_head list;
	40	/* Indicates whether or not the context is in a list. */
	41	bool in_list;
	42	};
	43
	44	/* Kernel event */
	45	struct ltt_kernel_event {
	46	int fd;
	47	bool enabled;
	48	enum lttng_event_type type;
	49	struct lttng_kernel_abi_event *event;
	50	struct cds_list_head list;
	51	char *filter_expression;
	52	struct lttng_bytecode *filter;
	53	struct lttng_userspace_probe_location *userspace_probe_location;
	54	};
	55
	56	/* Kernel event */
	57	struct ltt_kernel_event_notifier_rule {
	58	int fd;
	59	uint64_t error_counter_index;
	60	bool enabled;
	61	enum lttng_event_type type;
	62	struct lttng_trigger *trigger;
	63	uint64_t token;
	64	const struct lttng_bytecode *filter;
	65	struct lttng_userspace_probe_location *userspace_probe_location;
	66	struct cds_lfht_node ht_node;
	67	/* call_rcu delayed reclaim. */
	68	struct rcu_head rcu_node;
	69	};
	70
	71	/* Kernel channel */
	72	struct ltt_kernel_channel {
	73	int fd;
	74	uint64_t key; /* Key to reference this channel with the consumer. */
	75	bool enabled;
	76	unsigned int stream_count;
	77	unsigned int event_count;
	78	bool published_to_notification_thread;
	79	struct cds_list_head ctx_list;
	80	struct lttng_channel *channel;
	81	struct ltt_kernel_event_list events_list;
	82	struct ltt_kernel_stream_list stream_list;
	83	struct cds_list_head list;
	84	/* Session pointer which has a reference to this object. */
	85	struct ltt_kernel_session *session;
	86	bool sent_to_consumer;
	87	};
	88
	89	/* Metadata */
	90	struct ltt_kernel_metadata {
	91	int fd;
	92	uint64_t key; /* Key to reference this channel with the consumer. */
	93	struct lttng_channel *conf;
	94	};
	95
	96	/* Channel stream */
	97	struct ltt_kernel_stream {
	98	int fd;
	99	int state;
	100	int cpu;
	101	bool sent_to_consumer;
	102	/* Format is %s_%d respectively channel name and CPU number. */
	103	char name[DEFAULT_STREAM_NAME_LEN];
	104	uint64_t tracefile_size;
	105	uint64_t tracefile_count;
	106	struct cds_list_head list;
	107	};
	108
	109	/* Kernel session */
	110	struct ltt_kernel_session {
	111	int fd;
	112	int metadata_stream_fd;
	113	int consumer_fds_sent;
	114	unsigned int channel_count;
	115	unsigned int stream_count_global;
	116	struct ltt_kernel_metadata *metadata;
	117	struct ltt_kernel_channel_list channel_list;
	118	/* UID/GID of the user owning the session */
	119	uid_t uid;
	120	gid_t gid;
	121	struct consumer_output *consumer;
	122	/* Tracing session id */
	123	uint64_t id;
	124	/* Session is active or not meaning it has been started or stopped. */
	125	bool active;
	126	/* Tell or not if the session has to output the traces. */
	127	unsigned int output_traces;
	128	unsigned int snapshot_mode;
	129	unsigned int has_non_default_channel;
	130	bool is_live_session;
	131	/* Current trace chunk of the ltt_session. */
	132	struct lttng_trace_chunk *current_trace_chunk;
	133	/* Tracker lists */
	134	struct process_attr_tracker *tracker_pid;
	135	struct process_attr_tracker *tracker_vpid;
	136	struct process_attr_tracker *tracker_uid;
	137	struct process_attr_tracker *tracker_vuid;
	138	struct process_attr_tracker *tracker_gid;
	139	struct process_attr_tracker *tracker_vgid;
	140	};
	141
	142	/*
	143	* Lookup functions. NULL is returned if not found.
	144	*/
	145	struct ltt_kernel_event trace_kernel_get_event_by_name(char name,
	146	struct ltt_kernel_channel *channel,
	147	enum lttng_event_type type);
	148	struct ltt_kernel_event trace_kernel_find_event(char name,
	149	struct ltt_kernel_channel *channel,
	150	enum lttng_event_type type,
	151	struct lttng_bytecode *filter);
	152	struct ltt_kernel_channel trace_kernel_get_channel_by_name(const char name,
	153	struct ltt_kernel_session *session);
	154
	155	/*
	156	* Create functions malloc() the data structure.
	157	*/
	158	struct ltt_kernel_session *trace_kernel_create_session();
	159	struct ltt_kernel_channel trace_kernel_create_channel(struct lttng_channel chan);
	160	enum lttng_error_code trace_kernel_create_event(struct lttng_event *ev,
	161	char *filter_expression,
	162	struct lttng_bytecode *filter,
	163	struct ltt_kernel_event **kernel_event);
	164	struct ltt_kernel_metadata *trace_kernel_create_metadata();
	165	struct ltt_kernel_stream trace_kernel_create_stream(const char name, unsigned int count);
	166	struct ltt_kernel_context trace_kernel_create_context(struct lttng_kernel_abi_context ctx);
	167	/* Trigger is only non-const to acquire a reference. */
	168	enum lttng_error_code trace_kernel_create_event_notifier_rule(
	169	struct lttng_trigger *trigger,
	170	uint64_t token,
	171	uint64_t error_counter_index,
	172	struct ltt_kernel_event_notifier_rule **event_notifier_rule);
	173	struct ltt_kernel_context trace_kernel_copy_context(struct ltt_kernel_context ctx);
	174	enum lttng_error_code trace_kernel_init_event_notifier_from_event_rule(
	175	const struct lttng_event_rule *rule,
	176	struct lttng_kernel_abi_event_notifier *kernel_event_notifier);
	177
	178	/*
	179	* Destroy functions free() the data structure and remove from linked list if
	180	* it's applies.
	181	*/
	182	void trace_kernel_destroy_session(struct ltt_kernel_session *session);
	183	void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
	184	void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
	185	void trace_kernel_destroy_event(struct ltt_kernel_event *event);
	186	void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
	187	void trace_kernel_destroy_context(struct ltt_kernel_context *ctx);
	188	void trace_kernel_destroy_event_notifier_rule(struct ltt_kernel_event_notifier_rule *rule);
	189	void trace_kernel_free_session(struct ltt_kernel_session *session);
	190
	191	#endif /* _LTT_TRACE_KERNEL_H */