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_save
= "save";
31 const char * const mi_lttng_element_command_load
= "load";
32 const char * const mi_lttng_element_command_name
= "name";
33 const char * const mi_lttng_element_command_start
= "start";
34 const char * const mi_lttng_element_command_output
= "output";
35 const char * const mi_lttng_element_command_success
= "success";
37 /* Strings related to version command */
38 const char * const mi_lttng_element_version
= "version";
39 const char * const mi_lttng_element_version_str
= "string";
40 const char * const mi_lttng_element_version_web
= "url";
41 const char * const mi_lttng_element_version_major
= "major";
42 const char * const mi_lttng_element_version_minor
= "minor";
43 const char * const mi_lttng_element_version_commit
= "commit";
44 const char * const mi_lttng_element_version_license
= "license";
45 const char * const mi_lttng_element_version_patch_level
= "patchLevel";
46 const char * const mi_lttng_element_version_description
= "description";
48 /* Strings related to pid */
49 const char * const mi_lttng_element_pids
= "pids";
50 const char * const mi_lttng_element_pid
= "pid";
51 const char * const mi_lttng_element_pid_id
= "id";
53 /* Strings related to save command */
54 const char * const mi_lttng_element_save
= "save";
56 /* Strings related to load command */
57 const char * const mi_lttng_element_load
= "load";
59 /* String related to a lttng_event_field */
60 const char * const mi_lttng_element_event_field
= "event_field";
61 const char * const mi_lttng_element_event_fields
= "event_fields";
63 /* General elements of mi_lttng */
64 const char * const mi_lttng_element_type_other
= "OTHER";
65 const char * const mi_lttng_element_type_integer
= "INTEGER";
66 const char * const mi_lttng_element_type_enum
= "ENUM";
67 const char * const mi_lttng_element_type_float
= "FLOAT";
68 const char * const mi_lttng_element_type_string
= "STRING";
69 const char * const mi_lttng_element_nowrite
= "nowrite";
71 /* String related to loglevel */
72 const char * const mi_lttng_loglevel_str_alert
= "TRACE_ALERT";
73 const char * const mi_lttng_loglevel_str_crit
= "TRACE_CRIT";
74 const char * const mi_lttng_loglevel_str_debug
= "TRACE_DEBUG";
75 const char * const mi_lttng_loglevel_str_debug_function
= "TRACE_DEBUG_FUNCTION";
76 const char * const mi_lttng_loglevel_str_debug_line
= "TRACE_DEBUG_LINE";
77 const char * const mi_lttng_loglevel_str_debug_module
= "TRACE_DEBUG_MODULE";
78 const char * const mi_lttng_loglevel_str_debug_process
= "TRACE_DEBUG_PROCESS";
79 const char * const mi_lttng_loglevel_str_debug_program
= "TRACE_DEBUG_PROGRAM";
80 const char * const mi_lttng_loglevel_str_debug_system
= "TRACE_DEBUG_SYSTEM";
81 const char * const mi_lttng_loglevel_str_debug_unit
= "TRACE_DEBUG_UNIT";
82 const char * const mi_lttng_loglevel_str_emerg
= "TRACE_EMERG";
83 const char * const mi_lttng_loglevel_str_err
= "TRACE_ERR";
84 const char * const mi_lttng_loglevel_str_info
= "TRACE_INFO";
85 const char * const mi_lttng_loglevel_str_notice
= "TRACE_NOTICE";
86 const char * const mi_lttng_loglevel_str_unknown
= "UNKNOWN";
87 const char * const mi_lttng_loglevel_str_warning
= "TRACE_WARNING";
89 /* String related to loglevel type */
90 const char * const mi_lttng_loglevel_type_all
= "ALL";
91 const char * const mi_lttng_loglevel_type_range
= "RANGE";
92 const char * const mi_lttng_loglevel_type_single
= "SINGLE";
93 const char * const mi_lttng_loglevel_type_unknown
= "UNKNOWN";
95 const char * const mi_lttng_element_empty
= "";
97 const char *mi_lttng_loglevel_string(int value
)
101 return mi_lttng_element_empty
;
102 case LTTNG_LOGLEVEL_EMERG
:
103 return mi_lttng_loglevel_str_emerg
;
104 case LTTNG_LOGLEVEL_ALERT
:
105 return mi_lttng_loglevel_str_alert
;
106 case LTTNG_LOGLEVEL_CRIT
:
107 return mi_lttng_loglevel_str_crit
;
108 case LTTNG_LOGLEVEL_ERR
:
109 return mi_lttng_loglevel_str_err
;
110 case LTTNG_LOGLEVEL_WARNING
:
111 return mi_lttng_loglevel_str_warning
;
112 case LTTNG_LOGLEVEL_NOTICE
:
113 return mi_lttng_loglevel_str_notice
;
114 case LTTNG_LOGLEVEL_INFO
:
115 return mi_lttng_loglevel_str_info
;
116 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
117 return mi_lttng_loglevel_str_debug_system
;
118 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
119 return mi_lttng_loglevel_str_debug_program
;
120 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
121 return mi_lttng_loglevel_str_debug_process
;
122 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
123 return mi_lttng_loglevel_str_debug_module
;
124 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
125 return mi_lttng_loglevel_str_debug_unit
;
126 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
127 return mi_lttng_loglevel_str_debug_function
;
128 case LTTNG_LOGLEVEL_DEBUG_LINE
:
129 return mi_lttng_loglevel_str_debug_line
;
130 case LTTNG_LOGLEVEL_DEBUG
:
131 return mi_lttng_loglevel_str_debug
;
133 return mi_lttng_loglevel_str_unknown
;
137 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value
)
140 case LTTNG_EVENT_LOGLEVEL_ALL
:
141 return mi_lttng_loglevel_type_all
;
142 case LTTNG_EVENT_LOGLEVEL_RANGE
:
143 return mi_lttng_loglevel_type_range
;
144 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
145 return mi_lttng_loglevel_type_single
;
147 return mi_lttng_loglevel_type_unknown
;
151 const char *mi_lttng_eventtype_string(enum lttng_event_type value
)
154 case LTTNG_EVENT_ALL
:
155 return config_event_type_all
;
156 case LTTNG_EVENT_TRACEPOINT
:
157 return config_event_type_tracepoint
;
158 case LTTNG_EVENT_PROBE
:
159 return config_event_type_probe
;
160 case LTTNG_EVENT_FUNCTION
:
161 return config_event_type_function
;
162 case LTTNG_EVENT_FUNCTION_ENTRY
:
163 return config_event_type_function_entry
;
164 case LTTNG_EVENT_SYSCALL
:
165 return config_event_type_syscall
;
166 case LTTNG_EVENT_NOOP
:
167 return config_event_type_noop
;
169 return mi_lttng_element_empty
;
173 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val
)
176 case(LTTNG_EVENT_FIELD_INTEGER
):
177 return mi_lttng_element_type_integer
;
178 case(LTTNG_EVENT_FIELD_ENUM
):
179 return mi_lttng_element_type_enum
;
180 case(LTTNG_EVENT_FIELD_FLOAT
):
181 return mi_lttng_element_type_float
;
182 case(LTTNG_EVENT_FIELD_STRING
):
183 return mi_lttng_element_type_string
;
185 return mi_lttng_element_type_other
;
189 const char *mi_lttng_domaintype_string(enum lttng_domain_type value
)
191 /* Note: This is a *duplicate* of get_domain_str from bin/lttng/utils.c */
193 case LTTNG_DOMAIN_KERNEL
:
194 return config_domain_type_kernel
;
195 case LTTNG_DOMAIN_UST
:
196 return config_domain_type_ust
;
197 case LTTNG_DOMAIN_JUL
:
198 return config_domain_type_jul
;
200 /* Should not have an unknown domain */
205 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value
)
208 case LTTNG_BUFFER_PER_PID
:
209 return config_buffer_type_per_pid
;
210 case LTTNG_BUFFER_PER_UID
:
211 return config_buffer_type_per_uid
;
212 case LTTNG_BUFFER_GLOBAL
:
213 return config_buffer_type_global
;
215 /* Should not have an unknow buffer type */
221 struct mi_writer
*mi_lttng_writer_create(int fd_output
, int mi_output_type
)
223 struct mi_writer
*mi_writer
;
225 mi_writer
= zmalloc(sizeof(struct mi_writer
));
227 PERROR("zmalloc mi_writer_create");
230 if (mi_output_type
== LTTNG_MI_XML
) {
231 mi_writer
->writer
= config_writer_create(fd_output
);
232 if (!mi_writer
->writer
) {
235 mi_writer
->type
= LTTNG_MI_XML
;
249 int mi_lttng_writer_destroy(struct mi_writer
*writer
)
258 ret
= config_writer_destroy(writer
->writer
);
269 int mi_lttng_writer_command_open(struct mi_writer
*writer
, const char *command
)
273 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_command
);
277 ret
= mi_lttng_writer_write_element_string(writer
,
278 mi_lttng_element_command_name
, command
);
284 int mi_lttng_writer_command_close(struct mi_writer
*writer
)
286 return mi_lttng_writer_close_element(writer
);
290 int mi_lttng_writer_open_element(struct mi_writer
*writer
,
291 const char *element_name
)
293 return config_writer_open_element(writer
->writer
, element_name
);
297 int mi_lttng_writer_close_element(struct mi_writer
*writer
)
299 return config_writer_close_element(writer
->writer
);
303 int mi_lttng_close_multi_element(struct mi_writer
*writer
,
304 unsigned int nb_element
)
308 if (nb_element
< 1) {
312 for (i
= 0; i
< nb_element
; i
++) {
313 ret
= mi_lttng_writer_close_element(writer
);
323 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer
*writer
,
324 const char *element_name
, uint64_t value
)
326 return config_writer_write_element_unsigned_int(writer
->writer
,
327 element_name
, value
);
331 int mi_lttng_writer_write_element_signed_int(struct mi_writer
*writer
,
332 const char *element_name
, int64_t value
)
334 return config_writer_write_element_signed_int(writer
->writer
,
335 element_name
, value
);
339 int mi_lttng_writer_write_element_bool(struct mi_writer
*writer
,
340 const char *element_name
, int value
)
342 return config_writer_write_element_bool(writer
->writer
,
343 element_name
, value
);
347 int mi_lttng_writer_write_element_string(struct mi_writer
*writer
,
348 const char *element_name
, const char *value
)
350 return config_writer_write_element_string(writer
->writer
,
351 element_name
, value
);
355 int mi_lttng_version(struct mi_writer
*writer
, struct mi_lttng_version
*version
,
356 const char *lttng_description
, const char *lttng_license
)
361 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_version
);
366 /* Version string (contain info like rc etc.) */
367 ret
= mi_lttng_writer_write_element_string(writer
,
368 mi_lttng_element_version_str
, VERSION
);
373 /* Major version number */
374 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
375 mi_lttng_element_version_major
, version
->version_major
);
380 /* Minor version number */
381 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
382 mi_lttng_element_version_minor
, version
->version_minor
);
387 /* Commit version number */
388 ret
= mi_lttng_writer_write_element_string(writer
,
389 mi_lttng_element_version_commit
, version
->version_commit
);
395 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
396 mi_lttng_element_version_patch_level
, version
->version_patchlevel
);
401 /* Name of the version */
402 ret
= mi_lttng_writer_write_element_string(writer
,
403 config_element_name
, version
->version_name
);
408 /* Description mostly related to beer... */
409 ret
= mi_lttng_writer_write_element_string(writer
,
410 mi_lttng_element_version_description
, lttng_description
);
416 ret
= mi_lttng_writer_write_element_string(writer
,
417 mi_lttng_element_version_web
, version
->package_url
);
422 /* License: free as in free beer...no...*speech* */
423 ret
= mi_lttng_writer_write_element_string(writer
,
424 mi_lttng_element_version_license
, lttng_license
);
429 /* Close version element */
430 ret
= mi_lttng_writer_close_element(writer
);
437 int mi_lttng_sessions_open(struct mi_writer
*writer
)
439 return mi_lttng_writer_open_element(writer
, config_element_sessions
);
443 int mi_lttng_session(struct mi_writer
*writer
,
444 struct lttng_session
*session
, int is_open
)
450 /* Open sessions element */
451 ret
= mi_lttng_writer_open_element(writer
,
452 config_element_session
);
457 /* Name of the session */
458 ret
= mi_lttng_writer_write_element_string(writer
,
459 config_element_name
, session
->name
);
465 ret
= mi_lttng_writer_write_element_string(writer
,
466 config_element_path
, session
->path
);
472 ret
= mi_lttng_writer_write_element_bool(writer
,
473 config_element_enabled
, session
->enabled
);
479 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
480 config_element_snapshot_mode
, session
->snapshot_mode
);
485 /* Live timer interval in usec */
486 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
487 config_element_live_timer_interval
,
488 session
->live_timer_interval
);
494 /* Closing session element */
495 ret
= mi_lttng_writer_close_element(writer
);
503 int mi_lttng_domains_open(struct mi_writer
*writer
)
505 return mi_lttng_writer_open_element(writer
, config_element_domains
);
509 int mi_lttng_domain(struct mi_writer
*writer
,
510 struct lttng_domain
*domain
, int is_open
)
513 const char *str_domain
;
514 const char *str_buffer
;
518 /* Open domain element */
519 ret
= mi_lttng_writer_open_element(writer
, config_element_domain
);
525 str_domain
= mi_lttng_domaintype_string(domain
->type
);
526 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
533 str_buffer
= mi_lttng_buffertype_string(domain
->buf_type
);
534 ret
= mi_lttng_writer_write_element_string(writer
,
535 config_element_buffer_type
, str_buffer
);
540 /* TODO: attr... not sure how to use the union.... */
543 /* Closing domain element */
544 ret
= mi_lttng_writer_close_element(writer
);
553 int mi_lttng_channels_open(struct mi_writer
*writer
)
555 return mi_lttng_writer_open_element(writer
, config_element_channels
);
559 int mi_lttng_channel(struct mi_writer
*writer
,
560 struct lttng_channel
*channel
, int is_open
)
566 /* Opening channel element */
567 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
573 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
580 ret
= mi_lttng_writer_write_element_bool(writer
,
581 config_element_enabled
, channel
->enabled
);
587 ret
= mi_lttng_channel_attr(writer
, &channel
->attr
);
593 /* Closing channel element */
594 ret
= mi_lttng_writer_close_element(writer
);
604 int mi_lttng_channel_attr(struct mi_writer
*writer
,
605 struct lttng_channel_attr
*attr
)
611 /* Opening Attributes */
612 ret
= mi_lttng_writer_open_element(writer
, config_element_attributes
);
618 ret
= mi_lttng_writer_write_element_string(writer
,
619 config_element_overwrite_mode
,
620 attr
->overwrite
? config_overwrite_mode_overwrite
:
621 config_overwrite_mode_discard
);
626 /* Sub buffer size in byte */
627 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
628 config_element_subbuf_size
, attr
->subbuf_size
);
633 /* Number of subbuffer (power of two) */
634 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
635 config_element_num_subbuf
,
641 /* Switch timer interval in usec */
642 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
643 config_element_switch_timer_interval
,
644 attr
->switch_timer_interval
);
649 /* Read timer interval in usec */
650 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
651 config_element_read_timer_interval
,
652 attr
->read_timer_interval
);
658 ret
= mi_lttng_writer_write_element_string(writer
,
659 config_element_output_type
,
660 attr
->output
== LTTNG_EVENT_SPLICE
?
661 config_output_type_splice
: config_output_type_mmap
);
666 /* Tracefile size in bytes */
667 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
668 config_element_tracefile_size
, attr
->tracefile_size
);
673 /* Count of tracefiles */
674 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
675 config_element_tracefile_count
,
676 attr
->tracefile_count
);
681 /* Live timer interval in usec*/
682 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
683 config_element_live_timer_interval
,
684 attr
->live_timer_interval
);
689 /* Closing attributes */
690 ret
= mi_lttng_writer_close_element(writer
);
700 int mi_lttng_event_common_attributes(struct mi_writer
*writer
,
701 struct lttng_event
*event
)
705 /* Open event element */
706 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
712 ret
= mi_lttng_writer_write_element_string(writer
,
713 config_element_name
, event
->name
);
719 ret
= mi_lttng_writer_write_element_string(writer
,
720 config_element_type
, mi_lttng_eventtype_string(event
->type
));
725 /* is event enabled */
726 ret
= mi_lttng_writer_write_element_bool(writer
,
727 config_element_enabled
, event
->enabled
);
732 /* event filter enabled? */
733 ret
= mi_lttng_writer_write_element_bool(writer
,
734 config_element_filter
, event
->filter
);
741 int mi_lttng_event_tracepoint_loglevel(struct mi_writer
*writer
,
742 struct lttng_event
*event
)
747 ret
= mi_lttng_writer_write_element_string(writer
,
748 config_element_loglevel
, mi_lttng_loglevel_string(event
->loglevel
));
753 ret
= mi_lttng_writer_write_element_string(writer
,
754 config_element_loglevel_type
,
755 mi_lttng_logleveltype_string(event
->loglevel_type
));
760 /* event exclusion filter */
761 ret
= mi_lttng_writer_write_element_bool(writer
,
762 config_element_exclusion
, event
->exclusion
);
772 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer
*writer
,
773 struct lttng_event
*event
)
775 /* event exclusion filter */
776 return mi_lttng_writer_write_element_bool(writer
,
777 config_element_exclusion
, event
->exclusion
);
781 int mi_lttng_event_function_probe(struct mi_writer
*writer
,
782 struct lttng_event
*event
)
786 if (event
->attr
.probe
.addr
!= 0) {
787 /* event probe address */
788 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
789 config_element_address
, event
->attr
.probe
.addr
);
794 /* event probe offset */
795 ret
= mi_lttng_writer_write_element_unsigned_int(writer
,
796 config_element_offset
, event
->attr
.probe
.offset
);
801 /* event probe symbol_name */
802 ret
= mi_lttng_writer_write_element_string(writer
,
803 config_element_symbol_name
, event
->attr
.probe
.symbol_name
);
813 int mi_lttng_event_function_entry(struct mi_writer
*writer
,
814 struct lttng_event
*event
)
816 /* event probe symbol_name */
817 return mi_lttng_writer_write_element_string(writer
,
818 config_element_symbol_name
, event
->attr
.ftrace
.symbol_name
);
822 int mi_lttng_events_open(struct mi_writer
*writer
)
824 return mi_lttng_writer_open_element(writer
, config_element_events
);
828 int mi_lttng_event(struct mi_writer
*writer
,
829 struct lttng_event
*event
, int is_open
)
833 ret
= mi_lttng_event_common_attributes(writer
, event
);
838 switch (event
->type
) {
839 case LTTNG_EVENT_ALL
:
840 /* We should never have "all" events in list. */
843 case LTTNG_EVENT_TRACEPOINT
:
845 if (event
->loglevel
!= -1) {
846 ret
= mi_lttng_event_tracepoint_loglevel(writer
, event
);
848 ret
= mi_lttng_event_tracepoint_no_loglevel(writer
, event
);
852 case LTTNG_EVENT_PROBE
:
853 ret
= mi_lttng_event_function_probe(writer
, event
);
855 case LTTNG_EVENT_FUNCTION_ENTRY
:
856 ret
= mi_lttng_event_function_entry(writer
, event
);
863 ret
= mi_lttng_writer_close_element(writer
);
871 int mi_lttng_pids_open(struct mi_writer
*writer
)
873 return mi_lttng_writer_open_element(writer
, mi_lttng_element_pids
);
877 int mi_lttng_pid(struct mi_writer
*writer
, pid_t pid
, const char *cmdline
,
882 /* Open element pid */
883 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_pid
);
888 /* Writing pid number */
889 ret
= mi_lttng_writer_write_element_signed_int(writer
,
890 mi_lttng_element_pid_id
, (int)pid
);
895 /* Writing name of the process */
896 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
904 ret
= mi_lttng_writer_close_element(writer
);
912 int mi_lttng_event_fields_open(struct mi_writer
*writer
)
914 return mi_lttng_writer_open_element(writer
, mi_lttng_element_event_fields
);
918 int mi_lttng_event_field(struct mi_writer
*writer
,
919 struct lttng_event_field
*field
)
923 if (!field
->field_name
[0]) {
924 /* To Review: not sure if legal david ?
925 * how should this be handle ?
932 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_field
);
937 if (!field
->field_name
[0]) {
942 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
,
949 ret
= mi_lttng_writer_write_element_string(writer
, config_element_type
,
950 mi_lttng_eventfieldtype_string(field
->type
));
956 ret
= mi_lttng_writer_write_element_signed_int(writer
,
957 mi_lttng_element_nowrite
, field
->nowrite
);
963 /* Close field element */
964 ret
= mi_lttng_writer_close_element(writer
);