ctf metadata field is set bitmasks
[babeltrace.git] / include / babeltrace / ctf / metadata.h
CommitLineData
c054553d
MD
1#ifndef _BABELTRACE_CTF_METADATA_H
2#define _BABELTRACE_CTF_METADATA_H
3
4/*
5 * BabelTrace
6 *
7 * CTF Metadata Header
8 *
9 * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 */
21
22#include <babeltrace/types.h>
96513a7f
MD
23#include <uuid/uuid.h>
24#include <assert.h>
c054553d
MD
25#include <glib.h>
26
27struct ctf_trace;
28struct ctf_stream;
29struct ctf_event;
30
96513a7f
MD
31#define CTF_TRACE_SET_FIELD(ctf_trace, field, value) \
32 do { \
33 (ctf_trace)->(field) = (value); \
34 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
35 } while (0)
36
37#define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
38 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
39
40#define CTF_TRACE_GET_FIELD(ctf_trace, field) \
41 ({ \
42 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
43 (ctf_trace)->(field); \
44 })
45
c054553d 46struct ctf_trace {
fe21b943 47 struct declaration_scope *scope; /* root scope */
96513a7f 48 GArray *streams; /* Array of struct ctf_stream */
fe21b943
MD
49
50 uint64_t major;
51 uint64_t minor;
96513a7f 52 uuid_t uuid;
fe21b943 53 uint64_t word_size;
96513a7f
MD
54
55 enum { /* Fields populated mask */
56 CTF_TRACE_major = (1U << 0),
57 CTF_TRACE_minor = (1U << 1),
58 CTF_TRACE_uuid = (1U << 2),
59 CTF_TRACE_word_size = (1U << 3),
60 } field_mask;
c054553d
MD
61};
62
96513a7f
MD
63#define CTF_STREAM_SET_FIELD(ctf_stream, field, value) \
64 do { \
65 (ctf_stream)->(field) = (value); \
66 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
67 } while (0)
68
69#define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
70 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
71
72#define CTF_STREAM_GET_FIELD(ctf_stream, field) \
73 ({ \
74 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
75 (ctf_stream)->(field); \
76 })
77
c054553d 78struct ctf_stream {
96513a7f 79 struct ctf_trace *trace;
fe21b943 80 struct declaration_scope *scope; /* parent is trace scope */
c054553d 81 GArray *events_by_id; /* Array of struct ctf_event indexed by id */
96513a7f 82 GHashTable *event_quark_to_id; /* GQuark to numeric id */
fe21b943 83
fe21b943
MD
84 struct declaration_struct *event_header;
85 struct declaration_struct *event_context;
86 struct declaration_struct *packet_context;
96513a7f
MD
87
88 uint64_t stream_id;
89
90 enum { /* Fields populated mask */
91 CTF_STREAM_stream_id = (1 << 0),
92 } field_mask;
c054553d
MD
93};
94
96513a7f
MD
95#define CTF_EVENT_SET_FIELD(ctf_event, field, value) \
96 do { \
97 (ctf_event)->(field) = (value); \
98 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
99 } while (0)
100
101#define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
102 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
103
104#define CTF_EVENT_GET_FIELD(ctf_event, field) \
105 ({ \
106 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
107 (ctf_event)->(field); \
108 })
109
c054553d 110struct ctf_event {
96513a7f 111 struct ctf_stream *stream; /* stream mapped by stream_id */
fe21b943 112 struct declaration_scope *scope; /* parent is stream scope */
fe21b943
MD
113 struct declaration_struct *context;
114 struct declaration_struct *fields;
96513a7f
MD
115
116 GQuark name;
117 uint64_t id; /* Numeric identifier within the stream */
118 uint64_t stream_id;
119
120 enum { /* Fields populated mask */
121 CTF_EVENT_name = (1 << 0),
122 CTF_EVENT_id = (1 << 1),
123 CTF_EVENT_stream_id = (1 << 2),
124 } field_mask;
c054553d
MD
125};
126
127#endif /* _BABELTRACE_CTF_METADATA_H */
This page took 0.027244 seconds and 4 git commands to generate.