lib: add option field classes with integer selectors
[babeltrace.git] / src / common / common.h
1 #ifndef BABELTRACE_COMMON_INTERNAL_H
2 #define BABELTRACE_COMMON_INTERNAL_H
3
4 /*
5 * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
6 * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27 #include <errno.h>
28 #include <glib.h>
29 #include <inttypes.h>
30 #include <stdarg.h>
31 #include <stdbool.h>
32 #include <stdint.h>
33 #include <stdlib.h>
34 #include <stdio.h>
35 #include <unistd.h>
36 #include <string.h>
37
38 #include <babeltrace2/babeltrace.h>
39
40 #define __BT_IN_BABELTRACE_H
41 #include <babeltrace2/func-status.h>
42
43 #include "common/assert.h"
44 #include "common/macros.h"
45 #include "common/safe.h"
46
47 #define BT_COMMON_COLOR_RESET "\033[0m"
48 #define BT_COMMON_COLOR_BOLD "\033[1m"
49 #define BT_COMMON_COLOR_FG_DEFAULT "\033[39m"
50 #define BT_COMMON_COLOR_FG_RED "\033[31m"
51 #define BT_COMMON_COLOR_FG_GREEN "\033[32m"
52 #define BT_COMMON_COLOR_FG_YELLOW "\033[33m"
53 #define BT_COMMON_COLOR_FG_BLUE "\033[34m"
54 #define BT_COMMON_COLOR_FG_MAGENTA "\033[35m"
55 #define BT_COMMON_COLOR_FG_CYAN "\033[36m"
56 #define BT_COMMON_COLOR_FG_LIGHT_GRAY "\033[37m"
57 #define BT_COMMON_COLOR_BG_DEFAULT "\033[49m"
58 #define BT_COMMON_COLOR_BG_RED "\033[41m"
59 #define BT_COMMON_COLOR_BG_GREEN "\033[42m"
60 #define BT_COMMON_COLOR_BG_YELLOW "\033[43m"
61 #define BT_COMMON_COLOR_BG_BLUE "\033[44m"
62 #define BT_COMMON_COLOR_BG_MAGENTA "\033[45m"
63 #define BT_COMMON_COLOR_BG_CYAN "\033[46m"
64 #define BT_COMMON_COLOR_BG_LIGHT_GRAY "\033[47m"
65
66 struct bt_common_lttng_live_url_parts {
67 GString *proto;
68 GString *hostname;
69 GString *target_hostname;
70 GString *session_name;
71
72 /* -1 means default port */
73 int port;
74 };
75
76 /*
77 * Checks if the current process has setuid or setgid access rights.
78 * Returns `true` if so.
79 */
80 BT_HIDDEN
81 bool bt_common_is_setuid_setgid(void);
82
83 /*
84 * Returns the system-wide plugin path, e.g.
85 * `/usr/lib/babeltrace2/plugins`. Do not free the return value.
86 */
87 BT_HIDDEN
88 const char *bt_common_get_system_plugin_path(void);
89
90 /*
91 * Returns the user plugin path, e.g.
92 * `/home/user/.local/lib/babeltrace2/plugins`. You need to free the
93 * return value.
94 */
95 BT_HIDDEN
96 char *bt_common_get_home_plugin_path(int log_level);
97
98 /*
99 * Appends the list of directories in `paths` to the array `dirs`.
100 * `paths` is a list of directories separated by `:`. Returns 0 on
101 * success.
102 */
103 BT_HIDDEN
104 int bt_common_append_plugin_path_dirs(const char *paths, GPtrArray *dirs);
105
106 /*
107 * Returns `true` if terminal color codes are supported for this
108 * process.
109 */
110 BT_HIDDEN
111 bool bt_common_colors_supported(void);
112
113 BT_HIDDEN
114 const char *bt_common_color_reset(void);
115
116 BT_HIDDEN
117 const char *bt_common_color_bold(void);
118
119 BT_HIDDEN
120 const char *bt_common_color_fg_default(void);
121
122 BT_HIDDEN
123 const char *bt_common_color_fg_red(void);
124
125 BT_HIDDEN
126 const char *bt_common_color_fg_green(void);
127
128 BT_HIDDEN
129 const char *bt_common_color_fg_yellow(void);
130
131 BT_HIDDEN
132 const char *bt_common_color_fg_blue(void);
133
134 BT_HIDDEN
135 const char *bt_common_color_fg_magenta(void);
136
137 BT_HIDDEN
138 const char *bt_common_color_fg_cyan(void);
139
140 BT_HIDDEN
141 const char *bt_common_color_fg_light_gray(void);
142
143 BT_HIDDEN
144 const char *bt_common_color_bg_default(void);
145
146 BT_HIDDEN
147 const char *bt_common_color_bg_red(void);
148
149 BT_HIDDEN
150 const char *bt_common_color_bg_green(void);
151
152 BT_HIDDEN
153 const char *bt_common_color_bg_yellow(void);
154
155 BT_HIDDEN
156 const char *bt_common_color_bg_blue(void);
157
158 BT_HIDDEN
159 const char *bt_common_color_bg_magenta(void);
160
161 BT_HIDDEN
162 const char *bt_common_color_bg_cyan(void);
163
164 BT_HIDDEN
165 const char *bt_common_color_bg_light_gray(void);
166
167 /*
168 * Returns the substring from `input` to the first character found
169 * in the list of characters `end_chars`, unescaping any character
170 * found in `escapable_chars`, and sets `*end_pos` to the position of
171 * the end (from `input`). The caller owns the returned GString.
172 */
173 BT_HIDDEN
174 GString *bt_common_string_until(const char *input, const char *escapable_chars,
175 const char *end_chars, size_t *end_pos);
176
177 /*
178 * Returns the quoted version of `input` for a shell. If
179 * `with_single_quotes` is `true`, prepends and appends the `'` prefix
180 * and suffix to the returned string; otherwise the caller should
181 * prepend and append them manually, although they are not always
182 * required. The caller owns the returned GString.
183 */
184 BT_HIDDEN
185 GString *bt_common_shell_quote(const char *input, bool with_single_quotes);
186
187 /*
188 * Returns `true` if `input` is a string made only of printable
189 * characters.
190 */
191 BT_HIDDEN
192 bool bt_common_string_is_printable(const char *input);
193
194 /*
195 * Destroys the parts of an LTTng live URL as returned by
196 * bt_common_parse_lttng_live_url().
197 */
198 BT_HIDDEN
199 void bt_common_destroy_lttng_live_url_parts(
200 struct bt_common_lttng_live_url_parts *parts);
201
202 /*
203 * Parses the LTTng live URL `url` and returns its different parts.
204 * If there's an error, writes the error message into `*error_buf`
205 * up to `error_buf_size` bytes. You must destroy the returned value
206 * with bt_common_destroy_lttng_live_url_parts().
207 */
208 BT_HIDDEN
209 struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
210 const char *url, char *error_buf, size_t error_buf_size);
211
212 /*
213 * Normalizes (in place) a star globbing pattern to be used with
214 * bt_common_star_glob_match(). This function always succeeds.
215 */
216 BT_HIDDEN
217 void bt_common_normalize_star_glob_pattern(char *pattern);
218
219 /*
220 * Returns `true` if `candidate` (of size `candidate_len`) matches
221 * the star globbing pattern `pattern` (of size `pattern_len`).
222 */
223 BT_HIDDEN
224 bool bt_common_star_glob_match(const char *pattern, size_t pattern_len,
225 const char *candidate, size_t candidate_len);
226
227 /*
228 * Normalizes the path `path`:
229 *
230 * * If it's a relative path, converts it to an absolute path using
231 * `wd` as the working directory (or the current working directory
232 * if `wd` is NULL).
233 * * Removes consecutive and trailing slashes.
234 * * Resolves `..` and `.` in the path (both in `path` and in `wd`).
235 * * Does NOT resolve symbolic links.
236 *
237 * The caller owns the returned GString.
238 */
239 BT_HIDDEN
240 GString *bt_common_normalize_path(const char *path, const char *wd);
241
242 typedef void (* bt_common_handle_custom_specifier_func)(void *priv_data,
243 char **buf, size_t avail_size, const char **fmt, va_list *args);
244
245 /*
246 * This is a custom vsnprintf() which handles the standard conversion
247 * specifier as well as custom ones.
248 *
249 * `fmt` is a typical printf()-style format string, with the following
250 * limitations:
251 *
252 * * The `*` width specifier is not accepted.
253 * * The `*` precision specifier is not accepted.
254 * * The `j` and `t` length modifiers are not accepted.
255 * * The `n` format specifier is not accepted.
256 * * The format specifiers defined in <inttypes.h> are not accepted
257 * except for `PRId64`, `PRIu64`, `PRIx64`, `PRIX64`, `PRIo64`, and
258 * `PRIi64`.
259 *
260 * `intro` specifies which special character immediately following an
261 * introductory `%` character in `fmt` is used to indicate a custom
262 * conversion specifier. For example, if `intro` is '@', then any `%@`
263 * sequence in `fmt` is the beginning of a custom conversion specifier.
264 *
265 * When a custom conversion specifier is encountered in `fmt`,
266 * the function calls `handle_specifier`. This callback receives:
267 *
268 * `priv_data`:
269 * Custom, private data.
270 *
271 * `buf`:
272 * Address of the current buffer pointer. `*buf` is the position to
273 * append new data. The callback must update `*buf` when appending
274 * new data. The callback must ensure not to write passed the whole
275 * buffer passed to bt_common_custom_vsnprintf().
276 *
277 * `avail_size`:
278 * Number of bytes left in whole buffer from the `*buf` point.
279 *
280 * `fmt`:
281 * Address of the current format string pointer. `*fmt` points to
282 * the introductory `%` character, which is followed by the
283 * character `intro`. The callback must update `*fmt` so that it
284 * points after the whole custom conversion specifier.
285 *
286 * `args`:
287 * Variable argument list. Use va_arg() to get new arguments from
288 * this list and update it at the same time.
289 *
290 * Because this is an internal utility, this function and its callback
291 * do not return error codes: they abort when there's any error (bad
292 * format string, for example).
293 */
294 BT_HIDDEN
295 void bt_common_custom_vsnprintf(char *buf, size_t buf_size,
296 char intro,
297 bt_common_handle_custom_specifier_func handle_specifier,
298 void *priv_data, const char *fmt, va_list *args);
299
300 /*
301 * Variadic form of bt_common_custom_vsnprintf().
302 */
303 BT_HIDDEN
304 void bt_common_custom_snprintf(char *buf, size_t buf_size,
305 char intro,
306 bt_common_handle_custom_specifier_func handle_specifier,
307 void *priv_data, const char *fmt, ...);
308
309 /*
310 * Returns the system page size.
311 */
312 BT_HIDDEN
313 size_t bt_common_get_page_size(int log_level);
314
315 /*
316 * Adds the digit separator `sep` as many times as needed to form groups
317 * of `digits_per_group` digits within `str`. `str` must have enough
318 * room to accomodate the new separators, that is:
319 *
320 * strlen(str) + (strlen(str) / digits_per_group) + 1
321 *
322 * Example: with `str` `1983198398213`, `digits_per_group` 3, and `sep`
323 * `,`, `str` becomes `1,983,198,398,213`.
324 *
325 * `strlen(str)` must not be 0. `digits_per_group` must not be 0. `sep`
326 * must not be `\0`.
327 */
328 BT_HIDDEN
329 void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep);
330
331 /*
332 * This is similar to what the command `fold --spaces` does: it wraps
333 * the input lines of `str`, breaking at spaces, and indenting each line
334 * with `indent` spaces so that each line fits the total length
335 * `total_length`.
336 *
337 * If an original line in `str` contains a word which is >= the content
338 * length (`total_length - indent`), then the corresponding folded line
339 * is also larger than the content length. In other words, breaking at
340 * spaces is a best effort, but it might not be possible.
341 *
342 * The returned string, on success, is owned by the caller.
343 */
344 BT_HIDDEN
345 GString *bt_common_fold(const char *str, unsigned int total_length,
346 unsigned int indent);
347
348 /*
349 * Writes the terminal's width to `*width`, its height to `*height`,
350 * and returns 0 on success, or returns -1 on error.
351 */
352 BT_HIDDEN
353 int bt_common_get_term_size(unsigned int *width, unsigned int *height);
354
355 /*
356 * Appends the textual content of `fp` to `str`, starting from its
357 * current position to the end of the file.
358 *
359 * This function does NOT rewind `fp` once it's done or on error.
360 */
361 BT_HIDDEN
362 int bt_common_append_file_content_to_g_string(GString *str, FILE *fp);
363
364 /*
365 * Wraps read() function to handle EINTR and partial reads.
366 * On success, it returns `count` received as parameter. On error, it returns a
367 * value smaller than the requested `count`.
368 */
369 static inline
370 ssize_t bt_common_read(int fd, void *buf, size_t count, int log_level)
371 {
372 size_t i = 0;
373 ssize_t ret;
374
375 BT_ASSERT(buf);
376
377 /* Never return an overflow value. */
378 BT_ASSERT(count <= SSIZE_MAX);
379
380 do {
381 ret = read(fd, buf + i, count - i);
382 if (ret < 0) {
383 if (errno == EINTR) {
384 #ifdef BT_LOG_WRITE_CUR_LVL
385 BT_LOG_WRITE_CUR_LVL(BT_LOG_DEBUG, log_level,
386 BT_LOG_TAG,
387 "read() call interrupted; retrying...");
388 #endif
389 /* retry operation */
390 continue;
391 } else {
392 #ifdef BT_LOG_WRITE_ERRNO_CUR_LVL
393 BT_LOG_WRITE_ERRNO_CUR_LVL(BT_LOG_ERROR,
394 log_level, BT_LOG_TAG,
395 "Error while reading", ": fd=%d", fd);
396 #endif
397 goto end;
398 }
399 }
400 i += ret;
401 BT_ASSERT(i <= count);
402 } while (count - i > 0 && ret > 0);
403
404 end:
405 if (ret >= 0) {
406 if (i == 0) {
407 ret = -1;
408 } else {
409 ret = i;
410 }
411 }
412
413 return ret;
414 }
415
416 static inline
417 const char *bt_common_field_class_type_string(enum bt_field_class_type class_type)
418 {
419 switch (class_type) {
420 case BT_FIELD_CLASS_TYPE_BOOL:
421 return "BOOL";
422 case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
423 return "BIT_ARRAY";
424 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
425 return "UNSIGNED_INTEGER";
426 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
427 return "SIGNED_INTEGER";
428 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
429 return "UNSIGNED_ENUMERATION";
430 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
431 return "SIGNED_ENUMERATION";
432 case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL:
433 return "SINGLE_PRECISION_REAL";
434 case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
435 return "DOUBLE_PRECISION_REAL";
436 case BT_FIELD_CLASS_TYPE_STRING:
437 return "STRING";
438 case BT_FIELD_CLASS_TYPE_STRUCTURE:
439 return "STRUCTURE";
440 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
441 return "STATIC_ARRAY";
442 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
443 return "DYNAMIC_ARRAY";
444 case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR:
445 return "OPTION_WITHOUT_SELECTOR";
446 case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR:
447 return "OPTION_WITH_BOOL_SELECTOR";
448 case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR:
449 return "OPTION_WITH_UNSIGNED_INTEGER_SELECTOR";
450 case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR:
451 return "OPTION_WITH_SIGNED_INTEGER_SELECTOR";
452 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
453 return "VARIANT_WITHOUT_SELECTOR";
454 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR:
455 return "VARIANT_WITH_UNSIGNED_SELECTOR";
456 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR:
457 return "VARIANT_WITH_SIGNED_SELECTOR";
458 default:
459 return "(unknown)";
460 }
461 };
462
463 static inline
464 const char *bt_common_field_class_integer_preferred_display_base_string(enum bt_field_class_integer_preferred_display_base base)
465 {
466 switch (base) {
467 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY:
468 return "BINARY";
469 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL:
470 return "OCTAL";
471 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL:
472 return "DECIMAL";
473 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL:
474 return "HEXADECIMAL";
475 default:
476 return "(unknown)";
477 }
478 }
479
480 static inline
481 const char *bt_common_scope_string(enum bt_field_path_scope scope)
482 {
483 switch (scope) {
484 case BT_FIELD_PATH_SCOPE_PACKET_CONTEXT:
485 return "PACKET_CONTEXT";
486 case BT_FIELD_PATH_SCOPE_EVENT_COMMON_CONTEXT:
487 return "EVENT_COMMON_CONTEXT";
488 case BT_FIELD_PATH_SCOPE_EVENT_SPECIFIC_CONTEXT:
489 return "EVENT_SPECIFIC_CONTEXT";
490 case BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD:
491 return "EVENT_PAYLOAD";
492 default:
493 return "(unknown)";
494 }
495 }
496
497 static inline
498 const char *bt_common_event_class_log_level_string(
499 enum bt_event_class_log_level level)
500 {
501 switch (level) {
502 case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY:
503 return "EMERGENCY";
504 case BT_EVENT_CLASS_LOG_LEVEL_ALERT:
505 return "ALERT";
506 case BT_EVENT_CLASS_LOG_LEVEL_CRITICAL:
507 return "CRITICAL";
508 case BT_EVENT_CLASS_LOG_LEVEL_ERROR:
509 return "ERROR";
510 case BT_EVENT_CLASS_LOG_LEVEL_WARNING:
511 return "WARNING";
512 case BT_EVENT_CLASS_LOG_LEVEL_NOTICE:
513 return "NOTICE";
514 case BT_EVENT_CLASS_LOG_LEVEL_INFO:
515 return "INFO";
516 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM:
517 return "DEBUG_SYSTEM";
518 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM:
519 return "DEBUG_PROGRAM";
520 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS:
521 return "DEBUG_PROCESS";
522 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE:
523 return "DEBUG_MODULE";
524 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT:
525 return "DEBUG_UNIT";
526 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION:
527 return "DEBUG_FUNCTION";
528 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE:
529 return "DEBUG_LINE";
530 case BT_EVENT_CLASS_LOG_LEVEL_DEBUG:
531 return "DEBUG";
532 default:
533 return "(unknown)";
534 }
535 };
536
537 static inline
538 const char *bt_common_value_type_string(enum bt_value_type type)
539 {
540 switch (type) {
541 case BT_VALUE_TYPE_NULL:
542 return "NULL";
543 case BT_VALUE_TYPE_BOOL:
544 return "BOOL";
545 case BT_VALUE_TYPE_UNSIGNED_INTEGER:
546 return "UNSIGNED_INTEGER";
547 case BT_VALUE_TYPE_SIGNED_INTEGER:
548 return "SIGNED_INTEGER";
549 case BT_VALUE_TYPE_REAL:
550 return "REAL";
551 case BT_VALUE_TYPE_STRING:
552 return "STRING";
553 case BT_VALUE_TYPE_ARRAY:
554 return "ARRAY";
555 case BT_VALUE_TYPE_MAP:
556 return "MAP";
557 default:
558 return "(unknown)";
559 }
560 };
561
562 static inline
563 GString *bt_common_field_path_string(struct bt_field_path *path)
564 {
565 GString *str = g_string_new(NULL);
566 uint64_t i;
567
568 BT_ASSERT(path);
569
570 if (!str) {
571 goto end;
572 }
573
574 g_string_append_printf(str, "[%s", bt_common_scope_string(
575 bt_field_path_get_root_scope(path)));
576
577 for (i = 0; i < bt_field_path_get_item_count(path); i++) {
578 const struct bt_field_path_item *fp_item =
579 bt_field_path_borrow_item_by_index_const(path, i);
580
581 switch (bt_field_path_item_get_type(fp_item)) {
582 case BT_FIELD_PATH_ITEM_TYPE_INDEX:
583 g_string_append_printf(str, ", %" PRIu64,
584 bt_field_path_item_index_get_index(fp_item));
585 break;
586 case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
587 g_string_append(str, ", <CUR>");
588 break;
589 default:
590 abort();
591 }
592 }
593
594 g_string_append(str, "]");
595
596 end:
597 return str;
598 }
599
600 static inline
601 const char *bt_common_logging_level_string(
602 enum bt_logging_level level)
603 {
604 switch (level) {
605 case BT_LOGGING_LEVEL_TRACE:
606 return "TRACE";
607 case BT_LOGGING_LEVEL_DEBUG:
608 return "DEBUG";
609 case BT_LOGGING_LEVEL_INFO:
610 return "INFO";
611 case BT_LOGGING_LEVEL_WARNING:
612 return "WARNING";
613 case BT_LOGGING_LEVEL_ERROR:
614 return "ERROR";
615 case BT_LOGGING_LEVEL_FATAL:
616 return "FATAL";
617 case BT_LOGGING_LEVEL_NONE:
618 return "NONE";
619 default:
620 return "(unknown)";
621 }
622 };
623
624 static inline
625 const char *bt_common_func_status_string(int status)
626 {
627 switch (status) {
628 case __BT_FUNC_STATUS_OVERFLOW_ERROR:
629 return "OVERFLOW";
630 case __BT_FUNC_STATUS_UNKNOWN_OBJECT:
631 return "UNKNOWN_OBJECT";
632 case __BT_FUNC_STATUS_MEMORY_ERROR:
633 return "MEMORY_ERROR";
634 case __BT_FUNC_STATUS_ERROR:
635 return "ERROR";
636 case __BT_FUNC_STATUS_OK:
637 return "OK";
638 case __BT_FUNC_STATUS_END:
639 return "END";
640 case __BT_FUNC_STATUS_NOT_FOUND:
641 return "NOT_FOUND";
642 case __BT_FUNC_STATUS_AGAIN:
643 return "AGAIN";
644 case __BT_FUNC_STATUS_INTERRUPTED:
645 return "INTERRUPTED";
646 default:
647 return "(unknown)";
648 }
649 }
650
651 #define NS_PER_S_I INT64_C(1000000000)
652 #define NS_PER_S_U UINT64_C(1000000000)
653
654 static inline
655 int bt_common_clock_value_from_ns_from_origin(
656 int64_t cc_offset_seconds, uint64_t cc_offset_cycles,
657 uint64_t cc_freq, int64_t ns_from_origin,
658 uint64_t *raw_value)
659 {
660 int ret = 0;
661 int64_t offset_in_ns;
662 uint64_t value_in_ns;
663 uint64_t rem_value_in_ns;
664 uint64_t value_periods;
665 uint64_t value_period_cycles;
666 int64_t ns_to_add;
667
668 BT_ASSERT(raw_value);
669
670 /* Compute offset part of requested value, in nanoseconds */
671 if (!bt_safe_to_mul_int64(cc_offset_seconds, NS_PER_S_I)) {
672 ret = -1;
673 goto end;
674 }
675
676 offset_in_ns = cc_offset_seconds * NS_PER_S_I;
677
678 if (cc_freq == NS_PER_S_U) {
679 ns_to_add = (int64_t) cc_offset_cycles;
680 } else {
681 if (!bt_safe_to_mul_int64((int64_t) cc_offset_cycles,
682 NS_PER_S_I)) {
683 ret = -1;
684 goto end;
685 }
686
687 ns_to_add = ((int64_t) cc_offset_cycles * NS_PER_S_I) /
688 (int64_t) cc_freq;
689 }
690
691 if (!bt_safe_to_add_int64(offset_in_ns, ns_to_add)) {
692 ret = -1;
693 goto end;
694 }
695
696 offset_in_ns += ns_to_add;
697
698 /* Value part in nanoseconds */
699 if (ns_from_origin < offset_in_ns) {
700 ret = -1;
701 goto end;
702 }
703
704 value_in_ns = (uint64_t) (ns_from_origin - offset_in_ns);
705
706 /* Number of whole clock periods in `value_in_ns` */
707 value_periods = value_in_ns / NS_PER_S_U;
708
709 /* Remaining nanoseconds in cycles + whole clock periods in cycles */
710 rem_value_in_ns = value_in_ns - value_periods * NS_PER_S_U;
711
712 if (value_periods > UINT64_MAX / cc_freq) {
713 ret = -1;
714 goto end;
715 }
716
717 if (!bt_safe_to_mul_uint64(value_periods, cc_freq)) {
718 ret = -1;
719 goto end;
720 }
721
722 value_period_cycles = value_periods * cc_freq;
723
724 if (!bt_safe_to_mul_uint64(cc_freq, rem_value_in_ns)) {
725 ret = -1;
726 goto end;
727 }
728
729 if (!bt_safe_to_add_uint64(cc_freq * rem_value_in_ns / NS_PER_S_U,
730 value_period_cycles)) {
731 ret = -1;
732 goto end;
733 }
734
735 *raw_value = cc_freq * rem_value_in_ns / NS_PER_S_U +
736 value_period_cycles;
737
738 end:
739 return ret;
740 }
741
742 /*
743 * bt_g_string_append_printf cannot be inlined because it expects a
744 * variadic argument list.
745 */
746 BT_HIDDEN
747 int bt_common_g_string_append_printf(GString *str, const char *fmt, ...);
748
749 static inline
750 void bt_common_g_string_append(GString *str, const char *s)
751 {
752 gsize len, allocated_len, s_len;
753
754 /* str->len excludes \0. */
755 len = str->len;
756 /* Exclude \0. */
757 allocated_len = str->allocated_len - 1;
758 s_len = strlen(s);
759 if (G_UNLIKELY(allocated_len < len + s_len)) {
760 /* Resize. */
761 g_string_set_size(str, len + s_len);
762 } else {
763 str->len = len + s_len;
764 }
765 memcpy(str->str + len, s, s_len + 1);
766 }
767
768 static inline
769 void bt_common_g_string_append_c(GString *str, char c)
770 {
771 gsize len, allocated_len, s_len;
772
773 /* str->len excludes \0. */
774 len = str->len;
775 /* Exclude \0. */
776 allocated_len = str->allocated_len - 1;
777 s_len = 1;
778 if (G_UNLIKELY(allocated_len < len + s_len)) {
779 /* Resize. */
780 g_string_set_size(str, len + s_len);
781 } else {
782 str->len = len + s_len;
783 }
784 str->str[len] = c;
785 str->str[len + 1] = '\0';
786 }
787
788 #endif /* BABELTRACE_COMMON_INTERNAL_H */
This page took 0.046753 seconds and 4 git commands to generate.