include/babeltrace/format.h

   1 #ifndef _BABELTRACE_FORMAT_H
   2 #define _BABELTRACE_FORMAT_H
   3
   4 /*
   5  * BabelTrace
   6  *
   7  * Trace Format Header
   8  *
   9  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
  10  *
  11  * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  12  *
  13  * Permission is hereby granted, free of charge, to any person obtaining a copy
  14  * of this software and associated documentation files (the "Software"), to deal
  15  * in the Software without restriction, including without limitation the rights
  16  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  17  * copies of the Software, and to permit persons to whom the Software is
  18  * furnished to do so, subject to the following conditions:
  19  *
  20  * The above copyright notice and this permission notice shall be included in
  21  * all copies or substantial portions of the Software.
  22  */
  23
  24 #include <babeltrace/list.h>
  25 #include <babeltrace/clock-types.h>
  26 #include <stdint.h>
  27 #include <stdio.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 typedef int bt_intern_str;
  34
  35 /* forward declaration */
  36 struct stream_pos;
  37 struct bt_context;
  38 struct bt_trace_handle;
  39
  40 /* Parent trace descriptor */
  41 struct trace_descriptor {
  42 };
  43
  44 struct mmap_stream {
  45         int fd;
  46         struct bt_list_head list;
  47 };
  48
  49 struct mmap_stream_list {
  50         struct bt_list_head head;
  51 };
  52
  53 struct format {
  54         bt_intern_str name;
  55
  56         struct trace_descriptor *(*open_trace)(const char *path, int flags,
  57                         void (*packet_seek)(struct stream_pos *pos,
  58                                 size_t index, int whence),
  59                         FILE *metadata_fp);
  60         struct trace_descriptor *(*open_mmap_trace)(
  61                         struct mmap_stream_list *mmap_list,
  62                         void (*packet_seek)(struct stream_pos *pos,
  63                                 size_t index, int whence),
  64                         FILE *metadata_fp);
  65         void (*close_trace)(struct trace_descriptor *descriptor);
  66         void (*set_context)(struct trace_descriptor *descriptor,
  67                         struct bt_context *ctx);
  68         void (*set_handle)(struct trace_descriptor *descriptor,
  69                         struct bt_trace_handle *handle);
  70         uint64_t (*timestamp_begin)(struct trace_descriptor *descriptor,
  71                         struct bt_trace_handle *handle, enum bt_clock_type type);
  72         uint64_t (*timestamp_end)(struct trace_descriptor *descriptor,
  73                         struct bt_trace_handle *handle, enum bt_clock_type type);
  74         int (*convert_index_timestamp)(struct trace_descriptor *descriptor);
  75 };
  76
  77 extern struct format *bt_lookup_format(bt_intern_str qname);
  78 extern void bt_fprintf_format_list(FILE *fp);
  79 extern int bt_register_format(struct format *format);
  80
  81 /* TBD: format unregistration */
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif /* _BABELTRACE_FORMAT_H */