1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Michel Dagenais
3 * 2005 Mathieu Desnoyers
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;
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.
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,
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
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>
35 #include <lttv/stats.h>
36 #include <lttv/filter.h>
38 // #include <lttv/traceset.h>
39 #include <lttv/print.h>
41 #include <ltt/event.h>
42 #include <ltt/trace.h>
46 #include <lttv/event.h>
67 print_path_tree(FILE *fp
, GString
*indent
, LttvAttribute
*tree
)
69 int i
, nb
, saved_length
;
71 LttvAttribute
*subtree
;
73 LttvAttributeName name
;
75 LttvAttributeValue value
;
77 LttvAttributeType type
;
81 saved_length
= indent
->len
;
82 nb
= lttv_attribute_get_number(tree
);
83 for(i
= 0 ; i
< nb
; i
++) {
84 type
= lttv_attribute_get(tree
, i
, &name
, &value
, &is_named
);
86 g_string_sprintfa(indent
, "/%s", g_quark_to_string(name
));
88 g_string_sprintfa(indent
, "/%" PRIu32
, (guint32
) name
);
93 fprintf(fp
, "%s: %d\n", indent
->str
, *value
.v_int
);
96 fprintf(fp
, "%s: %d\n", indent
->str
, *value
.v_int
);
99 fprintf(fp
, "%s: %ld\n", indent
->str
, *value
.v_ulong
);
102 fprintf(fp
, "%s: %lu\n", indent
->str
, *value
.v_ulong
);
105 fprintf(fp
, "%s: %f\n", indent
->str
, (double) *value
.v_float
);
108 fprintf(fp
, "%s: %f\n", indent
->str
, *value
.v_double
);
111 fprintf(fp
, "%s: %lu.%09lu\n", indent
->str
, value
.v_time
->tv_sec
, value
.v_time
->tv_nsec
);
114 fprintf(fp
, "%s: POINTER\n", indent
->str
);
117 fprintf(fp
, "%s: %s\n", indent
->str
, *value
.v_string
);
120 if(LTTV_IS_ATTRIBUTE(*(value
.v_gobject
))) {
121 subtree
= (LttvAttribute
*) *(value
.v_gobject
);
122 print_path_tree(fp
, indent
, subtree
);
124 fprintf(fp
, "%s: GOBJECT\n", indent
->str
);
130 g_string_truncate(indent
, saved_length
);
135 print_tree(FILE *fp
, GString
*indent
, LttvAttribute
*tree
)
137 int i
, nb
, saved_length
;
139 LttvAttribute
*subtree
;
141 LttvAttributeName name
;
143 LttvAttributeValue value
;
145 LttvAttributeType type
;
149 nb
= lttv_attribute_get_number(tree
);
150 for(i
= 0 ; i
< nb
; i
++) {
151 type
= lttv_attribute_get(tree
, i
, &name
, &value
, &is_named
);
153 fprintf(fp
, "%s%s: ", indent
->str
, g_quark_to_string(name
));
155 fprintf(fp
, "%s%" PRIu32
": ", indent
->str
,
160 fprintf(fp
, "%d\n", *value
.v_int
);
163 fprintf(fp
, "%u\n", *value
.v_uint
);
166 fprintf(fp
, "%ld\n", *value
.v_long
);
169 fprintf(fp
, "%lu\n", *value
.v_ulong
);
172 fprintf(fp
, "%f\n", (double)*value
.v_float
);
175 fprintf(fp
, "%f\n", *value
.v_double
);
178 fprintf(fp
, "%10lu.%09lu\n", value
.v_time
->tv_sec
,
179 value
.v_time
->tv_nsec
);
182 fprintf(fp
, "POINTER\n");
185 fprintf(fp
, "%s\n", *value
.v_string
);
188 if(LTTV_IS_ATTRIBUTE(*(value
.v_gobject
))) {
190 subtree
= (LttvAttribute
*)*(value
.v_gobject
);
191 saved_length
= indent
->len
;
192 indent
= g_string_append(indent
, " ");
193 print_tree(fp
, indent
, subtree
);
194 g_string_truncate(indent
, saved_length
);
196 else fprintf(fp
, "GOBJECT\n");
205 print_stats(FILE *fp
, LttvTracesetStats
*tscs
)
207 int i
, nb
, saved_length
;
215 if(tscs
->stats
== NULL
) return;
216 indent
= g_string_new("");
217 fprintf(fp
, "Traceset statistics:\n\n");
219 print_path_tree(fp
, indent
, tscs
->stats
);
221 print_tree(fp
, indent
, tscs
->stats
);
224 ts
= tscs
->parent
.parent
.ts
;
225 nb
= lttv_traceset_number(ts
);
227 for(i
= 0 ; i
< nb
; i
++) {
228 tcs
= (LttvTraceStats
*)(LTTV_TRACESET_CONTEXT(tscs
)->traces
[i
]);
230 LttSystemDescription
*desc
;
231 desc
= ltt_trace_system_description(tcs
->parent
.parent
.t
);
232 LttTime start_time
= ltt_trace_system_description_trace_start_time(desc
);
233 fprintf(fp
, "Trace on system %s at time %lu.%09lu :\n",
234 ltt_trace_system_description_node_name(desc
),
238 saved_length
= indent
->len
;
240 g_string_sprintfa(indent
, "/trace%i", i
);
241 print_path_tree(fp
, indent
, tcs
->stats
);
243 g_string_append(indent
, " ");
244 print_tree(fp
, indent
, tcs
->stats
);
246 g_string_truncate(indent
, saved_length
);
248 g_string_free(indent
, TRUE
);
251 /* Insert the hooks before and after each trace and tracefile, and for each
252 event. Print a global header. */
256 static GString
*a_string
;
258 static gboolean
write_traceset_header(void *hook_data
, void *call_data
)
260 LttvTraceset
*traceset
= (LttvTraceset
*)call_data
;
262 g_info("TextDump traceset header");
264 if(a_file_name
== NULL
) a_file
= stdout
;
265 else a_file
= fopen(a_file_name
, "w");
267 if(a_file
== NULL
) g_error("cannot open file %s", a_file_name
);
269 /* Print the trace set header */
270 fprintf(a_file
,"Trace set contains %d traces\n\n",
271 lttv_traceset_number(traceset
));
277 static gboolean
write_traceset_footer(void *hook_data
, void *call_data
)
279 LttvTraceset
*traceset
= (LttvTraceset
*)call_data
;
281 g_info("TextDump traceset footer");
283 fprintf(a_file
,"End trace set\n\n");
285 if(LTTV_IS_TRACESET_STATS(tc
)) {
286 lttv_stats_sum_traceset((LttvTracesetStats
*)tc
, ltt_time_infinite
);
287 print_stats(a_file
, (LttvTracesetStats
*)tc
);
290 if(a_file_name
!= NULL
) fclose(a_file
);
296 static gboolean
write_trace_header(void *hook_data
, void *call_data
)
299 LttvTraceContext
*tc
= (LttvTraceContext
*)call_data
;
300 LttSystemDescription
*system
= ltt_trace_system_description(tc
->t
);
302 fprintf(a_file
," Trace from %s in %s\n%s\n\n",
303 ltt_trace_system_description_node_name(system
),
304 ltt_trace_system_description_domain_name(system
),
305 ltt_trace_system_description_description(system
));
310 static int write_event_content(void *hook_data
, void *call_data
)
314 LttvIAttribute
*attributes
= LTTV_IATTRIBUTE(lttv_global_attributes());
316 LttvEvent
*event
= (LttvEvent
*)call_data
;
318 LttvTracefileContext
*tfc
= (LttvTracefileContext
*)call_data
;
320 LttvTracefileState
*tfs
= (LttvTracefileState
*)call_data
;
324 LttvAttributeValue value_filter
;
328 guint cpu
= tfs
->cpu
;
329 LttvTraceState
*ts
= (LttvTraceState
*)tfc
->t_context
;
330 LttvProcessState
*process
= ts
->running_process
[cpu
];
335 e
= ltt_tracefile_get_event(tfc
->tf
);
337 result
= lttv_iattribute_find_by_path(attributes
, "filter/lttv_filter",
338 LTTV_POINTER
, &value_filter
);
340 filter
= (LttvFilter
*)*(value_filter
.v_pointer
);
343 * call to the filter if available
345 if(filter
->head
!= NULL
)
346 if(!lttv_filter_tree_parse(filter
->head
,e
,tfc
->tf
,
347 tfc
->t_context
->t
,tfc
,NULL
,NULL
))
351 lttv_event_to_string(e
, a_string
, TRUE
, !a_no_field_names
, tfs
);
354 /* TODO 2012-03-12 Add state info */
355 lttv_event_to_string(event
, a_string
, !a_no_field_names
, TRUE
);
359 g_string_append_printf(a_string
, " %s ",
360 g_quark_to_string(process
->state
->s
));
364 g_string_append_printf(a_string
,"\n");
366 fputs(a_string
->str
, a_file
);
376 LttvAttributeValue value
;
378 LttvIAttribute
*attributes
= LTTV_IATTRIBUTE(lttv_global_attributes());
380 g_info("Init textDump.c");
382 a_string
= g_string_new("");
385 lttv_option_add("output", 'o',
386 "output file where the text is written",
388 LTTV_OPT_STRING
, &a_file_name
, NULL
, NULL
);
391 lttv_option_add("noevent", 'n',
392 "disable event printout",
394 LTTV_OPT_NONE
, &a_noevent
, NULL
, NULL
);
396 a_no_field_names
= FALSE
;
397 lttv_option_add("field_names", 's',
398 "do not write the field names for each event",
400 LTTV_OPT_NONE
, &a_no_field_names
, NULL
, NULL
);
403 lttv_option_add("process_state", 'r',
404 "write the pid and state for each event",
406 LTTV_OPT_NONE
, &a_state
, NULL
, NULL
);
409 lttv_option_add("cpu_stats", 'c',
410 "write the per cpu statistics",
412 LTTV_OPT_NONE
, &a_cpu_stats
, NULL
, NULL
);
414 a_process_stats
= FALSE
;
415 lttv_option_add("process_stats", 'p',
416 "write the per process statistics",
418 LTTV_OPT_NONE
, &a_process_stats
, NULL
, NULL
);
420 a_path_output
= FALSE
;
421 lttv_option_add("path_output", 'a',
422 "print the process stats in path format, for easy grepping",
424 LTTV_OPT_NONE
, &a_path_output
, NULL
, NULL
);
426 result
= lttv_iattribute_find_by_path(attributes
, "hooks/event",
427 LTTV_POINTER
, &value
);
429 event_hook
= *(value
.v_pointer
);
430 g_assert(event_hook
);
431 lttv_hooks_add(event_hook
, write_event_content
, NULL
, LTTV_PRIO_DEFAULT
);
433 result
= lttv_iattribute_find_by_path(attributes
, "hooks/trace/before",
434 LTTV_POINTER
, &value
);
436 before_trace
= *(value
.v_pointer
);
437 g_assert(before_trace
);
438 lttv_hooks_add(before_trace
, write_trace_header
, NULL
, LTTV_PRIO_DEFAULT
);
440 result
= lttv_iattribute_find_by_path(attributes
, "hooks/traceset/before",
441 LTTV_POINTER
, &value
);
443 before_traceset
= *(value
.v_pointer
);
444 g_assert(before_traceset
);
445 lttv_hooks_add(before_traceset
, write_traceset_header
, NULL
,
448 result
= lttv_iattribute_find_by_path(attributes
, "hooks/traceset/after",
449 LTTV_POINTER
, &value
);
451 after_traceset
= *(value
.v_pointer
);
452 g_assert(after_traceset
);
453 lttv_hooks_add(after_traceset
, write_traceset_footer
, NULL
,
457 static void destroy()
459 g_info("Destroy textDump");
461 lttv_option_remove("noevent");
463 lttv_option_remove("output");
465 lttv_option_remove("field_names");
467 lttv_option_remove("process_state");
469 lttv_option_remove("cpu_stats");
471 lttv_option_remove("process_stats");
473 lttv_option_remove("path_output");
475 g_string_free(a_string
, TRUE
);
477 lttv_hooks_remove_data(event_hook
, write_event_content
, NULL
);
479 lttv_hooks_remove_data(before_trace
, write_trace_header
, NULL
);
481 lttv_hooks_remove_data(before_traceset
, write_traceset_header
, NULL
);
483 lttv_hooks_remove_data(after_traceset
, write_traceset_footer
, NULL
);
487 LTTV_MODULE("textDump", "Print events in a file", \
488 "Produce a detailed text printout of a trace", \
489 init
, destroy
, "batchAnalysis", "option", "print")