1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Xiangxiu Yang
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,
28 #include <sys/types.h>
36 #include "ltt-private.h"
37 #include <ltt/facility.h>
45 /* search for the (named) type in the table, if it does not exist
47 LttType
* lookup_named_type(LttFacility
*fac
, type_descriptor_t
* td
);
49 /* construct directed acyclic graph for types, and tree for fields */
50 void construct_types_and_fields(LttFacility
* fac
, type_descriptor_t
* td
,
53 /* generate the facility according to the events belongin to it */
54 void generateFacility(LttFacility
* f
, facility_t
* fac
,
57 /* functions to release the memory occupied by a facility */
58 void freeFacility(LttFacility
* facility
);
59 void freeEventtype(LttEventType
* evType
);
60 void freeLttType(LttType
** type
);
61 void freeLttField(LttField
* fld
);
62 void freeLttNamedType(LttType
* type
);
65 /*****************************************************************************
67 * ltt_facility_open : open facilities
69 * t : the trace containing the facilities
70 * pathname : the path name of the facility
72 *returns 0 on success, 1 on error.
73 ****************************************************************************/
75 int ltt_facility_open(LttFacility
*f
, LttTrace
* t
, gchar
* pathname
)
81 unsigned long checksum
;
82 //GError * error = NULL;
83 gchar buffer
[BUFFER_SIZE
];
85 in
.buffer
= &(buffer
[0]);
87 in
.error
= error_callback
;
91 //in.fd = g_open(in.name, O_RDONLY, 0);
93 in
.fp
= fopen(in
.name
, "r");
95 g_warning("cannot open facility description file %s",
101 //in.channel = g_io_channel_unix_new(in.fd);
105 token
= getToken(&in
);
106 if(in
.type
== ENDFILE
) break;
108 if(g_ascii_strcasecmp(token
, "<")) in
.error(&in
,"not a facility file");
109 token
= getName(&in
);
111 if(g_ascii_strcasecmp("facility",token
) == 0) {
112 fac
= g_new(facility_t
, 1);
114 fac
->description
= NULL
;
115 sequence_init(&(fac
->events
));
116 table_init(&(fac
->named_types
));
117 sequence_init(&(fac
->unnamed_types
));
119 parseFacility(&in
, fac
);
121 //check if any namedType is not defined
122 checkNamedTypesImplemented(&fac
->named_types
);
124 generateChecksum(fac
->name
, &checksum
, &fac
->events
);
126 generateFacility(f
, fac
, checksum
);
130 g_free(fac
->description
);
131 freeEvents(&fac
->events
);
132 sequence_dispose(&fac
->events
);
133 freeNamedType(&fac
->named_types
);
134 table_dispose(&fac
->named_types
);
135 freeTypes(&fac
->unnamed_types
);
136 sequence_dispose(&fac
->unnamed_types
);
140 g_warning("facility token was expected in file %s", in
.name
);
147 //g_io_channel_shutdown(in.channel, FALSE, &error); /* No flush */
148 //if(error != NULL) {
151 // g_warning("Can not close file: \n%s\n", error->message);
152 // g_error_free(error);
160 /*****************************************************************************
162 * generateFacility : generate facility, internal function
164 * facility : LttFacilty structure
165 * fac : facility structure
166 * checksum : checksum of the facility
167 ****************************************************************************/
169 void generateFacility(LttFacility
*f
, facility_t
*fac
, guint32 checksum
)
171 char * facilityName
= fac
->name
;
172 sequence_t
* events
= &fac
->events
;
174 //LttEventType * evType;
175 LttEventType
* event_type
;
179 g_assert(f
->name
== g_quark_from_string(facilityName
));
180 g_assert(f
->checksum
== checksum
);
182 //f->event_number = events->position;
184 //initialize inner structures
185 f
->events
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttEventType
),
187 //f->events = g_new(LttEventType*,f->event_number);
188 f
->events
= g_array_set_size(f
->events
, events
->position
);
190 g_datalist_init(&f
->events_by_name
);
191 g_datalist_init(&f
->named_types
);
193 //f->named_types_number = fac->named_types.keys.position;
194 //f->named_types = g_array_sized_new (FALSE, TRUE, sizeof(LttType),
195 // fac->named_types.keys.position);
196 //f->named_types = g_new(LttType*, fac->named_types.keys.position);
197 //f->named_types = g_array_set_size(f->named_types,
198 // fac->named_types.keys.position);
200 //for each event, construct field tree and type graph
201 for(i
=0;i
<events
->position
;i
++){
202 event_type
= &g_array_index(f
->events
, LttEventType
, i
);
203 //evType = g_new(LttEventType,1);
204 //f->events[i] = evType;
207 g_quark_from_string(((event_t
*)(events
->array
[i
]))->name
);
209 g_datalist_id_set_data(&f
->events_by_name
, event_type
->name
,
212 event_type
->description
=
213 g_strdup(((event_t
*)(events
->array
[i
]))->description
);
215 field
= g_new(LttField
, 1);
216 event_type
->root_field
= field
;
217 event_type
->facility
= f
;
218 event_type
->index
= i
;
220 if(((event_t
*)(events
->array
[i
]))->type
!= NULL
){
221 // field->field_pos = 0;
222 type
= lookup_named_type(f
,((event_t
*)(events
->array
[i
]))->type
);
223 field
->field_type
= type
;
224 field
->offset_root
= 0;
225 field
->fixed_root
= FIELD_UNKNOWN
;
226 field
->offset_parent
= 0;
227 field
->fixed_parent
= FIELD_UNKNOWN
;
228 // field->base_address = NULL;
229 field
->field_size
= 0;
230 field
->fixed_size
= FIELD_UNKNOWN
;
231 field
->parent
= NULL
;
233 field
->current_element
= 0;
235 //construct field tree and type graph
236 construct_types_and_fields(f
,((event_t
*)(events
->array
[i
]))->type
,field
);
238 event_type
->root_field
= NULL
;
245 /*****************************************************************************
247 * construct_types_and_fields : construct field tree and type graph,
248 * internal recursion function
250 * fac : facility struct
251 * td : type descriptor
252 * root_field : root field of the event
253 ****************************************************************************/
256 void construct_types_and_fields(LttFacility
* fac
, type_descriptor_t
* td
,
260 type_descriptor_t
* tmpTd
;
266 fld
->field_type
->size
= td
->size
;
274 fld
->field_type
->size
= 0;
277 fld
->field_type
->size
= 0;
280 fld
->field_type
->element_number
= td
->labels
.position
;
281 fld
->field_type
->enum_strings
= g_new(GQuark
,td
->labels
.position
);
282 for(i
=0;i
<td
->labels
.position
;i
++){
283 fld
->field_type
->enum_strings
[i
]
284 = g_quark_from_string(((char*)(td
->labels
.array
[i
])));
286 fld
->field_type
->size
= td
->size
;
290 fld
->field_type
->element_number
= (unsigned)td
->size
;
292 fld
->field_type
->element_type
= g_new(LttType
*,1);
293 tmpTd
= td
->nested_type
;
294 fld
->field_type
->element_type
[0] = lookup_named_type(fac
, tmpTd
);
295 fld
->child
= g_new(LttField
*, 1);
296 fld
->child
[0] = g_new(LttField
, 1);
298 fld
->child
[0]->field_type
= fld
->field_type
->element_type
[0];
299 fld
->child
[0]->offset_root
= 0;
300 fld
->child
[0]->fixed_root
= FIELD_UNKNOWN
;
301 fld
->child
[0]->offset_parent
= 0;
302 fld
->child
[0]->fixed_parent
= FIELD_UNKNOWN
;
303 fld
->child
[0]->field_size
= 0;
304 fld
->child
[0]->fixed_size
= FIELD_UNKNOWN
;
305 fld
->child
[0]->parent
= fld
;
306 fld
->child
[0]->child
= NULL
;
307 fld
->child
[0]->current_element
= 0;
308 construct_types_and_fields(fac
, tmpTd
, fld
->child
[0]);
313 fld
->field_type
->element_number
= td
->fields
.position
;
315 g_assert(fld
->field_type
->element_type
== NULL
);
316 fld
->field_type
->element_type
= g_new(LttType
*, td
->fields
.position
);
318 fld
->child
= g_new(LttField
*, td
->fields
.position
);
319 for(i
=0;i
<td
->fields
.position
;i
++){
320 tmpTd
= ((field_t
*)(td
->fields
.array
[i
]))->type
;
322 fld
->field_type
->element_type
[i
] = lookup_named_type(fac
, tmpTd
);
323 fld
->child
[i
] = g_new(LttField
,1);
325 // fld->child[i]->field_pos = i;
326 fld
->child
[i
]->field_type
= fld
->field_type
->element_type
[i
];
328 fld
->child
[i
]->field_type
->element_name
329 = g_quark_from_string(((field_t
*)(td
->fields
.array
[i
]))->name
);
331 fld
->child
[i
]->offset_root
= 0;
332 fld
->child
[i
]->fixed_root
= FIELD_UNKNOWN
;
333 fld
->child
[i
]->offset_parent
= 0;
334 fld
->child
[i
]->fixed_parent
= FIELD_UNKNOWN
;
335 fld
->child
[i
]->field_size
= 0;
336 fld
->child
[i
]->fixed_size
= FIELD_UNKNOWN
;
337 fld
->child
[i
]->parent
= fld
;
338 fld
->child
[i
]->child
= NULL
;
339 fld
->child
[i
]->current_element
= 0;
340 construct_types_and_fields(fac
, tmpTd
, fld
->child
[i
]);
345 g_error("construct_types_and_fields : unknown type");
354 void construct_types_and_fields(LttFacility
* fac
, type_descriptor
* td
,
358 type_descriptor
* tmpTd
;
360 // if(td->type == LTT_STRING || td->type == LTT_SEQUENCE)
361 // fld->field_size = 0;
362 // else fld->field_size = -1;
364 if(td
->type
== LTT_ENUM
){
365 fld
->field_type
->element_number
= td
->labels
.position
;
366 fld
->field_type
->enum_strings
= g_new(GQuark
,td
->labels
.position
);
367 for(i
=0;i
<td
->labels
.position
;i
++){
368 fld
->field_type
->enum_strings
[i
]
369 = g_quark_from_string(((char*)(td
->labels
.array
[i
])));
371 }else if(td
->type
== LTT_ARRAY
|| td
->type
== LTT_SEQUENCE
){
372 if(td
->type
== LTT_ARRAY
)
373 fld
->field_type
->element_number
= (unsigned)td
->size
;
374 fld
->field_type
->element_type
= g_new(LttType
*,1);
375 tmpTd
= td
->nested_type
;
376 fld
->field_type
->element_type
[0] = lookup_named_type(fac
, tmpTd
);
377 fld
->child
= g_new(LttField
*, 1);
378 fld
->child
[0] = g_new(LttField
, 1);
380 // fld->child[0]->field_pos = 0;
381 fld
->child
[0]->field_type
= fld
->field_type
->element_type
[0];
382 fld
->child
[0]->offset_root
= fld
->offset_root
;
383 fld
->child
[0]->fixed_root
= fld
->fixed_root
;
384 fld
->child
[0]->offset_parent
= 0;
385 fld
->child
[0]->fixed_parent
= 1;
386 // fld->child[0]->base_address = NULL;
387 fld
->child
[0]->field_size
= 0;
388 fld
->child
[0]->field_fixed
= -1;
389 fld
->child
[0]->parent
= fld
;
390 fld
->child
[0]->child
= NULL
;
391 fld
->child
[0]->current_element
= 0;
392 construct_types_and_fields(fac
, tmpTd
, fld
->child
[0]);
393 }else if(td
->type
== LTT_STRUCT
){
394 fld
->field_type
->element_number
= td
->fields
.position
;
396 if(fld
->field_type
->element_type
== NULL
){
397 fld
->field_type
->element_type
= g_new(LttType
*, td
->fields
.position
);
403 fld
->child
= g_new(LttField
*, td
->fields
.position
);
404 for(i
=0;i
<td
->fields
.position
;i
++){
405 tmpTd
= ((type_fields
*)(td
->fields
.array
[i
]))->type
;
408 fld
->field_type
->element_type
[i
] = lookup_named_type(fac
, tmpTd
);
409 fld
->child
[i
] = g_new(LttField
,1);
411 fld
->child
[i
]->field_pos
= i
;
412 fld
->child
[i
]->field_type
= fld
->field_type
->element_type
[i
];
415 fld
->child
[i
]->field_type
->element_name
416 = g_quark_from_string(((type_fields
*)(td
->fields
.array
[i
]))->name
);
419 fld
->child
[i
]->offset_root
= -1;
420 fld
->child
[i
]->fixed_root
= -1;
421 fld
->child
[i
]->offset_parent
= -1;
422 fld
->child
[i
]->fixed_parent
= -1;
423 // fld->child[i]->base_address = NULL;
424 fld
->child
[i
]->field_size
= 0;
425 fld
->child
[i
]->field_fixed
= -1;
426 fld
->child
[i
]->parent
= fld
;
427 fld
->child
[i
]->child
= NULL
;
428 fld
->child
[i
]->current_element
= 0;
429 construct_types_and_fields(fac
, tmpTd
, fld
->child
[i
]);
435 /*****************************************************************************
437 * lookup_named_type: search named type in the table
440 * fac : facility struct
441 * td : type descriptor
443 * : either find the named type, or create a new LttType
444 ****************************************************************************/
446 LttType
* lookup_named_type(LttFacility
*fac
, type_descriptor_t
* td
)
448 LttType
*type
= NULL
;
451 if(td
->type_name
!= NULL
) {
453 name
= g_quark_from_string(td
->type_name
);
455 type
= g_datalist_id_get_data(&fac
->named_types
, name
);
459 /* Create the type */
460 type
= g_new(LttType
,1);
461 type
->type_name
= name
;
462 type
->type_class
= td
->type
;
463 if(td
->fmt
) type
->fmt
= g_strdup(td
->fmt
);
464 else type
->fmt
= NULL
;
465 type
->size
= td
->size
;
466 type
->enum_strings
= NULL
;
467 type
->element_type
= NULL
;
468 type
->element_number
= 0;
470 if(td
->type_name
!= NULL
)
471 g_datalist_id_set_data_full(&fac
->named_types
, name
,
472 type
, (GDestroyNotify
)freeLttNamedType
);
478 /*****************************************************************************
480 * ltt_facility_close : close a facility, decrease its usage count,
481 * if usage count = 0, release the memory
483 * f : facility that will be closed
484 ****************************************************************************/
486 void ltt_facility_close(LttFacility
*f
)
488 //release the memory it occupied
492 /*****************************************************************************
493 * Functions to release the memory occupied by the facility
494 ****************************************************************************/
496 void freeFacility(LttFacility
* fac
)
501 for(i
=0; i
<fac
->events
->len
; i
++) {
502 et
= &g_array_index (fac
->events
, LttEventType
, i
);
505 g_array_free(fac
->events
, TRUE
);
507 g_datalist_clear(&fac
->named_types
);
511 void freeEventtype(LttEventType
* evType
)
514 if(evType
->description
)
515 g_free(evType
->description
);
516 if(evType
->root_field
){
517 root_type
= evType
->root_field
->field_type
;
518 freeLttField(evType
->root_field
);
519 freeLttType(&root_type
);
523 void freeLttNamedType(LttType
* type
)
528 void freeLttType(LttType
** type
)
531 if(*type
== NULL
) return;
532 if((*type
)->type_name
!= 0) return; //this is a named type.
533 //if((*type)->type_name){
534 // return; //this is a named type
537 g_free((*type
)->fmt
);
538 if((*type
)->enum_strings
){
539 g_free((*type
)->enum_strings
);
542 if((*type
)->element_type
){
543 for(i
=0;i
<(*type
)->element_number
;i
++)
544 freeLttType(&((*type
)->element_type
[i
]));
545 g_free((*type
)->element_type
);
551 void freeLttField(LttField
* fld
)
557 if(fld
->field_type
->type_class
== LTT_ARRAY
||
558 fld
->field_type
->type_class
== LTT_SEQUENCE
){
560 }else if(fld
->field_type
->type_class
== LTT_STRUCT
){
561 size
= fld
->field_type
->element_number
;
566 for(i
=0; i
<size
; i
++){
567 if(fld
->child
[i
])freeLttField(fld
->child
[i
]);
574 /*****************************************************************************
576 * ltt_facility_name : obtain the facility's name
580 * GQuark : the facility's name
581 ****************************************************************************/
583 GQuark
ltt_facility_name(LttFacility
*f
)
588 /*****************************************************************************
590 * ltt_facility_checksum : obtain the facility's checksum
594 * : the checksum of the facility
595 ****************************************************************************/
597 guint32
ltt_facility_checksum(LttFacility
*f
)
602 /*****************************************************************************
604 * ltt_facility_base_id : obtain the facility base id
608 * : the base id of the facility
609 ****************************************************************************/
611 guint
ltt_facility_id(LttFacility
*f
)
616 /*****************************************************************************
618 * ltt_facility_eventtype_number: obtain the number of the event types
620 * f : the facility that will be closed
622 * : the number of the event types
623 ****************************************************************************/
625 guint8
ltt_facility_eventtype_number(LttFacility
*f
)
627 return (f
->events
->len
);
630 /*****************************************************************************
632 * ltt_facility_eventtype_get: obtain the event type according to event id
633 * from 0 to event_number - 1
635 * f : the facility that will be closed
637 * LttEventType * : the event type required
638 ****************************************************************************/
640 LttEventType
*ltt_facility_eventtype_get(LttFacility
*f
, guint8 i
)
642 if(!f
->exists
) return NULL
;
644 g_assert(i
< f
->events
->len
);
645 return &g_array_index(f
->events
, LttEventType
, i
);
648 /*****************************************************************************
650 * ltt_facility_eventtype_get_by_name
651 * : obtain the event type according to event name
652 * event name is unique in the facility
655 * name : the name of the event
657 * LttEventType * : the event type required
658 ****************************************************************************/
660 LttEventType
*ltt_facility_eventtype_get_by_name(LttFacility
*f
, GQuark name
)
662 LttEventType
*et
= g_datalist_id_get_data(&f
->events_by_name
, name
);
This page took 0.043509 seconds and 4 git commands to generate.