1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Michel Dagenais
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License Version 2 as
6 * published by the Free Software Foundation;
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
19 /* The text dump facility needs to print headers before the trace set and
20 before each trace, to print each event, and to print statistics
27 #include <lttv/lttv.h>
28 #include <lttv/option.h>
29 #include <lttv/module.h>
30 #include <lttv/hook.h>
31 #include <lttv/attribute.h>
32 #include <lttv/iattribute.h>
33 #include <lttv/stats.h>
34 #include <lttv/filter.h>
36 #include <ltt/event.h>
38 #include <ltt/trace.h>
39 #include <ltt/facility.h>
57 void print_field(LttEvent
*e
, LttField
*f
, GString
*s
, gboolean field_names
) {
67 type
= ltt_field_type(f
);
68 switch(ltt_type_class(type
)) {
72 g_string_append_printf(s
, " %lld", ltt_event_get_long_int(e
,f
));
79 g_string_append_printf(s
, " %llu", ltt_event_get_long_unsigned(e
,f
));
83 g_string_append_printf(s
, " %g", ltt_event_get_double(e
,f
));
87 g_string_append_printf(s
, " 0x%llx", ltt_event_get_long_unsigned(e
,f
));
91 g_string_append_printf(s
, " \"%s\"", ltt_event_get_string(e
,f
));
95 g_string_append_printf(s
, " %s",
96 g_quark_to_string(ltt_enum_string_get(type
,
97 ltt_event_get_unsigned(e
,f
)-1)));
102 g_string_append_printf(s
, " {");
103 nb
= ltt_event_field_element_number(e
,f
);
104 element
= ltt_field_element(f
);
105 for(i
= 0 ; i
< nb
; i
++) {
106 ltt_event_field_element_select(e
,f
,i
);
107 print_field(e
, element
, s
, field_names
);
109 g_string_append_printf(s
, " }");
113 g_string_append_printf(s
, " {");
114 nb
= ltt_type_member_number(type
);
115 for(i
= 0 ; i
< nb
; i
++) {
116 element
= ltt_field_member(f
,i
);
118 ltt_type_member_type(type
, i
, &name
);
119 g_string_append_printf(s
, " %s = ", g_quark_to_string(name
));
121 print_field(e
, element
, s
, field_names
);
123 g_string_append_printf(s
, " }");
127 g_string_append_printf(s
, " {");
128 nb
= ltt_type_member_number(type
);
129 for(i
= 0 ; i
< nb
; i
++) {
130 element
= ltt_field_member(f
,i
);
132 ltt_type_member_type(type
, i
, &name
);
133 g_string_append_printf(s
, " %s = ", g_quark_to_string(name
));
135 print_field(e
, element
, s
, field_names
);
137 g_string_append_printf(s
, " }");
144 void lttv_event_to_string(LttEvent
*e
, GString
*s
,
145 gboolean mandatory_fields
, gboolean field_names
, LttvTracefileState
*tfs
)
147 LttFacility
*facility
;
149 LttEventType
*event_type
;
157 g_string_set_size(s
,0);
159 facility
= ltt_event_facility(e
);
160 event_type
= ltt_event_eventtype(e
);
161 field
= ltt_event_field(e
);
163 if(mandatory_fields
) {
164 time
= ltt_event_time(e
);
165 g_string_append_printf(s
,"%s.%s: %ld.%09ld (%s)",
166 g_quark_to_string(ltt_facility_name(facility
)),
167 g_quark_to_string(ltt_eventtype_name(event_type
)),
168 (long)time
.tv_sec
, time
.tv_nsec
,
169 g_quark_to_string(tfs
->cpu_name
));
170 /* Print the process id and the state/interrupt type of the process */
171 g_string_append_printf(s
,", %u, %u, %s", tfs
->process
->pid
,
173 g_quark_to_string(tfs
->process
->state
->t
));
177 print_field(e
, field
, s
, field_names
);
182 print_tree(FILE *fp
, GString
*indent
, LttvAttribute
*tree
)
184 int i
, nb
, saved_length
;
186 LttvAttribute
*subtree
;
188 LttvAttributeName name
;
190 LttvAttributeValue value
;
192 LttvAttributeType type
;
194 nb
= lttv_attribute_get_number(tree
);
195 for(i
= 0 ; i
< nb
; i
++) {
196 type
= lttv_attribute_get(tree
, i
, &name
, &value
);
197 fprintf(fp
, "%s%s: ", indent
->str
, g_quark_to_string(name
));
201 fprintf(fp
, "%d\n", *value
.v_int
);
204 fprintf(fp
, "%u\n", *value
.v_uint
);
207 fprintf(fp
, "%ld\n", *value
.v_long
);
210 fprintf(fp
, "%lu\n", *value
.v_ulong
);
213 fprintf(fp
, "%f\n", (double)*value
.v_float
);
216 fprintf(fp
, "%f\n", *value
.v_double
);
219 fprintf(fp
, "%10lu.%09lu\n", value
.v_time
->tv_sec
,
220 value
.v_time
->tv_nsec
);
223 fprintf(fp
, "POINTER\n");
226 fprintf(fp
, "%s\n", *value
.v_string
);
229 if(LTTV_IS_ATTRIBUTE(*(value
.v_gobject
))) {
231 subtree
= (LttvAttribute
*)*(value
.v_gobject
);
232 saved_length
= indent
->len
;
233 g_string_append(indent
, " ");
234 print_tree(fp
, indent
, subtree
);
235 g_string_truncate(indent
, saved_length
);
237 else fprintf(fp
, "GOBJECT\n");
247 print_stats(FILE *fp
, LttvTracesetStats
*tscs
)
249 int i
, nb
, saved_length
;
257 LttSystemDescription
*desc
;
259 if(tscs
->stats
== NULL
) return;
260 indent
= g_string_new("");
261 fprintf(fp
, "Traceset statistics:\n\n");
262 print_tree(fp
, indent
, tscs
->stats
);
264 ts
= tscs
->parent
.parent
.ts
;
265 nb
= lttv_traceset_number(ts
);
267 for(i
= 0 ; i
< nb
; i
++) {
268 tcs
= (LttvTraceStats
*)(LTTV_TRACESET_CONTEXT(tscs
)->traces
[i
]);
270 desc
= ltt_trace_system_description(tcs
->parent
.parent
.t
);
271 LttTime start_time
= ltt_trace_system_description_trace_start_time(desc
);
272 fprintf(fp
, "Trace on system %s at time %lu.%09lu :\n",
273 ltt_trace_system_description_node_name(desc
),
277 saved_length
= indent
->len
;
278 g_string_append(indent
, " ");
279 print_tree(fp
, indent
, tcs
->stats
);
280 g_string_truncate(indent
, saved_length
);
282 g_string_free(indent
, TRUE
);
286 /* Insert the hooks before and after each trace and tracefile, and for each
287 event. Print a global header. */
291 static GString
*a_string
;
293 static gboolean
write_traceset_header(void *hook_data
, void *call_data
)
295 LttvTracesetContext
*tc
= (LttvTracesetContext
*)call_data
;
297 g_info("TextDump traceset header");
299 if(a_file_name
== NULL
) a_file
= stdout
;
300 else a_file
= fopen(a_file_name
, "w");
302 if(a_file
== NULL
) g_error("cannot open file %s", a_file_name
);
304 /* Print the trace set header */
305 fprintf(a_file
,"Trace set contains %d traces\n\n",
306 lttv_traceset_number(tc
->ts
));
312 static gboolean
write_traceset_footer(void *hook_data
, void *call_data
)
314 LttvTracesetContext
*tc
= (LttvTracesetContext
*)call_data
;
316 g_info("TextDump traceset footer");
318 fprintf(a_file
,"End trace set\n\n");
320 if(LTTV_IS_TRACESET_STATS(tc
)) {
321 lttv_stats_sum_traceset((LttvTracesetStats
*)tc
);
322 print_stats(a_file
, (LttvTracesetStats
*)tc
);
325 if(a_file_name
!= NULL
) fclose(a_file
);
331 static gboolean
write_trace_header(void *hook_data
, void *call_data
)
333 LttvTraceContext
*tc
= (LttvTraceContext
*)call_data
;
335 LttSystemDescription
*system
= ltt_trace_system_description(tc
->t
);
337 fprintf(a_file
," Trace from %s in %s\n%s\n\n",
338 ltt_trace_system_description_node_name(system
),
339 ltt_trace_system_description_domain_name(system
),
340 ltt_trace_system_description_description(system
));
346 static int write_event_content(void *hook_data
, void *call_data
)
348 LttvIAttribute
*attributes
= LTTV_IATTRIBUTE(lttv_global_attributes());
350 LttvTracefileContext
*tfc
= (LttvTracefileContext
*)call_data
;
352 LttvTracefileState
*tfs
= (LttvTracefileState
*)call_data
;
356 LttvAttributeValue value_filter
;
360 e
= ltt_tracefile_get_event(tfc
->tf
);
363 g_assert(lttv_iattribute_find_by_path(attributes
, "filter/lttv_filter",
364 LTTV_POINTER
, &value_filter
));
365 filter
= (LttvFilter
*)*(value_filter
.v_pointer
);
368 * call to the filter if available
370 if(filter
->head
!= NULL
)
371 if(!lttv_filter_tree_parse(filter
->head
,e
,tfc
->tf
,tfc
->t_context
->t
,tfs
->process
,tfc
))
374 lttv_event_to_string(e
, a_string
, TRUE
, a_field_names
, tfs
);
375 g_string_append_printf(a_string
,"\n");
378 g_string_append_printf(a_string
, " %s ",
379 g_quark_to_string(tfs
->process
->state
->s
));
382 fputs(a_string
->str
, a_file
);
389 LttvAttributeValue value
;
391 LttvIAttribute
*attributes
= LTTV_IATTRIBUTE(lttv_global_attributes());
393 g_info("Init textDump.c");
395 a_string
= g_string_new("");
398 lttv_option_add("output", 'o',
399 "output file where the text is written",
401 LTTV_OPT_STRING
, &a_file_name
, NULL
, NULL
);
403 a_field_names
= FALSE
;
404 lttv_option_add("field_names", 'l',
405 "write the field names for each event",
407 LTTV_OPT_NONE
, &a_field_names
, NULL
, NULL
);
410 lttv_option_add("process_state", 's',
411 "write the pid and state for each event",
413 LTTV_OPT_NONE
, &a_state
, NULL
, NULL
);
416 lttv_option_add("cpu_stats", 'c',
417 "write the per cpu statistics",
419 LTTV_OPT_NONE
, &a_cpu_stats
, NULL
, NULL
);
421 a_process_stats
= FALSE
;
422 lttv_option_add("process_stats", 'p',
423 "write the per process statistics",
425 LTTV_OPT_NONE
, &a_process_stats
, NULL
, NULL
);
427 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/event",
428 LTTV_POINTER
, &value
));
429 g_assert((event_hook
= *(value
.v_pointer
)) != NULL
);
430 lttv_hooks_add(event_hook
, write_event_content
, NULL
, LTTV_PRIO_DEFAULT
);
432 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/trace/before",
433 LTTV_POINTER
, &value
));
434 g_assert((before_trace
= *(value
.v_pointer
)) != NULL
);
435 lttv_hooks_add(before_trace
, write_trace_header
, NULL
, LTTV_PRIO_DEFAULT
);
437 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/traceset/before",
438 LTTV_POINTER
, &value
));
439 g_assert((before_traceset
= *(value
.v_pointer
)) != NULL
);
440 lttv_hooks_add(before_traceset
, write_traceset_header
, NULL
,
443 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/traceset/after",
444 LTTV_POINTER
, &value
));
445 g_assert((after_traceset
= *(value
.v_pointer
)) != NULL
);
446 lttv_hooks_add(after_traceset
, write_traceset_footer
, NULL
,
451 static void destroy()
453 g_info("Destroy textDump");
455 lttv_option_remove("output");
457 lttv_option_remove("field_names");
459 lttv_option_remove("process_state");
461 lttv_option_remove("cpu_stats");
463 lttv_option_remove("process_stats");
465 g_string_free(a_string
, TRUE
);
467 lttv_hooks_remove_data(event_hook
, write_event_content
, NULL
);
469 lttv_hooks_remove_data(before_trace
, write_trace_header
, NULL
);
471 lttv_hooks_remove_data(before_trace
, write_traceset_header
, NULL
);
473 lttv_hooks_remove_data(before_trace
, write_traceset_footer
, NULL
);
477 LTTV_MODULE("textDump", "Print events in a file", \
478 "Produce a detailed text printout of a trace", \
479 init
, destroy
, "stats", "batchAnalysis", "option")