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

/*
 * 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 <lttng/domain.h>
#include <lttng/lttng-error.h>
#include <urcu/rculfhash.h>
#include "notification-thread.h"
#include "notification-thread-internal.h"
#include "notification-thread-events.h"
#include <common/waiter.h>
#include <stdbool.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_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;

	enum notification_thread_command_type type;
	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 channel. */
		struct {
			struct {
				const char *name;
				uid_t uid;
				gid_t gid;
			} 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 {
			const char *session_name;
			uid_t uid;
			gid_t gid;
			uint64_t trace_archive_chunk_id;
			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;
	/* lttng_waiter on which to wait for command reply (optional). */
	struct lttng_waiter reply_waiter;
	enum lttng_error_code reply_code;
	bool is_async;
};

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