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 guint cpu
= ltt_tracefile_num(tfs
->parent
.tf
);
158 LttvTraceState
*ts
= (LttvTraceState
*)tfs
->parent
.t_context
;
159 LttvProcessState
*process
= ts
->running_process
[cpu
];
161 g_string_set_size(s
,0);
163 facility
= ltt_event_facility(e
);
164 event_type
= ltt_event_eventtype(e
);
165 field
= ltt_event_field(e
);
167 if(mandatory_fields
) {
168 time
= ltt_event_time(e
);
169 g_string_append_printf(s
,"%s.%s: %ld.%09ld (%s)",
170 g_quark_to_string(ltt_facility_name(facility
)),
171 g_quark_to_string(ltt_eventtype_name(event_type
)),
172 (long)time
.tv_sec
, time
.tv_nsec
,
173 g_quark_to_string(ltt_tracefile_name(tfs
->parent
.tf
)));
174 /* Print the process id and the state/interrupt type of the process */
175 g_string_append_printf(s
,", %u, %u, %s", process
->pid
,
177 g_quark_to_string(process
->state
->t
));
181 print_field(e
, field
, s
, field_names
);
186 print_tree(FILE *fp
, GString
*indent
, LttvAttribute
*tree
)
188 int i
, nb
, saved_length
;
190 LttvAttribute
*subtree
;
192 LttvAttributeName name
;
194 LttvAttributeValue value
;
196 LttvAttributeType type
;
198 nb
= lttv_attribute_get_number(tree
);
199 for(i
= 0 ; i
< nb
; i
++) {
200 type
= lttv_attribute_get(tree
, i
, &name
, &value
);
201 fprintf(fp
, "%s%s: ", indent
->str
, g_quark_to_string(name
));
205 fprintf(fp
, "%d\n", *value
.v_int
);
208 fprintf(fp
, "%u\n", *value
.v_uint
);
211 fprintf(fp
, "%ld\n", *value
.v_long
);
214 fprintf(fp
, "%lu\n", *value
.v_ulong
);
217 fprintf(fp
, "%f\n", (double)*value
.v_float
);
220 fprintf(fp
, "%f\n", *value
.v_double
);
223 fprintf(fp
, "%10lu.%09lu\n", value
.v_time
->tv_sec
,
224 value
.v_time
->tv_nsec
);
227 fprintf(fp
, "POINTER\n");
230 fprintf(fp
, "%s\n", *value
.v_string
);
233 if(LTTV_IS_ATTRIBUTE(*(value
.v_gobject
))) {
235 subtree
= (LttvAttribute
*)*(value
.v_gobject
);
236 saved_length
= indent
->len
;
237 g_string_append(indent
, " ");
238 print_tree(fp
, indent
, subtree
);
239 g_string_truncate(indent
, saved_length
);
241 else fprintf(fp
, "GOBJECT\n");
251 print_stats(FILE *fp
, LttvTracesetStats
*tscs
)
253 int i
, nb
, saved_length
;
261 LttSystemDescription
*desc
;
263 if(tscs
->stats
== NULL
) return;
264 indent
= g_string_new("");
265 fprintf(fp
, "Traceset statistics:\n\n");
266 print_tree(fp
, indent
, tscs
->stats
);
268 ts
= tscs
->parent
.parent
.ts
;
269 nb
= lttv_traceset_number(ts
);
271 for(i
= 0 ; i
< nb
; i
++) {
272 tcs
= (LttvTraceStats
*)(LTTV_TRACESET_CONTEXT(tscs
)->traces
[i
]);
274 desc
= ltt_trace_system_description(tcs
->parent
.parent
.t
);
275 LttTime start_time
= ltt_trace_system_description_trace_start_time(desc
);
276 fprintf(fp
, "Trace on system %s at time %lu.%09lu :\n",
277 ltt_trace_system_description_node_name(desc
),
281 saved_length
= indent
->len
;
282 g_string_append(indent
, " ");
283 print_tree(fp
, indent
, tcs
->stats
);
284 g_string_truncate(indent
, saved_length
);
286 g_string_free(indent
, TRUE
);
290 /* Insert the hooks before and after each trace and tracefile, and for each
291 event. Print a global header. */
295 static GString
*a_string
;
297 static gboolean
write_traceset_header(void *hook_data
, void *call_data
)
299 LttvTracesetContext
*tc
= (LttvTracesetContext
*)call_data
;
301 g_info("TextDump traceset header");
303 if(a_file_name
== NULL
) a_file
= stdout
;
304 else a_file
= fopen(a_file_name
, "w");
306 if(a_file
== NULL
) g_error("cannot open file %s", a_file_name
);
308 /* Print the trace set header */
309 fprintf(a_file
,"Trace set contains %d traces\n\n",
310 lttv_traceset_number(tc
->ts
));
316 static gboolean
write_traceset_footer(void *hook_data
, void *call_data
)
318 LttvTracesetContext
*tc
= (LttvTracesetContext
*)call_data
;
320 g_info("TextDump traceset footer");
322 fprintf(a_file
,"End trace set\n\n");
324 if(LTTV_IS_TRACESET_STATS(tc
)) {
325 lttv_stats_sum_traceset((LttvTracesetStats
*)tc
);
326 print_stats(a_file
, (LttvTracesetStats
*)tc
);
329 if(a_file_name
!= NULL
) fclose(a_file
);
335 static gboolean
write_trace_header(void *hook_data
, void *call_data
)
337 LttvTraceContext
*tc
= (LttvTraceContext
*)call_data
;
339 LttSystemDescription
*system
= ltt_trace_system_description(tc
->t
);
341 fprintf(a_file
," Trace from %s in %s\n%s\n\n",
342 ltt_trace_system_description_node_name(system
),
343 ltt_trace_system_description_domain_name(system
),
344 ltt_trace_system_description_description(system
));
350 static int write_event_content(void *hook_data
, void *call_data
)
352 LttvIAttribute
*attributes
= LTTV_IATTRIBUTE(lttv_global_attributes());
354 LttvTracefileContext
*tfc
= (LttvTracefileContext
*)call_data
;
356 LttvTracefileState
*tfs
= (LttvTracefileState
*)call_data
;
360 LttvAttributeValue value_filter
;
364 guint cpu
= ltt_tracefile_num(tfs
->parent
.tf
);
365 LttvTraceState
*ts
= (LttvTraceState
*)tfc
->t_context
;
366 LttvProcessState
*process
= ts
->running_process
[cpu
];
368 e
= ltt_tracefile_get_event(tfc
->tf
);
370 g_assert(lttv_iattribute_find_by_path(attributes
, "filter/lttv_filter",
371 LTTV_POINTER
, &value_filter
));
372 filter
= (LttvFilter
*)*(value_filter
.v_pointer
);
375 * call to the filter if available
377 if(filter
->head
!= NULL
)
378 if(!lttv_filter_tree_parse(filter
->head
,e
,tfc
->tf
,
379 tfc
->t_context
->t
,process
,tfc
))
382 lttv_event_to_string(e
, a_string
, TRUE
, a_field_names
, tfs
);
383 g_string_append_printf(a_string
,"\n");
386 g_string_append_printf(a_string
, " %s ",
387 g_quark_to_string(process
->state
->s
));
390 fputs(a_string
->str
, a_file
);
397 LttvAttributeValue value
;
399 LttvIAttribute
*attributes
= LTTV_IATTRIBUTE(lttv_global_attributes());
401 g_info("Init textDump.c");
403 a_string
= g_string_new("");
406 lttv_option_add("output", 'o',
407 "output file where the text is written",
409 LTTV_OPT_STRING
, &a_file_name
, NULL
, NULL
);
411 a_field_names
= FALSE
;
412 lttv_option_add("field_names", 'l',
413 "write the field names for each event",
415 LTTV_OPT_NONE
, &a_field_names
, NULL
, NULL
);
418 lttv_option_add("process_state", 's',
419 "write the pid and state for each event",
421 LTTV_OPT_NONE
, &a_state
, NULL
, NULL
);
424 lttv_option_add("cpu_stats", 'c',
425 "write the per cpu statistics",
427 LTTV_OPT_NONE
, &a_cpu_stats
, NULL
, NULL
);
429 a_process_stats
= FALSE
;
430 lttv_option_add("process_stats", 'p',
431 "write the per process statistics",
433 LTTV_OPT_NONE
, &a_process_stats
, NULL
, NULL
);
435 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/event",
436 LTTV_POINTER
, &value
));
437 g_assert((event_hook
= *(value
.v_pointer
)) != NULL
);
438 lttv_hooks_add(event_hook
, write_event_content
, NULL
, LTTV_PRIO_DEFAULT
);
440 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/trace/before",
441 LTTV_POINTER
, &value
));
442 g_assert((before_trace
= *(value
.v_pointer
)) != NULL
);
443 lttv_hooks_add(before_trace
, write_trace_header
, NULL
, LTTV_PRIO_DEFAULT
);
445 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/traceset/before",
446 LTTV_POINTER
, &value
));
447 g_assert((before_traceset
= *(value
.v_pointer
)) != NULL
);
448 lttv_hooks_add(before_traceset
, write_traceset_header
, NULL
,
451 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/traceset/after",
452 LTTV_POINTER
, &value
));
453 g_assert((after_traceset
= *(value
.v_pointer
)) != NULL
);
454 lttv_hooks_add(after_traceset
, write_traceset_footer
, NULL
,
459 static void destroy()
461 g_info("Destroy textDump");
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 g_string_free(a_string
, TRUE
);
475 lttv_hooks_remove_data(event_hook
, write_event_content
, NULL
);
477 lttv_hooks_remove_data(before_trace
, write_trace_header
, NULL
);
479 lttv_hooks_remove_data(before_trace
, write_traceset_header
, NULL
);
481 lttv_hooks_remove_data(before_trace
, write_traceset_footer
, NULL
);
485 LTTV_MODULE("textDump", "Print events in a file", \
486 "Produce a detailed text printout of a trace", \
487 init
, destroy
, "stats", "batchAnalysis", "option")