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