e13342e835511deca29d53af8b1264f403961ef1
[lttng-tools.git] / src / common / mi-lttng.c
1 /*
2 * Copyright (C) 2014 - Jonathan Rajotte <jonathan.r.julien@gmail.com>
3 * - Olivier Cotte <olivier.cotte@polymtl.ca>
4 *
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.
8 *
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
12 * more details.
13 *
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.
17 */
18
19
20 #include <include/config.h>
21 #include <common/config/config.h>
22 #include <lttng/snapshot-internal.h>
23 #include "mi-lttng.h"
24
25 #include <assert.h>
26
27 /* Strings related to command */
28 const char * const mi_lttng_element_command = "command";
29 const char * const mi_lttng_element_command_action = "snapshot_action";
30 const char * const mi_lttng_element_command_add_context = "add-context";
31 const char * const mi_lttng_element_command_calibrate = "calibrate";
32 const char * const mi_lttng_element_command_create = "create";
33 const char * const mi_lttng_element_command_destroy = "destroy";
34 const char * const mi_lttng_element_command_disable_channel = "disable-channel";
35 const char * const mi_lttng_element_command_disable_event = "disable-event";
36 const char * const mi_lttng_element_command_enable_channels = "enable-channel";
37 const char * const mi_lttng_element_command_enable_event = "enable-event";
38 const char * const mi_lttng_element_command_list = "list";
39 const char * const mi_lttng_element_command_load = "load";
40 const char * const mi_lttng_element_command_name = "name";
41 const char * const mi_lttng_element_command_output = "output";
42 const char * const mi_lttng_element_command_save = "save";
43 const char * const mi_lttng_element_command_set_session = "set-session";
44 const char * const mi_lttng_element_command_snapshot = "snapshot";
45 const char * const mi_lttng_element_command_snapshot_add = "add_snapshot";
46 const char * const mi_lttng_element_command_snapshot_del = "del_snapshot";
47 const char * const mi_lttng_element_command_snapshot_list = "list_snapshot";
48 const char * const mi_lttng_element_command_snapshot_record = "record_snapshot";
49 const char * const mi_lttng_element_command_start = "start";
50 const char * const mi_lttng_element_command_stop = "stop";
51 const char * const mi_lttng_element_command_success = "success";
52 const char * const mi_lttng_element_command_version = "version";
53
54 /* Strings related to version command */
55 const char * const mi_lttng_element_version = "version";
56 const char * const mi_lttng_element_version_commit = "commit";
57 const char * const mi_lttng_element_version_description = "description";
58 const char * const mi_lttng_element_version_license = "license";
59 const char * const mi_lttng_element_version_major = "major";
60 const char * const mi_lttng_element_version_minor = "minor";
61 const char * const mi_lttng_element_version_patch_level = "patchLevel";
62 const char * const mi_lttng_element_version_str = "string";
63 const char * const mi_lttng_element_version_web = "url";
64
65 /* String related to a lttng_event_field */
66 const char * const mi_lttng_element_event_field = "event_field";
67 const char * const mi_lttng_element_event_fields = "event_fields";
68
69 /* String related to lttng_event_context */
70 const char * const mi_lttng_context_type_perf_counter = "PERF_COUNTER";
71 const char * const mi_lttng_context_type_perf_cpu_counter = "PERF_CPU_COUNTER";
72 const char * const mi_lttng_context_type_perf_thread_counter = "PERF_THREAD_COUNTER";
73
74 /* String related to lttng_event_perf_counter_ctx */
75 const char * const mi_lttng_element_perf_counter_context = "perf_counter_context";
76
77 /* Strings related to pid */
78 const char * const mi_lttng_element_pids = "pids";
79 const char * const mi_lttng_element_pid = "pid";
80 const char * const mi_lttng_element_pid_id = "id";
81
82 /* Strings related to save command */
83 const char * const mi_lttng_element_save = "save";
84
85 /* Strings related to load command */
86 const char * const mi_lttng_element_load = "load";
87
88 /* General elements of mi_lttng */
89 const char * const mi_lttng_element_empty = "";
90 const char * const mi_lttng_element_id = "id";
91 const char * const mi_lttng_element_nowrite = "nowrite";
92 const char * const mi_lttng_element_success = "success";
93 const char * const mi_lttng_element_type_enum = "ENUM";
94 const char * const mi_lttng_element_type_float = "FLOAT";
95 const char * const mi_lttng_element_type_integer = "INTEGER";
96 const char * const mi_lttng_element_type_other = "OTHER";
97 const char * const mi_lttng_element_type_string = "STRING";
98
99 /* String related to loglevel */
100 const char * const mi_lttng_loglevel_str_alert = "TRACE_ALERT";
101 const char * const mi_lttng_loglevel_str_crit = "TRACE_CRIT";
102 const char * const mi_lttng_loglevel_str_debug = "TRACE_DEBUG";
103 const char * const mi_lttng_loglevel_str_debug_function = "TRACE_DEBUG_FUNCTION";
104 const char * const mi_lttng_loglevel_str_debug_line = "TRACE_DEBUG_LINE";
105 const char * const mi_lttng_loglevel_str_debug_module = "TRACE_DEBUG_MODULE";
106 const char * const mi_lttng_loglevel_str_debug_process = "TRACE_DEBUG_PROCESS";
107 const char * const mi_lttng_loglevel_str_debug_program = "TRACE_DEBUG_PROGRAM";
108 const char * const mi_lttng_loglevel_str_debug_system = "TRACE_DEBUG_SYSTEM";
109 const char * const mi_lttng_loglevel_str_debug_unit = "TRACE_DEBUG_UNIT";
110 const char * const mi_lttng_loglevel_str_emerg = "TRACE_EMERG";
111 const char * const mi_lttng_loglevel_str_err = "TRACE_ERR";
112 const char * const mi_lttng_loglevel_str_info = "TRACE_INFO";
113 const char * const mi_lttng_loglevel_str_notice = "TRACE_NOTICE";
114 const char * const mi_lttng_loglevel_str_unknown = "UNKNOWN";
115 const char * const mi_lttng_loglevel_str_warning = "TRACE_WARNING";
116
117 /* String related to loglevel JUL */
118 const char * const mi_lttng_loglevel_str_jul_all = "JUL_ALL";
119 const char * const mi_lttng_loglevel_str_jul_config = "JUL_CONFIG";
120 const char * const mi_lttng_loglevel_str_jul_fine = "JUL_FINE";
121 const char * const mi_lttng_loglevel_str_jul_finer = "JUL_FINER";
122 const char * const mi_lttng_loglevel_str_jul_finest = "JUL_FINEST";
123 const char * const mi_lttng_loglevel_str_jul_info = "JUL_INFO";
124 const char * const mi_lttng_loglevel_str_jul_off = "JUL_OFF";
125 const char * const mi_lttng_loglevel_str_jul_severe = "JUL_SEVERE";
126 const char * const mi_lttng_loglevel_str_jul_warning = "JUL_WARNING";
127
128 /* String related to loglevel type */
129 const char * const mi_lttng_loglevel_type_all = "ALL";
130 const char * const mi_lttng_loglevel_type_range = "RANGE";
131 const char * const mi_lttng_loglevel_type_single = "SINGLE";
132 const char * const mi_lttng_loglevel_type_unknown = "UNKNOWN";
133
134 /* String related to lttng_calibrate */
135 const char * const mi_lttng_element_calibrate = "calibrate";
136 const char * const mi_lttng_element_calibrate_function = "FUNCTION";
137
138 /* String related to a lttng_snapshot_output */
139 const char * const mi_lttng_element_snapshot_ctrl_url = "ctrl_url";
140 const char * const mi_lttng_element_snapshot_data_url = "data_url";
141 const char * const mi_lttng_element_snapshot_max_size = "max_size";
142 const char * const mi_lttng_element_snapshot_n_ptr = "n_ptr";
143 const char * const mi_lttng_element_snapshot_session_name = "session_name";
144 const char * const mi_lttng_element_snapshots = "snapshots";
145
146 /* This is a merge of jul loglevel and regular loglevel
147 * Those should never overlap by definition
148 * (see struct lttng_event loglevel)
149 */
150 const char *mi_lttng_loglevel_string(int value)
151 {
152 switch (value) {
153 case -1:
154 return mi_lttng_element_empty;
155 case LTTNG_LOGLEVEL_EMERG:
156 return mi_lttng_loglevel_str_emerg;
157 case LTTNG_LOGLEVEL_ALERT:
158 return mi_lttng_loglevel_str_alert;
159 case LTTNG_LOGLEVEL_CRIT:
160 return mi_lttng_loglevel_str_crit;
161 case LTTNG_LOGLEVEL_ERR:
162 return mi_lttng_loglevel_str_err;
163 case LTTNG_LOGLEVEL_WARNING:
164 return mi_lttng_loglevel_str_warning;
165 case LTTNG_LOGLEVEL_NOTICE:
166 return mi_lttng_loglevel_str_notice;
167 case LTTNG_LOGLEVEL_INFO:
168 return mi_lttng_loglevel_str_info;
169 case LTTNG_LOGLEVEL_DEBUG_SYSTEM:
170 return mi_lttng_loglevel_str_debug_system;
171 case LTTNG_LOGLEVEL_DEBUG_PROGRAM:
172 return mi_lttng_loglevel_str_debug_program;
173 case LTTNG_LOGLEVEL_DEBUG_PROCESS:
174 return mi_lttng_loglevel_str_debug_process;
175 case LTTNG_LOGLEVEL_DEBUG_MODULE:
176 return mi_lttng_loglevel_str_debug_module;
177 case LTTNG_LOGLEVEL_DEBUG_UNIT:
178 return mi_lttng_loglevel_str_debug_unit;
179 case LTTNG_LOGLEVEL_DEBUG_FUNCTION:
180 return mi_lttng_loglevel_str_debug_function;
181 case LTTNG_LOGLEVEL_DEBUG_LINE:
182 return mi_lttng_loglevel_str_debug_line;
183 case LTTNG_LOGLEVEL_DEBUG:
184 return mi_lttng_loglevel_str_debug;
185 case LTTNG_LOGLEVEL_JUL_OFF:
186 return mi_lttng_loglevel_str_jul_off;
187 case LTTNG_LOGLEVEL_JUL_SEVERE:
188 return mi_lttng_loglevel_str_jul_severe;
189 case LTTNG_LOGLEVEL_JUL_WARNING:
190 return mi_lttng_loglevel_str_jul_warning;
191 case LTTNG_LOGLEVEL_JUL_INFO:
192 return mi_lttng_loglevel_str_jul_info;
193 case LTTNG_LOGLEVEL_JUL_CONFIG:
194 return mi_lttng_loglevel_str_jul_config;
195 case LTTNG_LOGLEVEL_JUL_FINE:
196 return mi_lttng_loglevel_str_jul_fine;
197 case LTTNG_LOGLEVEL_JUL_FINER:
198 return mi_lttng_loglevel_str_jul_finer;
199 case LTTNG_LOGLEVEL_JUL_FINEST:
200 return mi_lttng_loglevel_str_jul_finest;
201 case LTTNG_LOGLEVEL_JUL_ALL:
202 return mi_lttng_loglevel_str_jul_all;
203 default:
204 return mi_lttng_loglevel_str_unknown;
205 }
206 }
207
208 const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value)
209 {
210 switch (value) {
211 case LTTNG_EVENT_LOGLEVEL_ALL:
212 return mi_lttng_loglevel_type_all;
213 case LTTNG_EVENT_LOGLEVEL_RANGE:
214 return mi_lttng_loglevel_type_range;
215 case LTTNG_EVENT_LOGLEVEL_SINGLE:
216 return mi_lttng_loglevel_type_single;
217 default:
218 return mi_lttng_loglevel_type_unknown;
219 }
220 }
221
222 const char *mi_lttng_eventtype_string(enum lttng_event_type value)
223 {
224 switch (value) {
225 case LTTNG_EVENT_ALL:
226 return config_event_type_all;
227 case LTTNG_EVENT_TRACEPOINT:
228 return config_event_type_tracepoint;
229 case LTTNG_EVENT_PROBE:
230 return config_event_type_probe;
231 case LTTNG_EVENT_FUNCTION:
232 return config_event_type_function;
233 case LTTNG_EVENT_FUNCTION_ENTRY:
234 return config_event_type_function_entry;
235 case LTTNG_EVENT_SYSCALL:
236 return config_event_type_syscall;
237 case LTTNG_EVENT_NOOP:
238 return config_event_type_noop;
239 default:
240 return mi_lttng_element_empty;
241 }
242 }
243
244 const char *mi_lttng_event_contexttype_string(enum lttng_event_context_type val)
245 {
246 switch (val) {
247 case LTTNG_EVENT_CONTEXT_PID:
248 return config_event_context_pid;
249 case LTTNG_EVENT_CONTEXT_PERF_COUNTER:
250 return mi_lttng_context_type_perf_counter;
251 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER:
252 return mi_lttng_context_type_perf_thread_counter;
253 case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER:
254 return mi_lttng_context_type_perf_cpu_counter;
255 case LTTNG_EVENT_CONTEXT_PROCNAME:
256 return config_event_context_procname;
257 case LTTNG_EVENT_CONTEXT_PRIO:
258 return config_event_context_prio;
259 case LTTNG_EVENT_CONTEXT_NICE:
260 return config_event_context_nice;
261 case LTTNG_EVENT_CONTEXT_VPID:
262 return config_event_context_vpid;
263 case LTTNG_EVENT_CONTEXT_TID:
264 return config_event_context_tid;
265 case LTTNG_EVENT_CONTEXT_VTID:
266 return config_event_context_vtid;
267 case LTTNG_EVENT_CONTEXT_PPID:
268 return config_event_context_ppid;
269 case LTTNG_EVENT_CONTEXT_VPPID:
270 return config_event_context_vppid;
271 case LTTNG_EVENT_CONTEXT_PTHREAD_ID:
272 return config_event_context_pthread_id;
273 case LTTNG_EVENT_CONTEXT_HOSTNAME:
274 return config_event_context_hostname;
275 case LTTNG_EVENT_CONTEXT_IP:
276 return config_event_context_ip;
277 default:
278 return NULL;
279 }
280 }
281
282 const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type val)
283 {
284 switch (val) {
285 case(LTTNG_EVENT_FIELD_INTEGER):
286 return mi_lttng_element_type_integer;
287 case(LTTNG_EVENT_FIELD_ENUM):
288 return mi_lttng_element_type_enum;
289 case(LTTNG_EVENT_FIELD_FLOAT):
290 return mi_lttng_element_type_float;
291 case(LTTNG_EVENT_FIELD_STRING):
292 return mi_lttng_element_type_string;
293 default:
294 return mi_lttng_element_type_other;
295 }
296 }
297
298 const char *mi_lttng_domaintype_string(enum lttng_domain_type value)
299 {
300 /* Note: This is a *duplicate* of get_domain_str from bin/lttng/utils.c */
301 switch (value) {
302 case LTTNG_DOMAIN_KERNEL:
303 return config_domain_type_kernel;
304 case LTTNG_DOMAIN_UST:
305 return config_domain_type_ust;
306 case LTTNG_DOMAIN_JUL:
307 return config_domain_type_jul;
308 default:
309 /* Should not have an unknown domain */
310 assert(0);
311 }
312 }
313
314 const char *mi_lttng_buffertype_string(enum lttng_buffer_type value)
315 {
316 switch (value) {
317 case LTTNG_BUFFER_PER_PID:
318 return config_buffer_type_per_pid;
319 case LTTNG_BUFFER_PER_UID:
320 return config_buffer_type_per_uid;
321 case LTTNG_BUFFER_GLOBAL:
322 return config_buffer_type_global;
323 default:
324 /* Should not have an unknow buffer type */
325 assert(0);
326 }
327 }
328
329 const char *mi_lttng_calibratetype_string(enum lttng_calibrate_type val)
330 {
331 const char *ret;
332
333 switch (val) {
334 case LTTNG_CALIBRATE_FUNCTION:
335 ret = mi_lttng_element_calibrate_function;
336 break;
337 default:
338 ret = mi_lttng_element_empty;
339 break;
340 }
341 return ret;
342 }
343
344 LTTNG_HIDDEN
345 struct mi_writer *mi_lttng_writer_create(int fd_output, int mi_output_type)
346 {
347 struct mi_writer *mi_writer;
348
349 mi_writer = zmalloc(sizeof(struct mi_writer));
350 if (!mi_writer) {
351 PERROR("zmalloc mi_writer_create");
352 goto end;
353 }
354 if (mi_output_type == LTTNG_MI_XML) {
355 mi_writer->writer = config_writer_create(fd_output);
356 if (!mi_writer->writer) {
357 goto err_destroy;
358 }
359 mi_writer->type = LTTNG_MI_XML;
360 } else {
361 goto err_destroy;
362 }
363
364 end:
365 return mi_writer;
366
367 err_destroy:
368 free(mi_writer);
369 return NULL;
370 }
371
372 LTTNG_HIDDEN
373 int mi_lttng_writer_destroy(struct mi_writer *writer)
374 {
375 int ret;
376
377 if (!writer) {
378 ret = -EINVAL;
379 goto end;
380 }
381
382 ret = config_writer_destroy(writer->writer);
383 if (ret < 0) {
384 goto end;
385 }
386
387 free(writer);
388 end:
389 return ret;
390 }
391
392 LTTNG_HIDDEN
393 int mi_lttng_writer_command_open(struct mi_writer *writer, const char *command)
394 {
395 int ret;
396
397 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_command);
398 if (ret) {
399 goto end;
400 }
401 ret = mi_lttng_writer_write_element_string(writer,
402 mi_lttng_element_command_name, command);
403 end:
404 return ret;
405 }
406
407 LTTNG_HIDDEN
408 int mi_lttng_writer_command_close(struct mi_writer *writer)
409 {
410 return mi_lttng_writer_close_element(writer);
411 }
412
413 LTTNG_HIDDEN
414 int mi_lttng_writer_open_element(struct mi_writer *writer,
415 const char *element_name)
416 {
417 return config_writer_open_element(writer->writer, element_name);
418 }
419
420 LTTNG_HIDDEN
421 int mi_lttng_writer_close_element(struct mi_writer *writer)
422 {
423 return config_writer_close_element(writer->writer);
424 }
425
426 LTTNG_HIDDEN
427 int mi_lttng_close_multi_element(struct mi_writer *writer,
428 unsigned int nb_element)
429 {
430 int ret, i;
431
432 if (nb_element < 1) {
433 ret = 0;
434 goto end;
435 }
436 for (i = 0; i < nb_element; i++) {
437 ret = mi_lttng_writer_close_element(writer);
438 if (ret) {
439 goto end;
440 }
441 }
442 end:
443 return ret;
444 }
445
446 LTTNG_HIDDEN
447 int mi_lttng_writer_write_element_unsigned_int(struct mi_writer *writer,
448 const char *element_name, uint64_t value)
449 {
450 return config_writer_write_element_unsigned_int(writer->writer,
451 element_name, value);
452 }
453
454 LTTNG_HIDDEN
455 int mi_lttng_writer_write_element_signed_int(struct mi_writer *writer,
456 const char *element_name, int64_t value)
457 {
458 return config_writer_write_element_signed_int(writer->writer,
459 element_name, value);
460 }
461
462 LTTNG_HIDDEN
463 int mi_lttng_writer_write_element_bool(struct mi_writer *writer,
464 const char *element_name, int value)
465 {
466 return config_writer_write_element_bool(writer->writer,
467 element_name, value);
468 }
469
470 LTTNG_HIDDEN
471 int mi_lttng_writer_write_element_string(struct mi_writer *writer,
472 const char *element_name, const char *value)
473 {
474 return config_writer_write_element_string(writer->writer,
475 element_name, value);
476 }
477
478 LTTNG_HIDDEN
479 int mi_lttng_version(struct mi_writer *writer, struct mi_lttng_version *version,
480 const char *lttng_description, const char *lttng_license)
481 {
482 int ret;
483
484 /* Open version */
485 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_version);
486 if (ret) {
487 goto end;
488 }
489
490 /* Version string (contain info like rc etc.) */
491 ret = mi_lttng_writer_write_element_string(writer,
492 mi_lttng_element_version_str, VERSION);
493 if (ret) {
494 goto end;
495 }
496
497 /* Major version number */
498 ret = mi_lttng_writer_write_element_unsigned_int(writer,
499 mi_lttng_element_version_major, version->version_major);
500 if (ret) {
501 goto end;
502 }
503
504 /* Minor version number */
505 ret = mi_lttng_writer_write_element_unsigned_int(writer,
506 mi_lttng_element_version_minor, version->version_minor);
507 if (ret) {
508 goto end;
509 }
510
511 /* Commit version number */
512 ret = mi_lttng_writer_write_element_string(writer,
513 mi_lttng_element_version_commit, version->version_commit);
514 if (ret) {
515 goto end;
516 }
517
518 /* Patch number */
519 ret = mi_lttng_writer_write_element_unsigned_int(writer,
520 mi_lttng_element_version_patch_level, version->version_patchlevel);
521 if (ret) {
522 goto end;
523 }
524
525 /* Name of the version */
526 ret = mi_lttng_writer_write_element_string(writer,
527 config_element_name, version->version_name);
528 if (ret) {
529 goto end;
530 }
531
532 /* Description mostly related to beer... */
533 ret = mi_lttng_writer_write_element_string(writer,
534 mi_lttng_element_version_description, lttng_description);
535 if (ret) {
536 goto end;
537 }
538
539 /* url */
540 ret = mi_lttng_writer_write_element_string(writer,
541 mi_lttng_element_version_web, version->package_url);
542 if (ret) {
543 goto end;
544 }
545
546 /* License: free as in free beer...no...*speech* */
547 ret = mi_lttng_writer_write_element_string(writer,
548 mi_lttng_element_version_license, lttng_license);
549 if (ret) {
550 goto end;
551 }
552
553 /* Close version element */
554 ret = mi_lttng_writer_close_element(writer);
555
556 end:
557 return ret;
558 }
559
560 LTTNG_HIDDEN
561 int mi_lttng_sessions_open(struct mi_writer *writer)
562 {
563 return mi_lttng_writer_open_element(writer, config_element_sessions);
564 }
565
566 LTTNG_HIDDEN
567 int mi_lttng_session(struct mi_writer *writer,
568 struct lttng_session *session, int is_open)
569 {
570 int ret;
571
572 assert(session);
573
574 /* Open sessions element */
575 ret = mi_lttng_writer_open_element(writer,
576 config_element_session);
577 if (ret) {
578 goto end;
579 }
580
581 /* Name of the session */
582 ret = mi_lttng_writer_write_element_string(writer,
583 config_element_name, session->name);
584 if (ret) {
585 goto end;
586 }
587
588 /* Path */
589 ret = mi_lttng_writer_write_element_string(writer,
590 config_element_path, session->path);
591 if (ret) {
592 goto end;
593 }
594
595 /* Enabled ? */
596 ret = mi_lttng_writer_write_element_bool(writer,
597 config_element_enabled, session->enabled);
598 if (ret) {
599 goto end;
600 }
601
602 /* Snapshot mode */
603 ret = mi_lttng_writer_write_element_unsigned_int(writer,
604 config_element_snapshot_mode, session->snapshot_mode);
605 if (ret) {
606 goto end;
607 }
608
609 /* Live timer interval in usec */
610 ret = mi_lttng_writer_write_element_unsigned_int(writer,
611 config_element_live_timer_interval,
612 session->live_timer_interval);
613 if (ret) {
614 goto end;
615 }
616
617 if (!is_open) {
618 /* Closing session element */
619 ret = mi_lttng_writer_close_element(writer);
620 }
621 end:
622 return ret;
623
624 }
625
626 LTTNG_HIDDEN
627 int mi_lttng_domains_open(struct mi_writer *writer)
628 {
629 return mi_lttng_writer_open_element(writer, config_element_domains);
630 }
631
632 LTTNG_HIDDEN
633 int mi_lttng_domain(struct mi_writer *writer,
634 struct lttng_domain *domain, int is_open)
635 {
636 int ret = 0;
637 const char *str_domain;
638 const char *str_buffer;
639
640 assert(domain);
641
642 /* Open domain element */
643 ret = mi_lttng_writer_open_element(writer, config_element_domain);
644 if (ret) {
645 goto end;
646 }
647
648 /* Domain Type */
649 str_domain = mi_lttng_domaintype_string(domain->type);
650 ret = mi_lttng_writer_write_element_string(writer, config_element_type,
651 str_domain);
652 if (ret) {
653 goto end;
654 }
655
656 /* Buffer Type */
657 str_buffer= mi_lttng_buffertype_string(domain->buf_type);
658 ret = mi_lttng_writer_write_element_string(writer,
659 config_element_buffer_type, str_buffer);
660 if (ret) {
661 goto end;
662 }
663
664 /* TODO: union attr
665 * This union is not currently used and was added for
666 * future ust domain support.
667 * Date: 25-06-2014
668 * */
669
670 if (!is_open) {
671 /* Closing domain element */
672 ret = mi_lttng_writer_close_element(writer);
673 }
674
675 end:
676 return ret;
677
678 }
679
680 LTTNG_HIDDEN
681 int mi_lttng_channels_open(struct mi_writer *writer)
682 {
683 return mi_lttng_writer_open_element(writer, config_element_channels);
684 }
685
686 LTTNG_HIDDEN
687 int mi_lttng_channel(struct mi_writer *writer,
688 struct lttng_channel *channel, int is_open)
689 {
690 int ret = 0;
691
692 assert(channel);
693
694 /* Opening channel element */
695 ret = mi_lttng_writer_open_element(writer, config_element_channel);
696 if (ret) {
697 goto end;
698 }
699
700 /* Name */
701 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
702 channel->name);
703 if (ret) {
704 goto end;
705 }
706
707 /* Enabled ? */
708 ret = mi_lttng_writer_write_element_bool(writer,
709 config_element_enabled, channel->enabled);
710 if (ret) {
711 goto end;
712 }
713
714 /* Attribute */
715 ret = mi_lttng_channel_attr(writer, &channel->attr);
716 if (ret) {
717 goto end;
718 }
719
720 if (!is_open) {
721 /* Closing channel element */
722 ret = mi_lttng_writer_close_element(writer);
723 if (ret) {
724 goto end;
725 }
726 }
727 end:
728 return ret;
729 }
730
731 LTTNG_HIDDEN
732 int mi_lttng_channel_attr(struct mi_writer *writer,
733 struct lttng_channel_attr *attr)
734 {
735 int ret = 0;
736
737 assert(attr);
738
739 /* Opening Attributes */
740 ret = mi_lttng_writer_open_element(writer, config_element_attributes);
741 if (ret) {
742 goto end;
743 }
744
745 /* Overwrite */
746 ret = mi_lttng_writer_write_element_string(writer,
747 config_element_overwrite_mode,
748 attr->overwrite ? config_overwrite_mode_overwrite :
749 config_overwrite_mode_discard);
750 if (ret) {
751 goto end;
752 }
753
754 /* Sub buffer size in byte */
755 ret = mi_lttng_writer_write_element_unsigned_int(writer,
756 config_element_subbuf_size, attr->subbuf_size);
757 if (ret) {
758 goto end;
759 }
760
761 /* Number of subbuffer (power of two) */
762 ret = mi_lttng_writer_write_element_unsigned_int(writer,
763 config_element_num_subbuf,
764 attr->num_subbuf);
765 if (ret) {
766 goto end;
767 }
768
769 /* Switch timer interval in usec */
770 ret = mi_lttng_writer_write_element_unsigned_int(writer,
771 config_element_switch_timer_interval,
772 attr->switch_timer_interval);
773 if (ret) {
774 goto end;
775 }
776
777 /* Read timer interval in usec */
778 ret = mi_lttng_writer_write_element_unsigned_int(writer,
779 config_element_read_timer_interval,
780 attr->read_timer_interval);
781 if (ret) {
782 goto end;
783 }
784
785 /* Event output */
786 ret = mi_lttng_writer_write_element_string(writer,
787 config_element_output_type,
788 attr->output == LTTNG_EVENT_SPLICE ?
789 config_output_type_splice : config_output_type_mmap);
790 if (ret) {
791 goto end;
792 }
793
794 /* Tracefile size in bytes */
795 ret = mi_lttng_writer_write_element_unsigned_int(writer,
796 config_element_tracefile_size, attr->tracefile_size);
797 if (ret) {
798 goto end;
799 }
800
801 /* Count of tracefiles */
802 ret = mi_lttng_writer_write_element_unsigned_int(writer,
803 config_element_tracefile_count,
804 attr->tracefile_count);
805 if (ret) {
806 goto end;
807 }
808
809 /* Live timer interval in usec*/
810 ret = mi_lttng_writer_write_element_unsigned_int(writer,
811 config_element_live_timer_interval,
812 attr->live_timer_interval);
813 if (ret) {
814 goto end;
815 }
816
817 /* Closing attributes */
818 ret = mi_lttng_writer_close_element(writer);
819 if (ret) {
820 goto end;
821 }
822 end:
823 return ret;
824
825 }
826
827 LTTNG_HIDDEN
828 int mi_lttng_event_common_attributes(struct mi_writer *writer,
829 struct lttng_event *event)
830 {
831 int ret;
832
833 /* Open event element */
834 ret = mi_lttng_writer_open_element(writer, config_element_event);
835 if (ret) {
836 goto end;
837 }
838
839 /* Event name */
840 ret = mi_lttng_writer_write_element_string(writer,
841 config_element_name, event->name);
842 if (ret) {
843 goto end;
844 }
845
846 /* Event type */
847 ret = mi_lttng_writer_write_element_string(writer,
848 config_element_type, mi_lttng_eventtype_string(event->type));
849 if (ret) {
850 goto end;
851 }
852
853 /* Is event enabled */
854 ret = mi_lttng_writer_write_element_bool(writer,
855 config_element_enabled, event->enabled);
856 if (ret) {
857 goto end;
858 }
859
860 /* Event filter enabled? */
861 ret = mi_lttng_writer_write_element_bool(writer,
862 config_element_filter, event->filter);
863
864 end:
865 return ret;
866 }
867
868 LTTNG_HIDDEN
869 int mi_lttng_event_tracepoint_loglevel(struct mi_writer *writer,
870 struct lttng_event *event)
871 {
872 int ret;
873
874 /* Event loglevel */
875 ret = mi_lttng_writer_write_element_string(writer,
876 config_element_loglevel, mi_lttng_loglevel_string(event->loglevel));
877 if (ret) {
878 goto end;
879 }
880
881 /* Log level type */
882 ret = mi_lttng_writer_write_element_string(writer,
883 config_element_loglevel_type,
884 mi_lttng_logleveltype_string(event->loglevel_type));
885 if (ret) {
886 goto end;
887 }
888
889 /* event exclusion filter */
890 ret = mi_lttng_writer_write_element_bool(writer,
891 config_element_exclusion, event->exclusion);
892 if (ret) {
893 goto end;
894 }
895
896 end:
897 return ret;
898 }
899
900 LTTNG_HIDDEN
901 int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer *writer,
902 struct lttng_event *event)
903 {
904 /* event exclusion filter */
905 return mi_lttng_writer_write_element_bool(writer,
906 config_element_exclusion, event->exclusion);
907 }
908
909 LTTNG_HIDDEN
910 int mi_lttng_event_function_probe(struct mi_writer *writer,
911 struct lttng_event *event)
912 {
913 int ret;
914
915 if (event->attr.probe.addr != 0) {
916 /* event probe address */
917 ret = mi_lttng_writer_write_element_unsigned_int(writer,
918 config_element_address, event->attr.probe.addr);
919 if (ret) {
920 goto end;
921 }
922 } else {
923 /* event probe offset */
924 ret = mi_lttng_writer_write_element_unsigned_int(writer,
925 config_element_offset, event->attr.probe.offset);
926 if (ret) {
927 goto end;
928 }
929
930 /* event probe symbol_name */
931 ret = mi_lttng_writer_write_element_string(writer,
932 config_element_symbol_name, event->attr.probe.symbol_name);
933 if (ret) {
934 goto end;
935 }
936 }
937 end:
938 return ret;
939 }
940
941 LTTNG_HIDDEN
942 int mi_lttng_event_function_entry(struct mi_writer *writer,
943 struct lttng_event *event)
944 {
945 /* event probe symbol_name */
946 return mi_lttng_writer_write_element_string(writer,
947 config_element_symbol_name, event->attr.ftrace.symbol_name);
948 }
949
950 LTTNG_HIDDEN
951 int mi_lttng_events_open(struct mi_writer *writer)
952 {
953 return mi_lttng_writer_open_element(writer, config_element_events);
954 }
955
956 LTTNG_HIDDEN
957 int mi_lttng_event(struct mi_writer *writer,
958 struct lttng_event *event, int is_open)
959 {
960 int ret;
961
962 ret = mi_lttng_event_common_attributes(writer, event);
963 if (ret) {
964 goto end;
965 }
966
967 switch (event->type) {
968 case LTTNG_EVENT_TRACEPOINT:
969 {
970 if (event->loglevel != -1) {
971 ret = mi_lttng_event_tracepoint_loglevel(writer, event);
972 } else {
973 ret = mi_lttng_event_tracepoint_no_loglevel(writer, event);
974 }
975 break;
976 }
977 case LTTNG_EVENT_PROBE:
978 ret = mi_lttng_event_function_probe(writer, event);
979 break;
980 case LTTNG_EVENT_FUNCTION_ENTRY:
981 ret = mi_lttng_event_function_entry(writer, event);
982 break;
983 case LTTNG_EVENT_ALL:
984 /* Fallthrough */
985 default:
986 break;
987 }
988
989 if (!is_open) {
990 ret = mi_lttng_writer_close_element(writer);
991 }
992
993 end:
994 return ret;
995 }
996
997 LTTNG_HIDDEN
998 int mi_lttng_pids_open(struct mi_writer *writer)
999 {
1000 return mi_lttng_writer_open_element(writer, mi_lttng_element_pids);
1001 }
1002
1003 LTTNG_HIDDEN
1004 int mi_lttng_pid(struct mi_writer *writer, pid_t pid , const char *cmdline,
1005 int is_open)
1006 {
1007 int ret;
1008
1009 /* Open element pid */
1010 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_pid);
1011 if (ret) {
1012 goto end;
1013 }
1014
1015 /* Writing pid number */
1016 ret = mi_lttng_writer_write_element_signed_int(writer,
1017 mi_lttng_element_pid_id, (int)pid);
1018 if (ret) {
1019 goto end;
1020 }
1021
1022 /* Writing name of the process */
1023 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
1024 cmdline);
1025 if (ret) {
1026 goto end;
1027 }
1028
1029 if (!is_open) {
1030 /* Closing Pid */
1031 ret = mi_lttng_writer_close_element(writer);
1032 }
1033
1034 end:
1035 return ret;
1036 }
1037
1038 LTTNG_HIDDEN
1039 int mi_lttng_event_fields_open(struct mi_writer *writer)
1040 {
1041 return mi_lttng_writer_open_element(writer, mi_lttng_element_event_fields);
1042 }
1043
1044 LTTNG_HIDDEN
1045 int mi_lttng_event_field(struct mi_writer *writer,
1046 struct lttng_event_field *field)
1047 {
1048 int ret;
1049
1050 if (!field->field_name[0]) {
1051 ret = 0;
1052 goto end;
1053 }
1054
1055 /* Open field */
1056 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_event_field);
1057 if (ret) {
1058 goto end;
1059 }
1060
1061 if (!field->field_name[0]) {
1062 goto close;
1063 }
1064
1065 /* Name */
1066 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
1067 field->field_name);
1068 if (ret) {
1069 goto end;
1070 }
1071
1072 /* Type */
1073 ret = mi_lttng_writer_write_element_string(writer, config_element_type,
1074 mi_lttng_eventfieldtype_string(field->type));
1075 if (ret) {
1076 goto end;
1077 }
1078
1079 /* nowrite */
1080 ret = mi_lttng_writer_write_element_signed_int(writer,
1081 mi_lttng_element_nowrite, field->nowrite);
1082 if (ret) {
1083 goto end;
1084 }
1085
1086 close:
1087 /* Close field element */
1088 ret = mi_lttng_writer_close_element(writer);
1089
1090 end:
1091 return ret;
1092 }
1093
1094 LTTNG_HIDDEN
1095 int mi_lttng_calibrate(struct mi_writer *writer,
1096 struct lttng_calibrate *calibrate)
1097 {
1098 int ret;
1099
1100 /* Open calibrate element */
1101 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_calibrate);
1102 if (ret) {
1103 goto end;
1104 }
1105
1106 /* Calibration type */
1107 ret = mi_lttng_writer_write_element_string(writer, config_element_type,
1108 mi_lttng_calibratetype_string(calibrate->type));
1109 if (ret) {
1110 goto end;
1111 }
1112
1113 /* Closing calibrate element */
1114 ret = mi_lttng_writer_close_element(writer);
1115 end:
1116 return ret;
1117 }
1118 LTTNG_HIDDEN
1119 int mi_lttng_context(struct mi_writer *writer,
1120 struct lttng_event_context *context, int is_open)
1121 {
1122 int ret;
1123 const char *type_string;
1124 struct lttng_event_perf_counter_ctx *perf_context;
1125 /* Open context */
1126 ret = mi_lttng_writer_open_element(writer , config_element_context);
1127 if (ret) {
1128 goto end;
1129 }
1130
1131 type_string = mi_lttng_event_contexttype_string(context->ctx);
1132 if (!type_string) {
1133 ret = -LTTNG_ERR_INVALID;
1134 goto end;
1135 }
1136
1137 /* Print context type */
1138 ret = mi_lttng_writer_write_element_string(writer, config_element_type,
1139 type_string);
1140
1141 /* Special case for PERF_*_COUNTER
1142 * print the lttng_event_perf_counter_ctx*/
1143 switch (context->ctx) {
1144 case LTTNG_EVENT_CONTEXT_PERF_COUNTER:
1145 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER:
1146 case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER:
1147 perf_context = &context->u.perf_counter;
1148 ret = mi_lttng_perf_counter_context(writer, perf_context);
1149 if (ret) {
1150 goto end;
1151 }
1152 break;
1153 default:
1154 break;
1155 }
1156
1157 /* Close context */
1158 if (!is_open) {
1159 ret = mi_lttng_writer_close_element(writer);
1160 }
1161
1162 end:
1163 return ret;
1164 }
1165
1166 LTTNG_HIDDEN
1167 int mi_lttng_perf_counter_context(struct mi_writer *writer,
1168 struct lttng_event_perf_counter_ctx *perf_context)
1169 {
1170 int ret;
1171
1172 /* Open perf_counter_context */
1173 ret = mi_lttng_writer_open_element(writer,
1174 mi_lttng_element_perf_counter_context);
1175 if (ret) {
1176 goto end;
1177 }
1178
1179 /* Type */
1180 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1181 config_element_type, perf_context->type);
1182 if (ret) {
1183 goto end;
1184 }
1185
1186 /* Config */
1187 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1188 config_element_config, perf_context->config);
1189 if (ret) {
1190 goto end;
1191 }
1192
1193 /* Name of the perf counter */
1194 ret = mi_lttng_writer_write_element_string(writer,
1195 config_element_name, perf_context->name);
1196 if (ret) {
1197 goto end;
1198 }
1199
1200 /* Close perf_counter_context */
1201 ret = mi_lttng_writer_close_element(writer);
1202 end:
1203 return ret;
1204 }
1205
1206 LTTNG_HIDDEN
1207 int mi_lttng_snapshot_output_session_name(struct mi_writer *writer,
1208 const char *session_name)
1209 {
1210 int ret;
1211
1212 /* Open session element */
1213 ret = mi_lttng_writer_open_element(writer, config_element_session);
1214 if (ret) {
1215 goto end;
1216 }
1217
1218 /* Snapshot output list for current session name */
1219 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
1220 session_name);
1221
1222 /* Open element snapshots (sequence one snapshot) */
1223 ret = mi_lttng_writer_open_element(writer, mi_lttng_element_snapshots);
1224 if (ret) {
1225 goto end;
1226 }
1227
1228 end:
1229 return ret;
1230 }
1231
1232 LTTNG_HIDDEN
1233 int mi_lttng_snapshot_list_output(struct mi_writer *writer,
1234 struct lttng_snapshot_output *output)
1235 {
1236 int ret;
1237
1238 /* Open element snapshot output */
1239 ret = mi_lttng_writer_open_element(writer,
1240 mi_lttng_element_command_snapshot);
1241 if (ret) {
1242 goto end;
1243 }
1244
1245 /* ID of the snapshot output */
1246 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1247 mi_lttng_element_id, output->id);
1248 if (ret) {
1249 goto end;
1250 }
1251
1252 /* Name of the output */
1253 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
1254 output->name);
1255 if (ret) {
1256 goto end;
1257 }
1258
1259 /* Destination of the output (ctrl_url)*/
1260 ret = mi_lttng_writer_write_element_string(writer,
1261 mi_lttng_element_snapshot_ctrl_url, output->ctrl_url);
1262 if (ret) {
1263 goto end;
1264 }
1265
1266 /* Destination of the output (data_url) */
1267 ret = mi_lttng_writer_write_element_string(writer,
1268 mi_lttng_element_snapshot_data_url, output->data_url);
1269 if (ret) {
1270 goto end;
1271 }
1272
1273 /* total size of all stream combined */
1274 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1275 mi_lttng_element_snapshot_max_size, output->max_size);
1276 if (ret) {
1277 goto end;
1278 }
1279
1280 /* Close snapshot output element */
1281 ret = mi_lttng_writer_close_element(writer);
1282
1283 end:
1284 return ret;
1285 }
1286
1287 LTTNG_HIDDEN
1288 int mi_lttng_snapshot_del_output(struct mi_writer *writer, int id,
1289 const char *name, const char *current_session_name)
1290 {
1291 int ret;
1292
1293 /* Open element del_snapshot */
1294 ret = mi_lttng_writer_open_element(writer,
1295 mi_lttng_element_command_snapshot);
1296 if (ret) {
1297 goto end;
1298 }
1299
1300
1301 if (id != UINT32_MAX) {
1302 /* "Snapshot output "id" successfully deleted
1303 * for "current_session_name"
1304 * ID of the snapshot output
1305 */
1306 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1307 mi_lttng_element_id, id);
1308 if (ret) {
1309 goto end;
1310 }
1311 } else {
1312 /* "Snapshot output "name" successfully deleted
1313 * for session "current_session_name"
1314 * Name of the output
1315 */
1316 ret = mi_lttng_writer_write_element_string(writer, config_element_name,
1317 name);
1318 if (ret) {
1319 goto end;
1320 }
1321 }
1322
1323 /* Snapshot was deleted for session "current_session_name"*/
1324 ret = mi_lttng_writer_write_element_string(writer,
1325 mi_lttng_element_snapshot_session_name,
1326 current_session_name);
1327 if (ret) {
1328 goto end;
1329 }
1330
1331 /* Close snapshot element */
1332 ret = mi_lttng_writer_close_element(writer);
1333
1334 end:
1335 return ret;
1336 }
1337
1338 LTTNG_HIDDEN
1339 int mi_lttng_snapshot_add_output(struct mi_writer *writer,
1340 const char *current_session_name, const char *n_ptr,
1341 struct lttng_snapshot_output *output)
1342 {
1343 int ret;
1344
1345 /* Open element snapshot */
1346 ret = mi_lttng_writer_open_element(writer,
1347 mi_lttng_element_command_snapshot);
1348 if (ret) {
1349 goto end;
1350 }
1351
1352 /* Snapshot output id */
1353 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1354 mi_lttng_element_id, output->id);
1355 if (ret) {
1356 goto end;
1357 }
1358
1359 /* Snapshot output names */
1360 ret = mi_lttng_writer_write_element_string(writer,
1361 config_element_name, n_ptr);
1362 if (ret) {
1363 goto end;
1364 }
1365
1366 /* Destination of the output (ctrl_url)*/
1367 ret = mi_lttng_writer_write_element_string(writer,
1368 mi_lttng_element_snapshot_ctrl_url, output->ctrl_url);
1369 if (ret) {
1370 goto end;
1371 }
1372
1373 /* Snapshot added for session "current_session_name"*/
1374 ret = mi_lttng_writer_write_element_string(writer,
1375 mi_lttng_element_snapshot_session_name, current_session_name);
1376 if (ret) {
1377 goto end;
1378 }
1379
1380 /* total size of all stream combined */
1381 ret = mi_lttng_writer_write_element_unsigned_int(writer,
1382 mi_lttng_element_snapshot_max_size, output->max_size);
1383 if (ret) {
1384 goto end;
1385 }
1386
1387 /* Close snapshot element */
1388 ret = mi_lttng_writer_close_element(writer);
1389
1390 end:
1391 return ret;
1392 }
1393
1394 LTTNG_HIDDEN
1395 int mi_lttng_snapshot_record(struct mi_writer *writer,
1396 const char *current_session_name, const char *url,
1397 const char *cmdline_ctrl_url, const char *cmdline_data_url)
1398 {
1399 int ret;
1400
1401 /* Open element snapshot */
1402 ret = mi_lttng_writer_open_element(writer,
1403 mi_lttng_element_command_snapshot);
1404 if (ret) {
1405 goto end;
1406 }
1407
1408 /*
1409 * If a valid an URL was given, serialize it,
1410 * else take the command line data and ctrl urls*/
1411 if (url) {
1412 /* Destination of the output (ctrl_url)*/
1413 ret = mi_lttng_writer_write_element_string(writer,
1414 mi_lttng_element_snapshot_ctrl_url, url);
1415 if (ret) {
1416 goto end;
1417 }
1418 } else if (cmdline_ctrl_url) {
1419 /* Destination of the output (ctrl_url)*/
1420 ret = mi_lttng_writer_write_element_string(writer,
1421 mi_lttng_element_snapshot_ctrl_url, cmdline_ctrl_url);
1422 if (ret) {
1423 goto end;
1424 }
1425
1426 /* Destination of the output (data_url) */
1427 ret = mi_lttng_writer_write_element_string(writer,
1428 mi_lttng_element_snapshot_data_url, cmdline_data_url);
1429 if (ret) {
1430 goto end;
1431 }
1432 }
1433
1434 /* Close record_snapshot element */
1435 ret = mi_lttng_writer_close_element(writer);
1436
1437 end:
1438 return ret;
1439 }
This page took 0.059563 seconds and 3 git commands to generate.