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