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_name
= "name";
29 const char * const mi_lttng_element_command_version
= "version";
30 const char * const mi_lttng_element_command_list
= "list";
31 const char * const mi_lttng_element_command_save
= "save";
32 const char * const mi_lttng_element_command_load
= "load";
33 const char * const mi_lttng_element_command_start
= "start";
34 const char * const mi_lttng_element_command_stop
= "stop";
35 const char * const mi_lttng_element_command_create
= "create";
36 const char * const mi_lttng_element_command_output
= "output";
37 const char * const mi_lttng_element_command_success
= "success";
39 /* Strings related to version command */
40 const char * const mi_lttng_element_version
= "version";
41 const char * const mi_lttng_element_version_str
= "string";
42 const char * const mi_lttng_element_version_web
= "url";
43 const char * const mi_lttng_element_version_major
= "major";
44 const char * const mi_lttng_element_version_minor
= "minor";
45 const char * const mi_lttng_element_version_commit
= "commit";
46 const char * const mi_lttng_element_version_license
= "license";
47 const char * const mi_lttng_element_version_patch_level
= "patchLevel";
48 const char * const mi_lttng_element_version_description
= "description";
50 /* Strings related to pid */
51 const char * const mi_lttng_element_pids
= "pids";
52 const char * const mi_lttng_element_pid
= "pid";
53 const char * const mi_lttng_element_pid_id
= "id";
55 /* Strings related to save command */
56 const char * const mi_lttng_element_save
= "save";
58 /* Strings related to load command */
59 const char * const mi_lttng_element_load
= "load";
61 /* String related to a lttng_event_field */
62 const char * const mi_lttng_element_event_field
= "event_field";
63 const char * const mi_lttng_element_event_fields
= "event_fields";
65 /* General elements of mi_lttng */
66 const char * const mi_lttng_element_type_other
= "OTHER";
67 const char * const mi_lttng_element_type_integer
= "INTEGER";
68 const char * const mi_lttng_element_type_enum
= "ENUM";
69 const char * const mi_lttng_element_type_float
= "FLOAT";
70 const char * const mi_lttng_element_type_string
= "STRING";
71 const char * const mi_lttng_element_nowrite
= "nowrite";
73 /* String related to loglevel */
74 const char * const mi_lttng_loglevel_str_alert
= "TRACE_ALERT";
75 const char * const mi_lttng_loglevel_str_crit
= "TRACE_CRIT";
76 const char * const mi_lttng_loglevel_str_debug
= "TRACE_DEBUG";
77 const char * const mi_lttng_loglevel_str_debug_function
= "TRACE_DEBUG_FUNCTION";
78 const char * const mi_lttng_loglevel_str_debug_line
= "TRACE_DEBUG_LINE";
79 const char * const mi_lttng_loglevel_str_debug_module
= "TRACE_DEBUG_MODULE";
80 const char * const mi_lttng_loglevel_str_debug_process
= "TRACE_DEBUG_PROCESS";
81 const char * const mi_lttng_loglevel_str_debug_program
= "TRACE_DEBUG_PROGRAM";
82 const char * const mi_lttng_loglevel_str_debug_system
= "TRACE_DEBUG_SYSTEM";
83 const char * const mi_lttng_loglevel_str_debug_unit
= "TRACE_DEBUG_UNIT";
84 const char * const mi_lttng_loglevel_str_emerg
= "TRACE_EMERG";
85 const char * const mi_lttng_loglevel_str_err
= "TRACE_ERR";
86 const char * const mi_lttng_loglevel_str_info
= "TRACE_INFO";
87 const char * const mi_lttng_loglevel_str_notice
= "TRACE_NOTICE";
88 const char * const mi_lttng_loglevel_str_unknown
= "UNKNOWN";
89 const char * const mi_lttng_loglevel_str_warning
= "TRACE_WARNING";
91 /* String related to loglevel type */
92 const char * const mi_lttng_loglevel_type_all
= "ALL";
93 const char * const mi_lttng_loglevel_type_range
= "RANGE";
94 const char * const mi_lttng_loglevel_type_single
= "SINGLE";
95 const char * const mi_lttng_loglevel_type_unknown
= "UNKNOWN";
97 const char * const mi_lttng_element_empty
= "";
99 const char *mi_lttng_loglevel_string(int value
)
103 return mi_lttng_element_empty
;
104 case LTTNG_LOGLEVEL_EMERG
:
105 return mi_lttng_loglevel_str_emerg
;
106 case LTTNG_LOGLEVEL_ALERT
:
107 return mi_lttng_loglevel_str_alert
;
108 case LTTNG_LOGLEVEL_CRIT
:
109 return mi_lttng_loglevel_str_crit
;
110 case LTTNG_LOGLEVEL_ERR
:
111 return mi_lttng_loglevel_str_err
;
112 case LTTNG_LOGLEVEL_WARNING
:
113 return mi_lttng_loglevel_str_warning
;
114 case LTTNG_LOGLEVEL_NOTICE
:
115 return mi_lttng_loglevel_str_notice
;
116 case LTTNG_LOGLEVEL_INFO
:
117 return mi_lttng_loglevel_str_info
;
118 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
119 return mi_lttng_loglevel_str_debug_system
;
120 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
121 return mi_lttng_loglevel_str_debug_program
;
122 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
123 return mi_lttng_loglevel_str_debug_process
;
124 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
125 return mi_lttng_loglevel_str_debug_module
;
126 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
127 return mi_lttng_loglevel_str_debug_unit
;
128 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
129 return mi_lttng_loglevel_str_debug_function
;
130 case LTTNG_LOGLEVEL_DEBUG_LINE
:
131 return mi_lttng_loglevel_str_debug_line
;
132 case LTTNG_LOGLEVEL_DEBUG
:
133 return mi_lttng_loglevel_str_debug
;
135 return mi_lttng_loglevel_str_unknown
;
139 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value
)
142 case LTTNG_EVENT_LOGLEVEL_ALL
:
143 return mi_lttng_loglevel_type_all
;
144 case LTTNG_EVENT_LOGLEVEL_RANGE
:
145 return mi_lttng_loglevel_type_range
;
146 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
147 return mi_lttng_loglevel_type_single
;
149 return mi_lttng_loglevel_type_unknown
;
153 const char *mi_lttng_eventtype_string(enum lttng_event_type value
)
156 case LTTNG_EVENT_ALL
:
157 return config_event_type_all
;
158 case LTTNG_EVENT_TRACEPOINT
:
159 return config_event_type_tracepoint
;
160 case LTTNG_EVENT_PROBE
:
161 return config_event_type_probe
;
162 case LTTNG_EVENT_FUNCTION
:
163 return config_event_type_function
;
164 case LTTNG_EVENT_FUNCTION_ENTRY
:
165 return config_event_type_function_entry
;
166 case LTTNG_EVENT_SYSCALL
:
167 return config_event_type_syscall
;
168 case LTTNG_EVENT_NOOP
:
169 return config_event_type_noop
;
171 return mi_lttng_element_empty
;
175 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val
)
178 case(LTTNG_EVENT_FIELD_INTEGER
):
179 return mi_lttng_element_type_integer
;
180 case(LTTNG_EVENT_FIELD_ENUM
):
181 return mi_lttng_element_type_enum
;
182 case(LTTNG_EVENT_FIELD_FLOAT
):
183 return mi_lttng_element_type_float
;
184 case(LTTNG_EVENT_FIELD_STRING
):
185 return mi_lttng_element_type_string
;
187 return mi_lttng_element_type_other
;
191 const char *mi_lttng_domaintype_string(enum lttng_domain_type value
)
193 /* Note: This is a *duplicate* of get_domain_str from bin/lttng/utils.c */
195 case LTTNG_DOMAIN_KERNEL
:
196 return config_domain_type_kernel
;
197 case LTTNG_DOMAIN_UST
:
198 return config_domain_type_ust
;
199 case LTTNG_DOMAIN_JUL
:
200 return config_domain_type_jul
;
202 /* Should not have an unknown domain */
207 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value
)
210 case LTTNG_BUFFER_PER_PID
:
211 return config_buffer_type_per_pid
;
212 case LTTNG_BUFFER_PER_UID
:
213 return config_buffer_type_per_uid
;
214 case LTTNG_BUFFER_GLOBAL
:
215 return config_buffer_type_global
;
217 /* Should not have an unknow buffer type */
223 struct mi_writer
*mi_lttng_writer_create(int fd_output
, int mi_output_type
)
225 struct mi_writer
*mi_writer
;
227 mi_writer
= zmalloc(sizeof(struct mi_writer
));
229 PERROR("zmalloc mi_writer_create");
232 if (mi_output_type
== LTTNG_MI_XML
) {
233 mi_writer
->writer
= config_writer_create(fd_output
);
234 if (!mi_writer
->writer
) {
237 mi_writer
->type
= LTTNG_MI_XML
;
251 int mi_lttng_writer_destroy(struct mi_writer
*writer
)
260 ret
= config_writer_destroy(writer
->writer
);
271 int mi_lttng_writer_command_open(struct mi_writer
*writer
, const char *command
)
275 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_command
);
279 ret
= mi_lttng_writer_write_element_string(writer
,
280 mi_lttng_element_command_name
, command
);
286 int mi_lttng_writer_command_close(struct mi_writer
*writer
)
288 return mi_lttng_writer_close_element(writer
);
292 int mi_lttng_writer_open_element(struct mi_writer
*writer
,
293 const char *element_name
)
295 return config_writer_open_element(writer
->writer
, element_name
);
299 int mi_lttng_writer_close_element(struct mi_writer
*writer
)
301 return config_writer_close_element(writer
->writer
);
305 int mi_lttng_close_multi_element(struct mi_writer
*writer
,
306 unsigned int nb_element
)
310 if (nb_element
< 1) {
314 for (i
= 0; i
< nb_element
; i
++) {
315 ret
= mi_lttng_writer_close_element(writer
);
325 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer
*writer
,
326 const char *element_name
, uint64_t value
)
328 return config_writer_write_element_unsigned_int(writer
->writer
,
329 element_name
, value
);
333 int mi_lttng_writer_write_element_signed_int(struct mi_writer
*writer
,
334 const char *element_name
, int64_t value
)
336 return config_writer_write_element_signed_int(writer
->writer
,
337 element_name
, value
);
341 int mi_lttng_writer_write_element_bool(struct mi_writer
*writer
,
342 const char *element_name
, int value
)
344 return config_writer_write_element_bool(writer
->writer
,
345 element_name
, value
);
349 int mi_lttng_writer_write_element_string(struct mi_writer
*writer
,
350 const char *element_name
, const char *value
)
352 return config_writer_write_element_string(writer
->writer
,
353 element_name
, value
);
357 int mi_lttng_version(struct mi_writer
*writer
, struct mi_lttng_version
*version
,
358 const char *lttng_description
, const char *lttng_license
)
363 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_version
);
368 /* Version string (contain info like rc etc.) */
369 ret
= mi_lttng_writer_write_element_string(writer
,
370 mi_lttng_element_version_str
, VERSION
);
375 /* Major version number */
376 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
377 mi_lttng_element_version_major
, version
->version_major
);
382 /* Minor version number */
383 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
384 mi_lttng_element_version_minor
, version
->version_minor
);
389 /* Commit version number */
390 ret
= mi_lttng_writer_write_element_string(writer
,
391 mi_lttng_element_version_commit
, version
->version_commit
);
397 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
398 mi_lttng_element_version_patch_level
, version
->version_patchlevel
);
403 /* Name of the version */
404 ret
= mi_lttng_writer_write_element_string(writer
,
405 config_element_name
, version
->version_name
);
410 /* Description mostly related to beer... */
411 ret
= mi_lttng_writer_write_element_string(writer
,
412 mi_lttng_element_version_description
, lttng_description
);
418 ret
= mi_lttng_writer_write_element_string(writer
,
419 mi_lttng_element_version_web
, version
->package_url
);
424 /* License: free as in free beer...no...*speech* */
425 ret
= mi_lttng_writer_write_element_string(writer
,
426 mi_lttng_element_version_license
, lttng_license
);
431 /* Close version element */
432 ret
= mi_lttng_writer_close_element(writer
);
439 int mi_lttng_sessions_open(struct mi_writer
*writer
)
441 return mi_lttng_writer_open_element(writer
, config_element_sessions
);
445 int mi_lttng_session(struct mi_writer
*writer
,
446 struct lttng_session
*session
, int is_open
)
452 /* Open sessions element */
453 ret
= mi_lttng_writer_open_element(writer
,
454 config_element_session
);
459 /* Name of the session */
460 ret
= mi_lttng_writer_write_element_string(writer
,
461 config_element_name
, session
->name
);
467 ret
= mi_lttng_writer_write_element_string(writer
,
468 config_element_path
, session
->path
);
474 ret
= mi_lttng_writer_write_element_bool(writer
,
475 config_element_enabled
, session
->enabled
);
481 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
482 config_element_snapshot_mode
, session
->snapshot_mode
);
487 /* Live timer interval in usec */
488 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
489 config_element_live_timer_interval
,
490 session
->live_timer_interval
);
496 /* Closing session element */
497 ret
= mi_lttng_writer_close_element(writer
);
505 int mi_lttng_domains_open(struct mi_writer
*writer
)
507 return mi_lttng_writer_open_element(writer
, config_element_domains
);
511 int mi_lttng_domain(struct mi_writer
*writer
,
512 struct lttng_domain
*domain
, int is_open
)
515 const char *str_domain
;
516 const char *str_buffer
;
520 /* Open domain element */
521 ret
= mi_lttng_writer_open_element(writer
, config_element_domain
);
527 str_domain
= mi_lttng_domaintype_string(domain
->type
);
528 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
535 str_buffer
= mi_lttng_buffertype_string(domain
->buf_type
);
536 ret
= mi_lttng_writer_write_element_string(writer
,
537 config_element_buffer_type
, str_buffer
);
542 /* TODO: attr... not sure how to use the union.... */
545 /* Closing domain element */
546 ret
= mi_lttng_writer_close_element(writer
);
555 int mi_lttng_channels_open(struct mi_writer
*writer
)
557 return mi_lttng_writer_open_element(writer
, config_element_channels
);
561 int mi_lttng_channel(struct mi_writer
*writer
,
562 struct lttng_channel
*channel
, int is_open
)
568 /* Opening channel element */
569 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
575 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
582 ret
= mi_lttng_writer_write_element_bool(writer
,
583 config_element_enabled
, channel
->enabled
);
589 ret
= mi_lttng_channel_attr(writer
, &channel
->attr
);
595 /* Closing channel element */
596 ret
= mi_lttng_writer_close_element(writer
);
606 int mi_lttng_channel_attr(struct mi_writer
*writer
,
607 struct lttng_channel_attr
*attr
)
613 /* Opening Attributes */
614 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
620 ret
= mi_lttng_writer_write_element_string(writer
,
621 config_element_overwrite_mode
,
622 attr
->overwrite
? config_overwrite_mode_overwrite
:
623 config_overwrite_mode_discard
);
628 /* Sub buffer size in byte */
629 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
630 config_element_subbuf_size
, attr
->subbuf_size
);
635 /* Number of subbuffer (power of two) */
636 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
637 config_element_num_subbuf
,
643 /* Switch timer interval in usec */
644 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
645 config_element_switch_timer_interval
,
646 attr
->switch_timer_interval
);
651 /* Read timer interval in usec */
652 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
653 config_element_read_timer_interval
,
654 attr
->read_timer_interval
);
660 ret
= mi_lttng_writer_write_element_string(writer
,
661 config_element_output_type
,
662 attr
->output
== LTTNG_EVENT_SPLICE
?
663 config_output_type_splice
: config_output_type_mmap
);
668 /* Tracefile size in bytes */
669 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
670 config_element_tracefile_size
, attr
->tracefile_size
);
675 /* Count of tracefiles */
676 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
677 config_element_tracefile_count
,
678 attr
->tracefile_count
);
683 /* Live timer interval in usec*/
684 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
685 config_element_live_timer_interval
,
686 attr
->live_timer_interval
);
691 /* Closing attributes */
692 ret
= mi_lttng_writer_close_element(writer
);
702 int mi_lttng_event_common_attributes(struct mi_writer
*writer
,
703 struct lttng_event
*event
)
707 /* Open event element */
708 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
714 ret
= mi_lttng_writer_write_element_string(writer
,
715 config_element_name
, event
->name
);
721 ret
= mi_lttng_writer_write_element_string(writer
,
722 config_element_type
, mi_lttng_eventtype_string(event
->type
));
727 /* is event enabled */
728 ret
= mi_lttng_writer_write_element_bool(writer
,
729 config_element_enabled
, event
->enabled
);
734 /* event filter enabled? */
735 ret
= mi_lttng_writer_write_element_bool(writer
,
736 config_element_filter
, event
->filter
);
743 int mi_lttng_event_tracepoint_loglevel(struct mi_writer
*writer
,
744 struct lttng_event
*event
)
749 ret
= mi_lttng_writer_write_element_string(writer
,
750 config_element_loglevel
, mi_lttng_loglevel_string(event
->loglevel
));
755 ret
= mi_lttng_writer_write_element_string(writer
,
756 config_element_loglevel_type
,
757 mi_lttng_logleveltype_string(event
->loglevel_type
));
762 /* event exclusion filter */
763 ret
= mi_lttng_writer_write_element_bool(writer
,
764 config_element_exclusion
, event
->exclusion
);
774 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer
*writer
,
775 struct lttng_event
*event
)
777 /* event exclusion filter */
778 return mi_lttng_writer_write_element_bool(writer
,
779 config_element_exclusion
, event
->exclusion
);
783 int mi_lttng_event_function_probe(struct mi_writer
*writer
,
784 struct lttng_event
*event
)
788 if (event
->attr
.probe
.addr
!= 0) {
789 /* event probe address */
790 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
791 config_element_address
, event
->attr
.probe
.addr
);
796 /* event probe offset */
797 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
798 config_element_offset
, event
->attr
.probe
.offset
);
803 /* event probe symbol_name */
804 ret
= mi_lttng_writer_write_element_string(writer
,
805 config_element_symbol_name
, event
->attr
.probe
.symbol_name
);
815 int mi_lttng_event_function_entry(struct mi_writer
*writer
,
816 struct lttng_event
*event
)
818 /* event probe symbol_name */
819 return mi_lttng_writer_write_element_string(writer
,
820 config_element_symbol_name
, event
->attr
.ftrace
.symbol_name
);
824 int mi_lttng_events_open(struct mi_writer
*writer
)
826 return mi_lttng_writer_open_element(writer
, config_element_events
);
830 int mi_lttng_event(struct mi_writer
*writer
,
831 struct lttng_event
*event
, int is_open
)
835 ret
= mi_lttng_event_common_attributes(writer
, event
);
840 switch (event
->type
) {
841 case LTTNG_EVENT_ALL
:
842 /* We should never have "all" events in list. */
845 case LTTNG_EVENT_TRACEPOINT
:
847 if (event
->loglevel
!= -1) {
848 ret
= mi_lttng_event_tracepoint_loglevel(writer
, event
);
850 ret
= mi_lttng_event_tracepoint_no_loglevel(writer
, event
);
854 case LTTNG_EVENT_PROBE
:
855 ret
= mi_lttng_event_function_probe(writer
, event
);
857 case LTTNG_EVENT_FUNCTION_ENTRY
:
858 ret
= mi_lttng_event_function_entry(writer
, event
);
865 ret
= mi_lttng_writer_close_element(writer
);
873 int mi_lttng_pids_open(struct mi_writer
*writer
)
875 return mi_lttng_writer_open_element(writer
, mi_lttng_element_pids
);
879 int mi_lttng_pid(struct mi_writer
*writer
, pid_t pid
, const char *cmdline
,
884 /* Open element pid */
885 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_pid
);
890 /* Writing pid number */
891 ret
= mi_lttng_writer_write_element_signed_int(writer
,
892 mi_lttng_element_pid_id
, (int)pid
);
897 /* Writing name of the process */
898 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
906 ret
= mi_lttng_writer_close_element(writer
);
914 int mi_lttng_event_fields_open(struct mi_writer
*writer
)
916 return mi_lttng_writer_open_element(writer
, mi_lttng_element_event_fields
);
920 int mi_lttng_event_field(struct mi_writer
*writer
,
921 struct lttng_event_field
*field
)
925 if (!field
->field_name
[0]) {
926 /* To Review: not sure if legal david ?
927 * how should this be handle ?
934 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_field
);
939 if (!field
->field_name
[0]) {
944 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
951 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
952 mi_lttng_eventfieldtype_string(field
->type
));
958 ret
= mi_lttng_writer_write_element_signed_int(writer
,
959 mi_lttng_element_nowrite
, field
->nowrite
);
965 /* Close field element */
966 ret
= mi_lttng_writer_close_element(writer
);