lib: have dedicated "dynamic array FC with/without length field" types
[babeltrace.git] / src / plugins / lttng-utils / debug-info / trace-ir-data-copy.c
CommitLineData
58f6d595
FD
1/*
2 * Babeltrace - Trace IR data object copy
3 *
4 * Copyright (c) 2015-2019 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2019 Francis Deslauriers <francis.deslauriers@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
475e740e 26#define BT_COMP_LOG_SELF_COMP self_comp
a07aba4f 27#define BT_LOG_OUTPUT_LEVEL log_level
b03487ab 28#define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO/TRACE-IR-DATA-COPY"
3fa1b6a3 29#include "logging/comp-logging.h"
58f6d595
FD
30
31#include <inttypes.h>
32#include <stdint.h>
33
57952005 34#include "common/assert.h"
58f6d595
FD
35
36#include "trace-ir-data-copy.h"
37
38BT_HIDDEN
a07aba4f 39void copy_trace_content(const bt_trace *in_trace, bt_trace *out_trace,
475e740e 40 bt_logging_level log_level, bt_self_component *self_comp)
58f6d595 41{
fb25b9e3 42 bt_trace_set_name_status status;
58f6d595 43 const char *trace_name;
cd03c43c 44 uint64_t i, env_field_count;
58f6d595 45
475e740e 46 BT_COMP_LOGD("Copying content of trace: in-t-addr=%p, out-t-addr=%p",
58f6d595 47 in_trace, out_trace);
58f6d595
FD
48 trace_name = bt_trace_get_name(in_trace);
49 /* Copy the trace name. */
50 if (trace_name) {
51 status = bt_trace_set_name(out_trace, trace_name);
fb25b9e3 52 if (status != BT_TRACE_SET_NAME_STATUS_OK) {
475e740e 53 BT_COMP_LOGE("Cannot set trace's name: trace-addr=%p, name=\"%s\"",
fb25b9e3 54 out_trace, trace_name);
0fb60f5d 55 bt_current_thread_clear_error();
58f6d595
FD
56 goto end;
57 }
58 }
59
84ff66df
PP
60 /*
61 * Safe to use the same value object because it's frozen at this
62 * point.
63 */
64 bt_trace_set_user_attributes(out_trace,
65 bt_trace_borrow_user_attributes_const(in_trace));
66
cd03c43c
PP
67 /*
68 * Do not copy the trace UUID as it may be modified and should
69 * no longer have the same UUID.
70 */
71
72 /*
73 * Go over all the entries in the environment section of the
74 * trace and copy the content to the new trace.
75 */
76 env_field_count = bt_trace_get_environment_entry_count(in_trace);
77 for (i = 0; i < env_field_count; i++) {
78 const char *value_name;
79 const bt_value *value = NULL;
80 bt_trace_set_environment_entry_status set_env_status;
81
82 bt_trace_borrow_environment_entry_by_index_const(
83 in_trace, i, &value_name, &value);
84
85 BT_COMP_LOGD("Copying trace environnement entry: "
86 "index=%" PRId64 ", value-addr=%p, value-name=%s",
87 i, value, value_name);
88
89 BT_ASSERT(value_name);
90 BT_ASSERT(value);
91
92 if (bt_value_is_signed_integer(value)) {
9a51bfb2
FD
93 set_env_status = bt_trace_set_environment_entry_integer(
94 out_trace, value_name,
95 bt_value_integer_signed_get( value));
cd03c43c 96 } else if (bt_value_is_string(value)) {
9a51bfb2
FD
97 set_env_status = bt_trace_set_environment_entry_string(
98 out_trace, value_name,
99 bt_value_string_get(value));
cd03c43c
PP
100 } else {
101 abort();
102 }
103
9a51bfb2 104 if (set_env_status != BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_OK) {
cd03c43c
PP
105 BT_COMP_LOGE("Cannot copy trace's environment: "
106 "trace-addr=%p, name=\"%s\"",
107 out_trace, trace_name);
108 bt_current_thread_clear_error();
109 goto end;
110 }
111 }
112
475e740e 113 BT_COMP_LOGD("Copied content of trace: in-t-addr=%p, out-t-addr=%p",
58f6d595
FD
114 in_trace, out_trace);
115end:
116 return;
117}
118
119BT_HIDDEN
a07aba4f 120void copy_stream_content(const bt_stream *in_stream, bt_stream *out_stream,
475e740e 121 bt_logging_level log_level, bt_self_component *self_comp)
58f6d595 122{
58f6d595 123 const char *stream_name;
fb25b9e3 124 bt_stream_set_name_status status;
58f6d595 125
475e740e 126 BT_COMP_LOGD("Copying content of stream: in-s-addr=%p, out-s-addr=%p",
58f6d595
FD
127 in_stream, out_stream);
128
58f6d595
FD
129 stream_name = bt_stream_get_name(in_stream);
130 if (stream_name) {
131 status = bt_stream_set_name(out_stream, stream_name);
fb25b9e3 132 if (status != BT_STREAM_SET_NAME_STATUS_OK) {
475e740e 133 BT_COMP_LOGE("Cannot set stream's name: stream-addr=%p, "
58f6d595
FD
134 "name=%s", out_stream, stream_name);
135 goto end;
136 }
137 }
138
84ff66df
PP
139 /*
140 * Safe to use the same value object because it's frozen at this
141 * point.
142 */
143 bt_stream_set_user_attributes(out_stream,
144 bt_stream_borrow_user_attributes_const(in_stream));
475e740e 145 BT_COMP_LOGD("Copied content of stream: in-s-addr=%p, out-s-addr=%p",
58f6d595
FD
146 in_stream, out_stream);
147end:
148 return;
149}
150
151BT_HIDDEN
a07aba4f 152void copy_packet_content(const bt_packet *in_packet, bt_packet *out_packet,
475e740e 153 bt_logging_level log_level, bt_self_component *self_comp)
58f6d595
FD
154{
155 const bt_field *in_context_field;
156 bt_field *out_context_field;
157
475e740e 158 BT_COMP_LOGD("Copying content of packet: in-p-addr=%p, out-p-addr=%p",
58f6d595
FD
159 in_packet, out_packet);
160
161 /* Copy context field. */
162 in_context_field = bt_packet_borrow_context_field_const(in_packet);
163 if (in_context_field) {
164 out_context_field = bt_packet_borrow_context_field(out_packet);
165 BT_ASSERT(out_context_field);
a07aba4f 166 copy_field_content(in_context_field, out_context_field,
475e740e 167 log_level, self_comp);
58f6d595
FD
168 }
169
475e740e 170 BT_COMP_LOGD("Copied content of packet: in-p-addr=%p, out-p-addr=%p",
58f6d595
FD
171 in_packet, out_packet);
172 return;
173}
174
175BT_HIDDEN
a07aba4f 176void copy_event_content(const bt_event *in_event, bt_event *out_event,
475e740e 177 bt_logging_level log_level, bt_self_component *self_comp)
58f6d595
FD
178{
179 const bt_field *in_common_ctx_field, *in_specific_ctx_field,
180 *in_payload_field;
181 bt_field *out_common_ctx_field, *out_specific_ctx_field,
182 *out_payload_field;
183
475e740e 184 BT_COMP_LOGD("Copying content of event: in-e-addr=%p, out-e-addr=%p",
58f6d595
FD
185 in_event, out_event);
186 in_common_ctx_field =
187 bt_event_borrow_common_context_field_const(in_event);
188 if (in_common_ctx_field) {
189 out_common_ctx_field =
190 bt_event_borrow_common_context_field(out_event);
191 BT_ASSERT(out_common_ctx_field);
192 copy_field_content(in_common_ctx_field,
475e740e 193 out_common_ctx_field, log_level, self_comp);
58f6d595
FD
194 }
195
196 in_specific_ctx_field =
197 bt_event_borrow_specific_context_field_const(in_event);
198 if (in_specific_ctx_field) {
199 out_specific_ctx_field =
200 bt_event_borrow_specific_context_field(out_event);
201 BT_ASSERT(out_specific_ctx_field);
202 copy_field_content(in_specific_ctx_field,
475e740e 203 out_specific_ctx_field, log_level, self_comp);
58f6d595
FD
204 }
205
206 in_payload_field = bt_event_borrow_payload_field_const(in_event);
207 if (in_payload_field) {
208 out_payload_field = bt_event_borrow_payload_field(out_event);
209 BT_ASSERT(out_payload_field);
210 copy_field_content(in_payload_field,
475e740e 211 out_payload_field, log_level, self_comp);
58f6d595
FD
212 }
213
475e740e 214 BT_COMP_LOGD("Copied content of event: in-e-addr=%p, out-e-addr=%p",
58f6d595
FD
215 in_event, out_event);
216}
217
218BT_HIDDEN
a07aba4f 219void copy_field_content(const bt_field *in_field, bt_field *out_field,
475e740e 220 bt_logging_level log_level, bt_self_component *self_comp)
58f6d595
FD
221{
222 bt_field_class_type in_fc_type, out_fc_type;
223
224 in_fc_type = bt_field_get_class_type(in_field);
225 out_fc_type = bt_field_get_class_type(out_field);
226 BT_ASSERT(in_fc_type == out_fc_type);
227
c9ecaa78 228 BT_COMP_LOGT("Copying content of field: in-f-addr=%p, out-f-addr=%p",
58f6d595
FD
229 in_field, out_field);
230 switch (in_fc_type) {
41bdd7c1
PP
231 case BT_FIELD_CLASS_TYPE_BOOL:
232 bt_field_bool_set_value(out_field,
233 bt_field_bool_get_value(in_field));
234 break;
f5f2c882
PP
235 case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
236 bt_field_bit_array_set_value_as_integer(out_field,
237 bt_field_bit_array_get_value_as_integer(in_field));
238 break;
58f6d595
FD
239 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
240 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
60bbfc7c
PP
241 bt_field_integer_unsigned_set_value(out_field,
242 bt_field_integer_unsigned_get_value(in_field));
58f6d595
FD
243 break;
244 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
245 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
60bbfc7c
PP
246 bt_field_integer_signed_set_value(out_field,
247 bt_field_integer_signed_get_value(in_field));
58f6d595 248 break;
76276a81
FD
249 case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL:
250 bt_field_real_single_precision_set_value(out_field,
251 bt_field_real_single_precision_get_value(in_field));
252 break;
253 case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
254 bt_field_real_double_precision_set_value(out_field,
255 bt_field_real_double_precision_get_value(in_field));
58f6d595
FD
256 break;
257 case BT_FIELD_CLASS_TYPE_STRING:
258 {
259 const char *str = bt_field_string_get_value(in_field);
fb25b9e3
PP
260 bt_field_string_set_value_status status =
261 bt_field_string_set_value(out_field, str);
262 if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
475e740e 263 BT_COMP_LOGE("Cannot set string field's value: "
58f6d595
FD
264 "str-field-addr=%p, str=%s" PRId64,
265 out_field, str);
0fb60f5d
PP
266 bt_current_thread_clear_error();
267
58f6d595
FD
268 }
269 break;
270 }
271 case BT_FIELD_CLASS_TYPE_STRUCTURE:
272 {
273 uint64_t i, nb_member_struct;
274 const bt_field *in_member_field;
275 bt_field *out_member_field;
e24f271a 276 const bt_field_class *in_field_class;
58f6d595
FD
277 const char *in_member_name;
278
279 in_field_class = bt_field_borrow_class_const(in_field);
280 nb_member_struct = bt_field_class_structure_get_member_count(
281 in_field_class);
282
283 /*
284 * Iterate over the fields by names in the input field to avoid
285 * problem if the struct fields are not in the same order after
286 * the debug-info was added.
287 */
288 for (i = 0; i < nb_member_struct; i++) {
e24f271a
PP
289 const bt_field_class_structure_member *member =
290 bt_field_class_structure_borrow_member_by_index_const(
291 in_field_class, i);
58f6d595 292
e24f271a
PP
293 in_member_name =
294 bt_field_class_structure_member_get_name(
295 member);
58f6d595
FD
296 in_member_field =
297 bt_field_structure_borrow_member_field_by_name_const(
9a51bfb2 298 in_field, in_member_name);
58f6d595
FD
299 out_member_field =
300 bt_field_structure_borrow_member_field_by_name(
9a51bfb2 301 out_field, in_member_name);
58f6d595
FD
302
303 copy_field_content(in_member_field,
475e740e 304 out_member_field, log_level, self_comp);
58f6d595
FD
305 }
306 break;
307 }
b8ddb4f0
PP
308 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
309 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
58f6d595
FD
310 /* fall through */
311 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
312 {
313 const bt_field *in_element_field;
314 bt_field *out_element_field;
315 uint64_t i, array_len;
60bbfc7c 316 bt_field_array_dynamic_set_length_status set_len_status;
58f6d595
FD
317
318 array_len = bt_field_array_get_length(in_field);
319
b8ddb4f0
PP
320 if (in_fc_type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD ||
321 in_fc_type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD) {
60bbfc7c 322 set_len_status = bt_field_array_dynamic_set_length(
fb25b9e3
PP
323 out_field, array_len);
324 if (set_len_status !=
325 BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_OK) {
475e740e 326 BT_COMP_LOGE("Cannot set dynamic array field's "
58f6d595
FD
327 "length field: field-addr=%p, "
328 "length=%" PRIu64, out_field, array_len);
0fb60f5d 329 bt_current_thread_clear_error();
58f6d595
FD
330 }
331 }
332
333 for (i = 0; i < array_len; i++) {
334 in_element_field =
335 bt_field_array_borrow_element_field_by_index_const(
fb25b9e3 336 in_field, i);
58f6d595
FD
337 out_element_field =
338 bt_field_array_borrow_element_field_by_index(
fb25b9e3 339 out_field, i);
a07aba4f 340 copy_field_content(in_element_field, out_element_field,
475e740e 341 log_level, self_comp);
58f6d595
FD
342 }
343 break;
344 }
467673c1
PP
345 case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR:
346 case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR:
347 case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR:
348 case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR:
978237e9
PP
349 {
350 const bt_field *in_option_field;
351 bt_field *out_option_field;
352
353 in_option_field = bt_field_option_borrow_field_const(in_field);
354
355 if (in_option_field) {
356 bt_field_option_set_has_field(out_field, BT_TRUE);
357 out_option_field = bt_field_option_borrow_field(
358 out_field);
359 BT_ASSERT(out_option_field);
360 copy_field_content(in_option_field, out_option_field,
361 log_level, self_comp);
362 } else {
363 bt_field_option_set_has_field(out_field, BT_FALSE);
364 }
365
366 break;
367 }
02b61fe0 368 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
0822832b
PP
369 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR:
370 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR:
58f6d595 371 {
02b61fe0 372 bt_field_variant_select_option_field_by_index_status sel_opt_status;
58f6d595
FD
373 uint64_t in_selected_option_idx;
374 const bt_field *in_option_field;
375 bt_field *out_option_field;
376
377 in_selected_option_idx =
378 bt_field_variant_get_selected_option_field_index(
9a51bfb2 379 in_field);
02b61fe0 380 sel_opt_status = bt_field_variant_select_option_field_by_index(out_field,
9a51bfb2 381 in_selected_option_idx);
fb25b9e3
PP
382 if (sel_opt_status !=
383 BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK) {
475e740e 384 BT_COMP_LOGE("Cannot select variant field's option field: "
58f6d595
FD
385 "var-field-addr=%p, opt-index=%" PRId64,
386 out_field, in_selected_option_idx);
0fb60f5d 387 bt_current_thread_clear_error();
58f6d595
FD
388 }
389
390 in_option_field = bt_field_variant_borrow_selected_option_field_const(in_field);
391 out_option_field = bt_field_variant_borrow_selected_option_field(out_field);
392
a07aba4f 393 copy_field_content(in_option_field, out_option_field,
475e740e 394 log_level, self_comp);
58f6d595
FD
395
396 break;
397 }
398 default:
399 abort();
400 }
c9ecaa78 401 BT_COMP_LOGT("Copied content of field: in-f-addr=%p, out-f-addr=%p",
58f6d595
FD
402 in_field, out_field);
403}
This page took 0.054896 seconds and 4 git commands to generate.