Commit | Line | Data |
---|---|---|
7a278c8e | 1 | /* |
3228cc1d | 2 | * pretty.c |
7a278c8e | 3 | * |
5dac767a | 4 | * Babeltrace CTF Text Output Plugin |
7a278c8e | 5 | * |
2e339de1 | 6 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
f504043c | 7 | * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
7a278c8e JG |
8 | * |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
33b34c43 | 30 | #include <babeltrace/plugin/plugin-dev.h> |
b2e0c907 PP |
31 | #include <babeltrace/graph/component.h> |
32 | #include <babeltrace/graph/private-component.h> | |
b9d103be | 33 | #include <babeltrace/graph/private-component-sink.h> |
b2e0c907 PP |
34 | #include <babeltrace/graph/component-sink.h> |
35 | #include <babeltrace/graph/port.h> | |
36 | #include <babeltrace/graph/private-port.h> | |
37 | #include <babeltrace/graph/connection.h> | |
38 | #include <babeltrace/graph/private-connection.h> | |
39 | #include <babeltrace/graph/notification.h> | |
40 | #include <babeltrace/graph/notification-iterator.h> | |
41 | #include <babeltrace/graph/notification-event.h> | |
6e1bc0df | 42 | #include <babeltrace/values.h> |
3d9990ac | 43 | #include <babeltrace/compiler-internal.h> |
ad96d936 | 44 | #include <babeltrace/common-internal.h> |
7d61fa8e | 45 | #include <plugins-common.h> |
bfd20a42 | 46 | #include <stdio.h> |
39cfa40f | 47 | #include <stdbool.h> |
bac67f0f | 48 | #include <glib.h> |
75e1829b | 49 | #include <assert.h> |
6405967d | 50 | |
3228cc1d PP |
51 | #include "pretty.h" |
52 | ||
6e1bc0df MD |
53 | static |
54 | const char *plugin_options[] = { | |
ad96d936 | 55 | "color", |
a0ad501b | 56 | "path", |
6e1bc0df MD |
57 | "no-delta", |
58 | "clock-cycles", | |
59 | "clock-seconds", | |
60 | "clock-date", | |
61 | "clock-gmt", | |
a263021c | 62 | "verbose", |
6e1bc0df MD |
63 | "name-default", /* show/hide */ |
64 | "name-payload", | |
65 | "name-context", | |
66 | "name-scope", | |
67 | "name-header", | |
68 | "field-default", /* show/hide */ | |
69 | "field-trace", | |
70 | "field-trace:hostname", | |
71 | "field-trace:domain", | |
72 | "field-trace:procname", | |
73 | "field-trace:vpid", | |
74 | "field-loglevel", | |
75 | "field-emf", | |
60535549 | 76 | "field-callsite", |
6e1bc0df MD |
77 | }; |
78 | ||
bfd20a42 | 79 | static |
3228cc1d | 80 | void destroy_pretty_data(struct pretty_component *pretty) |
bac67f0f | 81 | { |
3228cc1d | 82 | bt_put(pretty->input_iterator); |
5280f742 PP |
83 | |
84 | if (pretty->string) { | |
85 | (void) g_string_free(pretty->string, TRUE); | |
86 | } | |
87 | ||
88 | if (pretty->tmp_string) { | |
89 | (void) g_string_free(pretty->tmp_string, TRUE); | |
90 | } | |
91 | ||
3228cc1d | 92 | if (pretty->out != stdout) { |
77986bad JD |
93 | int ret; |
94 | ||
3228cc1d | 95 | ret = fclose(pretty->out); |
77986bad JD |
96 | if (ret) { |
97 | perror("close output file"); | |
98 | } | |
99 | } | |
3228cc1d | 100 | g_free(pretty->options.output_path); |
3228cc1d | 101 | g_free(pretty); |
bac67f0f JG |
102 | } |
103 | ||
b25bd455 | 104 | static |
3228cc1d | 105 | struct pretty_component *create_pretty(void) |
bac67f0f | 106 | { |
3228cc1d | 107 | struct pretty_component *pretty; |
541b0a11 | 108 | |
3228cc1d PP |
109 | pretty = g_new0(struct pretty_component, 1); |
110 | if (!pretty) { | |
541b0a11 JG |
111 | goto end; |
112 | } | |
3228cc1d PP |
113 | pretty->string = g_string_new(""); |
114 | if (!pretty->string) { | |
6a18b281 MD |
115 | goto error; |
116 | } | |
5280f742 PP |
117 | pretty->tmp_string = g_string_new(""); |
118 | if (!pretty->tmp_string) { | |
119 | goto error; | |
120 | } | |
541b0a11 | 121 | end: |
3228cc1d | 122 | return pretty; |
6a18b281 MD |
123 | |
124 | error: | |
3228cc1d | 125 | g_free(pretty); |
6a18b281 | 126 | return NULL; |
bac67f0f JG |
127 | } |
128 | ||
3228cc1d PP |
129 | BT_HIDDEN |
130 | void pretty_finalize(struct bt_private_component *component) | |
b25bd455 | 131 | { |
890882ef | 132 | void *data = bt_private_component_get_user_data(component); |
b25bd455 | 133 | |
3228cc1d | 134 | destroy_pretty_data(data); |
b25bd455 JG |
135 | } |
136 | ||
bac67f0f | 137 | static |
3228cc1d | 138 | enum bt_component_status handle_notification(struct pretty_component *pretty, |
6e1bc0df | 139 | struct bt_notification *notification) |
4c1456f0 | 140 | { |
541b0a11 | 141 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; |
541b0a11 | 142 | |
b5e978f4 | 143 | assert(pretty); |
541b0a11 | 144 | |
7cdc2bab MD |
145 | switch (bt_notification_get_type(notification)) { |
146 | case BT_NOTIFICATION_TYPE_EVENT: | |
d9f65f09 | 147 | ret = pretty_print_event(pretty, notification); |
7cdc2bab MD |
148 | break; |
149 | case BT_NOTIFICATION_TYPE_INACTIVITY: | |
150 | fprintf(stderr, "Inactivity notification\n"); | |
151 | break; | |
152 | case BT_NOTIFICATION_TYPE_PACKET_BEGIN: | |
153 | case BT_NOTIFICATION_TYPE_PACKET_END: | |
154 | case BT_NOTIFICATION_TYPE_STREAM_BEGIN: | |
155 | case BT_NOTIFICATION_TYPE_STREAM_END: | |
156 | break; | |
da6febac PP |
157 | case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS: |
158 | case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS: | |
159 | ret = pretty_print_discarded_elements(pretty, notification); | |
160 | break; | |
7cdc2bab MD |
161 | default: |
162 | fprintf(stderr, "Unhandled notification type\n"); | |
78586d8a | 163 | } |
b5e978f4 | 164 | |
541b0a11 | 165 | return ret; |
4c1456f0 | 166 | } |
bac67f0f | 167 | |
3228cc1d | 168 | BT_HIDDEN |
0d8b4d8e | 169 | void pretty_port_connected( |
890882ef | 170 | struct bt_private_component *component, |
8f4799f7 PP |
171 | struct bt_private_port *self_port, |
172 | struct bt_port *other_port) | |
75e1829b | 173 | { |
73d5c1ad | 174 | enum bt_connection_status conn_status; |
890882ef | 175 | struct bt_private_connection *connection; |
3228cc1d | 176 | struct pretty_component *pretty; |
fa054faf PP |
177 | static const enum bt_notification_type notif_types[] = { |
178 | BT_NOTIFICATION_TYPE_EVENT, | |
da6febac PP |
179 | BT_NOTIFICATION_TYPE_DISCARDED_PACKETS, |
180 | BT_NOTIFICATION_TYPE_DISCARDED_EVENTS, | |
fa054faf PP |
181 | BT_NOTIFICATION_TYPE_SENTINEL, |
182 | }; | |
75e1829b | 183 | |
3228cc1d PP |
184 | pretty = bt_private_component_get_user_data(component); |
185 | assert(pretty); | |
186 | assert(!pretty->input_iterator); | |
890882ef | 187 | connection = bt_private_port_get_private_connection(self_port); |
72b913fb | 188 | assert(connection); |
73d5c1ad PP |
189 | conn_status = bt_private_connection_create_notification_iterator( |
190 | connection, notif_types, &pretty->input_iterator); | |
191 | if (conn_status != BT_CONNECTION_STATUS_OK) { | |
0d8b4d8e | 192 | pretty->error = true; |
75e1829b | 193 | } |
72b913fb PP |
194 | |
195 | bt_put(connection); | |
75e1829b JG |
196 | } |
197 | ||
3228cc1d PP |
198 | BT_HIDDEN |
199 | enum bt_component_status pretty_consume(struct bt_private_component *component) | |
fec2a9f2 JG |
200 | { |
201 | enum bt_component_status ret; | |
202 | struct bt_notification *notification = NULL; | |
203 | struct bt_notification_iterator *it; | |
3228cc1d | 204 | struct pretty_component *pretty = |
890882ef | 205 | bt_private_component_get_user_data(component); |
41a2b7ae | 206 | enum bt_notification_iterator_status it_ret; |
fec2a9f2 | 207 | |
0d8b4d8e PP |
208 | if (unlikely(pretty->error)) { |
209 | ret = BT_COMPONENT_STATUS_ERROR; | |
210 | goto end; | |
211 | } | |
fec2a9f2 | 212 | |
0d8b4d8e | 213 | it = pretty->input_iterator; |
41a2b7ae | 214 | it_ret = bt_notification_iterator_next(it); |
0d8b4d8e | 215 | |
41a2b7ae | 216 | switch (it_ret) { |
41a2b7ae PP |
217 | case BT_NOTIFICATION_ITERATOR_STATUS_END: |
218 | ret = BT_COMPONENT_STATUS_END; | |
3228cc1d | 219 | BT_PUT(pretty->input_iterator); |
41a2b7ae | 220 | goto end; |
dfa6653c PP |
221 | case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN: |
222 | ret = BT_COMPONENT_STATUS_AGAIN; | |
223 | goto end; | |
224 | case BT_NOTIFICATION_ITERATOR_STATUS_OK: | |
41a2b7ae | 225 | break; |
dfa6653c PP |
226 | default: |
227 | ret = BT_COMPONENT_STATUS_ERROR; | |
228 | goto end; | |
fec2a9f2 JG |
229 | } |
230 | ||
41a2b7ae PP |
231 | notification = bt_notification_iterator_get_notification(it); |
232 | assert(notification); | |
3228cc1d | 233 | ret = handle_notification(pretty, notification); |
dfa6653c | 234 | |
fec2a9f2 | 235 | end: |
fec2a9f2 JG |
236 | bt_put(notification); |
237 | return ret; | |
238 | } | |
239 | ||
6e1bc0df MD |
240 | static |
241 | enum bt_component_status add_params_to_map(struct bt_value *plugin_opt_map) | |
242 | { | |
243 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
244 | unsigned int i; | |
245 | ||
246 | for (i = 0; i < BT_ARRAY_SIZE(plugin_options); i++) { | |
247 | const char *key = plugin_options[i]; | |
248 | enum bt_value_status status; | |
249 | ||
250 | status = bt_value_map_insert(plugin_opt_map, key, bt_value_null); | |
251 | switch (status) { | |
252 | case BT_VALUE_STATUS_OK: | |
253 | break; | |
254 | default: | |
255 | ret = BT_COMPONENT_STATUS_ERROR; | |
256 | goto end; | |
257 | } | |
258 | } | |
259 | end: | |
260 | return ret; | |
261 | } | |
262 | ||
263 | static | |
c55a9f58 | 264 | bt_bool check_param_exists(const char *key, struct bt_value *object, void *data) |
6e1bc0df | 265 | { |
3228cc1d PP |
266 | struct pretty_component *pretty = data; |
267 | struct bt_value *plugin_opt_map = pretty->plugin_opt_map; | |
6e1bc0df MD |
268 | |
269 | if (!bt_value_map_get(plugin_opt_map, key)) { | |
3228cc1d PP |
270 | fprintf(pretty->err, |
271 | "[warning] Parameter \"%s\" unknown to \"text.pretty\" sink component\n", key); | |
6e1bc0df | 272 | } |
c55a9f58 | 273 | return BT_TRUE; |
6e1bc0df MD |
274 | } |
275 | ||
276 | static | |
277 | enum bt_component_status apply_one_string(const char *key, | |
278 | struct bt_value *params, | |
279 | char **option) | |
280 | { | |
281 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
282 | struct bt_value *value = NULL; | |
283 | enum bt_value_status status; | |
284 | const char *str; | |
285 | ||
286 | value = bt_value_map_get(params, key); | |
287 | if (!value) { | |
288 | goto end; | |
289 | } | |
290 | if (bt_value_is_null(value)) { | |
291 | goto end; | |
292 | } | |
293 | status = bt_value_string_get(value, &str); | |
294 | switch (status) { | |
295 | case BT_VALUE_STATUS_OK: | |
296 | break; | |
297 | default: | |
298 | ret = BT_COMPONENT_STATUS_ERROR; | |
299 | goto end; | |
300 | } | |
301 | *option = g_strdup(str); | |
302 | end: | |
303 | bt_put(value); | |
304 | return ret; | |
305 | } | |
306 | ||
307 | static | |
308 | enum bt_component_status apply_one_bool(const char *key, | |
309 | struct bt_value *params, | |
310 | bool *option, | |
311 | bool *found) | |
312 | { | |
313 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
314 | struct bt_value *value = NULL; | |
315 | enum bt_value_status status; | |
c55a9f58 | 316 | bt_bool bool_val; |
6e1bc0df MD |
317 | |
318 | value = bt_value_map_get(params, key); | |
319 | if (!value) { | |
320 | goto end; | |
321 | } | |
c55a9f58 | 322 | status = bt_value_bool_get(value, &bool_val); |
6e1bc0df MD |
323 | switch (status) { |
324 | case BT_VALUE_STATUS_OK: | |
325 | break; | |
326 | default: | |
327 | ret = BT_COMPONENT_STATUS_ERROR; | |
328 | goto end; | |
329 | } | |
c55a9f58 | 330 | *option = (bool) bool_val; |
6e1bc0df MD |
331 | if (found) { |
332 | *found = true; | |
333 | } | |
334 | end: | |
335 | bt_put(value); | |
336 | return ret; | |
337 | } | |
338 | ||
ad96d936 | 339 | static |
3228cc1d | 340 | void warn_wrong_color_param(struct pretty_component *pretty) |
ad96d936 | 341 | { |
3228cc1d | 342 | fprintf(pretty->err, |
ad96d936 PP |
343 | "[warning] Accepted values for the \"color\" parameter are:\n \"always\", \"auto\", \"never\"\n"); |
344 | } | |
345 | ||
77986bad | 346 | static |
3228cc1d | 347 | enum bt_component_status open_output_file(struct pretty_component *pretty) |
77986bad JD |
348 | { |
349 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
350 | ||
3228cc1d | 351 | if (!pretty->options.output_path) { |
77986bad JD |
352 | goto end; |
353 | } | |
354 | ||
3228cc1d PP |
355 | pretty->out = fopen(pretty->options.output_path, "w"); |
356 | if (!pretty->out) { | |
77986bad JD |
357 | goto error; |
358 | } | |
359 | ||
360 | goto end; | |
361 | ||
362 | error: | |
363 | ret = BT_COMPONENT_STATUS_ERROR; | |
364 | end: | |
365 | return ret; | |
366 | } | |
367 | ||
6e1bc0df | 368 | static |
3228cc1d | 369 | enum bt_component_status apply_params(struct pretty_component *pretty, |
6e1bc0df MD |
370 | struct bt_value *params) |
371 | { | |
372 | enum bt_component_status ret = BT_COMPONENT_STATUS_OK; | |
373 | enum bt_value_status status; | |
374 | bool value, found; | |
375 | char *str = NULL; | |
376 | ||
3228cc1d PP |
377 | pretty->plugin_opt_map = bt_value_map_create(); |
378 | if (!pretty->plugin_opt_map) { | |
6e1bc0df MD |
379 | ret = BT_COMPONENT_STATUS_ERROR; |
380 | goto end; | |
381 | } | |
3228cc1d | 382 | ret = add_params_to_map(pretty->plugin_opt_map); |
6e1bc0df MD |
383 | if (ret != BT_COMPONENT_STATUS_OK) { |
384 | goto end; | |
385 | } | |
386 | /* Report unknown parameters. */ | |
3228cc1d | 387 | status = bt_value_map_foreach(params, check_param_exists, pretty); |
6e1bc0df MD |
388 | switch (status) { |
389 | case BT_VALUE_STATUS_OK: | |
390 | break; | |
391 | default: | |
392 | ret = BT_COMPONENT_STATUS_ERROR; | |
393 | goto end; | |
394 | } | |
395 | /* Known parameters. */ | |
3228cc1d | 396 | pretty->options.color = PRETTY_COLOR_OPT_AUTO; |
ad96d936 PP |
397 | if (bt_value_map_has_key(params, "color")) { |
398 | struct bt_value *color_value; | |
399 | const char *color; | |
400 | ||
401 | color_value = bt_value_map_get(params, "color"); | |
402 | if (!color_value) { | |
403 | goto end; | |
404 | } | |
405 | ||
72b913fb PP |
406 | status = bt_value_string_get(color_value, &color); |
407 | if (status) { | |
3228cc1d | 408 | warn_wrong_color_param(pretty); |
ad96d936 PP |
409 | } else { |
410 | if (strcmp(color, "never") == 0) { | |
3228cc1d | 411 | pretty->options.color = PRETTY_COLOR_OPT_NEVER; |
ad96d936 | 412 | } else if (strcmp(color, "auto") == 0) { |
3228cc1d | 413 | pretty->options.color = PRETTY_COLOR_OPT_AUTO; |
ad96d936 | 414 | } else if (strcmp(color, "always") == 0) { |
3228cc1d | 415 | pretty->options.color = PRETTY_COLOR_OPT_ALWAYS; |
ad96d936 | 416 | } else { |
3228cc1d | 417 | warn_wrong_color_param(pretty); |
ad96d936 PP |
418 | } |
419 | } | |
420 | ||
421 | bt_put(color_value); | |
422 | } | |
423 | ||
a0ad501b | 424 | ret = apply_one_string("path", params, &pretty->options.output_path); |
6e1bc0df MD |
425 | if (ret != BT_COMPONENT_STATUS_OK) { |
426 | goto end; | |
427 | } | |
3228cc1d | 428 | ret = open_output_file(pretty); |
77986bad JD |
429 | if (ret != BT_COMPONENT_STATUS_OK) { |
430 | goto end; | |
431 | } | |
6e1bc0df | 432 | |
6e1bc0df MD |
433 | value = false; /* Default. */ |
434 | ret = apply_one_bool("no-delta", params, &value, NULL); | |
435 | if (ret != BT_COMPONENT_STATUS_OK) { | |
436 | goto end; | |
437 | } | |
3228cc1d | 438 | pretty->options.print_delta_field = !value; /* Reverse logic. */ |
6e1bc0df MD |
439 | |
440 | value = false; /* Default. */ | |
441 | ret = apply_one_bool("clock-cycles", params, &value, NULL); | |
442 | if (ret != BT_COMPONENT_STATUS_OK) { | |
443 | goto end; | |
444 | } | |
3228cc1d | 445 | pretty->options.print_timestamp_cycles = value; |
6e1bc0df MD |
446 | |
447 | value = false; /* Default. */ | |
448 | ret = apply_one_bool("clock-seconds", params, &value, NULL); | |
449 | if (ret != BT_COMPONENT_STATUS_OK) { | |
450 | goto end; | |
451 | } | |
3228cc1d | 452 | pretty->options.clock_seconds = value; |
6e1bc0df MD |
453 | |
454 | value = false; /* Default. */ | |
455 | ret = apply_one_bool("clock-date", params, &value, NULL); | |
456 | if (ret != BT_COMPONENT_STATUS_OK) { | |
457 | goto end; | |
458 | } | |
3228cc1d | 459 | pretty->options.clock_date = value; |
6e1bc0df MD |
460 | |
461 | value = false; /* Default. */ | |
462 | ret = apply_one_bool("clock-gmt", params, &value, NULL); | |
463 | if (ret != BT_COMPONENT_STATUS_OK) { | |
464 | goto end; | |
465 | } | |
3228cc1d | 466 | pretty->options.clock_gmt = value; |
6e1bc0df | 467 | |
a263021c JD |
468 | value = false; /* Default. */ |
469 | ret = apply_one_bool("verbose", params, &value, NULL); | |
470 | if (ret != BT_COMPONENT_STATUS_OK) { | |
471 | goto end; | |
472 | } | |
3228cc1d | 473 | pretty->options.verbose = value; |
a263021c | 474 | |
6e1bc0df MD |
475 | /* Names. */ |
476 | ret = apply_one_string("name-default", params, &str); | |
477 | if (ret != BT_COMPONENT_STATUS_OK) { | |
478 | goto end; | |
479 | } | |
480 | if (!str) { | |
3228cc1d | 481 | pretty->options.name_default = PRETTY_DEFAULT_UNSET; |
6e1bc0df | 482 | } else if (!strcmp(str, "show")) { |
3228cc1d | 483 | pretty->options.name_default = PRETTY_DEFAULT_SHOW; |
6e1bc0df | 484 | } else if (!strcmp(str, "hide")) { |
3228cc1d | 485 | pretty->options.name_default = PRETTY_DEFAULT_HIDE; |
6e1bc0df MD |
486 | } else { |
487 | ret = BT_COMPONENT_STATUS_ERROR; | |
488 | goto end; | |
489 | } | |
490 | g_free(str); | |
491 | str = NULL; | |
492 | ||
3228cc1d PP |
493 | switch (pretty->options.name_default) { |
494 | case PRETTY_DEFAULT_UNSET: | |
495 | pretty->options.print_payload_field_names = true; | |
496 | pretty->options.print_context_field_names = true; | |
497 | pretty->options.print_header_field_names = false; | |
498 | pretty->options.print_scope_field_names = false; | |
6e1bc0df | 499 | break; |
3228cc1d PP |
500 | case PRETTY_DEFAULT_SHOW: |
501 | pretty->options.print_payload_field_names = true; | |
502 | pretty->options.print_context_field_names = true; | |
503 | pretty->options.print_header_field_names = true; | |
504 | pretty->options.print_scope_field_names = true; | |
6e1bc0df | 505 | break; |
3228cc1d PP |
506 | case PRETTY_DEFAULT_HIDE: |
507 | pretty->options.print_payload_field_names = false; | |
508 | pretty->options.print_context_field_names = false; | |
509 | pretty->options.print_header_field_names = false; | |
510 | pretty->options.print_scope_field_names = false; | |
6e1bc0df MD |
511 | break; |
512 | default: | |
513 | ret = BT_COMPONENT_STATUS_ERROR; | |
514 | goto end; | |
515 | } | |
516 | ||
517 | value = false; | |
518 | found = false; | |
519 | ret = apply_one_bool("name-payload", params, &value, &found); | |
520 | if (ret != BT_COMPONENT_STATUS_OK) { | |
521 | goto end; | |
522 | } | |
523 | if (found) { | |
3228cc1d | 524 | pretty->options.print_payload_field_names = value; |
6e1bc0df MD |
525 | } |
526 | ||
527 | value = false; | |
528 | found = false; | |
529 | ret = apply_one_bool("name-context", params, &value, &found); | |
530 | if (ret != BT_COMPONENT_STATUS_OK) { | |
531 | goto end; | |
532 | } | |
533 | if (found) { | |
3228cc1d | 534 | pretty->options.print_context_field_names = value; |
6e1bc0df MD |
535 | } |
536 | ||
537 | value = false; | |
538 | found = false; | |
539 | ret = apply_one_bool("name-header", params, &value, &found); | |
540 | if (ret != BT_COMPONENT_STATUS_OK) { | |
541 | goto end; | |
542 | } | |
543 | if (found) { | |
3228cc1d | 544 | pretty->options.print_header_field_names = value; |
6e1bc0df MD |
545 | } |
546 | ||
547 | value = false; | |
548 | found = false; | |
549 | ret = apply_one_bool("name-scope", params, &value, &found); | |
550 | if (ret != BT_COMPONENT_STATUS_OK) { | |
551 | goto end; | |
552 | } | |
553 | if (found) { | |
3228cc1d | 554 | pretty->options.print_scope_field_names = value; |
6e1bc0df MD |
555 | } |
556 | ||
557 | /* Fields. */ | |
558 | ret = apply_one_string("field-default", params, &str); | |
559 | if (ret != BT_COMPONENT_STATUS_OK) { | |
560 | goto end; | |
561 | } | |
562 | if (!str) { | |
3228cc1d | 563 | pretty->options.field_default = PRETTY_DEFAULT_UNSET; |
6e1bc0df | 564 | } else if (!strcmp(str, "show")) { |
3228cc1d | 565 | pretty->options.field_default = PRETTY_DEFAULT_SHOW; |
6e1bc0df | 566 | } else if (!strcmp(str, "hide")) { |
3228cc1d | 567 | pretty->options.field_default = PRETTY_DEFAULT_HIDE; |
6e1bc0df MD |
568 | } else { |
569 | ret = BT_COMPONENT_STATUS_ERROR; | |
570 | goto end; | |
571 | } | |
572 | g_free(str); | |
573 | str = NULL; | |
574 | ||
3228cc1d PP |
575 | switch (pretty->options.field_default) { |
576 | case PRETTY_DEFAULT_UNSET: | |
577 | pretty->options.print_trace_field = false; | |
578 | pretty->options.print_trace_hostname_field = true; | |
579 | pretty->options.print_trace_domain_field = false; | |
580 | pretty->options.print_trace_procname_field = true; | |
581 | pretty->options.print_trace_vpid_field = true; | |
582 | pretty->options.print_loglevel_field = false; | |
583 | pretty->options.print_emf_field = false; | |
584 | pretty->options.print_callsite_field = false; | |
6e1bc0df | 585 | break; |
3228cc1d PP |
586 | case PRETTY_DEFAULT_SHOW: |
587 | pretty->options.print_trace_field = true; | |
588 | pretty->options.print_trace_hostname_field = true; | |
589 | pretty->options.print_trace_domain_field = true; | |
590 | pretty->options.print_trace_procname_field = true; | |
591 | pretty->options.print_trace_vpid_field = true; | |
592 | pretty->options.print_loglevel_field = true; | |
593 | pretty->options.print_emf_field = true; | |
594 | pretty->options.print_callsite_field = true; | |
6e1bc0df | 595 | break; |
3228cc1d PP |
596 | case PRETTY_DEFAULT_HIDE: |
597 | pretty->options.print_trace_field = false; | |
598 | pretty->options.print_trace_hostname_field = false; | |
599 | pretty->options.print_trace_domain_field = false; | |
600 | pretty->options.print_trace_procname_field = false; | |
601 | pretty->options.print_trace_vpid_field = false; | |
602 | pretty->options.print_loglevel_field = false; | |
603 | pretty->options.print_emf_field = false; | |
604 | pretty->options.print_callsite_field = false; | |
6e1bc0df MD |
605 | break; |
606 | default: | |
607 | ret = BT_COMPONENT_STATUS_ERROR; | |
608 | goto end; | |
609 | } | |
610 | ||
611 | value = false; | |
612 | found = false; | |
613 | ret = apply_one_bool("field-trace", params, &value, &found); | |
614 | if (ret != BT_COMPONENT_STATUS_OK) { | |
615 | goto end; | |
616 | } | |
617 | if (found) { | |
3228cc1d | 618 | pretty->options.print_trace_field = value; |
6e1bc0df MD |
619 | } |
620 | ||
621 | value = false; | |
622 | found = false; | |
623 | ret = apply_one_bool("field-trace:hostname", params, &value, &found); | |
624 | if (ret != BT_COMPONENT_STATUS_OK) { | |
625 | goto end; | |
626 | } | |
627 | if (found) { | |
3228cc1d | 628 | pretty->options.print_trace_hostname_field = value; |
6e1bc0df MD |
629 | } |
630 | ||
631 | value = false; | |
632 | found = false; | |
633 | ret = apply_one_bool("field-trace:domain", params, &value, &found); | |
634 | if (ret != BT_COMPONENT_STATUS_OK) { | |
635 | goto end; | |
636 | } | |
637 | if (found) { | |
3228cc1d | 638 | pretty->options.print_trace_domain_field = value; |
6e1bc0df MD |
639 | } |
640 | ||
641 | value = false; | |
642 | found = false; | |
643 | ret = apply_one_bool("field-trace:procname", params, &value, &found); | |
644 | if (ret != BT_COMPONENT_STATUS_OK) { | |
645 | goto end; | |
646 | } | |
647 | if (found) { | |
3228cc1d | 648 | pretty->options.print_trace_procname_field = value; |
6e1bc0df MD |
649 | } |
650 | ||
651 | value = false; | |
652 | found = false; | |
653 | ret = apply_one_bool("field-trace:vpid", params, &value, &found); | |
654 | if (ret != BT_COMPONENT_STATUS_OK) { | |
655 | goto end; | |
656 | } | |
657 | if (found) { | |
3228cc1d | 658 | pretty->options.print_trace_vpid_field = value; |
6e1bc0df MD |
659 | } |
660 | ||
661 | value = false; | |
662 | found = false; | |
663 | ret = apply_one_bool("field-loglevel", params, &value, &found); | |
664 | if (ret != BT_COMPONENT_STATUS_OK) { | |
665 | goto end; | |
666 | } | |
667 | if (found) { | |
3228cc1d | 668 | pretty->options.print_loglevel_field = value; |
6e1bc0df MD |
669 | } |
670 | ||
671 | value = false; | |
672 | found = false; | |
673 | ret = apply_one_bool("field-emf", params, &value, &found); | |
674 | if (ret != BT_COMPONENT_STATUS_OK) { | |
675 | goto end; | |
676 | } | |
677 | if (found) { | |
3228cc1d | 678 | pretty->options.print_emf_field = value; |
6e1bc0df MD |
679 | } |
680 | ||
681 | value = false; | |
682 | found = false; | |
60535549 | 683 | ret = apply_one_bool("field-callsite", params, &value, &found); |
6e1bc0df MD |
684 | if (ret != BT_COMPONENT_STATUS_OK) { |
685 | goto end; | |
686 | } | |
687 | if (found) { | |
3228cc1d | 688 | pretty->options.print_callsite_field = value; |
6e1bc0df MD |
689 | } |
690 | ||
6e1bc0df | 691 | end: |
3228cc1d PP |
692 | bt_put(pretty->plugin_opt_map); |
693 | pretty->plugin_opt_map = NULL; | |
6e1bc0df MD |
694 | g_free(str); |
695 | return ret; | |
696 | } | |
697 | ||
ad96d936 | 698 | static |
3228cc1d | 699 | void set_use_colors(struct pretty_component *pretty) |
ad96d936 | 700 | { |
3228cc1d PP |
701 | switch (pretty->options.color) { |
702 | case PRETTY_COLOR_OPT_ALWAYS: | |
703 | pretty->use_colors = true; | |
ad96d936 | 704 | break; |
3228cc1d PP |
705 | case PRETTY_COLOR_OPT_AUTO: |
706 | pretty->use_colors = pretty->out == stdout && | |
ad96d936 PP |
707 | bt_common_colors_supported(); |
708 | break; | |
3228cc1d PP |
709 | case PRETTY_COLOR_OPT_NEVER: |
710 | pretty->use_colors = false; | |
ad96d936 PP |
711 | break; |
712 | } | |
713 | } | |
714 | ||
2b4c4a7c JD |
715 | static |
716 | void init_stream_packet_context_quarks(void) | |
717 | { | |
718 | stream_packet_context_quarks[Q_TIMESTAMP_BEGIN] = | |
719 | g_quark_from_string("timestamp_begin"); | |
720 | stream_packet_context_quarks[Q_TIMESTAMP_BEGIN] = | |
721 | g_quark_from_string("timestamp_begin"); | |
722 | stream_packet_context_quarks[Q_TIMESTAMP_END] = | |
723 | g_quark_from_string("timestamp_end"); | |
724 | stream_packet_context_quarks[Q_EVENTS_DISCARDED] = | |
725 | g_quark_from_string("events_discarded"); | |
726 | stream_packet_context_quarks[Q_CONTENT_SIZE] = | |
727 | g_quark_from_string("content_size"); | |
728 | stream_packet_context_quarks[Q_PACKET_SIZE] = | |
729 | g_quark_from_string("packet_size"); | |
730 | stream_packet_context_quarks[Q_PACKET_SEQ_NUM] = | |
731 | g_quark_from_string("packet_seq_num"); | |
732 | } | |
733 | ||
3228cc1d PP |
734 | BT_HIDDEN |
735 | enum bt_component_status pretty_init( | |
890882ef PP |
736 | struct bt_private_component *component, |
737 | struct bt_value *params, | |
7d61fa8e | 738 | UNUSED_VAR void *init_method_data) |
bac67f0f JG |
739 | { |
740 | enum bt_component_status ret; | |
3228cc1d | 741 | struct pretty_component *pretty = create_pretty(); |
bac67f0f | 742 | |
3228cc1d | 743 | if (!pretty) { |
bac67f0f JG |
744 | ret = BT_COMPONENT_STATUS_NOMEM; |
745 | goto end; | |
746 | } | |
747 | ||
147337a3 PP |
748 | ret = bt_private_component_sink_add_input_private_port(component, |
749 | "in", NULL, NULL); | |
750 | if (ret != BT_COMPONENT_STATUS_OK) { | |
b9d103be PP |
751 | goto end; |
752 | } | |
753 | ||
3228cc1d PP |
754 | pretty->out = stdout; |
755 | pretty->err = stderr; | |
6e1bc0df | 756 | |
3228cc1d PP |
757 | pretty->delta_cycles = -1ULL; |
758 | pretty->last_cycles_timestamp = -1ULL; | |
3af83b5a | 759 | |
3228cc1d PP |
760 | pretty->delta_real_timestamp = -1ULL; |
761 | pretty->last_real_timestamp = -1ULL; | |
3af83b5a | 762 | |
3228cc1d | 763 | ret = apply_params(pretty, params); |
6e1bc0df MD |
764 | if (ret != BT_COMPONENT_STATUS_OK) { |
765 | goto error; | |
766 | } | |
767 | ||
3228cc1d | 768 | set_use_colors(pretty); |
3228cc1d | 769 | ret = bt_private_component_set_user_data(component, pretty); |
bac67f0f JG |
770 | if (ret != BT_COMPONENT_STATUS_OK) { |
771 | goto error; | |
772 | } | |
2b4c4a7c JD |
773 | |
774 | init_stream_packet_context_quarks(); | |
775 | ||
bac67f0f JG |
776 | end: |
777 | return ret; | |
778 | error: | |
3228cc1d | 779 | destroy_pretty_data(pretty); |
bac67f0f JG |
780 | return ret; |
781 | } |