[lttng-tools.git] / src / bin / lttng-sessiond / notification-thread-commands.hpp

/*
 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef NOTIFICATION_THREAD_COMMANDS_H
#define NOTIFICATION_THREAD_COMMANDS_H

#include "notification-thread-events.hpp"
#include "notification-thread-internal.hpp"
#include "notification-thread.hpp"

#include <common/waiter.hpp>

#include <lttng/domain.h>
#include <lttng/lttng-error.h>

#include <vendor/optional.hpp>

#include <stdbool.h>
#include <urcu/rculfhash.h>

struct notification_thread_data;
struct lttng_trigger;

enum notification_thread_command_type {
	NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER,
	NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER,
	NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL,
	NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL,
	NOTIFICATION_COMMAND_TYPE_ADD_SESSION,
	NOTIFICATION_COMMAND_TYPE_REMOVE_SESSION,
	NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING,
	NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED,
	NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE,
	NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE,
	NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS,
	NOTIFICATION_COMMAND_TYPE_QUIT,
	NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE,
	NOTIFICATION_COMMAND_TYPE_GET_TRIGGER,
};

struct notification_thread_command {
	struct cds_list_head cmd_list_node = {};

	notification_thread_command_type type = NOTIFICATION_COMMAND_TYPE_QUIT;
	union {
		/* Register trigger. */
		struct {
			struct lttng_trigger *trigger;
			bool is_trigger_anonymous;
		} register_trigger;
		/* Unregister trigger. */
		struct {
			const struct lttng_trigger *trigger;
		} unregister_trigger;
		/* Add session. */
		struct {
			uint64_t session_id;
			const char *session_name;
			uid_t session_uid;
			gid_t session_gid;
		} add_session;
		/* Remove session. */
		struct {
			uint64_t session_id;
		} remove_session;
		/* Add channel. */
		struct {
			struct {
				uint64_t id;
			} session;
			struct {
				const char *name;
				enum lttng_domain_type domain;
				uint64_t key;
				uint64_t capacity;
			} channel;
		} add_channel;
		/* Remove channel. */
		struct {
			uint64_t key;
			enum lttng_domain_type domain;
		} remove_channel;
		struct {
			uint64_t session_id;
			uint64_t trace_archive_chunk_id;
			/* Weak reference. */
			struct lttng_trace_archive_location *location;
		} session_rotation;
		/* Add/Remove tracer event source fd. */
		struct {
			int tracer_event_source_fd;
			enum lttng_domain_type domain;
		} tracer_event_source;
		/* List triggers. */
		struct {
			/* Credentials of the requesting user. */
			uid_t uid;
		} list_triggers;
		/* Client communication update. */
		struct {
			notification_client_id id;
			enum client_transmission_status status;
		} client_communication_update;

		struct {
			const struct lttng_trigger *trigger;
		} get_trigger;

	} parameters = {};

	union {
		struct {
			struct lttng_triggers *triggers;
		} list_triggers;
		struct {
			struct lttng_trigger *trigger;
		} get_trigger;
	} reply = {};

	/* Used to wake origin thread for synchroneous commands. */
	nonstd::optional<lttng::synchro::waker> command_completed_waker = nonstd::nullopt;
	lttng_error_code reply_code = LTTNG_ERR_UNK;
	bool is_async = false;
};

enum lttng_error_code
notification_thread_command_register_trigger(struct notification_thread_handle *handle,
					     struct lttng_trigger *trigger,
					     bool is_anonymous_trigger);

enum lttng_error_code
notification_thread_command_unregister_trigger(struct notification_thread_handle *handle,
					       const struct lttng_trigger *trigger);

enum lttng_error_code
notification_thread_command_add_session(struct notification_thread_handle *handle,
					uint64_t session_id,
					const char *session_name,
					uid_t session_uid,
					gid_t session_gid);

enum lttng_error_code
notification_thread_command_remove_session(struct notification_thread_handle *handle,
					   uint64_t session_id);

enum lttng_error_code
notification_thread_command_add_channel(struct notification_thread_handle *handle,
					uint64_t session_id,
					char *channel_name,
					uint64_t key,
					enum lttng_domain_type domain,
					uint64_t capacity);

enum lttng_error_code notification_thread_command_remove_channel(
	struct notification_thread_handle *handle, uint64_t key, enum lttng_domain_type domain);

enum lttng_error_code
notification_thread_command_session_rotation_ongoing(struct notification_thread_handle *handle,
						     uint64_t session_id,
						     uint64_t trace_archive_chunk_id);

/* Ownership of location is transferred. */
enum lttng_error_code notification_thread_command_session_rotation_completed(
	struct notification_thread_handle *handle,
	uint64_t session_id,
	uint64_t trace_archive_chunk_id,
	struct lttng_trace_archive_location *location);

/*
 * Return the set of triggers visible to a given client.
 *
 * The trigger objects contained in the set are the actual trigger instances
 * used by the notification subsystem (i.e. not a copy). Given that the command
 * is only used to serialize the triggers, this is fine: the properties that
 * are serialized are immutable over the lifetime of the triggers.
 *
 * Moreover, the lifetime of the trigger instances is protected through
 * reference counting (references are held by the trigger set).
 *
 * The caller has the exclusive ownership of the returned trigger set.
 */
enum lttng_error_code
notification_thread_command_list_triggers(struct notification_thread_handle *handle,
					  uid_t client_uid,
					  struct lttng_triggers **triggers);

/*
 * The ownership of trigger_event_application_pipe is _not_ transferred to
 * the notification thread.
 */
enum lttng_error_code
notification_thread_command_add_tracer_event_source(struct notification_thread_handle *handle,
						    int tracer_event_source_fd,
						    enum lttng_domain_type domain);

enum lttng_error_code
notification_thread_command_remove_tracer_event_source(struct notification_thread_handle *handle,
						       int tracer_event_source_fd);

void notification_thread_command_quit(struct notification_thread_handle *handle);

enum lttng_error_code
notification_thread_command_get_trigger(struct notification_thread_handle *handle,
					const struct lttng_trigger *trigger,
					struct lttng_trigger **real_trigger);

#endif /* NOTIFICATION_THREAD_COMMANDS_H */
Commit	Line	Data
ab0ee2ca	1	/*
ab5be9fa	2	* Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
ab0ee2ca	3	*
ab5be9fa	4	* SPDX-License-Identifier: GPL-2.0-only
ab0ee2ca	5	*
ab0ee2ca JG	6	*/
	7
	8	#ifndef NOTIFICATION_THREAD_COMMANDS_H
	9	#define NOTIFICATION_THREAD_COMMANDS_H
	10
c9e313bc	11	#include "notification-thread-events.hpp"
28f23191 JG	12	#include "notification-thread-internal.hpp"
	13	#include "notification-thread.hpp"
	14
c9e313bc	15	#include <common/waiter.hpp>
28f23191 JG	16
	17	#include <lttng/domain.h>
	18	#include <lttng/lttng-error.h>
	19
32670d71 JG	20	#include <vendor/optional.hpp>
32670d71 JG	21
0ab399e0	22	#include <stdbool.h>
28f23191	23	#include <urcu/rculfhash.h>
ab0ee2ca JG	24
	25	struct notification_thread_data;
	26	struct lttng_trigger;
	27
	28	enum notification_thread_command_type {
	29	NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER,
	30	NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER,
	31	NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL,
	32	NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL,
139a8d25 JG	33	NOTIFICATION_COMMAND_TYPE_ADD_SESSION,
139a8d25 JG	34	NOTIFICATION_COMMAND_TYPE_REMOVE_SESSION,
731c1b12 JG	35	NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING,
731c1b12 JG	36	NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED,
d02d7404 JR	37	NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE,
d02d7404 JR	38	NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE,
fbc9f37d	39	NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS,
ab0ee2ca	40	NOTIFICATION_COMMAND_TYPE_QUIT,
f2b3ef9f	41	NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE,
8790759c	42	NOTIFICATION_COMMAND_TYPE_GET_TRIGGER,
ab0ee2ca JG	43	};
ab0ee2ca JG	44
ab0ee2ca	45	struct notification_thread_command {
32670d71	46	struct cds_list_head cmd_list_node = {};
ab0ee2ca	47
32670d71	48	notification_thread_command_type type = NOTIFICATION_COMMAND_TYPE_QUIT;
ab0ee2ca	49	union {
ac16173e JG	50	/* Register trigger. */
	51	struct {
	52	struct lttng_trigger *trigger;
0efb2ad7	53	bool is_trigger_anonymous;
ac16173e JG	54	} register_trigger;
	55	/* Unregister trigger. */
	56	struct {
	57	const struct lttng_trigger *trigger;
	58	} unregister_trigger;
139a8d25 JG	59	/* Add session. */
	60	struct {
	61	uint64_t session_id;
	62	const char *session_name;
	63	uid_t session_uid;
	64	gid_t session_gid;
	65	} add_session;
	66	/* Remove session. */
	67	struct {
	68	uint64_t session_id;
	69	} remove_session;
ab0ee2ca	70	/* Add channel. */
8abe313a JG	71	struct {
8abe313a JG	72	struct {
139a8d25	73	uint64_t id;
8abe313a JG	74	} session;
	75	struct {
	76	const char *name;
	77	enum lttng_domain_type domain;
	78	uint64_t key;
	79	uint64_t capacity;
	80	} channel;
	81	} add_channel;
ab0ee2ca JG	82	/* Remove channel. */
	83	struct {
	84	uint64_t key;
	85	enum lttng_domain_type domain;
	86	} remove_channel;
731c1b12	87	struct {
139a8d25	88	uint64_t session_id;
731c1b12	89	uint64_t trace_archive_chunk_id;
d3740619	90	/* Weak reference. */
731c1b12 JG	91	struct lttng_trace_archive_location *location;
731c1b12 JG	92	} session_rotation;
d02d7404 JR	93	/* Add/Remove tracer event source fd. */
	94	struct {
	95	int tracer_event_source_fd;
	96	enum lttng_domain_type domain;
	97	} tracer_event_source;
fbc9f37d JR	98	/* List triggers. */
	99	struct {
	100	/* Credentials of the requesting user. */
	101	uid_t uid;
	102	} list_triggers;
f2b3ef9f JG	103	/* Client communication update. */
	104	struct {
	105	notification_client_id id;
	106	enum client_transmission_status status;
	107	} client_communication_update;
	108
8790759c FD	109	struct {
	110	const struct lttng_trigger *trigger;
	111	} get_trigger;
	112
32670d71	113	} parameters = {};
ab0ee2ca	114
fbc9f37d JR	115	union {
	116	struct {
	117	struct lttng_triggers *triggers;
	118	} list_triggers;
8790759c FD	119	struct {
	120	struct lttng_trigger *trigger;
	121	} get_trigger;
32670d71 JG	122	} reply = {};
	123
	124	/* Used to wake origin thread for synchroneous commands. */
	125	nonstd::optional<lttng::synchro::waker> command_completed_waker = nonstd::nullopt;
	126	lttng_error_code reply_code = LTTNG_ERR_UNK;
	127	bool is_async = false;
ab0ee2ca JG	128	};
ab0ee2ca JG	129
28f23191 JG	130	enum lttng_error_code
	131	notification_thread_command_register_trigger(struct notification_thread_handle *handle,
	132	struct lttng_trigger *trigger,
	133	bool is_anonymous_trigger);
	134
	135	enum lttng_error_code
	136	notification_thread_command_unregister_trigger(struct notification_thread_handle *handle,
	137	const struct lttng_trigger *trigger);
	138
	139	enum lttng_error_code
	140	notification_thread_command_add_session(struct notification_thread_handle *handle,
	141	uint64_t session_id,
	142	const char *session_name,
	143	uid_t session_uid,
	144	gid_t session_gid);
	145
	146	enum lttng_error_code
	147	notification_thread_command_remove_session(struct notification_thread_handle *handle,
	148	uint64_t session_id);
	149
	150	enum lttng_error_code
	151	notification_thread_command_add_channel(struct notification_thread_handle *handle,
	152	uint64_t session_id,
	153	char *channel_name,
	154	uint64_t key,
	155	enum lttng_domain_type domain,
	156	uint64_t capacity);
ab0ee2ca JG	157
ab0ee2ca JG	158	enum lttng_error_code notification_thread_command_remove_channel(
28f23191	159	struct notification_thread_handle *handle, uint64_t key, enum lttng_domain_type domain);
ab0ee2ca	160
28f23191 JG	161	enum lttng_error_code
	162	notification_thread_command_session_rotation_ongoing(struct notification_thread_handle *handle,
	163	uint64_t session_id,
	164	uint64_t trace_archive_chunk_id);
731c1b12 JG	165
	166	/* Ownership of location is transferred. */
	167	enum lttng_error_code notification_thread_command_session_rotation_completed(
28f23191 JG	168	struct notification_thread_handle *handle,
	169	uint64_t session_id,
	170	uint64_t trace_archive_chunk_id,
	171	struct lttng_trace_archive_location *location);
731c1b12	172
fbc9f37d JR	173	/*
	174	* Return the set of triggers visible to a given client.
	175	*
	176	* The trigger objects contained in the set are the actual trigger instances
	177	* used by the notification subsystem (i.e. not a copy). Given that the command
	178	* is only used to serialize the triggers, this is fine: the properties that
	179	* are serialized are immutable over the lifetime of the triggers.
	180	*
	181	* Moreover, the lifetime of the trigger instances is protected through
	182	* reference counting (references are held by the trigger set).
	183	*
	184	* The caller has the exclusive ownership of the returned trigger set.
	185	*/
28f23191 JG	186	enum lttng_error_code
	187	notification_thread_command_list_triggers(struct notification_thread_handle *handle,
	188	uid_t client_uid,
	189	struct lttng_triggers **triggers);
fbc9f37d	190
d02d7404 JR	191	/*
	192	* The ownership of trigger_event_application_pipe is _not_ transferred to
	193	* the notification thread.
	194	*/
28f23191 JG	195	enum lttng_error_code
	196	notification_thread_command_add_tracer_event_source(struct notification_thread_handle *handle,
	197	int tracer_event_source_fd,
	198	enum lttng_domain_type domain);
	199
	200	enum lttng_error_code
	201	notification_thread_command_remove_tracer_event_source(struct notification_thread_handle *handle,
	202	int tracer_event_source_fd);
	203
	204	void notification_thread_command_quit(struct notification_thread_handle *handle);
	205
	206	enum lttng_error_code
	207	notification_thread_command_get_trigger(struct notification_thread_handle *handle,
	208	const struct lttng_trigger *trigger,
	209	struct lttng_trigger **real_trigger);
8790759c	210
ab0ee2ca	211	#endif /* NOTIFICATION_THREAD_COMMANDS_H */