projects / lttng-tools.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
liblttng-ctl: hide MI trigger command variables
[lttng-tools.git] / src / common / mi-lttng.h
CommitLineData
c7e35b03 1/*
ab5be9fa
MJ		 2 * Copyright (C) 2014 Jonathan Rajotte <jonathan.r.julien@gmail.com>
3 * Copyright (C) 2014 Olivier Cotte <olivier.cotte@polymtl.ca>
4 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
c7e35b03 5 *
ab5be9fa 6 * SPDX-License-Identifier: GPL-2.0-only
c7e35b03 7 *
c7e35b03
JR		 8 */
9
10#ifndef _MI_LTTNG_H
11#define _MI_LTTNG_H
12
13#include <stdint.h>
14
15#include <common/error.h>
16#include <common/macros.h>
f40ef1d5 17#include <common/config/session-config.h>
c7e35b03
JR		 18#include <lttng/lttng.h>
19
50534d6f
JRJ		 20/* Don't want to reference snapshot-internal.h here */
21struct lttng_snapshot_output;
22
c7e35b03
JR		 23/* Instance of a machine interface writer. */
24struct mi_writer {
25 struct config_writer *writer;
26 enum lttng_mi_output_type type;
27};
28
29/*
30 * Version information for the machine interface.
31 */
32struct mi_lttng_version {
36d2e35d 33 char version[LTTNG_NAME_MAX]; /* Version number of package */
c7e35b03
JR		 34 uint32_t version_major; /* LTTng-Tools major version number */
35 uint32_t version_minor; /* LTTng-Tools minor version number */
36 uint32_t version_patchlevel; /* LTTng-Tools patchlevel version number */
36d2e35d
MJ		 37 char version_commit[LTTNG_NAME_MAX]; /* Commit hash of the current version */
38 char version_name[LTTNG_NAME_MAX];
39 char package_url[LTTNG_NAME_MAX]; /* Define to the home page for this package. */
c7e35b03
JR		 40};
41
0f7c2963
JR		 42/* Error query callbacks. */
43typedef enum lttng_error_code (*mi_lttng_error_query_trigger_cb)(
44 const struct lttng_trigger *trigger,
45 struct lttng_error_query_results **results);
46typedef enum lttng_error_code (*mi_lttng_error_query_condition_cb)(
47 const struct lttng_trigger *trigger,
48 struct lttng_error_query_results **results);
49typedef enum lttng_error_code (*mi_lttng_error_query_action_cb)(
50 const struct lttng_trigger *trigger,
51 const struct lttng_action_path *action_path,
52 struct lttng_error_query_results **results);
53
54struct mi_lttng_error_query_callbacks {
55 mi_lttng_error_query_trigger_cb trigger_cb;
56 mi_lttng_error_query_condition_cb condition_cb;
57 mi_lttng_error_query_action_cb action_cb;
58};
59
c7e35b03 60/* Strings related to command */
4965f956
JG		 61extern const char * const mi_lttng_element_command;
62extern const char * const mi_lttng_element_command_action;
63extern const char * const mi_lttng_element_command_add_context;
ecd27e60 64LTTNG_HIDDEN extern const char * const mi_lttng_element_command_add_trigger;
4965f956
JG		 65extern const char * const mi_lttng_element_command_create;
66extern const char * const mi_lttng_element_command_destroy;
67extern const char * const mi_lttng_element_command_disable_channel;
68extern const char * const mi_lttng_element_command_disable_event;
69extern const char * const mi_lttng_element_command_enable_channels;
70extern const char * const mi_lttng_element_command_enable_event;
71extern const char * const mi_lttng_element_command_list;
ecd27e60 72LTTNG_HIDDEN extern const char * const mi_lttng_element_command_list_trigger;
4965f956 73extern const char * const mi_lttng_element_command_load;
54897b57
JD		 74extern const char * const mi_lttng_element_command_metadata;
75extern const char * const mi_lttng_element_command_metadata_action;
eded6438
JD		 76extern const char * const mi_lttng_element_command_regenerate;
77extern const char * const mi_lttng_element_command_regenerate_action;
4965f956
JG		 78extern const char * const mi_lttng_element_command_name;
79extern const char * const mi_lttng_element_command_output;
ecd27e60 80LTTNG_HIDDEN extern const char * const mi_lttng_element_command_remove_trigger;
4965f956
JG		 81extern const char * const mi_lttng_element_command_save;
82extern const char * const mi_lttng_element_command_set_session;
83extern const char * const mi_lttng_element_command_snapshot;
84extern const char * const mi_lttng_element_command_snapshot_add;
85extern const char * const mi_lttng_element_command_snapshot_del;
86extern const char * const mi_lttng_element_command_snapshot_list;
87extern const char * const mi_lttng_element_command_snapshot_record;
88extern const char * const mi_lttng_element_command_start;
89extern const char * const mi_lttng_element_command_stop;
90extern const char * const mi_lttng_element_command_success;
91extern const char * const mi_lttng_element_command_track;
92extern const char * const mi_lttng_element_command_untrack;
93extern const char * const mi_lttng_element_command_version;
d68c9a04 94extern const char * const mi_lttng_element_command_rotate;
259c2674
JD		 95extern const char * const mi_lttng_element_command_enable_rotation;
96extern const char * const mi_lttng_element_command_disable_rotation;
511ed4e2 97extern const char * const mi_lttng_element_command_clear;
c7e35b03 98
1734c658 99/* Strings related to version command */
4965f956
JG		 100extern const char * const mi_lttng_element_version;
101extern const char * const mi_lttng_element_version_commit;
102extern const char * const mi_lttng_element_version_description;
103extern const char * const mi_lttng_element_version_license;
104extern const char * const mi_lttng_element_version_major;
105extern const char * const mi_lttng_element_version_minor;
106extern const char * const mi_lttng_element_version_patch_level;
107extern const char * const mi_lttng_element_version_str;
108extern const char * const mi_lttng_element_version_web;
c7e35b03 109
5e18ec73 110/* String related to a lttng_event_field */
4965f956
JG		 111extern const char * const mi_lttng_element_event_field;
112extern const char * const mi_lttng_element_event_fields;
5e18ec73 113
89b72577 114/* String related to lttng_event_perf_counter_ctx */
4965f956 115extern const char * const mi_lttng_element_perf_counter_context;
89b72577 116
5e18ec73 117/* Strings related to pid */
4965f956 118extern const char * const mi_lttng_element_pid_id;
5e18ec73 119
1734c658 120/* Strings related to save command */
4965f956 121extern const char * const mi_lttng_element_save;
1734c658
JRJ		 122
123/* Strings related to load command */
4965f956 124extern const char * const mi_lttng_element_load;
44cdb3a2
MJ		 125LTTNG_HIDDEN extern const char * const mi_lttng_element_load_overrides;
126LTTNG_HIDDEN extern const char * const mi_lttng_element_load_override_url;
1734c658 127
5e18ec73 128/* General element of mi_lttng */
4965f956
JG		 129extern const char * const mi_lttng_element_empty;
130extern const char * const mi_lttng_element_id;
131extern const char * const mi_lttng_element_nowrite;
132extern const char * const mi_lttng_element_success;
133extern const char * const mi_lttng_element_type_enum;
134extern const char * const mi_lttng_element_type_float;
135extern const char * const mi_lttng_element_type_integer;
136extern const char * const mi_lttng_element_type_other;
137extern const char * const mi_lttng_element_type_string;
5e18ec73
JR		 138
139/* String related to loglevel */
4965f956
JG		 140extern const char * const mi_lttng_loglevel_str_alert;
141extern const char * const mi_lttng_loglevel_str_crit;
142extern const char * const mi_lttng_loglevel_str_debug;
143extern const char * const mi_lttng_loglevel_str_debug_function;
144extern const char * const mi_lttng_loglevel_str_debug_line;
145extern const char * const mi_lttng_loglevel_str_debug_module;
146extern const char * const mi_lttng_loglevel_str_debug_process;
147extern const char * const mi_lttng_loglevel_str_debug_program;
148extern const char * const mi_lttng_loglevel_str_debug_system;
149extern const char * const mi_lttng_loglevel_str_debug_unit;
150extern const char * const mi_lttng_loglevel_str_emerg;
151extern const char * const mi_lttng_loglevel_str_err;
152extern const char * const mi_lttng_loglevel_str_info;
153extern const char * const mi_lttng_loglevel_str_notice;
154extern const char * const mi_lttng_loglevel_str_unknown;
155extern const char * const mi_lttng_loglevel_str_warning;
5e18ec73 156
136f2f81 157/* String related to loglevel JUL */
4965f956
JG		 158extern const char * const mi_lttng_loglevel_str_jul_all;
159extern const char * const mi_lttng_loglevel_str_jul_config;
160extern const char * const mi_lttng_loglevel_str_jul_fine;
161extern const char * const mi_lttng_loglevel_str_jul_finer;
162extern const char * const mi_lttng_loglevel_str_jul_finest;
163extern const char * const mi_lttng_loglevel_str_jul_info;
164extern const char * const mi_lttng_loglevel_str_jul_off;
165extern const char * const mi_lttng_loglevel_str_jul_severe;
166extern const char * const mi_lttng_loglevel_str_jul_warning;
136f2f81 167
970d848b 168/* String related to loglevel Log4j */
4965f956
JG		 169extern const char * const mi_lttng_loglevel_str_log4j_off;
170extern const char * const mi_lttng_loglevel_str_log4j_fatal;
171extern const char * const mi_lttng_loglevel_str_log4j_error;
172extern const char * const mi_lttng_loglevel_str_log4j_warn;
173extern const char * const mi_lttng_loglevel_str_log4j_info;
174extern const char * const mi_lttng_loglevel_str_log4j_debug;
175extern const char * const mi_lttng_loglevel_str_log4j_trace;
176extern const char * const mi_lttng_loglevel_str_log4j_all;
970d848b 177
0e115563 178/* String related to loglevel Python */
4965f956
JG		 179extern const char * const mi_lttng_loglevel_str_python_critical;
180extern const char * const mi_lttng_loglevel_str_python_error;
181extern const char * const mi_lttng_loglevel_str_python_warning;
182extern const char * const mi_lttng_loglevel_str_python_info;
183extern const char * const mi_lttng_loglevel_str_python_debug;
184extern const char * const mi_lttng_loglevel_str_python_notset;
0e115563 185
1734c658 186/* String related to loglevel type */
4965f956
JG		 187extern const char * const mi_lttng_loglevel_type_all;
188extern const char * const mi_lttng_loglevel_type_range;
189extern const char * const mi_lttng_loglevel_type_single;
190extern const char * const mi_lttng_loglevel_type_unknown;
5e18ec73 191
136f2f81 192/* String related to a lttng_snapshot */
4965f956
JG		 193extern const char * const mi_lttng_element_snapshot_ctrl_url;
194extern const char * const mi_lttng_element_snapshot_data_url;
195extern const char * const mi_lttng_element_snapshot_max_size;
196extern const char * const mi_lttng_element_snapshot_n_ptr;
197extern const char * const mi_lttng_element_snapshot_session_name;
198extern const char * const mi_lttng_element_snapshots;
50534d6f 199
a23cb78a 200/* String related to track/untrack command */
44cdb3a2 201extern const char * const mi_lttng_element_track_untrack_all_wildcard;
a23cb78a 202
44cdb3a2 203LTTNG_HIDDEN extern const char * const mi_lttng_element_session_name;
d68c9a04
JD		 204
205/* String related to rotate command */
44cdb3a2
MJ		 206LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation;
207LTTNG_HIDDEN extern const char * const mi_lttng_element_rotate_status;
208LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_schedule;
209LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_schedules;
210LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_schedule_periodic;
211LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_schedule_periodic_time_us;
212LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_schedule_size_threshold;
213LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_schedule_size_threshold_bytes;
214LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_schedule_result;
215LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_schedule_results;
216LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_state;
217LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location;
218LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location_local;
219LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location_local_absolute_path;
220LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location_relay;
221LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location_relay_host;
222LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location_relay_control_port;
223LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location_relay_data_port;
224LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location_relay_protocol;
225LTTNG_HIDDEN extern const char * const mi_lttng_element_rotation_location_relay_relative_path;
91c4d516
JG		 226
227/* String related to enum lttng_rotation_state */
44cdb3a2
MJ		 228LTTNG_HIDDEN extern const char * const mi_lttng_rotation_state_str_ongoing;
229LTTNG_HIDDEN extern const char * const mi_lttng_rotation_state_str_completed;
230LTTNG_HIDDEN extern const char * const mi_lttng_rotation_state_str_expired;
231LTTNG_HIDDEN extern const char * const mi_lttng_rotation_state_str_error;
91c4d516
JG		 232
233/* String related to enum lttng_trace_archive_location_relay_protocol_type */
44cdb3a2 234LTTNG_HIDDEN extern const char * const mi_lttng_rotation_location_relay_protocol_str_tcp;
d68c9a04 235
0f7c2963
JR		 236/* String related to rate_policy elements */
237LTTNG_HIDDEN extern const char *const mi_lttng_element_rate_policy;
238LTTNG_HIDDEN extern const char *const mi_lttng_element_rate_policy_every_n;
239LTTNG_HIDDEN extern const char *const mi_lttng_element_rate_policy_once_after_n;
240
241LTTNG_HIDDEN extern const char
242 *const mi_lttng_element_rate_policy_every_n_interval;
243LTTNG_HIDDEN extern const char
244 *const mi_lttng_element_rate_policy_once_after_n_threshold;
245
246/* String related to action elements */
247LTTNG_HIDDEN extern const char *const mi_lttng_element_action;
248LTTNG_HIDDEN extern const char *const mi_lttng_element_action_list;
249LTTNG_HIDDEN extern const char *const mi_lttng_element_action_notify;
250LTTNG_HIDDEN extern const char *const mi_lttng_element_action_start_session;
251LTTNG_HIDDEN extern const char *const mi_lttng_element_action_stop_session;
252LTTNG_HIDDEN extern const char *const mi_lttng_element_action_rotate_session;
253LTTNG_HIDDEN extern const char *const mi_lttng_element_action_snapshot_session;
254LTTNG_HIDDEN extern const char
255 *const mi_lttng_element_action_snapshot_session_output;
256
257/* String related to condition */
258LTTNG_HIDDEN extern const char *const mi_lttng_element_condition;
259LTTNG_HIDDEN extern const char
260 *const mi_lttng_element_condition_buffer_usage_high;
261LTTNG_HIDDEN extern const char
262 *const mi_lttng_element_condition_buffer_usage_low;
263LTTNG_HIDDEN extern const char
264 *const mi_lttng_element_condition_event_rule_matches;
265LTTNG_HIDDEN extern const char
266 *const mi_lttng_element_condition_session_consumed_size;
267LTTNG_HIDDEN extern const char
268 *const mi_lttng_element_condition_session_rotation;
269LTTNG_HIDDEN extern const char
270 *const mi_lttng_element_condition_session_rotation_completed;
271LTTNG_HIDDEN extern const char
272 *const mi_lttng_element_condition_session_rotation_ongoing;
273LTTNG_HIDDEN extern const char *const mi_lttng_element_condition_channel_name;
274LTTNG_HIDDEN extern const char *const mi_lttng_element_condition_threshold_ratio;
275LTTNG_HIDDEN extern const char *const mi_lttng_element_condition_threshold_bytes;
276
277/* String related to capture descriptor */
278LTTNG_HIDDEN extern const char *const mi_lttng_element_capture_descriptor;
279LTTNG_HIDDEN extern const char *const mi_lttng_element_capture_descriptors;
280
281/* String related to event expression */
282LTTNG_HIDDEN extern const char *const mi_lttng_element_event_expr;
283LTTNG_HIDDEN extern const char *const mi_lttng_element_event_expr_payload_field;
284LTTNG_HIDDEN extern const char
285 *const mi_lttng_element_event_expr_channel_context_field;
286LTTNG_HIDDEN extern const char
287 *const mi_lttng_element_event_expr_app_specific_context_field;
288LTTNG_HIDDEN extern const char
289 *const mi_lttng_element_event_expr_array_field_element;
290
291LTTNG_HIDDEN extern const char *const mi_lttng_element_event_expr_provider_name;
292LTTNG_HIDDEN extern const char *const mi_lttng_element_event_expr_type_name;
293LTTNG_HIDDEN extern const char *const mi_lttng_element_event_expr_index;
294
295/* String related to event rule */
296LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule;
297
298/* String related to lttng_event_rule */
299LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule_event_name;
300LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule_name_pattern;
301LTTNG_HIDDEN extern const char
302 *const mi_lttng_element_event_rule_filter_expression;
303LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule_jul_logging;
304LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule_kernel_kprobe;
305LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule_kernel_syscall;
306LTTNG_HIDDEN extern const char
307 *const mi_lttng_element_event_rule_kernel_tracepoint;
308LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule_kernel_uprobe;
309LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule_log4j_logging;
310LTTNG_HIDDEN extern const char *const mi_lttng_element_event_rule_python_logging;
311LTTNG_HIDDEN extern const char
312 *const mi_lttng_element_event_rule_user_tracepoint;
313
314/* String related to lttng_event_rule_kernel_syscall. */
315LTTNG_HIDDEN extern const char
316 *const mi_lttng_element_event_rule_kernel_syscall_emission_site;
317
318/* String related to enum lttng_event_rule_kernel_syscall_emission_site. */
319LTTNG_HIDDEN extern const char *const
320 mi_lttng_event_rule_kernel_syscall_emission_site_entry_exit;
321LTTNG_HIDDEN extern const char
322 *const mi_lttng_event_rule_kernel_syscall_emission_site_entry;
323LTTNG_HIDDEN extern const char
324 *const mi_lttng_event_rule_kernel_syscall_emission_site_exit;
325
326LTTNG_HIDDEN extern const char *const
327 mi_lttng_element_event_rule_user_tracepoint_name_pattern_exclusions;
328LTTNG_HIDDEN extern const char *const
329 mi_lttng_element_event_rule_user_tracepoint_name_pattern_exclusion;
330
331/* String related to log level rule. */
332LTTNG_HIDDEN extern const char *const mi_lttng_element_log_level_rule;
333LTTNG_HIDDEN extern const char *const mi_lttng_element_log_level_rule_exactly;
334LTTNG_HIDDEN extern const char
335 *const mi_lttng_element_log_level_rule_at_least_as_severe_as;
336LTTNG_HIDDEN extern const char *const
337 mi_lttng_element_log_level_rule_at_least_as_severe_as_thre;
338LTTNG_HIDDEN extern const char *const mi_lttng_element_log_level_rule_level;
339
340/* String related to kernel probe location. */
341LTTNG_HIDDEN extern const char *const mi_lttng_element_kernel_probe_location;
342LTTNG_HIDDEN extern const char
343 *const mi_lttng_element_kernel_probe_location_symbol_offset;
344LTTNG_HIDDEN extern const char *const
345 mi_lttng_element_kernel_probe_location_symbol_offset_name;
346LTTNG_HIDDEN extern const char *const
347 mi_lttng_element_kernel_probe_location_symbol_offset_offset;
348LTTNG_HIDDEN extern const char
349 *const mi_lttng_element_kernel_probe_location_address;
350LTTNG_HIDDEN extern const char
351 *const mi_lttng_element_kernel_probe_location_address_address;
352
353/* String related to userspace probe location. */
354LTTNG_HIDDEN extern const char *const mi_lttng_element_userspace_probe_location;
355LTTNG_HIDDEN extern const char
356 *const mi_lttng_element_userspace_probe_location_binary_path;
357LTTNG_HIDDEN extern const char
358 *const mi_lttng_element_userspace_probe_location_function;
359LTTNG_HIDDEN extern const char
360 *const mi_lttng_element_userspace_probe_location_function_name;
361LTTNG_HIDDEN extern const char
362 *const mi_lttng_element_userspace_probe_location_lookup_method;
363LTTNG_HIDDEN extern const char *const
364 mi_lttng_element_userspace_probe_location_lookup_method_function_default;
365LTTNG_HIDDEN extern const char *const
366 mi_lttng_element_userspace_probe_location_lookup_method_function_elf;
367LTTNG_HIDDEN extern const char *const
368 mi_lttng_element_userspace_probe_location_lookup_method_tracepoint_sdt;
369LTTNG_HIDDEN extern const char
370 *const mi_lttng_element_userspace_probe_location_tracepoint;
371LTTNG_HIDDEN extern const char *const
372 mi_lttng_element_userspace_probe_location_tracepoint_probe_name;
373LTTNG_HIDDEN extern const char *const
374 mi_lttng_element_userspace_probe_location_tracepoint_provider_name;
375
376/* String related to enum
377 * lttng_userspace_probe_location_function_instrumentation_type */
378LTTNG_HIDDEN extern const char *const
379 mi_lttng_element_userspace_probe_location_function_instrumentation_type;
380LTTNG_HIDDEN extern const char *const
381 mi_lttng_userspace_probe_location_function_instrumentation_type_entry;
382
383/* String related to trigger */
384LTTNG_HIDDEN extern const char *const mi_lttng_element_triggers;
385LTTNG_HIDDEN extern const char *const mi_lttng_element_trigger;
386LTTNG_HIDDEN extern const char *const mi_lttng_element_trigger_owner_uid;
387
388/* String related to error_query. */
389LTTNG_HIDDEN extern const char *const mi_lttng_element_error_query_result;
390LTTNG_HIDDEN extern const char
391 *const mi_lttng_element_error_query_result_counter;
392LTTNG_HIDDEN extern const char
393 *const mi_lttng_element_error_query_result_counter_value;
394LTTNG_HIDDEN extern const char
395 *const mi_lttng_element_error_query_result_description;
396LTTNG_HIDDEN extern const char *const mi_lttng_element_error_query_result_name;
397LTTNG_HIDDEN extern const char *const mi_lttng_element_error_query_result_type;
398LTTNG_HIDDEN extern const char *const mi_lttng_element_error_query_results;
399
59deec0c
JR		 400/* String related to add-context command */
401LTTNG_HIDDEN extern const char * const mi_lttng_element_context_symbol;
402
5e18ec73 403/* Utility string function */
970d848b 404const char *mi_lttng_loglevel_string(int value, enum lttng_domain_type domain);
5e18ec73
JR		 405const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value);
406const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type value);
407const char *mi_lttng_domaintype_string(enum lttng_domain_type value);
408const char *mi_lttng_buffertype_string(enum lttng_buffer_type value);
91c4d516
JG		 409const char *mi_lttng_rotation_state_string(enum lttng_rotation_state value);
410const char *mi_lttng_trace_archive_location_relay_protocol_type_string(
411 enum lttng_trace_archive_location_relay_protocol_type value);
5e18ec73 412
c7e35b03
JR		 413/*
414 * Create an instance of a machine interface writer.
415 *
416 * fd_output File to which the XML content must be written. The file will be
417 * closed once the mi_writer has been destroyed.
418 *
419 * Returns an instance of a machine interface writer on success, NULL on
420 * error.
421 */
422struct mi_writer *mi_lttng_writer_create(int fd_output, int mi_output_type);
423
424/*
425 * Destroy an instance of a machine interface writer.
426 *
427 * writer An instance of a machine interface writer.
428 *
429 * Returns zero if the XML document could be closed cleanly. Negative values
430 * indicate an error.
431 */
432int mi_lttng_writer_destroy(struct mi_writer *writer);
433
434/*
435 * Open a command tag and add it's name node.
436 *
437 * writer An instance of a machine interface writer.
c7e35b03
JR		 438 * command The command name.
439 *
440 * Returns zero if the XML document could be closed cleanly.
441 * Negative values indicate an error.
442 */
443int mi_lttng_writer_command_open(struct mi_writer *writer, const char *command);
444
445/*
446 * Close a command tag.
447 *
448 * writer An instance of a machine interface writer.
449 *
450 * Returns zero if the XML document could be closed cleanly.
451 * Negative values indicate an error.
452 */
453int mi_lttng_writer_command_close(struct mi_writer *writer);
454
455/*
456 * Open an element tag.
457 *
458 * writer An instance of a machine interface writer.
c7e35b03
JR		 459 * element_name Element tag name.
460 *
461 * Returns zero if the XML document could be closed cleanly.
462 * Negative values indicate an error.
463 */
464int mi_lttng_writer_open_element(struct mi_writer *writer,
465 const char *element_name);
466
467/*
468 * Close the current element tag.
469 *
470 * writer An instance of a machine interface writer.
471 *
472 * Returns zero if the XML document could be closed cleanly.
473 * Negative values indicate an error.
474 */
475int mi_lttng_writer_close_element(struct mi_writer *writer);
476
477/*
5e18ec73 478 * Close multiple element.
c7e35b03
JR		 479 *
480 * writer An instance of a machine interface writer.
5e18ec73 481 * nb_element Number of elements.
c7e35b03 482 *
5e18ec73
JR		 483 * Returns zero if the XML document could be closed cleanly.
484 * Negative values indicate an error.
485 */
486int mi_lttng_close_multi_element(struct mi_writer *writer,
487 unsigned int nb_element);
488
489/*
490 * Write an element of type unsigned int.
c7e35b03 491 *
5e18ec73
JR		 492 * writer An instance of a machine interface writer.
493 * element_name Element name.
c7e35b03
JR		 494 * value Unsigned int value of the element
495 *
496 * Returns zero if the element's value could be written.
497 * Negative values indicate an error.
498 */
499int mi_lttng_writer_write_element_unsigned_int(struct mi_writer *writer,
500 const char *element_name, uint64_t value);
501
502/*
503 * Write an element of type signed int.
504 *
505 * writer An instance of a machine interface writer.
c7e35b03 506 * element_name Element name.
5e18ec73 507 * value Signed int value of the element.
c7e35b03
JR		 508 *
509 * Returns zero if the element's value could be written.
510 * Negative values indicate an error.
511 */
512int mi_lttng_writer_write_element_signed_int(struct mi_writer *writer,
513 const char *element_name, int64_t value);
514
515/*
516 * Write an element of type boolean.
517 *
518 * writer An instance of a machine interface writer.
c7e35b03 519 * element_name Element name.
5e18ec73 520 * value Boolean value of the element.
c7e35b03
JR		 521 *
522 * Returns zero if the element's value could be written.
523 * Negative values indicate an error.
524 */
525int mi_lttng_writer_write_element_bool(struct mi_writer *writer,
526 const char *element_name, int value);
527
528/*
529 * Write an element of type string.
530 *
531 * writer An instance of a machine interface writer.
c7e35b03 532 * element_name Element name.
5e18ec73 533 * value String value of the element.
c7e35b03
JR		 534 *
535 * Returns zero if the element's value could be written.
536 * Negative values indicate an error.
537 */
538int mi_lttng_writer_write_element_string(struct mi_writer *writer,
539 const char *element_name, const char *value);
540
7c9e11fd
JR		 541/*
542 * Write an element of type double.
543 *
544 * writer An instance of a machine interface writer.
545 * element_name Element name.
546 * value Double value of the element.
547 *
548 * Returns zero if the element's value could be written.
549 * Negative values indicate an error.
550 */
551int mi_lttng_writer_write_element_double(struct mi_writer *writer,
552 const char *element_name,
553 double value);
554
c7e35b03
JR		 555/*
556 * Machine interface of struct version.
557 *
558 * writer An instance of a machine interface writer.
c7e35b03 559 * version Version struct.
c7e35b03 560 * lttng_description String value of the version description.
c7e35b03
JR		 561 * lttng_license String value of the version license.
562 *
563 * Returns zero if the element's value could be written.
564 * Negative values indicate an error.
565 */
566int mi_lttng_version(struct mi_writer *writer, struct mi_lttng_version *version,
567 const char *lttng_description, const char *lttng_license);
568
569/*
5e18ec73 570 * Machine interface: open a sessions element.
c7e35b03 571 *
5e18ec73 572 * writer An instance of a machine interface writer.
c7e35b03 573 *
5e18ec73
JR		 574 * Returns zero if the element's value could be written.
575 * Negative values indicate an error.
576 */
577int mi_lttng_sessions_open(struct mi_writer *writer);
578
579/*
580 * Machine interface of struct session.
c7e35b03 581 *
5e18ec73
JR		 582 * writer An instance of a machine interface writer.
583 * session An instance of a session.
584 * is_open Defines whether or not the session element shall be closed.
585 * This should be used carefully and the client
586 * must close the session element.
136f2f81 587 * Use case: nested additional information on a session
c7e35b03 588 * ex: domain,channel event.
c7e35b03
JR		 589 *
590 * Returns zero if the element's value could be written.
591 * Negative values indicate an error.
592 */
593int mi_lttng_session(struct mi_writer *writer,
5e18ec73
JR		 594 struct lttng_session *session, int is_open);
595
596/*
597 * Machine interface: open a domains element.
598 *
599 * writer An instance of a machine interface writer.
600 *
601 * Returns zero if the element's value could be written.
602 * Negative values indicate an error.
603 */
604int mi_lttng_domains_open(struct mi_writer *writer);
605
606/*
607 * Machine interface of struct domain.
608 *
609 * writer An instance of a machine interface writer.
610 * domain An instance of a domain.
611 *
612 * is_open Defines whether or not the session element shall be closed.
613 * This should be used carefully and the client
614 * must close the domain element.
615 * Use case: nested addition information on a domain
616 * ex: channel event.
617 *
618 * Returns zero if the element's value could be written.
619 * Negative values indicate an error.
620 */
621int mi_lttng_domain(struct mi_writer *writer,
622 struct lttng_domain *domain, int is_open);
623
624/*
625 * Machine interface: open a channels element.
626 *
627 * writer An instance of a machine interface writer.
628 *
629 * Returns zero if the element's value could be written.
630 * Negative values indicate an error.
631 */
632int mi_lttng_channels_open(struct mi_writer *writer);
633
634/*
635 * Machine interface of struct channel.
636 *
637 * writer An instance of a machine interface writer.
638 * channel An instance of a channel.
639 *
640 * is_open Defines whether or not the session element shall be closed.
641 * This should be used carefully and the client
642 * must close the channel element.
643 * Use case: nested addition information on a channel.
644 * ex: channel event.
645 *
646 * Returns zero if the element's value could be written.
647 * Negative values indicate an error.
648 */
649int mi_lttng_channel(struct mi_writer *writer,
650 struct lttng_channel *channel, int is_open);
651
652/*
653 * Machine interface of struct channel_attr.
654 *
655 * writer An instance of a machine interface writer.
656 * attr An instance of a channel_attr struct.
657 *
658 * Returns zero if the element's value could be written.
659 * Negative values indicate an error.
660 */
661int mi_lttng_channel_attr(struct mi_writer *writer,
662 struct lttng_channel_attr *attr);
663
664/*
665* Machine interface for event common attributes.
666*
667* writer An instance of a mi writer.
668* event single trace event.
669*
670* The common attribute are:
671* - mi event element
672* - event name
673* - event type
674* - enabled tag
675* - event filter
676*
677* Returns zero if the element's value could be written.
678* Negative values indicate an error.
679*/
680int mi_lttng_event_common_attributes(struct mi_writer *writer,
681 struct lttng_event *event);
682
683/*
684 * Machine interface for kernel tracepoint event with a loglevel.
685 *
686 * writer An instance of a mi writer.
687 * event single trace event.
970d848b 688 * domain Event's domain
5e18ec73
JR		 689 *
690 * Returns zero if the element's value could be written.
691 * Negative values indicate an error.
692 */
693int mi_lttng_event_tracepoint_loglevel(struct mi_writer *writer,
970d848b 694 struct lttng_event *event, enum lttng_domain_type domain);
5e18ec73
JR		 695
696/*
697 * Machine interface for kernel tracepoint event with no loglevel.
698 *
699 * writer An instance of a mi writer.
700 * event single trace event.
701 *
702 * Returns zero if the element's value could be written.
703 * Negative values indicate an error.
704 */
705int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer *writer,
706 struct lttng_event *event);
707
708/*
709 * Machine interface for kernel function and probe event.
710 *
711 * writer An instance of a mi writer.
712 * event single trace event.
713 *
714 * Returns zero if the element's value could be written.
715 * Negative values indicate an error.
716 */
717int mi_lttng_event_function_probe(struct mi_writer *writer,
718 struct lttng_event *event);
719
720/*
721 * Machine interface for kernel function entry event.
722 *
723 * writer An instance of a mi writer.
724 * event single trace event.
725 *
726 * Returns zero if the element's value could be written.
727 * Negative values indicate an error.
728 */
729int mi_lttng_event_function_entry(struct mi_writer *writer,
730 struct lttng_event *event);
731
732/*
733 * Machine interface: open an events element.
734 *
735 * writer An instance of a machine interface writer.
736 *
737 * Returns zero if the element's value could be written.
738 * Negative values indicate an error.
739 */
740int mi_lttng_events_open(struct mi_writer *writer);
741
742/*
743 * Machine interface for printing an event.
744 * The trace event type currently supported are:
745 * TRACEPOINT,
746 * PROBE,
747 * FUNCTION,
748 * FUNCTION_ENTRY,
749 * SYSCALL
750 *
751 * writer An instance of a mi writer.
752 * event single trace event.
753 * is_open Defines whether or not the session element shall be closed.
754 * This should be used carefully and the client
755 * must close the event element.
756 * Use case: nested additional information
970d848b 757 * domain Event's domain
5e18ec73
JR		 758 *
759 * Returns zero if the element's value could be written.
760 * Negative values indicate an error.
761 */
762int mi_lttng_event(struct mi_writer *writer, struct lttng_event *event,
970d848b 763 int is_open, enum lttng_domain_type domain);
5e18ec73
JR		 764
765/*
766 * Machine interface for struct lttng_event_field.
767 *
768 * writer An instance of a mi writer.
769 * field An event_field instance.
770 *
771 * Returns zero if the element's value could be written.
772 * Negative values indicate an error.
773 */
774int mi_lttng_event_field(struct mi_writer *writer,
775 struct lttng_event_field *field);
776
777/*
778 * Machine interface: open a event_fields element.
779 *
780 * writer An instance of a machine interface writer.
781 *
e4d484a5 782 * Returns zero if the element have be written.
5e18ec73
JR		 783 * Negative values indicate an error.
784 */
785int mi_lttng_event_fields_open(struct mi_writer *writer);
786
ebbf5ab7
JR		 787/*
788 * Machine interface: open a trackers element.
789 *
790 * writer An instance of a machine interface writer.
791 *
792 * Returns zero if the element's value could be written.
793 * Negative values indicate an error.
794 */
795int mi_lttng_trackers_open(struct mi_writer *writer);
796
797/*
159b042f 798 * Machine interface: open a process attribute tracker element.
ebbf5ab7
JR		 799 *
800 * writer An instance of a machine interface writer.
801 *
802 * Returns zero if the element's value could be written.
803 * Negative values indicate an error.
804 *
805 * Note: A targets element is also opened for each tracker definition
806 */
159b042f
JG		 807int mi_lttng_process_attribute_tracker_open(
808 struct mi_writer *writer, enum lttng_process_attr process_attr);
ebbf5ab7 809
5e18ec73
JR		 810/*
811 * Machine interface: open a PIDs element.
812 *
813 * writer An instance of a machine interface writer.
814 *
815 * Returns zero if the element's value could be written.
816 * Negative values indicate an error.
817 */
818int mi_lttng_pids_open(struct mi_writer *writer);
819
820/*
ebbf5ab7
JR		 821 * Machine interface: open a processes element.
822 *
823 * writer An instance of a machine interface writer.
824 *
825 * Returns zero if the element's value could be written.
826 * Negative values indicate an error.
827 */
828int mi_lttng_processes_open(struct mi_writer *writer);
829
830/*
831 * Machine interface of a Process.
5e18ec73
JR		 832 *
833 * writer An instance of a machine interface writer.
834 * pid A PID.
835 *
836 * is_open Defines whether or not the session element shall be closed.
837 * This should be used carefully and the client
838 * must close the pid element.
839 * Use case: nested addition information on a domain
840 * ex: channel event.
841 *
842 * Returns zero if the element's value could be written.
843 * Negative values indicate an error.
844 */
ebbf5ab7 845int mi_lttng_process(struct mi_writer *writer, pid_t pid , const char *name,
5e18ec73 846 int is_open);
bf239d4c
JR		 847
848/*
849 * TODO: move pid of lttng list -u to process semantic on mi api bump
850 * Machine interface of a Process.
851 *
852 * writer An instance of a machine interface writer.
853 * pid A PID.
854 *
855 * is_open Defines whether or not the session element shall be closed.
856 * This should be used carefully and the client
857 * must close the pid element.
858 * Use case: nested addition information on a domain
859 * ex: channel event.
860 *
861 * Returns zero if the element's value could be written.
862 * Negative values indicate an error.
863 */
864int mi_lttng_pid(struct mi_writer *writer, pid_t pid , const char *name,
865 int is_open);
159b042f 866
ebbf5ab7 867/*
159b042f 868 * Machine interface: open a process attribute values element.
ebbf5ab7
JR		 869 *
870 * writer An instance of a machine interface writer.
871 *
872 * Returns zero if the element's value could be written.
873 * Negative values indicate an error.
874 */
159b042f 875int mi_lttng_process_attr_values_open(struct mi_writer *writer);
ebbf5ab7
JR		 876
877/*
159b042f 878 * Machine interface for track/untrack of all process attribute values.
ebbf5ab7
JR		 879 *
880 * writer An instance of a machine interface writer.
881 *
882 * Returns zero if the element's value could be written.
883 * Negative values indicate an error.
884 */
159b042f
JG		 885int mi_lttng_all_process_attribute_value(struct mi_writer *writer,
886 enum lttng_process_attr process_attr,
887 bool is_open);
888
889/*
890 * Machine interface for track/untrack of an integral process attribute value.
891 *
892 * writer An instance of a machine interface writer.
893 *
894 * Returns zero if the element's value could be written.
895 * Negative values indicate an error.
896 */
897int mi_lttng_integral_process_attribute_value(struct mi_writer *writer,
898 enum lttng_process_attr process_attr,
899 int64_t value,
900 bool is_open);
901
902/*
903 * Machine interface for track/untrack of a string process attribute value.
904 *
905 * writer An instance of a machine interface writer.
906 *
907 * Returns zero if the element's value could be written.
908 * Negative values indicate an error.
909 */
910int mi_lttng_string_process_attribute_value(struct mi_writer *writer,
911 enum lttng_process_attr process_attr,
912 const char *value,
913 bool is_open);
c7e35b03 914
89b72577
JRJ		 915/*
916 * Machine interface of a context.
917 *
918 * writer An instance of a machine interface writer
919 *
920 * context An instance of a lttng_event_context
921 *
922 * is_open Define if we close the context element
923 * This should be used carefully and the client
924 * need to close the context element.
89b72577
JRJ		 925 * Returns zero if the element's value could be written.
926 * Negative values indicate an error.
927 */
928int mi_lttng_context(struct mi_writer *writer,
929 struct lttng_event_context *context, int is_open);
930
931/*
932 * Machine interface of a perf_counter_context.
933 *
934 * writer An instance of a machine interface writer
935 *
936 * contest An instance of a lttng_event_perf_counter_ctx
937 *
938 * Returns zero if the element's value could be written.
939 * Negative values indicate an error.
940 */
941int mi_lttng_perf_counter_context(struct mi_writer *writer,
942 struct lttng_event_perf_counter_ctx *perf_context);
943
50534d6f
JRJ		 944/*
945 * Machine interface of the snapshot list_output.
946 * It specifies the session for which we are listing snapshots,
947 * and it opens a snapshots element to list a sequence
948 * of snapshots.
949 *
950 * writer An instance of a machine interface writer.
951 *
952 * session_name: Snapshot output for session "session_name".
953 *
954 * Note: The client has to close the session and the snapshots elements after
955 * having listed every lttng_snapshot_output.
956 *
957 * Returns zero if the element's value could be written.
958 * Negative values indicate an error.
959 */
960int mi_lttng_snapshot_output_session_name(struct mi_writer *writer,
961 const char *session_name);
962
963/*
964 * Machine interface of the snapshot output.
965 * The machine interface serializes the following attributes:
966 * - id: ID of the snapshot output.
967 * - name: Name of the output.
968 * - data_url : Destination of the output.
969 * - ctrl_url: Destination of the output.
970 * - max_size: total size of all stream combined.
971 *
972 * writer An instance of a machine interface writer.
973 *
974 * output: A list of snapshot_output.
975 *
976 * Returns zero if the element's value could be written.
977 * Negative values indicate an error.
978 */
979int mi_lttng_snapshot_list_output(struct mi_writer *writer,
0f7c2963 980 const struct lttng_snapshot_output *output);
50534d6f
JRJ		 981
982/*
983 * Machine interface of the output of the command snapshot del output
984 * when deleting a snapshot either by id or by name.
985 * If the snapshot was found and successfully deleted using its id,
986 * it return the id of the snapshot and the current session name on which it
987 * was attached.
988 *
989 * Otherwise, it do the same process with the name of the snapshot, if the
990 * snapshot output id is undefined.
991 *
992 * writer An instance of a machine interface writer.
993 *
994 * id: ID of the snapshot output.
995 *
996 * name: Name of the snapshot.
997 *
998 * current_session_name: Session to which the snapshot belongs.
999 *
1000 * Returns zero if the element's value could be written.
1001 * Negative values indicate an error.
1002 */
1003int mi_lttng_snapshot_del_output(struct mi_writer *writer, int id,
1004 const char *name, const char *current_session_name);
1005
1006/*
1007 * Machine interface of the output of the command snapshot add output
1008 * when adding a snapshot from a user URL.
1009 *
1010 * If the snapshot was successfully added, the machine interface lists
1011 * these information:
1012 * - id: ID of the newly add snapshot output.
1013 * - current_session_name: Name of the session to which the output was added.
1014 * - ctrl_url: Destination of the output.
1015 * - max_size: total size of all stream combined.
1016 *
1017 * writer An instance of a machine interface writer.
1018 *
1019 * current_session_name: Session to which the snapshot belongs.
1020 *
1021 * n_ptr:
1022 *
1023 * output: iterator over a lttng_snapshot_output_list which contain
1024 * the snapshot output informations.
1025 *
1026 * Returns zero if the element's value could be written.
1027 * Negative values indicate an error.
1028 */
1029int mi_lttng_snapshot_add_output(struct mi_writer *writer,
1030 const char *current_session_name, const char *n_ptr,
1031 struct lttng_snapshot_output *output);
1032
1033/*
1034 * Machine interface of the output of the command snapshot
1035 * record from a URL (if given).
1036 *
1037 * If the snapshot is successfully recorded from a url, the machine interface
1038 * output the following information:
1039 * - url: Destination of the output stored in the snapshot.
1040 *
1041 * Otherwise, the machine interface output the data and ctrl url received
1042 * from the command-line.
1043 *
1044 * writer An instance of a machine interface writer.
1045 *
1046 * current_session_name: Snapshot record for session "current_session_name".
1047 *
1048 * ctrl_url, data_url: Destination of the output receive from the command-line.
1049 *
1050 * Returns zero if the element's value could be written.
1051 * Negative values indicate an error.
1052 */
1053int mi_lttng_snapshot_record(struct mi_writer *writer,
1054 const char *current_session_name, const char *url,
1055 const char *cmdline_ctrl_url, const char *cmdline_data_url);
1056
66ea93b1
JG		 1057/*
1058 * Machine interface representation of a session rotation schedule.
1059 *
1060 * The machine interface serializes the provided schedule as one of the choices
1061 * from 'rotation_schedule_type'.
1062 *
1063 * writer: An instance of a machine interface writer.
1064 *
1065 * schedule: An lttng rotation schedule descriptor object.
1066 *
1067 * Returns zero if the element's value could be written.
1068 * Negative values indicate an error.
1069 */
1070int mi_lttng_rotation_schedule(struct mi_writer *writer,
1071 const struct lttng_rotation_schedule *schedule);
1072
1073/*
1074 * Machine interface of a session rotation schedule result.
1075 * This is an element that is part of the output of the enable-rotation and
1076 * disable-rotation commands.
1077 *
1078 * The machine interface provides the following information:
1079 * - schedule: the session rotation schedule descriptor.
1080 * - success: whether the sub-command succeeded.
1081 *
1082 * writer: An instance of a machine interface writer.
1083 *
66ea93b1
JG		 1084 * schedule: An lttng rotation schedule descriptor object.
1085 *
1086 * success: Whether the sub-command suceeded.
1087 *
1088 * Returns zero if the element's value could be written.
1089 * Negative values indicate an error.
1090 */
1091int mi_lttng_rotation_schedule_result(struct mi_writer *writer,
1092 const struct lttng_rotation_schedule *schedule,
1093 bool success);
1094
91c4d516
JG		 1095/*
1096 * Machine interface of a session rotation result.
1097 * This is an element that is part of the output of the rotate command.
1098 *
1099 * The machine interface provides the following information:
1100 * - session_name: the session to be rotated.
1101 * - state: the session rotation state.
1102 * - location: the location of the completed chunk archive.
1103 *
1104 * writer: An instance of a machine interface writer.
1105 *
1106 * session_name: The session to which the rotate command applies.
1107 *
1108 * location: A location descriptor object.
1109 *
1110 * success: Whether the sub-command suceeded.
1111 *
1112 * Returns zero if the element's value could be written.
1113 * Negative values indicate an error.
1114 */
1115int mi_lttng_rotate(struct mi_writer *writer,
1116 const char *session_name,
1117 enum lttng_rotation_state rotation_state,
1118 const struct lttng_trace_archive_location *location);
1119
c7e35b03 1120#endif /* _MI_LTTNG_H */
LTTng tools - Deliverables
This page took 0.111462 seconds and 5 git commands to generate.