src/bin/lttng-sessiond/cmd.h

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