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>
24 #include <lttng/channel.h>
29 #define MI_SCHEMA_MAJOR_VERSION 3
30 #define MI_SCHEMA_MINOR_VERSION 0
32 /* Machine interface namespace URI */
33 LTTNG_HIDDEN
const char * const mi_lttng_xmlns
= "xmlns";
34 LTTNG_HIDDEN
const char * const mi_lttng_xmlns_xsi
= "xmlns:xsi";
35 LTTNG_HIDDEN
const char * const mi_lttng_w3_schema_uri
= "http://www.w3.org/2001/XMLSchema-instance";
36 LTTNG_HIDDEN
const char * const mi_lttng_schema_location
= "xsi:schemaLocation";
37 LTTNG_HIDDEN
const char * const mi_lttng_schema_location_uri
=
38 DEFAULT_LTTNG_MI_NAMESPACE
" "
39 "http://lttng.org/xml/schemas/lttng-mi/" XSTR(MI_SCHEMA_MAJOR_VERSION
)
40 "/lttng-mi-" XSTR(MI_SCHEMA_MAJOR_VERSION
) "."
41 XSTR(MI_SCHEMA_MINOR_VERSION
) ".xsd";
42 LTTNG_HIDDEN
const char * const mi_lttng_schema_version
= "schemaVersion";
43 LTTNG_HIDDEN
const char * const mi_lttng_schema_version_value
= XSTR(MI_SCHEMA_MAJOR_VERSION
)
44 "." XSTR(MI_SCHEMA_MINOR_VERSION
);
46 /* Strings related to command */
47 const char * const mi_lttng_element_command
= "command";
48 const char * const mi_lttng_element_command_action
= "snapshot_action";
49 const char * const mi_lttng_element_command_add_context
= "add-context";
50 const char * const mi_lttng_element_command_calibrate
= "calibrate";
51 const char * const mi_lttng_element_command_create
= "create";
52 const char * const mi_lttng_element_command_destroy
= "destroy";
53 const char * const mi_lttng_element_command_disable_channel
= "disable-channel";
54 const char * const mi_lttng_element_command_disable_event
= "disable-event";
55 const char * const mi_lttng_element_command_enable_channels
= "enable-channel";
56 const char * const mi_lttng_element_command_enable_event
= "enable-event";
57 const char * const mi_lttng_element_command_list
= "list";
58 const char * const mi_lttng_element_command_load
= "load";
59 LTTNG_HIDDEN
const char * const mi_lttng_element_command_metadata
= "metadata";
60 LTTNG_HIDDEN
const char * const mi_lttng_element_command_metadata_action
= "metadata_action";
61 const char * const mi_lttng_element_command_name
= "name";
62 const char * const mi_lttng_element_command_output
= "output";
63 const char * const mi_lttng_element_command_save
= "save";
64 const char * const mi_lttng_element_command_set_session
= "set-session";
65 const char * const mi_lttng_element_command_snapshot
= "snapshot";
66 const char * const mi_lttng_element_command_snapshot_add
= "add_snapshot";
67 const char * const mi_lttng_element_command_snapshot_del
= "del_snapshot";
68 const char * const mi_lttng_element_command_snapshot_list
= "list_snapshot";
69 const char * const mi_lttng_element_command_snapshot_record
= "record_snapshot";
70 const char * const mi_lttng_element_command_start
= "start";
71 const char * const mi_lttng_element_command_stop
= "stop";
72 const char * const mi_lttng_element_command_success
= "success";
73 const char * const mi_lttng_element_command_track
= "track";
74 const char * const mi_lttng_element_command_untrack
= "untrack";
75 const char * const mi_lttng_element_command_version
= "version";
77 /* Strings related to version command */
78 const char * const mi_lttng_element_version
= "version";
79 const char * const mi_lttng_element_version_commit
= "commit";
80 const char * const mi_lttng_element_version_description
= "description";
81 const char * const mi_lttng_element_version_license
= "license";
82 const char * const mi_lttng_element_version_major
= "major";
83 const char * const mi_lttng_element_version_minor
= "minor";
84 const char * const mi_lttng_element_version_patch_level
= "patchLevel";
85 const char * const mi_lttng_element_version_str
= "string";
86 const char * const mi_lttng_element_version_web
= "url";
88 /* String related to a lttng_event_field */
89 const char * const mi_lttng_element_event_field
= "event_field";
90 const char * const mi_lttng_element_event_fields
= "event_fields";
92 /* String related to lttng_event_perf_counter_ctx */
93 const char * const mi_lttng_element_perf_counter_context
= "perf";
95 /* Strings related to pid */
96 const char * const mi_lttng_element_pid_id
= "id";
98 /* Strings related to save command */
99 const char * const mi_lttng_element_save
= "save";
101 /* Strings related to load command */
102 const char * const mi_lttng_element_load
= "load";
104 /* General elements of mi_lttng */
105 const char * const mi_lttng_element_empty
= "";
106 const char * const mi_lttng_element_id
= "id";
107 const char * const mi_lttng_element_nowrite
= "nowrite";
108 const char * const mi_lttng_element_success
= "success";
109 const char * const mi_lttng_element_type_enum
= "ENUM";
110 const char * const mi_lttng_element_type_float
= "FLOAT";
111 const char * const mi_lttng_element_type_integer
= "INTEGER";
112 const char * const mi_lttng_element_type_other
= "OTHER";
113 const char * const mi_lttng_element_type_string
= "STRING";
115 /* String related to loglevel */
116 const char * const mi_lttng_loglevel_str_alert
= "TRACE_ALERT";
117 const char * const mi_lttng_loglevel_str_crit
= "TRACE_CRIT";
118 const char * const mi_lttng_loglevel_str_debug
= "TRACE_DEBUG";
119 const char * const mi_lttng_loglevel_str_debug_function
= "TRACE_DEBUG_FUNCTION";
120 const char * const mi_lttng_loglevel_str_debug_line
= "TRACE_DEBUG_LINE";
121 const char * const mi_lttng_loglevel_str_debug_module
= "TRACE_DEBUG_MODULE";
122 const char * const mi_lttng_loglevel_str_debug_process
= "TRACE_DEBUG_PROCESS";
123 const char * const mi_lttng_loglevel_str_debug_program
= "TRACE_DEBUG_PROGRAM";
124 const char * const mi_lttng_loglevel_str_debug_system
= "TRACE_DEBUG_SYSTEM";
125 const char * const mi_lttng_loglevel_str_debug_unit
= "TRACE_DEBUG_UNIT";
126 const char * const mi_lttng_loglevel_str_emerg
= "TRACE_EMERG";
127 const char * const mi_lttng_loglevel_str_err
= "TRACE_ERR";
128 const char * const mi_lttng_loglevel_str_info
= "TRACE_INFO";
129 const char * const mi_lttng_loglevel_str_notice
= "TRACE_NOTICE";
130 const char * const mi_lttng_loglevel_str_unknown
= "UNKNOWN";
131 const char * const mi_lttng_loglevel_str_warning
= "TRACE_WARNING";
133 /* String related to loglevel JUL */
134 const char * const mi_lttng_loglevel_str_jul_all
= "JUL_ALL";
135 const char * const mi_lttng_loglevel_str_jul_config
= "JUL_CONFIG";
136 const char * const mi_lttng_loglevel_str_jul_fine
= "JUL_FINE";
137 const char * const mi_lttng_loglevel_str_jul_finer
= "JUL_FINER";
138 const char * const mi_lttng_loglevel_str_jul_finest
= "JUL_FINEST";
139 const char * const mi_lttng_loglevel_str_jul_info
= "JUL_INFO";
140 const char * const mi_lttng_loglevel_str_jul_off
= "JUL_OFF";
141 const char * const mi_lttng_loglevel_str_jul_severe
= "JUL_SEVERE";
142 const char * const mi_lttng_loglevel_str_jul_warning
= "JUL_WARNING";
144 /* String related to loglevel LOG4J */
145 const char * const mi_lttng_loglevel_str_log4j_off
= "LOG4J_OFF";
146 const char * const mi_lttng_loglevel_str_log4j_fatal
= "LOG4J_FATAL";
147 const char * const mi_lttng_loglevel_str_log4j_error
= "LOG4J_ERROR";
148 const char * const mi_lttng_loglevel_str_log4j_warn
= "LOG4J_WARN";
149 const char * const mi_lttng_loglevel_str_log4j_info
= "LOG4J_INFO";
150 const char * const mi_lttng_loglevel_str_log4j_debug
= "LOG4J_DEBUG";
151 const char * const mi_lttng_loglevel_str_log4j_trace
= "LOG4J_TRACE";
152 const char * const mi_lttng_loglevel_str_log4j_all
= "LOG4J_ALL";
154 /* String related to loglevel Python */
155 const char * const mi_lttng_loglevel_str_python_critical
= "PYTHON_CRITICAL";
156 const char * const mi_lttng_loglevel_str_python_error
= "PYTHON_ERROR";
157 const char * const mi_lttng_loglevel_str_python_warning
= "PYTHON_WARNING";
158 const char * const mi_lttng_loglevel_str_python_info
= "PYTHON_INFO";
159 const char * const mi_lttng_loglevel_str_python_debug
= "PYTHON_DEBUG";
160 const char * const mi_lttng_loglevel_str_python_notset
= "PYTHON_NOTSET";
162 /* String related to loglevel type */
163 const char * const mi_lttng_loglevel_type_all
= "ALL";
164 const char * const mi_lttng_loglevel_type_range
= "RANGE";
165 const char * const mi_lttng_loglevel_type_single
= "SINGLE";
166 const char * const mi_lttng_loglevel_type_unknown
= "UNKNOWN";
168 /* String related to lttng_calibrate */
169 const char * const mi_lttng_element_calibrate
= "calibrate";
170 const char * const mi_lttng_element_calibrate_function
= "FUNCTION";
172 /* String related to a lttng_snapshot_output */
173 const char * const mi_lttng_element_snapshot_ctrl_url
= "ctrl_url";
174 const char * const mi_lttng_element_snapshot_data_url
= "data_url";
175 const char * const mi_lttng_element_snapshot_max_size
= "max_size";
176 const char * const mi_lttng_element_snapshot_n_ptr
= "n_ptr";
177 const char * const mi_lttng_element_snapshot_session_name
= "session_name";
178 const char * const mi_lttng_element_snapshots
= "snapshots";
180 /* String related to track/untrack command */
181 const char * const mi_lttng_element_track_untrack_all_wildcard
= "*";
183 /* Deprecated symbols preserved for ABI compatibility. */
184 const char * const mi_lttng_context_type_perf_counter
;
185 const char * const mi_lttng_context_type_perf_cpu_counter
;
186 const char * const mi_lttng_context_type_perf_thread_counter
;
187 const char * const mi_lttng_element_track_untrack_pid_target
;
188 const char * const mi_lttng_element_track_untrack_targets
;
190 /* This is a merge of jul loglevel and regular loglevel
191 * Those should never overlap by definition
192 * (see struct lttng_event loglevel)
195 const char *mi_lttng_loglevel_string(int value
, enum lttng_domain_type domain
)
198 case LTTNG_DOMAIN_KERNEL
:
199 case LTTNG_DOMAIN_UST
:
202 return mi_lttng_element_empty
;
203 case LTTNG_LOGLEVEL_EMERG
:
204 return mi_lttng_loglevel_str_emerg
;
205 case LTTNG_LOGLEVEL_ALERT
:
206 return mi_lttng_loglevel_str_alert
;
207 case LTTNG_LOGLEVEL_CRIT
:
208 return mi_lttng_loglevel_str_crit
;
209 case LTTNG_LOGLEVEL_ERR
:
210 return mi_lttng_loglevel_str_err
;
211 case LTTNG_LOGLEVEL_WARNING
:
212 return mi_lttng_loglevel_str_warning
;
213 case LTTNG_LOGLEVEL_NOTICE
:
214 return mi_lttng_loglevel_str_notice
;
215 case LTTNG_LOGLEVEL_INFO
:
216 return mi_lttng_loglevel_str_info
;
217 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
218 return mi_lttng_loglevel_str_debug_system
;
219 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
220 return mi_lttng_loglevel_str_debug_program
;
221 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
222 return mi_lttng_loglevel_str_debug_process
;
223 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
224 return mi_lttng_loglevel_str_debug_module
;
225 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
226 return mi_lttng_loglevel_str_debug_unit
;
227 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
228 return mi_lttng_loglevel_str_debug_function
;
229 case LTTNG_LOGLEVEL_DEBUG_LINE
:
230 return mi_lttng_loglevel_str_debug_line
;
231 case LTTNG_LOGLEVEL_DEBUG
:
232 return mi_lttng_loglevel_str_debug
;
234 return mi_lttng_loglevel_str_unknown
;
237 case LTTNG_DOMAIN_LOG4J
:
240 return mi_lttng_element_empty
;
241 case LTTNG_LOGLEVEL_LOG4J_OFF
:
242 return mi_lttng_loglevel_str_log4j_off
;
243 case LTTNG_LOGLEVEL_LOG4J_FATAL
:
244 return mi_lttng_loglevel_str_log4j_fatal
;
245 case LTTNG_LOGLEVEL_LOG4J_ERROR
:
246 return mi_lttng_loglevel_str_log4j_error
;
247 case LTTNG_LOGLEVEL_LOG4J_WARN
:
248 return mi_lttng_loglevel_str_log4j_warn
;
249 case LTTNG_LOGLEVEL_LOG4J_INFO
:
250 return mi_lttng_loglevel_str_log4j_info
;
251 case LTTNG_LOGLEVEL_LOG4J_DEBUG
:
252 return mi_lttng_loglevel_str_log4j_debug
;
253 case LTTNG_LOGLEVEL_LOG4J_TRACE
:
254 return mi_lttng_loglevel_str_log4j_trace
;
255 case LTTNG_LOGLEVEL_LOG4J_ALL
:
256 return mi_lttng_loglevel_str_log4j_all
;
258 return mi_lttng_loglevel_str_unknown
;
261 case LTTNG_DOMAIN_JUL
:
264 return mi_lttng_element_empty
;
265 case LTTNG_LOGLEVEL_JUL_OFF
:
266 return mi_lttng_loglevel_str_jul_off
;
267 case LTTNG_LOGLEVEL_JUL_SEVERE
:
268 return mi_lttng_loglevel_str_jul_severe
;
269 case LTTNG_LOGLEVEL_JUL_WARNING
:
270 return mi_lttng_loglevel_str_jul_warning
;
271 case LTTNG_LOGLEVEL_JUL_INFO
:
272 return mi_lttng_loglevel_str_jul_info
;
273 case LTTNG_LOGLEVEL_JUL_CONFIG
:
274 return mi_lttng_loglevel_str_jul_config
;
275 case LTTNG_LOGLEVEL_JUL_FINE
:
276 return mi_lttng_loglevel_str_jul_fine
;
277 case LTTNG_LOGLEVEL_JUL_FINER
:
278 return mi_lttng_loglevel_str_jul_finer
;
279 case LTTNG_LOGLEVEL_JUL_FINEST
:
280 return mi_lttng_loglevel_str_jul_finest
;
281 case LTTNG_LOGLEVEL_JUL_ALL
:
282 return mi_lttng_loglevel_str_jul_all
;
284 return mi_lttng_loglevel_str_unknown
;
287 case LTTNG_DOMAIN_PYTHON
:
289 case LTTNG_LOGLEVEL_PYTHON_CRITICAL
:
290 return mi_lttng_loglevel_str_python_critical
;
291 case LTTNG_LOGLEVEL_PYTHON_ERROR
:
292 return mi_lttng_loglevel_str_python_error
;
293 case LTTNG_LOGLEVEL_PYTHON_WARNING
:
294 return mi_lttng_loglevel_str_python_warning
;
295 case LTTNG_LOGLEVEL_PYTHON_INFO
:
296 return mi_lttng_loglevel_str_python_info
;
297 case LTTNG_LOGLEVEL_PYTHON_DEBUG
:
298 return mi_lttng_loglevel_str_python_debug
;
299 case LTTNG_LOGLEVEL_PYTHON_NOTSET
:
300 return mi_lttng_loglevel_str_python_notset
;
302 return mi_lttng_loglevel_str_unknown
;
306 return mi_lttng_loglevel_str_unknown
;
311 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value
)
314 case LTTNG_EVENT_LOGLEVEL_ALL
:
315 return mi_lttng_loglevel_type_all
;
316 case LTTNG_EVENT_LOGLEVEL_RANGE
:
317 return mi_lttng_loglevel_type_range
;
318 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
319 return mi_lttng_loglevel_type_single
;
321 return mi_lttng_loglevel_type_unknown
;
326 const char *mi_lttng_eventtype_string(enum lttng_event_type value
)
329 case LTTNG_EVENT_ALL
:
330 return config_event_type_all
;
331 case LTTNG_EVENT_TRACEPOINT
:
332 return config_event_type_tracepoint
;
333 case LTTNG_EVENT_PROBE
:
334 return config_event_type_probe
;
335 case LTTNG_EVENT_FUNCTION
:
336 return config_event_type_function
;
337 case LTTNG_EVENT_FUNCTION_ENTRY
:
338 return config_event_type_function_entry
;
339 case LTTNG_EVENT_SYSCALL
:
340 return config_event_type_syscall
;
341 case LTTNG_EVENT_NOOP
:
342 return config_event_type_noop
;
344 return mi_lttng_element_empty
;
349 const char *mi_lttng_event_contexttype_string(enum lttng_event_context_type val
)
352 case LTTNG_EVENT_CONTEXT_PID
:
353 return config_event_context_pid
;
354 case LTTNG_EVENT_CONTEXT_PROCNAME
:
355 return config_event_context_procname
;
356 case LTTNG_EVENT_CONTEXT_PRIO
:
357 return config_event_context_prio
;
358 case LTTNG_EVENT_CONTEXT_NICE
:
359 return config_event_context_nice
;
360 case LTTNG_EVENT_CONTEXT_VPID
:
361 return config_event_context_vpid
;
362 case LTTNG_EVENT_CONTEXT_TID
:
363 return config_event_context_tid
;
364 case LTTNG_EVENT_CONTEXT_VTID
:
365 return config_event_context_vtid
;
366 case LTTNG_EVENT_CONTEXT_PPID
:
367 return config_event_context_ppid
;
368 case LTTNG_EVENT_CONTEXT_VPPID
:
369 return config_event_context_vppid
;
370 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
371 return config_event_context_pthread_id
;
372 case LTTNG_EVENT_CONTEXT_HOSTNAME
:
373 return config_event_context_hostname
;
374 case LTTNG_EVENT_CONTEXT_IP
:
375 return config_event_context_ip
;
382 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val
)
385 case(LTTNG_EVENT_FIELD_INTEGER
):
386 return mi_lttng_element_type_integer
;
387 case(LTTNG_EVENT_FIELD_ENUM
):
388 return mi_lttng_element_type_enum
;
389 case(LTTNG_EVENT_FIELD_FLOAT
):
390 return mi_lttng_element_type_float
;
391 case(LTTNG_EVENT_FIELD_STRING
):
392 return mi_lttng_element_type_string
;
394 return mi_lttng_element_type_other
;
399 const char *mi_lttng_domaintype_string(enum lttng_domain_type value
)
401 /* Note: This is a *duplicate* of get_domain_str from bin/lttng/utils.c */
403 case LTTNG_DOMAIN_KERNEL
:
404 return config_domain_type_kernel
;
405 case LTTNG_DOMAIN_UST
:
406 return config_domain_type_ust
;
407 case LTTNG_DOMAIN_JUL
:
408 return config_domain_type_jul
;
409 case LTTNG_DOMAIN_LOG4J
:
410 return config_domain_type_log4j
;
411 case LTTNG_DOMAIN_PYTHON
:
412 return config_domain_type_python
;
414 /* Should not have an unknown domain */
421 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value
)
424 case LTTNG_BUFFER_PER_PID
:
425 return config_buffer_type_per_pid
;
426 case LTTNG_BUFFER_PER_UID
:
427 return config_buffer_type_per_uid
;
428 case LTTNG_BUFFER_GLOBAL
:
429 return config_buffer_type_global
;
431 /* Should not have an unknow buffer type */
438 const char *mi_lttng_calibratetype_string(enum lttng_calibrate_type val
)
443 case LTTNG_CALIBRATE_FUNCTION
:
444 ret
= mi_lttng_element_calibrate_function
;
447 ret
= mi_lttng_element_empty
;
454 struct mi_writer
*mi_lttng_writer_create(int fd_output
, int mi_output_type
)
456 struct mi_writer
*mi_writer
;
458 mi_writer
= zmalloc(sizeof(struct mi_writer
));
460 PERROR("zmalloc mi_writer_create");
463 if (mi_output_type
== LTTNG_MI_XML
) {
464 mi_writer
->writer
= config_writer_create(fd_output
, 0);
465 if (!mi_writer
->writer
) {
468 mi_writer
->type
= LTTNG_MI_XML
;
482 int mi_lttng_writer_destroy(struct mi_writer
*writer
)
491 ret
= config_writer_destroy(writer
->writer
);
502 int mi_lttng_writer_command_open(struct mi_writer
*writer
, const char *command
)
507 * A command is always the MI's root node, it must declare the current
508 * namespace and schema URIs and the schema's version.
510 ret
= config_writer_open_element(writer
->writer
,
511 mi_lttng_element_command
);
516 ret
= config_writer_write_attribute(writer
->writer
,
517 mi_lttng_xmlns
, DEFAULT_LTTNG_MI_NAMESPACE
);
522 ret
= config_writer_write_attribute(writer
->writer
,
523 mi_lttng_xmlns_xsi
, mi_lttng_w3_schema_uri
);
528 ret
= config_writer_write_attribute(writer
->writer
,
529 mi_lttng_schema_location
,
530 mi_lttng_schema_location_uri
);
535 ret
= config_writer_write_attribute(writer
->writer
,
536 mi_lttng_schema_version
,
537 mi_lttng_schema_version_value
);
542 ret
= mi_lttng_writer_write_element_string(writer
,
543 mi_lttng_element_command_name
, command
);
549 int mi_lttng_writer_command_close(struct mi_writer
*writer
)
551 return mi_lttng_writer_close_element(writer
);
555 int mi_lttng_writer_open_element(struct mi_writer
*writer
,
556 const char *element_name
)
558 return config_writer_open_element(writer
->writer
, element_name
);
562 int mi_lttng_writer_close_element(struct mi_writer
*writer
)
564 return config_writer_close_element(writer
->writer
);
568 int mi_lttng_close_multi_element(struct mi_writer
*writer
,
569 unsigned int nb_element
)
573 if (nb_element
< 1) {
577 for (i
= 0; i
< nb_element
; i
++) {
578 ret
= mi_lttng_writer_close_element(writer
);
588 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer
*writer
,
589 const char *element_name
, uint64_t value
)
591 return config_writer_write_element_unsigned_int(writer
->writer
,
592 element_name
, value
);
596 int mi_lttng_writer_write_element_signed_int(struct mi_writer
*writer
,
597 const char *element_name
, int64_t value
)
599 return config_writer_write_element_signed_int(writer
->writer
,
600 element_name
, value
);
604 int mi_lttng_writer_write_element_bool(struct mi_writer
*writer
,
605 const char *element_name
, int value
)
607 return config_writer_write_element_bool(writer
->writer
,
608 element_name
, value
);
612 int mi_lttng_writer_write_element_string(struct mi_writer
*writer
,
613 const char *element_name
, const char *value
)
615 return config_writer_write_element_string(writer
->writer
,
616 element_name
, value
);
620 int mi_lttng_version(struct mi_writer
*writer
, struct mi_lttng_version
*version
,
621 const char *lttng_description
, const char *lttng_license
)
626 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_version
);
631 /* Version string (contain info like rc etc.) */
632 ret
= mi_lttng_writer_write_element_string(writer
,
633 mi_lttng_element_version_str
, version
->version
);
638 /* Major version number */
639 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
640 mi_lttng_element_version_major
, version
->version_major
);
645 /* Minor version number */
646 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
647 mi_lttng_element_version_minor
, version
->version_minor
);
652 /* Commit version number */
653 ret
= mi_lttng_writer_write_element_string(writer
,
654 mi_lttng_element_version_commit
, version
->version_commit
);
660 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
661 mi_lttng_element_version_patch_level
, version
->version_patchlevel
);
666 /* Name of the version */
667 ret
= mi_lttng_writer_write_element_string(writer
,
668 config_element_name
, version
->version_name
);
673 /* Description mostly related to beer... */
674 ret
= mi_lttng_writer_write_element_string(writer
,
675 mi_lttng_element_version_description
, lttng_description
);
681 ret
= mi_lttng_writer_write_element_string(writer
,
682 mi_lttng_element_version_web
, version
->package_url
);
687 /* License: free as in free beer...no...*speech* */
688 ret
= mi_lttng_writer_write_element_string(writer
,
689 mi_lttng_element_version_license
, lttng_license
);
694 /* Close version element */
695 ret
= mi_lttng_writer_close_element(writer
);
702 int mi_lttng_sessions_open(struct mi_writer
*writer
)
704 return mi_lttng_writer_open_element(writer
, config_element_sessions
);
708 int mi_lttng_session(struct mi_writer
*writer
,
709 struct lttng_session
*session
, int is_open
)
715 /* Open sessions element */
716 ret
= mi_lttng_writer_open_element(writer
,
717 config_element_session
);
722 /* Name of the session */
723 ret
= mi_lttng_writer_write_element_string(writer
,
724 config_element_name
, session
->name
);
730 ret
= mi_lttng_writer_write_element_string(writer
,
731 config_element_path
, session
->path
);
737 ret
= mi_lttng_writer_write_element_bool(writer
,
738 config_element_enabled
, session
->enabled
);
744 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
745 config_element_snapshot_mode
, session
->snapshot_mode
);
750 /* Live timer interval in usec */
751 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
752 config_element_live_timer_interval
,
753 session
->live_timer_interval
);
759 /* Closing session element */
760 ret
= mi_lttng_writer_close_element(writer
);
768 int mi_lttng_domains_open(struct mi_writer
*writer
)
770 return mi_lttng_writer_open_element(writer
, config_element_domains
);
774 int mi_lttng_domain(struct mi_writer
*writer
,
775 struct lttng_domain
*domain
, int is_open
)
778 const char *str_domain
;
779 const char *str_buffer
;
783 /* Open domain element */
784 ret
= mi_lttng_writer_open_element(writer
, config_element_domain
);
790 str_domain
= mi_lttng_domaintype_string(domain
->type
);
791 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
798 str_buffer
= mi_lttng_buffertype_string(domain
->buf_type
);
799 ret
= mi_lttng_writer_write_element_string(writer
,
800 config_element_buffer_type
, str_buffer
);
806 * This union is not currently used and was added for
807 * future ust domain support.
812 /* Closing domain element */
813 ret
= mi_lttng_writer_close_element(writer
);
822 int mi_lttng_channels_open(struct mi_writer
*writer
)
824 return mi_lttng_writer_open_element(writer
, config_element_channels
);
828 int mi_lttng_channel(struct mi_writer
*writer
,
829 struct lttng_channel
*channel
, int is_open
)
835 /* Opening channel element */
836 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
842 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
849 ret
= mi_lttng_writer_write_element_bool(writer
,
850 config_element_enabled
, channel
->enabled
);
856 ret
= mi_lttng_channel_attr(writer
, &channel
->attr
);
862 /* Closing channel element */
863 ret
= mi_lttng_writer_close_element(writer
);
873 int mi_lttng_channel_attr(struct mi_writer
*writer
,
874 struct lttng_channel_attr
*attr
)
877 struct lttng_channel
*chan
= caa_container_of(attr
,
878 struct lttng_channel
, attr
);
879 uint64_t discarded_events
, lost_packets
;
883 ret
= lttng_channel_get_discarded_event_count(chan
, &discarded_events
);
888 ret
= lttng_channel_get_lost_packet_count(chan
, &lost_packets
);
893 /* Opening Attributes */
894 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
900 ret
= mi_lttng_writer_write_element_string(writer
,
901 config_element_overwrite_mode
,
902 attr
->overwrite
? config_overwrite_mode_overwrite
:
903 config_overwrite_mode_discard
);
908 /* Sub buffer size in byte */
909 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
910 config_element_subbuf_size
, attr
->subbuf_size
);
915 /* Number of subbuffer (power of two) */
916 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
917 config_element_num_subbuf
,
923 /* Switch timer interval in usec */
924 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
925 config_element_switch_timer_interval
,
926 attr
->switch_timer_interval
);
931 /* Read timer interval in usec */
932 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
933 config_element_read_timer_interval
,
934 attr
->read_timer_interval
);
940 ret
= mi_lttng_writer_write_element_string(writer
,
941 config_element_output_type
,
942 attr
->output
== LTTNG_EVENT_SPLICE
?
943 config_output_type_splice
: config_output_type_mmap
);
948 /* Tracefile size in bytes */
949 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
950 config_element_tracefile_size
, attr
->tracefile_size
);
955 /* Count of tracefiles */
956 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
957 config_element_tracefile_count
,
958 attr
->tracefile_count
);
963 /* Live timer interval in usec*/
964 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
965 config_element_live_timer_interval
,
966 attr
->live_timer_interval
);
971 /* Discarded events */
972 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
973 config_element_discarded_events
,
980 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
981 config_element_lost_packets
,
987 /* Closing attributes */
988 ret
= mi_lttng_writer_close_element(writer
);
998 int mi_lttng_event_common_attributes(struct mi_writer
*writer
,
999 struct lttng_event
*event
)
1002 const char *filter_expression
;
1004 /* Open event element */
1005 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
1011 ret
= mi_lttng_writer_write_element_string(writer
,
1012 config_element_name
, event
->name
);
1018 ret
= mi_lttng_writer_write_element_string(writer
,
1019 config_element_type
, mi_lttng_eventtype_string(event
->type
));
1024 /* Is event enabled */
1025 ret
= mi_lttng_writer_write_element_bool(writer
,
1026 config_element_enabled
, event
->enabled
);
1031 /* Event filter expression */
1032 ret
= lttng_event_get_filter_expression(event
, &filter_expression
);
1037 if (filter_expression
) {
1038 ret
= mi_lttng_writer_write_element_string(writer
,
1039 config_element_filter_expression
,
1050 static int write_event_exclusions(struct mi_writer
*writer
,
1051 struct lttng_event
*event
)
1055 int exclusion_count
;
1057 /* Open event exclusions */
1058 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
1063 exclusion_count
= lttng_event_get_exclusion_name_count(event
);
1064 if (exclusion_count
< 0) {
1065 ret
= exclusion_count
;
1069 for (i
= 0; i
< exclusion_count
; i
++) {
1072 ret
= lttng_event_get_exclusion_name(event
, i
, &name
);
1074 /* Close exclusions */
1075 mi_lttng_writer_close_element(writer
);
1079 ret
= mi_lttng_writer_write_element_string(writer
,
1080 config_element_exclusion
, name
);
1082 /* Close exclusions */
1083 mi_lttng_writer_close_element(writer
);
1088 /* Close exclusions */
1089 ret
= mi_lttng_writer_close_element(writer
);
1096 int mi_lttng_event_tracepoint_loglevel(struct mi_writer
*writer
,
1097 struct lttng_event
*event
, enum lttng_domain_type domain
)
1101 /* Event loglevel */
1102 ret
= mi_lttng_writer_write_element_string(writer
,
1103 config_element_loglevel
,
1104 mi_lttng_loglevel_string(event
->loglevel
, domain
));
1109 /* Log level type */
1110 ret
= mi_lttng_writer_write_element_string(writer
,
1111 config_element_loglevel_type
,
1112 mi_lttng_logleveltype_string(event
->loglevel_type
));
1117 /* Event exclusions */
1118 ret
= write_event_exclusions(writer
, event
);
1125 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer
*writer
,
1126 struct lttng_event
*event
)
1128 /* event exclusion filter */
1129 return write_event_exclusions(writer
, event
);
1133 int mi_lttng_event_function_probe(struct mi_writer
*writer
,
1134 struct lttng_event
*event
)
1138 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
1143 ret
= mi_lttng_writer_open_element(writer
, config_element_probe_attributes
);
1148 if (event
->attr
.probe
.addr
!= 0) {
1149 /* event probe address */
1150 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1151 config_element_address
, event
->attr
.probe
.addr
);
1156 /* event probe offset */
1157 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1158 config_element_offset
, event
->attr
.probe
.offset
);
1163 /* event probe symbol_name */
1164 ret
= mi_lttng_writer_write_element_string(writer
,
1165 config_element_symbol_name
, event
->attr
.probe
.symbol_name
);
1171 /* Close probe_attributes and attributes */
1172 ret
= mi_lttng_close_multi_element(writer
, 2);
1178 int mi_lttng_event_function_entry(struct mi_writer
*writer
,
1179 struct lttng_event
*event
)
1183 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
1188 ret
= mi_lttng_writer_open_element(writer
, config_element_probe_attributes
);
1193 /* event probe symbol_name */
1194 ret
= mi_lttng_writer_write_element_string(writer
,
1195 config_element_symbol_name
, event
->attr
.ftrace
.symbol_name
);
1200 /* Close function_attributes and attributes */
1201 ret
= mi_lttng_close_multi_element(writer
, 2);
1207 int mi_lttng_events_open(struct mi_writer
*writer
)
1209 return mi_lttng_writer_open_element(writer
, config_element_events
);
1213 int mi_lttng_event(struct mi_writer
*writer
,
1214 struct lttng_event
*event
, int is_open
, enum lttng_domain_type domain
)
1218 ret
= mi_lttng_event_common_attributes(writer
, event
);
1223 switch (event
->type
) {
1224 case LTTNG_EVENT_TRACEPOINT
:
1226 if (event
->loglevel
!= -1) {
1227 ret
= mi_lttng_event_tracepoint_loglevel(writer
, event
, domain
);
1229 ret
= mi_lttng_event_tracepoint_no_loglevel(writer
, event
);
1233 case LTTNG_EVENT_FUNCTION
:
1235 case LTTNG_EVENT_PROBE
:
1236 ret
= mi_lttng_event_function_probe(writer
, event
);
1238 case LTTNG_EVENT_FUNCTION_ENTRY
:
1239 ret
= mi_lttng_event_function_entry(writer
, event
);
1241 case LTTNG_EVENT_ALL
:
1248 ret
= mi_lttng_writer_close_element(writer
);
1256 int mi_lttng_trackers_open(struct mi_writer
*writer
)
1258 return mi_lttng_writer_open_element(writer
, config_element_trackers
);
1262 int mi_lttng_pid_tracker_open(struct mi_writer
*writer
)
1266 /* Open element pid_tracker */
1267 ret
= mi_lttng_writer_open_element(writer
, config_element_pid_tracker
);
1272 /* Open targets element */
1273 ret
= mi_lttng_targets_open(writer
);
1279 int mi_lttng_pids_open(struct mi_writer
*writer
)
1281 return mi_lttng_writer_open_element(writer
, config_element_pids
);
1285 * TODO: move the listing of pid for user agent to process semantic on
1286 * mi api bump. The use of process element break the mi api.
1289 int mi_lttng_pid(struct mi_writer
*writer
, pid_t pid
, const char *name
,
1294 /* Open pid process */
1295 ret
= mi_lttng_writer_open_element(writer
, config_element_pid
);
1300 /* Writing pid number */
1301 ret
= mi_lttng_writer_write_element_signed_int(writer
,
1302 mi_lttng_element_pid_id
, (int)pid
);
1307 /* Writing name of the process */
1309 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1318 ret
= mi_lttng_writer_close_element(writer
);
1326 int mi_lttng_targets_open(struct mi_writer
*writer
)
1328 return mi_lttng_writer_open_element(writer
,
1329 config_element_targets
);
1333 int mi_lttng_pid_target(struct mi_writer
*writer
, pid_t pid
, int is_open
)
1337 ret
= mi_lttng_writer_open_element(writer
,
1338 config_element_target_pid
);
1343 /* Writing pid number
1344 * Special case for element all on track untrack command
1345 * All pid is represented as wildcard *
1347 if ((int) pid
== -1) {
1348 ret
= mi_lttng_writer_write_element_string(writer
,
1350 mi_lttng_element_track_untrack_all_wildcard
);
1352 ret
= mi_lttng_writer_write_element_signed_int(writer
,
1353 config_element_pid
, (int) pid
);
1360 ret
= mi_lttng_writer_close_element(writer
);
1371 int mi_lttng_event_fields_open(struct mi_writer
*writer
)
1373 return mi_lttng_writer_open_element(writer
, mi_lttng_element_event_fields
);
1377 int mi_lttng_event_field(struct mi_writer
*writer
,
1378 struct lttng_event_field
*field
)
1382 if (!field
->field_name
[0]) {
1388 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_field
);
1393 if (!field
->field_name
[0]) {
1398 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1405 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
1406 mi_lttng_eventfieldtype_string(field
->type
));
1412 ret
= mi_lttng_writer_write_element_signed_int(writer
,
1413 mi_lttng_element_nowrite
, field
->nowrite
);
1419 /* Close field element */
1420 ret
= mi_lttng_writer_close_element(writer
);
1427 int mi_lttng_calibrate(struct mi_writer
*writer
,
1428 struct lttng_calibrate
*calibrate
)
1432 /* Open calibrate element */
1433 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_calibrate
);
1438 /* Calibration type */
1439 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
1440 mi_lttng_calibratetype_string(calibrate
->type
));
1445 /* Closing calibrate element */
1446 ret
= mi_lttng_writer_close_element(writer
);
1452 int mi_lttng_perf_counter_context(struct mi_writer
*writer
,
1453 struct lttng_event_perf_counter_ctx
*perf_context
)
1457 /* Open perf_counter_context */
1458 ret
= mi_lttng_writer_open_element(writer
,
1459 mi_lttng_element_perf_counter_context
);
1465 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1466 config_element_type
, perf_context
->type
);
1472 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1473 config_element_config
, perf_context
->config
);
1478 /* Name of the perf counter */
1479 ret
= mi_lttng_writer_write_element_string(writer
,
1480 config_element_name
, perf_context
->name
);
1485 /* Close perf_counter_context */
1486 ret
= mi_lttng_writer_close_element(writer
);
1492 int mi_lttng_app_context(struct mi_writer
*writer
,
1493 const char *provider_name
, const char *ctx_name
)
1498 ret
= mi_lttng_writer_open_element(writer
,
1499 config_element_context_app
);
1505 ret
= mi_lttng_writer_write_element_string(writer
,
1506 config_element_context_app_provider_name
,
1513 ret
= mi_lttng_writer_write_element_string(writer
,
1514 config_element_context_app_ctx_name
, ctx_name
);
1520 ret
= mi_lttng_writer_close_element(writer
);
1526 int mi_lttng_context(struct mi_writer
*writer
,
1527 struct lttng_event_context
*context
, int is_open
)
1532 ret
= mi_lttng_writer_open_element(writer
, config_element_context
);
1537 /* Special case for PERF_*_COUNTER
1538 * print the lttng_event_perf_counter_ctx*/
1539 switch (context
->ctx
) {
1540 case LTTNG_EVENT_CONTEXT_PERF_COUNTER
:
1541 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
1542 case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER
:
1544 struct lttng_event_perf_counter_ctx
*perf_context
=
1545 &context
->u
.perf_counter
;
1546 ret
= mi_lttng_perf_counter_context(writer
, perf_context
);
1552 case LTTNG_EVENT_CONTEXT_APP_CONTEXT
:
1554 ret
= mi_lttng_app_context(writer
,
1555 context
->u
.app_ctx
.provider_name
,
1556 context
->u
.app_ctx
.ctx_name
);
1564 const char *type_string
= mi_lttng_event_contexttype_string(
1567 ret
= -LTTNG_ERR_INVALID
;
1571 /* Print context type */
1572 ret
= mi_lttng_writer_write_element_string(writer
,
1573 config_element_type
, type_string
);
1580 ret
= mi_lttng_writer_close_element(writer
);
1588 int mi_lttng_snapshot_output_session_name(struct mi_writer
*writer
,
1589 const char *session_name
)
1593 /* Open session element */
1594 ret
= mi_lttng_writer_open_element(writer
, config_element_session
);
1599 /* Snapshot output list for current session name */
1600 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1606 /* Open element snapshots (sequence one snapshot) */
1607 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_snapshots
);
1617 int mi_lttng_snapshot_list_output(struct mi_writer
*writer
,
1618 struct lttng_snapshot_output
*output
)
1622 /* Open element snapshot output */
1623 ret
= mi_lttng_writer_open_element(writer
,
1624 mi_lttng_element_command_snapshot
);
1629 /* ID of the snapshot output */
1630 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1631 mi_lttng_element_id
, output
->id
);
1636 /* Name of the output */
1637 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1643 /* Destination of the output (ctrl_url)*/
1644 ret
= mi_lttng_writer_write_element_string(writer
,
1645 mi_lttng_element_snapshot_ctrl_url
, output
->ctrl_url
);
1650 /* Destination of the output (data_url) */
1651 ret
= mi_lttng_writer_write_element_string(writer
,
1652 mi_lttng_element_snapshot_data_url
, output
->data_url
);
1657 /* total size of all stream combined */
1658 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1659 mi_lttng_element_snapshot_max_size
, output
->max_size
);
1664 /* Close snapshot output element */
1665 ret
= mi_lttng_writer_close_element(writer
);
1672 int mi_lttng_snapshot_del_output(struct mi_writer
*writer
, int id
,
1673 const char *name
, const char *current_session_name
)
1677 /* Open element del_snapshot */
1678 ret
= mi_lttng_writer_open_element(writer
,
1679 mi_lttng_element_command_snapshot
);
1685 if (id
!= UINT32_MAX
) {
1686 /* "Snapshot output "id" successfully deleted
1687 * for "current_session_name"
1688 * ID of the snapshot output
1690 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1691 mi_lttng_element_id
, id
);
1696 /* "Snapshot output "name" successfully deleted
1697 * for session "current_session_name"
1698 * Name of the output
1700 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
1707 /* Snapshot was deleted for session "current_session_name"*/
1708 ret
= mi_lttng_writer_write_element_string(writer
,
1709 mi_lttng_element_snapshot_session_name
,
1710 current_session_name
);
1715 /* Close snapshot element */
1716 ret
= mi_lttng_writer_close_element(writer
);
1723 int mi_lttng_snapshot_add_output(struct mi_writer
*writer
,
1724 const char *current_session_name
, const char *n_ptr
,
1725 struct lttng_snapshot_output
*output
)
1729 /* Open element snapshot */
1730 ret
= mi_lttng_writer_open_element(writer
,
1731 mi_lttng_element_command_snapshot
);
1736 /* Snapshot output id */
1737 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1738 mi_lttng_element_id
, output
->id
);
1743 /* Snapshot output names */
1744 ret
= mi_lttng_writer_write_element_string(writer
,
1745 config_element_name
, n_ptr
);
1750 /* Destination of the output (ctrl_url)*/
1751 ret
= mi_lttng_writer_write_element_string(writer
,
1752 mi_lttng_element_snapshot_ctrl_url
, output
->ctrl_url
);
1757 /* Snapshot added for session "current_session_name"*/
1758 ret
= mi_lttng_writer_write_element_string(writer
,
1759 mi_lttng_element_snapshot_session_name
, current_session_name
);
1764 /* total size of all stream combined */
1765 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
1766 mi_lttng_element_snapshot_max_size
, output
->max_size
);
1771 /* Close snapshot element */
1772 ret
= mi_lttng_writer_close_element(writer
);
1779 int mi_lttng_snapshot_record(struct mi_writer
*writer
,
1780 const char *current_session_name
, const char *url
,
1781 const char *cmdline_ctrl_url
, const char *cmdline_data_url
)
1785 /* Open element snapshot */
1786 ret
= mi_lttng_writer_open_element(writer
,
1787 mi_lttng_element_command_snapshot
);
1793 * If a valid an URL was given, serialize it,
1794 * else take the command line data and ctrl urls*/
1796 /* Destination of the output (ctrl_url)*/
1797 ret
= mi_lttng_writer_write_element_string(writer
,
1798 mi_lttng_element_snapshot_ctrl_url
, url
);
1802 } else if (cmdline_ctrl_url
) {
1803 /* Destination of the output (ctrl_url)*/
1804 ret
= mi_lttng_writer_write_element_string(writer
,
1805 mi_lttng_element_snapshot_ctrl_url
, cmdline_ctrl_url
);
1810 /* Destination of the output (data_url) */
1811 ret
= mi_lttng_writer_write_element_string(writer
,
1812 mi_lttng_element_snapshot_data_url
, cmdline_data_url
);
1818 /* Close record_snapshot element */
1819 ret
= mi_lttng_writer_close_element(writer
);