| 1 | /* This file is part of the Linux Trace Toolkit trace reading library |
| 2 | * Copyright (C) 2003-2004 Michel Dagenais |
| 3 | * |
| 4 | * This library is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU Lesser General Public |
| 6 | * License Version 2.1 as published by the Free Software Foundation. |
| 7 | * |
| 8 | * This library 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 GNU |
| 11 | * Lesser General Public License for more details. |
| 12 | * |
| 13 | * You should have received a copy of the GNU Lesser General Public |
| 14 | * License along with this library; if not, write to the |
| 15 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 16 | * Boston, MA 02111-1307, USA. |
| 17 | */ |
| 18 | |
| 19 | #ifndef TRACE_H |
| 20 | #define TRACE_H |
| 21 | |
| 22 | #include <ltt/ltt.h> |
| 23 | |
| 24 | /* A trace is specified as a pathname to the directory containing all the |
| 25 | associated data (control tracefiles, per cpu tracefiles, event |
| 26 | descriptions...). |
| 27 | |
| 28 | When a trace is closed, all the associated facilities, types and fields |
| 29 | are released as well. */ |
| 30 | |
| 31 | LttTrace *ltt_trace_open(const char *pathname); |
| 32 | |
| 33 | /* copy reopens a trace */ |
| 34 | LttTrace *ltt_trace_copy(LttTrace *self); |
| 35 | |
| 36 | char * ltt_trace_name(LttTrace *t); |
| 37 | |
| 38 | void ltt_trace_close(LttTrace *t); |
| 39 | |
| 40 | |
| 41 | LttSystemDescription *ltt_trace_system_description(LttTrace *t); |
| 42 | |
| 43 | |
| 44 | /* Functions to discover the facilities in the trace. Once the number |
| 45 | of facilities is known, they may be accessed by position. Multiple |
| 46 | versions of a facility (same name, different checksum) have consecutive |
| 47 | positions. */ |
| 48 | |
| 49 | unsigned ltt_trace_facility_number(LttTrace *t); |
| 50 | |
| 51 | LttFacility *ltt_trace_facility_get(LttTrace *t, unsigned i); |
| 52 | |
| 53 | LttFacility * ltt_trace_facility_by_id(LttTrace * trace, unsigned id); |
| 54 | |
| 55 | /* Look for a facility by name. It returns the number of facilities found |
| 56 | and sets the position argument to the first found. Returning 0, the named |
| 57 | facility is unknown, returning 1, the named facility is at the specified |
| 58 | position, returning n, the facilities are from position to |
| 59 | position + n - 1. */ |
| 60 | |
| 61 | unsigned ltt_trace_facility_find(LttTrace *t, char *name, unsigned *position); |
| 62 | |
| 63 | |
| 64 | /* Functions to discover all the event types in the trace */ |
| 65 | |
| 66 | unsigned ltt_trace_eventtype_number(LttTrace *t); |
| 67 | |
| 68 | LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i); |
| 69 | |
| 70 | |
| 71 | /* There is one "per cpu" tracefile for each CPU, numbered from 0 to |
| 72 | the maximum number of CPU in the system. When the number of CPU installed |
| 73 | is less than the maximum, some positions are unused. There are also a |
| 74 | number of "control" tracefiles (facilities, interrupts...). */ |
| 75 | |
| 76 | unsigned ltt_trace_control_tracefile_number(LttTrace *t); |
| 77 | |
| 78 | unsigned ltt_trace_per_cpu_tracefile_number(LttTrace *t); |
| 79 | |
| 80 | |
| 81 | /* It is possible to search for the tracefiles by name or by CPU position. |
| 82 | The index within the tracefiles of the same type is returned if found |
| 83 | and a negative value otherwise. */ |
| 84 | |
| 85 | int ltt_trace_control_tracefile_find(LttTrace *t, char *name); |
| 86 | |
| 87 | int ltt_trace_per_cpu_tracefile_find(LttTrace *t, unsigned i); |
| 88 | |
| 89 | |
| 90 | /* Get a specific tracefile */ |
| 91 | |
| 92 | LttTracefile *ltt_trace_control_tracefile_get(LttTrace *t, unsigned i); |
| 93 | |
| 94 | LttTracefile *ltt_trace_per_cpu_tracefile_get(LttTrace *t, unsigned i); |
| 95 | |
| 96 | |
| 97 | /* Get the start time and end time of the trace */ |
| 98 | |
| 99 | void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end); |
| 100 | |
| 101 | |
| 102 | /* Get the name of a tracefile */ |
| 103 | |
| 104 | char *ltt_tracefile_name(LttTracefile *tf); |
| 105 | |
| 106 | |
| 107 | /* Get the number of blocks in the tracefile */ |
| 108 | |
| 109 | unsigned ltt_tracefile_block_number(LttTracefile *tf); |
| 110 | |
| 111 | |
| 112 | /* Seek to the first event of the trace with time larger or equal to time */ |
| 113 | |
| 114 | void ltt_tracefile_seek_time(LttTracefile *t, LttTime time); |
| 115 | |
| 116 | /* Seek to the first event with position equal or larger to ep */ |
| 117 | |
| 118 | void ltt_tracefile_seek_position(LttTracefile *t, |
| 119 | LttEventPosition *ep); |
| 120 | |
| 121 | /* Read the next event */ |
| 122 | |
| 123 | LttEvent *ltt_tracefile_read(LttTracefile *t); |
| 124 | |
| 125 | /* open tracefile */ |
| 126 | |
| 127 | LttTracefile * ltt_tracefile_open(LttTrace *t, char * tracefile_name); |
| 128 | |
| 129 | void ltt_tracefile_open_cpu(LttTrace *t, char * tracefile_name); |
| 130 | |
| 131 | void ltt_tracefile_open_control(LttTrace *t, char * control_name); |
| 132 | |
| 133 | |
| 134 | /* obtain the time of an event */ |
| 135 | |
| 136 | LttTime getEventTime(LttTracefile * tf); |
| 137 | |
| 138 | |
| 139 | /* get the data type size and endian type of the local machine */ |
| 140 | |
| 141 | void getDataEndianType(LttArchSize * size, LttArchEndian * endian); |
| 142 | |
| 143 | /* get an integer number */ |
| 144 | |
| 145 | int getIntNumber(int size1, void *evD); |
| 146 | |
| 147 | |
| 148 | /* get the node name of the system */ |
| 149 | |
| 150 | char * ltt_trace_system_description_node_name (LttSystemDescription * s); |
| 151 | |
| 152 | |
| 153 | /* get the domain name of the system */ |
| 154 | |
| 155 | char * ltt_trace_system_description_domain_name (LttSystemDescription * s); |
| 156 | |
| 157 | |
| 158 | /* get the description of the system */ |
| 159 | |
| 160 | char * ltt_trace_system_description_description (LttSystemDescription * s); |
| 161 | |
| 162 | |
| 163 | /* get the start time of the trace */ |
| 164 | |
| 165 | LttTime ltt_trace_system_description_trace_start_time(LttSystemDescription *s); |
| 166 | |
| 167 | #endif // TRACE_H |