2 * Copyright (C) 2014 - Jonathan Rajotte <jonathan.r.julien@gmail.com>
3 * - Olivier Cotte <olivier.cotte@polymtl.ca>
4 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License, version 2 only, as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <common/error.h>
26 #include <common/macros.h>
27 #include <common/config/session-config.h>
28 #include <lttng/lttng.h>
30 /* Don't want to reference snapshot-internal.h here */
31 struct lttng_snapshot_output
;
33 /* Instance of a machine interface writer. */
35 struct config_writer
*writer
;
36 enum lttng_mi_output_type type
;
40 * Version information for the machine interface.
42 struct mi_lttng_version
{
43 char version
[LTTNG_NAME_MAX
]; /* Version number of package */
44 uint32_t version_major
; /* LTTng-Tools major version number */
45 uint32_t version_minor
; /* LTTng-Tools minor version number */
46 uint32_t version_patchlevel
; /* LTTng-Tools patchlevel version number */
47 char version_commit
[LTTNG_NAME_MAX
]; /* Commit hash of the current version */
48 char version_name
[LTTNG_NAME_MAX
];
49 char package_url
[LTTNG_NAME_MAX
]; /* Define to the home page for this package. */
52 /* Strings related to command */
53 extern const char * const mi_lttng_element_command
;
54 extern const char * const mi_lttng_element_command_action
;
55 extern const char * const mi_lttng_element_command_add_context
;
56 extern const char * const mi_lttng_element_command_create
;
57 extern const char * const mi_lttng_element_command_destroy
;
58 extern const char * const mi_lttng_element_command_disable_channel
;
59 extern const char * const mi_lttng_element_command_disable_event
;
60 extern const char * const mi_lttng_element_command_enable_channels
;
61 extern const char * const mi_lttng_element_command_enable_event
;
62 extern const char * const mi_lttng_element_command_list
;
63 extern const char * const mi_lttng_element_command_load
;
64 extern const char * const mi_lttng_element_command_metadata
;
65 extern const char * const mi_lttng_element_command_metadata_action
;
66 extern const char * const mi_lttng_element_command_regenerate
;
67 extern const char * const mi_lttng_element_command_regenerate_action
;
68 extern const char * const mi_lttng_element_command_name
;
69 extern const char * const mi_lttng_element_command_output
;
70 extern const char * const mi_lttng_element_command_save
;
71 extern const char * const mi_lttng_element_command_set_session
;
72 extern const char * const mi_lttng_element_command_snapshot
;
73 extern const char * const mi_lttng_element_command_snapshot_add
;
74 extern const char * const mi_lttng_element_command_snapshot_del
;
75 extern const char * const mi_lttng_element_command_snapshot_list
;
76 extern const char * const mi_lttng_element_command_snapshot_record
;
77 extern const char * const mi_lttng_element_command_start
;
78 extern const char * const mi_lttng_element_command_stop
;
79 extern const char * const mi_lttng_element_command_success
;
80 extern const char * const mi_lttng_element_command_track
;
81 extern const char * const mi_lttng_element_command_untrack
;
82 extern const char * const mi_lttng_element_command_version
;
83 extern const char * const mi_lttng_element_command_rotate
;
84 extern const char * const mi_lttng_element_command_enable_rotation
;
85 extern const char * const mi_lttng_element_command_disable_rotation
;
87 /* Strings related to version command */
88 extern const char * const mi_lttng_element_version
;
89 extern const char * const mi_lttng_element_version_commit
;
90 extern const char * const mi_lttng_element_version_description
;
91 extern const char * const mi_lttng_element_version_license
;
92 extern const char * const mi_lttng_element_version_major
;
93 extern const char * const mi_lttng_element_version_minor
;
94 extern const char * const mi_lttng_element_version_patch_level
;
95 extern const char * const mi_lttng_element_version_str
;
96 extern const char * const mi_lttng_element_version_web
;
98 /* String related to a lttng_event_field */
99 extern const char * const mi_lttng_element_event_field
;
100 extern const char * const mi_lttng_element_event_fields
;
102 /* String related to lttng_event_perf_counter_ctx */
103 extern const char * const mi_lttng_element_perf_counter_context
;
105 /* Strings related to pid */
106 extern const char * const mi_lttng_element_pid_id
;
108 /* Strings related to save command */
109 extern const char * const mi_lttng_element_save
;
111 /* Strings related to load command */
112 extern const char * const mi_lttng_element_load
;
113 LTTNG_HIDDEN
const char * const mi_lttng_element_load_overrides
;
114 LTTNG_HIDDEN
const char * const mi_lttng_element_load_override_url
;
116 /* General element of mi_lttng */
117 extern const char * const mi_lttng_element_empty
;
118 extern const char * const mi_lttng_element_id
;
119 extern const char * const mi_lttng_element_nowrite
;
120 extern const char * const mi_lttng_element_success
;
121 extern const char * const mi_lttng_element_type_enum
;
122 extern const char * const mi_lttng_element_type_float
;
123 extern const char * const mi_lttng_element_type_integer
;
124 extern const char * const mi_lttng_element_type_other
;
125 extern const char * const mi_lttng_element_type_string
;
127 /* String related to loglevel */
128 extern const char * const mi_lttng_loglevel_str_alert
;
129 extern const char * const mi_lttng_loglevel_str_crit
;
130 extern const char * const mi_lttng_loglevel_str_debug
;
131 extern const char * const mi_lttng_loglevel_str_debug_function
;
132 extern const char * const mi_lttng_loglevel_str_debug_line
;
133 extern const char * const mi_lttng_loglevel_str_debug_module
;
134 extern const char * const mi_lttng_loglevel_str_debug_process
;
135 extern const char * const mi_lttng_loglevel_str_debug_program
;
136 extern const char * const mi_lttng_loglevel_str_debug_system
;
137 extern const char * const mi_lttng_loglevel_str_debug_unit
;
138 extern const char * const mi_lttng_loglevel_str_emerg
;
139 extern const char * const mi_lttng_loglevel_str_err
;
140 extern const char * const mi_lttng_loglevel_str_info
;
141 extern const char * const mi_lttng_loglevel_str_notice
;
142 extern const char * const mi_lttng_loglevel_str_unknown
;
143 extern const char * const mi_lttng_loglevel_str_warning
;
145 /* String related to loglevel JUL */
146 extern const char * const mi_lttng_loglevel_str_jul_all
;
147 extern const char * const mi_lttng_loglevel_str_jul_config
;
148 extern const char * const mi_lttng_loglevel_str_jul_fine
;
149 extern const char * const mi_lttng_loglevel_str_jul_finer
;
150 extern const char * const mi_lttng_loglevel_str_jul_finest
;
151 extern const char * const mi_lttng_loglevel_str_jul_info
;
152 extern const char * const mi_lttng_loglevel_str_jul_off
;
153 extern const char * const mi_lttng_loglevel_str_jul_severe
;
154 extern const char * const mi_lttng_loglevel_str_jul_warning
;
156 /* String related to loglevel Log4j */
157 extern const char * const mi_lttng_loglevel_str_log4j_off
;
158 extern const char * const mi_lttng_loglevel_str_log4j_fatal
;
159 extern const char * const mi_lttng_loglevel_str_log4j_error
;
160 extern const char * const mi_lttng_loglevel_str_log4j_warn
;
161 extern const char * const mi_lttng_loglevel_str_log4j_info
;
162 extern const char * const mi_lttng_loglevel_str_log4j_debug
;
163 extern const char * const mi_lttng_loglevel_str_log4j_trace
;
164 extern const char * const mi_lttng_loglevel_str_log4j_all
;
166 /* String related to loglevel Python */
167 extern const char * const mi_lttng_loglevel_str_python_critical
;
168 extern const char * const mi_lttng_loglevel_str_python_error
;
169 extern const char * const mi_lttng_loglevel_str_python_warning
;
170 extern const char * const mi_lttng_loglevel_str_python_info
;
171 extern const char * const mi_lttng_loglevel_str_python_debug
;
172 extern const char * const mi_lttng_loglevel_str_python_notset
;
174 /* String related to loglevel type */
175 extern const char * const mi_lttng_loglevel_type_all
;
176 extern const char * const mi_lttng_loglevel_type_range
;
177 extern const char * const mi_lttng_loglevel_type_single
;
178 extern const char * const mi_lttng_loglevel_type_unknown
;
180 /* String related to a lttng_snapshot */
181 extern const char * const mi_lttng_element_snapshot_ctrl_url
;
182 extern const char * const mi_lttng_element_snapshot_data_url
;
183 extern const char * const mi_lttng_element_snapshot_max_size
;
184 extern const char * const mi_lttng_element_snapshot_n_ptr
;
185 extern const char * const mi_lttng_element_snapshot_session_name
;
186 extern const char * const mi_lttng_element_snapshots
;
188 /* String related to track/untrack command */
189 const char * const mi_lttng_element_track_untrack_all_wildcard
;
191 LTTNG_HIDDEN
const char * const mi_lttng_element_session_name
;
193 /* String related to rotate command */
194 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation
;
195 LTTNG_HIDDEN
const char * const mi_lttng_element_rotate_status
;
196 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_schedule
;
197 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_schedules
;
198 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_schedule_periodic
;
199 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_schedule_periodic_time_us
;
200 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_schedule_size_threshold
;
201 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_schedule_size_threshold_bytes
;
202 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_schedule_result
;
203 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_schedule_results
;
204 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_state
;
205 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location
;
206 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location_local
;
207 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location_local_absolute_path
;
208 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location_relay
;
209 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location_relay_host
;
210 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location_relay_control_port
;
211 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location_relay_data_port
;
212 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location_relay_protocol
;
213 LTTNG_HIDDEN
const char * const mi_lttng_element_rotation_location_relay_relative_path
;
215 /* String related to enum lttng_rotation_state */
216 LTTNG_HIDDEN
const char * const mi_lttng_rotation_state_str_ongoing
;
217 LTTNG_HIDDEN
const char * const mi_lttng_rotation_state_str_completed
;
218 LTTNG_HIDDEN
const char * const mi_lttng_rotation_state_str_expired
;
219 LTTNG_HIDDEN
const char * const mi_lttng_rotation_state_str_error
;
221 /* String related to enum lttng_trace_archive_location_relay_protocol_type */
222 LTTNG_HIDDEN
const char * const mi_lttng_rotation_location_relay_protocol_str_tcp
;
224 /* String related to add-context command */
225 LTTNG_HIDDEN
extern const char * const mi_lttng_element_context_symbol
;
227 /* Utility string function */
228 const char *mi_lttng_loglevel_string(int value
, enum lttng_domain_type domain
);
229 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value
);
230 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type value
);
231 const char *mi_lttng_domaintype_string(enum lttng_domain_type value
);
232 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value
);
233 const char *mi_lttng_rotation_state_string(enum lttng_rotation_state value
);
234 const char *mi_lttng_trace_archive_location_relay_protocol_type_string(
235 enum lttng_trace_archive_location_relay_protocol_type value
);
238 * Create an instance of a machine interface writer.
240 * fd_output File to which the XML content must be written. The file will be
241 * closed once the mi_writer has been destroyed.
243 * Returns an instance of a machine interface writer on success, NULL on
246 struct mi_writer
*mi_lttng_writer_create(int fd_output
, int mi_output_type
);
249 * Destroy an instance of a machine interface writer.
251 * writer An instance of a machine interface writer.
253 * Returns zero if the XML document could be closed cleanly. Negative values
256 int mi_lttng_writer_destroy(struct mi_writer
*writer
);
259 * Open a command tag and add it's name node.
261 * writer An instance of a machine interface writer.
262 * command The command name.
264 * Returns zero if the XML document could be closed cleanly.
265 * Negative values indicate an error.
267 int mi_lttng_writer_command_open(struct mi_writer
*writer
, const char *command
);
270 * Close a command tag.
272 * writer An instance of a machine interface writer.
274 * Returns zero if the XML document could be closed cleanly.
275 * Negative values indicate an error.
277 int mi_lttng_writer_command_close(struct mi_writer
*writer
);
280 * Open an element tag.
282 * writer An instance of a machine interface writer.
283 * element_name Element tag name.
285 * Returns zero if the XML document could be closed cleanly.
286 * Negative values indicate an error.
288 int mi_lttng_writer_open_element(struct mi_writer
*writer
,
289 const char *element_name
);
292 * Close the current element tag.
294 * writer An instance of a machine interface writer.
296 * Returns zero if the XML document could be closed cleanly.
297 * Negative values indicate an error.
299 int mi_lttng_writer_close_element(struct mi_writer
*writer
);
302 * Close multiple element.
304 * writer An instance of a machine interface writer.
305 * nb_element Number of elements.
307 * Returns zero if the XML document could be closed cleanly.
308 * Negative values indicate an error.
310 int mi_lttng_close_multi_element(struct mi_writer
*writer
,
311 unsigned int nb_element
);
314 * Write an element of type unsigned int.
316 * writer An instance of a machine interface writer.
317 * element_name Element name.
318 * value Unsigned int value of the element
320 * Returns zero if the element's value could be written.
321 * Negative values indicate an error.
323 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer
*writer
,
324 const char *element_name
, uint64_t value
);
327 * Write an element of type signed int.
329 * writer An instance of a machine interface writer.
330 * element_name Element name.
331 * value Signed int value of the element.
333 * Returns zero if the element's value could be written.
334 * Negative values indicate an error.
336 int mi_lttng_writer_write_element_signed_int(struct mi_writer
*writer
,
337 const char *element_name
, int64_t value
);
340 * Write an element of type boolean.
342 * writer An instance of a machine interface writer.
343 * element_name Element name.
344 * value Boolean value of the element.
346 * Returns zero if the element's value could be written.
347 * Negative values indicate an error.
349 int mi_lttng_writer_write_element_bool(struct mi_writer
*writer
,
350 const char *element_name
, int value
);
353 * Write an element of type string.
355 * writer An instance of a machine interface writer.
356 * element_name Element name.
357 * value String value of the element.
359 * Returns zero if the element's value could be written.
360 * Negative values indicate an error.
362 int mi_lttng_writer_write_element_string(struct mi_writer
*writer
,
363 const char *element_name
, const char *value
);
366 * Machine interface of struct version.
368 * writer An instance of a machine interface writer.
369 * version Version struct.
370 * lttng_description String value of the version description.
371 * lttng_license String value of the version license.
373 * Returns zero if the element's value could be written.
374 * Negative values indicate an error.
376 int mi_lttng_version(struct mi_writer
*writer
, struct mi_lttng_version
*version
,
377 const char *lttng_description
, const char *lttng_license
);
380 * Machine interface: open a sessions element.
382 * writer An instance of a machine interface writer.
384 * Returns zero if the element's value could be written.
385 * Negative values indicate an error.
387 int mi_lttng_sessions_open(struct mi_writer
*writer
);
390 * Machine interface of struct session.
392 * writer An instance of a machine interface writer.
393 * session An instance of a session.
394 * is_open Defines whether or not the session element shall be closed.
395 * This should be used carefully and the client
396 * must close the session element.
397 * Use case: nested additional information on a session
398 * ex: domain,channel event.
400 * Returns zero if the element's value could be written.
401 * Negative values indicate an error.
403 int mi_lttng_session(struct mi_writer
*writer
,
404 struct lttng_session
*session
, int is_open
);
407 * Machine interface: open a domains element.
409 * writer An instance of a machine interface writer.
411 * Returns zero if the element's value could be written.
412 * Negative values indicate an error.
414 int mi_lttng_domains_open(struct mi_writer
*writer
);
417 * Machine interface of struct domain.
419 * writer An instance of a machine interface writer.
420 * domain An instance of a domain.
422 * is_open Defines whether or not the session element shall be closed.
423 * This should be used carefully and the client
424 * must close the domain element.
425 * Use case: nested addition information on a domain
428 * Returns zero if the element's value could be written.
429 * Negative values indicate an error.
431 int mi_lttng_domain(struct mi_writer
*writer
,
432 struct lttng_domain
*domain
, int is_open
);
435 * Machine interface: open a channels element.
437 * writer An instance of a machine interface writer.
439 * Returns zero if the element's value could be written.
440 * Negative values indicate an error.
442 int mi_lttng_channels_open(struct mi_writer
*writer
);
445 * Machine interface of struct channel.
447 * writer An instance of a machine interface writer.
448 * channel An instance of a channel.
450 * is_open Defines whether or not the session element shall be closed.
451 * This should be used carefully and the client
452 * must close the channel element.
453 * Use case: nested addition information on a channel.
456 * Returns zero if the element's value could be written.
457 * Negative values indicate an error.
459 int mi_lttng_channel(struct mi_writer
*writer
,
460 struct lttng_channel
*channel
, int is_open
);
463 * Machine interface of struct channel_attr.
465 * writer An instance of a machine interface writer.
466 * attr An instance of a channel_attr struct.
468 * Returns zero if the element's value could be written.
469 * Negative values indicate an error.
471 int mi_lttng_channel_attr(struct mi_writer
*writer
,
472 struct lttng_channel_attr
*attr
);
475 * Machine interface for event common attributes.
477 * writer An instance of a mi writer.
478 * event single trace event.
480 * The common attribute are:
487 * Returns zero if the element's value could be written.
488 * Negative values indicate an error.
490 int mi_lttng_event_common_attributes(struct mi_writer
*writer
,
491 struct lttng_event
*event
);
494 * Machine interface for kernel tracepoint event with a loglevel.
496 * writer An instance of a mi writer.
497 * event single trace event.
498 * domain Event's domain
500 * Returns zero if the element's value could be written.
501 * Negative values indicate an error.
503 int mi_lttng_event_tracepoint_loglevel(struct mi_writer
*writer
,
504 struct lttng_event
*event
, enum lttng_domain_type domain
);
507 * Machine interface for kernel tracepoint event with no loglevel.
509 * writer An instance of a mi writer.
510 * event single trace event.
512 * Returns zero if the element's value could be written.
513 * Negative values indicate an error.
515 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer
*writer
,
516 struct lttng_event
*event
);
519 * Machine interface for kernel function and probe event.
521 * writer An instance of a mi writer.
522 * event single trace event.
524 * Returns zero if the element's value could be written.
525 * Negative values indicate an error.
527 int mi_lttng_event_function_probe(struct mi_writer
*writer
,
528 struct lttng_event
*event
);
531 * Machine interface for kernel function entry event.
533 * writer An instance of a mi writer.
534 * event single trace event.
536 * Returns zero if the element's value could be written.
537 * Negative values indicate an error.
539 int mi_lttng_event_function_entry(struct mi_writer
*writer
,
540 struct lttng_event
*event
);
543 * Machine interface: open an events element.
545 * writer An instance of a machine interface writer.
547 * Returns zero if the element's value could be written.
548 * Negative values indicate an error.
550 int mi_lttng_events_open(struct mi_writer
*writer
);
553 * Machine interface for printing an event.
554 * The trace event type currently supported are:
561 * writer An instance of a mi writer.
562 * event single trace event.
563 * is_open Defines whether or not the session element shall be closed.
564 * This should be used carefully and the client
565 * must close the event element.
566 * Use case: nested additional information
567 * domain Event's domain
569 * Returns zero if the element's value could be written.
570 * Negative values indicate an error.
572 int mi_lttng_event(struct mi_writer
*writer
, struct lttng_event
*event
,
573 int is_open
, enum lttng_domain_type domain
);
576 * Machine interface for struct lttng_event_field.
578 * writer An instance of a mi writer.
579 * field An event_field instance.
581 * Returns zero if the element's value could be written.
582 * Negative values indicate an error.
584 int mi_lttng_event_field(struct mi_writer
*writer
,
585 struct lttng_event_field
*field
);
588 * Machine interface: open a event_fields element.
590 * writer An instance of a machine interface writer.
592 * Returns zero if the element have be written.
593 * Negative values indicate an error.
595 int mi_lttng_event_fields_open(struct mi_writer
*writer
);
598 * Machine interface: open a trackers element.
600 * writer An instance of a machine interface writer.
602 * Returns zero if the element's value could be written.
603 * Negative values indicate an error.
605 int mi_lttng_trackers_open(struct mi_writer
*writer
);
608 * Machine interface: open a pid_tracker element.
610 * writer An instance of a machine interface writer.
612 * Returns zero if the element's value could be written.
613 * Negative values indicate an error.
615 * Note: A targets element is also opened for each tracker definition
617 int mi_lttng_pid_tracker_open(struct mi_writer
*writer
);
620 * Machine interface: open a PIDs element.
622 * writer An instance of a machine interface writer.
624 * Returns zero if the element's value could be written.
625 * Negative values indicate an error.
627 int mi_lttng_pids_open(struct mi_writer
*writer
);
630 * Machine interface: open a processes element.
632 * writer An instance of a machine interface writer.
634 * Returns zero if the element's value could be written.
635 * Negative values indicate an error.
637 int mi_lttng_processes_open(struct mi_writer
*writer
);
640 * Machine interface of a Process.
642 * writer An instance of a machine interface writer.
645 * is_open Defines whether or not the session element shall be closed.
646 * This should be used carefully and the client
647 * must close the pid element.
648 * Use case: nested addition information on a domain
651 * Returns zero if the element's value could be written.
652 * Negative values indicate an error.
654 int mi_lttng_process(struct mi_writer
*writer
, pid_t pid
, const char *name
,
658 * TODO: move pid of lttng list -u to process semantic on mi api bump
659 * Machine interface of a Process.
661 * writer An instance of a machine interface writer.
664 * is_open Defines whether or not the session element shall be closed.
665 * This should be used carefully and the client
666 * must close the pid element.
667 * Use case: nested addition information on a domain
670 * Returns zero if the element's value could be written.
671 * Negative values indicate an error.
673 int mi_lttng_pid(struct mi_writer
*writer
, pid_t pid
, const char *name
,
676 * Machine interface: open a targets element.
678 * writer An instance of a machine interface writer.
680 * Returns zero if the element's value could be written.
681 * Negative values indicate an error.
683 int mi_lttng_targets_open(struct mi_writer
*writer
);
686 * Machine interface for track/untrack a pid_target
688 * writer An instance of a machine interface writer.
690 * Returns zero if the element's value could be written.
691 * Negative values indicate an error.
693 int mi_lttng_pid_target(struct mi_writer
*writer
, pid_t pid
, int is_open
);
696 * Machine interface of a context.
698 * writer An instance of a machine interface writer
700 * context An instance of a lttng_event_context
702 * is_open Define if we close the context element
703 * This should be used carefully and the client
704 * need to close the context element.
705 * Returns zero if the element's value could be written.
706 * Negative values indicate an error.
708 int mi_lttng_context(struct mi_writer
*writer
,
709 struct lttng_event_context
*context
, int is_open
);
712 * Machine interface of a perf_counter_context.
714 * writer An instance of a machine interface writer
716 * contest An instance of a lttng_event_perf_counter_ctx
718 * Returns zero if the element's value could be written.
719 * Negative values indicate an error.
721 int mi_lttng_perf_counter_context(struct mi_writer
*writer
,
722 struct lttng_event_perf_counter_ctx
*perf_context
);
725 * Machine interface of the snapshot list_output.
726 * It specifies the session for which we are listing snapshots,
727 * and it opens a snapshots element to list a sequence
730 * writer An instance of a machine interface writer.
732 * session_name: Snapshot output for session "session_name".
734 * Note: The client has to close the session and the snapshots elements after
735 * having listed every lttng_snapshot_output.
737 * Returns zero if the element's value could be written.
738 * Negative values indicate an error.
740 int mi_lttng_snapshot_output_session_name(struct mi_writer
*writer
,
741 const char *session_name
);
744 * Machine interface of the snapshot output.
745 * The machine interface serializes the following attributes:
746 * - id: ID of the snapshot output.
747 * - name: Name of the output.
748 * - data_url : Destination of the output.
749 * - ctrl_url: Destination of the output.
750 * - max_size: total size of all stream combined.
752 * writer An instance of a machine interface writer.
754 * output: A list of snapshot_output.
756 * Returns zero if the element's value could be written.
757 * Negative values indicate an error.
759 int mi_lttng_snapshot_list_output(struct mi_writer
*writer
,
760 struct lttng_snapshot_output
*output
);
763 * Machine interface of the output of the command snapshot del output
764 * when deleting a snapshot either by id or by name.
765 * If the snapshot was found and successfully deleted using its id,
766 * it return the id of the snapshot and the current session name on which it
769 * Otherwise, it do the same process with the name of the snapshot, if the
770 * snapshot output id is undefined.
772 * writer An instance of a machine interface writer.
774 * id: ID of the snapshot output.
776 * name: Name of the snapshot.
778 * current_session_name: Session to which the snapshot belongs.
780 * Returns zero if the element's value could be written.
781 * Negative values indicate an error.
783 int mi_lttng_snapshot_del_output(struct mi_writer
*writer
, int id
,
784 const char *name
, const char *current_session_name
);
787 * Machine interface of the output of the command snapshot add output
788 * when adding a snapshot from a user URL.
790 * If the snapshot was successfully added, the machine interface lists
792 * - id: ID of the newly add snapshot output.
793 * - current_session_name: Name of the session to which the output was added.
794 * - ctrl_url: Destination of the output.
795 * - max_size: total size of all stream combined.
797 * writer An instance of a machine interface writer.
799 * current_session_name: Session to which the snapshot belongs.
803 * output: iterator over a lttng_snapshot_output_list which contain
804 * the snapshot output informations.
806 * Returns zero if the element's value could be written.
807 * Negative values indicate an error.
809 int mi_lttng_snapshot_add_output(struct mi_writer
*writer
,
810 const char *current_session_name
, const char *n_ptr
,
811 struct lttng_snapshot_output
*output
);
814 * Machine interface of the output of the command snapshot
815 * record from a URL (if given).
817 * If the snapshot is successfully recorded from a url, the machine interface
818 * output the following information:
819 * - url: Destination of the output stored in the snapshot.
821 * Otherwise, the machine interface output the data and ctrl url received
822 * from the command-line.
824 * writer An instance of a machine interface writer.
826 * current_session_name: Snapshot record for session "current_session_name".
828 * ctrl_url, data_url: Destination of the output receive from the command-line.
830 * Returns zero if the element's value could be written.
831 * Negative values indicate an error.
833 int mi_lttng_snapshot_record(struct mi_writer
*writer
,
834 const char *current_session_name
, const char *url
,
835 const char *cmdline_ctrl_url
, const char *cmdline_data_url
);
838 * Machine interface representation of a session rotation schedule.
840 * The machine interface serializes the provided schedule as one of the choices
841 * from 'rotation_schedule_type'.
843 * writer: An instance of a machine interface writer.
845 * schedule: An lttng rotation schedule descriptor object.
847 * Returns zero if the element's value could be written.
848 * Negative values indicate an error.
850 int mi_lttng_rotation_schedule(struct mi_writer
*writer
,
851 const struct lttng_rotation_schedule
*schedule
);
854 * Machine interface of a session rotation schedule result.
855 * This is an element that is part of the output of the enable-rotation and
856 * disable-rotation commands.
858 * The machine interface provides the following information:
859 * - schedule: the session rotation schedule descriptor.
860 * - success: whether the sub-command succeeded.
862 * writer: An instance of a machine interface writer.
864 * schedule: An lttng rotation schedule descriptor object.
866 * success: Whether the sub-command suceeded.
868 * Returns zero if the element's value could be written.
869 * Negative values indicate an error.
871 int mi_lttng_rotation_schedule_result(struct mi_writer
*writer
,
872 const struct lttng_rotation_schedule
*schedule
,
876 * Machine interface of a session rotation result.
877 * This is an element that is part of the output of the rotate command.
879 * The machine interface provides the following information:
880 * - session_name: the session to be rotated.
881 * - state: the session rotation state.
882 * - location: the location of the completed chunk archive.
884 * writer: An instance of a machine interface writer.
886 * session_name: The session to which the rotate command applies.
888 * location: A location descriptor object.
890 * success: Whether the sub-command suceeded.
892 * Returns zero if the element's value could be written.
893 * Negative values indicate an error.
895 int mi_lttng_rotate(struct mi_writer
*writer
,
896 const char *session_name
,
897 enum lttng_rotation_state rotation_state
,
898 const struct lttng_trace_archive_location
*location
);
900 #endif /* _MI_LTTNG_H */