| 1 | /* This file is part of the Linux Trace Toolkit viewer |
| 2 | * Copyright (C) 2003-2004 Michel Dagenais |
| 3 | * |
| 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; |
| 7 | * |
| 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. |
| 12 | * |
| 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, |
| 16 | * MA 02111-1307, USA. |
| 17 | */ |
| 18 | |
| 19 | #ifdef HAVE_CONFIG_H |
| 20 | #include <config.h> |
| 21 | #endif |
| 22 | |
| 23 | #include <lttv/traceset.h> |
| 24 | #include <lttv/iattribute.h> |
| 25 | #include <lttv/state.h> |
| 26 | #include <lttv/hook.h> |
| 27 | #include <stdio.h> |
| 28 | #include <babeltrace/context.h> |
| 29 | #include <babeltrace/iterator.h> |
| 30 | #include <babeltrace/ctf/events.h> |
| 31 | |
| 32 | /* To traverse a tree recursively */ |
| 33 | #include <fcntl.h> |
| 34 | #include <fts.h> |
| 35 | |
| 36 | /* A trace is a sequence of events gathered in the same tracing session. The |
| 37 | events may be stored in several tracefiles in the same directory. |
| 38 | A trace set is defined when several traces are to be analyzed together, |
| 39 | possibly to study the interactions between events in the different traces. |
| 40 | */ |
| 41 | |
| 42 | |
| 43 | LttvTraceset *lttv_traceset_new(void) |
| 44 | { |
| 45 | LttvTraceset *s; |
| 46 | struct bt_iter_pos begin_pos; |
| 47 | |
| 48 | s = g_new(LttvTraceset, 1); |
| 49 | s->filename = NULL; |
| 50 | s->traces = g_ptr_array_new(); |
| 51 | s->context = bt_context_create(); |
| 52 | s->a = g_object_new(LTTV_ATTRIBUTE_TYPE, NULL); |
| 53 | //TODO remove this when we have really mecanism |
| 54 | //s->tmpState = g_new(LttvTraceState *, 1); |
| 55 | //lttv_trace_state_init(s->tmpState,0); |
| 56 | begin_pos.type = BT_SEEK_BEGIN; |
| 57 | |
| 58 | //s->iter = bt_ctf_iter_create(lttv_traceset_get_context(s), |
| 59 | // &begin_pos, |
| 60 | // NULL); |
| 61 | s->iter = 0; |
| 62 | s->event_hooks = lttv_hooks_new(); |
| 63 | s->state_trace_handle_index = g_ptr_array_new(); |
| 64 | |
| 65 | |
| 66 | |
| 67 | return s; |
| 68 | } |
| 69 | |
| 70 | char * lttv_traceset_name(LttvTraceset * s) |
| 71 | { |
| 72 | return s->filename; |
| 73 | } |
| 74 | |
| 75 | #ifdef BABEL_CLEANUP |
| 76 | LttvTrace *lttv_trace_new(LttTrace *t) |
| 77 | { |
| 78 | LttvTrace *new_trace; |
| 79 | |
| 80 | new_trace = g_new(LttvTrace, 1); |
| 81 | new_trace->a = g_object_new(LTTV_ATTRIBUTE_TYPE, NULL); |
| 82 | new_trace->id = t; |
| 83 | new_trace->ref_count = 0; |
| 84 | return new_trace; |
| 85 | } |
| 86 | #endif |
| 87 | |
| 88 | /* |
| 89 | * lttv_trace_create : Create a trace from a path |
| 90 | * |
| 91 | * ts is the traceset in which will be contained the trace |
| 92 | * |
| 93 | * path is the path where to find a trace. It is not recursive. |
| 94 | * |
| 95 | * This function is static since a trace should always be contained in a |
| 96 | * traceset. |
| 97 | * |
| 98 | * return the created trace or NULL on failure |
| 99 | */ |
| 100 | static LttvTrace *lttv_trace_create(LttvTraceset *ts, const char *path) |
| 101 | { |
| 102 | int id = bt_context_add_trace(lttv_traceset_get_context(ts), |
| 103 | path, |
| 104 | "ctf", |
| 105 | NULL, |
| 106 | NULL, |
| 107 | NULL); |
| 108 | if (id < 0) { |
| 109 | return NULL; |
| 110 | } |
| 111 | // Create the trace and save the trace handle id returned by babeltrace |
| 112 | LttvTrace *new_trace; |
| 113 | |
| 114 | new_trace = g_new(LttvTrace, 1); |
| 115 | new_trace->a = g_object_new(LTTV_ATTRIBUTE_TYPE, NULL); |
| 116 | new_trace->id = id; |
| 117 | new_trace->ref_count = 0; |
| 118 | new_trace->traceset = ts; |
| 119 | new_trace->state = g_new(LttvTraceState,1); |
| 120 | lttv_trace_state_init(new_trace->state,new_trace); |
| 121 | |
| 122 | /* Add the state to the trace_handle to state index */ |
| 123 | g_ptr_array_set_size(ts->state_trace_handle_index,id+1); |
| 124 | g_ptr_array_index(ts->state_trace_handle_index,id) = new_trace->state; |
| 125 | |
| 126 | return new_trace; |
| 127 | } |
| 128 | |
| 129 | /* |
| 130 | * lttv_trace_create : Create and add a single trace to a traceset |
| 131 | * |
| 132 | * ts is the traceset in which will be contained the trace |
| 133 | * |
| 134 | * path is the path where to find a trace. It is not recursive. |
| 135 | * |
| 136 | * return a positive integer (>=0)on success or -1 on failure |
| 137 | */ |
| 138 | static int lttv_traceset_create_trace(LttvTraceset *ts, const char *path) |
| 139 | { |
| 140 | LttvTrace *trace = lttv_trace_create(ts, path); |
| 141 | if (trace == NULL) { |
| 142 | return -1; |
| 143 | } |
| 144 | lttv_traceset_add(ts, trace); |
| 145 | return 0; |
| 146 | } |
| 147 | |
| 148 | LttvTraceset *lttv_traceset_copy(LttvTraceset *s_orig) |
| 149 | { |
| 150 | guint i; |
| 151 | LttvTraceset *s; |
| 152 | LttvTrace * trace; |
| 153 | |
| 154 | s = g_new(LttvTraceset, 1); |
| 155 | s->filename = NULL; |
| 156 | s->traces = g_ptr_array_new(); |
| 157 | s->state_trace_handle_index = g_ptr_array_new(); |
| 158 | for(i=0;i<s_orig->traces->len;i++) |
| 159 | { |
| 160 | trace = g_ptr_array_index(s_orig->traces, i); |
| 161 | trace->ref_count++; |
| 162 | |
| 163 | /* WARNING: this is an alias, not a copy. */ |
| 164 | g_ptr_array_add(s->traces, trace); |
| 165 | |
| 166 | g_ptr_array_set_size(s->state_trace_handle_index,trace->id+1); |
| 167 | g_ptr_array_index(s->state_trace_handle_index,trace->id) = trace->state; |
| 168 | |
| 169 | } |
| 170 | s->context = s_orig->context; |
| 171 | bt_context_get(s->context); |
| 172 | s->a = LTTV_ATTRIBUTE(lttv_iattribute_deep_copy(LTTV_IATTRIBUTE(s_orig->a))); |
| 173 | return s; |
| 174 | } |
| 175 | |
| 176 | |
| 177 | LttvTraceset *lttv_traceset_load(const gchar *filename) |
| 178 | { |
| 179 | LttvTraceset *s = g_new(LttvTraceset,1); |
| 180 | FILE *tf; |
| 181 | |
| 182 | s->filename = g_strdup(filename); |
| 183 | tf = fopen(filename,"r"); |
| 184 | |
| 185 | g_critical("NOT IMPLEMENTED : load traceset data from a XML file"); |
| 186 | |
| 187 | fclose(tf); |
| 188 | return s; |
| 189 | } |
| 190 | |
| 191 | gint lttv_traceset_save(LttvTraceset *s) |
| 192 | { |
| 193 | FILE *tf; |
| 194 | |
| 195 | tf = fopen(s->filename, "w"); |
| 196 | |
| 197 | g_critical("NOT IMPLEMENTED : save traceset data in a XML file"); |
| 198 | |
| 199 | fclose(tf); |
| 200 | return 0; |
| 201 | } |
| 202 | |
| 203 | void lttv_traceset_destroy(LttvTraceset *s) |
| 204 | { |
| 205 | guint i; |
| 206 | |
| 207 | for(i=0;i<s->traces->len;i++) { |
| 208 | LttvTrace *trace = g_ptr_array_index(s->traces, i); |
| 209 | lttv_trace_unref(trace); |
| 210 | // todo mdenis 2012-03-27: uncomment when babeltrace gets fixed |
| 211 | //bt_context_remove_trace(lttv_traceset_get_context(s), trace->id); |
| 212 | if(lttv_trace_get_ref_number(trace) == 0) |
| 213 | lttv_trace_destroy(trace); |
| 214 | } |
| 215 | g_ptr_array_free(s->traces, TRUE); |
| 216 | bt_context_put(s->context); |
| 217 | g_object_unref(s->a); |
| 218 | g_free(s); |
| 219 | } |
| 220 | |
| 221 | struct bt_context *lttv_traceset_get_context(LttvTraceset *s) |
| 222 | { |
| 223 | return s->context; |
| 224 | } |
| 225 | |
| 226 | LttvTraceset *lttv_trace_get_traceset(LttvTrace *trace) |
| 227 | { |
| 228 | return trace->traceset; |
| 229 | } |
| 230 | |
| 231 | LttvHooks *lttv_traceset_get_hooks(LttvTraceset *s) |
| 232 | { |
| 233 | return s->event_hooks; |
| 234 | } |
| 235 | |
| 236 | void lttv_trace_destroy(LttvTrace *t) |
| 237 | { |
| 238 | g_object_unref(t->a); |
| 239 | g_free(t); |
| 240 | } |
| 241 | |
| 242 | |
| 243 | void lttv_traceset_add(LttvTraceset *s, LttvTrace *t) |
| 244 | { |
| 245 | t->ref_count++; |
| 246 | g_ptr_array_add(s->traces, t); |
| 247 | } |
| 248 | |
| 249 | int lttv_traceset_add_path(LttvTraceset *ts, char *trace_path) |
| 250 | { |
| 251 | FTS *tree; |
| 252 | FTSENT *node; |
| 253 | char * const paths[2] = { trace_path, NULL }; |
| 254 | int ret = -1; |
| 255 | |
| 256 | tree = fts_open(paths, FTS_NOCHDIR | FTS_LOGICAL, 0); |
| 257 | if (tree == NULL) { |
| 258 | g_warning("Cannot traverse \"%s\" for reading.\n", |
| 259 | trace_path); |
| 260 | return ret; |
| 261 | } |
| 262 | |
| 263 | int dirfd, metafd; |
| 264 | while ((node = fts_read(tree))) { |
| 265 | |
| 266 | if (!(node->fts_info & FTS_D)) |
| 267 | continue; |
| 268 | |
| 269 | dirfd = open(node->fts_accpath, 0); |
| 270 | if (dirfd < 0) { |
| 271 | g_warning("Unable to open trace " |
| 272 | "directory file descriptor : %s.", node->fts_accpath); |
| 273 | ret = dirfd; |
| 274 | goto error; |
| 275 | } |
| 276 | |
| 277 | // Check if a metadata file exists in the current directory |
| 278 | metafd = openat(dirfd, "metadata", O_RDONLY); |
| 279 | if (metafd < 0) { |
| 280 | ret = close(dirfd); |
| 281 | if (ret < 0) { |
| 282 | g_warning("Unable to open metadata " |
| 283 | "file descriptor : %s.", node->fts_accpath); |
| 284 | goto error; |
| 285 | } |
| 286 | } else { |
| 287 | ret = close(metafd); |
| 288 | if (ret < 0) { |
| 289 | g_warning("Unable to close metadata " |
| 290 | "file descriptor : %s.", node->fts_accpath); |
| 291 | goto error; |
| 292 | } |
| 293 | ret = close(dirfd); |
| 294 | if (ret < 0) { |
| 295 | g_warning("Unable to close trace " |
| 296 | "directory file descriptor : %s.", node->fts_accpath); |
| 297 | goto error; |
| 298 | } |
| 299 | |
| 300 | ret = lttv_traceset_create_trace(ts, node->fts_accpath); |
| 301 | if (ret < 0) { |
| 302 | g_warning("Opening trace \"%s\" from %s " |
| 303 | "for reading.", node->fts_accpath, trace_path); |
| 304 | goto error; |
| 305 | } |
| 306 | } |
| 307 | } |
| 308 | |
| 309 | error: |
| 310 | ret = fts_close(tree); |
| 311 | if (ret < 0) { |
| 312 | g_warning("Unable to close tree " |
| 313 | "file descriptor : %s.", trace_path); |
| 314 | } |
| 315 | return ret; |
| 316 | } |
| 317 | |
| 318 | unsigned lttv_traceset_number(LttvTraceset *s) |
| 319 | { |
| 320 | return s->traces->len; |
| 321 | } |
| 322 | |
| 323 | |
| 324 | LttvTrace *lttv_traceset_get(LttvTraceset *s, unsigned i) |
| 325 | { |
| 326 | g_assert(s->traces->len > i); |
| 327 | return ((LttvTrace *)s->traces->pdata[i]); |
| 328 | } |
| 329 | |
| 330 | |
| 331 | void lttv_traceset_remove(LttvTraceset *s, unsigned i) |
| 332 | { |
| 333 | LttvTrace * t; |
| 334 | g_assert(s->traces->len > i); |
| 335 | t = (LttvTrace *)s->traces->pdata[i]; |
| 336 | t->ref_count--; |
| 337 | bt_context_remove_trace(lttv_traceset_get_context(s), t->id); |
| 338 | g_ptr_array_remove_index(s->traces, i); |
| 339 | } |
| 340 | |
| 341 | |
| 342 | /* A set of attributes is attached to each trace set, trace and tracefile |
| 343 | to store user defined data as needed. */ |
| 344 | |
| 345 | LttvAttribute *lttv_traceset_attribute(LttvTraceset *s) |
| 346 | { |
| 347 | return s->a; |
| 348 | } |
| 349 | |
| 350 | |
| 351 | LttvAttribute *lttv_trace_attribute(LttvTrace *t) |
| 352 | { |
| 353 | return t->a; |
| 354 | } |
| 355 | |
| 356 | #ifdef BABEL_CLEANUP |
| 357 | LttTrace *lttv_trace(LttvTrace *t) |
| 358 | { |
| 359 | return t->t; |
| 360 | } |
| 361 | #endif |
| 362 | |
| 363 | gint lttv_trace_get_id(LttvTrace *t) |
| 364 | { |
| 365 | return t->id; |
| 366 | } |
| 367 | |
| 368 | guint lttv_trace_get_ref_number(LttvTrace * t) |
| 369 | { |
| 370 | // todo mdenis: adapt to babeltrace |
| 371 | return t->ref_count; |
| 372 | } |
| 373 | |
| 374 | guint lttv_trace_ref(LttvTrace * t) |
| 375 | { |
| 376 | t->ref_count++; |
| 377 | |
| 378 | return t->ref_count; |
| 379 | } |
| 380 | |
| 381 | guint lttv_trace_unref(LttvTrace * t) |
| 382 | { |
| 383 | if(likely(t->ref_count > 0)) |
| 384 | t->ref_count--; |
| 385 | |
| 386 | return t->ref_count; |
| 387 | } |
| 388 | |
| 389 | guint lttv_trace_get_num_cpu(LttvTrace *t) |
| 390 | { |
| 391 | #warning "TODO - Set the right number of CPU" |
| 392 | return 24; |
| 393 | } |
| 394 | |
| 395 | LttvTracesetPosition *lttv_traceset_create_position(LttvTraceset *traceset) |
| 396 | { |
| 397 | #warning "TODO" |
| 398 | return NULL; |
| 399 | } |
| 400 | |
| 401 | void lttv_traceset_destroy_position(LttvTracesetPosition *traceset_pos) |
| 402 | { |
| 403 | #warning "TODO" |
| 404 | return NULL; |
| 405 | } |
| 406 | |
| 407 | void lttv_traceset_seek_to_position(LttvTracesetPosition *traceset_pos) |
| 408 | { |
| 409 | #warning "TODO" |
| 410 | } |
| 411 | |
| 412 | guint lttv_traceset_get_cpuid_from_event(LttvEvent *event) |
| 413 | { |
| 414 | struct definition *scope; |
| 415 | unsigned long timestamp; |
| 416 | unsigned int cpu_id; |
| 417 | |
| 418 | struct bt_ctf_event *ctf_event = event->bt_event; |
| 419 | timestamp = bt_ctf_get_timestamp(ctf_event); |
| 420 | if (timestamp == -1ULL) { |
| 421 | return 0; |
| 422 | } |
| 423 | scope = bt_ctf_get_top_level_scope(ctf_event, BT_STREAM_PACKET_CONTEXT); |
| 424 | if (bt_ctf_field_get_error()) { |
| 425 | return 0; |
| 426 | } |
| 427 | cpu_id = bt_ctf_get_uint64(bt_ctf_get_field(ctf_event, scope, "cpu_id")); |
| 428 | if (bt_ctf_field_get_error()) { |
| 429 | return 0; |
| 430 | } else { |
| 431 | return cpu_id; |
| 432 | } |
| 433 | } |
| 434 | |
| 435 | const char *lttv_traceset_get_name_from_event(LttvEvent *event) |
| 436 | { |
| 437 | return bt_ctf_event_name(event->bt_event); |
| 438 | } |