src/bin/lttng-sessiond/cmd.h

   1 /*
   2  * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License, version 2 only, as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program; if not, write to the Free Software Foundation, Inc., 51
  15  * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef CMD_H
  19 #define CMD_H
  20
  21 #include "context.h"
  22 #include "session.h"
  23 #include "lttng-sessiond.h"
  24
  25 struct notification_thread_handle;
  26
  27 /*
  28  * A callback (and associated user data) that should be run after a command
  29  * has been executed. No locks should be taken while executing this handler.
  30  *
  31  * The command's reply should not be sent until the handler has run and
  32  * completed successfully. On failure, the handler's return code should
  33  * be the only reply sent to the client.
  34  */
  35 typedef enum lttng_error_code (*completion_handler_function)(void *);
  36 struct cmd_completion_handler {
  37         completion_handler_function run;
  38         void *data;
  39 };
  40
  41 /*
  42  * Init the command subsystem. Must be called before using any of the functions
  43  * above. This is called in the main() of the session daemon.
  44  */
  45 void cmd_init(void);
  46
  47 /* Session commands */
  48 enum lttng_error_code cmd_create_session(struct command_ctx *cmd_ctx, int sock,
  49                 struct lttng_session_descriptor **return_descriptor);
  50 int cmd_destroy_session(struct ltt_session *session,
  51                 struct notification_thread_handle *notification_thread_handle,
  52                 int *sock_fd);
  53
  54 /* Channel commands */
  55 int cmd_disable_channel(struct ltt_session *session,
  56                 enum lttng_domain_type domain, char *channel_name);
  57 int cmd_enable_channel(struct ltt_session *session,
  58                 const struct lttng_domain *domain, const struct lttng_channel *attr,
  59                 int wpipe);
  60 int cmd_track_id(struct ltt_session *session,
  61                 enum lttng_tracker_type tracker_type,
  62                 enum lttng_domain_type domain,
  63                 const struct lttng_tracker_id *id);
  64 int cmd_untrack_id(struct ltt_session *session,
  65                 enum lttng_tracker_type tracker_type,
  66                 enum lttng_domain_type domain,
  67                 const struct lttng_tracker_id *id);
  68
  69 /* Event commands */
  70 int cmd_disable_event(struct ltt_session *session,
  71                 enum lttng_domain_type domain,
  72                 const char *channel_name,
  73                 const struct lttng_event *event);
  74 int cmd_add_context(struct ltt_session *session, enum lttng_domain_type domain,
  75                 char *channel_name, const struct lttng_event_context *ctx, int kwpipe);
  76 int cmd_set_filter(struct ltt_session *session, enum lttng_domain_type domain,
  77                 char *channel_name, struct lttng_event *event,
  78                 struct lttng_filter_bytecode *bytecode);
  79 int cmd_enable_event(struct ltt_session *session, const struct lttng_domain *domain,
  80                 char *channel_name, struct lttng_event *event,
  81                 char *filter_expression,
  82                 struct lttng_filter_bytecode *filter,
  83                 struct lttng_event_exclusion *exclusion,
  84                 int wpipe);
  85
  86 /* Trace session action commands */
  87 int cmd_start_trace(struct ltt_session *session);
  88 int cmd_stop_trace(struct ltt_session *session);
  89
  90 /* Consumer commands */
  91 int cmd_register_consumer(struct ltt_session *session,
  92                 enum lttng_domain_type domain,
  93                 const char *sock_path, struct consumer_data *cdata);
  94 int cmd_set_consumer_uri(struct ltt_session *session, size_t nb_uri,
  95                 struct lttng_uri *uris);
  96 int cmd_setup_relayd(struct ltt_session *session);
  97
  98 /* Listing commands */
  99 ssize_t cmd_list_domains(struct ltt_session *session,
 100                 struct lttng_domain **domains);
 101 ssize_t cmd_list_events(enum lttng_domain_type domain,
 102                 struct ltt_session *session, char *channel_name,
 103                 struct lttng_event **events, size_t *total_size);
 104 ssize_t cmd_list_channels(enum lttng_domain_type domain,
 105                 struct ltt_session *session, struct lttng_channel **channels);
 106 ssize_t cmd_list_domains(struct ltt_session *session,
 107                 struct lttng_domain **domains);
 108 void cmd_list_lttng_sessions(struct lttng_session *sessions,
 109                 size_t session_count, uid_t uid, gid_t gid);
 110 ssize_t cmd_list_tracepoint_fields(enum lttng_domain_type domain,
 111                 struct lttng_event_field **fields);
 112 ssize_t cmd_list_tracepoints(enum lttng_domain_type domain,
 113                 struct lttng_event **events);
 114 ssize_t cmd_snapshot_list_outputs(struct ltt_session *session,
 115                 struct lttng_snapshot_output **outputs);
 116 ssize_t cmd_list_syscalls(struct lttng_event **events);
 117 ssize_t cmd_list_tracker_ids(enum lttng_tracker_type tracker_type,
 118                 struct ltt_session *session,
 119                 enum lttng_domain_type domain,
 120                 struct lttng_tracker_id **ids);
 121
 122 int cmd_data_pending(struct ltt_session *session);
 123
 124 /* Snapshot */
 125 int cmd_snapshot_add_output(struct ltt_session *session,
 126                 const struct lttng_snapshot_output *output, uint32_t *id);
 127 int cmd_snapshot_del_output(struct ltt_session *session,
 128                 const struct lttng_snapshot_output *output);
 129 int cmd_snapshot_record(struct ltt_session *session,
 130                 const struct lttng_snapshot_output *output, int wait);
 131
 132 int cmd_set_session_shm_path(struct ltt_session *session,
 133                 const char *shm_path);
 134 int cmd_regenerate_metadata(struct ltt_session *session);
 135 int cmd_regenerate_statedump(struct ltt_session *session);
 136
 137 int cmd_register_trigger(struct command_ctx *cmd_ctx, int sock,
 138                 struct notification_thread_handle *notification_thread_handle);
 139 int cmd_unregister_trigger(struct command_ctx *cmd_ctx, int sock,
 140                 struct notification_thread_handle *notification_thread_handle);
 141
 142 int cmd_rotate_session(struct ltt_session *session,
 143                 struct lttng_rotate_session_return *rotate_return,
 144                 bool quiet_rotation,
 145                 enum lttng_trace_chunk_command_type command);
 146 int cmd_rotate_get_info(struct ltt_session *session,
 147                 struct lttng_rotation_get_info_return *info_return,
 148                 uint64_t rotate_id);
 149 int cmd_rotation_set_schedule(struct ltt_session *session,
 150                 bool activate, enum lttng_rotation_schedule_type schedule_type,
 151                 uint64_t value,
 152                 struct notification_thread_handle *notification_thread_handle);
 153
 154 const struct cmd_completion_handler *cmd_pop_completion_handler(void);
 155 int start_kernel_session(struct ltt_kernel_session *ksess);
 156 int stop_kernel_session(struct ltt_kernel_session *ksess);
 157
 158 #endif /* CMD_H */