Commit | Line | Data |
---|---|---|
7cdc2bab MD |
1 | /* |
2 | * Copyright 2016 - Philippe Proulx <pproulx@efficios.com> | |
3 | * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation | |
4 | * | |
5 | * Some functions are based on older functions written by Mathieu Desnoyers. | |
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 | ||
020bc26f PP |
26 | #define BT_LOG_TAG "PLUGIN-CTF-LTTNG-LIVE-SRC-METADATA" |
27 | #include "logging.h" | |
28 | ||
7cdc2bab MD |
29 | #include <stdio.h> |
30 | #include <stdint.h> | |
31 | #include <stdlib.h> | |
32 | #include <stdbool.h> | |
33 | #include <glib.h> | |
34 | #include <babeltrace/compat/uuid-internal.h> | |
35 | #include <babeltrace/compat/memstream-internal.h> | |
9d408fca | 36 | #include <babeltrace/babeltrace.h> |
7cdc2bab | 37 | |
7cdc2bab MD |
38 | #include "metadata.h" |
39 | #include "../common/metadata/decoder.h" | |
40 | ||
41 | #define TSDL_MAGIC 0x75d11d57 | |
42 | ||
43 | struct packet_header { | |
44 | uint32_t magic; | |
45 | uint8_t uuid[16]; | |
46 | uint32_t checksum; | |
47 | uint32_t content_size; | |
48 | uint32_t packet_size; | |
49 | uint8_t compression_scheme; | |
50 | uint8_t encryption_scheme; | |
51 | uint8_t checksum_scheme; | |
52 | uint8_t major; | |
53 | uint8_t minor; | |
54 | } __attribute__((__packed__)); | |
55 | ||
56 | static | |
50842bdc | 57 | enum bt_lttng_live_iterator_status lttng_live_update_clock_map( |
7cdc2bab MD |
58 | struct lttng_live_trace *trace) |
59 | { | |
50842bdc PP |
60 | enum bt_lttng_live_iterator_status status = |
61 | BT_LTTNG_LIVE_ITERATOR_STATUS_OK; | |
7cdc2bab MD |
62 | size_t i; |
63 | int count, ret; | |
64 | ||
65300d60 | 65 | BT_OBJECT_PUT_REF_AND_RESET(trace->cc_prio_map); |
7cdc2bab MD |
66 | trace->cc_prio_map = bt_clock_class_priority_map_create(); |
67 | if (!trace->cc_prio_map) { | |
68 | goto error; | |
69 | } | |
70 | ||
50842bdc | 71 | count = bt_trace_get_clock_class_count(trace->trace); |
f6ccaed9 | 72 | BT_ASSERT(count >= 0); |
7cdc2bab MD |
73 | |
74 | for (i = 0; i < count; i++) { | |
50842bdc PP |
75 | struct bt_clock_class *clock_class = |
76 | bt_trace_get_clock_class_by_index(trace->trace, i); | |
7cdc2bab | 77 | |
f6ccaed9 | 78 | BT_ASSERT(clock_class); |
7cdc2bab MD |
79 | ret = bt_clock_class_priority_map_add_clock_class( |
80 | trace->cc_prio_map, clock_class, 0); | |
65300d60 | 81 | BT_OBJECT_PUT_REF_AND_RESET(clock_class); |
7cdc2bab MD |
82 | |
83 | if (ret) { | |
84 | goto error; | |
85 | } | |
86 | } | |
87 | ||
88 | goto end; | |
89 | error: | |
50842bdc | 90 | status = BT_LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
7cdc2bab MD |
91 | end: |
92 | return status; | |
93 | } | |
94 | ||
95 | BT_HIDDEN | |
50842bdc | 96 | enum bt_lttng_live_iterator_status lttng_live_metadata_update( |
7cdc2bab MD |
97 | struct lttng_live_trace *trace) |
98 | { | |
99 | struct lttng_live_session *session = trace->session; | |
7cdc2bab MD |
100 | struct lttng_live_metadata *metadata = trace->metadata; |
101 | ssize_t ret = 0; | |
102 | size_t size, len_read = 0; | |
103 | char *metadata_buf = NULL; | |
104 | FILE *fp = NULL; | |
105 | enum ctf_metadata_decoder_status decoder_status; | |
50842bdc PP |
106 | enum bt_lttng_live_iterator_status status = |
107 | BT_LTTNG_LIVE_ITERATOR_STATUS_OK; | |
7cdc2bab MD |
108 | |
109 | /* No metadata stream yet. */ | |
110 | if (!metadata) { | |
111 | if (session->new_streams_needed) { | |
50842bdc | 112 | status = BT_LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
7cdc2bab MD |
113 | } else { |
114 | session->new_streams_needed = true; | |
50842bdc | 115 | status = BT_LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
7cdc2bab MD |
116 | } |
117 | goto end; | |
118 | } | |
119 | ||
6f79a7cf MD |
120 | if (!metadata->trace) { |
121 | trace->new_metadata_needed = false; | |
122 | } | |
123 | ||
7cdc2bab MD |
124 | if (!trace->new_metadata_needed) { |
125 | goto end; | |
126 | } | |
127 | ||
128 | /* Open for writing */ | |
129 | fp = bt_open_memstream(&metadata_buf, &size); | |
130 | if (!fp) { | |
087bc060 | 131 | BT_LOGE("Metadata open_memstream: %s", strerror(errno)); |
7cdc2bab MD |
132 | goto error; |
133 | } | |
134 | ||
135 | /* Grab all available metadata. */ | |
136 | do { | |
137 | /* | |
138 | * get_one_metadata_packet returns the number of bytes | |
139 | * received, 0 when we have received everything, a | |
140 | * negative value on error. | |
141 | */ | |
142 | ret = lttng_live_get_one_metadata_packet(trace, fp); | |
143 | if (ret > 0) { | |
144 | len_read += ret; | |
145 | } | |
146 | } while (ret > 0); | |
147 | ||
148 | /* | |
149 | * Consider metadata closed as soon as we get an error reading | |
150 | * it (e.g. cannot be found). | |
151 | */ | |
152 | if (ret < 0) { | |
153 | if (!metadata->closed) { | |
154 | metadata->closed = true; | |
155 | /* | |
156 | * Release our reference on the trace as soon as | |
157 | * we know the metadata stream is not available | |
158 | * anymore. This won't necessarily teardown the | |
159 | * metadata objects immediately, but only when | |
160 | * the data streams are done. | |
161 | */ | |
162 | lttng_live_unref_trace(metadata->trace); | |
6f79a7cf | 163 | metadata->trace = NULL; |
7cdc2bab | 164 | } |
4c66436f | 165 | if (errno == EINTR) { |
6f79a7cf | 166 | if (lttng_live_is_canceled(session->lttng_live)) { |
50842bdc | 167 | status = BT_LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
4c66436f MD |
168 | goto end; |
169 | } | |
170 | } | |
7cdc2bab MD |
171 | } |
172 | ||
173 | if (bt_close_memstream(&metadata_buf, &size, fp)) { | |
174 | BT_LOGE("bt_close_memstream: %s", strerror(errno)); | |
175 | } | |
176 | ret = 0; | |
177 | fp = NULL; | |
178 | ||
179 | if (len_read == 0) { | |
180 | if (!trace->trace) { | |
50842bdc | 181 | status = BT_LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
7cdc2bab MD |
182 | goto end; |
183 | } | |
184 | trace->new_metadata_needed = false; | |
185 | goto end; | |
186 | } | |
187 | ||
7cdc2bab MD |
188 | fp = bt_fmemopen(metadata_buf, len_read, "rb"); |
189 | if (!fp) { | |
087bc060 | 190 | BT_LOGE("Cannot memory-open metadata buffer: %s", |
7cdc2bab MD |
191 | strerror(errno)); |
192 | goto error; | |
193 | } | |
194 | ||
195 | decoder_status = ctf_metadata_decoder_decode(metadata->decoder, fp); | |
196 | switch (decoder_status) { | |
197 | case CTF_METADATA_DECODER_STATUS_OK: | |
65300d60 | 198 | BT_OBJECT_PUT_REF_AND_RESET(trace->trace); |
7cdc2bab MD |
199 | trace->trace = ctf_metadata_decoder_get_trace(metadata->decoder); |
200 | trace->new_metadata_needed = false; | |
201 | status = lttng_live_update_clock_map(trace); | |
50842bdc | 202 | if (status != BT_LTTNG_LIVE_ITERATOR_STATUS_OK) { |
7cdc2bab MD |
203 | goto end; |
204 | } | |
205 | break; | |
206 | case CTF_METADATA_DECODER_STATUS_INCOMPLETE: | |
50842bdc | 207 | status = BT_LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
7cdc2bab MD |
208 | break; |
209 | case CTF_METADATA_DECODER_STATUS_ERROR: | |
210 | case CTF_METADATA_DECODER_STATUS_INVAL_VERSION: | |
211 | case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR: | |
212 | goto error; | |
213 | } | |
214 | ||
215 | goto end; | |
216 | error: | |
50842bdc | 217 | status = BT_LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
7cdc2bab MD |
218 | end: |
219 | if (fp) { | |
220 | int closeret; | |
221 | ||
222 | closeret = fclose(fp); | |
223 | if (closeret) { | |
087bc060 | 224 | BT_LOGE("Error on fclose"); |
7cdc2bab MD |
225 | } |
226 | } | |
6f79a7cf | 227 | free(metadata_buf); |
7cdc2bab MD |
228 | return status; |
229 | } | |
230 | ||
231 | BT_HIDDEN | |
232 | int lttng_live_metadata_create_stream(struct lttng_live_session *session, | |
233 | uint64_t ctf_trace_id, | |
06994c71 MD |
234 | uint64_t stream_id, |
235 | const char *trace_name) | |
7cdc2bab MD |
236 | { |
237 | struct lttng_live_metadata *metadata = NULL; | |
238 | struct lttng_live_trace *trace; | |
06994c71 | 239 | const char *match; |
7cdc2bab MD |
240 | |
241 | metadata = g_new0(struct lttng_live_metadata, 1); | |
242 | if (!metadata) { | |
243 | return -1; | |
244 | } | |
245 | metadata->stream_id = stream_id; | |
246 | //TODO: add clock offset option | |
06994c71 MD |
247 | match = strstr(trace_name, session->session_name->str); |
248 | if (!match) { | |
249 | goto error; | |
250 | } | |
a2a54545 | 251 | metadata->decoder = ctf_metadata_decoder_create(NULL, |
06994c71 | 252 | match); |
7cdc2bab MD |
253 | if (!metadata->decoder) { |
254 | goto error; | |
255 | } | |
256 | trace = lttng_live_ref_trace(session, ctf_trace_id); | |
257 | if (!trace) { | |
258 | goto error; | |
259 | } | |
260 | metadata->trace = trace; | |
261 | trace->metadata = metadata; | |
262 | return 0; | |
263 | ||
264 | error: | |
265 | ctf_metadata_decoder_destroy(metadata->decoder); | |
266 | g_free(metadata); | |
267 | return -1; | |
268 | } | |
269 | ||
270 | BT_HIDDEN | |
271 | void lttng_live_metadata_fini(struct lttng_live_trace *trace) | |
272 | { | |
273 | struct lttng_live_metadata *metadata = trace->metadata; | |
274 | ||
275 | if (!metadata) { | |
276 | return; | |
277 | } | |
278 | if (metadata->text) { | |
279 | free(metadata->text); | |
280 | } | |
281 | ctf_metadata_decoder_destroy(metadata->decoder); | |
282 | trace->metadata = NULL; | |
7cdc2bab MD |
283 | if (!metadata->closed) { |
284 | lttng_live_unref_trace(metadata->trace); | |
285 | } | |
286 | g_free(metadata); | |
287 | } |