| 1 | #ifndef TYPE_H |
| 2 | #define TYPE_H |
| 3 | |
| 4 | |
| 5 | /* Different types allowed */ |
| 6 | |
| 7 | typedef enum _LttTypeEnum |
| 8 | { LTT_INT, LTT_UINT, LTT_FLOAT, LTT_STRING, LTT_ENUM, LTT_ARRAY, |
| 9 | LTT_SEQUENCE, LTT_STRUCT, LTT_UNION |
| 10 | } LttTypeEnum; |
| 11 | |
| 12 | #include <ltt/ltt.h> |
| 13 | |
| 14 | |
| 15 | /* All event types, data types and fields belong to their trace and |
| 16 | are released at the same time. */ |
| 17 | |
| 18 | /* Obtain the name, description, facility, facility relative id, global id, |
| 19 | type and root field for an eventtype */ |
| 20 | |
| 21 | char *ltt_eventtype_name(LttEventType *et); |
| 22 | |
| 23 | char *ltt_eventtype_description(LttEventType *et); |
| 24 | |
| 25 | LttFacility *ltt_eventtype_facility(LttEventType *et); |
| 26 | |
| 27 | unsigned *ltt_eventtype_relative_id(LttEventType *et); |
| 28 | |
| 29 | unsigned *ltt_eventtype_id(LttEventType *et); |
| 30 | |
| 31 | LttType *ltt_eventtype_type(LttEventType *et); |
| 32 | |
| 33 | LttField *ltt_eventtype_field(LttEventType *et); |
| 34 | |
| 35 | |
| 36 | /* obtain the type name and size. The size is the number of bytes for |
| 37 | primitive types (INT, UINT, FLOAT, ENUM), or the size for the unsigned |
| 38 | integer length count for sequences. */ |
| 39 | |
| 40 | char *ltt_type_name(LttType *t); |
| 41 | |
| 42 | LttTypeEnum ltt_type_class(LttType *t); |
| 43 | |
| 44 | unsigned ltt_type_size(LttTrace *trace, LttType *t); |
| 45 | |
| 46 | |
| 47 | /* The type of nested elements for arrays and sequences. */ |
| 48 | |
| 49 | LttType *ltt_type_element_type(LttType *t); |
| 50 | |
| 51 | |
| 52 | /* The number of elements for arrays. */ |
| 53 | |
| 54 | unsigned ltt_type_element_number(LttType *t); |
| 55 | |
| 56 | |
| 57 | /* The number of data members for structures and unions. */ |
| 58 | |
| 59 | unsigned ltt_type_member_number(LttType *t); |
| 60 | |
| 61 | |
| 62 | /* The type of a data member in a structure. */ |
| 63 | |
| 64 | LttType *ltt_type_member_type(LttType *t, unsigned i); |
| 65 | |
| 66 | |
| 67 | /* For enumerations, obtain the symbolic string associated with a value |
| 68 | (0 to n - 1 for an enumeration of n elements). */ |
| 69 | |
| 70 | char *ltt_enum_string_get(LttType *t, unsigned i); |
| 71 | |
| 72 | |
| 73 | /* The fields form a tree representing a depth first search of the |
| 74 | corresponding event type directed acyclic graph. Fields for arrays and |
| 75 | sequences simply point to one nested field representing the currently |
| 76 | selected element among all the (identically typed) elements. For structures, |
| 77 | a nested field exists for each data member. Each field stores the |
| 78 | platform/trace specific offset values (for efficient access) and |
| 79 | points back to the corresponding LttType for the rest. */ |
| 80 | |
| 81 | LttField *ltt_field_element(LttField *f); |
| 82 | |
| 83 | LttField *ltt_field_member(LttField *f, unsigned i); |
| 84 | |
| 85 | LttType *ltt_field_type(LttField *f); |
| 86 | |
| 87 | #endif // TYPE_H |