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.
21 #include <common/config/session-config.h>
22 #include <common/defaults.h>
23 #include <lttng/snapshot-internal.h>
28 #define MI_SCHEMA_MAJOR_VERSION 3
29 #define MI_SCHEMA_MINOR_VERSION 0
31 /* Machine interface namespace URI */
32 const char * const mi_lttng_xmlns
= "xmlns";
33 const char * const mi_lttng_xmlns_xsi
= "xmlns:xsi";
34 const char * const mi_lttng_w3_schema_uri
= "http://www.w3.org/2001/XMLSchema-instance";
35 const char * const mi_lttng_schema_location
= "xsi:schemaLocation";
36 const char * const mi_lttng_schema_location_uri
=
37 DEFAULT_LTTNG_MI_NAMESPACE
" "
38 "http://lttng.org/xml/schemas/lttng-mi/" XSTR(MI_SCHEMA_MAJOR_VERSION
)
39 "/lttng-mi-" XSTR(MI_SCHEMA_MAJOR_VERSION
) "."
40 XSTR(MI_SCHEMA_MINOR_VERSION
) ".xsd";
41 const char * const mi_lttng_schema_version
= "schemaVersion";
42 const char * const mi_lttng_schema_version_value
= XSTR(MI_SCHEMA_MAJOR_VERSION
)
43 "." XSTR(MI_SCHEMA_MINOR_VERSION
);
45 /* Strings related to command */
46 const char * const mi_lttng_element_command
= "command";
47 const char * const mi_lttng_element_command_action
= "snapshot_action";
48 const char * const mi_lttng_element_command_add_context
= "add-context";
49 const char * const mi_lttng_element_command_calibrate
= "calibrate";
50 const char * const mi_lttng_element_command_create
= "create";
51 const char * const mi_lttng_element_command_destroy
= "destroy";
52 const char * const mi_lttng_element_command_disable_channel
= "disable-channel";
53 const char * const mi_lttng_element_command_disable_event
= "disable-event";
54 const char * const mi_lttng_element_command_enable_channels
= "enable-channel";
55 const char * const mi_lttng_element_command_enable_event
= "enable-event";
56 const char * const mi_lttng_element_command_list
= "list";
57 const char * const mi_lttng_element_command_load
= "load";
58 const char * const mi_lttng_element_command_name
= "name";
59 const char * const mi_lttng_element_command_output
= "output";
60 const char * const mi_lttng_element_command_save
= "save";
61 const char * const mi_lttng_element_command_set_session
= "set-session";
62 const char * const mi_lttng_element_command_snapshot
= "snapshot";
63 const char * const mi_lttng_element_command_snapshot_add
= "add_snapshot";
64 const char * const mi_lttng_element_command_snapshot_del
= "del_snapshot";
65 const char * const mi_lttng_element_command_snapshot_list
= "list_snapshot";
66 const char * const mi_lttng_element_command_snapshot_record
= "record_snapshot";
67 const char * const mi_lttng_element_command_start
= "start";
68 const char * const mi_lttng_element_command_stop
= "stop";
69 const char * const mi_lttng_element_command_success
= "success";
70 const char * const mi_lttng_element_command_track
= "track";
71 const char * const mi_lttng_element_command_untrack
= "untrack";
72 const char * const mi_lttng_element_command_version
= "version";
74 /* Strings related to version command */
75 const char * const mi_lttng_element_version
= "version";
76 const char * const mi_lttng_element_version_commit
= "commit";
77 const char * const mi_lttng_element_version_description
= "description";
78 const char * const mi_lttng_element_version_license
= "license";
79 const char * const mi_lttng_element_version_major
= "major";
80 const char * const mi_lttng_element_version_minor
= "minor";
81 const char * const mi_lttng_element_version_patch_level
= "patchLevel";
82 const char * const mi_lttng_element_version_str
= "string";
83 const char * const mi_lttng_element_version_web
= "url";
85 /* String related to a lttng_event_field */
86 const char * const mi_lttng_element_event_field
= "event_field";
87 const char * const mi_lttng_element_event_fields
= "event_fields";
89 /* String related to lttng_event_perf_counter_ctx */
90 const char * const mi_lttng_element_perf_counter_context
= "perf";
92 /* Strings related to pid */
93 const char * const mi_lttng_element_pid_id
= "id";
95 /* Strings related to save command */
96 const char * const mi_lttng_element_save
= "save";
98 /* Strings related to load command */
99 const char * const mi_lttng_element_load
= "load";
101 /* General elements of mi_lttng */
102 const char * const mi_lttng_element_empty
= "";
103 const char * const mi_lttng_element_id
= "id";
104 const char * const mi_lttng_element_nowrite
= "nowrite";
105 const char * const mi_lttng_element_success
= "success";
106 const char * const mi_lttng_element_type_enum
= "ENUM";
107 const char * const mi_lttng_element_type_float
= "FLOAT";
108 const char * const mi_lttng_element_type_integer
= "INTEGER";
109 const char * const mi_lttng_element_type_other
= "OTHER";
110 const char * const mi_lttng_element_type_string
= "STRING";
112 /* String related to loglevel */
113 const char * const mi_lttng_loglevel_str_alert
= "TRACE_ALERT";
114 const char * const mi_lttng_loglevel_str_crit
= "TRACE_CRIT";
115 const char * const mi_lttng_loglevel_str_debug
= "TRACE_DEBUG";
116 const char * const mi_lttng_loglevel_str_debug_function
= "TRACE_DEBUG_FUNCTION";
117 const char * const mi_lttng_loglevel_str_debug_line
= "TRACE_DEBUG_LINE";
118 const char * const mi_lttng_loglevel_str_debug_module
= "TRACE_DEBUG_MODULE";
119 const char * const mi_lttng_loglevel_str_debug_process
= "TRACE_DEBUG_PROCESS";
120 const char * const mi_lttng_loglevel_str_debug_program
= "TRACE_DEBUG_PROGRAM";
121 const char * const mi_lttng_loglevel_str_debug_system
= "TRACE_DEBUG_SYSTEM";
122 const char * const mi_lttng_loglevel_str_debug_unit
= "TRACE_DEBUG_UNIT";
123 const char * const mi_lttng_loglevel_str_emerg
= "TRACE_EMERG";
124 const char * const mi_lttng_loglevel_str_err
= "TRACE_ERR";
125 const char * const mi_lttng_loglevel_str_info
= "TRACE_INFO";
126 const char * const mi_lttng_loglevel_str_notice
= "TRACE_NOTICE";
127 const char * const mi_lttng_loglevel_str_unknown
= "UNKNOWN";
128 const char * const mi_lttng_loglevel_str_warning
= "TRACE_WARNING";
130 /* String related to loglevel JUL */
131 const char * const mi_lttng_loglevel_str_jul_all
= "JUL_ALL";
132 const char * const mi_lttng_loglevel_str_jul_config
= "JUL_CONFIG";
133 const char * const mi_lttng_loglevel_str_jul_fine
= "JUL_FINE";
134 const char * const mi_lttng_loglevel_str_jul_finer
= "JUL_FINER";
135 const char * const mi_lttng_loglevel_str_jul_finest
= "JUL_FINEST";
136 const char * const mi_lttng_loglevel_str_jul_info
= "JUL_INFO";
137 const char * const mi_lttng_loglevel_str_jul_off
= "JUL_OFF";
138 const char * const mi_lttng_loglevel_str_jul_severe
= "JUL_SEVERE";
139 const char * const mi_lttng_loglevel_str_jul_warning
= "JUL_WARNING";
141 /* String related to loglevel LOG4J */
142 const char * const mi_lttng_loglevel_str_log4j_off
= "LOG4J_OFF";
143 const char * const mi_lttng_loglevel_str_log4j_fatal
= "LOG4J_FATAL";
144 const char * const mi_lttng_loglevel_str_log4j_error
= "LOG4J_ERROR";
145 const char * const mi_lttng_loglevel_str_log4j_warn
= "LOG4J_WARN";
146 const char * const mi_lttng_loglevel_str_log4j_info
= "LOG4J_INFO";
147 const char * const mi_lttng_loglevel_str_log4j_debug
= "LOG4J_DEBUG";
148 const char * const mi_lttng_loglevel_str_log4j_trace
= "LOG4J_TRACE";
149 const char * const mi_lttng_loglevel_str_log4j_all
= "LOG4J_ALL";
151 /* String related to loglevel Python */
152 const char * const mi_lttng_loglevel_str_python_critical
= "PYTHON_CRITICAL";
153 const char * const mi_lttng_loglevel_str_python_error
= "PYTHON_ERROR";
154 const char * const mi_lttng_loglevel_str_python_warning
= "PYTHON_WARNING";
155 const char * const mi_lttng_loglevel_str_python_info
= "PYTHON_INFO";
156 const char * const mi_lttng_loglevel_str_python_debug
= "PYTHON_DEBUG";
157 const char * const mi_lttng_loglevel_str_python_notset
= "PYTHON_NOTSET";
159 /* String related to loglevel type */
160 const char * const mi_lttng_loglevel_type_all
= "ALL";
161 const char * const mi_lttng_loglevel_type_range
= "RANGE";
162 const char * const mi_lttng_loglevel_type_single
= "SINGLE";
163 const char * const mi_lttng_loglevel_type_unknown
= "UNKNOWN";
165 /* String related to lttng_calibrate */
166 const char * const mi_lttng_element_calibrate
= "calibrate";
167 const char * const mi_lttng_element_calibrate_function
= "FUNCTION";
169 /* String related to a lttng_snapshot_output */
170 const char * const mi_lttng_element_snapshot_ctrl_url
= "ctrl_url";
171 const char * const mi_lttng_element_snapshot_data_url
= "data_url";
172 const char * const mi_lttng_element_snapshot_max_size
= "max_size";
173 const char * const mi_lttng_element_snapshot_n_ptr
= "n_ptr";
174 const char * const mi_lttng_element_snapshot_session_name
= "session_name";
175 const char * const mi_lttng_element_snapshots
= "snapshots";
177 /* String related to track/untrack command */
178 const char * const mi_lttng_element_track_untrack_all_wildcard
= "*";
181 /* This is a merge of jul loglevel and regular loglevel
182 * Those should never overlap by definition
183 * (see struct lttng_event loglevel)
186 const char *mi_lttng_loglevel_string(int value
, enum lttng_domain_type domain
)
189 case LTTNG_DOMAIN_KERNEL
:
190 case LTTNG_DOMAIN_UST
:
193 return mi_lttng_element_empty
;
194 case LTTNG_LOGLEVEL_EMERG
:
195 return mi_lttng_loglevel_str_emerg
;
196 case LTTNG_LOGLEVEL_ALERT
:
197 return mi_lttng_loglevel_str_alert
;
198 case LTTNG_LOGLEVEL_CRIT
:
199 return mi_lttng_loglevel_str_crit
;
200 case LTTNG_LOGLEVEL_ERR
:
201 return mi_lttng_loglevel_str_err
;
202 case LTTNG_LOGLEVEL_WARNING
:
203 return mi_lttng_loglevel_str_warning
;
204 case LTTNG_LOGLEVEL_NOTICE
:
205 return mi_lttng_loglevel_str_notice
;
206 case LTTNG_LOGLEVEL_INFO
:
207 return mi_lttng_loglevel_str_info
;
208 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
209 return mi_lttng_loglevel_str_debug_system
;
210 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
211 return mi_lttng_loglevel_str_debug_program
;
212 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
213 return mi_lttng_loglevel_str_debug_process
;
214 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
215 return mi_lttng_loglevel_str_debug_module
;
216 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
217 return mi_lttng_loglevel_str_debug_unit
;
218 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
219 return mi_lttng_loglevel_str_debug_function
;
220 case LTTNG_LOGLEVEL_DEBUG_LINE
:
221 return mi_lttng_loglevel_str_debug_line
;
222 case LTTNG_LOGLEVEL_DEBUG
:
223 return mi_lttng_loglevel_str_debug
;
225 return mi_lttng_loglevel_str_unknown
;
228 case LTTNG_DOMAIN_LOG4J
:
231 return mi_lttng_element_empty
;
232 case LTTNG_LOGLEVEL_LOG4J_OFF
:
233 return mi_lttng_loglevel_str_log4j_off
;
234 case LTTNG_LOGLEVEL_LOG4J_FATAL
:
235 return mi_lttng_loglevel_str_log4j_fatal
;
236 case LTTNG_LOGLEVEL_LOG4J_ERROR
:
237 return mi_lttng_loglevel_str_log4j_error
;
238 case LTTNG_LOGLEVEL_LOG4J_WARN
:
239 return mi_lttng_loglevel_str_log4j_warn
;
240 case LTTNG_LOGLEVEL_LOG4J_INFO
:
241 return mi_lttng_loglevel_str_log4j_info
;
242 case LTTNG_LOGLEVEL_LOG4J_DEBUG
:
243 return mi_lttng_loglevel_str_log4j_debug
;
244 case LTTNG_LOGLEVEL_LOG4J_TRACE
:
245 return mi_lttng_loglevel_str_log4j_trace
;
246 case LTTNG_LOGLEVEL_LOG4J_ALL
:
247 return mi_lttng_loglevel_str_log4j_all
;
249 return mi_lttng_loglevel_str_unknown
;
252 case LTTNG_DOMAIN_JUL
:
255 return mi_lttng_element_empty
;
256 case LTTNG_LOGLEVEL_JUL_OFF
:
257 return mi_lttng_loglevel_str_jul_off
;
258 case LTTNG_LOGLEVEL_JUL_SEVERE
:
259 return mi_lttng_loglevel_str_jul_severe
;
260 case LTTNG_LOGLEVEL_JUL_WARNING
:
261 return mi_lttng_loglevel_str_jul_warning
;
262 case LTTNG_LOGLEVEL_JUL_INFO
:
263 return mi_lttng_loglevel_str_jul_info
;
264 case LTTNG_LOGLEVEL_JUL_CONFIG
:
265 return mi_lttng_loglevel_str_jul_config
;
266 case LTTNG_LOGLEVEL_JUL_FINE
:
267 return mi_lttng_loglevel_str_jul_fine
;
268 case LTTNG_LOGLEVEL_JUL_FINER
:
269 return mi_lttng_loglevel_str_jul_finer
;
270 case LTTNG_LOGLEVEL_JUL_FINEST
:
271 return mi_lttng_loglevel_str_jul_finest
;
272 case LTTNG_LOGLEVEL_JUL_ALL
:
273 return mi_lttng_loglevel_str_jul_all
;
275 return mi_lttng_loglevel_str_unknown
;
278 case LTTNG_DOMAIN_PYTHON
:
280 case LTTNG_LOGLEVEL_PYTHON_CRITICAL
:
281 return mi_lttng_loglevel_str_python_critical
;
282 case LTTNG_LOGLEVEL_PYTHON_ERROR
:
283 return mi_lttng_loglevel_str_python_error
;
284 case LTTNG_LOGLEVEL_PYTHON_WARNING
:
285 return mi_lttng_loglevel_str_python_warning
;
286 case LTTNG_LOGLEVEL_PYTHON_INFO
:
287 return mi_lttng_loglevel_str_python_info
;
288 case LTTNG_LOGLEVEL_PYTHON_DEBUG
:
289 return mi_lttng_loglevel_str_python_debug
;
290 case LTTNG_LOGLEVEL_PYTHON_NOTSET
:
291 return mi_lttng_loglevel_str_python_notset
;
293 return mi_lttng_loglevel_str_unknown
;
298 /* Reaching this means the domain is unknown. */
299 return mi_lttng_loglevel_str_unknown
;
303 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value
)
306 case LTTNG_EVENT_LOGLEVEL_ALL
:
307 return mi_lttng_loglevel_type_all
;
308 case LTTNG_EVENT_LOGLEVEL_RANGE
:
309 return mi_lttng_loglevel_type_range
;
310 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
311 return mi_lttng_loglevel_type_single
;
313 return mi_lttng_loglevel_type_unknown
;
318 const char *mi_lttng_eventtype_string(enum lttng_event_type value
)
321 case LTTNG_EVENT_ALL
:
322 return config_event_type_all
;
323 case LTTNG_EVENT_TRACEPOINT
:
324 return config_event_type_tracepoint
;
325 case LTTNG_EVENT_PROBE
:
326 return config_event_type_probe
;
327 case LTTNG_EVENT_FUNCTION
:
328 return config_event_type_function
;
329 case LTTNG_EVENT_FUNCTION_ENTRY
:
330 return config_event_type_function_entry
;
331 case LTTNG_EVENT_SYSCALL
:
332 return config_event_type_syscall
;
333 case LTTNG_EVENT_NOOP
:
334 return config_event_type_noop
;
336 return mi_lttng_element_empty
;
341 const char *mi_lttng_event_contexttype_string(enum lttng_event_context_type val
)
344 case LTTNG_EVENT_CONTEXT_PID
:
345 return config_event_context_pid
;
346 case LTTNG_EVENT_CONTEXT_PROCNAME
:
347 return config_event_context_procname
;
348 case LTTNG_EVENT_CONTEXT_PRIO
:
349 return config_event_context_prio
;
350 case LTTNG_EVENT_CONTEXT_NICE
:
351 return config_event_context_nice
;
352 case LTTNG_EVENT_CONTEXT_VPID
:
353 return config_event_context_vpid
;
354 case LTTNG_EVENT_CONTEXT_TID
:
355 return config_event_context_tid
;
356 case LTTNG_EVENT_CONTEXT_VTID
:
357 return config_event_context_vtid
;
358 case LTTNG_EVENT_CONTEXT_PPID
:
359 return config_event_context_ppid
;
360 case LTTNG_EVENT_CONTEXT_VPPID
:
361 return config_event_context_vppid
;
362 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
363 return config_event_context_pthread_id
;
364 case LTTNG_EVENT_CONTEXT_HOSTNAME
:
365 return config_event_context_hostname
;
366 case LTTNG_EVENT_CONTEXT_IP
:
367 return config_event_context_ip
;
374 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val
)
377 case(LTTNG_EVENT_FIELD_INTEGER
):
378 return mi_lttng_element_type_integer
;
379 case(LTTNG_EVENT_FIELD_ENUM
):
380 return mi_lttng_element_type_enum
;
381 case(LTTNG_EVENT_FIELD_FLOAT
):
382 return mi_lttng_element_type_float
;
383 case(LTTNG_EVENT_FIELD_STRING
):
384 return mi_lttng_element_type_string
;
386 return mi_lttng_element_type_other
;
391 const char *mi_lttng_domaintype_string(enum lttng_domain_type value
)
393 /* Note: This is a *duplicate* of get_domain_str from bin/lttng/utils.c */
395 case LTTNG_DOMAIN_KERNEL
:
396 return config_domain_type_kernel
;
397 case LTTNG_DOMAIN_UST
:
398 return config_domain_type_ust
;
399 case LTTNG_DOMAIN_JUL
:
400 return config_domain_type_jul
;
401 case LTTNG_DOMAIN_LOG4J
:
402 return config_domain_type_log4j
;
403 case LTTNG_DOMAIN_PYTHON
:
404 return config_domain_type_python
;
406 /* Should not have an unknown domain */
413 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value
)
416 case LTTNG_BUFFER_PER_PID
:
417 return config_buffer_type_per_pid
;
418 case LTTNG_BUFFER_PER_UID
:
419 return config_buffer_type_per_uid
;
420 case LTTNG_BUFFER_GLOBAL
:
421 return config_buffer_type_global
;
423 /* Should not have an unknow buffer type */
430 const char *mi_lttng_calibratetype_string(enum lttng_calibrate_type val
)
435 case LTTNG_CALIBRATE_FUNCTION
:
436 ret
= mi_lttng_element_calibrate_function
;
439 ret
= mi_lttng_element_empty
;
446 struct mi_writer
*mi_lttng_writer_create(int fd_output
, int mi_output_type
)
448 struct mi_writer
*mi_writer
;
450 mi_writer
= zmalloc(sizeof(struct mi_writer
));
452 PERROR("zmalloc mi_writer_create");
455 if (mi_output_type
== LTTNG_MI_XML
) {
456 mi_writer
->writer
= config_writer_create(fd_output
, 0);
457 if (!mi_writer
->writer
) {
460 mi_writer
->type
= LTTNG_MI_XML
;
474 int mi_lttng_writer_destroy(struct mi_writer
*writer
)
483 ret
= config_writer_destroy(writer
->writer
);
494 int mi_lttng_writer_command_open(struct mi_writer
*writer
, const char *command
)
499 * A command is always the MI's root node, it must declare the current
500 * namespace and schema URIs and the schema's version.
502 ret
= config_writer_open_element(writer
->writer
,
503 mi_lttng_element_command
);
508 ret
= config_writer_write_attribute(writer
->writer
,
509 mi_lttng_xmlns
, DEFAULT_LTTNG_MI_NAMESPACE
);
514 ret
= config_writer_write_attribute(writer
->writer
,
515 mi_lttng_xmlns_xsi
, mi_lttng_w3_schema_uri
);
520 ret
= config_writer_write_attribute(writer
->writer
,
521 mi_lttng_schema_location
,
522 mi_lttng_schema_location_uri
);
527 ret
= config_writer_write_attribute(writer
->writer
,
528 mi_lttng_schema_version
,
529 mi_lttng_schema_version_value
);
534 ret
= mi_lttng_writer_write_element_string(writer
,
535 mi_lttng_element_command_name
, command
);
541 int mi_lttng_writer_command_close(struct mi_writer
*writer
)
543 return mi_lttng_writer_close_element(writer
);
547 int mi_lttng_writer_open_element(struct mi_writer
*writer
,
548 const char *element_name
)
550 return config_writer_open_element(writer
->writer
, element_name
);
554 int mi_lttng_writer_close_element(struct mi_writer
*writer
)
556 return config_writer_close_element(writer
->writer
);
560 int mi_lttng_close_multi_element(struct mi_writer
*writer
,
561 unsigned int nb_element
)
565 if (nb_element
< 1) {
569 for (i
= 0; i
< nb_element
; i
++) {
570 ret
= mi_lttng_writer_close_element(writer
);
580 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer
*writer
,
581 const char *element_name
, uint64_t value
)
583 return config_writer_write_element_unsigned_int(writer
->writer
,
584 element_name
, value
);
588 int mi_lttng_writer_write_element_signed_int(struct mi_writer
*writer
,
589 const char *element_name
, int64_t value
)
591 return config_writer_write_element_signed_int(writer
->writer
,
592 element_name
, value
);
596 int mi_lttng_writer_write_element_bool(struct mi_writer
*writer
,
597 const char *element_name
, int value
)
599 return config_writer_write_element_bool(writer
->writer
,
600 element_name
, value
);
604 int mi_lttng_writer_write_element_string(struct mi_writer
*writer
,
605 const char *element_name
, const char *value
)
607 return config_writer_write_element_string(writer
->writer
,
608 element_name
, value
);
612 int mi_lttng_version(struct mi_writer
*writer
, struct mi_lttng_version
*version
,
613 const char *lttng_description
, const char *lttng_license
)
618 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_version
);
623 /* Version string (contain info like rc etc.) */
624 ret
= mi_lttng_writer_write_element_string(writer
,
625 mi_lttng_element_version_str
, version
->version
);
630 /* Major version number */
631 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
632 mi_lttng_element_version_major
, version
->version_major
);
637 /* Minor version number */
638 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
639 mi_lttng_element_version_minor
, version
->version_minor
);
644 /* Commit version number */
645 ret
= mi_lttng_writer_write_element_string(writer
,
646 mi_lttng_element_version_commit
, version
->version_commit
);
652 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
653 mi_lttng_element_version_patch_level
, version
->version_patchlevel
);
658 /* Name of the version */
659 ret
= mi_lttng_writer_write_element_string(writer
,
660 config_element_name
, version
->version_name
);
665 /* Description mostly related to beer... */
666 ret
= mi_lttng_writer_write_element_string(writer
,
667 mi_lttng_element_version_description
, lttng_description
);
673 ret
= mi_lttng_writer_write_element_string(writer
,
674 mi_lttng_element_version_web
, version
->package_url
);
679 /* License: free as in free beer...no...*speech* */
680 ret
= mi_lttng_writer_write_element_string(writer
,
681 mi_lttng_element_version_license
, lttng_license
);
686 /* Close version element */
687 ret
= mi_lttng_writer_close_element(writer
);
694 int mi_lttng_sessions_open(struct mi_writer
*writer
)
696 return mi_lttng_writer_open_element(writer
, config_element_sessions
);
700 int mi_lttng_session(struct mi_writer
*writer
,
701 struct lttng_session
*session
, int is_open
)
707 /* Open sessions element */
708 ret
= mi_lttng_writer_open_element(writer
,
709 config_element_session
);
714 /* Name of the session */
715 ret
= mi_lttng_writer_write_element_string(writer
,
716 config_element_name
, session
->name
);
722 ret
= mi_lttng_writer_write_element_string(writer
,
723 config_element_path
, session
->path
);
729 ret
= mi_lttng_writer_write_element_bool(writer
,
730 config_element_enabled
, session
->enabled
);
736 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
737 config_element_snapshot_mode
, session
->snapshot_mode
);
742 /* Live timer interval in usec */
743 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
744 config_element_live_timer_interval
,
745 session
->live_timer_interval
);
751 /* Closing session element */
752 ret
= mi_lttng_writer_close_element(writer
);
760 int mi_lttng_domains_open(struct mi_writer
*writer
)
762 return mi_lttng_writer_open_element(writer
, config_element_domains
);
766 int mi_lttng_domain(struct mi_writer
*writer
,
767 struct lttng_domain
*domain
, int is_open
)
770 const char *str_domain
;
771 const char *str_buffer
;
775 /* Open domain element */
776 ret
= mi_lttng_writer_open_element(writer
, config_element_domain
);
782 str_domain
= mi_lttng_domaintype_string(domain
->type
);
783 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
790 str_buffer
= mi_lttng_buffertype_string(domain
->buf_type
);
791 ret
= mi_lttng_writer_write_element_string(writer
,
792 config_element_buffer_type
, str_buffer
);
798 * This union is not currently used and was added for
799 * future ust domain support.
804 /* Closing domain element */
805 ret
= mi_lttng_writer_close_element(writer
);
814 int mi_lttng_channels_open(struct mi_writer
*writer
)
816 return mi_lttng_writer_open_element(writer
, config_element_channels
);
820 int mi_lttng_channel(struct mi_writer
*writer
,
821 struct lttng_channel
*channel
, int is_open
)
827 /* Opening channel element */
828 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
834 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
841 ret
= mi_lttng_writer_write_element_bool(writer
,
842 config_element_enabled
, channel
->enabled
);
848 ret
= mi_lttng_channel_attr(writer
, &channel
->attr
);
854 /* Closing channel element */
855 ret
= mi_lttng_writer_close_element(writer
);
865 int mi_lttng_channel_attr(struct mi_writer
*writer
,
866 struct lttng_channel_attr
*attr
)
872 /* Opening Attributes */
873 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
879 ret
= mi_lttng_writer_write_element_string(writer
,
880 config_element_overwrite_mode
,
881 attr
->overwrite
? config_overwrite_mode_overwrite
:
882 config_overwrite_mode_discard
);
887 /* Sub buffer size in byte */
888 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
889 config_element_subbuf_size
, attr
->subbuf_size
);
894 /* Number of subbuffer (power of two) */
895 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
896 config_element_num_subbuf
,
902 /* Switch timer interval in usec */
903 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
904 config_element_switch_timer_interval
,
905 attr
->switch_timer_interval
);
910 /* Read timer interval in usec */
911 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
912 config_element_read_timer_interval
,
913 attr
->read_timer_interval
);
919 ret
= mi_lttng_writer_write_element_string(writer
,
920 config_element_output_type
,
921 attr
->output
== LTTNG_EVENT_SPLICE
?
922 config_output_type_splice
: config_output_type_mmap
);
927 /* Tracefile size in bytes */
928 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
929 config_element_tracefile_size
, attr
->tracefile_size
);
934 /* Count of tracefiles */
935 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
936 config_element_tracefile_count
,
937 attr
->tracefile_count
);
942 /* Live timer interval in usec*/
943 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
944 config_element_live_timer_interval
,
945 attr
->live_timer_interval
);
950 /* Closing attributes */
951 ret
= mi_lttng_writer_close_element(writer
);
961 int mi_lttng_event_common_attributes(struct mi_writer
*writer
,
962 struct lttng_event
*event
)
965 const char *filter_expression
;
967 /* Open event element */
968 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
974 ret
= mi_lttng_writer_write_element_string(writer
,
975 config_element_name
, event
->name
);
981 ret
= mi_lttng_writer_write_element_string(writer
,
982 config_element_type
, mi_lttng_eventtype_string(event
->type
));
987 /* Is event enabled */
988 ret
= mi_lttng_writer_write_element_bool(writer
,
989 config_element_enabled
, event
->enabled
);
994 /* Event filter expression */
995 ret
= lttng_event_get_filter_string(event
, &filter_expression
);
1000 if (filter_expression
) {
1001 ret
= mi_lttng_writer_write_element_string(writer
,
1002 config_element_filter_expression
,
1013 static int write_event_exclusions(struct mi_writer
*writer
,
1014 struct lttng_event
*event
)
1018 int exclusion_count
;
1020 /* Open event exclusions */
1021 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
1026 exclusion_count
= lttng_event_get_exclusion_name_count(event
);
1027 if (exclusion_count
< 0) {
1028 ret
= exclusion_count
;
1032 for (i
= 0; i
< exclusion_count
; i
++) {
1035 ret
= lttng_event_get_exclusion_name(event
, i
, &name
);
1037 /* Close exclusions */
1038 mi_lttng_writer_close_element(writer
);
1042 ret
= mi_lttng_writer_write_element_string(writer
,
1043 config_element_exclusion
, name
);
1045 /* Close exclusions */
1046 mi_lttng_writer_close_element(writer
);
1051 /* Close exclusions */
1052 ret
= mi_lttng_writer_close_element(writer
);
1059 int mi_lttng_event_tracepoint_loglevel(struct mi_writer
*writer
,
1060 struct lttng_event
*event
, enum lttng_domain_type domain
)
1064 /* Event loglevel */
1065 ret
= mi_lttng_writer_write_element_string(writer
,
1066 config_element_loglevel
,
1067 mi_lttng_loglevel_string(event
->loglevel
, domain
));
1072 /* Log level type */
1073 ret
= mi_lttng_writer_write_element_string(writer
,
1074 config_element_loglevel_type
,
1075 mi_lttng_logleveltype_string(event
->loglevel_type
));
1080 /* Event exclusions */
1081 ret
= write_event_exclusions(writer
, event
);
1088 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer
*writer
,
1089 struct lttng_event
*event
)
1091 /* event exclusion filter */
1092 return write_event_exclusions(writer
, event
);
1096 int mi_lttng_event_function_probe(struct mi_writer
*writer
,
1097 struct lttng_event
*event
)
1101 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
1106 ret
= mi_lttng_writer_open_element(writer
, config_element_probe_attributes
);
1111 if (event
->attr
.probe
.addr
!= 0) {
1112 /* event probe address */
1113 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1114 config_element_address
, event
->attr
.probe
.addr
);
1119 /* event probe offset */
1120 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1121 config_element_offset
, event
->attr
.probe
.offset
);
1126 /* event probe symbol_name */
1127 ret
= mi_lttng_writer_write_element_string(writer
,
1128 config_element_symbol_name
, event
->attr
.probe
.symbol_name
);
1134 /* Close probe_attributes and attributes */
1135 ret
= mi_lttng_close_multi_element(writer
, 2);
1141 int mi_lttng_event_function_entry(struct mi_writer
*writer
,
1142 struct lttng_event
*event
)
1146 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
1151 ret
= mi_lttng_writer_open_element(writer
, config_element_probe_attributes
);
1156 /* event probe symbol_name */
1157 ret
= mi_lttng_writer_write_element_string(writer
,
1158 config_element_symbol_name
, event
->attr
.ftrace
.symbol_name
);
1163 /* Close function_attributes and attributes */
1164 ret
= mi_lttng_close_multi_element(writer
, 2);
1170 int mi_lttng_events_open(struct mi_writer
*writer
)
1172 return mi_lttng_writer_open_element(writer
, config_element_events
);
1176 int mi_lttng_event(struct mi_writer
*writer
,
1177 struct lttng_event
*event
, int is_open
, enum lttng_domain_type domain
)
1181 ret
= mi_lttng_event_common_attributes(writer
, event
);
1186 switch (event
->type
) {
1187 case LTTNG_EVENT_TRACEPOINT
:
1189 if (event
->loglevel
!= -1) {
1190 ret
= mi_lttng_event_tracepoint_loglevel(writer
, event
, domain
);
1192 ret
= mi_lttng_event_tracepoint_no_loglevel(writer
, event
);
1196 case LTTNG_EVENT_FUNCTION
:
1198 case LTTNG_EVENT_PROBE
:
1199 ret
= mi_lttng_event_function_probe(writer
, event
);
1201 case LTTNG_EVENT_FUNCTION_ENTRY
:
1202 ret
= mi_lttng_event_function_entry(writer
, event
);
1204 case LTTNG_EVENT_ALL
:
1211 ret
= mi_lttng_writer_close_element(writer
);
1219 int mi_lttng_trackers_open(struct mi_writer
*writer
)
1221 return mi_lttng_writer_open_element(writer
, config_element_trackers
);
1225 int mi_lttng_pid_tracker_open(struct mi_writer
*writer
)
1229 /* Open element pid_tracker */
1230 ret
= mi_lttng_writer_open_element(writer
, config_element_pid_tracker
);
1235 /* Open targets element */
1236 ret
= mi_lttng_targets_open(writer
);
1242 int mi_lttng_pids_open(struct mi_writer
*writer
)
1244 return mi_lttng_writer_open_element(writer
, config_element_pids
);
1248 * TODO: move the listing of pid for user agent to process semantic on
1249 * mi api bump. The use of process element break the mi api.
1252 int mi_lttng_pid(struct mi_writer
*writer
, pid_t pid
, const char *name
,
1257 /* Open pid process */
1258 ret
= mi_lttng_writer_open_element(writer
, config_element_pid
);
1263 /* Writing pid number */
1264 ret
= mi_lttng_writer_write_element_signed_int(writer
,
1265 mi_lttng_element_pid_id
, (int)pid
);
1270 /* Writing name of the process */
1272 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1281 ret
= mi_lttng_writer_close_element(writer
);
1289 int mi_lttng_targets_open(struct mi_writer
*writer
)
1291 return mi_lttng_writer_open_element(writer
,
1292 config_element_targets
);
1296 int mi_lttng_pid_target(struct mi_writer
*writer
, pid_t pid
, int is_open
)
1300 ret
= mi_lttng_writer_open_element(writer
,
1301 config_element_target_pid
);
1306 /* Writing pid number
1307 * Special case for element all on track untrack command
1308 * All pid is represented as wildcard *
1310 if ((int) pid
== -1) {
1311 ret
= mi_lttng_writer_write_element_string(writer
,
1313 mi_lttng_element_track_untrack_all_wildcard
);
1315 ret
= mi_lttng_writer_write_element_signed_int(writer
,
1316 config_element_pid
, (int) pid
);
1323 ret
= mi_lttng_writer_close_element(writer
);
1334 int mi_lttng_event_fields_open(struct mi_writer
*writer
)
1336 return mi_lttng_writer_open_element(writer
, mi_lttng_element_event_fields
);
1340 int mi_lttng_event_field(struct mi_writer
*writer
,
1341 struct lttng_event_field
*field
)
1345 if (!field
->field_name
[0]) {
1351 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_field
);
1356 if (!field
->field_name
[0]) {
1361 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1368 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
1369 mi_lttng_eventfieldtype_string(field
->type
));
1375 ret
= mi_lttng_writer_write_element_signed_int(writer
,
1376 mi_lttng_element_nowrite
, field
->nowrite
);
1382 /* Close field element */
1383 ret
= mi_lttng_writer_close_element(writer
);
1390 int mi_lttng_calibrate(struct mi_writer
*writer
,
1391 struct lttng_calibrate
*calibrate
)
1395 /* Open calibrate element */
1396 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_calibrate
);
1401 /* Calibration type */
1402 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
1403 mi_lttng_calibratetype_string(calibrate
->type
));
1408 /* Closing calibrate element */
1409 ret
= mi_lttng_writer_close_element(writer
);
1415 int mi_lttng_perf_counter_context(struct mi_writer
*writer
,
1416 struct lttng_event_perf_counter_ctx
*perf_context
)
1420 /* Open perf_counter_context */
1421 ret
= mi_lttng_writer_open_element(writer
,
1422 mi_lttng_element_perf_counter_context
);
1428 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1429 config_element_type
, perf_context
->type
);
1435 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1436 config_element_config
, perf_context
->config
);
1441 /* Name of the perf counter */
1442 ret
= mi_lttng_writer_write_element_string(writer
,
1443 config_element_name
, perf_context
->name
);
1448 /* Close perf_counter_context */
1449 ret
= mi_lttng_writer_close_element(writer
);
1455 int mi_lttng_app_context(struct mi_writer
*writer
,
1456 const char *provider_name
, const char *ctx_name
)
1461 ret
= mi_lttng_writer_open_element(writer
,
1462 config_element_context_app
);
1468 ret
= mi_lttng_writer_write_element_string(writer
,
1469 config_element_context_app_provider_name
,
1476 ret
= mi_lttng_writer_write_element_string(writer
,
1477 config_element_context_app_ctx_name
, ctx_name
);
1483 ret
= mi_lttng_writer_close_element(writer
);
1489 int mi_lttng_context(struct mi_writer
*writer
,
1490 struct lttng_event_context
*context
, int is_open
)
1495 ret
= mi_lttng_writer_open_element(writer
, config_element_context
);
1500 /* Special case for PERF_*_COUNTER
1501 * print the lttng_event_perf_counter_ctx*/
1502 switch (context
->ctx
) {
1503 case LTTNG_EVENT_CONTEXT_PERF_COUNTER
:
1504 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
1505 case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER
:
1507 struct lttng_event_perf_counter_ctx
*perf_context
=
1508 &context
->u
.perf_counter
;
1509 ret
= mi_lttng_perf_counter_context(writer
, perf_context
);
1515 case LTTNG_EVENT_CONTEXT_APP_CONTEXT
:
1517 ret
= mi_lttng_app_context(writer
,
1518 context
->u
.app_ctx
.provider_name
,
1519 context
->u
.app_ctx
.ctx_name
);
1527 const char *type_string
= mi_lttng_event_contexttype_string(
1530 ret
= -LTTNG_ERR_INVALID
;
1534 /* Print context type */
1535 ret
= mi_lttng_writer_write_element_string(writer
,
1536 config_element_type
, type_string
);
1543 ret
= mi_lttng_writer_close_element(writer
);
1551 int mi_lttng_snapshot_output_session_name(struct mi_writer
*writer
,
1552 const char *session_name
)
1556 /* Open session element */
1557 ret
= mi_lttng_writer_open_element(writer
, config_element_session
);
1562 /* Snapshot output list for current session name */
1563 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1569 /* Open element snapshots (sequence one snapshot) */
1570 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_snapshots
);
1580 int mi_lttng_snapshot_list_output(struct mi_writer
*writer
,
1581 struct lttng_snapshot_output
*output
)
1585 /* Open element snapshot output */
1586 ret
= mi_lttng_writer_open_element(writer
,
1587 mi_lttng_element_command_snapshot
);
1592 /* ID of the snapshot output */
1593 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1594 mi_lttng_element_id
, output
->id
);
1599 /* Name of the output */
1600 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1606 /* Destination of the output (ctrl_url)*/
1607 ret
= mi_lttng_writer_write_element_string(writer
,
1608 mi_lttng_element_snapshot_ctrl_url
, output
->ctrl_url
);
1613 /* Destination of the output (data_url) */
1614 ret
= mi_lttng_writer_write_element_string(writer
,
1615 mi_lttng_element_snapshot_data_url
, output
->data_url
);
1620 /* total size of all stream combined */
1621 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1622 mi_lttng_element_snapshot_max_size
, output
->max_size
);
1627 /* Close snapshot output element */
1628 ret
= mi_lttng_writer_close_element(writer
);
1635 int mi_lttng_snapshot_del_output(struct mi_writer
*writer
, int id
,
1636 const char *name
, const char *current_session_name
)
1640 /* Open element del_snapshot */
1641 ret
= mi_lttng_writer_open_element(writer
,
1642 mi_lttng_element_command_snapshot
);
1648 if (id
!= UINT32_MAX
) {
1649 /* "Snapshot output "id" successfully deleted
1650 * for "current_session_name"
1651 * ID of the snapshot output
1653 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1654 mi_lttng_element_id
, id
);
1659 /* "Snapshot output "name" successfully deleted
1660 * for session "current_session_name"
1661 * Name of the output
1663 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1670 /* Snapshot was deleted for session "current_session_name"*/
1671 ret
= mi_lttng_writer_write_element_string(writer
,
1672 mi_lttng_element_snapshot_session_name
,
1673 current_session_name
);
1678 /* Close snapshot element */
1679 ret
= mi_lttng_writer_close_element(writer
);
1686 int mi_lttng_snapshot_add_output(struct mi_writer
*writer
,
1687 const char *current_session_name
, const char *n_ptr
,
1688 struct lttng_snapshot_output
*output
)
1692 /* Open element snapshot */
1693 ret
= mi_lttng_writer_open_element(writer
,
1694 mi_lttng_element_command_snapshot
);
1699 /* Snapshot output id */
1700 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1701 mi_lttng_element_id
, output
->id
);
1706 /* Snapshot output names */
1707 ret
= mi_lttng_writer_write_element_string(writer
,
1708 config_element_name
, n_ptr
);
1713 /* Destination of the output (ctrl_url)*/
1714 ret
= mi_lttng_writer_write_element_string(writer
,
1715 mi_lttng_element_snapshot_ctrl_url
, output
->ctrl_url
);
1720 /* Snapshot added for session "current_session_name"*/
1721 ret
= mi_lttng_writer_write_element_string(writer
,
1722 mi_lttng_element_snapshot_session_name
, current_session_name
);
1727 /* total size of all stream combined */
1728 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1729 mi_lttng_element_snapshot_max_size
, output
->max_size
);
1734 /* Close snapshot element */
1735 ret
= mi_lttng_writer_close_element(writer
);
1742 int mi_lttng_snapshot_record(struct mi_writer
*writer
,
1743 const char *current_session_name
, const char *url
,
1744 const char *cmdline_ctrl_url
, const char *cmdline_data_url
)
1748 /* Open element snapshot */
1749 ret
= mi_lttng_writer_open_element(writer
,
1750 mi_lttng_element_command_snapshot
);
1756 * If a valid an URL was given, serialize it,
1757 * else take the command line data and ctrl urls*/
1759 /* Destination of the output (ctrl_url)*/
1760 ret
= mi_lttng_writer_write_element_string(writer
,
1761 mi_lttng_element_snapshot_ctrl_url
, url
);
1765 } else if (cmdline_ctrl_url
) {
1766 /* Destination of the output (ctrl_url)*/
1767 ret
= mi_lttng_writer_write_element_string(writer
,
1768 mi_lttng_element_snapshot_ctrl_url
, cmdline_ctrl_url
);
1773 /* Destination of the output (data_url) */
1774 ret
= mi_lttng_writer_write_element_string(writer
,
1775 mi_lttng_element_snapshot_data_url
, cmdline_data_url
);
1781 /* Close record_snapshot element */
1782 ret
= mi_lttng_writer_close_element(writer
);