Adding filtering 'metadata' channel to formattedDump v2
[lttv.git] / lttv / modules / text / textDump.c
CommitLineData
9c312311 1/* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Michel Dagenais
8e680509 3 * 2005 Mathieu Desnoyers
9c312311 4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License Version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
17 * MA 02111-1307, USA.
18 */
19
48f6f3c2 20/* The text dump facility needs to print headers before the trace set and
21 before each trace, to print each event, and to print statistics
22 after each trace. */
23
4e4d11b3 24#ifdef HAVE_CONFIG_H
25#include <config.h>
26#endif
27
996acd92 28#include <lttv/lttv.h>
29#include <lttv/option.h>
30#include <lttv/module.h>
31#include <lttv/hook.h>
32#include <lttv/attribute.h>
33#include <lttv/iattribute.h>
b445142a 34#include <lttv/stats.h>
cec3d7b0 35#include <lttv/filter.h>
8e680509 36#include <lttv/print.h>
ffd54a90 37#include <ltt/ltt.h>
38#include <ltt/event.h>
ffd54a90 39#include <ltt/trace.h>
40#include <stdio.h>
43ed82b5 41#include <inttypes.h>
996acd92 42
dc877563 43static gboolean
7e5fe4d0 44 a_noevent,
b5ad5a5d 45 a_no_field_names,
b445142a 46 a_state,
47 a_cpu_stats,
7a36589d 48 a_process_stats,
49 a_path_output;
dc877563 50
51static char
b445142a 52 *a_file_name = NULL;
dc877563 53
54static LttvHooks
55 *before_traceset,
56 *after_traceset,
57 *before_trace,
12c59c3d 58 *event_hook;
dc877563 59
48f6f3c2 60
b445142a 61static void
7a36589d 62print_path_tree(FILE *fp, GString *indent, LttvAttribute *tree)
63{
64 int i, nb, saved_length;
65
66 LttvAttribute *subtree;
67
68 LttvAttributeName name;
69
70 LttvAttributeValue value;
71
72 LttvAttributeType type;
73
74 gboolean is_named;
75
76 saved_length = indent->len;
77 nb = lttv_attribute_get_number(tree);
78 for(i = 0 ; i < nb ; i++) {
79 type = lttv_attribute_get(tree, i, &name, &value, &is_named);
80 if(is_named) {
81 g_string_sprintfa(indent, "/%s", g_quark_to_string(name));
82 } else {
43ed82b5 83 g_string_sprintfa(indent, "/%" PRIu32, (guint32) name);
7a36589d 84 }
85
86 switch(type) {
87 case LTTV_INT:
88 fprintf(fp, "%s: %d\n", indent->str, *value.v_int);
89 break;
90 case LTTV_UINT:
91 fprintf(fp, "%s: %d\n", indent->str, *value.v_int);
92 break;
93 case LTTV_LONG:
94 fprintf(fp, "%s: %ld\n", indent->str, *value.v_ulong);
95 break;
96 case LTTV_ULONG:
97 fprintf(fp, "%s: %lu\n", indent->str, *value.v_ulong);
98 break;
99 case LTTV_FLOAT:
100 fprintf(fp, "%s: %f\n", indent->str, (double) *value.v_float);
101 break;
102 case LTTV_DOUBLE:
103 fprintf(fp, "%s: %f\n", indent->str, *value.v_double);
104 break;
105 case LTTV_TIME:
106 fprintf(fp, "%s: %lu.%09lu\n", indent->str, value.v_time->tv_sec, value.v_time->tv_nsec);
107 break;
108 case LTTV_POINTER:
109 fprintf(fp, "%s: POINTER\n", indent->str);
110 break;
111 case LTTV_STRING:
112 fprintf(fp, "%s: %s\n", indent->str, *value.v_string);
113 break;
114 case LTTV_GOBJECT:
115 if(LTTV_IS_ATTRIBUTE(*(value.v_gobject))) {
116 subtree = (LttvAttribute*) *(value.v_gobject);
117 print_path_tree(fp, indent, subtree);
118 } else {
119 fprintf(fp, "%s: GOBJECT\n", indent->str);
120 }
121 break;
122 case LTTV_NONE:
123 break;
124 }
125 g_string_truncate(indent, saved_length);
126 }
127}
128
129static void
b445142a 130print_tree(FILE *fp, GString *indent, LttvAttribute *tree)
131{
132 int i, nb, saved_length;
133
134 LttvAttribute *subtree;
135
136 LttvAttributeName name;
137
138 LttvAttributeValue value;
139
140 LttvAttributeType type;
141
c0cb4d12 142 gboolean is_named;
143
b445142a 144 nb = lttv_attribute_get_number(tree);
145 for(i = 0 ; i < nb ; i++) {
c0cb4d12 146 type = lttv_attribute_get(tree, i, &name, &value, &is_named);
147 if(is_named)
148 fprintf(fp, "%s%s: ", indent->str, g_quark_to_string(name));
149 else
43ed82b5 150 fprintf(fp, "%s%" PRIu32 ": ", indent->str,
151 (guint32) name);
b445142a 152
153 switch(type) {
154 case LTTV_INT:
155 fprintf(fp, "%d\n", *value.v_int);
156 break;
157 case LTTV_UINT:
158 fprintf(fp, "%u\n", *value.v_uint);
159 break;
160 case LTTV_LONG:
161 fprintf(fp, "%ld\n", *value.v_long);
162 break;
163 case LTTV_ULONG:
164 fprintf(fp, "%lu\n", *value.v_ulong);
165 break;
166 case LTTV_FLOAT:
167 fprintf(fp, "%f\n", (double)*value.v_float);
168 break;
169 case LTTV_DOUBLE:
170 fprintf(fp, "%f\n", *value.v_double);
171 break;
172 case LTTV_TIME:
ba6f11f1 173 fprintf(fp, "%10lu.%09lu\n", value.v_time->tv_sec,
b445142a 174 value.v_time->tv_nsec);
175 break;
176 case LTTV_POINTER:
177 fprintf(fp, "POINTER\n");
178 break;
179 case LTTV_STRING:
180 fprintf(fp, "%s\n", *value.v_string);
181 break;
182 case LTTV_GOBJECT:
183 if(LTTV_IS_ATTRIBUTE(*(value.v_gobject))) {
184 fprintf(fp, "\n");
185 subtree = (LttvAttribute *)*(value.v_gobject);
186 saved_length = indent->len;
4ec0c904 187 indent = g_string_append(indent, " ");
b445142a 188 print_tree(fp, indent, subtree);
189 g_string_truncate(indent, saved_length);
190 }
191 else fprintf(fp, "GOBJECT\n");
192 break;
193 case LTTV_NONE:
194 break;
195 }
196 }
197}
198
b445142a 199static void
200print_stats(FILE *fp, LttvTracesetStats *tscs)
201{
202 int i, nb, saved_length;
203
204 LttvTraceset *ts;
205
206 LttvTraceStats *tcs;
207
208 GString *indent;
209
b445142a 210 if(tscs->stats == NULL) return;
211 indent = g_string_new("");
212 fprintf(fp, "Traceset statistics:\n\n");
7a36589d 213 if(a_path_output) {
214 print_path_tree(fp, indent, tscs->stats);
215 } else {
216 print_tree(fp, indent, tscs->stats);
217 }
b445142a 218
219 ts = tscs->parent.parent.ts;
220 nb = lttv_traceset_number(ts);
221
222 for(i = 0 ; i < nb ; i++) {
223 tcs = (LttvTraceStats *)(LTTV_TRACESET_CONTEXT(tscs)->traces[i]);
9eb6aa7a 224#if 0 //FIXME
43ed82b5 225 LttSystemDescription *desc;
b445142a 226 desc = ltt_trace_system_description(tcs->parent.parent.t);
ba6f11f1 227 LttTime start_time = ltt_trace_system_description_trace_start_time(desc);
228 fprintf(fp, "Trace on system %s at time %lu.%09lu :\n",
a5dcde2f 229 ltt_trace_system_description_node_name(desc),
ba6f11f1 230 start_time.tv_sec,
231 start_time.tv_nsec);
9eb6aa7a 232#endif //FIXME
b445142a 233 saved_length = indent->len;
7a36589d 234 if(a_path_output) {
235 g_string_sprintfa(indent, "/trace%i", i);
236 print_path_tree(fp, indent, tcs->stats);
237 } else {
238 g_string_append(indent, " ");
239 print_tree(fp, indent, tcs->stats);
240 }
b445142a 241 g_string_truncate(indent, saved_length);
242 }
243 g_string_free(indent, TRUE);
244}
245
dc877563 246/* Insert the hooks before and after each trace and tracefile, and for each
247 event. Print a global header. */
248
249static FILE *a_file;
48f6f3c2 250
dc877563 251static GString *a_string;
252
ffd54a90 253static gboolean write_traceset_header(void *hook_data, void *call_data)
48f6f3c2 254{
dc877563 255 LttvTracesetContext *tc = (LttvTracesetContext *)call_data;
48f6f3c2 256
b445142a 257 g_info("TextDump traceset header");
258
dc877563 259 if(a_file_name == NULL) a_file = stdout;
260 else a_file = fopen(a_file_name, "w");
48f6f3c2 261
dc877563 262 if(a_file == NULL) g_error("cannot open file %s", a_file_name);
48f6f3c2 263
dc877563 264 /* Print the trace set header */
265 fprintf(a_file,"Trace set contains %d traces\n\n",
ffd54a90 266 lttv_traceset_number(tc->ts));
48f6f3c2 267
dc877563 268 return FALSE;
48f6f3c2 269}
270
271
ffd54a90 272static gboolean write_traceset_footer(void *hook_data, void *call_data)
48f6f3c2 273{
dc877563 274 LttvTracesetContext *tc = (LttvTracesetContext *)call_data;
48f6f3c2 275
b445142a 276 g_info("TextDump traceset footer");
277
dc877563 278 fprintf(a_file,"End trace set\n\n");
48f6f3c2 279
b445142a 280 if(LTTV_IS_TRACESET_STATS(tc)) {
b91e751b 281 lttv_stats_sum_traceset((LttvTracesetStats *)tc, ltt_time_infinite);
b445142a 282 print_stats(a_file, (LttvTracesetStats *)tc);
283 }
284
ffd54a90 285 if(a_file_name != NULL) fclose(a_file);
286
dc877563 287 return FALSE;
48f6f3c2 288}
289
290
dc877563 291static gboolean write_trace_header(void *hook_data, void *call_data)
48f6f3c2 292{
9eb6aa7a 293#if 0 //FIXME
43ed82b5 294 LttvTraceContext *tc = (LttvTraceContext *)call_data;
dc877563 295 LttSystemDescription *system = ltt_trace_system_description(tc->t);
48f6f3c2 296
a5dcde2f 297 fprintf(a_file," Trace from %s in %s\n%s\n\n",
298 ltt_trace_system_description_node_name(system),
299 ltt_trace_system_description_domain_name(system),
300 ltt_trace_system_description_description(system));
9eb6aa7a 301#endif //0
dc877563 302 return FALSE;
48f6f3c2 303}
304
305
dc877563 306static int write_event_content(void *hook_data, void *call_data)
48f6f3c2 307{
d5160b2b 308 gboolean result;
309
8bf54995 310 LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
311
dc877563 312 LttvTracefileContext *tfc = (LttvTracefileContext *)call_data;
48f6f3c2 313
dc877563 314 LttvTracefileState *tfs = (LttvTracefileState *)call_data;
48f6f3c2 315
dc877563 316 LttEvent *e;
48f6f3c2 317
8bf54995 318 LttvAttributeValue value_filter;
319
320 LttvFilter *filter;
321
ae3d0f50 322 guint cpu = tfs->cpu;
d730b5c8 323 LttvTraceState *ts = (LttvTraceState*)tfc->t_context;
324 LttvProcessState *process = ts->running_process[cpu];
48f6f3c2 325
9d128d8e 326 if (a_noevent)
8ad2f153 327 return FALSE;
328
d730b5c8 329 e = ltt_tracefile_get_event(tfc->tf);
8bf54995 330
d5160b2b 331 result = lttv_iattribute_find_by_path(attributes, "filter/lttv_filter",
332 LTTV_POINTER, &value_filter);
333 g_assert(result);
8bf54995 334 filter = (LttvFilter*)*(value_filter.v_pointer);
335
cec3d7b0 336 /*
337 * call to the filter if available
338 */
0bc23ba9 339 if(filter->head != NULL)
d730b5c8 340 if(!lttv_filter_tree_parse(filter->head,e,tfc->tf,
b6ef18af 341 tfc->t_context->t,tfc,NULL,NULL))
8ff6243c 342 return FALSE;
cec3d7b0 343
b5ad5a5d 344 lttv_event_to_string(e, a_string, TRUE, !a_no_field_names, tfs);
dc877563 345
346 if(a_state) {
9d0bb8d1 347 g_string_append_printf(a_string, " %s ",
d730b5c8 348 g_quark_to_string(process->state->s));
dc877563 349 }
48f6f3c2 350
54d067f5 351 g_string_append_printf(a_string,"\n");
a0305aae 352
ffd54a90 353 fputs(a_string->str, a_file);
dc877563 354 return FALSE;
48f6f3c2 355}
356
357
08b1c66e 358static void init()
48f6f3c2 359{
d5160b2b 360 gboolean result;
361
ffd54a90 362 LttvAttributeValue value;
48f6f3c2 363
ffd54a90 364 LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
48f6f3c2 365
b445142a 366 g_info("Init textDump.c");
9402662d 367
c6bc9cb9 368 a_string = g_string_new("");
369
ffd54a90 370 a_file_name = NULL;
371 lttv_option_add("output", 'o',
372 "output file where the text is written",
373 "file name",
374 LTTV_OPT_STRING, &a_file_name, NULL, NULL);
48f6f3c2 375
7e5fe4d0 376 a_noevent = FALSE;
377 lttv_option_add("noevent", 'n',
378 "disable event printout",
379 "",
380 LTTV_OPT_NONE, &a_noevent, NULL, NULL);
381
b5ad5a5d 382 a_no_field_names = FALSE;
383 lttv_option_add("field_names", 's',
384 "do not write the field names for each event",
ffd54a90 385 "",
b5ad5a5d 386 LTTV_OPT_NONE, &a_no_field_names, NULL, NULL);
48f6f3c2 387
ffd54a90 388 a_state = FALSE;
7e63c6cd 389 lttv_option_add("process_state", 'r',
ffd54a90 390 "write the pid and state for each event",
391 "",
392 LTTV_OPT_NONE, &a_state, NULL, NULL);
dc877563 393
b445142a 394 a_cpu_stats = FALSE;
9d0bb8d1 395 lttv_option_add("cpu_stats", 'c',
b445142a 396 "write the per cpu statistics",
397 "",
398 LTTV_OPT_NONE, &a_cpu_stats, NULL, NULL);
399
400 a_process_stats = FALSE;
9d0bb8d1 401 lttv_option_add("process_stats", 'p',
b445142a 402 "write the per process statistics",
403 "",
404 LTTV_OPT_NONE, &a_process_stats, NULL, NULL);
405
7a36589d 406 a_path_output = FALSE;
407 lttv_option_add("path_output", 'a',
408 "print the process stats in path format, for easy grepping",
409 "",
410 LTTV_OPT_NONE, &a_path_output, NULL, NULL);
411
8ad2f153 412 result = lttv_iattribute_find_by_path(attributes, "hooks/event",
413 LTTV_POINTER, &value);
414 g_assert(result);
415 event_hook = *(value.v_pointer);
416 g_assert(event_hook);
417 lttv_hooks_add(event_hook, write_event_content, NULL, LTTV_PRIO_DEFAULT);
dc877563 418
d5160b2b 419 result = lttv_iattribute_find_by_path(attributes, "hooks/trace/before",
420 LTTV_POINTER, &value);
421 g_assert(result);
422 before_trace = *(value.v_pointer);
423 g_assert(before_trace);
12c59c3d 424 lttv_hooks_add(before_trace, write_trace_header, NULL, LTTV_PRIO_DEFAULT);
dc877563 425
d5160b2b 426 result = lttv_iattribute_find_by_path(attributes, "hooks/traceset/before",
427 LTTV_POINTER, &value);
428 g_assert(result);
429 before_traceset = *(value.v_pointer);
430 g_assert(before_traceset);
12c59c3d 431 lttv_hooks_add(before_traceset, write_traceset_header, NULL,
432 LTTV_PRIO_DEFAULT);
dc877563 433
d5160b2b 434 result = lttv_iattribute_find_by_path(attributes, "hooks/traceset/after",
435 LTTV_POINTER, &value);
436 g_assert(result);
437 after_traceset = *(value.v_pointer);
438 g_assert(after_traceset);
12c59c3d 439 lttv_hooks_add(after_traceset, write_traceset_footer, NULL,
440 LTTV_PRIO_DEFAULT);
ffd54a90 441}
48f6f3c2 442
08b1c66e 443static void destroy()
ffd54a90 444{
b445142a 445 g_info("Destroy textDump");
446
7e5fe4d0 447 lttv_option_remove("noevent");
448
ffd54a90 449 lttv_option_remove("output");
48f6f3c2 450
ffd54a90 451 lttv_option_remove("field_names");
48f6f3c2 452
ffd54a90 453 lttv_option_remove("process_state");
48f6f3c2 454
b445142a 455 lttv_option_remove("cpu_stats");
456
457 lttv_option_remove("process_stats");
458
4f9ac095 459 lttv_option_remove("path_output");
460
c6bc9cb9 461 g_string_free(a_string, TRUE);
462
8ad2f153 463 lttv_hooks_remove_data(event_hook, write_event_content, NULL);
48f6f3c2 464
ffd54a90 465 lttv_hooks_remove_data(before_trace, write_trace_header, NULL);
48f6f3c2 466
58ad2e34 467 lttv_hooks_remove_data(before_traceset, write_traceset_header, NULL);
48f6f3c2 468
cbf66716 469 lttv_hooks_remove_data(after_traceset, write_traceset_footer, NULL);
48f6f3c2 470}
471
472
08b1c66e 473LTTV_MODULE("textDump", "Print events in a file", \
474 "Produce a detailed text printout of a trace", \
8e680509 475 init, destroy, "stats", "batchAnalysis", "option", "print")
48f6f3c2 476
This page took 0.093666 seconds and 4 git commands to generate.