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_license
= "license";
40 const char * const mi_lttng_element_version_patch_level
= "patchLevel";
41 const char * const mi_lttng_element_version_description
= "description";
43 /* Strings related to pid */
44 const char * const mi_lttng_element_pids
= "pids";
45 const char * const mi_lttng_element_pid
= "pid";
46 const char * const mi_lttng_element_pid_id
= "id";
48 /* String related to a lttng_event_field */
49 const char * const mi_lttng_element_event_field
= "event_field";
50 const char * const mi_lttng_element_event_fields
= "event_fields";
52 /* General elements of mi_lttng */
53 const char * const mi_lttng_element_type_other
= "OTHER";
54 const char * const mi_lttng_element_type_integer
= "INTEGER";
55 const char * const mi_lttng_element_type_enum
= "ENUM";
56 const char * const mi_lttng_element_type_float
= "FLOAT";
57 const char * const mi_lttng_element_type_string
= "STRING";
58 const char * const mi_lttng_element_nowrite
= "nowrite";
60 /* String related to loglevel */
61 const char * const mi_lttng_loglevel_str_alert
= "TRACE_ALERT";
62 const char * const mi_lttng_loglevel_str_crit
= "TRACE_CRIT";
63 const char * const mi_lttng_loglevel_str_debug
= "TRACE_DEBUG";
64 const char * const mi_lttng_loglevel_str_debug_function
= "TRACE_DEBUG_FUNCTION";
65 const char * const mi_lttng_loglevel_str_debug_line
= "TRACE_DEBUG_LINE";
66 const char * const mi_lttng_loglevel_str_debug_module
= "TRACE_DEBUG_MODULE";
67 const char * const mi_lttng_loglevel_str_debug_process
= "TRACE_DEBUG_PROCESS";
68 const char * const mi_lttng_loglevel_str_debug_program
= "TRACE_DEBUG_PROGRAM";
69 const char * const mi_lttng_loglevel_str_debug_system
= "TRACE_DEBUG_SYSTEM";
70 const char * const mi_lttng_loglevel_str_debug_unit
= "TRACE_DEBUG_UNIT";
71 const char * const mi_lttng_loglevel_str_emerg
= "TRACE_EMERG";
72 const char * const mi_lttng_loglevel_str_err
= "TRACE_ERR";
73 const char * const mi_lttng_loglevel_str_info
= "TRACE_INFO";
74 const char * const mi_lttng_loglevel_str_notice
= "TRACE_NOTICE";
75 const char * const mi_lttng_loglevel_str_unknown
= "UNKNOWN";
76 const char * const mi_lttng_loglevel_str_warning
= "TRACE_WARNING";
78 const char * const mi_lttng_loglevel_type_all
= "ALL";
79 const char * const mi_lttng_loglevel_type_range
= "RANGE";
80 const char * const mi_lttng_loglevel_type_single
= "SINGLE";
81 const char * const mi_lttng_loglevel_type_unknown
= "UNKNOWN";
83 const char * const mi_lttng_element_empty
= "";
85 const char *mi_lttng_loglevel_string(int value
)
89 return mi_lttng_element_empty
;
90 case LTTNG_LOGLEVEL_EMERG
:
91 return mi_lttng_loglevel_str_emerg
;
92 case LTTNG_LOGLEVEL_ALERT
:
93 return mi_lttng_loglevel_str_alert
;
94 case LTTNG_LOGLEVEL_CRIT
:
95 return mi_lttng_loglevel_str_crit
;
96 case LTTNG_LOGLEVEL_ERR
:
97 return mi_lttng_loglevel_str_err
;
98 case LTTNG_LOGLEVEL_WARNING
:
99 return mi_lttng_loglevel_str_warning
;
100 case LTTNG_LOGLEVEL_NOTICE
:
101 return mi_lttng_loglevel_str_notice
;
102 case LTTNG_LOGLEVEL_INFO
:
103 return mi_lttng_loglevel_str_info
;
104 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
105 return mi_lttng_loglevel_str_debug_system
;
106 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
107 return mi_lttng_loglevel_str_debug_program
;
108 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
109 return mi_lttng_loglevel_str_debug_process
;
110 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
111 return mi_lttng_loglevel_str_debug_module
;
112 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
113 return mi_lttng_loglevel_str_debug_unit
;
114 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
115 return mi_lttng_loglevel_str_debug_function
;
116 case LTTNG_LOGLEVEL_DEBUG_LINE
:
117 return mi_lttng_loglevel_str_debug_line
;
118 case LTTNG_LOGLEVEL_DEBUG
:
119 return mi_lttng_loglevel_str_debug
;
121 return mi_lttng_loglevel_str_unknown
;
125 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value
)
128 case LTTNG_EVENT_LOGLEVEL_ALL
:
129 return mi_lttng_loglevel_type_all
;
130 case LTTNG_EVENT_LOGLEVEL_RANGE
:
131 return mi_lttng_loglevel_type_range
;
132 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
133 return mi_lttng_loglevel_type_single
;
135 return mi_lttng_loglevel_type_unknown
;
139 const char *mi_lttng_eventtype_string(enum lttng_event_type value
)
142 case LTTNG_EVENT_ALL
:
143 return config_event_type_all
;
144 case LTTNG_EVENT_TRACEPOINT
:
145 return config_event_type_tracepoint
;
146 case LTTNG_EVENT_PROBE
:
147 return config_event_type_probe
;
148 case LTTNG_EVENT_FUNCTION
:
149 return config_event_type_function
;
150 case LTTNG_EVENT_FUNCTION_ENTRY
:
151 return config_event_type_function_entry
;
152 case LTTNG_EVENT_SYSCALL
:
153 return config_event_type_syscall
;
154 case LTTNG_EVENT_NOOP
:
155 return config_event_type_noop
;
157 return mi_lttng_element_empty
;
161 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val
)
164 case(LTTNG_EVENT_FIELD_INTEGER
):
165 return mi_lttng_element_type_integer
;
166 case(LTTNG_EVENT_FIELD_ENUM
):
167 return mi_lttng_element_type_enum
;
168 case(LTTNG_EVENT_FIELD_FLOAT
):
169 return mi_lttng_element_type_float
;
170 case(LTTNG_EVENT_FIELD_STRING
):
171 return mi_lttng_element_type_string
;
173 return mi_lttng_element_type_other
;
177 const char *mi_lttng_domaintype_string(enum lttng_domain_type value
)
179 /* Note: This is a *duplicate* of get_domain_str from bin/lttng/utils.c */
181 case LTTNG_DOMAIN_KERNEL
:
182 return config_domain_type_kernel
;
183 case LTTNG_DOMAIN_UST
:
184 return config_domain_type_ust
;
185 case LTTNG_DOMAIN_JUL
:
186 return config_domain_type_jul
;
188 /* Should not have an unknown domain */
193 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value
)
196 case LTTNG_BUFFER_PER_PID
:
197 return config_buffer_type_per_pid
;
198 case LTTNG_BUFFER_PER_UID
:
199 return config_buffer_type_per_uid
;
200 case LTTNG_BUFFER_GLOBAL
:
201 return config_buffer_type_global
;
203 /* Should not have an unknow buffer type */
209 struct mi_writer
*mi_lttng_writer_create(int fd_output
, int mi_output_type
)
211 struct mi_writer
*mi_writer
;
213 mi_writer
= zmalloc(sizeof(struct mi_writer
));
215 PERROR("zmalloc mi_writer_create");
218 if (mi_output_type
== LTTNG_MI_XML
) {
219 mi_writer
->writer
= config_writer_create(fd_output
);
220 if (!mi_writer
->writer
) {
223 mi_writer
->type
= LTTNG_MI_XML
;
237 int mi_lttng_writer_destroy(struct mi_writer
*writer
)
246 ret
= config_writer_destroy(writer
->writer
);
257 int mi_lttng_writer_command_open(struct mi_writer
*writer
, const char *command
)
261 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_command
);
265 ret
= mi_lttng_writer_write_element_string(writer
,
266 mi_lttng_element_command_name
, command
);
272 int mi_lttng_writer_command_close(struct mi_writer
*writer
)
274 return mi_lttng_writer_close_element(writer
);
278 int mi_lttng_writer_open_element(struct mi_writer
*writer
,
279 const char *element_name
)
281 return config_writer_open_element(writer
->writer
, element_name
);
285 int mi_lttng_writer_close_element(struct mi_writer
*writer
)
287 return config_writer_close_element(writer
->writer
);
291 int mi_lttng_close_multi_element(struct mi_writer
*writer
,
292 unsigned int nb_element
)
296 if (nb_element
< 1) {
300 for (i
= 0; i
< nb_element
; i
++) {
301 ret
= mi_lttng_writer_close_element(writer
);
311 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer
*writer
,
312 const char *element_name
, uint64_t value
)
314 return config_writer_write_element_unsigned_int(writer
->writer
,
315 element_name
, value
);
319 int mi_lttng_writer_write_element_signed_int(struct mi_writer
*writer
,
320 const char *element_name
, int64_t value
)
322 return config_writer_write_element_signed_int(writer
->writer
,
323 element_name
, value
);
327 int mi_lttng_writer_write_element_bool(struct mi_writer
*writer
,
328 const char *element_name
, int value
)
330 return config_writer_write_element_bool(writer
->writer
,
331 element_name
, value
);
335 int mi_lttng_writer_write_element_string(struct mi_writer
*writer
,
336 const char *element_name
, const char *value
)
338 return config_writer_write_element_string(writer
->writer
,
339 element_name
, value
);
343 int mi_lttng_version(struct mi_writer
*writer
, struct mi_lttng_version
*version
,
344 const char *lttng_description
, const char *lttng_license
)
349 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_version
);
354 /* Version string (contain info like rc etc.) */
355 ret
= mi_lttng_writer_write_element_string(writer
,
356 mi_lttng_element_version_str
, VERSION
);
361 /* Major version number */
362 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
363 mi_lttng_element_version_major
, version
->version_major
);
368 /* Minor version number */
369 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
370 mi_lttng_element_version_minor
, version
->version_minor
);
376 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
377 mi_lttng_element_version_patch_level
, version
->version_patchlevel
);
382 /* Name of the version */
383 ret
= mi_lttng_writer_write_element_string(writer
,
384 config_element_name
, version
->version_name
);
389 /* Description mostly related to beer... */
390 ret
= mi_lttng_writer_write_element_string(writer
,
391 mi_lttng_element_version_description
, lttng_description
);
397 ret
= mi_lttng_writer_write_element_string(writer
,
398 mi_lttng_element_version_web
, version
->package_url
);
403 /* License: free as in free beer...no...*speech* */
404 ret
= mi_lttng_writer_write_element_string(writer
,
405 mi_lttng_element_version_license
, lttng_license
);
410 /* Close version element */
411 ret
= mi_lttng_writer_close_element(writer
);
418 int mi_lttng_sessions_open(struct mi_writer
*writer
)
420 return mi_lttng_writer_open_element(writer
, config_element_sessions
);
424 int mi_lttng_session(struct mi_writer
*writer
,
425 struct lttng_session
*session
, int is_open
)
431 /* Open sessions element */
432 ret
= mi_lttng_writer_open_element(writer
,
433 config_element_session
);
438 /* Name of the session */
439 ret
= mi_lttng_writer_write_element_string(writer
,
440 config_element_name
, session
->name
);
446 ret
= mi_lttng_writer_write_element_string(writer
,
447 config_element_path
, session
->path
);
453 ret
= mi_lttng_writer_write_element_bool(writer
,
454 config_element_enabled
, session
->enabled
);
460 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
461 config_element_snapshot_mode
, session
->snapshot_mode
);
466 /* Live timer interval in usec */
467 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
468 config_element_live_timer_interval
,
469 session
->live_timer_interval
);
475 /* Closing session element */
476 ret
= mi_lttng_writer_close_element(writer
);
484 int mi_lttng_domains_open(struct mi_writer
*writer
)
486 return mi_lttng_writer_open_element(writer
, config_element_domains
);
490 int mi_lttng_domain(struct mi_writer
*writer
,
491 struct lttng_domain
*domain
, int is_open
)
494 const char *str_domain
;
495 const char *str_buffer
;
499 /* Open domain element */
500 ret
= mi_lttng_writer_open_element(writer
, config_element_domain
);
506 str_domain
= mi_lttng_domaintype_string(domain
->type
);
507 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
514 str_buffer
= mi_lttng_buffertype_string(domain
->buf_type
);
515 ret
= mi_lttng_writer_write_element_string(writer
,
516 config_element_buffer_type
, str_buffer
);
521 /* TODO: attr... not sure how to use the union.... */
524 /* Closing domain element */
525 ret
= mi_lttng_writer_close_element(writer
);
534 int mi_lttng_channels_open(struct mi_writer
*writer
)
536 return mi_lttng_writer_open_element(writer
, config_element_channels
);
540 int mi_lttng_channel(struct mi_writer
*writer
,
541 struct lttng_channel
*channel
, int is_open
)
547 /* Opening channel element */
548 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
554 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
561 ret
= mi_lttng_writer_write_element_bool(writer
,
562 config_element_enabled
, channel
->enabled
);
568 ret
= mi_lttng_channel_attr(writer
, &channel
->attr
);
574 /* Closing channel element */
575 ret
= mi_lttng_writer_close_element(writer
);
585 int mi_lttng_channel_attr(struct mi_writer
*writer
,
586 struct lttng_channel_attr
*attr
)
592 /* Opening Attributes */
593 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
599 ret
= mi_lttng_writer_write_element_string(writer
,
600 config_element_overwrite_mode
,
601 attr
->overwrite
? config_overwrite_mode_overwrite
:
602 config_overwrite_mode_discard
);
607 /* Sub buffer size in byte */
608 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
609 config_element_subbuf_size
, attr
->subbuf_size
);
614 /* Number of subbuffer (power of two) */
615 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
616 config_element_num_subbuf
,
622 /* Switch timer interval in usec */
623 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
624 config_element_switch_timer_interval
,
625 attr
->switch_timer_interval
);
630 /* Read timer interval in usec */
631 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
632 config_element_read_timer_interval
,
633 attr
->read_timer_interval
);
639 ret
= mi_lttng_writer_write_element_string(writer
,
640 config_element_output_type
,
641 attr
->output
== LTTNG_EVENT_SPLICE
?
642 config_output_type_splice
: config_output_type_mmap
);
647 /* Tracefile size in bytes */
648 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
649 config_element_tracefile_size
, attr
->tracefile_size
);
654 /* Count of tracefiles */
655 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
656 config_element_tracefile_count
,
657 attr
->tracefile_count
);
662 /* Live timer interval in usec*/
663 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
664 config_element_live_timer_interval
,
665 attr
->live_timer_interval
);
670 /* Closing attributes */
671 ret
= mi_lttng_writer_close_element(writer
);
681 int mi_lttng_event_common_attributes(struct mi_writer
*writer
,
682 struct lttng_event
*event
)
686 /* Open event element */
687 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
693 ret
= mi_lttng_writer_write_element_string(writer
,
694 config_element_name
, event
->name
);
700 ret
= mi_lttng_writer_write_element_string(writer
,
701 config_element_type
, mi_lttng_eventtype_string(event
->type
));
706 /* is event enabled */
707 ret
= mi_lttng_writer_write_element_bool(writer
,
708 config_element_enabled
, event
->enabled
);
713 /* event filter enabled? */
714 ret
= mi_lttng_writer_write_element_bool(writer
,
715 config_element_filter
, event
->filter
);
722 int mi_lttng_event_tracepoint_loglevel(struct mi_writer
*writer
,
723 struct lttng_event
*event
)
728 ret
= mi_lttng_writer_write_element_string(writer
,
729 config_element_loglevel
, mi_lttng_loglevel_string(event
->loglevel
));
734 ret
= mi_lttng_writer_write_element_string(writer
,
735 config_element_loglevel_type
,
736 mi_lttng_logleveltype_string(event
->loglevel_type
));
741 /* event exclusion filter */
742 ret
= mi_lttng_writer_write_element_bool(writer
,
743 config_element_exclusion
, event
->exclusion
);
753 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer
*writer
,
754 struct lttng_event
*event
)
756 /* event exclusion filter */
757 return mi_lttng_writer_write_element_bool(writer
,
758 config_element_exclusion
, event
->exclusion
);
762 int mi_lttng_event_function_probe(struct mi_writer
*writer
,
763 struct lttng_event
*event
)
767 if (event
->attr
.probe
.addr
!= 0) {
768 /* event probe address */
769 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
770 config_element_address
, event
->attr
.probe
.addr
);
775 /* event probe offset */
776 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
777 config_element_offset
, event
->attr
.probe
.offset
);
782 /* event probe symbol_name */
783 ret
= mi_lttng_writer_write_element_string(writer
,
784 config_element_symbol_name
, event
->attr
.probe
.symbol_name
);
794 int mi_lttng_event_function_entry(struct mi_writer
*writer
,
795 struct lttng_event
*event
)
797 /* event probe symbol_name */
798 return mi_lttng_writer_write_element_string(writer
,
799 config_element_symbol_name
, event
->attr
.ftrace
.symbol_name
);
803 int mi_lttng_events_open(struct mi_writer
*writer
)
805 return mi_lttng_writer_open_element(writer
, config_element_events
);
809 int mi_lttng_event(struct mi_writer
*writer
,
810 struct lttng_event
*event
, int is_open
)
814 ret
= mi_lttng_event_common_attributes(writer
, event
);
819 switch (event
->type
) {
820 case LTTNG_EVENT_ALL
:
821 /* We should never have "all" events in list. */
824 case LTTNG_EVENT_TRACEPOINT
:
826 if (event
->loglevel
!= -1) {
827 ret
= mi_lttng_event_tracepoint_loglevel(writer
, event
);
829 ret
= mi_lttng_event_tracepoint_no_loglevel(writer
, event
);
833 case LTTNG_EVENT_PROBE
:
834 ret
= mi_lttng_event_function_probe(writer
, event
);
836 case LTTNG_EVENT_FUNCTION_ENTRY
:
837 ret
= mi_lttng_event_function_entry(writer
, event
);
844 ret
= mi_lttng_writer_close_element(writer
);
852 int mi_lttng_pids_open(struct mi_writer
*writer
)
854 return mi_lttng_writer_open_element(writer
, mi_lttng_element_pids
);
858 int mi_lttng_pid(struct mi_writer
*writer
, pid_t pid
, const char *cmdline
,
863 /* Open element pid */
864 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_pid
);
869 /* Writing pid number */
870 ret
= mi_lttng_writer_write_element_signed_int(writer
,
871 mi_lttng_element_pid_id
, (int)pid
);
876 /* Writing name of the process */
877 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
885 ret
= mi_lttng_writer_close_element(writer
);
893 int mi_lttng_event_fields_open(struct mi_writer
*writer
)
895 return mi_lttng_writer_open_element(writer
, mi_lttng_element_event_fields
);
899 int mi_lttng_event_field(struct mi_writer
*writer
,
900 struct lttng_event_field
*field
)
904 if (!field
->field_name
[0]) {
905 /* To Review: not sure if legal david ?
906 * how should this be handle ?
913 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_field
);
918 if (!field
->field_name
[0]) {
923 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
930 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
931 mi_lttng_eventfieldtype_string(field
->type
));
937 ret
= mi_lttng_writer_write_element_signed_int(writer
,
938 mi_lttng_element_nowrite
, field
->nowrite
);
944 /* Close field element */
945 ret
= mi_lttng_writer_close_element(writer
);