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
* td
);
49 /* construct directed acyclic graph for types, and tree for fields */
50 void construct_types_and_fields(LttFacility
* fac
,type_descriptor
* 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
)
82 GError
* error
= NULL
;
83 gchar buffer
[BUFFER_SIZE
];
85 in
.buffer
= &(buffer
[0]);
87 in
.error
= error_callback
;
90 in
.fd
= g_open(in
.name
, O_RDONLY
, 0);
92 g_warning("cannot open facility description file %s",
97 in
.channel
= g_io_channel_unix_new(in
.fd
);
101 token
= getToken(&in
);
102 if(in
.type
== ENDFILE
) break;
104 if(g_ascii_strcasecmp(token
, "<")) in
.error(&in
,"not a facility file");
105 token
= getName(&in
);
107 if(g_ascii_strcasecmp("facility",token
) == 0) {
108 fac
= g_new(facility_t
, 1);
110 fac
->description
= NULL
;
111 sequence_init(&(fac
->events
));
112 table_init(&(fac
->named_types
));
113 sequence_init(&(fac
->unnamed_types
));
115 parseFacility(&in
, fac
);
117 //check if any namedType is not defined
118 g_assert(checkNamedTypesImplemented(&fac
->named_types
) == 0);
120 g_assert(generateChecksum(fac
->name
, &checksum
, &fac
->events
) == 0);
122 generateFacility(f
, fac
, checksum
);
125 g_free(fac
->description
);
126 freeEvents(&fac
->events
);
127 sequence_dispose(&fac
->events
);
128 freeNamedType(&fac
->named_types
);
129 table_dispose(&fac
->named_types
);
130 freeTypes(&fac
->unnamed_types
);
131 sequence_dispose(&fac
->unnamed_types
);
135 g_warning("facility token was expected in file %s", in
.name
);
141 g_io_channel_shutdown(in
.channel
, FALSE
, &error
); /* No flush */
143 g_warning("Can not close file: \n%s\n", error
->message
);
151 /*****************************************************************************
153 * generateFacility : generate facility, internal function
155 * facility : LttFacilty structure
156 * fac : facility structure
157 * checksum : checksum of the facility
158 ****************************************************************************/
160 void generateFacility(LttFacility
*f
, facility_t
*fac
, guint32 checksum
)
162 char * facilityName
= fac
->name
;
163 sequence
* events
= &fac
->events
;
165 //LttEventType * evType;
166 LttEventType
* event_type
;
170 g_assert(f
->name
== g_quark_from_string(facilityName
));
171 g_assert(f
->checksum
== checksum
);
173 //f->event_number = events->position;
175 //initialize inner structures
176 f
->events
= g_array_sized_new (FALSE
, TRUE
, sizeof(LttEventType
),
178 //f->events = g_new(LttEventType*,f->event_number);
179 f
->events
= g_array_set_size(f
->events
, events
->position
);
181 g_datalist_init(&f
->events_by_name
);
182 g_datalist_init(&f
->named_types
);
184 //f->named_types_number = fac->named_types.keys.position;
185 //f->named_types = g_array_sized_new (FALSE, TRUE, sizeof(LttType),
186 // fac->named_types.keys.position);
187 //f->named_types = g_new(LttType*, fac->named_types.keys.position);
188 //f->named_types = g_array_set_size(f->named_types,
189 // fac->named_types.keys.position);
191 //for each event, construct field tree and type graph
192 for(i
=0;i
<events
->position
;i
++){
193 event_type
= &g_array_index(f
->events
, LttEventType
, i
);
194 //evType = g_new(LttEventType,1);
195 //f->events[i] = evType;
198 g_quark_from_string(((event_t
*)(events
->array
[i
]))->name
);
200 g_datalist_id_set_data(&f
->events_by_name
, event_type
->name
,
203 event_type
->description
=
204 g_strdup(((event_t
*)(events
->array
[i
]))->description
);
206 field
= g_new(LttField
, 1);
207 event_type
->root_field
= field
;
208 event_type
->facility
= f
;
209 event_type
->index
= i
;
211 if(((event_t
*)(events
->array
[i
]))->type
!= NULL
){
212 // field->field_pos = 0;
213 type
= lookup_named_type(f
,((event_t
*)(events
->array
[i
]))->type
);
214 field
->field_type
= type
;
215 field
->offset_root
= 0;
216 field
->fixed_root
= FIELD_UNKNOWN
;
217 field
->offset_parent
= 0;
218 field
->fixed_parent
= FIELD_UNKNOWN
;
219 // field->base_address = NULL;
220 field
->field_size
= 0;
221 field
->fixed_size
= FIELD_UNKNOWN
;
222 field
->parent
= NULL
;
224 field
->current_element
= 0;
226 //construct field tree and type graph
227 construct_types_and_fields(f
,((event_t
*)(events
->array
[i
]))->type
,field
);
229 event_type
->root_field
= NULL
;
236 /*****************************************************************************
238 * construct_types_and_fields : construct field tree and type graph,
239 * internal recursion function
241 * fac : facility struct
242 * td : type descriptor
243 * root_field : root field of the event
244 ****************************************************************************/
247 void construct_types_and_fields(LttFacility
* fac
, type_descriptor
* td
,
251 type_descriptor
* tmpTd
;
255 fld
->field_type
->element_number
= td
->labels
.position
;
256 fld
->field_type
->enum_strings
= g_new(GQuark
,td
->labels
.position
);
257 for(i
=0;i
<td
->labels
.position
;i
++){
258 fld
->field_type
->enum_strings
[i
]
259 = g_quark_from_string(((char*)(td
->labels
.array
[i
])));
263 fld
->field_type
->element_number
= (unsigned)td
->size
;
265 fld
->field_type
->element_type
= g_new(LttType
*,1);
266 tmpTd
= td
->nested_type
;
267 fld
->field_type
->element_type
[0] = lookup_named_type(fac
, tmpTd
);
268 fld
->child
= g_new(LttField
*, 1);
269 fld
->child
[0] = g_new(LttField
, 1);
271 fld
->child
[0]->field_type
= fld
->field_type
->element_type
[0];
272 fld
->child
[0]->offset_root
= 0;
273 fld
->child
[0]->fixed_root
= FIELD_UNKNOWN
;
274 fld
->child
[0]->offset_parent
= 0;
275 fld
->child
[0]->fixed_parent
= FIELD_UNKNOWN
;
276 fld
->child
[0]->field_size
= 0;
277 fld
->child
[0]->fixed_size
= FIELD_UNKNOWN
;
278 fld
->child
[0]->parent
= fld
;
279 fld
->child
[0]->child
= NULL
;
280 fld
->child
[0]->current_element
= 0;
281 construct_types_and_fields(fac
, tmpTd
, fld
->child
[0]);
285 fld
->field_type
->element_number
= td
->fields
.position
;
287 g_assert(fld
->field_type
->element_type
== NULL
);
288 fld
->field_type
->element_type
= g_new(LttType
*, td
->fields
.position
);
290 fld
->child
= g_new(LttField
*, td
->fields
.position
);
291 for(i
=0;i
<td
->fields
.position
;i
++){
292 tmpTd
= ((type_fields
*)(td
->fields
.array
[i
]))->type
;
294 fld
->field_type
->element_type
[i
] = lookup_named_type(fac
, tmpTd
);
295 fld
->child
[i
] = g_new(LttField
,1);
297 // fld->child[i]->field_pos = i;
298 fld
->child
[i
]->field_type
= fld
->field_type
->element_type
[i
];
300 fld
->child
[i
]->field_type
->element_name
301 = g_quark_from_string(((type_fields
*)(td
->fields
.array
[i
]))->name
);
303 fld
->child
[i
]->offset_root
= 0;
304 fld
->child
[i
]->fixed_root
= FIELD_UNKNOWN
;
305 fld
->child
[i
]->offset_parent
= 0;
306 fld
->child
[i
]->fixed_parent
= FIELD_UNKNOWN
;
307 fld
->child
[i
]->field_size
= 0;
308 fld
->child
[i
]->fixed_size
= FIELD_UNKNOWN
;
309 fld
->child
[i
]->parent
= fld
;
310 fld
->child
[i
]->child
= NULL
;
311 fld
->child
[i
]->current_element
= 0;
312 construct_types_and_fields(fac
, tmpTd
, fld
->child
[i
]);
317 g_error("construct_types_and_fields : unknown type");
326 void construct_types_and_fields(LttFacility
* fac
, type_descriptor
* td
,
330 type_descriptor
* tmpTd
;
332 // if(td->type == LTT_STRING || td->type == LTT_SEQUENCE)
333 // fld->field_size = 0;
334 // else fld->field_size = -1;
336 if(td
->type
== LTT_ENUM
){
337 fld
->field_type
->element_number
= td
->labels
.position
;
338 fld
->field_type
->enum_strings
= g_new(GQuark
,td
->labels
.position
);
339 for(i
=0;i
<td
->labels
.position
;i
++){
340 fld
->field_type
->enum_strings
[i
]
341 = g_quark_from_string(((char*)(td
->labels
.array
[i
])));
343 }else if(td
->type
== LTT_ARRAY
|| td
->type
== LTT_SEQUENCE
){
344 if(td
->type
== LTT_ARRAY
)
345 fld
->field_type
->element_number
= (unsigned)td
->size
;
346 fld
->field_type
->element_type
= g_new(LttType
*,1);
347 tmpTd
= td
->nested_type
;
348 fld
->field_type
->element_type
[0] = lookup_named_type(fac
, tmpTd
);
349 fld
->child
= g_new(LttField
*, 1);
350 fld
->child
[0] = g_new(LttField
, 1);
352 // fld->child[0]->field_pos = 0;
353 fld
->child
[0]->field_type
= fld
->field_type
->element_type
[0];
354 fld
->child
[0]->offset_root
= fld
->offset_root
;
355 fld
->child
[0]->fixed_root
= fld
->fixed_root
;
356 fld
->child
[0]->offset_parent
= 0;
357 fld
->child
[0]->fixed_parent
= 1;
358 // fld->child[0]->base_address = NULL;
359 fld
->child
[0]->field_size
= 0;
360 fld
->child
[0]->field_fixed
= -1;
361 fld
->child
[0]->parent
= fld
;
362 fld
->child
[0]->child
= NULL
;
363 fld
->child
[0]->current_element
= 0;
364 construct_types_and_fields(fac
, tmpTd
, fld
->child
[0]);
365 }else if(td
->type
== LTT_STRUCT
){
366 fld
->field_type
->element_number
= td
->fields
.position
;
368 if(fld
->field_type
->element_type
== NULL
){
369 fld
->field_type
->element_type
= g_new(LttType
*, td
->fields
.position
);
375 fld
->child
= g_new(LttField
*, td
->fields
.position
);
376 for(i
=0;i
<td
->fields
.position
;i
++){
377 tmpTd
= ((type_fields
*)(td
->fields
.array
[i
]))->type
;
380 fld
->field_type
->element_type
[i
] = lookup_named_type(fac
, tmpTd
);
381 fld
->child
[i
] = g_new(LttField
,1);
383 fld
->child
[i
]->field_pos
= i
;
384 fld
->child
[i
]->field_type
= fld
->field_type
->element_type
[i
];
387 fld
->child
[i
]->field_type
->element_name
388 = g_quark_from_string(((type_fields
*)(td
->fields
.array
[i
]))->name
);
391 fld
->child
[i
]->offset_root
= -1;
392 fld
->child
[i
]->fixed_root
= -1;
393 fld
->child
[i
]->offset_parent
= -1;
394 fld
->child
[i
]->fixed_parent
= -1;
395 // fld->child[i]->base_address = NULL;
396 fld
->child
[i
]->field_size
= 0;
397 fld
->child
[i
]->field_fixed
= -1;
398 fld
->child
[i
]->parent
= fld
;
399 fld
->child
[i
]->child
= NULL
;
400 fld
->child
[i
]->current_element
= 0;
401 construct_types_and_fields(fac
, tmpTd
, fld
->child
[i
]);
407 /*****************************************************************************
409 * lookup_named_type: search named type in the table
412 * fac : facility struct
413 * td : type descriptor
415 * : either find the named type, or create a new LttType
416 ****************************************************************************/
418 LttType
* lookup_named_type(LttFacility
*fac
, type_descriptor
* td
)
420 GQuark name
= g_quark_from_string(td
->type_name
);
422 LttType
*type
= g_datalist_id_get_data(&fac
->named_types
, name
);
425 type
= g_new(LttType
,1);
426 type
->type_name
= name
;
427 g_datalist_id_set_data_full(&fac
->named_types
, name
,
428 type
, (GDestroyNotify
)freeLttNamedType
);
429 type
->type_class
= td
->type
;
430 if(td
->fmt
) type
->fmt
= g_strdup(td
->fmt
);
431 else type
->fmt
= NULL
;
432 type
->size
= td
->size
;
433 type
->enum_strings
= NULL
;
434 type
->element_type
= NULL
;
435 type
->element_number
= 0;
442 /*****************************************************************************
444 * ltt_facility_close : close a facility, decrease its usage count,
445 * if usage count = 0, release the memory
447 * f : facility that will be closed
448 ****************************************************************************/
450 void ltt_facility_close(LttFacility
*f
)
452 //release the memory it occupied
456 /*****************************************************************************
457 * Functions to release the memory occupied by the facility
458 ****************************************************************************/
460 void freeFacility(LttFacility
* fac
)
465 for(i
=0; i
<fac
->events
->len
; i
++) {
466 et
= &g_array_index (fac
->events
, LttEventType
, i
);
469 g_array_free(fac
->events
, TRUE
);
471 g_datalist_clear(&fac
->named_types
);
475 void freeEventtype(LttEventType
* evType
)
478 if(evType
->description
)
479 g_free(evType
->description
);
480 if(evType
->root_field
){
481 root_type
= evType
->root_field
->field_type
;
482 freeLttField(evType
->root_field
);
483 freeLttType(&root_type
);
487 void freeLttNamedType(LttType
* type
)
492 void freeLttType(LttType
** type
)
495 if(*type
== NULL
) return;
496 //if((*type)->type_name){
497 // return; //this is a named type
500 g_free((*type
)->fmt
);
501 if((*type
)->enum_strings
){
502 g_free((*type
)->enum_strings
);
505 if((*type
)->element_type
){
506 for(i
=0;i
<(*type
)->element_number
;i
++)
507 freeLttType(&((*type
)->element_type
[i
]));
508 g_free((*type
)->element_type
);
514 void freeLttField(LttField
* fld
)
520 if(fld
->field_type
->type_class
== LTT_ARRAY
||
521 fld
->field_type
->type_class
== LTT_SEQUENCE
){
523 }else if(fld
->field_type
->type_class
== LTT_STRUCT
){
524 size
= fld
->field_type
->element_number
;
529 for(i
=0; i
<size
; i
++){
530 if(fld
->child
[i
])freeLttField(fld
->child
[i
]);
537 /*****************************************************************************
539 * ltt_facility_name : obtain the facility's name
543 * GQuark : the facility's name
544 ****************************************************************************/
546 GQuark
ltt_facility_name(LttFacility
*f
)
551 /*****************************************************************************
553 * ltt_facility_checksum : obtain the facility's checksum
557 * : the checksum of the facility
558 ****************************************************************************/
560 guint32
ltt_facility_checksum(LttFacility
*f
)
565 /*****************************************************************************
567 * ltt_facility_base_id : obtain the facility base id
571 * : the base id of the facility
572 ****************************************************************************/
574 guint
ltt_facility_id(LttFacility
*f
)
579 /*****************************************************************************
581 * ltt_facility_eventtype_number: obtain the number of the event types
583 * f : the facility that will be closed
585 * : the number of the event types
586 ****************************************************************************/
588 guint8
ltt_facility_eventtype_number(LttFacility
*f
)
590 return (f
->events
->len
);
593 /*****************************************************************************
595 * ltt_facility_eventtype_get: obtain the event type according to event id
596 * from 0 to event_number - 1
598 * f : the facility that will be closed
600 * LttEventType * : the event type required
601 ****************************************************************************/
603 LttEventType
*ltt_facility_eventtype_get(LttFacility
*f
, guint8 i
)
605 g_assert(i
< f
->events
->len
);
606 return &g_array_index(f
->events
, LttEventType
, i
);
609 /*****************************************************************************
611 * ltt_facility_eventtype_get_by_name
612 * : obtain the event type according to event name
613 * event name is unique in the facility
616 * name : the name of the event
618 * LttEventType * : the event type required
619 ****************************************************************************/
621 LttEventType
*ltt_facility_eventtype_get_by_name(LttFacility
*f
, GQuark name
)
623 LttEventType
*et
= g_datalist_get_data(f
->events_by_name
, name
);
This page took 0.042244 seconds and 4 git commands to generate.