CLI: Add trace format mi to session mi
[deliverable/lttng-tools.git] / src / common / mi-lttng.cpp
1 /*
2 * Copyright (C) 2014 EfficiOS Inc.
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
5 * SPDX-License-Identifier: LGPL-2.1-only
6 *
7 */
8
9 #include "lttng/tracker.h"
10 #define _LGPL_SOURCE
11 #include "mi-lttng.hpp"
12 #include <common/config/session-config.hpp>
13 #include <common/defaults.hpp>
14 #include <common/tracker.hpp>
15 #include <lttng/channel.h>
16 #include <lttng/snapshot-internal.hpp>
17 #include <lttng/trace-format-descriptor-internal.hpp>
18
19 #define MI_SCHEMA_MAJOR_VERSION 4
20 #define MI_SCHEMA_MINOR_VERSION 1
21
22 /* Machine interface namespace URI */
23 const char * const mi_lttng_xmlns = "xmlns";
24 const char * const mi_lttng_xmlns_xsi = "xmlns:xsi";
25 const char * const mi_lttng_w3_schema_uri = "http://www.w3.org/2001/XMLSchema-instance";
26 const char * const mi_lttng_schema_location = "xsi:schemaLocation";
27 const char * const mi_lttng_schema_location_uri =
28 DEFAULT_LTTNG_MI_NAMESPACE " "
29 "https://lttng.org/xml/schemas/lttng-mi/" XSTR(MI_SCHEMA_MAJOR_VERSION)
30 "/lttng-mi-" XSTR(MI_SCHEMA_MAJOR_VERSION) "."
31 XSTR(MI_SCHEMA_MINOR_VERSION) ".xsd";
32 const char * const mi_lttng_schema_version = "schemaVersion";
33 const char * const mi_lttng_schema_version_value = XSTR(MI_SCHEMA_MAJOR_VERSION)
34 "." XSTR(MI_SCHEMA_MINOR_VERSION);
35
36 /* Strings related to command */
37 const char * const mi_lttng_element_command = "command";
38 const char * const mi_lttng_element_command_action = "snapshot_action";
39 const char * const mi_lttng_element_command_add_context = "add-context";
40 const char *const mi_lttng_element_command_add_trigger = "add-trigger";
41 const char * const mi_lttng_element_command_create = "create";
42 const char * const mi_lttng_element_command_destroy = "destroy";
43 const char * const mi_lttng_element_command_disable_channel = "disable-channel";
44 const char * const mi_lttng_element_command_disable_event = "disable-event";
45 const char * const mi_lttng_element_command_enable_channels = "enable-channel";
46 const char * const mi_lttng_element_command_enable_event = "enable-event";
47 const char * const mi_lttng_element_command_list = "list";
48 const char *const mi_lttng_element_command_list_trigger = "list-trigger";
49 const char * const mi_lttng_element_command_load = "load";
50 const char * const mi_lttng_element_command_metadata = "metadata";
51 const char * const mi_lttng_element_command_metadata_action = "metadata_action";
52 const char * const mi_lttng_element_command_regenerate = "regenerate";
53 const char * const mi_lttng_element_command_regenerate_action = "regenerate_action";
54 const char * const mi_lttng_element_command_name = "name";
55 const char * const mi_lttng_element_command_output = "output";
56 const char *const mi_lttng_element_command_remove_trigger = "remove-trigger";
57 const char * const mi_lttng_element_command_save = "save";
58 const char * const mi_lttng_element_command_set_session = "set-session";
59 const char * const mi_lttng_element_command_snapshot = "snapshot";
60 const char * const mi_lttng_element_command_snapshot_add = "add_snapshot";
61 const char * const mi_lttng_element_command_snapshot_del = "del_snapshot";
62 const char * const mi_lttng_element_command_snapshot_list = "list_snapshot";
63 const char * const mi_lttng_element_command_snapshot_record = "record_snapshot";
64 const char * const mi_lttng_element_command_start = "start";
65 const char * const mi_lttng_element_command_stop = "stop";
66 const char * const mi_lttng_element_command_success = "success";
67 const char * const mi_lttng_element_command_track = "track";
68 const char * const mi_lttng_element_command_untrack = "untrack";
69 const char * const mi_lttng_element_command_version = "version";
70 const char * const mi_lttng_element_command_rotate = "rotate";
71 const char * const mi_lttng_element_command_enable_rotation = "enable-rotation";
72 const char * const mi_lttng_element_command_disable_rotation = "disable-rotation";
73 const char * const mi_lttng_element_command_clear = "clear";
74
75 /* Strings related to version command */
76 const char * const mi_lttng_element_version = "version";
77 const char * const mi_lttng_element_version_commit = "commit";
78 const char * const mi_lttng_element_version_description = "description";
79 const char * const mi_lttng_element_version_license = "license";
80 const char * const mi_lttng_element_version_major = "major";
81 const char * const mi_lttng_element_version_minor = "minor";
82 const char * const mi_lttng_element_version_patch_level = "patchLevel";
83 const char * const mi_lttng_element_version_str = "string";
84 const char * const mi_lttng_element_version_web = "url";
85
86 /* String related to a lttng_event_field */
87 const char * const mi_lttng_element_event_field = "event_field";
88 const char * const mi_lttng_element_event_fields = "event_fields";
89
90 /* String related to lttng_event_perf_counter_ctx */
91 const char * const mi_lttng_element_perf_counter_context = "perf";
92
93 /* Strings related to pid */
94 const char * const mi_lttng_element_pid_id = "id";
95
96 /* Strings related to save command */
97 const char * const mi_lttng_element_save = "save";
98
99 /* Strings related to load command */
100 const char * const mi_lttng_element_load = "load";
101 const char * const mi_lttng_element_load_overrides = "overrides";
102 const char * const mi_lttng_element_load_override_url = "url";
103
104 /* General elements of mi_lttng */
105 const char * const mi_lttng_element_empty = "";
106 const char * const mi_lttng_element_id = "id";
107 const char * const mi_lttng_element_nowrite = "nowrite";
108 const char * const mi_lttng_element_success = "success";
109 const char * const mi_lttng_element_type_enum = "ENUM";
110 const char * const mi_lttng_element_type_float = "FLOAT";
111 const char * const mi_lttng_element_type_integer = "INTEGER";
112 const char * const mi_lttng_element_type_other = "OTHER";
113 const char * const mi_lttng_element_type_string = "STRING";
114
115 /* String related to loglevel */
116 const char * const mi_lttng_loglevel_str_alert = "TRACE_ALERT";
117 const char * const mi_lttng_loglevel_str_crit = "TRACE_CRIT";
118 const char * const mi_lttng_loglevel_str_debug = "TRACE_DEBUG";
119 const char * const mi_lttng_loglevel_str_debug_function = "TRACE_DEBUG_FUNCTION";
120 const char * const mi_lttng_loglevel_str_debug_line = "TRACE_DEBUG_LINE";
121 const char * const mi_lttng_loglevel_str_debug_module = "TRACE_DEBUG_MODULE";
122 const char * const mi_lttng_loglevel_str_debug_process = "TRACE_DEBUG_PROCESS";
123 const char * const mi_lttng_loglevel_str_debug_program = "TRACE_DEBUG_PROGRAM";
124 const char * const mi_lttng_loglevel_str_debug_system = "TRACE_DEBUG_SYSTEM";
125 const char * const mi_lttng_loglevel_str_debug_unit = "TRACE_DEBUG_UNIT";
126 const char * const mi_lttng_loglevel_str_emerg = "TRACE_EMERG";
127 const char * const mi_lttng_loglevel_str_err = "TRACE_ERR";
128 const char * const mi_lttng_loglevel_str_info = "TRACE_INFO";
129 const char * const mi_lttng_loglevel_str_notice = "TRACE_NOTICE";
130 const char * const mi_lttng_loglevel_str_unknown = "UNKNOWN";
131 const char * const mi_lttng_loglevel_str_warning = "TRACE_WARNING";
132
133 /* String related to loglevel JUL */
134 const char * const mi_lttng_loglevel_str_jul_all = "JUL_ALL";
135 const char * const mi_lttng_loglevel_str_jul_config = "JUL_CONFIG";
136 const char * const mi_lttng_loglevel_str_jul_fine = "JUL_FINE";
137 const char * const mi_lttng_loglevel_str_jul_finer = "JUL_FINER";
138 const char * const mi_lttng_loglevel_str_jul_finest = "JUL_FINEST";
139 const char * const mi_lttng_loglevel_str_jul_info = "JUL_INFO";
140 const char * const mi_lttng_loglevel_str_jul_off = "JUL_OFF";
141 const char * const mi_lttng_loglevel_str_jul_severe = "JUL_SEVERE";
142 const char * const mi_lttng_loglevel_str_jul_warning = "JUL_WARNING";
143
144 /* String related to loglevel LOG4J */
145 const char * const mi_lttng_loglevel_str_log4j_off = "LOG4J_OFF";
146 const char * const mi_lttng_loglevel_str_log4j_fatal = "LOG4J_FATAL";
147 const char * const mi_lttng_loglevel_str_log4j_error = "LOG4J_ERROR";
148 const char * const mi_lttng_loglevel_str_log4j_warn = "LOG4J_WARN";
149 const char * const mi_lttng_loglevel_str_log4j_info = "LOG4J_INFO";
150 const char * const mi_lttng_loglevel_str_log4j_debug = "LOG4J_DEBUG";
151 const char * const mi_lttng_loglevel_str_log4j_trace = "LOG4J_TRACE";
152 const char * const mi_lttng_loglevel_str_log4j_all = "LOG4J_ALL";
153
154 /* String related to loglevel Python */
155 const char * const mi_lttng_loglevel_str_python_critical = "PYTHON_CRITICAL";
156 const char * const mi_lttng_loglevel_str_python_error = "PYTHON_ERROR";
157 const char * const mi_lttng_loglevel_str_python_warning = "PYTHON_WARNING";
158 const char * const mi_lttng_loglevel_str_python_info = "PYTHON_INFO";
159 const char * const mi_lttng_loglevel_str_python_debug = "PYTHON_DEBUG";
160 const char * const mi_lttng_loglevel_str_python_notset = "PYTHON_NOTSET";
161
162 /* String related to loglevel type */
163 const char * const mi_lttng_loglevel_type_all = "ALL";
164 const char * const mi_lttng_loglevel_type_range = "RANGE";
165 const char * const mi_lttng_loglevel_type_single = "SINGLE";
166 const char * const mi_lttng_loglevel_type_unknown = "UNKNOWN";
167
168 /* String related to a lttng_snapshot_output */
169 const char * const mi_lttng_element_snapshot_ctrl_url = "ctrl_url";
170 const char * const mi_lttng_element_snapshot_data_url = "data_url";
171 const char * const mi_lttng_element_snapshot_max_size = "max_size";
172 const char * const mi_lttng_element_snapshot_n_ptr = "n_ptr";
173 const char * const mi_lttng_element_snapshot_session_name = "session_name";
174 const char * const mi_lttng_element_snapshots = "snapshots";
175
176 /* String related to track/untrack command */
177 const char * const mi_lttng_element_track_untrack_all_wildcard = "*";
178
179 const char * const mi_lttng_element_session_name = "session_name";
180
181 /* String related to rotate command */
182 const char * const mi_lttng_element_rotation = "rotation";
183 const char * const mi_lttng_element_rotate_status = "status";
184 const char * const mi_lttng_element_rotation_schedule = "rotation_schedule";
185 const char * const mi_lttng_element_rotation_schedules = "rotation_schedules";
186 const char * const mi_lttng_element_rotation_schedule_result = "rotation_schedule_result";
187 const char * const mi_lttng_element_rotation_schedule_results = "rotation_schedule_results";
188 const char * const mi_lttng_element_rotation_schedule_periodic = "periodic";
189 const char * const mi_lttng_element_rotation_schedule_periodic_time_us = "time_us";
190 const char * const mi_lttng_element_rotation_schedule_size_threshold = "size_threshold";
191 const char * const mi_lttng_element_rotation_schedule_size_threshold_bytes = "bytes";
192 const char * const mi_lttng_element_rotation_state = "state";
193 const char * const mi_lttng_element_rotation_location = "location";
194 const char * const mi_lttng_element_rotation_location_local = "local";
195 const char * const mi_lttng_element_rotation_location_local_absolute_path = "absolute_path";
196 const char * const mi_lttng_element_rotation_location_relay = "relay";
197 const char * const mi_lttng_element_rotation_location_relay_host = "host";
198 const char * const mi_lttng_element_rotation_location_relay_control_port = "control_port";
199 const char * const mi_lttng_element_rotation_location_relay_data_port = "data_port";
200 const char * const mi_lttng_element_rotation_location_relay_protocol = "protocol";
201 const char * const mi_lttng_element_rotation_location_relay_relative_path = "relative_path";
202
203 /* String related to enum lttng_rotation_state */
204 const char * const mi_lttng_rotation_state_str_ongoing = "ONGOING";
205 const char * const mi_lttng_rotation_state_str_completed = "COMPLETED";
206 const char * const mi_lttng_rotation_state_str_expired = "EXPIRED";
207 const char * const mi_lttng_rotation_state_str_error = "ERROR";
208
209 /* String related to enum lttng_trace_archive_location_relay_protocol_type */
210 const char * const mi_lttng_rotation_location_relay_protocol_str_tcp = "TCP";
211
212 /* String related to rate_policy elements */
213 const char *const mi_lttng_element_rate_policy = "rate_policy";
214 const char *const mi_lttng_element_rate_policy_every_n =
215 "rate_policy_every_n";
216 const char *const mi_lttng_element_rate_policy_once_after_n =
217 "rate_policy_once_after_n";
218
219 const char *const mi_lttng_element_rate_policy_every_n_interval =
220 "interval";
221 const char
222 *const mi_lttng_element_rate_policy_once_after_n_threshold =
223 "threshold";
224
225 /* String related to action elements */
226 const char *const mi_lttng_element_action = "action";
227 const char *const mi_lttng_element_action_list = "action_list";
228 const char *const mi_lttng_element_action_notify = "action_notify";
229 const char *const mi_lttng_element_action_start_session =
230 "action_start_session";
231 const char *const mi_lttng_element_action_stop_session =
232 "action_stop_session";
233 const char *const mi_lttng_element_action_rotate_session =
234 "action_rotate_session";
235 const char *const mi_lttng_element_action_snapshot_session =
236 "action_snapshot_session";
237 const char *const mi_lttng_element_action_snapshot_session_output =
238 "output";
239
240 /* String related to condition */
241 const char *const mi_lttng_element_condition = "condition";
242 const char *const mi_lttng_element_condition_buffer_usage_high =
243 "condition_buffer_usage_high";
244 const char *const mi_lttng_element_condition_buffer_usage_low =
245 "condition_buffer_usage_low";
246 const char *const mi_lttng_element_condition_event_rule_matches =
247 "condition_event_rule_matches";
248 const char *const mi_lttng_element_condition_session_consumed_size =
249 "condition_session_consumed_size";
250 const char *const mi_lttng_element_condition_session_rotation =
251 "condition_session_rotation";
252 const char
253 *const mi_lttng_element_condition_session_rotation_completed =
254 "condition_session_rotation_completed";
255 const char
256 *const mi_lttng_element_condition_session_rotation_ongoing =
257 "condition_session_rotation_ongoing";
258
259 const char *const mi_lttng_element_condition_channel_name =
260 "channel_name";
261 const char *const mi_lttng_element_condition_threshold_bytes =
262 "threshold_bytes";
263 const char *const mi_lttng_element_condition_threshold_ratio =
264 "threshold_ratio";
265
266 /* String related to capture descriptor */
267 const char *const mi_lttng_element_capture_descriptor =
268 "capture_descriptor";
269 const char *const mi_lttng_element_capture_descriptors =
270 "capture_descriptors";
271
272 /* String related to event expression */
273 const char *const mi_lttng_element_event_expr = "event_expr";
274 const char *const mi_lttng_element_event_expr_payload_field =
275 "event_expr_payload_field";
276 const char *const mi_lttng_element_event_expr_channel_context_field =
277 "event_expr_channel_context_field";
278 const char
279 *const mi_lttng_element_event_expr_app_specific_context_field =
280 "event_expr_app_specific_context_field";
281 const char *const mi_lttng_element_event_expr_array_field_element =
282 "event_expr_array_field_element";
283 const char *const mi_lttng_element_event_expr_provider_name =
284 "provider_name";
285 const char *const mi_lttng_element_event_expr_type_name =
286 "type_name";
287 const char *const mi_lttng_element_event_expr_index = "index";
288
289 /* String related to event rule */
290 const char *const mi_lttng_element_event_rule = "event_rule";
291
292 /* String related to lttng_event_rule_type */
293 const char *const mi_lttng_element_event_rule_event_name =
294 "event_name";
295 const char *const mi_lttng_element_event_rule_name_pattern =
296 "name_pattern";
297 const char *const mi_lttng_element_event_rule_filter_expression =
298 "filter_expression";
299
300 const char *const mi_lttng_element_event_rule_jul_logging =
301 "event_rule_jul_logging";
302 const char *const mi_lttng_element_event_rule_kernel_kprobe =
303 "event_rule_kernel_kprobe";
304 const char *const mi_lttng_element_event_rule_kernel_syscall =
305 "event_rule_kernel_syscall";
306 const char *const mi_lttng_element_event_rule_kernel_tracepoint =
307 "event_rule_kernel_tracepoint";
308 const char *const mi_lttng_element_event_rule_kernel_uprobe =
309 "event_rule_kernel_uprobe";
310 const char *const mi_lttng_element_event_rule_log4j_logging =
311 "event_rule_log4j_logging";
312 const char *const mi_lttng_element_event_rule_python_logging =
313 "event_rule_python_logging";
314 const char *const mi_lttng_element_event_rule_user_tracepoint =
315 "event_rule_user_tracepoint";
316
317 /* String related to lttng_event_rule_kernel_syscall. */
318 const char *const
319 mi_lttng_element_event_rule_kernel_syscall_emission_site =
320 "emission_site";
321
322 /* String related to enum lttng_event_rule_kernel_syscall_emission_site. */
323 const char *const
324 mi_lttng_event_rule_kernel_syscall_emission_site_entry_exit =
325 "entry+exit";
326 const char
327 *const mi_lttng_event_rule_kernel_syscall_emission_site_entry =
328 "entry";
329 const char *const
330 mi_lttng_event_rule_kernel_syscall_emission_site_exit = "exit";
331
332 /* String related to lttng_event_rule_user_tracepoint */
333 const char *const
334 mi_lttng_element_event_rule_user_tracepoint_name_pattern_exclusions =
335 "name_pattern_exclusions";
336 const char *const
337 mi_lttng_element_event_rule_user_tracepoint_name_pattern_exclusion =
338 "name_pattern_exclusion";
339
340 /* String related to log level rule. */
341 const char *const mi_lttng_element_log_level_rule =
342 "log_level_rule";
343 const char *const mi_lttng_element_log_level_rule_exactly =
344 "log_level_rule_exactly";
345 const char
346 *const mi_lttng_element_log_level_rule_at_least_as_severe_as =
347 "log_level_rule_at_least_as_severe_as";
348 const char *const mi_lttng_element_log_level_rule_level = "level";
349
350 /* String related to kernel probe location. */
351 const char *const mi_lttng_element_kernel_probe_location =
352 "kernel_probe_location";
353 const char
354 *const mi_lttng_element_kernel_probe_location_symbol_offset =
355 "kernel_probe_location_symbol_offset";
356 const char *const
357 mi_lttng_element_kernel_probe_location_symbol_offset_name =
358 "name";
359 const char *const
360 mi_lttng_element_kernel_probe_location_symbol_offset_offset =
361 "offset";
362
363 const char *const mi_lttng_element_kernel_probe_location_address =
364 "kernel_probe_location_address";
365 const char
366 *const mi_lttng_element_kernel_probe_location_address_address =
367 "address";
368
369 /* String related to userspace probe location. */
370 const char *const mi_lttng_element_userspace_probe_location =
371 "userspace_probe_location";
372 const char
373 *const mi_lttng_element_userspace_probe_location_binary_path =
374 "binary_path";
375 const char
376 *const mi_lttng_element_userspace_probe_location_function =
377 "userspace_probe_location_function";
378 const char
379 *const mi_lttng_element_userspace_probe_location_function_name =
380 "name";
381 const char
382 *const mi_lttng_element_userspace_probe_location_lookup_method =
383 "userspace_probe_location_lookup_method";
384 const char *const
385 mi_lttng_element_userspace_probe_location_lookup_method_function_default =
386 "userspace_probe_location_lookup_method_function_default";
387 const char *const
388 mi_lttng_element_userspace_probe_location_lookup_method_function_elf =
389 "userspace_probe_location_lookup_method_function_elf";
390 const char *const
391 mi_lttng_element_userspace_probe_location_lookup_method_tracepoint_sdt =
392 "userspace_probe_location_lookup_method_tracepoint_sdt";
393 const char
394 *const mi_lttng_element_userspace_probe_location_tracepoint =
395 "userspace_probe_location_tracepoint";
396 const char *const
397 mi_lttng_element_userspace_probe_location_tracepoint_probe_name =
398 "probe_name";
399 const char *const
400 mi_lttng_element_userspace_probe_location_tracepoint_provider_name =
401 "provider_name";
402
403 /* String related to enum
404 * lttng_userspace_probe_location_function_instrumentation_type */
405 const char *const
406 mi_lttng_element_userspace_probe_location_function_instrumentation_type =
407 "instrumentation_type";
408 const char *const
409 mi_lttng_userspace_probe_location_function_instrumentation_type_entry =
410 "ENTRY";
411
412 /* String related to trigger */
413 const char *const mi_lttng_element_triggers = "triggers";
414 const char *const mi_lttng_element_trigger = "trigger";
415 const char *const mi_lttng_element_trigger_owner_uid = "owner_uid";
416
417 /* String related to error_query. */
418 const char *const mi_lttng_element_error_query_result =
419 "error_query_result";
420 const char *const mi_lttng_element_error_query_result_counter =
421 "error_query_result_counter";
422 const char *const
423 mi_lttng_element_error_query_result_counter_value = "value";
424 const char *const mi_lttng_element_error_query_result_description =
425 "description";
426 const char *const mi_lttng_element_error_query_result_name =
427 "name";
428 const char *const mi_lttng_element_error_query_result_type =
429 "type";
430 const char *const mi_lttng_element_error_query_results =
431 "error_query_results";
432
433 /* String related to add-context command */
434 const char * const mi_lttng_element_context_symbol = "symbol";
435
436 /* Deprecated symbols preserved for ABI compatibility. */
437 LTTNG_EXPORT const char *mi_lttng_context_type_perf_counter;
438 LTTNG_EXPORT const char *mi_lttng_context_type_perf_cpu_counter;
439 LTTNG_EXPORT const char *mi_lttng_context_type_perf_thread_counter;
440 LTTNG_EXPORT const char *mi_lttng_element_track_untrack_pid_target;
441 LTTNG_EXPORT const char *mi_lttng_element_track_untrack_targets;
442 LTTNG_EXPORT const char *mi_lttng_element_calibrate;
443 LTTNG_EXPORT const char *mi_lttng_element_calibrate_function;
444 LTTNG_EXPORT const char *mi_lttng_element_command_calibrate;
445
446 /* This is a merge of jul loglevel and regular loglevel
447 * Those should never overlap by definition
448 * (see struct lttng_event loglevel)
449 */
450 const char *mi_lttng_loglevel_string(int value, enum lttng_domain_type domain)
451 {
452 switch (domain) {
453 case LTTNG_DOMAIN_KERNEL:
454 case LTTNG_DOMAIN_UST:
455 switch (value) {
456 case -1:
457 return mi_lttng_element_empty;
458 case LTTNG_LOGLEVEL_EMERG:
459 return mi_lttng_loglevel_str_emerg;
460 case LTTNG_LOGLEVEL_ALERT:
461 return mi_lttng_loglevel_str_alert;
462 case LTTNG_LOGLEVEL_CRIT:
463 return mi_lttng_loglevel_str_crit;
464 case LTTNG_LOGLEVEL_ERR:
465 return mi_lttng_loglevel_str_err;
466 case LTTNG_LOGLEVEL_WARNING:
467 return mi_lttng_loglevel_str_warning;
468 case LTTNG_LOGLEVEL_NOTICE:
469 return mi_lttng_loglevel_str_notice;
470 case LTTNG_LOGLEVEL_INFO:
471 return mi_lttng_loglevel_str_info;
472 case LTTNG_LOGLEVEL_DEBUG_SYSTEM:
473 return mi_lttng_loglevel_str_debug_system;
474 case LTTNG_LOGLEVEL_DEBUG_PROGRAM:
475 return mi_lttng_loglevel_str_debug_program;
476 case LTTNG_LOGLEVEL_DEBUG_PROCESS:
477 return mi_lttng_loglevel_str_debug_process;
478 case LTTNG_LOGLEVEL_DEBUG_MODULE:
479 return mi_lttng_loglevel_str_debug_module;
480 case LTTNG_LOGLEVEL_DEBUG_UNIT:
481 return mi_lttng_loglevel_str_debug_unit;
482 case LTTNG_LOGLEVEL_DEBUG_FUNCTION:
483 return mi_lttng_loglevel_str_debug_function;
484 case LTTNG_LOGLEVEL_DEBUG_LINE:
485 return mi_lttng_loglevel_str_debug_line;
486 case LTTNG_LOGLEVEL_DEBUG:
487 return mi_lttng_loglevel_str_debug;
488 default:
489 return mi_lttng_loglevel_str_unknown;
490 }
491 break;
492 case LTTNG_DOMAIN_LOG4J:
493 switch (value) {
494 case -1:
495 return mi_lttng_element_empty;
496 case LTTNG_LOGLEVEL_LOG4J_OFF:
497 return mi_lttng_loglevel_str_log4j_off;
498 case LTTNG_LOGLEVEL_LOG4J_FATAL:
499 return mi_lttng_loglevel_str_log4j_fatal;
500 case LTTNG_LOGLEVEL_LOG4J_ERROR:
501 return mi_lttng_loglevel_str_log4j_error;
502 case LTTNG_LOGLEVEL_LOG4J_WARN:
503 return mi_lttng_loglevel_str_log4j_warn;
504 case LTTNG_LOGLEVEL_LOG4J_INFO:
505 return mi_lttng_loglevel_str_log4j_info;
506 case LTTNG_LOGLEVEL_LOG4J_DEBUG:
507 return mi_lttng_loglevel_str_log4j_debug;
508 case LTTNG_LOGLEVEL_LOG4J_TRACE:
509 return mi_lttng_loglevel_str_log4j_trace;
510 case LTTNG_LOGLEVEL_LOG4J_ALL:
511 return mi_lttng_loglevel_str_log4j_all;
512 default:
513 return mi_lttng_loglevel_str_unknown;
514 }
515 break;
516 case LTTNG_DOMAIN_JUL:
517 switch (value) {
518 case -1:
519 return mi_lttng_element_empty;
520 case LTTNG_LOGLEVEL_JUL_OFF:
521 return mi_lttng_loglevel_str_jul_off;
522 case LTTNG_LOGLEVEL_JUL_SEVERE:
523 return mi_lttng_loglevel_str_jul_severe;
524 case LTTNG_LOGLEVEL_JUL_WARNING:
525 return mi_lttng_loglevel_str_jul_warning;
526 case LTTNG_LOGLEVEL_JUL_INFO:
527 return mi_lttng_loglevel_str_jul_info;
528 case LTTNG_LOGLEVEL_JUL_CONFIG:
529 return mi_lttng_loglevel_str_jul_config;
530 case LTTNG_LOGLEVEL_JUL_FINE:
531 return mi_lttng_loglevel_str_jul_fine;
532 case LTTNG_LOGLEVEL_JUL_FINER:
533 return mi_lttng_loglevel_str_jul_finer;
534 case LTTNG_LOGLEVEL_JUL_FINEST:
535 return mi_lttng_loglevel_str_jul_finest;
536 case LTTNG_LOGLEVEL_JUL_ALL:
537 return mi_lttng_loglevel_str_jul_all;
538 default:
539 return mi_lttng_loglevel_str_unknown;
540 }
541 break;
542 case LTTNG_DOMAIN_PYTHON:
543 switch (value) {
544 case LTTNG_LOGLEVEL_PYTHON_CRITICAL:
545 return mi_lttng_loglevel_str_python_critical;
546 case LTTNG_LOGLEVEL_PYTHON_ERROR:
547 return mi_lttng_loglevel_str_python_error;
548 case LTTNG_LOGLEVEL_PYTHON_WARNING:
549 return mi_lttng_loglevel_str_python_warning;
550 case LTTNG_LOGLEVEL_PYTHON_INFO:
551 return mi_lttng_loglevel_str_python_info;
552 case LTTNG_LOGLEVEL_PYTHON_DEBUG:
553 return mi_lttng_loglevel_str_python_debug;
554 case LTTNG_LOGLEVEL_PYTHON_NOTSET:
555 return mi_lttng_loglevel_str_python_notset;
556 default:
557 return mi_lttng_loglevel_str_unknown;
558 }
559 break;
560 default:
561 return mi_lttng_loglevel_str_unknown;
562 }
563 }
564
565 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value)
566 {
567 switch (value) {
568 case LTTNG_EVENT_LOGLEVEL_ALL:
569 return mi_lttng_loglevel_type_all;
570 case LTTNG_EVENT_LOGLEVEL_RANGE:
571 return mi_lttng_loglevel_type_range;
572 case LTTNG_EVENT_LOGLEVEL_SINGLE:
573 return mi_lttng_loglevel_type_single;
574 default:
575 return mi_lttng_loglevel_type_unknown;
576 }
577 }
578
579 static
580 const char *mi_lttng_eventtype_string(enum lttng_event_type value)
581 {
582 switch (value) {
583 case LTTNG_EVENT_ALL:
584 return config_event_type_all;
585 case LTTNG_EVENT_TRACEPOINT:
586 return config_event_type_tracepoint;
587 case LTTNG_EVENT_PROBE:
588 return config_event_type_probe;
589 case LTTNG_EVENT_USERSPACE_PROBE:
590 return config_event_type_userspace_probe;
591 case LTTNG_EVENT_FUNCTION:
592 return config_event_type_function;
593 case LTTNG_EVENT_FUNCTION_ENTRY:
594 return config_event_type_function_entry;
595 case LTTNG_EVENT_SYSCALL:
596 return config_event_type_syscall;
597 case LTTNG_EVENT_NOOP:
598 return config_event_type_noop;
599 default:
600 return mi_lttng_element_empty;
601 }
602 }
603
604 static
605 const char *mi_lttng_event_contexttype_string(enum lttng_event_context_type val)
606 {
607 switch (val) {
608 case LTTNG_EVENT_CONTEXT_PID:
609 return config_event_context_pid;
610 case LTTNG_EVENT_CONTEXT_PROCNAME:
611 return config_event_context_procname;
612 case LTTNG_EVENT_CONTEXT_PRIO:
613 return config_event_context_prio;
614 case LTTNG_EVENT_CONTEXT_NICE:
615 return config_event_context_nice;
616 case LTTNG_EVENT_CONTEXT_VPID:
617 return config_event_context_vpid;
618 case LTTNG_EVENT_CONTEXT_TID:
619 return config_event_context_tid;
620 case LTTNG_EVENT_CONTEXT_VTID:
621 return config_event_context_vtid;
622 case LTTNG_EVENT_CONTEXT_PPID:
623 return config_event_context_ppid;
624 case LTTNG_EVENT_CONTEXT_VPPID:
625 return config_event_context_vppid;
626 case LTTNG_EVENT_CONTEXT_PTHREAD_ID:
627 return config_event_context_pthread_id;
628 case LTTNG_EVENT_CONTEXT_HOSTNAME:
629 return config_event_context_hostname;
630 case LTTNG_EVENT_CONTEXT_IP:
631 return config_event_context_ip;
632 case LTTNG_EVENT_CONTEXT_INTERRUPTIBLE:
633 return config_event_context_interruptible;
634 case LTTNG_EVENT_CONTEXT_PREEMPTIBLE:
635 return config_event_context_preemptible;
636 case LTTNG_EVENT_CONTEXT_NEED_RESCHEDULE:
637 return config_event_context_need_reschedule;
638 case LTTNG_EVENT_CONTEXT_MIGRATABLE:
639 return config_event_context_migratable;
640 case LTTNG_EVENT_CONTEXT_CALLSTACK_USER:
641 return config_event_context_callstack_user;
642 case LTTNG_EVENT_CONTEXT_CALLSTACK_KERNEL:
643 return config_event_context_callstack_kernel;
644 case LTTNG_EVENT_CONTEXT_CGROUP_NS:
645 return config_event_context_cgroup_ns;
646 case LTTNG_EVENT_CONTEXT_IPC_NS:
647 return config_event_context_ipc_ns;
648 case LTTNG_EVENT_CONTEXT_MNT_NS:
649 return config_event_context_mnt_ns;
650 case LTTNG_EVENT_CONTEXT_NET_NS:
651 return config_event_context_net_ns;
652 case LTTNG_EVENT_CONTEXT_PID_NS:
653 return config_event_context_pid_ns;
654 case LTTNG_EVENT_CONTEXT_TIME_NS:
655 return config_event_context_time_ns;
656 case LTTNG_EVENT_CONTEXT_USER_NS:
657 return config_event_context_user_ns;
658 case LTTNG_EVENT_CONTEXT_UTS_NS:
659 return config_event_context_uts_ns;
660 case LTTNG_EVENT_CONTEXT_UID:
661 return config_event_context_uid;
662 case LTTNG_EVENT_CONTEXT_EUID:
663 return config_event_context_euid;
664 case LTTNG_EVENT_CONTEXT_SUID:
665 return config_event_context_suid;
666 case LTTNG_EVENT_CONTEXT_GID:
667 return config_event_context_gid;
668 case LTTNG_EVENT_CONTEXT_EGID:
669 return config_event_context_egid;
670 case LTTNG_EVENT_CONTEXT_SGID:
671 return config_event_context_sgid;
672 case LTTNG_EVENT_CONTEXT_VUID:
673 return config_event_context_vuid;
674 case LTTNG_EVENT_CONTEXT_VEUID:
675 return config_event_context_veuid;
676 case LTTNG_EVENT_CONTEXT_VSUID:
677 return config_event_context_vsuid;
678 case LTTNG_EVENT_CONTEXT_VGID:
679 return config_event_context_vgid;
680 case LTTNG_EVENT_CONTEXT_VEGID:
681 return config_event_context_vegid;
682 case LTTNG_EVENT_CONTEXT_VSGID:
683 return config_event_context_vsgid;
684 default:
685 return NULL;
686 }
687 }
688
689 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val)
690 {
691 switch (val) {
692 case(LTTNG_EVENT_FIELD_INTEGER):
693 return mi_lttng_element_type_integer;
694 case(LTTNG_EVENT_FIELD_ENUM):
695 return mi_lttng_element_type_enum;
696 case(LTTNG_EVENT_FIELD_FLOAT):
697 return mi_lttng_element_type_float;
698 case(LTTNG_EVENT_FIELD_STRING):
699 return mi_lttng_element_type_string;
700 default:
701 return mi_lttng_element_type_other;
702 }
703 }
704
705 const char *mi_lttng_domaintype_string(enum lttng_domain_type value)
706 {
707 switch (value) {
708 case LTTNG_DOMAIN_KERNEL:
709 return config_domain_type_kernel;
710 case LTTNG_DOMAIN_UST:
711 return config_domain_type_ust;
712 case LTTNG_DOMAIN_JUL:
713 return config_domain_type_jul;
714 case LTTNG_DOMAIN_LOG4J:
715 return config_domain_type_log4j;
716 case LTTNG_DOMAIN_PYTHON:
717 return config_domain_type_python;
718 default:
719 /* Should not have an unknown domain */
720 abort();
721 return NULL;
722 }
723 }
724
725 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value)
726 {
727 switch (value) {
728 case LTTNG_BUFFER_PER_PID:
729 return config_buffer_type_per_pid;
730 case LTTNG_BUFFER_PER_UID:
731 return config_buffer_type_per_uid;
732 case LTTNG_BUFFER_GLOBAL:
733 return config_buffer_type_global;
734 default:
735 /* Should not have an unknow buffer type */
736 abort();
737 return NULL;
738 }
739 }
740
741 const char *mi_lttng_rotation_state_string(enum lttng_rotation_state value)
742 {
743 switch (value) {
744 case LTTNG_ROTATION_STATE_ONGOING:
745 return mi_lttng_rotation_state_str_ongoing;
746 case LTTNG_ROTATION_STATE_COMPLETED:
747 return mi_lttng_rotation_state_str_completed;
748 case LTTNG_ROTATION_STATE_EXPIRED:
749 return mi_lttng_rotation_state_str_expired;
750 case LTTNG_ROTATION_STATE_ERROR:
751 return mi_lttng_rotation_state_str_error;
752 default:
753 /* Should not have an unknow rotation state. */
754 abort();
755 return NULL;
756 }
757 }
758
759 const char *mi_lttng_trace_archive_location_relay_protocol_type_string(
760 enum lttng_trace_archive_location_relay_protocol_type value)
761 {
762 switch (value) {
763 case LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP:
764 return mi_lttng_rotation_location_relay_protocol_str_tcp;
765 default:
766 /* Should not have an unknown relay protocol. */
767 abort();
768 return NULL;
769 }
770 }
771
772 struct mi_writer *mi_lttng_writer_create(int fd_output, int mi_output_type)
773 {
774 struct mi_writer *mi_writer;
775
776 mi_writer = zmalloc<struct mi_writer>();
777 if (!mi_writer) {
778 PERROR("zmalloc mi_writer_create");
779 goto end;
780 }
781 if (mi_output_type == LTTNG_MI_XML) {
782 mi_writer->writer = config_writer_create(fd_output, 0);
783 if (!mi_writer->writer) {
784 goto err_destroy;
785 }
786 mi_writer->type = LTTNG_MI_XML;
787 } else {
788 goto err_destroy;
789 }
790
791 end:
792 return mi_writer;
793
794 err_destroy:
795 free(mi_writer);
796 return NULL;
797 }
798
799 int mi_lttng_writer_destroy(struct mi_writer *writer)
800 {
801 int ret;
802
803 if (!writer) {
804 ret = -EINVAL;
805 goto end;
806 }
807
808 ret = config_writer_destroy(writer->writer);
809 if (ret < 0) {
810 goto end;
811 }
812
813 free(writer);
814 end:
815 return ret;
816 }
817
818 int mi_lttng_writer_command_open(struct mi_writer *writer, const char *command)
819 {
820 int ret;
821
822 /*
823 * A command is always the MI's root node, it must declare the current
824 * namespace and schema URIs and the schema's version.
825 */
826 ret = config_writer_open_element(writer->writer,
827 mi_lttng_element_command);
828 if (ret) {
829 goto end;
830 }
831
832 ret = config_writer_write_attribute(writer->writer,
833 mi_lttng_xmlns, DEFAULT_LTTNG_MI_NAMESPACE);
834 if (ret) {
835 goto end;
836 }
837
838 ret = config_writer_write_attribute(writer->writer,
839 mi_lttng_xmlns_xsi, mi_lttng_w3_schema_uri);
840 if (ret) {
841 goto end;
842 }
843
844 ret = config_writer_write_attribute(writer->writer,
845 mi_lttng_schema_location,
846 mi_lttng_schema_location_uri);
847 if (ret) {
848 goto end;
849 }
850
851 ret = config_writer_write_attribute(writer->writer,
852 mi_lttng_schema_version,
853 mi_lttng_schema_version_value);
854 if (ret) {
855 goto end;
856 }
857
858 ret = mi_lttng_writer_write_element_string(writer,
859 mi_lttng_element_command_name, command);
860 end:
861 return ret;
862 }
863
864 int mi_lttng_writer_command_close(struct mi_writer *writer)
865 {
866 return mi_lttng_writer_close_element(writer);
867 }
868
869 int mi_lttng_writer_open_element(struct mi_writer *writer,
870 const char *element_name)
871 {
872 return config_writer_open_element(writer->writer, element_name);
873 }
874
875 int mi_lttng_writer_close_element(struct mi_writer *writer)
876 {
877 return config_writer_close_element(writer->writer);
878 }
879
880 int mi_lttng_close_multi_element(struct mi_writer *writer,
881 unsigned int nb_element)
882 {
883 int ret, i;
884
885 if (nb_element < 1) {
886 ret = 0;
887 goto end;
888 }
889 for (i = 0; i < nb_element; i++) {
890 ret = mi_lttng_writer_close_element(writer);
891 if (ret) {
892 goto end;
893 }
894 }
895 end:
896 return ret;
897 }
898
899 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer *writer,
900 const char *element_name, uint64_t value)
901 {
902 return config_writer_write_element_unsigned_int(writer->writer,
903 element_name, value);
904 }
905
906 int mi_lttng_writer_write_element_signed_int(struct mi_writer *writer,
907 const char *element_name, int64_t value)
908 {
909 return config_writer_write_element_signed_int(writer->writer,
910 element_name, value);
911 }
912
913 int mi_lttng_writer_write_element_bool(struct mi_writer *writer,
914 const char *element_name, int value)
915 {
916 return config_writer_write_element_bool(writer->writer,
917 element_name, value);
918 }
919
920 int mi_lttng_writer_write_element_string(struct mi_writer *writer,
921 const char *element_name, const char *value)
922 {
923 return config_writer_write_element_string(writer->writer,
924 element_name, value);
925 }
926
927 int mi_lttng_writer_write_element_double(struct mi_writer *writer,
928 const char *element_name,
929 double value)
930 {
931 return config_writer_write_element_double(
932 writer->writer, element_name, value);
933 }
934
935 int mi_lttng_version(struct mi_writer *writer, struct mi_lttng_version_data *version,
936 const char *lttng_description, const char *lttng_license)
937 {
938 int ret;
939
940 /* Open version */
941 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_version);
942 if (ret) {
943 goto end;
944 }
945
946 /* Version string (contain info like rc etc.) */
947 ret = mi_lttng_writer_write_element_string(writer,
948 mi_lttng_element_version_str, version->version);
949 if (ret) {
950 goto end;
951 }
952
953 /* Major version number */
954 ret = mi_lttng_writer_write_element_unsigned_int(writer,
955 mi_lttng_element_version_major, version->version_major);
956 if (ret) {
957 goto end;
958 }
959
960 /* Minor version number */
961 ret = mi_lttng_writer_write_element_unsigned_int(writer,
962 mi_lttng_element_version_minor, version->version_minor);
963 if (ret) {
964 goto end;
965 }
966
967 /* Commit version number */
968 ret = mi_lttng_writer_write_element_string(writer,
969 mi_lttng_element_version_commit, version->version_commit);
970 if (ret) {
971 goto end;
972 }
973
974 /* Patch number */
975 ret = mi_lttng_writer_write_element_unsigned_int(writer,
976 mi_lttng_element_version_patch_level, version->version_patchlevel);
977 if (ret) {
978 goto end;
979 }
980
981 /* Name of the version */
982 ret = mi_lttng_writer_write_element_string(writer,
983 config_element_name, version->version_name);
984 if (ret) {
985 goto end;
986 }
987
988 /* Description mostly related to beer... */
989 ret = mi_lttng_writer_write_element_string(writer,
990 mi_lttng_element_version_description, lttng_description);
991 if (ret) {
992 goto end;
993 }
994
995 /* url */
996 ret = mi_lttng_writer_write_element_string(writer,
997 mi_lttng_element_version_web, version->package_url);
998 if (ret) {
999 goto end;
1000 }
1001
1002 /* License: free as in free beer...no...*speech* */
1003 ret = mi_lttng_writer_write_element_string(writer,
1004 mi_lttng_element_version_license, lttng_license);
1005 if (ret) {
1006 goto end;
1007 }
1008
1009 /* Close version element */
1010 ret = mi_lttng_writer_close_element(writer);
1011
1012 end:
1013 return ret;
1014 }
1015
1016 int mi_lttng_sessions_open(struct mi_writer *writer)
1017 {
1018 return mi_lttng_writer_open_element(writer, config_element_sessions);
1019 }
1020
1021 int mi_lttng_session(struct mi_writer *writer,
1022 struct lttng_session *session, int is_open)
1023 {
1024 int ret;
1025 lttng_error_code ret_code;
1026 struct lttng_trace_format_descriptor *trace_format_descriptor = nullptr;
1027
1028 LTTNG_ASSERT(session);
1029
1030 /* Open sessions element */
1031 ret = mi_lttng_writer_open_element(writer,
1032 config_element_session);
1033 if (ret) {
1034 goto end;
1035 }
1036
1037 /* Name of the session */
1038 ret = mi_lttng_writer_write_element_string(writer,
1039 config_element_name, session->name);
1040 if (ret) {
1041 goto end;
1042 }
1043
1044 /* Path */
1045 ret = mi_lttng_writer_write_element_string(writer,
1046 config_element_path, session->path);
1047 if (ret) {
1048 goto end;
1049 }
1050
1051 /* Enabled ? */
1052 ret = mi_lttng_writer_write_element_bool(writer,
1053 config_element_enabled, session->enabled);
1054 if (ret) {
1055 goto end;
1056 }
1057
1058 /* Snapshot mode */
1059 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1060 config_element_snapshot_mode, session->snapshot_mode);
1061 if (ret) {
1062 goto end;
1063 }
1064
1065 /* Live timer interval in usec */
1066 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1067 config_element_live_timer_interval,
1068 session->live_timer_interval);
1069 if (ret) {
1070 goto end;
1071 }
1072
1073 ret_code = lttng_session_get_trace_format_descriptor(session, &trace_format_descriptor);
1074 if (ret_code != LTTNG_OK) {
1075 ret = -1;
1076 goto end;
1077 }
1078
1079 ret_code = reinterpret_cast<lttng::trace_format_descriptor *>(trace_format_descriptor)
1080 ->mi_serialize(writer);
1081 if (ret_code != LTTNG_OK) {
1082 ret = -1;
1083 goto end;
1084 }
1085
1086 if (!is_open) {
1087 /* Closing session element */
1088 ret = mi_lttng_writer_close_element(writer);
1089 }
1090 end:
1091 lttng_trace_format_descriptor_destroy(trace_format_descriptor);
1092 return ret;
1093
1094 }
1095
1096 int mi_lttng_domains_open(struct mi_writer *writer)
1097 {
1098 return mi_lttng_writer_open_element(writer, config_element_domains);
1099 }
1100
1101 int mi_lttng_domain(struct mi_writer *writer,
1102 struct lttng_domain *domain, int is_open)
1103 {
1104 int ret = 0;
1105 const char *str_domain;
1106 const char *str_buffer;
1107
1108 LTTNG_ASSERT(domain);
1109
1110 /* Open domain element */
1111 ret = mi_lttng_writer_open_element(writer, config_element_domain);
1112 if (ret) {
1113 goto end;
1114 }
1115
1116 /* Domain Type */
1117 str_domain = mi_lttng_domaintype_string(domain->type);
1118 ret = mi_lttng_writer_write_element_string(writer, config_element_type,
1119 str_domain);
1120 if (ret) {
1121 goto end;
1122 }
1123
1124 /* Buffer Type */
1125 str_buffer= mi_lttng_buffertype_string(domain->buf_type);
1126 ret = mi_lttng_writer_write_element_string(writer,
1127 config_element_buffer_type, str_buffer);
1128 if (ret) {
1129 goto end;
1130 }
1131
1132 /* TODO: union attr
1133 * This union is not currently used and was added for
1134 * future ust domain support.
1135 * Date: 25-06-2014
1136 * */
1137
1138 if (!is_open) {
1139 /* Closing domain element */
1140 ret = mi_lttng_writer_close_element(writer);
1141 }
1142
1143 end:
1144 return ret;
1145
1146 }
1147
1148 int mi_lttng_channels_open(struct mi_writer *writer)
1149 {
1150 return mi_lttng_writer_open_element(writer, config_element_channels);
1151 }
1152
1153 int mi_lttng_channel(struct mi_writer *writer,
1154 struct lttng_channel *channel, int is_open)
1155 {
1156 int ret = 0;
1157
1158 LTTNG_ASSERT(channel);
1159
1160 /* Opening channel element */
1161 ret = mi_lttng_writer_open_element(writer, config_element_channel);
1162 if (ret) {
1163 goto end;
1164 }
1165
1166 /* Name */
1167 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
1168 channel->name);
1169 if (ret) {
1170 goto end;
1171 }
1172
1173 /* Enabled ? */
1174 ret = mi_lttng_writer_write_element_bool(writer,
1175 config_element_enabled, channel->enabled);
1176 if (ret) {
1177 goto end;
1178 }
1179
1180 /* Attribute */
1181 ret = mi_lttng_channel_attr(writer, &channel->attr);
1182 if (ret) {
1183 goto end;
1184 }
1185
1186 if (!is_open) {
1187 /* Closing channel element */
1188 ret = mi_lttng_writer_close_element(writer);
1189 if (ret) {
1190 goto end;
1191 }
1192 }
1193 end:
1194 return ret;
1195 }
1196
1197 int mi_lttng_channel_attr(struct mi_writer *writer,
1198 struct lttng_channel_attr *attr)
1199 {
1200 int ret = 0;
1201 struct lttng_channel *chan = caa_container_of(attr,
1202 struct lttng_channel, attr);
1203 uint64_t discarded_events, lost_packets, monitor_timer_interval;
1204 int64_t blocking_timeout;
1205
1206 LTTNG_ASSERT(attr);
1207
1208 ret = lttng_channel_get_discarded_event_count(chan, &discarded_events);
1209 if (ret) {
1210 goto end;
1211 }
1212
1213 ret = lttng_channel_get_lost_packet_count(chan, &lost_packets);
1214 if (ret) {
1215 goto end;
1216 }
1217
1218 ret = lttng_channel_get_monitor_timer_interval(chan,
1219 &monitor_timer_interval);
1220 if (ret) {
1221 goto end;
1222 }
1223
1224 ret = lttng_channel_get_blocking_timeout(chan,
1225 &blocking_timeout);
1226 if (ret) {
1227 goto end;
1228 }
1229
1230 /* Opening Attributes */
1231 ret = mi_lttng_writer_open_element(writer, config_element_attributes);
1232 if (ret) {
1233 goto end;
1234 }
1235
1236 /* Overwrite */
1237 ret = mi_lttng_writer_write_element_string(writer,
1238 config_element_overwrite_mode,
1239 attr->overwrite ? config_overwrite_mode_overwrite :
1240 config_overwrite_mode_discard);
1241 if (ret) {
1242 goto end;
1243 }
1244
1245 /* Sub buffer size in byte */
1246 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1247 config_element_subbuf_size, attr->subbuf_size);
1248 if (ret) {
1249 goto end;
1250 }
1251
1252 /* Number of subbuffer (power of two) */
1253 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1254 config_element_num_subbuf,
1255 attr->num_subbuf);
1256 if (ret) {
1257 goto end;
1258 }
1259
1260 /* Switch timer interval in usec */
1261 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1262 config_element_switch_timer_interval,
1263 attr->switch_timer_interval);
1264 if (ret) {
1265 goto end;
1266 }
1267
1268 /* Read timer interval in usec */
1269 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1270 config_element_read_timer_interval,
1271 attr->read_timer_interval);
1272 if (ret) {
1273 goto end;
1274 }
1275
1276 /* Monitor timer interval in usec */
1277 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1278 config_element_monitor_timer_interval,
1279 monitor_timer_interval);
1280 if (ret) {
1281 goto end;
1282 }
1283
1284 /* Retry timeout in usec */
1285 ret = mi_lttng_writer_write_element_signed_int(writer,
1286 config_element_blocking_timeout,
1287 blocking_timeout);
1288 if (ret) {
1289 goto end;
1290 }
1291
1292 /* Event output */
1293 ret = mi_lttng_writer_write_element_string(writer,
1294 config_element_output_type,
1295 attr->output == LTTNG_EVENT_SPLICE ?
1296 config_output_type_splice : config_output_type_mmap);
1297 if (ret) {
1298 goto end;
1299 }
1300
1301 /* Tracefile size in bytes */
1302 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1303 config_element_tracefile_size, attr->tracefile_size);
1304 if (ret) {
1305 goto end;
1306 }
1307
1308 /* Count of tracefiles */
1309 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1310 config_element_tracefile_count,
1311 attr->tracefile_count);
1312 if (ret) {
1313 goto end;
1314 }
1315
1316 /* Live timer interval in usec*/
1317 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1318 config_element_live_timer_interval,
1319 attr->live_timer_interval);
1320 if (ret) {
1321 goto end;
1322 }
1323
1324 /* Discarded events */
1325 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1326 config_element_discarded_events,
1327 discarded_events);
1328 if (ret) {
1329 goto end;
1330 }
1331
1332 /* Lost packets */
1333 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1334 config_element_lost_packets,
1335 lost_packets);
1336 if (ret) {
1337 goto end;
1338 }
1339
1340 /* Closing attributes */
1341 ret = mi_lttng_writer_close_element(writer);
1342 if (ret) {
1343 goto end;
1344 }
1345 end:
1346 return ret;
1347
1348 }
1349
1350 int mi_lttng_event_common_attributes(struct mi_writer *writer,
1351 struct lttng_event *event)
1352 {
1353 int ret;
1354 const char *filter_expression;
1355
1356 /* Open event element */
1357 ret = mi_lttng_writer_open_element(writer, config_element_event);
1358 if (ret) {
1359 goto end;
1360 }
1361
1362 /* Event name */
1363 ret = mi_lttng_writer_write_element_string(writer,
1364 config_element_name, event->name);
1365 if (ret) {
1366 goto end;
1367 }
1368
1369 /* Event type */
1370 ret = mi_lttng_writer_write_element_string(writer,
1371 config_element_type, mi_lttng_eventtype_string(event->type));
1372 if (ret) {
1373 goto end;
1374 }
1375
1376 /* Is event enabled */
1377 ret = mi_lttng_writer_write_element_bool(writer,
1378 config_element_enabled, event->enabled);
1379 if (ret) {
1380 goto end;
1381 }
1382
1383 /* Event filter expression */
1384 ret = lttng_event_get_filter_expression(event, &filter_expression);
1385 if (ret) {
1386 goto end;
1387 }
1388
1389 if (filter_expression) {
1390 ret = mi_lttng_writer_write_element_string(writer,
1391 config_element_filter_expression,
1392 filter_expression);
1393 if (ret) {
1394 goto end;
1395 }
1396 }
1397
1398 end:
1399 return ret;
1400 }
1401
1402 static int write_event_exclusions(struct mi_writer *writer,
1403 struct lttng_event *event)
1404 {
1405 int i;
1406 int ret;
1407 int exclusion_count;
1408
1409 /* Open event exclusions */
1410 ret = mi_lttng_writer_open_element(writer, config_element_exclusions);
1411 if (ret) {
1412 goto end;
1413 }
1414
1415 exclusion_count = lttng_event_get_exclusion_name_count(event);
1416 if (exclusion_count < 0) {
1417 ret = exclusion_count;
1418 goto end;
1419 }
1420
1421 for (i = 0; i < exclusion_count; i++) {
1422 const char *name;
1423
1424 ret = lttng_event_get_exclusion_name(event, i, &name);
1425 if (ret) {
1426 /* Close exclusions */
1427 mi_lttng_writer_close_element(writer);
1428 goto end;
1429 }
1430
1431 ret = mi_lttng_writer_write_element_string(writer,
1432 config_element_exclusion, name);
1433 if (ret) {
1434 /* Close exclusions */
1435 mi_lttng_writer_close_element(writer);
1436 goto end;
1437 }
1438 }
1439
1440 /* Close exclusions */
1441 ret = mi_lttng_writer_close_element(writer);
1442
1443 end:
1444 return ret;
1445 }
1446
1447 int mi_lttng_event_tracepoint_loglevel(struct mi_writer *writer,
1448 struct lttng_event *event, enum lttng_domain_type domain)
1449 {
1450 int ret;
1451
1452 /* Event loglevel */
1453 ret = mi_lttng_writer_write_element_string(writer,
1454 config_element_loglevel,
1455 mi_lttng_loglevel_string(event->loglevel, domain));
1456 if (ret) {
1457 goto end;
1458 }
1459
1460 /* Log level type */
1461 ret = mi_lttng_writer_write_element_string(writer,
1462 config_element_loglevel_type,
1463 mi_lttng_logleveltype_string(event->loglevel_type));
1464 if (ret) {
1465 goto end;
1466 }
1467
1468 /* Event exclusions */
1469 ret = write_event_exclusions(writer, event);
1470
1471 end:
1472 return ret;
1473 }
1474
1475 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer *writer,
1476 struct lttng_event *event)
1477 {
1478 /* event exclusion filter */
1479 return write_event_exclusions(writer, event);
1480 }
1481
1482 int mi_lttng_event_function_probe(struct mi_writer *writer,
1483 struct lttng_event *event)
1484 {
1485 int ret;
1486
1487 ret = mi_lttng_writer_open_element(writer, config_element_attributes);
1488 if (ret) {
1489 goto end;
1490 }
1491
1492 ret = mi_lttng_writer_open_element(writer, config_element_probe_attributes);
1493 if (ret) {
1494 goto end;
1495 }
1496
1497 if (event->attr.probe.addr != 0) {
1498 /* event probe address */
1499 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1500 config_element_address, event->attr.probe.addr);
1501 if (ret) {
1502 goto end;
1503 }
1504 } else {
1505 /* event probe offset */
1506 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1507 config_element_offset, event->attr.probe.offset);
1508 if (ret) {
1509 goto end;
1510 }
1511
1512 /* event probe symbol_name */
1513 ret = mi_lttng_writer_write_element_string(writer,
1514 config_element_symbol_name, event->attr.probe.symbol_name);
1515 if (ret) {
1516 goto end;
1517 }
1518 }
1519
1520 /* Close probe_attributes and attributes */
1521 ret = mi_lttng_close_multi_element(writer, 2);
1522 end:
1523 return ret;
1524 }
1525
1526 static
1527 int mi_lttng_event_userspace_probe(struct mi_writer *writer,
1528 struct lttng_event *event)
1529 {
1530 int ret;
1531 const struct lttng_userspace_probe_location *location;
1532 const struct lttng_userspace_probe_location_lookup_method *lookup_method;
1533 enum lttng_userspace_probe_location_lookup_method_type lookup_type;
1534
1535 location = lttng_event_get_userspace_probe_location(event);
1536 if (!location) {
1537 ret = -LTTNG_ERR_INVALID;
1538 goto end;
1539 }
1540
1541 lookup_method = lttng_userspace_probe_location_get_lookup_method(location);
1542 if (!lookup_method) {
1543 ret = -LTTNG_ERR_INVALID;
1544 goto end;
1545 }
1546
1547 lookup_type = lttng_userspace_probe_location_lookup_method_get_type(lookup_method);
1548
1549 ret = mi_lttng_writer_open_element(writer, config_element_attributes);
1550 if (ret) {
1551 goto end;
1552 }
1553
1554 switch (lttng_userspace_probe_location_get_type(location)) {
1555 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION:
1556 {
1557 const char *function_name;
1558 const char *binary_path;
1559
1560 ret = mi_lttng_writer_open_element(writer,
1561 config_element_userspace_probe_function_attributes);
1562 if (ret) {
1563 goto end;
1564 }
1565
1566 switch (lookup_type) {
1567 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF:
1568 ret = mi_lttng_writer_write_element_string(writer,
1569 config_element_userspace_probe_lookup,
1570 config_element_userspace_probe_lookup_function_elf);
1571 if (ret) {
1572 goto end;
1573 }
1574 break;
1575 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_DEFAULT:
1576 ret = mi_lttng_writer_write_element_string(writer,
1577 config_element_userspace_probe_lookup,
1578 config_element_userspace_probe_lookup_function_default);
1579 if (ret) {
1580 goto end;
1581 }
1582 break;
1583 default:
1584 goto end;
1585 }
1586
1587 binary_path = lttng_userspace_probe_location_function_get_binary_path(location);
1588 ret = mi_lttng_writer_write_element_string(writer,
1589 config_element_userspace_probe_location_binary_path, binary_path);
1590 if (ret) {
1591 goto end;
1592 }
1593
1594 function_name = lttng_userspace_probe_location_function_get_function_name(location);
1595 ret = mi_lttng_writer_write_element_string(writer,
1596 config_element_userspace_probe_function_location_function_name,
1597 function_name);
1598 if (ret) {
1599 goto end;
1600 }
1601
1602 break;
1603 }
1604 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT:
1605 {
1606 const char *probe_name, *provider_name;
1607 const char *binary_path;
1608
1609 ret = mi_lttng_writer_open_element(writer,
1610 config_element_userspace_probe_function_attributes);
1611 if (ret) {
1612 goto end;
1613 }
1614
1615 switch (lookup_type) {
1616 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT:
1617 ret = mi_lttng_writer_write_element_string(writer,
1618 config_element_userspace_probe_lookup,
1619 config_element_userspace_probe_lookup_tracepoint_sdt);
1620 if (ret) {
1621 goto end;
1622 }
1623 break;
1624 default:
1625 goto end;
1626 }
1627
1628 binary_path = lttng_userspace_probe_location_tracepoint_get_binary_path(location);
1629 ret = mi_lttng_writer_write_element_string(writer,
1630 config_element_userspace_probe_location_binary_path,
1631 binary_path);
1632 if (ret) {
1633 goto end;
1634 }
1635
1636 provider_name = lttng_userspace_probe_location_tracepoint_get_provider_name(location);
1637 ret = mi_lttng_writer_write_element_string(writer,
1638 config_element_userspace_probe_tracepoint_location_provider_name,
1639 provider_name);
1640 if (ret) {
1641 goto end;
1642 }
1643
1644 probe_name = lttng_userspace_probe_location_tracepoint_get_probe_name(location);
1645 ret = mi_lttng_writer_write_element_string(writer,
1646 config_element_userspace_probe_tracepoint_location_probe_name, probe_name);
1647 if (ret) {
1648 goto end;
1649 }
1650 break;
1651 }
1652 default:
1653 ERR("Invalid probe type encountered");
1654 }
1655 /* Close probe_attributes and attributes */
1656 ret = mi_lttng_close_multi_element(writer, 2);
1657 end:
1658 return ret;
1659 }
1660
1661 int mi_lttng_event_function_entry(struct mi_writer *writer,
1662 struct lttng_event *event)
1663 {
1664 int ret;
1665
1666 ret = mi_lttng_writer_open_element(writer, config_element_attributes);
1667 if (ret) {
1668 goto end;
1669 }
1670
1671 ret = mi_lttng_writer_open_element(writer, config_element_probe_attributes);
1672 if (ret) {
1673 goto end;
1674 }
1675
1676 /* event probe symbol_name */
1677 ret = mi_lttng_writer_write_element_string(writer,
1678 config_element_symbol_name, event->attr.ftrace.symbol_name);
1679 if (ret) {
1680 goto end;
1681 }
1682
1683 /* Close function_attributes and attributes */
1684 ret = mi_lttng_close_multi_element(writer, 2);
1685 end:
1686 return ret;
1687 }
1688
1689 int mi_lttng_events_open(struct mi_writer *writer)
1690 {
1691 return mi_lttng_writer_open_element(writer, config_element_events);
1692 }
1693
1694 int mi_lttng_event(struct mi_writer *writer,
1695 struct lttng_event *event, int is_open, enum lttng_domain_type domain)
1696 {
1697 int ret;
1698
1699 ret = mi_lttng_event_common_attributes(writer, event);
1700 if (ret) {
1701 goto end;
1702 }
1703
1704 switch (event->type) {
1705 case LTTNG_EVENT_TRACEPOINT:
1706 {
1707 if (event->loglevel != -1) {
1708 ret = mi_lttng_event_tracepoint_loglevel(writer, event, domain);
1709 } else {
1710 ret = mi_lttng_event_tracepoint_no_loglevel(writer, event);
1711 }
1712 break;
1713 }
1714 case LTTNG_EVENT_FUNCTION:
1715 /* Fallthrough */
1716 case LTTNG_EVENT_PROBE:
1717 ret = mi_lttng_event_function_probe(writer, event);
1718 break;
1719 case LTTNG_EVENT_FUNCTION_ENTRY:
1720 ret = mi_lttng_event_function_entry(writer, event);
1721 break;
1722 case LTTNG_EVENT_USERSPACE_PROBE:
1723 ret = mi_lttng_event_userspace_probe(writer, event);
1724 break;
1725 case LTTNG_EVENT_ALL:
1726 /* Fallthrough */
1727 default:
1728 break;
1729 }
1730
1731 if (ret) {
1732 goto end;
1733 }
1734
1735 if (!is_open) {
1736 ret = mi_lttng_writer_close_element(writer);
1737 }
1738
1739 end:
1740 return ret;
1741 }
1742
1743 int mi_lttng_trackers_open(struct mi_writer *writer)
1744 {
1745 return mi_lttng_writer_open_element(
1746 writer, config_element_process_attr_trackers);
1747 }
1748
1749 static int get_tracker_elements(enum lttng_process_attr process_attr,
1750 const char **element_process_attr_tracker,
1751 const char **element_process_attr_value)
1752 {
1753 int ret = 0;
1754
1755 switch (process_attr) {
1756 case LTTNG_PROCESS_ATTR_PROCESS_ID:
1757 *element_process_attr_tracker =
1758 config_element_process_attr_tracker_pid;
1759 *element_process_attr_value =
1760 config_element_process_attr_pid_value;
1761 break;
1762 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID:
1763 *element_process_attr_tracker =
1764 config_element_process_attr_tracker_vpid;
1765 *element_process_attr_value =
1766 config_element_process_attr_vpid_value;
1767 break;
1768 case LTTNG_PROCESS_ATTR_USER_ID:
1769 *element_process_attr_tracker =
1770 config_element_process_attr_tracker_uid;
1771 *element_process_attr_value =
1772 config_element_process_attr_uid_value;
1773 break;
1774 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID:
1775 *element_process_attr_tracker =
1776 config_element_process_attr_tracker_vuid;
1777 *element_process_attr_value =
1778 config_element_process_attr_vuid_value;
1779 break;
1780 case LTTNG_PROCESS_ATTR_GROUP_ID:
1781 *element_process_attr_tracker =
1782 config_element_process_attr_tracker_gid;
1783 *element_process_attr_value =
1784 config_element_process_attr_gid_value;
1785 break;
1786 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID:
1787 *element_process_attr_tracker =
1788 config_element_process_attr_tracker_vgid;
1789 *element_process_attr_value =
1790 config_element_process_attr_vgid_value;
1791 break;
1792 default:
1793 ret = LTTNG_ERR_SAVE_IO_FAIL;
1794 }
1795 return ret;
1796 }
1797
1798 int mi_lttng_process_attribute_tracker_open(
1799 struct mi_writer *writer, enum lttng_process_attr process_attr)
1800 {
1801 int ret;
1802 const char *element_tracker, *element_value;
1803
1804 ret = get_tracker_elements(
1805 process_attr, &element_tracker, &element_value);
1806 if (ret) {
1807 return ret;
1808 }
1809
1810 /* Open process attribute tracker element */
1811 ret = mi_lttng_writer_open_element(writer, element_tracker);
1812 if (ret) {
1813 goto end;
1814 }
1815
1816 /* Open values element */
1817 ret = mi_lttng_process_attr_values_open(writer);
1818 end:
1819 return ret;
1820 }
1821
1822 int mi_lttng_pids_open(struct mi_writer *writer)
1823 {
1824 return mi_lttng_writer_open_element(writer, config_element_pids);
1825 }
1826
1827 /*
1828 * TODO: move the listing of pid for user agent to process semantic on
1829 * mi api bump. The use of process element break the mi api.
1830 */
1831 int mi_lttng_pid(struct mi_writer *writer,
1832 pid_t pid,
1833 const char *name,
1834 int is_open)
1835 {
1836 int ret;
1837
1838 /* Open pid process */
1839 ret = mi_lttng_writer_open_element(writer, config_element_pid);
1840 if (ret) {
1841 goto end;
1842 }
1843
1844 /* Writing pid number */
1845 ret = mi_lttng_writer_write_element_signed_int(writer,
1846 mi_lttng_element_pid_id, (int)pid);
1847 if (ret) {
1848 goto end;
1849 }
1850
1851 /* Writing name of the process */
1852 if (name) {
1853 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
1854 name);
1855 if (ret) {
1856 goto end;
1857 }
1858 }
1859
1860 if (!is_open) {
1861 /* Closing Pid */
1862 ret = mi_lttng_writer_close_element(writer);
1863 }
1864
1865 end:
1866 return ret;
1867 }
1868
1869 int mi_lttng_process_attr_values_open(struct mi_writer *writer)
1870 {
1871 return mi_lttng_writer_open_element(
1872 writer, config_element_process_attr_values);
1873 }
1874
1875 int mi_lttng_all_process_attribute_value(struct mi_writer *writer,
1876 enum lttng_process_attr process_attr,
1877 bool is_open)
1878 {
1879 int ret;
1880 const char *element_id_tracker, *element_target_id;
1881
1882 ret = get_tracker_elements(
1883 process_attr, &element_id_tracker, &element_target_id);
1884 if (ret) {
1885 return ret;
1886 }
1887
1888 ret = mi_lttng_writer_open_element(writer, element_target_id);
1889 if (ret) {
1890 goto end;
1891 }
1892
1893 ret = mi_lttng_writer_open_element(writer, config_element_type);
1894 if (ret) {
1895 goto end;
1896 }
1897
1898 ret = mi_lttng_writer_write_element_bool(writer, config_element_all, 1);
1899 if (ret) {
1900 goto end;
1901 }
1902
1903 ret = mi_lttng_writer_close_element(writer);
1904 if (ret) {
1905 goto end;
1906 }
1907
1908 if (!is_open) {
1909 ret = mi_lttng_writer_close_element(writer);
1910 if (ret) {
1911 goto end;
1912 }
1913 }
1914 end:
1915 return ret;
1916 }
1917
1918 int mi_lttng_integral_process_attribute_value(struct mi_writer *writer,
1919 enum lttng_process_attr process_attr,
1920 int64_t value,
1921 bool is_open)
1922 {
1923 int ret;
1924 const char *element_id_tracker, *element_target_id;
1925
1926 ret = get_tracker_elements(
1927 process_attr, &element_id_tracker, &element_target_id);
1928 if (ret) {
1929 return ret;
1930 }
1931
1932 ret = mi_lttng_writer_open_element(writer, element_target_id);
1933 if (ret) {
1934 goto end;
1935 }
1936
1937 ret = mi_lttng_writer_open_element(writer, config_element_type);
1938 if (ret) {
1939 goto end;
1940 }
1941
1942 ret = mi_lttng_writer_write_element_signed_int(
1943 writer, config_element_process_attr_id, value);
1944 if (ret) {
1945 goto end;
1946 }
1947
1948 ret = mi_lttng_writer_close_element(writer);
1949 if (ret) {
1950 goto end;
1951 }
1952
1953 if (!is_open) {
1954 ret = mi_lttng_writer_close_element(writer);
1955 if (ret) {
1956 goto end;
1957 }
1958 }
1959
1960 end:
1961 return ret;
1962 }
1963
1964 int mi_lttng_string_process_attribute_value(struct mi_writer *writer,
1965 enum lttng_process_attr process_attr,
1966 const char *value,
1967 bool is_open)
1968
1969 {
1970 int ret;
1971 const char *element_id_tracker, *element_target_id;
1972
1973 ret = get_tracker_elements(
1974 process_attr, &element_id_tracker, &element_target_id);
1975 if (ret) {
1976 return ret;
1977 }
1978
1979 ret = mi_lttng_writer_open_element(writer, element_target_id);
1980 if (ret) {
1981 goto end;
1982 }
1983
1984 ret = mi_lttng_writer_open_element(writer, config_element_type);
1985 if (ret) {
1986 goto end;
1987 }
1988
1989 ret = mi_lttng_writer_write_element_string(
1990 writer, config_element_name, value);
1991 if (ret) {
1992 goto end;
1993 }
1994
1995 ret = mi_lttng_writer_close_element(writer);
1996 if (ret) {
1997 goto end;
1998 }
1999
2000 if (!is_open) {
2001 ret = mi_lttng_writer_close_element(writer);
2002 if (ret) {
2003 goto end;
2004 }
2005 }
2006
2007 end:
2008 return ret;
2009 }
2010
2011 int mi_lttng_event_fields_open(struct mi_writer *writer)
2012 {
2013 return mi_lttng_writer_open_element(writer, mi_lttng_element_event_fields);
2014 }
2015
2016 int mi_lttng_event_field(struct mi_writer *writer,
2017 struct lttng_event_field *field)
2018 {
2019 int ret;
2020
2021 if (!field->field_name[0]) {
2022 ret = 0;
2023 goto end;
2024 }
2025
2026 /* Open field */
2027 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_event_field);
2028 if (ret) {
2029 goto end;
2030 }
2031
2032 if (!field->field_name[0]) {
2033 goto close;
2034 }
2035
2036 /* Name */
2037 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
2038 field->field_name);
2039 if (ret) {
2040 goto end;
2041 }
2042
2043 /* Type */
2044 ret = mi_lttng_writer_write_element_string(writer, config_element_type,
2045 mi_lttng_eventfieldtype_string(field->type));
2046 if (ret) {
2047 goto end;
2048 }
2049
2050 /* nowrite */
2051 ret = mi_lttng_writer_write_element_signed_int(writer,
2052 mi_lttng_element_nowrite, field->nowrite);
2053 if (ret) {
2054 goto end;
2055 }
2056
2057 close:
2058 /* Close field element */
2059 ret = mi_lttng_writer_close_element(writer);
2060
2061 end:
2062 return ret;
2063 }
2064
2065 int mi_lttng_perf_counter_context(struct mi_writer *writer,
2066 struct lttng_event_perf_counter_ctx *perf_context)
2067 {
2068 int ret;
2069
2070 /* Open perf_counter_context */
2071 ret = mi_lttng_writer_open_element(writer,
2072 mi_lttng_element_perf_counter_context);
2073 if (ret) {
2074 goto end;
2075 }
2076
2077 /* Type */
2078 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2079 config_element_type, perf_context->type);
2080 if (ret) {
2081 goto end;
2082 }
2083
2084 /* Config */
2085 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2086 config_element_config, perf_context->config);
2087 if (ret) {
2088 goto end;
2089 }
2090
2091 /* Name of the perf counter */
2092 ret = mi_lttng_writer_write_element_string(writer,
2093 config_element_name, perf_context->name);
2094 if (ret) {
2095 goto end;
2096 }
2097
2098 /* Close perf_counter_context */
2099 ret = mi_lttng_writer_close_element(writer);
2100 end:
2101 return ret;
2102 }
2103
2104 static
2105 int mi_lttng_app_context(struct mi_writer *writer,
2106 const char *provider_name, const char *ctx_name)
2107 {
2108 int ret;
2109
2110 /* Open app */
2111 ret = mi_lttng_writer_open_element(writer,
2112 config_element_context_app);
2113 if (ret) {
2114 goto end;
2115 }
2116
2117 /* provider_name */
2118 ret = mi_lttng_writer_write_element_string(writer,
2119 config_element_context_app_provider_name,
2120 provider_name);
2121 if (ret) {
2122 goto end;
2123 }
2124
2125 /* ctx_name */
2126 ret = mi_lttng_writer_write_element_string(writer,
2127 config_element_context_app_ctx_name, ctx_name);
2128 if (ret) {
2129 goto end;
2130 }
2131
2132 /* Close app */
2133 ret = mi_lttng_writer_close_element(writer);
2134 end:
2135 return ret;
2136 }
2137
2138 int mi_lttng_context(struct mi_writer *writer,
2139 struct lttng_event_context *context, int is_open)
2140 {
2141 int ret;
2142
2143 /* Open context */
2144 ret = mi_lttng_writer_open_element(writer , config_element_context);
2145 if (ret) {
2146 goto end;
2147 }
2148
2149 /* Special case for PERF_*_COUNTER
2150 * print the lttng_event_perf_counter_ctx*/
2151 switch (context->ctx) {
2152 case LTTNG_EVENT_CONTEXT_PERF_COUNTER:
2153 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER:
2154 case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER:
2155 {
2156 struct lttng_event_perf_counter_ctx *perf_context =
2157 &context->u.perf_counter;
2158 ret = mi_lttng_perf_counter_context(writer, perf_context);
2159 if (ret) {
2160 goto end;
2161 }
2162 break;
2163 }
2164 case LTTNG_EVENT_CONTEXT_APP_CONTEXT:
2165 {
2166 ret = mi_lttng_app_context(writer,
2167 context->u.app_ctx.provider_name,
2168 context->u.app_ctx.ctx_name);
2169 if (ret) {
2170 goto end;
2171 }
2172 break;
2173 }
2174 default:
2175 {
2176 const char *type_string = mi_lttng_event_contexttype_string(
2177 context->ctx);
2178 if (!type_string) {
2179 ret = -LTTNG_ERR_INVALID;
2180 goto end;
2181 }
2182
2183 /* Print context type */
2184 ret = mi_lttng_writer_write_element_string(writer,
2185 config_element_type, type_string);
2186 break;
2187 }
2188 }
2189
2190 /* Close context */
2191 if (!is_open) {
2192 ret = mi_lttng_writer_close_element(writer);
2193 }
2194
2195 end:
2196 return ret;
2197 }
2198
2199 int mi_lttng_snapshot_output_session_name(struct mi_writer *writer,
2200 const char *session_name)
2201 {
2202 int ret;
2203
2204 /* Open session element */
2205 ret = mi_lttng_writer_open_element(writer, config_element_session);
2206 if (ret) {
2207 goto end;
2208 }
2209
2210 /* Snapshot output list for current session name */
2211 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
2212 session_name);
2213 if (ret) {
2214 goto end;
2215 }
2216
2217 /* Open element snapshots (sequence one snapshot) */
2218 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_snapshots);
2219 if (ret) {
2220 goto end;
2221 }
2222
2223 end:
2224 return ret;
2225 }
2226
2227 int mi_lttng_snapshot_list_output(struct mi_writer *writer,
2228 const struct lttng_snapshot_output *output)
2229 {
2230 int ret;
2231
2232 /* Open element snapshot output */
2233 ret = mi_lttng_writer_open_element(writer,
2234 mi_lttng_element_command_snapshot);
2235 if (ret) {
2236 goto end;
2237 }
2238
2239 /* ID of the snapshot output */
2240 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2241 mi_lttng_element_id, output->id);
2242 if (ret) {
2243 goto end;
2244 }
2245
2246 /* Name of the output */
2247 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
2248 output->name);
2249 if (ret) {
2250 goto end;
2251 }
2252
2253 /* Destination of the output (ctrl_url)*/
2254 ret = mi_lttng_writer_write_element_string(writer,
2255 mi_lttng_element_snapshot_ctrl_url, output->ctrl_url);
2256 if (ret) {
2257 goto end;
2258 }
2259
2260 /* Destination of the output (data_url) */
2261 ret = mi_lttng_writer_write_element_string(writer,
2262 mi_lttng_element_snapshot_data_url, output->data_url);
2263 if (ret) {
2264 goto end;
2265 }
2266
2267 /* total size of all stream combined */
2268 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2269 mi_lttng_element_snapshot_max_size, output->max_size);
2270 if (ret) {
2271 goto end;
2272 }
2273
2274 /* Close snapshot output element */
2275 ret = mi_lttng_writer_close_element(writer);
2276
2277 end:
2278 return ret;
2279 }
2280
2281 int mi_lttng_snapshot_del_output(struct mi_writer *writer, int id,
2282 const char *name, const char *current_session_name)
2283 {
2284 int ret;
2285
2286 /* Open element del_snapshot */
2287 ret = mi_lttng_writer_open_element(writer,
2288 mi_lttng_element_command_snapshot);
2289 if (ret) {
2290 goto end;
2291 }
2292
2293
2294 if (id != UINT32_MAX) {
2295 /* "Snapshot output "id" successfully deleted
2296 * for "current_session_name"
2297 * ID of the snapshot output
2298 */
2299 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2300 mi_lttng_element_id, id);
2301 if (ret) {
2302 goto end;
2303 }
2304 } else {
2305 /* "Snapshot output "name" successfully deleted
2306 * for session "current_session_name"
2307 * Name of the output
2308 */
2309 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
2310 name);
2311 if (ret) {
2312 goto end;
2313 }
2314 }
2315
2316 /* Snapshot was deleted for session "current_session_name"*/
2317 ret = mi_lttng_writer_write_element_string(writer,
2318 mi_lttng_element_snapshot_session_name,
2319 current_session_name);
2320 if (ret) {
2321 goto end;
2322 }
2323
2324 /* Close snapshot element */
2325 ret = mi_lttng_writer_close_element(writer);
2326
2327 end:
2328 return ret;
2329 }
2330
2331 int mi_lttng_snapshot_add_output(struct mi_writer *writer,
2332 const char *current_session_name, const char *n_ptr,
2333 struct lttng_snapshot_output *output)
2334 {
2335 int ret;
2336
2337 /* Open element snapshot */
2338 ret = mi_lttng_writer_open_element(writer,
2339 mi_lttng_element_command_snapshot);
2340 if (ret) {
2341 goto end;
2342 }
2343
2344 /* Snapshot output id */
2345 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2346 mi_lttng_element_id, output->id);
2347 if (ret) {
2348 goto end;
2349 }
2350
2351 /* Snapshot output names */
2352 ret = mi_lttng_writer_write_element_string(writer,
2353 config_element_name, n_ptr);
2354 if (ret) {
2355 goto end;
2356 }
2357
2358 /* Destination of the output (ctrl_url)*/
2359 ret = mi_lttng_writer_write_element_string(writer,
2360 mi_lttng_element_snapshot_ctrl_url, output->ctrl_url);
2361 if (ret) {
2362 goto end;
2363 }
2364
2365 /* Snapshot added for session "current_session_name"*/
2366 ret = mi_lttng_writer_write_element_string(writer,
2367 mi_lttng_element_snapshot_session_name, current_session_name);
2368 if (ret) {
2369 goto end;
2370 }
2371
2372 /* total size of all stream combined */
2373 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2374 mi_lttng_element_snapshot_max_size, output->max_size);
2375 if (ret) {
2376 goto end;
2377 }
2378
2379 /* Close snapshot element */
2380 ret = mi_lttng_writer_close_element(writer);
2381
2382 end:
2383 return ret;
2384 }
2385
2386 int mi_lttng_snapshot_record(struct mi_writer *writer, const char *url,
2387 const char *cmdline_ctrl_url, const char *cmdline_data_url)
2388 {
2389 int ret;
2390
2391 /* Open element snapshot */
2392 ret = mi_lttng_writer_open_element(writer,
2393 mi_lttng_element_command_snapshot);
2394 if (ret) {
2395 goto end;
2396 }
2397
2398 /*
2399 * If a valid an URL was given, serialize it,
2400 * else take the command line data and ctrl urls*/
2401 if (url) {
2402 /* Destination of the output (ctrl_url)*/
2403 ret = mi_lttng_writer_write_element_string(writer,
2404 mi_lttng_element_snapshot_ctrl_url, url);
2405 if (ret) {
2406 goto end;
2407 }
2408 } else if (cmdline_ctrl_url) {
2409 /* Destination of the output (ctrl_url)*/
2410 ret = mi_lttng_writer_write_element_string(writer,
2411 mi_lttng_element_snapshot_ctrl_url, cmdline_ctrl_url);
2412 if (ret) {
2413 goto end;
2414 }
2415
2416 /* Destination of the output (data_url) */
2417 ret = mi_lttng_writer_write_element_string(writer,
2418 mi_lttng_element_snapshot_data_url, cmdline_data_url);
2419 if (ret) {
2420 goto end;
2421 }
2422 }
2423
2424 /* Close record_snapshot element */
2425 ret = mi_lttng_writer_close_element(writer);
2426
2427 end:
2428 return ret;
2429 }
2430
2431 int mi_lttng_rotation_schedule(struct mi_writer *writer,
2432 const struct lttng_rotation_schedule *schedule)
2433 {
2434 int ret = 0;
2435 enum lttng_rotation_status status;
2436 uint64_t value;
2437 const char *element_name;
2438 const char *value_name;
2439 bool empty_schedule = false;
2440
2441 switch (lttng_rotation_schedule_get_type(schedule)) {
2442 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC:
2443 status = lttng_rotation_schedule_periodic_get_period(schedule,
2444 &value);
2445 element_name = mi_lttng_element_rotation_schedule_periodic;
2446 value_name = mi_lttng_element_rotation_schedule_periodic_time_us;
2447 break;
2448 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD:
2449 status = lttng_rotation_schedule_size_threshold_get_threshold(
2450 schedule, &value);
2451 element_name = mi_lttng_element_rotation_schedule_size_threshold;
2452 value_name = mi_lttng_element_rotation_schedule_size_threshold_bytes;
2453 break;
2454 default:
2455 ret = -1;
2456 goto end;
2457 }
2458
2459 if (status != LTTNG_ROTATION_STATUS_OK) {
2460 if (status == LTTNG_ROTATION_STATUS_UNAVAILABLE) {
2461 empty_schedule = true;
2462 } else {
2463 ret = -1;
2464 goto end;
2465 }
2466 }
2467
2468 ret = mi_lttng_writer_open_element(writer, element_name);
2469 if (ret) {
2470 goto end;
2471 }
2472
2473 if (!empty_schedule) {
2474 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2475 value_name, value);
2476 if (ret) {
2477 goto end;
2478 }
2479 }
2480
2481 /* Close schedule descriptor element. */
2482 ret = mi_lttng_writer_close_element(writer);
2483 if (ret) {
2484 goto end;
2485 }
2486 end:
2487 return ret;
2488 }
2489
2490 int mi_lttng_rotation_schedule_result(struct mi_writer *writer,
2491 const struct lttng_rotation_schedule *schedule,
2492 bool success)
2493 {
2494 int ret = 0;
2495
2496 ret = mi_lttng_writer_open_element(writer,
2497 mi_lttng_element_rotation_schedule_result);
2498 if (ret) {
2499 goto end;
2500 }
2501
2502 ret = mi_lttng_writer_open_element(writer,
2503 mi_lttng_element_rotation_schedule);
2504 if (ret) {
2505 goto end;
2506 }
2507
2508 ret = mi_lttng_rotation_schedule(writer, schedule);
2509 if (ret) {
2510 goto end;
2511 }
2512
2513 /* Close rotation_schedule element */
2514 ret = mi_lttng_writer_close_element(writer);
2515 if (ret) {
2516 goto end;
2517 }
2518
2519 ret = mi_lttng_writer_write_element_bool(writer,
2520 mi_lttng_element_command_success, success);
2521 if (ret) {
2522 goto end;
2523 }
2524
2525 /* Close rotation_schedule_result element */
2526 ret = mi_lttng_writer_close_element(writer);
2527 if (ret) {
2528 goto end;
2529 }
2530 end:
2531 return ret;
2532 }
2533
2534 static
2535 int mi_lttng_location(struct mi_writer *writer,
2536 const struct lttng_trace_archive_location *location)
2537 {
2538 int ret = 0;
2539 enum lttng_trace_archive_location_type location_type;
2540 enum lttng_trace_archive_location_status status;
2541
2542 location_type = lttng_trace_archive_location_get_type(location);
2543
2544 switch (location_type) {
2545 case LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL:
2546 {
2547 const char *absolute_path;
2548
2549 status = lttng_trace_archive_location_local_get_absolute_path(
2550 location, &absolute_path);
2551 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
2552 ret = -1;
2553 goto end;
2554 }
2555
2556 ret = mi_lttng_writer_open_element(writer,
2557 mi_lttng_element_rotation_location_local);
2558 if (ret) {
2559 goto end;
2560 }
2561
2562
2563 ret = mi_lttng_writer_write_element_string(writer,
2564 mi_lttng_element_rotation_location_local_absolute_path,
2565 absolute_path);
2566 if (ret) {
2567 goto end;
2568 }
2569
2570 /* Close local element */
2571 ret = mi_lttng_writer_close_element(writer);
2572 if (ret) {
2573 goto end;
2574 }
2575 break;
2576 }
2577 case LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY:
2578 {
2579 uint16_t control_port, data_port;
2580 const char *host, *relative_path;
2581 enum lttng_trace_archive_location_relay_protocol_type protocol;
2582
2583 /* Fetch all relay location parameters. */
2584 status = lttng_trace_archive_location_relay_get_protocol_type(
2585 location, &protocol);
2586 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
2587 ret = -1;
2588 goto end;
2589 }
2590
2591 status = lttng_trace_archive_location_relay_get_host(
2592 location, &host);
2593 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
2594 ret = -1;
2595 goto end;
2596 }
2597
2598 status = lttng_trace_archive_location_relay_get_control_port(
2599 location, &control_port);
2600 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
2601 ret = -1;
2602 goto end;
2603 }
2604
2605 status = lttng_trace_archive_location_relay_get_data_port(
2606 location, &data_port);
2607 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
2608 ret = -1;
2609 goto end;
2610 }
2611
2612 status = lttng_trace_archive_location_relay_get_relative_path(
2613 location, &relative_path);
2614 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
2615 ret = -1;
2616 goto end;
2617 }
2618
2619 ret = mi_lttng_writer_open_element(writer,
2620 mi_lttng_element_rotation_location_relay);
2621 if (ret) {
2622 goto end;
2623 }
2624
2625 ret = mi_lttng_writer_write_element_string(writer,
2626 mi_lttng_element_rotation_location_relay_host,
2627 host);
2628 if (ret) {
2629 goto end;
2630 }
2631
2632 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2633 mi_lttng_element_rotation_location_relay_control_port,
2634 control_port);
2635 if (ret) {
2636 goto end;
2637 }
2638
2639 ret = mi_lttng_writer_write_element_unsigned_int(writer,
2640 mi_lttng_element_rotation_location_relay_data_port,
2641 data_port);
2642 if (ret) {
2643 goto end;
2644 }
2645
2646 ret = mi_lttng_writer_write_element_string(writer,
2647 mi_lttng_element_rotation_location_relay_protocol,
2648 mi_lttng_trace_archive_location_relay_protocol_type_string(protocol));
2649 if (ret) {
2650 goto end;
2651 }
2652
2653 ret = mi_lttng_writer_write_element_string(writer,
2654 mi_lttng_element_rotation_location_relay_relative_path,
2655 relative_path);
2656 if (ret) {
2657 goto end;
2658 }
2659
2660 /* Close relay element */
2661 ret = mi_lttng_writer_close_element(writer);
2662 if (ret) {
2663 goto end;
2664 }
2665 break;
2666 }
2667 default:
2668 abort();
2669 }
2670 end:
2671 return ret;
2672 }
2673
2674 int mi_lttng_rotate(struct mi_writer *writer,
2675 const char *session_name,
2676 enum lttng_rotation_state rotation_state,
2677 const struct lttng_trace_archive_location *location)
2678 {
2679 int ret;
2680
2681 ret = mi_lttng_writer_open_element(writer,
2682 mi_lttng_element_rotation);
2683 if (ret) {
2684 goto end;
2685 }
2686
2687 ret = mi_lttng_writer_write_element_string(writer,
2688 mi_lttng_element_session_name,
2689 session_name);
2690 if (ret) {
2691 goto end;
2692 }
2693
2694 ret = mi_lttng_writer_write_element_string(writer,
2695 mi_lttng_element_rotation_state,
2696 mi_lttng_rotation_state_string(rotation_state));
2697 if (ret) {
2698 goto end;
2699 }
2700
2701 if (!location) {
2702 /* Not a serialization error. */
2703 goto close_rotation;
2704 }
2705
2706 ret = mi_lttng_writer_open_element(writer,
2707 mi_lttng_element_rotation_location);
2708 if (ret) {
2709 goto end;
2710 }
2711
2712 ret = mi_lttng_location(writer, location);
2713 if (ret) {
2714 goto close_location;
2715 }
2716
2717 close_location:
2718 /* Close location element */
2719 ret = mi_lttng_writer_close_element(writer);
2720 if (ret) {
2721 goto end;
2722 }
2723
2724 close_rotation:
2725 /* Close rotation element */
2726 ret = mi_lttng_writer_close_element(writer);
2727 if (ret) {
2728 goto end;
2729 }
2730 end:
2731 return ret;
2732 }
This page took 0.109277 seconds and 5 git commands to generate.