src/plugins/ctf/fs-src/metadata.h

   1 #ifndef CTF_FS_METADATA_H
   2 #define CTF_FS_METADATA_H
   3
   4 /*
   5  * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <stdbool.h>
  27 #include <stdio.h>
  28 #include <glib.h>
  29 #include "common/macros.h"
  30 #include <babeltrace2/babeltrace.h>
  31
  32 #define CTF_FS_METADATA_FILENAME        "metadata"
  33
  34 struct ctf_fs_trace;
  35 struct ctf_fs_metadata;
  36
  37 struct ctf_fs_metadata_config {
  38         bool force_clock_class_origin_unix_epoch;
  39         int64_t clock_class_offset_s;
  40         int64_t clock_class_offset_ns;
  41 };
  42
  43 BT_HIDDEN
  44 int ctf_fs_metadata_init(struct ctf_fs_metadata *metadata);
  45
  46 BT_HIDDEN
  47 void ctf_fs_metadata_fini(struct ctf_fs_metadata *metadata);
  48
  49 BT_HIDDEN
  50 int ctf_fs_metadata_set_trace_class(bt_self_component *self_comp,
  51                 struct ctf_fs_trace *ctf_fs_trace,
  52                 struct ctf_fs_metadata_config *config);
  53
  54 BT_HIDDEN
  55 FILE *ctf_fs_metadata_open_file(const char *trace_path);
  56
  57 BT_HIDDEN
  58 bool ctf_metadata_is_packetized(FILE *fp, int *byte_order);
  59
  60 #endif /* CTF_FS_METADATA_H */