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 <stdint.h>
  26 #include <stdio.h>
  27
  28 typedef int bt_intern_str;
  29
  30 /* forward declaration */
  31 struct stream_pos;
  32
  33 /* Parent trace descriptor */
  34 struct trace_descriptor {
  35 };
  36
  37 struct mmap_stream {
  38         int fd;
  39         struct bt_list_head list;
  40 };
  41
  42 struct mmap_stream_list {
  43         struct bt_list_head head;
  44 };
  45
  46 struct format {
  47         bt_intern_str name;
  48
  49         struct trace_descriptor *(*open_trace)(const char *path, int flags,
  50                         void (*move_pos_slow)(struct stream_pos *pos,
  51                                 size_t offset, int whence),
  52                         FILE *metadata_fp);
  53         struct trace_descriptor *(*open_mmap_trace)(
  54                         struct mmap_stream_list *mmap_list,
  55                         void (*move_pos_slow)(struct stream_pos *pos,
  56                                 size_t offset, int whence),
  57                         FILE *metadata_fp);
  58         void (*close_trace)(struct trace_descriptor *descriptor);
  59 };
  60
  61 extern struct format *bt_lookup_format(bt_intern_str qname);
  62 extern void bt_fprintf_format_list(FILE *fp);
  63 extern int bt_register_format(struct format *format);
  64
  65 /* TBD: format unregistration */
  66
  67 #endif /* _BABELTRACE_FORMAT_H */