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

/*
 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef CMD_H
#define CMD_H

#include "context.hpp"
#include "ctl-utils.hpp"
#include "lttng-sessiond.hpp"
#include "lttng/tracker.h"
#include "session.hpp"
#include "snapshot-output.hpp"

#include <common/tracker.hpp>

#include <lttng/kernel.h>

struct notification_thread_handle;
struct lttng_dynamic_buffer;

/*
 * A callback (and associated user data) that should be run after a command
 * has been executed. No locks should be taken while executing this handler.
 *
 * The command's reply should not be sent until the handler has run and
 * completed successfully. On failure, the handler's return code should
 * be the only reply sent to the client.
 */
using completion_handler_function = enum lttng_error_code (*)(void *);
struct cmd_completion_handler {
	completion_handler_function run;
	void *data;
};

/*
 * Init the command subsystem. Must be called before using any of the functions
 * above. This is called in the main() of the session daemon.
 */
void cmd_init();

/* Session commands */
enum lttng_error_code cmd_create_session(struct command_ctx *cmd_ctx,
					 int sock,
					 struct lttng_session_descriptor **return_descriptor);
int cmd_destroy_session(const ltt_session::locked_ref& session, int *sock_fd);

/* Channel commands */
int cmd_disable_channel(const ltt_session::locked_ref& session,
			enum lttng_domain_type domain,
			char *channel_name);
int cmd_enable_channel(struct command_ctx *cmd_ctx,
		       ltt_session::locked_ref& session,
		       int sock,
		       int wpipe);

/* Process attribute tracker commands */
enum lttng_error_code
cmd_process_attr_tracker_get_tracking_policy(const ltt_session::locked_ref& session,
					     enum lttng_domain_type domain,
					     enum lttng_process_attr process_attr,
					     enum lttng_tracking_policy *policy);
enum lttng_error_code
cmd_process_attr_tracker_set_tracking_policy(const ltt_session::locked_ref& session,
					     enum lttng_domain_type domain,
					     enum lttng_process_attr process_attr,
					     enum lttng_tracking_policy policy);
enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_add_value(const ltt_session::locked_ref& session,
						 enum lttng_domain_type domain,
						 enum lttng_process_attr process_attr,
						 const struct process_attr_value *value);
enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_remove_value(const ltt_session::locked_ref& session,
						    enum lttng_domain_type domain,
						    enum lttng_process_attr process_attr,
						    const struct process_attr_value *value);
enum lttng_error_code
cmd_process_attr_tracker_get_inclusion_set(const ltt_session::locked_ref& session,
					   enum lttng_domain_type domain,
					   enum lttng_process_attr process_attr,
					   struct lttng_process_attr_values **values);

/* Event commands */
int cmd_disable_event(struct command_ctx *cmd_ctx,
		      ltt_session::locked_ref& locked_session,
		      struct lttng_event *event,
		      char *filter_expression,
		      struct lttng_bytecode *filter,
		      struct lttng_event_exclusion *exclusion);
int cmd_add_context(struct command_ctx *cmd_ctx,
		    ltt_session::locked_ref& locked_session,
		    const struct lttng_event_context *event_context,
		    int kwpipe);
int cmd_set_filter(struct ltt_session *session,
		   enum lttng_domain_type domain,
		   char *channel_name,
		   struct lttng_event *event,
		   struct lttng_bytecode *bytecode);
int cmd_enable_event(struct command_ctx *cmd_ctx,
		     ltt_session::locked_ref& session,
		     struct lttng_event *event,
		     char *filter_expression,
		     struct lttng_event_exclusion *exclusion,
		     struct lttng_bytecode *bytecode,
		     int wpipe);

/* Trace session action commands */
int cmd_start_trace(const ltt_session::locked_ref& session);
int cmd_stop_trace(const ltt_session::locked_ref& session);

/* Consumer commands */
int cmd_register_consumer(const ltt_session::locked_ref& session,
			  enum lttng_domain_type domain,
			  const char *sock_path,
			  struct consumer_data *cdata);
int cmd_set_consumer_uri(const ltt_session::locked_ref& session,
			 size_t nb_uri,
			 struct lttng_uri *uris);
int cmd_setup_relayd(const ltt_session::locked_ref& session);

/* Listing commands */
ssize_t cmd_list_domains(const ltt_session::locked_ref& session, struct lttng_domain **domains);
enum lttng_error_code cmd_list_events(enum lttng_domain_type domain,
				      const ltt_session::locked_ref& session,
				      char *channel_name,
				      struct lttng_payload *payload);
enum lttng_error_code cmd_list_channels(enum lttng_domain_type domain,
					const ltt_session::locked_ref& session,
					struct lttng_payload *payload);
void cmd_list_lttng_sessions(lttng_session *sessions, size_t session_count, uid_t uid, gid_t gid);
enum lttng_error_code cmd_list_tracepoint_fields(enum lttng_domain_type domain,
						 struct lttng_payload *reply);
enum lttng_error_code cmd_list_tracepoints(enum lttng_domain_type domain,
					   struct lttng_payload *reply_payload);
ssize_t cmd_snapshot_list_outputs(const ltt_session::locked_ref& session,
				  struct lttng_snapshot_output **outputs);
enum lttng_error_code cmd_list_syscalls(struct lttng_payload *reply_payload);

int cmd_data_pending(const ltt_session::locked_ref& session);
enum lttng_error_code cmd_kernel_tracer_status(enum lttng_kernel_tracer_status *status);

/* Snapshot */
int cmd_snapshot_add_output(const ltt_session::locked_ref& session,
			    const struct lttng_snapshot_output *output,
			    uint32_t *id);
int cmd_snapshot_del_output(const ltt_session::locked_ref& session,
			    const struct lttng_snapshot_output *output);
int cmd_snapshot_record(const ltt_session::locked_ref& session,
			const struct lttng_snapshot_output *output,
			int wait);

int cmd_set_session_shm_path(const ltt_session::locked_ref& session, const char *shm_path);
int cmd_regenerate_metadata(const ltt_session::locked_ref& session);
int cmd_regenerate_statedump(const ltt_session::locked_ref& session);

lttng::ctl::trigger
cmd_register_trigger(const struct lttng_credentials *cmd_creds,
		     struct lttng_trigger *trigger,
		     bool is_anonymous_trigger,
		     struct notification_thread_handle *notification_thread_handle);
enum lttng_error_code
cmd_unregister_trigger(const struct lttng_credentials *cmd_creds,
		       const struct lttng_trigger *trigger,
		       struct notification_thread_handle *notification_thread_handle);

enum lttng_error_code
cmd_list_triggers(struct command_ctx *cmd_ctx,
		  struct notification_thread_handle *notification_thread_handle,
		  struct lttng_triggers **return_triggers);
enum lttng_error_code
cmd_execute_error_query(const struct lttng_credentials *cmd_creds,
			const struct lttng_error_query *query,
			struct lttng_error_query_results **_results,
			struct notification_thread_handle *notification_thread);

int cmd_rotate_session(const ltt_session::locked_ref& session,
		       struct lttng_rotate_session_return *rotate_return,
		       bool quiet_rotation,
		       enum lttng_trace_chunk_command_type command);
int cmd_rotate_get_info(const ltt_session::locked_ref& session,
			struct lttng_rotation_get_info_return *info_return,
			uint64_t rotate_id);
int cmd_rotation_set_schedule(const ltt_session::locked_ref& session,
			      bool activate,
			      enum lttng_rotation_schedule_type schedule_type,
			      uint64_t value);

const struct cmd_completion_handler *cmd_pop_completion_handler();
int start_kernel_session(struct ltt_kernel_session *ksess);
int stop_kernel_session(struct ltt_kernel_session *ksess);

#endif /* CMD_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
	3	*
	4	* SPDX-License-Identifier: GPL-2.0-only
	5	*
	6	*/
	7
	8	#ifndef CMD_H
	9	#define CMD_H
	10
	11	#include "context.hpp"
	12	#include "ctl-utils.hpp"
	13	#include "lttng-sessiond.hpp"
	14	#include "lttng/tracker.h"
	15	#include "session.hpp"
	16	#include "snapshot-output.hpp"
	17
	18	#include <common/tracker.hpp>
	19
	20	#include <lttng/kernel.h>
	21
	22	struct notification_thread_handle;
	23	struct lttng_dynamic_buffer;
	24
	25	/*
	26	* A callback (and associated user data) that should be run after a command
	27	* has been executed. No locks should be taken while executing this handler.
	28	*
	29	* The command's reply should not be sent until the handler has run and
	30	* completed successfully. On failure, the handler's return code should
	31	* be the only reply sent to the client.
	32	*/
	33	using completion_handler_function = enum lttng_error_code ()(void );
	34	struct cmd_completion_handler {
	35	completion_handler_function run;
	36	void *data;
	37	};
	38
	39	/*
	40	* Init the command subsystem. Must be called before using any of the functions
	41	* above. This is called in the main() of the session daemon.
	42	*/
	43	void cmd_init();
	44
	45	/* Session commands */
	46	enum lttng_error_code cmd_create_session(struct command_ctx *cmd_ctx,
	47	int sock,
	48	struct lttng_session_descriptor **return_descriptor);
	49	int cmd_destroy_session(const ltt_session::locked_ref& session, int *sock_fd);
	50
	51	/* Channel commands */
	52	int cmd_disable_channel(const ltt_session::locked_ref& session,
	53	enum lttng_domain_type domain,
	54	char *channel_name);
	55	int cmd_enable_channel(struct command_ctx *cmd_ctx,
	56	ltt_session::locked_ref& session,
	57	int sock,
	58	int wpipe);
	59
	60	/* Process attribute tracker commands */
	61	enum lttng_error_code
	62	cmd_process_attr_tracker_get_tracking_policy(const ltt_session::locked_ref& session,
	63	enum lttng_domain_type domain,
	64	enum lttng_process_attr process_attr,
	65	enum lttng_tracking_policy *policy);
	66	enum lttng_error_code
	67	cmd_process_attr_tracker_set_tracking_policy(const ltt_session::locked_ref& session,
	68	enum lttng_domain_type domain,
	69	enum lttng_process_attr process_attr,
	70	enum lttng_tracking_policy policy);
	71	enum lttng_error_code
	72	cmd_process_attr_tracker_inclusion_set_add_value(const ltt_session::locked_ref& session,
	73	enum lttng_domain_type domain,
	74	enum lttng_process_attr process_attr,
	75	const struct process_attr_value *value);
	76	enum lttng_error_code
	77	cmd_process_attr_tracker_inclusion_set_remove_value(const ltt_session::locked_ref& session,
	78	enum lttng_domain_type domain,
	79	enum lttng_process_attr process_attr,
	80	const struct process_attr_value *value);
	81	enum lttng_error_code
	82	cmd_process_attr_tracker_get_inclusion_set(const ltt_session::locked_ref& session,
	83	enum lttng_domain_type domain,
	84	enum lttng_process_attr process_attr,
	85	struct lttng_process_attr_values **values);
	86
	87	/* Event commands */
	88	int cmd_disable_event(struct command_ctx *cmd_ctx,
	89	ltt_session::locked_ref& locked_session,
	90	struct lttng_event *event,
	91	char *filter_expression,
	92	struct lttng_bytecode *filter,
	93	struct lttng_event_exclusion *exclusion);
	94	int cmd_add_context(struct command_ctx *cmd_ctx,
	95	ltt_session::locked_ref& locked_session,
	96	const struct lttng_event_context *event_context,
	97	int kwpipe);
	98	int cmd_set_filter(struct ltt_session *session,
	99	enum lttng_domain_type domain,
	100	char *channel_name,
	101	struct lttng_event *event,
	102	struct lttng_bytecode *bytecode);
	103	int cmd_enable_event(struct command_ctx *cmd_ctx,
	104	ltt_session::locked_ref& session,
	105	struct lttng_event *event,
	106	char *filter_expression,
	107	struct lttng_event_exclusion *exclusion,
	108	struct lttng_bytecode *bytecode,
	109	int wpipe);
	110
	111	/* Trace session action commands */
	112	int cmd_start_trace(const ltt_session::locked_ref& session);
	113	int cmd_stop_trace(const ltt_session::locked_ref& session);
	114
	115	/* Consumer commands */
	116	int cmd_register_consumer(const ltt_session::locked_ref& session,
	117	enum lttng_domain_type domain,
	118	const char *sock_path,
	119	struct consumer_data *cdata);
	120	int cmd_set_consumer_uri(const ltt_session::locked_ref& session,
	121	size_t nb_uri,
	122	struct lttng_uri *uris);
	123	int cmd_setup_relayd(const ltt_session::locked_ref& session);
	124
	125	/* Listing commands */
	126	ssize_t cmd_list_domains(const ltt_session::locked_ref& session, struct lttng_domain **domains);
	127	enum lttng_error_code cmd_list_events(enum lttng_domain_type domain,
	128	const ltt_session::locked_ref& session,
	129	char *channel_name,
	130	struct lttng_payload *payload);
	131	enum lttng_error_code cmd_list_channels(enum lttng_domain_type domain,
	132	const ltt_session::locked_ref& session,
	133	struct lttng_payload *payload);
	134	void cmd_list_lttng_sessions(lttng_session *sessions, size_t session_count, uid_t uid, gid_t gid);
	135	enum lttng_error_code cmd_list_tracepoint_fields(enum lttng_domain_type domain,
	136	struct lttng_payload *reply);
	137	enum lttng_error_code cmd_list_tracepoints(enum lttng_domain_type domain,
	138	struct lttng_payload *reply_payload);
	139	ssize_t cmd_snapshot_list_outputs(const ltt_session::locked_ref& session,
	140	struct lttng_snapshot_output **outputs);
	141	enum lttng_error_code cmd_list_syscalls(struct lttng_payload *reply_payload);
	142
	143	int cmd_data_pending(const ltt_session::locked_ref& session);
	144	enum lttng_error_code cmd_kernel_tracer_status(enum lttng_kernel_tracer_status *status);
	145
	146	/* Snapshot */
	147	int cmd_snapshot_add_output(const ltt_session::locked_ref& session,
	148	const struct lttng_snapshot_output *output,
	149	uint32_t *id);
	150	int cmd_snapshot_del_output(const ltt_session::locked_ref& session,
	151	const struct lttng_snapshot_output *output);
	152	int cmd_snapshot_record(const ltt_session::locked_ref& session,
	153	const struct lttng_snapshot_output *output,
	154	int wait);
	155
	156	int cmd_set_session_shm_path(const ltt_session::locked_ref& session, const char *shm_path);
	157	int cmd_regenerate_metadata(const ltt_session::locked_ref& session);
	158	int cmd_regenerate_statedump(const ltt_session::locked_ref& session);
	159
	160	lttng::ctl::trigger
	161	cmd_register_trigger(const struct lttng_credentials *cmd_creds,
	162	struct lttng_trigger *trigger,
	163	bool is_anonymous_trigger,
	164	struct notification_thread_handle *notification_thread_handle);
	165	enum lttng_error_code
	166	cmd_unregister_trigger(const struct lttng_credentials *cmd_creds,
	167	const struct lttng_trigger *trigger,
	168	struct notification_thread_handle *notification_thread_handle);
	169
	170	enum lttng_error_code
	171	cmd_list_triggers(struct command_ctx *cmd_ctx,
	172	struct notification_thread_handle *notification_thread_handle,
	173	struct lttng_triggers **return_triggers);
	174	enum lttng_error_code
	175	cmd_execute_error_query(const struct lttng_credentials *cmd_creds,
	176	const struct lttng_error_query *query,
	177	struct lttng_error_query_results **_results,
	178	struct notification_thread_handle *notification_thread);
	179
	180	int cmd_rotate_session(const ltt_session::locked_ref& session,
	181	struct lttng_rotate_session_return *rotate_return,
	182	bool quiet_rotation,
	183	enum lttng_trace_chunk_command_type command);
	184	int cmd_rotate_get_info(const ltt_session::locked_ref& session,
	185	struct lttng_rotation_get_info_return *info_return,
	186	uint64_t rotate_id);
	187	int cmd_rotation_set_schedule(const ltt_session::locked_ref& session,
	188	bool activate,
	189	enum lttng_rotation_schedule_type schedule_type,
	190	uint64_t value);
	191
	192	const struct cmd_completion_handler *cmd_pop_completion_handler();
	193	int start_kernel_session(struct ltt_kernel_session *ksess);
	194	int stop_kernel_session(struct ltt_kernel_session *ksess);
	195
	196	#endif /* CMD_H */