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
23 #include <lttv/lttv.h>
24 #include <lttv/option.h>
25 #include <lttv/module.h>
26 #include <lttv/hook.h>
27 #include <lttv/attribute.h>
28 #include <lttv/iattribute.h>
29 #include <lttv/stats.h>
30 #include <lttv/filter.h>
32 #include <ltt/event.h>
34 #include <ltt/trace.h>
35 #include <ltt/facility.h>
53 void print_field(LttEvent
*e
, LttField
*f
, GString
*s
, gboolean field_names
) {
63 type
= ltt_field_type(f
);
64 switch(ltt_type_class(type
)) {
66 g_string_append_printf(s
, " %lld", ltt_event_get_long_int(e
,f
));
70 g_string_append_printf(s
, " %llu", ltt_event_get_long_unsigned(e
,f
));
74 g_string_append_printf(s
, " %g", ltt_event_get_double(e
,f
));
78 g_string_append_printf(s
, " \"%s\"", ltt_event_get_string(e
,f
));
82 g_string_append_printf(s
, " %s", ltt_enum_string_get(type
,
83 ltt_event_get_unsigned(e
,f
)-1));
88 g_string_append_printf(s
, " {");
89 nb
= ltt_event_field_element_number(e
,f
);
90 element
= ltt_field_element(f
);
91 for(i
= 0 ; i
< nb
; i
++) {
92 ltt_event_field_element_select(e
,f
,i
);
93 print_field(e
, element
, s
, field_names
);
95 g_string_append_printf(s
, " }");
99 g_string_append_printf(s
, " {");
100 nb
= ltt_type_member_number(type
);
101 for(i
= 0 ; i
< nb
; i
++) {
102 element
= ltt_field_member(f
,i
);
104 ltt_type_member_type(type
, i
, &name
);
105 g_string_append_printf(s
, " %s = ", name
);
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 = ", name
);
121 print_field(e
, element
, s
, field_names
);
123 g_string_append_printf(s
, " }");
130 void lttv_event_to_string(LttEvent
*e
, GString
*s
,
131 gboolean mandatory_fields
, gboolean field_names
, LttvTracefileState
*tfs
)
133 LttFacility
*facility
;
135 LttEventType
*event_type
;
143 g_string_set_size(s
,0);
145 facility
= ltt_event_facility(e
);
146 event_type
= ltt_event_eventtype(e
);
147 field
= ltt_event_field(e
);
149 if(mandatory_fields
) {
150 time
= ltt_event_time(e
);
151 g_string_append_printf(s
,"%s.%s: %ld.%09ld (%s)",
152 ltt_facility_name(facility
),
153 ltt_eventtype_name(event_type
), (long)time
.tv_sec
, time
.tv_nsec
,
154 g_quark_to_string(tfs
->cpu_name
));
155 /* Print the process id and the state/interrupt type of the process */
156 g_string_append_printf(s
,", %u, %u, %s", tfs
->process
->pid
,
158 g_quark_to_string(tfs
->process
->state
->t
));
162 print_field(e
, field
, s
, field_names
);
167 print_tree(FILE *fp
, GString
*indent
, LttvAttribute
*tree
)
169 int i
, nb
, saved_length
;
171 LttvAttribute
*subtree
;
173 LttvAttributeName name
;
175 LttvAttributeValue value
;
177 LttvAttributeType type
;
179 nb
= lttv_attribute_get_number(tree
);
180 for(i
= 0 ; i
< nb
; i
++) {
181 type
= lttv_attribute_get(tree
, i
, &name
, &value
);
182 fprintf(fp
, "%s%s: ", indent
->str
, g_quark_to_string(name
));
186 fprintf(fp
, "%d\n", *value
.v_int
);
189 fprintf(fp
, "%u\n", *value
.v_uint
);
192 fprintf(fp
, "%ld\n", *value
.v_long
);
195 fprintf(fp
, "%lu\n", *value
.v_ulong
);
198 fprintf(fp
, "%f\n", (double)*value
.v_float
);
201 fprintf(fp
, "%f\n", *value
.v_double
);
204 fprintf(fp
, "%10lu.%09lu\n", value
.v_time
->tv_sec
,
205 value
.v_time
->tv_nsec
);
208 fprintf(fp
, "POINTER\n");
211 fprintf(fp
, "%s\n", *value
.v_string
);
214 if(LTTV_IS_ATTRIBUTE(*(value
.v_gobject
))) {
216 subtree
= (LttvAttribute
*)*(value
.v_gobject
);
217 saved_length
= indent
->len
;
218 g_string_append(indent
, " ");
219 print_tree(fp
, indent
, subtree
);
220 g_string_truncate(indent
, saved_length
);
222 else fprintf(fp
, "GOBJECT\n");
232 print_stats(FILE *fp
, LttvTracesetStats
*tscs
)
234 int i
, nb
, saved_length
;
242 LttSystemDescription
*desc
;
244 if(tscs
->stats
== NULL
) return;
245 indent
= g_string_new("");
246 fprintf(fp
, "Traceset statistics:\n\n");
247 print_tree(fp
, indent
, tscs
->stats
);
249 ts
= tscs
->parent
.parent
.ts
;
250 nb
= lttv_traceset_number(ts
);
252 for(i
= 0 ; i
< nb
; i
++) {
253 tcs
= (LttvTraceStats
*)(LTTV_TRACESET_CONTEXT(tscs
)->traces
[i
]);
254 desc
= ltt_trace_system_description(tcs
->parent
.parent
.t
);
255 LttTime start_time
= ltt_trace_system_description_trace_start_time(desc
);
256 fprintf(fp
, "Trace on system %s at time %lu.%09lu :\n",
257 ltt_trace_system_description_node_name(desc
),
260 saved_length
= indent
->len
;
261 g_string_append(indent
, " ");
262 print_tree(fp
, indent
, tcs
->stats
);
263 g_string_truncate(indent
, saved_length
);
265 g_string_free(indent
, TRUE
);
269 /* Insert the hooks before and after each trace and tracefile, and for each
270 event. Print a global header. */
274 static GString
*a_string
;
276 static gboolean
write_traceset_header(void *hook_data
, void *call_data
)
278 LttvTracesetContext
*tc
= (LttvTracesetContext
*)call_data
;
280 g_info("TextDump traceset header");
282 if(a_file_name
== NULL
) a_file
= stdout
;
283 else a_file
= fopen(a_file_name
, "w");
285 if(a_file
== NULL
) g_error("cannot open file %s", a_file_name
);
287 /* Print the trace set header */
288 fprintf(a_file
,"Trace set contains %d traces\n\n",
289 lttv_traceset_number(tc
->ts
));
295 static gboolean
write_traceset_footer(void *hook_data
, void *call_data
)
297 LttvTracesetContext
*tc
= (LttvTracesetContext
*)call_data
;
299 g_info("TextDump traceset footer");
301 fprintf(a_file
,"End trace set\n\n");
303 if(LTTV_IS_TRACESET_STATS(tc
)) {
304 lttv_stats_sum_traceset((LttvTracesetStats
*)tc
);
305 print_stats(a_file
, (LttvTracesetStats
*)tc
);
308 if(a_file_name
!= NULL
) fclose(a_file
);
314 static gboolean
write_trace_header(void *hook_data
, void *call_data
)
316 LttvTraceContext
*tc
= (LttvTraceContext
*)call_data
;
318 LttSystemDescription
*system
= ltt_trace_system_description(tc
->t
);
320 fprintf(a_file
," Trace from %s in %s\n%s\n\n",
321 ltt_trace_system_description_node_name(system
),
322 ltt_trace_system_description_domain_name(system
),
323 ltt_trace_system_description_description(system
));
328 static int write_event_content(void *hook_data
, void *call_data
)
330 LttvTracefileContext
*tfc
= (LttvTracefileContext
*)call_data
;
332 LttvTracefileState
*tfs
= (LttvTracefileState
*)call_data
;
339 * call to the filter if available
341 // lttv_filter_tree_parse(f->head,e,NULL,NULL,NULL);
343 lttv_event_to_string(e
, a_string
, TRUE
, a_field_names
, tfs
);
344 g_string_append_printf(a_string
,"\n");
347 g_string_append_printf(a_string
, " %s ",
348 g_quark_to_string(tfs
->process
->state
->s
));
351 fputs(a_string
->str
, a_file
);
358 LttvAttributeValue value
;
360 LttvIAttribute
*attributes
= LTTV_IATTRIBUTE(lttv_global_attributes());
362 g_info("Init textDump.c");
364 a_string
= g_string_new("");
367 lttv_option_add("output", 'o',
368 "output file where the text is written",
370 LTTV_OPT_STRING
, &a_file_name
, NULL
, NULL
);
372 a_field_names
= FALSE
;
373 lttv_option_add("field_names", 'l',
374 "write the field names for each event",
376 LTTV_OPT_NONE
, &a_field_names
, NULL
, NULL
);
379 lttv_option_add("process_state", 's',
380 "write the pid and state for each event",
382 LTTV_OPT_NONE
, &a_state
, NULL
, NULL
);
385 lttv_option_add("cpu_stats", 'c',
386 "write the per cpu statistics",
388 LTTV_OPT_NONE
, &a_cpu_stats
, NULL
, NULL
);
390 a_process_stats
= FALSE
;
391 lttv_option_add("process_stats", 'p',
392 "write the per process statistics",
394 LTTV_OPT_NONE
, &a_process_stats
, NULL
, NULL
);
396 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/event",
397 LTTV_POINTER
, &value
));
398 g_assert((event_hook
= *(value
.v_pointer
)) != NULL
);
399 lttv_hooks_add(event_hook
, write_event_content
, NULL
, LTTV_PRIO_DEFAULT
);
401 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/trace/before",
402 LTTV_POINTER
, &value
));
403 g_assert((before_trace
= *(value
.v_pointer
)) != NULL
);
404 lttv_hooks_add(before_trace
, write_trace_header
, NULL
, LTTV_PRIO_DEFAULT
);
406 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/traceset/before",
407 LTTV_POINTER
, &value
));
408 g_assert((before_traceset
= *(value
.v_pointer
)) != NULL
);
409 lttv_hooks_add(before_traceset
, write_traceset_header
, NULL
,
412 g_assert(lttv_iattribute_find_by_path(attributes
, "hooks/traceset/after",
413 LTTV_POINTER
, &value
));
414 g_assert((after_traceset
= *(value
.v_pointer
)) != NULL
);
415 lttv_hooks_add(after_traceset
, write_traceset_footer
, NULL
,
420 static void destroy()
422 g_info("Destroy textDump");
424 lttv_option_remove("output");
426 lttv_option_remove("field_names");
428 lttv_option_remove("process_state");
430 lttv_option_remove("cpu_stats");
432 lttv_option_remove("process_stats");
434 g_string_free(a_string
, TRUE
);
436 lttv_hooks_remove_data(event_hook
, write_event_content
, NULL
);
438 lttv_hooks_remove_data(before_trace
, write_trace_header
, NULL
);
440 lttv_hooks_remove_data(before_trace
, write_traceset_header
, NULL
);
442 lttv_hooks_remove_data(before_trace
, write_traceset_footer
, NULL
);
446 LTTV_MODULE("textDump", "Print events in a file", \
447 "Produce a detailed text printout of a trace", \
448 init
, destroy
, "stats", "batchAnalysis", "option")