clock: use freq field
[babeltrace.git] / include / babeltrace / ctf-ir / metadata.h
CommitLineData
145b8090
MD
1#ifndef _BABELTRACE_CTF_IR_METADATA_H
2#define _BABELTRACE_CTF_IR_METADATA_H
3
4/*
5 * BabelTrace
6 *
7 * CTF Intermediate Representation 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>
23#include <babeltrace/format.h>
24#include <babeltrace/ctf/types.h>
25#include <sys/types.h>
26#include <dirent.h>
27#include <uuid/uuid.h>
28#include <assert.h>
29#include <glib.h>
30
31struct ctf_trace;
32struct ctf_stream_class;
33struct ctf_stream;
34struct ctf_event;
25ccc85b
MD
35struct ctf_stream;
36struct ctf_clock;
145b8090
MD
37
38struct ctf_stream {
39 struct ctf_stream_class *stream_class;
40 uint64_t timestamp; /* Current timestamp, in ns */
c87a8eb2 41 uint64_t event_id; /* Current event ID */
5e2eb0ae 42 int has_timestamp;
661c4ce8 43 uint64_t stream_id;
145b8090
MD
44
45 struct definition_struct *trace_packet_header;
46 struct definition_struct *stream_packet_context;
47 struct definition_struct *stream_event_header;
48 struct definition_struct *stream_event_context;
42dc00b7 49 GPtrArray *events_by_id; /* Array of struct ctf_stream_event pointers indexed by id */
145b8090
MD
50 struct definition_scope *parent_def_scope; /* for initialization */
51 int stream_definitions_created;
fca04958 52
25ccc85b
MD
53 struct ctf_clock *current_clock;
54
fca04958
MD
55 /* Event discarded information */
56 uint32_t events_discarded;
3217ac37
MD
57 uint64_t prev_timestamp; /* Last event */
58 uint64_t prev_timestamp_end; /* End-of-packet timestamp */
145b8090
MD
59};
60
42dc00b7 61struct ctf_stream_event {
145b8090
MD
62 struct definition_struct *event_context;
63 struct definition_struct *event_fields;
64};
65
50cb9c56
MD
66#define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
67 do { \
68 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
69 } while (0)
70
71#define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
72 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
73
74#define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
75 ({ \
76 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
77 (ctf_clock)->(field); \
78 })
79
80struct ctf_clock {
81 GQuark name;
82 GQuark uuid;
83 char *description;
84 uint64_t freq; /* frequency, in HZ */
85 /* precision in seconds is: precision * (1/freq) */
86 uint64_t precision;
87 /*
88 * The offset from Epoch is: offset_s + (offset * (1/freq))
89 * Coarse clock offset from Epoch (in seconds).
90 */
91 uint64_t offset_s;
92 /* Fine clock offset from Epoch, in (1/freq) units. */
93 uint64_t offset;
11ac6674 94 int absolute;
50cb9c56
MD
95
96 enum { /* Fields populated mask */
97 CTF_CLOCK_name = (1U << 0),
98 } field_mask;
99};
100
145b8090
MD
101#define CTF_TRACE_SET_FIELD(ctf_trace, field) \
102 do { \
103 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
104 } while (0)
105
106#define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
107 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
108
109#define CTF_TRACE_GET_FIELD(ctf_trace, field) \
110 ({ \
111 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
112 (ctf_trace)->(field); \
113 })
114
cadd09e9
MD
115#define TRACER_ENV_LEN 128
116
117/* tracer-specific environment */
118struct ctf_tracer_env {
119 int vpid; /* negative if unset */
120
121 /* All strings below: "" if unset. */
122 char procname[TRACER_ENV_LEN];
123 char domain[TRACER_ENV_LEN];
124 char sysname[TRACER_ENV_LEN];
125 char release[TRACER_ENV_LEN];
126 char version[TRACER_ENV_LEN];
127};
128
145b8090
MD
129struct ctf_trace {
130 struct trace_descriptor parent;
131 /* root scope */
132 struct declaration_scope *root_declaration_scope;
133
134 struct declaration_scope *declaration_scope;
135 /* innermost definition scope. to be used as parent of stream. */
136 struct definition_scope *definition_scope;
137 GPtrArray *streams; /* Array of struct ctf_stream_class pointers */
2d0bea29 138 struct ctf_stream *metadata;
50cb9c56 139 GHashTable *clocks;
25ccc85b 140 struct ctf_clock *single_clock; /* currently supports only one clock */
fa709ab2 141 struct trace_collection *collection; /* Container of this trace */
145b8090 142
145b8090
MD
143 struct declaration_struct *packet_header_decl;
144
145 uint64_t major;
146 uint64_t minor;
147 uuid_t uuid;
148 int byte_order; /* trace BYTE_ORDER. 0 if unset. */
cadd09e9 149 struct ctf_tracer_env env;
145b8090
MD
150
151 enum { /* Fields populated mask */
152 CTF_TRACE_major = (1U << 0),
153 CTF_TRACE_minor = (1U << 1),
154 CTF_TRACE_uuid = (1U << 2),
155 CTF_TRACE_byte_order = (1U << 3),
156 CTF_TRACE_packet_header = (1U << 4),
157 } field_mask;
158
159 /* Information about trace backing directory and files */
160 DIR *dir;
161 int dirfd;
162 int flags; /* open flags */
163
164 /* Heap of streams, ordered to always get the lowest timestam */
165 struct ptr_heap *stream_heap;
82662ad4 166 char path[PATH_MAX];
145b8090
MD
167};
168
169#define CTF_STREAM_SET_FIELD(ctf_stream, field) \
170 do { \
171 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
172 } while (0)
173
174#define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
175 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
176
177#define CTF_STREAM_GET_FIELD(ctf_stream, field) \
178 ({ \
179 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
180 (ctf_stream)->(field); \
181 })
182
183struct ctf_stream_class {
184 struct ctf_trace *trace;
185 /* parent is lexical scope conaining the stream scope */
186 struct declaration_scope *declaration_scope;
187 /* innermost definition scope. to be used as parent of event. */
188 struct definition_scope *definition_scope;
189 GPtrArray *events_by_id; /* Array of struct ctf_event pointers indexed by id */
190 GHashTable *event_quark_to_id; /* GQuark to numeric id */
191
145b8090
MD
192 struct declaration_struct *packet_context_decl;
193 struct declaration_struct *event_header_decl;
194 struct declaration_struct *event_context_decl;
195
196 uint64_t stream_id;
197
198 enum { /* Fields populated mask */
199 CTF_STREAM_stream_id = (1 << 0),
200 } field_mask;
201
2d0bea29 202 GPtrArray *streams; /* Array of struct ctf_stream pointers */
145b8090
MD
203};
204
205#define CTF_EVENT_SET_FIELD(ctf_event, field) \
206 do { \
207 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
208 } while (0)
209
210#define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
211 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
212
213#define CTF_EVENT_GET_FIELD(ctf_event, field) \
214 ({ \
215 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
216 (ctf_event)->(field); \
217 })
218
219struct ctf_event {
220 /* stream mapped by stream_id */
221 struct ctf_stream_class *stream;
222 /* parent is lexical scope conaining the event scope */
223 struct declaration_scope *declaration_scope;
224
145b8090
MD
225 struct declaration_struct *context_decl;
226 struct declaration_struct *fields_decl;
227
228 GQuark name;
229 uint64_t id; /* Numeric identifier within the stream */
230 uint64_t stream_id;
306eeaa6 231 int loglevel;
145b8090
MD
232
233 enum { /* Fields populated mask */
d86d62f8
MD
234 CTF_EVENT_name = (1 << 0),
235 CTF_EVENT_id = (1 << 1),
236 CTF_EVENT_stream_id = (1 << 2),
306eeaa6 237 CTF_EVENT_loglevel = (1 << 4),
145b8090
MD
238 } field_mask;
239};
240
241#endif /* _BABELTRACE_CTF_IR_METADATA_H */
This page took 0.03182 seconds and 4 git commands to generate.