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