2 * Copyright (C) 2014 - Jonathan Rajotte <jonathan.r.julien@gmail.com>
3 * - Olivier Cotte <olivier.cotte@polymtl.ca>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include <include/config.h>
21 #include <common/config/config.h>
26 /* Strings related to command */
27 const char * const mi_lttng_element_command
= "command";
28 const char * const mi_lttng_element_command_version
= "version";
29 const char * const mi_lttng_element_command_list
= "list";
30 const char * const mi_lttng_element_command_name
= "name";
31 const char * const mi_lttng_element_command_output
= "output";
33 /* Strings related to command: version */
34 const char * const mi_lttng_element_version
= "version";
35 const char * const mi_lttng_element_version_str
= "string";
36 const char * const mi_lttng_element_version_web
= "url";
37 const char * const mi_lttng_element_version_major
= "major";
38 const char * const mi_lttng_element_version_minor
= "minor";
39 const char * const mi_lttng_element_version_commit
= "commit";
40 const char * const mi_lttng_element_version_license
= "license";
41 const char * const mi_lttng_element_version_patch_level
= "patchLevel";
42 const char * const mi_lttng_element_version_description
= "description";
44 /* Strings related to pid */
45 const char * const mi_lttng_element_pids
= "pids";
46 const char * const mi_lttng_element_pid
= "pid";
47 const char * const mi_lttng_element_pid_id
= "id";
49 /* String related to a lttng_event_field */
50 const char * const mi_lttng_element_event_field
= "event_field";
51 const char * const mi_lttng_element_event_fields
= "event_fields";
53 /* General elements of mi_lttng */
54 const char * const mi_lttng_element_type_other
= "OTHER";
55 const char * const mi_lttng_element_type_integer
= "INTEGER";
56 const char * const mi_lttng_element_type_enum
= "ENUM";
57 const char * const mi_lttng_element_type_float
= "FLOAT";
58 const char * const mi_lttng_element_type_string
= "STRING";
59 const char * const mi_lttng_element_nowrite
= "nowrite";
61 /* String related to loglevel */
62 const char * const mi_lttng_loglevel_str_alert
= "TRACE_ALERT";
63 const char * const mi_lttng_loglevel_str_crit
= "TRACE_CRIT";
64 const char * const mi_lttng_loglevel_str_debug
= "TRACE_DEBUG";
65 const char * const mi_lttng_loglevel_str_debug_function
= "TRACE_DEBUG_FUNCTION";
66 const char * const mi_lttng_loglevel_str_debug_line
= "TRACE_DEBUG_LINE";
67 const char * const mi_lttng_loglevel_str_debug_module
= "TRACE_DEBUG_MODULE";
68 const char * const mi_lttng_loglevel_str_debug_process
= "TRACE_DEBUG_PROCESS";
69 const char * const mi_lttng_loglevel_str_debug_program
= "TRACE_DEBUG_PROGRAM";
70 const char * const mi_lttng_loglevel_str_debug_system
= "TRACE_DEBUG_SYSTEM";
71 const char * const mi_lttng_loglevel_str_debug_unit
= "TRACE_DEBUG_UNIT";
72 const char * const mi_lttng_loglevel_str_emerg
= "TRACE_EMERG";
73 const char * const mi_lttng_loglevel_str_err
= "TRACE_ERR";
74 const char * const mi_lttng_loglevel_str_info
= "TRACE_INFO";
75 const char * const mi_lttng_loglevel_str_notice
= "TRACE_NOTICE";
76 const char * const mi_lttng_loglevel_str_unknown
= "UNKNOWN";
77 const char * const mi_lttng_loglevel_str_warning
= "TRACE_WARNING";
79 const char * const mi_lttng_loglevel_type_all
= "ALL";
80 const char * const mi_lttng_loglevel_type_range
= "RANGE";
81 const char * const mi_lttng_loglevel_type_single
= "SINGLE";
82 const char * const mi_lttng_loglevel_type_unknown
= "UNKNOWN";
84 const char * const mi_lttng_element_empty
= "";
86 const char *mi_lttng_loglevel_string(int value
)
90 return mi_lttng_element_empty
;
91 case LTTNG_LOGLEVEL_EMERG
:
92 return mi_lttng_loglevel_str_emerg
;
93 case LTTNG_LOGLEVEL_ALERT
:
94 return mi_lttng_loglevel_str_alert
;
95 case LTTNG_LOGLEVEL_CRIT
:
96 return mi_lttng_loglevel_str_crit
;
97 case LTTNG_LOGLEVEL_ERR
:
98 return mi_lttng_loglevel_str_err
;
99 case LTTNG_LOGLEVEL_WARNING
:
100 return mi_lttng_loglevel_str_warning
;
101 case LTTNG_LOGLEVEL_NOTICE
:
102 return mi_lttng_loglevel_str_notice
;
103 case LTTNG_LOGLEVEL_INFO
:
104 return mi_lttng_loglevel_str_info
;
105 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
106 return mi_lttng_loglevel_str_debug_system
;
107 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
108 return mi_lttng_loglevel_str_debug_program
;
109 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
110 return mi_lttng_loglevel_str_debug_process
;
111 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
112 return mi_lttng_loglevel_str_debug_module
;
113 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
114 return mi_lttng_loglevel_str_debug_unit
;
115 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
116 return mi_lttng_loglevel_str_debug_function
;
117 case LTTNG_LOGLEVEL_DEBUG_LINE
:
118 return mi_lttng_loglevel_str_debug_line
;
119 case LTTNG_LOGLEVEL_DEBUG
:
120 return mi_lttng_loglevel_str_debug
;
122 return mi_lttng_loglevel_str_unknown
;
126 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value
)
129 case LTTNG_EVENT_LOGLEVEL_ALL
:
130 return mi_lttng_loglevel_type_all
;
131 case LTTNG_EVENT_LOGLEVEL_RANGE
:
132 return mi_lttng_loglevel_type_range
;
133 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
134 return mi_lttng_loglevel_type_single
;
136 return mi_lttng_loglevel_type_unknown
;
140 const char *mi_lttng_eventtype_string(enum lttng_event_type value
)
143 case LTTNG_EVENT_ALL
:
144 return config_event_type_all
;
145 case LTTNG_EVENT_TRACEPOINT
:
146 return config_event_type_tracepoint
;
147 case LTTNG_EVENT_PROBE
:
148 return config_event_type_probe
;
149 case LTTNG_EVENT_FUNCTION
:
150 return config_event_type_function
;
151 case LTTNG_EVENT_FUNCTION_ENTRY
:
152 return config_event_type_function_entry
;
153 case LTTNG_EVENT_SYSCALL
:
154 return config_event_type_syscall
;
155 case LTTNG_EVENT_NOOP
:
156 return config_event_type_noop
;
158 return mi_lttng_element_empty
;
162 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val
)
165 case(LTTNG_EVENT_FIELD_INTEGER
):
166 return mi_lttng_element_type_integer
;
167 case(LTTNG_EVENT_FIELD_ENUM
):
168 return mi_lttng_element_type_enum
;
169 case(LTTNG_EVENT_FIELD_FLOAT
):
170 return mi_lttng_element_type_float
;
171 case(LTTNG_EVENT_FIELD_STRING
):
172 return mi_lttng_element_type_string
;
174 return mi_lttng_element_type_other
;
178 const char *mi_lttng_domaintype_string(enum lttng_domain_type value
)
180 /* Note: This is a *duplicate* of get_domain_str from bin/lttng/utils.c */
182 case LTTNG_DOMAIN_KERNEL
:
183 return config_domain_type_kernel
;
184 case LTTNG_DOMAIN_UST
:
185 return config_domain_type_ust
;
186 case LTTNG_DOMAIN_JUL
:
187 return config_domain_type_jul
;
189 /* Should not have an unknown domain */
194 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value
)
197 case LTTNG_BUFFER_PER_PID
:
198 return config_buffer_type_per_pid
;
199 case LTTNG_BUFFER_PER_UID
:
200 return config_buffer_type_per_uid
;
201 case LTTNG_BUFFER_GLOBAL
:
202 return config_buffer_type_global
;
204 /* Should not have an unknow buffer type */
210 struct mi_writer
*mi_lttng_writer_create(int fd_output
, int mi_output_type
)
212 struct mi_writer
*mi_writer
;
214 mi_writer
= zmalloc(sizeof(struct mi_writer
));
216 PERROR("zmalloc mi_writer_create");
219 if (mi_output_type
== LTTNG_MI_XML
) {
220 mi_writer
->writer
= config_writer_create(fd_output
);
221 if (!mi_writer
->writer
) {
224 mi_writer
->type
= LTTNG_MI_XML
;
238 int mi_lttng_writer_destroy(struct mi_writer
*writer
)
247 ret
= config_writer_destroy(writer
->writer
);
258 int mi_lttng_writer_command_open(struct mi_writer
*writer
, const char *command
)
262 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_command
);
266 ret
= mi_lttng_writer_write_element_string(writer
,
267 mi_lttng_element_command_name
, command
);
273 int mi_lttng_writer_command_close(struct mi_writer
*writer
)
275 return mi_lttng_writer_close_element(writer
);
279 int mi_lttng_writer_open_element(struct mi_writer
*writer
,
280 const char *element_name
)
282 return config_writer_open_element(writer
->writer
, element_name
);
286 int mi_lttng_writer_close_element(struct mi_writer
*writer
)
288 return config_writer_close_element(writer
->writer
);
292 int mi_lttng_close_multi_element(struct mi_writer
*writer
,
293 unsigned int nb_element
)
297 if (nb_element
< 1) {
301 for (i
= 0; i
< nb_element
; i
++) {
302 ret
= mi_lttng_writer_close_element(writer
);
312 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer
*writer
,
313 const char *element_name
, uint64_t value
)
315 return config_writer_write_element_unsigned_int(writer
->writer
,
316 element_name
, value
);
320 int mi_lttng_writer_write_element_signed_int(struct mi_writer
*writer
,
321 const char *element_name
, int64_t value
)
323 return config_writer_write_element_signed_int(writer
->writer
,
324 element_name
, value
);
328 int mi_lttng_writer_write_element_bool(struct mi_writer
*writer
,
329 const char *element_name
, int value
)
331 return config_writer_write_element_bool(writer
->writer
,
332 element_name
, value
);
336 int mi_lttng_writer_write_element_string(struct mi_writer
*writer
,
337 const char *element_name
, const char *value
)
339 return config_writer_write_element_string(writer
->writer
,
340 element_name
, value
);
344 int mi_lttng_version(struct mi_writer
*writer
, struct mi_lttng_version
*version
,
345 const char *lttng_description
, const char *lttng_license
)
350 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_version
);
355 /* Version string (contain info like rc etc.) */
356 ret
= mi_lttng_writer_write_element_string(writer
,
357 mi_lttng_element_version_str
, VERSION
);
362 /* Major version number */
363 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
364 mi_lttng_element_version_major
, version
->version_major
);
369 /* Minor version number */
370 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
371 mi_lttng_element_version_minor
, version
->version_minor
);
376 /* Commit version number */
377 ret
= mi_lttng_writer_write_element_string(writer
,
378 mi_lttng_element_version_commit
, version
->version_commit
);
384 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
385 mi_lttng_element_version_patch_level
, version
->version_patchlevel
);
390 /* Name of the version */
391 ret
= mi_lttng_writer_write_element_string(writer
,
392 config_element_name
, version
->version_name
);
397 /* Description mostly related to beer... */
398 ret
= mi_lttng_writer_write_element_string(writer
,
399 mi_lttng_element_version_description
, lttng_description
);
405 ret
= mi_lttng_writer_write_element_string(writer
,
406 mi_lttng_element_version_web
, version
->package_url
);
411 /* License: free as in free beer...no...*speech* */
412 ret
= mi_lttng_writer_write_element_string(writer
,
413 mi_lttng_element_version_license
, lttng_license
);
418 /* Close version element */
419 ret
= mi_lttng_writer_close_element(writer
);
426 int mi_lttng_sessions_open(struct mi_writer
*writer
)
428 return mi_lttng_writer_open_element(writer
, config_element_sessions
);
432 int mi_lttng_session(struct mi_writer
*writer
,
433 struct lttng_session
*session
, int is_open
)
439 /* Open sessions element */
440 ret
= mi_lttng_writer_open_element(writer
,
441 config_element_session
);
446 /* Name of the session */
447 ret
= mi_lttng_writer_write_element_string(writer
,
448 config_element_name
, session
->name
);
454 ret
= mi_lttng_writer_write_element_string(writer
,
455 config_element_path
, session
->path
);
461 ret
= mi_lttng_writer_write_element_bool(writer
,
462 config_element_enabled
, session
->enabled
);
468 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
469 config_element_snapshot_mode
, session
->snapshot_mode
);
474 /* Live timer interval in usec */
475 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
476 config_element_live_timer_interval
,
477 session
->live_timer_interval
);
483 /* Closing session element */
484 ret
= mi_lttng_writer_close_element(writer
);
492 int mi_lttng_domains_open(struct mi_writer
*writer
)
494 return mi_lttng_writer_open_element(writer
, config_element_domains
);
498 int mi_lttng_domain(struct mi_writer
*writer
,
499 struct lttng_domain
*domain
, int is_open
)
502 const char *str_domain
;
503 const char *str_buffer
;
507 /* Open domain element */
508 ret
= mi_lttng_writer_open_element(writer
, config_element_domain
);
514 str_domain
= mi_lttng_domaintype_string(domain
->type
);
515 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
522 str_buffer
= mi_lttng_buffertype_string(domain
->buf_type
);
523 ret
= mi_lttng_writer_write_element_string(writer
,
524 config_element_buffer_type
, str_buffer
);
529 /* TODO: attr... not sure how to use the union.... */
532 /* Closing domain element */
533 ret
= mi_lttng_writer_close_element(writer
);
542 int mi_lttng_channels_open(struct mi_writer
*writer
)
544 return mi_lttng_writer_open_element(writer
, config_element_channels
);
548 int mi_lttng_channel(struct mi_writer
*writer
,
549 struct lttng_channel
*channel
, int is_open
)
555 /* Opening channel element */
556 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
562 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
569 ret
= mi_lttng_writer_write_element_bool(writer
,
570 config_element_enabled
, channel
->enabled
);
576 ret
= mi_lttng_channel_attr(writer
, &channel
->attr
);
582 /* Closing channel element */
583 ret
= mi_lttng_writer_close_element(writer
);
593 int mi_lttng_channel_attr(struct mi_writer
*writer
,
594 struct lttng_channel_attr
*attr
)
600 /* Opening Attributes */
601 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
607 ret
= mi_lttng_writer_write_element_string(writer
,
608 config_element_overwrite_mode
,
609 attr
->overwrite
? config_overwrite_mode_overwrite
:
610 config_overwrite_mode_discard
);
615 /* Sub buffer size in byte */
616 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
617 config_element_subbuf_size
, attr
->subbuf_size
);
622 /* Number of subbuffer (power of two) */
623 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
624 config_element_num_subbuf
,
630 /* Switch timer interval in usec */
631 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
632 config_element_switch_timer_interval
,
633 attr
->switch_timer_interval
);
638 /* Read timer interval in usec */
639 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
640 config_element_read_timer_interval
,
641 attr
->read_timer_interval
);
647 ret
= mi_lttng_writer_write_element_string(writer
,
648 config_element_output_type
,
649 attr
->output
== LTTNG_EVENT_SPLICE
?
650 config_output_type_splice
: config_output_type_mmap
);
655 /* Tracefile size in bytes */
656 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
657 config_element_tracefile_size
, attr
->tracefile_size
);
662 /* Count of tracefiles */
663 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
664 config_element_tracefile_count
,
665 attr
->tracefile_count
);
670 /* Live timer interval in usec*/
671 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
672 config_element_live_timer_interval
,
673 attr
->live_timer_interval
);
678 /* Closing attributes */
679 ret
= mi_lttng_writer_close_element(writer
);
689 int mi_lttng_event_common_attributes(struct mi_writer
*writer
,
690 struct lttng_event
*event
)
694 /* Open event element */
695 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
701 ret
= mi_lttng_writer_write_element_string(writer
,
702 config_element_name
, event
->name
);
708 ret
= mi_lttng_writer_write_element_string(writer
,
709 config_element_type
, mi_lttng_eventtype_string(event
->type
));
714 /* is event enabled */
715 ret
= mi_lttng_writer_write_element_bool(writer
,
716 config_element_enabled
, event
->enabled
);
721 /* event filter enabled? */
722 ret
= mi_lttng_writer_write_element_bool(writer
,
723 config_element_filter
, event
->filter
);
730 int mi_lttng_event_tracepoint_loglevel(struct mi_writer
*writer
,
731 struct lttng_event
*event
)
736 ret
= mi_lttng_writer_write_element_string(writer
,
737 config_element_loglevel
, mi_lttng_loglevel_string(event
->loglevel
));
742 ret
= mi_lttng_writer_write_element_string(writer
,
743 config_element_loglevel_type
,
744 mi_lttng_logleveltype_string(event
->loglevel_type
));
749 /* event exclusion filter */
750 ret
= mi_lttng_writer_write_element_bool(writer
,
751 config_element_exclusion
, event
->exclusion
);
761 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer
*writer
,
762 struct lttng_event
*event
)
764 /* event exclusion filter */
765 return mi_lttng_writer_write_element_bool(writer
,
766 config_element_exclusion
, event
->exclusion
);
770 int mi_lttng_event_function_probe(struct mi_writer
*writer
,
771 struct lttng_event
*event
)
775 if (event
->attr
.probe
.addr
!= 0) {
776 /* event probe address */
777 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
778 config_element_address
, event
->attr
.probe
.addr
);
783 /* event probe offset */
784 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
785 config_element_offset
, event
->attr
.probe
.offset
);
790 /* event probe symbol_name */
791 ret
= mi_lttng_writer_write_element_string(writer
,
792 config_element_symbol_name
, event
->attr
.probe
.symbol_name
);
802 int mi_lttng_event_function_entry(struct mi_writer
*writer
,
803 struct lttng_event
*event
)
805 /* event probe symbol_name */
806 return mi_lttng_writer_write_element_string(writer
,
807 config_element_symbol_name
, event
->attr
.ftrace
.symbol_name
);
811 int mi_lttng_events_open(struct mi_writer
*writer
)
813 return mi_lttng_writer_open_element(writer
, config_element_events
);
817 int mi_lttng_event(struct mi_writer
*writer
,
818 struct lttng_event
*event
, int is_open
)
822 ret
= mi_lttng_event_common_attributes(writer
, event
);
827 switch (event
->type
) {
828 case LTTNG_EVENT_ALL
:
829 /* We should never have "all" events in list. */
832 case LTTNG_EVENT_TRACEPOINT
:
834 if (event
->loglevel
!= -1) {
835 ret
= mi_lttng_event_tracepoint_loglevel(writer
, event
);
837 ret
= mi_lttng_event_tracepoint_no_loglevel(writer
, event
);
841 case LTTNG_EVENT_PROBE
:
842 ret
= mi_lttng_event_function_probe(writer
, event
);
844 case LTTNG_EVENT_FUNCTION_ENTRY
:
845 ret
= mi_lttng_event_function_entry(writer
, event
);
852 ret
= mi_lttng_writer_close_element(writer
);
860 int mi_lttng_pids_open(struct mi_writer
*writer
)
862 return mi_lttng_writer_open_element(writer
, mi_lttng_element_pids
);
866 int mi_lttng_pid(struct mi_writer
*writer
, pid_t pid
, const char *cmdline
,
871 /* Open element pid */
872 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_pid
);
877 /* Writing pid number */
878 ret
= mi_lttng_writer_write_element_signed_int(writer
,
879 mi_lttng_element_pid_id
, (int)pid
);
884 /* Writing name of the process */
885 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
893 ret
= mi_lttng_writer_close_element(writer
);
901 int mi_lttng_event_fields_open(struct mi_writer
*writer
)
903 return mi_lttng_writer_open_element(writer
, mi_lttng_element_event_fields
);
907 int mi_lttng_event_field(struct mi_writer
*writer
,
908 struct lttng_event_field
*field
)
912 if (!field
->field_name
[0]) {
913 /* To Review: not sure if legal david ?
914 * how should this be handle ?
921 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_field
);
926 if (!field
->field_name
[0]) {
931 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
938 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
939 mi_lttng_eventfieldtype_string(field
->type
));
945 ret
= mi_lttng_writer_write_element_signed_int(writer
,
946 mi_lttng_element_nowrite
, field
->nowrite
);
952 /* Close field element */
953 ret
= mi_lttng_writer_close_element(writer
);