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_destroy
= "destroy";
37 const char * const mi_lttng_element_command_output
= "output";
38 const char * const mi_lttng_element_command_success
= "success";
40 /* Strings related to version command */
41 const char * const mi_lttng_element_version
= "version";
42 const char * const mi_lttng_element_version_str
= "string";
43 const char * const mi_lttng_element_version_web
= "url";
44 const char * const mi_lttng_element_version_major
= "major";
45 const char * const mi_lttng_element_version_minor
= "minor";
46 const char * const mi_lttng_element_version_commit
= "commit";
47 const char * const mi_lttng_element_version_license
= "license";
48 const char * const mi_lttng_element_version_patch_level
= "patchLevel";
49 const char * const mi_lttng_element_version_description
= "description";
51 /* Strings related to pid */
52 const char * const mi_lttng_element_pids
= "pids";
53 const char * const mi_lttng_element_pid
= "pid";
54 const char * const mi_lttng_element_pid_id
= "id";
56 /* Strings related to save command */
57 const char * const mi_lttng_element_save
= "save";
59 /* Strings related to load command */
60 const char * const mi_lttng_element_load
= "load";
62 /* String related to a lttng_event_field */
63 const char * const mi_lttng_element_event_field
= "event_field";
64 const char * const mi_lttng_element_event_fields
= "event_fields";
66 /* General elements of mi_lttng */
67 const char * const mi_lttng_element_type_other
= "OTHER";
68 const char * const mi_lttng_element_type_integer
= "INTEGER";
69 const char * const mi_lttng_element_type_enum
= "ENUM";
70 const char * const mi_lttng_element_type_float
= "FLOAT";
71 const char * const mi_lttng_element_type_string
= "STRING";
72 const char * const mi_lttng_element_nowrite
= "nowrite";
74 /* String related to loglevel */
75 const char * const mi_lttng_loglevel_str_alert
= "TRACE_ALERT";
76 const char * const mi_lttng_loglevel_str_crit
= "TRACE_CRIT";
77 const char * const mi_lttng_loglevel_str_debug
= "TRACE_DEBUG";
78 const char * const mi_lttng_loglevel_str_debug_function
= "TRACE_DEBUG_FUNCTION";
79 const char * const mi_lttng_loglevel_str_debug_line
= "TRACE_DEBUG_LINE";
80 const char * const mi_lttng_loglevel_str_debug_module
= "TRACE_DEBUG_MODULE";
81 const char * const mi_lttng_loglevel_str_debug_process
= "TRACE_DEBUG_PROCESS";
82 const char * const mi_lttng_loglevel_str_debug_program
= "TRACE_DEBUG_PROGRAM";
83 const char * const mi_lttng_loglevel_str_debug_system
= "TRACE_DEBUG_SYSTEM";
84 const char * const mi_lttng_loglevel_str_debug_unit
= "TRACE_DEBUG_UNIT";
85 const char * const mi_lttng_loglevel_str_emerg
= "TRACE_EMERG";
86 const char * const mi_lttng_loglevel_str_err
= "TRACE_ERR";
87 const char * const mi_lttng_loglevel_str_info
= "TRACE_INFO";
88 const char * const mi_lttng_loglevel_str_notice
= "TRACE_NOTICE";
89 const char * const mi_lttng_loglevel_str_unknown
= "UNKNOWN";
90 const char * const mi_lttng_loglevel_str_warning
= "TRACE_WARNING";
92 /* String related to loglevel type */
93 const char * const mi_lttng_loglevel_type_all
= "ALL";
94 const char * const mi_lttng_loglevel_type_range
= "RANGE";
95 const char * const mi_lttng_loglevel_type_single
= "SINGLE";
96 const char * const mi_lttng_loglevel_type_unknown
= "UNKNOWN";
98 const char * const mi_lttng_element_empty
= "";
100 const char *mi_lttng_loglevel_string(int value
)
104 return mi_lttng_element_empty
;
105 case LTTNG_LOGLEVEL_EMERG
:
106 return mi_lttng_loglevel_str_emerg
;
107 case LTTNG_LOGLEVEL_ALERT
:
108 return mi_lttng_loglevel_str_alert
;
109 case LTTNG_LOGLEVEL_CRIT
:
110 return mi_lttng_loglevel_str_crit
;
111 case LTTNG_LOGLEVEL_ERR
:
112 return mi_lttng_loglevel_str_err
;
113 case LTTNG_LOGLEVEL_WARNING
:
114 return mi_lttng_loglevel_str_warning
;
115 case LTTNG_LOGLEVEL_NOTICE
:
116 return mi_lttng_loglevel_str_notice
;
117 case LTTNG_LOGLEVEL_INFO
:
118 return mi_lttng_loglevel_str_info
;
119 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
120 return mi_lttng_loglevel_str_debug_system
;
121 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
122 return mi_lttng_loglevel_str_debug_program
;
123 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
124 return mi_lttng_loglevel_str_debug_process
;
125 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
126 return mi_lttng_loglevel_str_debug_module
;
127 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
128 return mi_lttng_loglevel_str_debug_unit
;
129 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
130 return mi_lttng_loglevel_str_debug_function
;
131 case LTTNG_LOGLEVEL_DEBUG_LINE
:
132 return mi_lttng_loglevel_str_debug_line
;
133 case LTTNG_LOGLEVEL_DEBUG
:
134 return mi_lttng_loglevel_str_debug
;
136 return mi_lttng_loglevel_str_unknown
;
140 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value
)
143 case LTTNG_EVENT_LOGLEVEL_ALL
:
144 return mi_lttng_loglevel_type_all
;
145 case LTTNG_EVENT_LOGLEVEL_RANGE
:
146 return mi_lttng_loglevel_type_range
;
147 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
148 return mi_lttng_loglevel_type_single
;
150 return mi_lttng_loglevel_type_unknown
;
154 const char *mi_lttng_eventtype_string(enum lttng_event_type value
)
157 case LTTNG_EVENT_ALL
:
158 return config_event_type_all
;
159 case LTTNG_EVENT_TRACEPOINT
:
160 return config_event_type_tracepoint
;
161 case LTTNG_EVENT_PROBE
:
162 return config_event_type_probe
;
163 case LTTNG_EVENT_FUNCTION
:
164 return config_event_type_function
;
165 case LTTNG_EVENT_FUNCTION_ENTRY
:
166 return config_event_type_function_entry
;
167 case LTTNG_EVENT_SYSCALL
:
168 return config_event_type_syscall
;
169 case LTTNG_EVENT_NOOP
:
170 return config_event_type_noop
;
172 return mi_lttng_element_empty
;
176 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val
)
179 case(LTTNG_EVENT_FIELD_INTEGER
):
180 return mi_lttng_element_type_integer
;
181 case(LTTNG_EVENT_FIELD_ENUM
):
182 return mi_lttng_element_type_enum
;
183 case(LTTNG_EVENT_FIELD_FLOAT
):
184 return mi_lttng_element_type_float
;
185 case(LTTNG_EVENT_FIELD_STRING
):
186 return mi_lttng_element_type_string
;
188 return mi_lttng_element_type_other
;
192 const char *mi_lttng_domaintype_string(enum lttng_domain_type value
)
194 /* Note: This is a *duplicate* of get_domain_str from bin/lttng/utils.c */
196 case LTTNG_DOMAIN_KERNEL
:
197 return config_domain_type_kernel
;
198 case LTTNG_DOMAIN_UST
:
199 return config_domain_type_ust
;
200 case LTTNG_DOMAIN_JUL
:
201 return config_domain_type_jul
;
203 /* Should not have an unknown domain */
208 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value
)
211 case LTTNG_BUFFER_PER_PID
:
212 return config_buffer_type_per_pid
;
213 case LTTNG_BUFFER_PER_UID
:
214 return config_buffer_type_per_uid
;
215 case LTTNG_BUFFER_GLOBAL
:
216 return config_buffer_type_global
;
218 /* Should not have an unknow buffer type */
224 struct mi_writer
*mi_lttng_writer_create(int fd_output
, int mi_output_type
)
226 struct mi_writer
*mi_writer
;
228 mi_writer
= zmalloc(sizeof(struct mi_writer
));
230 PERROR("zmalloc mi_writer_create");
233 if (mi_output_type
== LTTNG_MI_XML
) {
234 mi_writer
->writer
= config_writer_create(fd_output
);
235 if (!mi_writer
->writer
) {
238 mi_writer
->type
= LTTNG_MI_XML
;
252 int mi_lttng_writer_destroy(struct mi_writer
*writer
)
261 ret
= config_writer_destroy(writer
->writer
);
272 int mi_lttng_writer_command_open(struct mi_writer
*writer
, const char *command
)
276 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_command
);
280 ret
= mi_lttng_writer_write_element_string(writer
,
281 mi_lttng_element_command_name
, command
);
287 int mi_lttng_writer_command_close(struct mi_writer
*writer
)
289 return mi_lttng_writer_close_element(writer
);
293 int mi_lttng_writer_open_element(struct mi_writer
*writer
,
294 const char *element_name
)
296 return config_writer_open_element(writer
->writer
, element_name
);
300 int mi_lttng_writer_close_element(struct mi_writer
*writer
)
302 return config_writer_close_element(writer
->writer
);
306 int mi_lttng_close_multi_element(struct mi_writer
*writer
,
307 unsigned int nb_element
)
311 if (nb_element
< 1) {
315 for (i
= 0; i
< nb_element
; i
++) {
316 ret
= mi_lttng_writer_close_element(writer
);
326 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer
*writer
,
327 const char *element_name
, uint64_t value
)
329 return config_writer_write_element_unsigned_int(writer
->writer
,
330 element_name
, value
);
334 int mi_lttng_writer_write_element_signed_int(struct mi_writer
*writer
,
335 const char *element_name
, int64_t value
)
337 return config_writer_write_element_signed_int(writer
->writer
,
338 element_name
, value
);
342 int mi_lttng_writer_write_element_bool(struct mi_writer
*writer
,
343 const char *element_name
, int value
)
345 return config_writer_write_element_bool(writer
->writer
,
346 element_name
, value
);
350 int mi_lttng_writer_write_element_string(struct mi_writer
*writer
,
351 const char *element_name
, const char *value
)
353 return config_writer_write_element_string(writer
->writer
,
354 element_name
, value
);
358 int mi_lttng_version(struct mi_writer
*writer
, struct mi_lttng_version
*version
,
359 const char *lttng_description
, const char *lttng_license
)
364 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_version
);
369 /* Version string (contain info like rc etc.) */
370 ret
= mi_lttng_writer_write_element_string(writer
,
371 mi_lttng_element_version_str
, VERSION
);
376 /* Major version number */
377 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
378 mi_lttng_element_version_major
, version
->version_major
);
383 /* Minor version number */
384 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
385 mi_lttng_element_version_minor
, version
->version_minor
);
390 /* Commit version number */
391 ret
= mi_lttng_writer_write_element_string(writer
,
392 mi_lttng_element_version_commit
, version
->version_commit
);
398 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
399 mi_lttng_element_version_patch_level
, version
->version_patchlevel
);
404 /* Name of the version */
405 ret
= mi_lttng_writer_write_element_string(writer
,
406 config_element_name
, version
->version_name
);
411 /* Description mostly related to beer... */
412 ret
= mi_lttng_writer_write_element_string(writer
,
413 mi_lttng_element_version_description
, lttng_description
);
419 ret
= mi_lttng_writer_write_element_string(writer
,
420 mi_lttng_element_version_web
, version
->package_url
);
425 /* License: free as in free beer...no...*speech* */
426 ret
= mi_lttng_writer_write_element_string(writer
,
427 mi_lttng_element_version_license
, lttng_license
);
432 /* Close version element */
433 ret
= mi_lttng_writer_close_element(writer
);
440 int mi_lttng_sessions_open(struct mi_writer
*writer
)
442 return mi_lttng_writer_open_element(writer
, config_element_sessions
);
446 int mi_lttng_session(struct mi_writer
*writer
,
447 struct lttng_session
*session
, int is_open
)
453 /* Open sessions element */
454 ret
= mi_lttng_writer_open_element(writer
,
455 config_element_session
);
460 /* Name of the session */
461 ret
= mi_lttng_writer_write_element_string(writer
,
462 config_element_name
, session
->name
);
468 ret
= mi_lttng_writer_write_element_string(writer
,
469 config_element_path
, session
->path
);
475 ret
= mi_lttng_writer_write_element_bool(writer
,
476 config_element_enabled
, session
->enabled
);
482 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
483 config_element_snapshot_mode
, session
->snapshot_mode
);
488 /* Live timer interval in usec */
489 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
490 config_element_live_timer_interval
,
491 session
->live_timer_interval
);
497 /* Closing session element */
498 ret
= mi_lttng_writer_close_element(writer
);
506 int mi_lttng_domains_open(struct mi_writer
*writer
)
508 return mi_lttng_writer_open_element(writer
, config_element_domains
);
512 int mi_lttng_domain(struct mi_writer
*writer
,
513 struct lttng_domain
*domain
, int is_open
)
516 const char *str_domain
;
517 const char *str_buffer
;
521 /* Open domain element */
522 ret
= mi_lttng_writer_open_element(writer
, config_element_domain
);
528 str_domain
= mi_lttng_domaintype_string(domain
->type
);
529 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
536 str_buffer
= mi_lttng_buffertype_string(domain
->buf_type
);
537 ret
= mi_lttng_writer_write_element_string(writer
,
538 config_element_buffer_type
, str_buffer
);
543 /* TODO: attr... not sure how to use the union.... */
546 /* Closing domain element */
547 ret
= mi_lttng_writer_close_element(writer
);
556 int mi_lttng_channels_open(struct mi_writer
*writer
)
558 return mi_lttng_writer_open_element(writer
, config_element_channels
);
562 int mi_lttng_channel(struct mi_writer
*writer
,
563 struct lttng_channel
*channel
, int is_open
)
569 /* Opening channel element */
570 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
576 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
583 ret
= mi_lttng_writer_write_element_bool(writer
,
584 config_element_enabled
, channel
->enabled
);
590 ret
= mi_lttng_channel_attr(writer
, &channel
->attr
);
596 /* Closing channel element */
597 ret
= mi_lttng_writer_close_element(writer
);
607 int mi_lttng_channel_attr(struct mi_writer
*writer
,
608 struct lttng_channel_attr
*attr
)
614 /* Opening Attributes */
615 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
621 ret
= mi_lttng_writer_write_element_string(writer
,
622 config_element_overwrite_mode
,
623 attr
->overwrite
? config_overwrite_mode_overwrite
:
624 config_overwrite_mode_discard
);
629 /* Sub buffer size in byte */
630 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
631 config_element_subbuf_size
, attr
->subbuf_size
);
636 /* Number of subbuffer (power of two) */
637 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
638 config_element_num_subbuf
,
644 /* Switch timer interval in usec */
645 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
646 config_element_switch_timer_interval
,
647 attr
->switch_timer_interval
);
652 /* Read timer interval in usec */
653 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
654 config_element_read_timer_interval
,
655 attr
->read_timer_interval
);
661 ret
= mi_lttng_writer_write_element_string(writer
,
662 config_element_output_type
,
663 attr
->output
== LTTNG_EVENT_SPLICE
?
664 config_output_type_splice
: config_output_type_mmap
);
669 /* Tracefile size in bytes */
670 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
671 config_element_tracefile_size
, attr
->tracefile_size
);
676 /* Count of tracefiles */
677 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
678 config_element_tracefile_count
,
679 attr
->tracefile_count
);
684 /* Live timer interval in usec*/
685 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
686 config_element_live_timer_interval
,
687 attr
->live_timer_interval
);
692 /* Closing attributes */
693 ret
= mi_lttng_writer_close_element(writer
);
703 int mi_lttng_event_common_attributes(struct mi_writer
*writer
,
704 struct lttng_event
*event
)
708 /* Open event element */
709 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
715 ret
= mi_lttng_writer_write_element_string(writer
,
716 config_element_name
, event
->name
);
722 ret
= mi_lttng_writer_write_element_string(writer
,
723 config_element_type
, mi_lttng_eventtype_string(event
->type
));
728 /* is event enabled */
729 ret
= mi_lttng_writer_write_element_bool(writer
,
730 config_element_enabled
, event
->enabled
);
735 /* event filter enabled? */
736 ret
= mi_lttng_writer_write_element_bool(writer
,
737 config_element_filter
, event
->filter
);
744 int mi_lttng_event_tracepoint_loglevel(struct mi_writer
*writer
,
745 struct lttng_event
*event
)
750 ret
= mi_lttng_writer_write_element_string(writer
,
751 config_element_loglevel
, mi_lttng_loglevel_string(event
->loglevel
));
756 ret
= mi_lttng_writer_write_element_string(writer
,
757 config_element_loglevel_type
,
758 mi_lttng_logleveltype_string(event
->loglevel_type
));
763 /* event exclusion filter */
764 ret
= mi_lttng_writer_write_element_bool(writer
,
765 config_element_exclusion
, event
->exclusion
);
775 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer
*writer
,
776 struct lttng_event
*event
)
778 /* event exclusion filter */
779 return mi_lttng_writer_write_element_bool(writer
,
780 config_element_exclusion
, event
->exclusion
);
784 int mi_lttng_event_function_probe(struct mi_writer
*writer
,
785 struct lttng_event
*event
)
789 if (event
->attr
.probe
.addr
!= 0) {
790 /* event probe address */
791 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
792 config_element_address
, event
->attr
.probe
.addr
);
797 /* event probe offset */
798 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
799 config_element_offset
, event
->attr
.probe
.offset
);
804 /* event probe symbol_name */
805 ret
= mi_lttng_writer_write_element_string(writer
,
806 config_element_symbol_name
, event
->attr
.probe
.symbol_name
);
816 int mi_lttng_event_function_entry(struct mi_writer
*writer
,
817 struct lttng_event
*event
)
819 /* event probe symbol_name */
820 return mi_lttng_writer_write_element_string(writer
,
821 config_element_symbol_name
, event
->attr
.ftrace
.symbol_name
);
825 int mi_lttng_events_open(struct mi_writer
*writer
)
827 return mi_lttng_writer_open_element(writer
, config_element_events
);
831 int mi_lttng_event(struct mi_writer
*writer
,
832 struct lttng_event
*event
, int is_open
)
836 ret
= mi_lttng_event_common_attributes(writer
, event
);
841 switch (event
->type
) {
842 case LTTNG_EVENT_ALL
:
843 /* We should never have "all" events in list. */
846 case LTTNG_EVENT_TRACEPOINT
:
848 if (event
->loglevel
!= -1) {
849 ret
= mi_lttng_event_tracepoint_loglevel(writer
, event
);
851 ret
= mi_lttng_event_tracepoint_no_loglevel(writer
, event
);
855 case LTTNG_EVENT_PROBE
:
856 ret
= mi_lttng_event_function_probe(writer
, event
);
858 case LTTNG_EVENT_FUNCTION_ENTRY
:
859 ret
= mi_lttng_event_function_entry(writer
, event
);
866 ret
= mi_lttng_writer_close_element(writer
);
874 int mi_lttng_pids_open(struct mi_writer
*writer
)
876 return mi_lttng_writer_open_element(writer
, mi_lttng_element_pids
);
880 int mi_lttng_pid(struct mi_writer
*writer
, pid_t pid
, const char *cmdline
,
885 /* Open element pid */
886 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_pid
);
891 /* Writing pid number */
892 ret
= mi_lttng_writer_write_element_signed_int(writer
,
893 mi_lttng_element_pid_id
, (int)pid
);
898 /* Writing name of the process */
899 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
907 ret
= mi_lttng_writer_close_element(writer
);
915 int mi_lttng_event_fields_open(struct mi_writer
*writer
)
917 return mi_lttng_writer_open_element(writer
, mi_lttng_element_event_fields
);
921 int mi_lttng_event_field(struct mi_writer
*writer
,
922 struct lttng_event_field
*field
)
926 if (!field
->field_name
[0]) {
927 /* To Review: not sure if legal david ?
928 * how should this be handle ?
935 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_field
);
940 if (!field
->field_name
[0]) {
945 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
952 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
953 mi_lttng_eventfieldtype_string(field
->type
));
959 ret
= mi_lttng_writer_write_element_signed_int(writer
,
960 mi_lttng_element_nowrite
, field
->nowrite
);
966 /* Close field element */
967 ret
= mi_lttng_writer_close_element(writer
);