Commit | Line | Data |
---|---|---|
1670bffd PP |
1 | /* |
2 | * Babeltrace common functions | |
3 | * | |
4 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> | |
5 | * | |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
7 | * of this software and associated documentation files (the "Software"), to deal | |
8 | * in the Software without restriction, including without limitation the rights | |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
10 | * copies of the Software, and to permit persons to whom the Software is | |
11 | * furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in | |
14 | * all copies or substantial portions of the Software. | |
15 | * | |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
22 | * SOFTWARE. | |
23 | */ | |
24 | ||
86d8b7b8 | 25 | #define BT_LOG_OUTPUT_LEVEL log_level |
b4565e8b | 26 | #define BT_LOG_TAG "COMMON" |
86d8b7b8 | 27 | #include "logging/log.h" |
b4565e8b | 28 | |
290725f7 | 29 | #include <unistd.h> |
1670bffd | 30 | #include <string.h> |
85cd02cf | 31 | #include <inttypes.h> |
1670bffd | 32 | #include <sys/types.h> |
fcc7e8dd | 33 | #include <sys/stat.h> |
1670bffd | 34 | #include <unistd.h> |
578e048b | 35 | #include "common/assert.h" |
85cd02cf | 36 | #include <stdarg.h> |
db0f160a | 37 | #include <ctype.h> |
1670bffd | 38 | #include <glib.h> |
108e5a1e | 39 | #include <stdlib.h> |
85cd02cf PP |
40 | #include <stdio.h> |
41 | #include <wchar.h> | |
fcc7e8dd | 42 | #include <stdbool.h> |
91d81473 | 43 | #include "common/macros.h" |
578e048b MJ |
44 | #include "common/common.h" |
45 | #include "compat/unistd.h" | |
1670bffd | 46 | |
2006c005 MJ |
47 | #ifndef __MINGW32__ |
48 | #include <pwd.h> | |
2c4f022e | 49 | #include <sys/ioctl.h> |
2006c005 MJ |
50 | #endif |
51 | ||
056632bf | 52 | #define SYSTEM_PLUGIN_PATH BABELTRACE_PLUGINS_DIR |
1670bffd | 53 | #define HOME_ENV_VAR "HOME" |
d9676d8c | 54 | #define HOME_PLUGIN_SUBPATH "/.local/lib/babeltrace2/plugins" |
1670bffd | 55 | |
6c4a0731 PP |
56 | static const char *bt_common_color_code_reset = ""; |
57 | static const char *bt_common_color_code_bold = ""; | |
58 | static const char *bt_common_color_code_fg_default = ""; | |
59 | static const char *bt_common_color_code_fg_red = ""; | |
60 | static const char *bt_common_color_code_fg_green = ""; | |
61 | static const char *bt_common_color_code_fg_yellow = ""; | |
62 | static const char *bt_common_color_code_fg_blue = ""; | |
63 | static const char *bt_common_color_code_fg_magenta = ""; | |
64 | static const char *bt_common_color_code_fg_cyan = ""; | |
65 | static const char *bt_common_color_code_fg_light_gray = ""; | |
66 | static const char *bt_common_color_code_bg_default = ""; | |
67 | static const char *bt_common_color_code_bg_red = ""; | |
68 | static const char *bt_common_color_code_bg_green = ""; | |
69 | static const char *bt_common_color_code_bg_yellow = ""; | |
70 | static const char *bt_common_color_code_bg_blue = ""; | |
71 | static const char *bt_common_color_code_bg_magenta = ""; | |
72 | static const char *bt_common_color_code_bg_cyan = ""; | |
73 | static const char *bt_common_color_code_bg_light_gray = ""; | |
74 | ||
75 | static | |
76 | void __attribute__((constructor)) bt_common_color_ctor(void) | |
77 | { | |
78 | if (bt_common_colors_supported()) { | |
79 | bt_common_color_code_reset = BT_COMMON_COLOR_RESET; | |
80 | bt_common_color_code_bold = BT_COMMON_COLOR_BOLD; | |
81 | bt_common_color_code_fg_default = BT_COMMON_COLOR_FG_DEFAULT; | |
82 | bt_common_color_code_fg_red = BT_COMMON_COLOR_FG_RED; | |
83 | bt_common_color_code_fg_green = BT_COMMON_COLOR_FG_GREEN; | |
84 | bt_common_color_code_fg_yellow = BT_COMMON_COLOR_FG_YELLOW; | |
85 | bt_common_color_code_fg_blue = BT_COMMON_COLOR_FG_BLUE; | |
86 | bt_common_color_code_fg_magenta = BT_COMMON_COLOR_FG_MAGENTA; | |
87 | bt_common_color_code_fg_cyan = BT_COMMON_COLOR_FG_CYAN; | |
88 | bt_common_color_code_fg_light_gray = BT_COMMON_COLOR_FG_LIGHT_GRAY; | |
89 | bt_common_color_code_bg_default = BT_COMMON_COLOR_BG_DEFAULT; | |
90 | bt_common_color_code_bg_red = BT_COMMON_COLOR_BG_RED; | |
91 | bt_common_color_code_bg_green = BT_COMMON_COLOR_BG_GREEN; | |
92 | bt_common_color_code_bg_yellow = BT_COMMON_COLOR_BG_YELLOW; | |
93 | bt_common_color_code_bg_blue = BT_COMMON_COLOR_BG_BLUE; | |
94 | bt_common_color_code_bg_magenta = BT_COMMON_COLOR_BG_MAGENTA; | |
95 | bt_common_color_code_bg_cyan = BT_COMMON_COLOR_BG_CYAN; | |
96 | bt_common_color_code_bg_light_gray = BT_COMMON_COLOR_BG_LIGHT_GRAY; | |
97 | } | |
98 | } | |
99 | ||
1670bffd PP |
100 | BT_HIDDEN |
101 | const char *bt_common_get_system_plugin_path(void) | |
102 | { | |
103 | return SYSTEM_PLUGIN_PATH; | |
104 | } | |
105 | ||
a613ad68 MJ |
106 | #ifdef __MINGW32__ |
107 | BT_HIDDEN | |
108 | bool bt_common_is_setuid_setgid(void) | |
109 | { | |
110 | return false; | |
111 | } | |
112 | #else /* __MINGW32__ */ | |
1670bffd PP |
113 | BT_HIDDEN |
114 | bool bt_common_is_setuid_setgid(void) | |
115 | { | |
116 | return (geteuid() != getuid() || getegid() != getgid()); | |
117 | } | |
a613ad68 | 118 | #endif /* __MINGW32__ */ |
1670bffd | 119 | |
3a5e626b MJ |
120 | #ifdef __MINGW32__ |
121 | static | |
122 | const char *bt_get_home_dir(int log_level) | |
123 | { | |
124 | return g_get_home_dir(); | |
125 | } | |
126 | #else /* __MINGW32__ */ | |
2006c005 | 127 | static |
86d8b7b8 | 128 | char *bt_secure_getenv(const char *name, int log_level) |
1670bffd PP |
129 | { |
130 | if (bt_common_is_setuid_setgid()) { | |
b4565e8b PP |
131 | BT_LOGD("Disregarding environment variable for setuid/setgid binary: " |
132 | "name=\"%s\"", name); | |
1670bffd PP |
133 | return NULL; |
134 | } | |
135 | return getenv(name); | |
136 | } | |
137 | ||
2006c005 | 138 | static |
86d8b7b8 | 139 | const char *bt_get_home_dir(int log_level) |
1670bffd PP |
140 | { |
141 | char *val = NULL; | |
142 | struct passwd *pwd; | |
143 | ||
86d8b7b8 | 144 | val = bt_secure_getenv(HOME_ENV_VAR, log_level); |
1670bffd PP |
145 | if (val) { |
146 | goto end; | |
147 | } | |
148 | /* Fallback on password file. */ | |
149 | pwd = getpwuid(getuid()); | |
150 | if (!pwd) { | |
151 | goto end; | |
152 | } | |
153 | val = pwd->pw_dir; | |
154 | end: | |
155 | return val; | |
156 | } | |
2006c005 | 157 | #endif /* __MINGW32__ */ |
1670bffd PP |
158 | |
159 | BT_HIDDEN | |
86d8b7b8 | 160 | char *bt_common_get_home_plugin_path(int log_level) |
1670bffd PP |
161 | { |
162 | char *path = NULL; | |
163 | const char *home_dir; | |
b4565e8b | 164 | size_t length; |
1670bffd | 165 | |
86d8b7b8 | 166 | home_dir = bt_get_home_dir(log_level); |
1670bffd PP |
167 | if (!home_dir) { |
168 | goto end; | |
169 | } | |
170 | ||
b4565e8b PP |
171 | length = strlen(home_dir) + strlen(HOME_PLUGIN_SUBPATH) + 1; |
172 | ||
173 | if (length >= PATH_MAX) { | |
3f7d4d90 PP |
174 | BT_LOGW("Home directory path is too long: " |
175 | "length=%zu, max-length=%u", length, PATH_MAX); | |
1670bffd PP |
176 | goto end; |
177 | } | |
178 | ||
179 | path = malloc(PATH_MAX); | |
180 | if (!path) { | |
181 | goto end; | |
182 | } | |
183 | ||
184 | strcpy(path, home_dir); | |
185 | strcat(path, HOME_PLUGIN_SUBPATH); | |
186 | ||
187 | end: | |
188 | return path; | |
189 | } | |
190 | ||
191 | BT_HIDDEN | |
192 | int bt_common_append_plugin_path_dirs(const char *paths, GPtrArray *dirs) | |
193 | { | |
194 | int ret = 0; | |
195 | const char *at; | |
196 | const char *end; | |
197 | size_t init_dirs_len; | |
198 | ||
f6ccaed9 | 199 | BT_ASSERT(dirs); |
1670bffd PP |
200 | init_dirs_len = dirs->len; |
201 | ||
202 | if (!paths) { | |
203 | /* Nothing to append */ | |
204 | goto end; | |
205 | } | |
206 | ||
207 | at = paths; | |
208 | end = paths + strlen(paths); | |
209 | ||
210 | while (at < end) { | |
211 | GString *path; | |
52238017 | 212 | const char *next_sep; |
1670bffd | 213 | |
52238017 MJ |
214 | next_sep = strchr(at, G_SEARCHPATH_SEPARATOR); |
215 | if (next_sep == at) { | |
1670bffd PP |
216 | /* |
217 | * Empty path: try next character (supported | |
218 | * to conform to the typical parsing of $PATH). | |
219 | */ | |
220 | at++; | |
221 | continue; | |
52238017 MJ |
222 | } else if (!next_sep) { |
223 | /* No more separator: use the remaining */ | |
224 | next_sep = paths + strlen(paths); | |
1670bffd PP |
225 | } |
226 | ||
227 | path = g_string_new(NULL); | |
228 | if (!path) { | |
229 | goto error; | |
230 | } | |
231 | ||
52238017 MJ |
232 | g_string_append_len(path, at, next_sep - at); |
233 | at = next_sep + 1; | |
1670bffd PP |
234 | g_ptr_array_add(dirs, path); |
235 | } | |
236 | ||
237 | goto end; | |
238 | ||
239 | error: | |
240 | ret = -1; | |
241 | ||
242 | /* Remove the new entries in dirs */ | |
243 | while (dirs->len > init_dirs_len) { | |
244 | g_ptr_array_remove_index(dirs, init_dirs_len); | |
245 | } | |
246 | ||
247 | end: | |
248 | return ret; | |
249 | } | |
290725f7 | 250 | |
fcc7e8dd PP |
251 | static |
252 | bool isarealtty(int fd) | |
253 | { | |
254 | bool istty = false; | |
255 | struct stat tty_stats; | |
256 | ||
257 | if (!isatty(fd)) { | |
258 | /* Not a TTY */ | |
259 | goto end; | |
260 | } | |
261 | ||
262 | if (fstat(fd, &tty_stats) == 0) { | |
263 | if (!S_ISCHR(tty_stats.st_mode)) { | |
264 | /* Not a character device: not a TTY */ | |
265 | goto end; | |
266 | } | |
267 | } | |
268 | ||
269 | istty = true; | |
270 | ||
271 | end: | |
272 | return istty; | |
273 | } | |
274 | ||
ad96d936 PP |
275 | BT_HIDDEN |
276 | bool bt_common_colors_supported(void) | |
290725f7 PP |
277 | { |
278 | static bool supports_colors = false; | |
279 | static bool supports_colors_set = false; | |
fcc7e8dd PP |
280 | const char *term_env_var; |
281 | const char *term_color_env_var; | |
290725f7 PP |
282 | |
283 | if (supports_colors_set) { | |
284 | goto end; | |
285 | } | |
286 | ||
287 | supports_colors_set = true; | |
288 | ||
fcc7e8dd PP |
289 | /* |
290 | * `BABELTRACE_TERM_COLOR` environment variable always overrides | |
291 | * the automatic color support detection. | |
292 | */ | |
293 | term_color_env_var = getenv("BABELTRACE_TERM_COLOR"); | |
294 | if (term_color_env_var) { | |
295 | if (g_ascii_strcasecmp(term_color_env_var, "always") == 0) { | |
296 | /* Force colors */ | |
297 | supports_colors = true; | |
298 | } else if (g_ascii_strcasecmp(term_color_env_var, "never") == 0) { | |
299 | /* Force no colors */ | |
300 | goto end; | |
301 | } | |
62128320 PP |
302 | } |
303 | ||
fcc7e8dd PP |
304 | /* We need a compatible, known terminal */ |
305 | term_env_var = getenv("TERM"); | |
306 | if (!term_env_var) { | |
290725f7 PP |
307 | goto end; |
308 | } | |
309 | ||
fcc7e8dd PP |
310 | if (strncmp(term_env_var, "xterm", 5) != 0 && |
311 | strncmp(term_env_var, "rxvt", 4) != 0 && | |
312 | strncmp(term_env_var, "konsole", 7) != 0 && | |
313 | strncmp(term_env_var, "gnome", 5) != 0 && | |
314 | strncmp(term_env_var, "screen", 5) != 0 && | |
315 | strncmp(term_env_var, "tmux", 4) != 0 && | |
316 | strncmp(term_env_var, "putty", 5) != 0) { | |
290725f7 PP |
317 | goto end; |
318 | } | |
319 | ||
fcc7e8dd PP |
320 | /* Both standard output and error streams need to be TTYs */ |
321 | if (!isarealtty(STDOUT_FILENO) || !isarealtty(STDERR_FILENO)) { | |
290725f7 PP |
322 | goto end; |
323 | } | |
324 | ||
325 | supports_colors = true; | |
326 | ||
327 | end: | |
328 | return supports_colors; | |
329 | } | |
330 | ||
331 | BT_HIDDEN | |
332 | const char *bt_common_color_reset(void) | |
333 | { | |
6c4a0731 | 334 | return bt_common_color_code_reset; |
290725f7 PP |
335 | } |
336 | ||
337 | BT_HIDDEN | |
338 | const char *bt_common_color_bold(void) | |
339 | { | |
6c4a0731 | 340 | return bt_common_color_code_bold; |
290725f7 PP |
341 | } |
342 | ||
343 | BT_HIDDEN | |
344 | const char *bt_common_color_fg_default(void) | |
345 | { | |
6c4a0731 | 346 | return bt_common_color_code_fg_default; |
290725f7 PP |
347 | } |
348 | ||
349 | BT_HIDDEN | |
350 | const char *bt_common_color_fg_red(void) | |
351 | { | |
6c4a0731 | 352 | return bt_common_color_code_fg_red; |
290725f7 PP |
353 | } |
354 | ||
355 | BT_HIDDEN | |
356 | const char *bt_common_color_fg_green(void) | |
357 | { | |
6c4a0731 | 358 | return bt_common_color_code_fg_green; |
290725f7 PP |
359 | } |
360 | ||
361 | BT_HIDDEN | |
362 | const char *bt_common_color_fg_yellow(void) | |
363 | { | |
6c4a0731 | 364 | return bt_common_color_code_fg_yellow; |
290725f7 PP |
365 | } |
366 | ||
367 | BT_HIDDEN | |
368 | const char *bt_common_color_fg_blue(void) | |
369 | { | |
6c4a0731 | 370 | return bt_common_color_code_fg_blue; |
290725f7 PP |
371 | } |
372 | ||
373 | BT_HIDDEN | |
374 | const char *bt_common_color_fg_magenta(void) | |
375 | { | |
6c4a0731 | 376 | return bt_common_color_code_fg_magenta; |
290725f7 PP |
377 | } |
378 | ||
379 | BT_HIDDEN | |
380 | const char *bt_common_color_fg_cyan(void) | |
381 | { | |
6c4a0731 | 382 | return bt_common_color_code_fg_cyan; |
290725f7 PP |
383 | } |
384 | ||
385 | BT_HIDDEN | |
386 | const char *bt_common_color_fg_light_gray(void) | |
387 | { | |
6c4a0731 | 388 | return bt_common_color_code_fg_light_gray; |
290725f7 PP |
389 | } |
390 | ||
391 | BT_HIDDEN | |
392 | const char *bt_common_color_bg_default(void) | |
393 | { | |
6c4a0731 | 394 | return bt_common_color_code_bg_default; |
290725f7 PP |
395 | } |
396 | ||
397 | BT_HIDDEN | |
398 | const char *bt_common_color_bg_red(void) | |
399 | { | |
6c4a0731 | 400 | return bt_common_color_code_bg_red; |
290725f7 PP |
401 | } |
402 | ||
403 | BT_HIDDEN | |
404 | const char *bt_common_color_bg_green(void) | |
405 | { | |
6c4a0731 | 406 | return bt_common_color_code_bg_green; |
290725f7 PP |
407 | } |
408 | ||
409 | BT_HIDDEN | |
410 | const char *bt_common_color_bg_yellow(void) | |
411 | { | |
6c4a0731 | 412 | return bt_common_color_code_bg_yellow; |
290725f7 PP |
413 | } |
414 | ||
415 | BT_HIDDEN | |
416 | const char *bt_common_color_bg_blue(void) | |
417 | { | |
6c4a0731 | 418 | return bt_common_color_code_bg_blue; |
290725f7 PP |
419 | } |
420 | ||
421 | BT_HIDDEN | |
422 | const char *bt_common_color_bg_magenta(void) | |
423 | { | |
6c4a0731 | 424 | return bt_common_color_code_bg_magenta; |
290725f7 PP |
425 | } |
426 | ||
427 | BT_HIDDEN | |
428 | const char *bt_common_color_bg_cyan(void) | |
429 | { | |
6c4a0731 | 430 | return bt_common_color_code_bg_cyan; |
290725f7 PP |
431 | } |
432 | ||
433 | BT_HIDDEN | |
434 | const char *bt_common_color_bg_light_gray(void) | |
435 | { | |
6c4a0731 | 436 | return bt_common_color_code_bg_light_gray; |
290725f7 | 437 | } |
db0f160a PP |
438 | |
439 | BT_HIDDEN | |
440 | GString *bt_common_string_until(const char *input, const char *escapable_chars, | |
441 | const char *end_chars, size_t *end_pos) | |
442 | { | |
443 | GString *output = g_string_new(NULL); | |
444 | const char *ch; | |
445 | const char *es_char; | |
446 | const char *end_char; | |
447 | ||
448 | if (!output) { | |
449 | goto error; | |
450 | } | |
451 | ||
452 | for (ch = input; *ch != '\0'; ch++) { | |
453 | if (*ch == '\\') { | |
454 | bool continue_loop = false; | |
455 | ||
456 | if (ch[1] == '\0') { | |
457 | /* `\` at the end of the string: append `\` */ | |
458 | g_string_append_c(output, *ch); | |
459 | ch++; | |
460 | goto set_end_pos; | |
461 | } | |
462 | ||
463 | for (es_char = escapable_chars; *es_char != '\0'; es_char++) { | |
464 | if (ch[1] == *es_char) { | |
465 | /* | |
466 | * `\` followed by an escapable | |
467 | * character: append the escaped | |
468 | * character only. | |
469 | */ | |
470 | g_string_append_c(output, ch[1]); | |
471 | ch++; | |
472 | continue_loop = true; | |
473 | break; | |
474 | } | |
475 | } | |
476 | ||
477 | if (continue_loop) { | |
478 | continue; | |
479 | } | |
480 | ||
481 | /* | |
482 | * `\` followed by a non-escapable character: | |
483 | * append `\` and the character. | |
484 | */ | |
485 | g_string_append_c(output, *ch); | |
486 | g_string_append_c(output, ch[1]); | |
487 | ch++; | |
488 | continue; | |
489 | } else { | |
490 | for (end_char = end_chars; *end_char != '\0'; end_char++) { | |
491 | if (*ch == *end_char) { | |
492 | /* | |
493 | * End character found: | |
494 | * terminate this loop. | |
495 | */ | |
496 | goto set_end_pos; | |
497 | } | |
498 | } | |
499 | ||
500 | /* Normal character: append */ | |
501 | g_string_append_c(output, *ch); | |
502 | } | |
503 | } | |
504 | ||
505 | set_end_pos: | |
506 | if (end_pos) { | |
507 | *end_pos = ch - input; | |
508 | } | |
509 | ||
510 | goto end; | |
511 | ||
512 | error: | |
513 | if (output) { | |
514 | g_string_free(output, TRUE); | |
515 | } | |
516 | ||
517 | end: | |
518 | return output; | |
519 | } | |
520 | ||
521 | BT_HIDDEN | |
36b405c6 | 522 | GString *bt_common_shell_quote(const char *input, bool with_single_quotes) |
db0f160a PP |
523 | { |
524 | GString *output = g_string_new(NULL); | |
525 | const char *ch; | |
526 | bool no_quote = true; | |
527 | ||
528 | if (!output) { | |
529 | goto end; | |
530 | } | |
531 | ||
532 | if (strlen(input) == 0) { | |
36b405c6 PP |
533 | if (with_single_quotes) { |
534 | g_string_assign(output, "''"); | |
535 | } | |
536 | ||
db0f160a PP |
537 | goto end; |
538 | } | |
539 | ||
540 | for (ch = input; *ch != '\0'; ch++) { | |
541 | const char c = *ch; | |
542 | ||
543 | if (!g_ascii_isalpha(c) && !g_ascii_isdigit(c) && c != '_' && | |
544 | c != '@' && c != '%' && c != '+' && c != '=' && | |
545 | c != ':' && c != ',' && c != '.' && c != '/' && | |
546 | c != '-') { | |
547 | no_quote = false; | |
548 | break; | |
549 | } | |
550 | } | |
551 | ||
552 | if (no_quote) { | |
553 | g_string_assign(output, input); | |
554 | goto end; | |
555 | } | |
556 | ||
36b405c6 PP |
557 | if (with_single_quotes) { |
558 | g_string_assign(output, "'"); | |
559 | } | |
db0f160a PP |
560 | |
561 | for (ch = input; *ch != '\0'; ch++) { | |
562 | if (*ch == '\'') { | |
563 | g_string_append(output, "'\"'\"'"); | |
564 | } else { | |
565 | g_string_append_c(output, *ch); | |
566 | } | |
567 | } | |
568 | ||
36b405c6 PP |
569 | if (with_single_quotes) { |
570 | g_string_append_c(output, '\''); | |
571 | } | |
db0f160a PP |
572 | |
573 | end: | |
574 | return output; | |
575 | } | |
576 | ||
577 | BT_HIDDEN | |
578 | bool bt_common_string_is_printable(const char *input) | |
579 | { | |
580 | const char *ch; | |
581 | bool printable = true; | |
f6ccaed9 | 582 | BT_ASSERT(input); |
db0f160a PP |
583 | |
584 | for (ch = input; *ch != '\0'; ch++) { | |
585 | if (!isprint(*ch) && *ch != '\n' && *ch != '\r' && | |
586 | *ch != '\t' && *ch != '\v') { | |
587 | printable = false; | |
588 | goto end; | |
589 | } | |
590 | } | |
591 | ||
592 | end: | |
593 | return printable; | |
594 | } | |
595 | ||
596 | BT_HIDDEN | |
597 | void bt_common_destroy_lttng_live_url_parts( | |
598 | struct bt_common_lttng_live_url_parts *parts) | |
599 | { | |
600 | if (!parts) { | |
601 | goto end; | |
602 | } | |
603 | ||
604 | if (parts->proto) { | |
605 | g_string_free(parts->proto, TRUE); | |
606 | parts->proto = NULL; | |
607 | } | |
608 | ||
609 | if (parts->hostname) { | |
610 | g_string_free(parts->hostname, TRUE); | |
611 | parts->hostname = NULL; | |
612 | } | |
613 | ||
614 | if (parts->target_hostname) { | |
615 | g_string_free(parts->target_hostname, TRUE); | |
616 | parts->target_hostname = NULL; | |
617 | } | |
618 | ||
619 | if (parts->session_name) { | |
620 | g_string_free(parts->session_name, TRUE); | |
621 | parts->session_name = NULL; | |
622 | } | |
623 | ||
624 | end: | |
625 | return; | |
626 | } | |
627 | ||
628 | BT_HIDDEN | |
629 | struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url( | |
630 | const char *url, char *error_buf, size_t error_buf_size) | |
631 | { | |
632 | struct bt_common_lttng_live_url_parts parts; | |
633 | const char *at = url; | |
634 | size_t end_pos; | |
635 | ||
f6ccaed9 | 636 | BT_ASSERT(url); |
db0f160a PP |
637 | memset(&parts, 0, sizeof(parts)); |
638 | parts.port = -1; | |
639 | ||
640 | /* Protocol */ | |
641 | parts.proto = bt_common_string_until(at, "", ":", &end_pos); | |
642 | if (!parts.proto || parts.proto->len == 0) { | |
643 | if (error_buf) { | |
644 | snprintf(error_buf, error_buf_size, "Missing protocol"); | |
645 | } | |
646 | ||
647 | goto error; | |
648 | } | |
649 | ||
650 | if (strcmp(parts.proto->str, "net") == 0) { | |
651 | g_string_assign(parts.proto, "net4"); | |
652 | } | |
653 | ||
654 | if (strcmp(parts.proto->str, "net4") != 0 && | |
655 | strcmp(parts.proto->str, "net6") != 0) { | |
656 | if (error_buf) { | |
657 | snprintf(error_buf, error_buf_size, | |
658 | "Unknown protocol: `%s`", parts.proto->str); | |
659 | } | |
660 | ||
661 | goto error; | |
662 | } | |
663 | ||
664 | if (at[end_pos] != ':') { | |
665 | if (error_buf) { | |
666 | snprintf(error_buf, error_buf_size, | |
667 | "Expecting `:` after `%s`", parts.proto->str); | |
668 | } | |
669 | ||
670 | goto error; | |
671 | } | |
672 | ||
673 | at += end_pos; | |
674 | ||
675 | /* :// */ | |
676 | if (strncmp(at, "://", 3) != 0) { | |
677 | if (error_buf) { | |
678 | snprintf(error_buf, error_buf_size, | |
679 | "Expecting `://` after protocol"); | |
680 | } | |
681 | ||
682 | goto error; | |
683 | } | |
684 | ||
685 | at += 3; | |
686 | ||
687 | /* Hostname */ | |
688 | parts.hostname = bt_common_string_until(at, "", ":/", &end_pos); | |
689 | if (!parts.hostname || parts.hostname->len == 0) { | |
690 | if (error_buf) { | |
691 | snprintf(error_buf, error_buf_size, "Missing hostname"); | |
692 | } | |
693 | ||
694 | goto error; | |
695 | } | |
696 | ||
697 | if (at[end_pos] == ':') { | |
698 | /* Port */ | |
699 | GString *port; | |
700 | ||
701 | at += end_pos + 1; | |
702 | port = bt_common_string_until(at, "", "/", &end_pos); | |
703 | if (!port || port->len == 0) { | |
704 | if (error_buf) { | |
705 | snprintf(error_buf, error_buf_size, "Missing port"); | |
706 | } | |
707 | ||
708 | goto error; | |
709 | } | |
710 | ||
711 | if (sscanf(port->str, "%d", &parts.port) != 1) { | |
712 | if (error_buf) { | |
713 | snprintf(error_buf, error_buf_size, | |
714 | "Invalid port: `%s`", port->str); | |
715 | } | |
716 | ||
717 | g_string_free(port, TRUE); | |
718 | goto error; | |
719 | } | |
720 | ||
721 | g_string_free(port, TRUE); | |
722 | ||
723 | if (parts.port < 0 || parts.port >= 65536) { | |
724 | if (error_buf) { | |
725 | snprintf(error_buf, error_buf_size, | |
726 | "Invalid port: %d", parts.port); | |
727 | } | |
728 | ||
729 | goto error; | |
730 | } | |
731 | } | |
732 | ||
733 | if (at[end_pos] == '\0') { | |
734 | goto end; | |
735 | } | |
736 | ||
737 | at += end_pos; | |
738 | ||
739 | /* /host/ */ | |
740 | if (strncmp(at, "/host/", 6) != 0) { | |
741 | if (error_buf) { | |
742 | snprintf(error_buf, error_buf_size, | |
743 | "Expecting `/host/` after hostname or port"); | |
744 | } | |
745 | ||
746 | goto error; | |
747 | } | |
748 | ||
749 | at += 6; | |
750 | ||
751 | /* Target hostname */ | |
752 | parts.target_hostname = bt_common_string_until(at, "", "/", &end_pos); | |
753 | if (!parts.target_hostname || parts.target_hostname->len == 0) { | |
754 | if (error_buf) { | |
755 | snprintf(error_buf, error_buf_size, | |
756 | "Missing target hostname"); | |
757 | } | |
758 | ||
759 | goto error; | |
760 | } | |
761 | ||
762 | if (at[end_pos] == '\0') { | |
763 | goto end; | |
764 | } | |
765 | ||
766 | at += end_pos + 1; | |
767 | ||
768 | /* Session name */ | |
769 | parts.session_name = bt_common_string_until(at, "", "/", &end_pos); | |
770 | if (!parts.session_name || parts.session_name->len == 0) { | |
771 | if (error_buf) { | |
772 | snprintf(error_buf, error_buf_size, | |
773 | "Missing session name"); | |
774 | } | |
775 | ||
776 | goto error; | |
777 | } | |
778 | ||
779 | if (at[end_pos] == '/') { | |
780 | if (error_buf) { | |
781 | snprintf(error_buf, error_buf_size, | |
782 | "Unexpected `/` after session name (`%s`)", | |
783 | parts.session_name->str); | |
784 | } | |
785 | ||
786 | goto error; | |
787 | } | |
788 | ||
789 | goto end; | |
790 | ||
791 | error: | |
792 | bt_common_destroy_lttng_live_url_parts(&parts); | |
793 | ||
794 | end: | |
795 | return parts; | |
796 | } | |
9009cc24 PP |
797 | |
798 | BT_HIDDEN | |
799 | void bt_common_normalize_star_glob_pattern(char *pattern) | |
800 | { | |
801 | const char *p; | |
802 | char *np; | |
803 | bool got_star = false; | |
804 | ||
f6ccaed9 | 805 | BT_ASSERT(pattern); |
9009cc24 PP |
806 | |
807 | for (p = pattern, np = pattern; *p != '\0'; p++) { | |
808 | switch (*p) { | |
809 | case '*': | |
810 | if (got_star) { | |
811 | /* Avoid consecutive stars. */ | |
812 | continue; | |
813 | } | |
814 | ||
815 | got_star = true; | |
816 | break; | |
817 | case '\\': | |
818 | /* Copy backslash character. */ | |
819 | *np = *p; | |
820 | np++; | |
821 | p++; | |
822 | ||
823 | if (*p == '\0') { | |
824 | goto end; | |
825 | } | |
826 | ||
2f69c7e7 | 827 | /* fall-through */ |
9009cc24 PP |
828 | default: |
829 | got_star = false; | |
830 | break; | |
831 | } | |
832 | ||
833 | /* Copy single character. */ | |
834 | *np = *p; | |
835 | np++; | |
836 | } | |
837 | ||
838 | end: | |
839 | *np = '\0'; | |
840 | } | |
841 | ||
842 | static inline | |
843 | bool at_end_of_pattern(const char *p, const char *pattern, size_t pattern_len) | |
844 | { | |
845 | return (p - pattern) == pattern_len || *p == '\0'; | |
846 | } | |
847 | ||
848 | /* | |
849 | * Globbing matching function with the star feature only (`?` and | |
850 | * character sets are not supported). This matches `candidate` (plain | |
851 | * string) against `pattern`. A literal star can be escaped with `\` in | |
852 | * `pattern`. | |
853 | * | |
854 | * `pattern_len` or `candidate_len` can be greater than the actual | |
855 | * string length of `pattern` or `candidate` if the string is | |
856 | * null-terminated. | |
857 | */ | |
858 | BT_HIDDEN | |
859 | bool bt_common_star_glob_match(const char *pattern, size_t pattern_len, | |
860 | const char *candidate, size_t candidate_len) { | |
861 | const char *retry_c = candidate, *retry_p = pattern, *c, *p; | |
862 | bool got_a_star = false; | |
863 | ||
864 | retry: | |
865 | c = retry_c; | |
866 | p = retry_p; | |
867 | ||
868 | /* | |
869 | * The concept here is to retry a match in the specific case | |
870 | * where we already got a star. The retry position for the | |
871 | * pattern is just after the most recent star, and the retry | |
872 | * position for the candidate is the character following the | |
873 | * last try's first character. | |
874 | * | |
875 | * Example: | |
876 | * | |
877 | * candidate: hi ev every onyx one | |
878 | * ^ | |
879 | * pattern: hi*every*one | |
880 | * ^ | |
881 | * | |
882 | * candidate: hi ev every onyx one | |
883 | * ^ | |
884 | * pattern: hi*every*one | |
885 | * ^ | |
886 | * | |
887 | * candidate: hi ev every onyx one | |
888 | * ^ | |
889 | * pattern: hi*every*one | |
890 | * ^ | |
891 | * | |
892 | * candidate: hi ev every onyx one | |
893 | * ^ | |
894 | * pattern: hi*every*one | |
895 | * ^ MISMATCH | |
896 | * | |
897 | * candidate: hi ev every onyx one | |
898 | * ^ | |
899 | * pattern: hi*every*one | |
900 | * ^ | |
901 | * | |
902 | * candidate: hi ev every onyx one | |
903 | * ^^ | |
904 | * pattern: hi*every*one | |
905 | * ^^ | |
906 | * | |
907 | * candidate: hi ev every onyx one | |
908 | * ^ ^ | |
909 | * pattern: hi*every*one | |
910 | * ^ ^ MISMATCH | |
911 | * | |
912 | * candidate: hi ev every onyx one | |
913 | * ^ | |
914 | * pattern: hi*every*one | |
915 | * ^ MISMATCH | |
916 | * | |
917 | * candidate: hi ev every onyx one | |
918 | * ^ | |
919 | * pattern: hi*every*one | |
920 | * ^ MISMATCH | |
921 | * | |
922 | * candidate: hi ev every onyx one | |
923 | * ^ | |
924 | * pattern: hi*every*one | |
925 | * ^ | |
926 | * | |
927 | * candidate: hi ev every onyx one | |
928 | * ^^ | |
929 | * pattern: hi*every*one | |
930 | * ^^ | |
931 | * | |
932 | * candidate: hi ev every onyx one | |
933 | * ^ ^ | |
934 | * pattern: hi*every*one | |
935 | * ^ ^ | |
936 | * | |
937 | * candidate: hi ev every onyx one | |
938 | * ^ ^ | |
939 | * pattern: hi*every*one | |
940 | * ^ ^ | |
941 | * | |
942 | * candidate: hi ev every onyx one | |
943 | * ^ ^ | |
944 | * pattern: hi*every*one | |
945 | * ^ ^ | |
946 | * | |
947 | * candidate: hi ev every onyx one | |
948 | * ^ | |
949 | * pattern: hi*every*one | |
950 | * ^ | |
951 | * | |
952 | * candidate: hi ev every onyx one | |
953 | * ^ | |
954 | * pattern: hi*every*one | |
955 | * ^ MISMATCH | |
956 | * | |
957 | * candidate: hi ev every onyx one | |
958 | * ^ | |
959 | * pattern: hi*every*one | |
960 | * ^ | |
961 | * | |
962 | * candidate: hi ev every onyx one | |
963 | * ^^ | |
964 | * pattern: hi*every*one | |
965 | * ^^ | |
966 | * | |
967 | * candidate: hi ev every onyx one | |
968 | * ^ ^ | |
969 | * pattern: hi*every*one | |
970 | * ^ ^ MISMATCH | |
971 | * | |
972 | * candidate: hi ev every onyx one | |
973 | * ^ | |
974 | * pattern: hi*every*one | |
975 | * ^ MISMATCH | |
976 | * | |
977 | * candidate: hi ev every onyx one | |
978 | * ^ | |
979 | * pattern: hi*every*one | |
980 | * ^ MISMATCH | |
981 | * | |
982 | * candidate: hi ev every onyx one | |
983 | * ^ | |
984 | * pattern: hi*every*one | |
985 | * ^ MISMATCH | |
986 | * | |
987 | * candidate: hi ev every onyx one | |
988 | * ^ | |
989 | * pattern: hi*every*one | |
990 | * ^ MISMATCH | |
991 | * | |
992 | * candidate: hi ev every onyx one | |
993 | * ^ | |
994 | * pattern: hi*every*one | |
995 | * ^ | |
996 | * | |
997 | * candidate: hi ev every onyx one | |
998 | * ^^ | |
999 | * pattern: hi*every*one | |
1000 | * ^^ | |
1001 | * | |
1002 | * candidate: hi ev every onyx one | |
1003 | * ^ ^ | |
1004 | * pattern: hi*every*one | |
1005 | * ^ ^ | |
1006 | * | |
1007 | * candidate: hi ev every onyx one | |
1008 | * ^ ^ | |
1009 | * pattern: hi*every*one | |
1010 | * ^ ^ SUCCESS | |
1011 | */ | |
1012 | while ((c - candidate) < candidate_len && *c != '\0') { | |
f6ccaed9 | 1013 | BT_ASSERT(*c); |
9009cc24 PP |
1014 | |
1015 | if (at_end_of_pattern(p, pattern, pattern_len)) { | |
1016 | goto end_of_pattern; | |
1017 | } | |
1018 | ||
1019 | switch (*p) { | |
1020 | case '*': | |
1021 | got_a_star = true; | |
1022 | ||
1023 | /* | |
1024 | * Our first try starts at the current candidate | |
1025 | * character and after the star in the pattern. | |
1026 | */ | |
1027 | retry_c = c; | |
1028 | retry_p = p + 1; | |
1029 | ||
1030 | if (at_end_of_pattern(retry_p, pattern, pattern_len)) { | |
1031 | /* | |
1032 | * Star at the end of the pattern at | |
1033 | * this point: automatic match. | |
1034 | */ | |
1035 | return true; | |
1036 | } | |
1037 | ||
1038 | goto retry; | |
1039 | case '\\': | |
1040 | /* Go to escaped character. */ | |
1041 | p++; | |
1042 | ||
1043 | /* | |
1044 | * Fall through the default case which compares | |
1045 | * the escaped character now. | |
1046 | */ | |
2f69c7e7 | 1047 | /* fall-through */ |
9009cc24 PP |
1048 | default: |
1049 | if (at_end_of_pattern(p, pattern, pattern_len) || | |
1050 | *c != *p) { | |
1051 | end_of_pattern: | |
1052 | /* Character mismatch OR end of pattern. */ | |
1053 | if (!got_a_star) { | |
1054 | /* | |
1055 | * We didn't get any star yet, | |
1056 | * so this first mismatch | |
1057 | * automatically makes the whole | |
1058 | * test fail. | |
1059 | */ | |
1060 | return false; | |
1061 | } | |
1062 | ||
1063 | /* | |
1064 | * Next try: next candidate character, | |
1065 | * original pattern character (following | |
1066 | * the most recent star). | |
1067 | */ | |
1068 | retry_c++; | |
1069 | goto retry; | |
1070 | } | |
1071 | break; | |
1072 | } | |
1073 | ||
1074 | /* Next pattern and candidate characters. */ | |
1075 | c++; | |
1076 | p++; | |
1077 | } | |
1078 | ||
1079 | /* | |
1080 | * We checked every candidate character and we're still in a | |
1081 | * success state: the only pattern character allowed to remain | |
1082 | * is a star. | |
1083 | */ | |
1084 | if (at_end_of_pattern(p, pattern, pattern_len)) { | |
1085 | return true; | |
1086 | } | |
1087 | ||
1088 | p++; | |
1089 | return p[-1] == '*' && at_end_of_pattern(p, pattern, pattern_len); | |
1090 | } | |
e49a18d1 | 1091 | |
3a5e626b MJ |
1092 | #ifdef __MINGW32__ |
1093 | BT_HIDDEN | |
1094 | GString *bt_common_normalize_path(const char *path, const char *wd) | |
1095 | { | |
1096 | char *tmp; | |
1097 | GString *norm_path = NULL; | |
1098 | ||
1099 | BT_ASSERT(path); | |
1100 | ||
1101 | tmp = _fullpath(NULL, path, PATH_MAX); | |
1102 | if (!tmp) { | |
1103 | goto error; | |
1104 | } | |
1105 | ||
1106 | norm_path = g_string_new(tmp); | |
1107 | if (!norm_path) { | |
1108 | goto error; | |
1109 | } | |
1110 | ||
1111 | goto end; | |
1112 | error: | |
1113 | if (norm_path) { | |
1114 | g_string_free(norm_path, TRUE); | |
1115 | norm_path = NULL; | |
1116 | } | |
1117 | end: | |
6b934a94 | 1118 | free(tmp); |
3a5e626b MJ |
1119 | return norm_path; |
1120 | } | |
1121 | #else | |
e49a18d1 PP |
1122 | static |
1123 | void append_path_parts(const char *path, GPtrArray *parts) | |
1124 | { | |
1125 | const char *ch = path; | |
1126 | const char *last = path; | |
1127 | ||
1128 | while (true) { | |
1129 | if (*ch == G_DIR_SEPARATOR || *ch == '\0') { | |
1130 | if (ch - last > 0) { | |
1131 | GString *part = g_string_new(NULL); | |
1132 | ||
f6ccaed9 | 1133 | BT_ASSERT(part); |
e49a18d1 PP |
1134 | g_string_append_len(part, last, ch - last); |
1135 | g_ptr_array_add(parts, part); | |
1136 | } | |
1137 | ||
1138 | if (*ch == '\0') { | |
1139 | break; | |
1140 | } | |
1141 | ||
1142 | last = ch + 1; | |
1143 | } | |
1144 | ||
1145 | ch++; | |
1146 | } | |
1147 | } | |
1148 | ||
1149 | static | |
1150 | void destroy_gstring(void *gstring) | |
1151 | { | |
1152 | (void) g_string_free(gstring, TRUE); | |
1153 | } | |
1154 | ||
1155 | BT_HIDDEN | |
1156 | GString *bt_common_normalize_path(const char *path, const char *wd) | |
1157 | { | |
1158 | size_t i; | |
1159 | GString *norm_path; | |
1160 | GPtrArray *parts = NULL; | |
1161 | ||
f6ccaed9 | 1162 | BT_ASSERT(path); |
e49a18d1 PP |
1163 | norm_path = g_string_new(G_DIR_SEPARATOR_S); |
1164 | if (!norm_path) { | |
1165 | goto error; | |
1166 | } | |
1167 | ||
1168 | parts = g_ptr_array_new_with_free_func(destroy_gstring); | |
1169 | if (!parts) { | |
1170 | goto error; | |
1171 | } | |
1172 | ||
1173 | if (path[0] != G_DIR_SEPARATOR) { | |
1174 | /* Relative path: start with working directory */ | |
1175 | if (wd) { | |
1176 | append_path_parts(wd, parts); | |
1177 | } else { | |
1178 | gchar *cd = g_get_current_dir(); | |
1179 | ||
1180 | append_path_parts(cd, parts); | |
1181 | g_free(cd); | |
1182 | } | |
1183 | } | |
1184 | ||
1185 | /* Append parts of the path parameter */ | |
1186 | append_path_parts(path, parts); | |
1187 | ||
1188 | /* Resolve special `..` and `.` parts */ | |
1189 | for (i = 0; i < parts->len; i++) { | |
1190 | GString *part = g_ptr_array_index(parts, i); | |
1191 | ||
1192 | if (strcmp(part->str, "..") == 0) { | |
1193 | if (i == 0) { | |
1194 | /* | |
1195 | * First part of absolute path is `..`: | |
1196 | * this is invalid. | |
1197 | */ | |
1198 | goto error; | |
1199 | } | |
1200 | ||
1201 | /* Remove `..` and previous part */ | |
1202 | g_ptr_array_remove_index(parts, i - 1); | |
1203 | g_ptr_array_remove_index(parts, i - 1); | |
1204 | i -= 2; | |
1205 | } else if (strcmp(part->str, ".") == 0) { | |
1206 | /* Remove `.` */ | |
1207 | g_ptr_array_remove_index(parts, i); | |
1208 | i -= 1; | |
1209 | } | |
1210 | } | |
1211 | ||
1212 | /* Create normalized path with what's left */ | |
1213 | for (i = 0; i < parts->len; i++) { | |
1214 | GString *part = g_ptr_array_index(parts, i); | |
1215 | ||
1216 | g_string_append(norm_path, part->str); | |
1217 | ||
1218 | if (i < parts->len - 1) { | |
1219 | g_string_append_c(norm_path, G_DIR_SEPARATOR); | |
1220 | } | |
1221 | } | |
1222 | ||
1223 | goto end; | |
1224 | ||
1225 | error: | |
1226 | if (norm_path) { | |
1227 | g_string_free(norm_path, TRUE); | |
1228 | norm_path = NULL; | |
1229 | } | |
1230 | ||
1231 | end: | |
1232 | if (parts) { | |
1233 | g_ptr_array_free(parts, TRUE); | |
1234 | } | |
1235 | ||
1236 | return norm_path; | |
1237 | } | |
1cd3decc | 1238 | #endif |
108e5a1e MJ |
1239 | |
1240 | BT_HIDDEN | |
86d8b7b8 | 1241 | size_t bt_common_get_page_size(int log_level) |
108e5a1e MJ |
1242 | { |
1243 | int page_size; | |
1244 | ||
1245 | page_size = bt_sysconf(_SC_PAGESIZE); | |
1246 | if (page_size < 0) { | |
b4565e8b PP |
1247 | BT_LOGF("Cannot get system's page size: ret=%d", |
1248 | page_size); | |
108e5a1e MJ |
1249 | abort(); |
1250 | } | |
1251 | ||
1252 | return page_size; | |
1253 | } | |
85cd02cf PP |
1254 | |
1255 | #define BUF_STD_APPEND(...) \ | |
1256 | do { \ | |
1257 | char _tmp_fmt[64]; \ | |
1258 | int _count; \ | |
1259 | size_t _size = buf_size - (size_t) (*buf_ch - buf); \ | |
1260 | size_t _tmp_fmt_size = (size_t) (fmt_ch - *out_fmt_ch); \ | |
1261 | strncpy(_tmp_fmt, *out_fmt_ch, _tmp_fmt_size); \ | |
1262 | _tmp_fmt[_tmp_fmt_size] = '\0'; \ | |
1263 | _count = snprintf(*buf_ch, _size, _tmp_fmt, __VA_ARGS__); \ | |
f6ccaed9 | 1264 | BT_ASSERT(_count >= 0); \ |
85cd02cf PP |
1265 | *buf_ch += MIN(_count, _size); \ |
1266 | } while (0) | |
1267 | ||
1268 | #define BUF_STD_APPEND_SINGLE_ARG(_type) \ | |
1269 | do { \ | |
1270 | _type _arg = va_arg(*args, _type); \ | |
1271 | BUF_STD_APPEND(_arg); \ | |
1272 | } while (0) | |
1273 | ||
1274 | static inline void handle_conversion_specifier_std(char *buf, char **buf_ch, | |
1275 | size_t buf_size, const char **out_fmt_ch, va_list *args) | |
1276 | { | |
1277 | const char *fmt_ch = *out_fmt_ch; | |
1278 | enum LENGTH_MODIFIER { | |
1279 | LENGTH_MOD_H, | |
1280 | LENGTH_MOD_HH, | |
1281 | LENGTH_MOD_NONE, | |
1282 | LENGTH_MOD_LOW_L, | |
1283 | LENGTH_MOD_LOW_LL, | |
1284 | LENGTH_MOD_UP_L, | |
1285 | LENGTH_MOD_Z, | |
1286 | } length_mod = LENGTH_MOD_NONE; | |
1287 | ||
1288 | /* skip '%' */ | |
1289 | fmt_ch++; | |
1290 | ||
1291 | if (*fmt_ch == '%') { | |
1292 | fmt_ch++; | |
1293 | **buf_ch = '%'; | |
1294 | (*buf_ch)++; | |
1295 | goto update_rw_fmt; | |
1296 | } | |
1297 | ||
1298 | /* flags */ | |
1299 | for (;;) { | |
1300 | switch (*fmt_ch) { | |
1301 | case '-': | |
1302 | case '+': | |
1303 | case ' ': | |
1304 | case '#': | |
1305 | case '0': | |
1306 | case '\'': | |
1307 | fmt_ch++; | |
1308 | continue; | |
1309 | default: | |
1310 | break; | |
1311 | } | |
1312 | break; | |
1313 | } | |
1314 | ||
1315 | /* width */ | |
1316 | for (;;) { | |
1317 | if (*fmt_ch < '0' || *fmt_ch > '9') { | |
1318 | break; | |
1319 | } | |
1320 | ||
1321 | fmt_ch++; | |
1322 | } | |
1323 | ||
1324 | /* precision */ | |
1325 | if (*fmt_ch == '.') { | |
1326 | fmt_ch++; | |
1327 | ||
1328 | for (;;) { | |
1329 | if (*fmt_ch < '0' || *fmt_ch > '9') { | |
1330 | break; | |
1331 | } | |
1332 | ||
1333 | fmt_ch++; | |
1334 | } | |
1335 | } | |
1336 | ||
1337 | /* format (PRI*64) */ | |
44c440bc | 1338 | if (strncmp(fmt_ch, PRId64, sizeof(PRId64) - 1) == 0) { |
51f4c026 | 1339 | fmt_ch += sizeof(PRId64) - 1; |
85cd02cf PP |
1340 | BUF_STD_APPEND_SINGLE_ARG(int64_t); |
1341 | goto update_rw_fmt; | |
44c440bc | 1342 | } else if (strncmp(fmt_ch, PRIu64, sizeof(PRIu64) - 1) == 0) { |
51f4c026 | 1343 | fmt_ch += sizeof(PRIu64) - 1; |
85cd02cf PP |
1344 | BUF_STD_APPEND_SINGLE_ARG(uint64_t); |
1345 | goto update_rw_fmt; | |
44c440bc | 1346 | } else if (strncmp(fmt_ch, PRIx64, sizeof(PRIx64) - 1) == 0) { |
51f4c026 | 1347 | fmt_ch += sizeof(PRIx64) - 1; |
85cd02cf PP |
1348 | BUF_STD_APPEND_SINGLE_ARG(uint64_t); |
1349 | goto update_rw_fmt; | |
44c440bc | 1350 | } else if (strncmp(fmt_ch, PRIX64, sizeof(PRIX64) - 1) == 0) { |
51f4c026 | 1351 | fmt_ch += sizeof(PRIX64) - 1; |
85cd02cf PP |
1352 | BUF_STD_APPEND_SINGLE_ARG(uint64_t); |
1353 | goto update_rw_fmt; | |
44c440bc | 1354 | } else if (strncmp(fmt_ch, PRIo64, sizeof(PRIo64) - 1) == 0) { |
51f4c026 | 1355 | fmt_ch += sizeof(PRIo64) - 1; |
85cd02cf PP |
1356 | BUF_STD_APPEND_SINGLE_ARG(uint64_t); |
1357 | goto update_rw_fmt; | |
44c440bc | 1358 | } else if (strncmp(fmt_ch, PRIi64, sizeof(PRIi64) - 1) == 0) { |
51f4c026 | 1359 | fmt_ch += sizeof(PRIi64) - 1; |
85cd02cf PP |
1360 | BUF_STD_APPEND_SINGLE_ARG(int64_t); |
1361 | goto update_rw_fmt; | |
1362 | } | |
1363 | ||
1364 | // length modifier | |
1365 | switch (*fmt_ch) { | |
1366 | case 'h': | |
1367 | length_mod = LENGTH_MOD_H; | |
1368 | fmt_ch++; | |
1369 | ||
1370 | if (*fmt_ch == 'h') { | |
1371 | length_mod = LENGTH_MOD_HH; | |
1372 | fmt_ch++; | |
1373 | break; | |
1374 | } | |
1375 | break; | |
1376 | case 'l': | |
1377 | length_mod = LENGTH_MOD_LOW_L; | |
1378 | fmt_ch++; | |
1379 | ||
1380 | if (*fmt_ch == 'l') { | |
1381 | length_mod = LENGTH_MOD_LOW_LL; | |
1382 | fmt_ch++; | |
1383 | break; | |
1384 | } | |
1385 | break; | |
1386 | case 'L': | |
1387 | length_mod = LENGTH_MOD_UP_L; | |
1388 | fmt_ch++; | |
1389 | break; | |
1390 | case 'z': | |
1391 | length_mod = LENGTH_MOD_Z; | |
1392 | fmt_ch++; | |
1393 | break; | |
1394 | default: | |
1395 | break; | |
1396 | } | |
1397 | ||
1398 | // format | |
1399 | switch (*fmt_ch) { | |
1400 | case 'c': | |
1401 | { | |
1402 | fmt_ch++; | |
1403 | ||
1404 | switch (length_mod) { | |
1405 | case LENGTH_MOD_NONE: | |
1406 | BUF_STD_APPEND_SINGLE_ARG(int); | |
1407 | break; | |
1408 | case LENGTH_MOD_LOW_L: | |
1409 | BUF_STD_APPEND_SINGLE_ARG(wint_t); | |
1410 | break; | |
1411 | default: | |
1412 | abort(); | |
1413 | } | |
1414 | break; | |
1415 | } | |
1416 | case 's': | |
1417 | fmt_ch++; | |
1418 | ||
1419 | switch (length_mod) { | |
1420 | case LENGTH_MOD_NONE: | |
1421 | BUF_STD_APPEND_SINGLE_ARG(char *); | |
1422 | break; | |
1423 | case LENGTH_MOD_LOW_L: | |
1424 | BUF_STD_APPEND_SINGLE_ARG(wchar_t *); | |
1425 | break; | |
1426 | default: | |
1427 | abort(); | |
1428 | } | |
1429 | break; | |
1430 | case 'd': | |
1431 | case 'i': | |
1432 | fmt_ch++; | |
1433 | ||
1434 | switch (length_mod) { | |
1435 | case LENGTH_MOD_NONE: | |
1436 | case LENGTH_MOD_H: | |
1437 | case LENGTH_MOD_HH: | |
1438 | BUF_STD_APPEND_SINGLE_ARG(int); | |
1439 | break; | |
1440 | case LENGTH_MOD_LOW_L: | |
1441 | BUF_STD_APPEND_SINGLE_ARG(long); | |
1442 | break; | |
1443 | case LENGTH_MOD_LOW_LL: | |
1444 | BUF_STD_APPEND_SINGLE_ARG(long long); | |
1445 | break; | |
1446 | case LENGTH_MOD_Z: | |
1447 | BUF_STD_APPEND_SINGLE_ARG(size_t); | |
1448 | break; | |
1449 | default: | |
1450 | abort(); | |
1451 | } | |
1452 | break; | |
1453 | case 'o': | |
1454 | case 'x': | |
1455 | case 'X': | |
1456 | case 'u': | |
1457 | fmt_ch++; | |
1458 | ||
1459 | switch (length_mod) { | |
1460 | case LENGTH_MOD_NONE: | |
1461 | case LENGTH_MOD_H: | |
1462 | case LENGTH_MOD_HH: | |
1463 | BUF_STD_APPEND_SINGLE_ARG(unsigned int); | |
1464 | break; | |
1465 | case LENGTH_MOD_LOW_L: | |
1466 | BUF_STD_APPEND_SINGLE_ARG(unsigned long); | |
1467 | break; | |
1468 | case LENGTH_MOD_LOW_LL: | |
1469 | BUF_STD_APPEND_SINGLE_ARG(unsigned long long); | |
1470 | break; | |
1471 | case LENGTH_MOD_Z: | |
1472 | BUF_STD_APPEND_SINGLE_ARG(size_t); | |
1473 | break; | |
1474 | default: | |
1475 | abort(); | |
1476 | } | |
1477 | break; | |
1478 | case 'f': | |
1479 | case 'F': | |
1480 | case 'e': | |
1481 | case 'E': | |
1482 | case 'g': | |
1483 | case 'G': | |
1484 | fmt_ch++; | |
1485 | ||
1486 | switch (length_mod) { | |
1487 | case LENGTH_MOD_NONE: | |
1488 | BUF_STD_APPEND_SINGLE_ARG(double); | |
1489 | break; | |
1490 | case LENGTH_MOD_UP_L: | |
1491 | BUF_STD_APPEND_SINGLE_ARG(long double); | |
1492 | break; | |
1493 | default: | |
1494 | abort(); | |
1495 | } | |
1496 | break; | |
1497 | case 'p': | |
1498 | fmt_ch++; | |
1499 | ||
1500 | if (length_mod == LENGTH_MOD_NONE) { | |
1501 | BUF_STD_APPEND_SINGLE_ARG(void *); | |
1502 | } else { | |
1503 | abort(); | |
1504 | } | |
1505 | break; | |
1506 | default: | |
1507 | abort(); | |
1508 | } | |
1509 | ||
1510 | update_rw_fmt: | |
1511 | *out_fmt_ch = fmt_ch; | |
1512 | } | |
1513 | ||
1514 | BT_HIDDEN | |
1515 | void bt_common_custom_vsnprintf(char *buf, size_t buf_size, | |
1516 | char intro, | |
1517 | bt_common_handle_custom_specifier_func handle_specifier, | |
1518 | void *priv_data, const char *fmt, va_list *args) | |
1519 | { | |
1520 | const char *fmt_ch = fmt; | |
1521 | char *buf_ch = buf; | |
1522 | ||
f6ccaed9 PP |
1523 | BT_ASSERT(buf); |
1524 | BT_ASSERT(fmt); | |
85cd02cf PP |
1525 | |
1526 | while (*fmt_ch != '\0') { | |
1527 | switch (*fmt_ch) { | |
1528 | case '%': | |
f6ccaed9 | 1529 | BT_ASSERT(fmt_ch[1] != '\0'); |
85cd02cf PP |
1530 | |
1531 | if (fmt_ch[1] == intro) { | |
1532 | handle_specifier(priv_data, &buf_ch, | |
1533 | buf_size - (size_t) (buf_ch - buf), | |
1534 | &fmt_ch, args); | |
1535 | } else { | |
1536 | handle_conversion_specifier_std(buf, &buf_ch, | |
1537 | buf_size, &fmt_ch, args); | |
1538 | } | |
1539 | ||
1540 | if (buf_ch >= buf + buf_size - 1) { | |
1541 | fmt_ch = ""; | |
1542 | } | |
1543 | break; | |
1544 | default: | |
1545 | *buf_ch = *fmt_ch; | |
1546 | buf_ch++; | |
1547 | if (buf_ch >= buf + buf_size - 1) { | |
1548 | fmt_ch = ""; | |
1549 | } | |
1550 | ||
1551 | fmt_ch++; | |
1552 | } | |
1553 | } | |
1554 | ||
1555 | *buf_ch = '\0'; | |
1556 | } | |
1557 | ||
1558 | BT_HIDDEN | |
1559 | void bt_common_custom_snprintf(char *buf, size_t buf_size, | |
1560 | char intro, | |
1561 | bt_common_handle_custom_specifier_func handle_specifier, | |
1562 | void *priv_data, const char *fmt, ...) | |
1563 | { | |
1564 | va_list args; | |
1565 | va_start(args, fmt); | |
1566 | bt_common_custom_vsnprintf(buf, buf_size, intro, handle_specifier, | |
1567 | priv_data, fmt, &args); | |
1568 | va_end(args); | |
1569 | } | |
ae83436e PP |
1570 | |
1571 | BT_HIDDEN | |
1572 | void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep) | |
1573 | { | |
1574 | const char *rd; | |
1575 | char *wr; | |
1576 | uint64_t i = 0; | |
1577 | uint64_t orig_len; | |
1578 | uint64_t sep_count; | |
1579 | uint64_t new_len; | |
1580 | ||
1581 | BT_ASSERT(digits_per_group > 0); | |
1582 | BT_ASSERT(sep != '\0'); | |
1583 | ||
1584 | /* Compute new length of `str` */ | |
1585 | orig_len = strlen(str); | |
1586 | BT_ASSERT(orig_len > 0); | |
1587 | sep_count = (orig_len - 1) / digits_per_group; | |
1588 | new_len = strlen(str) + sep_count; | |
1589 | ||
1590 | /* | |
1591 | * Do the work in place. Have the reading pointer `rd` start at | |
1592 | * the end of the original string, and the writing pointer `wr` | |
1593 | * start at the end of the new string, making sure to also put a | |
1594 | * null character there. | |
1595 | */ | |
1596 | rd = str + orig_len - 1; | |
1597 | wr = str + new_len; | |
1598 | *wr = '\0'; | |
1599 | wr--; | |
1600 | ||
1601 | /* | |
1602 | * Here's what the process looks like (3 digits per group): | |
1603 | * | |
1604 | * Source: 12345678 | |
1605 | * ^ | |
1606 | * Destination: 12345678#8 | |
1607 | * ^ | |
1608 | * | |
1609 | * Source: 12345678 | |
1610 | * ^ | |
1611 | * Destination: 1234567878 | |
1612 | * ^ | |
1613 | * | |
1614 | * Source: 12345678 | |
1615 | * ^ | |
1616 | * Destination: 1234567678 | |
1617 | * ^ | |
1618 | * | |
1619 | * Source: 12345678 | |
1620 | * ^ | |
1621 | * Destination: 123456,678 | |
1622 | * ^ | |
1623 | * | |
1624 | * Source: 12345678 | |
1625 | * ^ | |
1626 | * Destination: 123455,678 | |
1627 | * ^ | |
1628 | * | |
1629 | * Source: 12345678 | |
1630 | * ^ | |
1631 | * Destination: 123445,678 | |
1632 | * ^ | |
1633 | * | |
1634 | * Source: 12345678 | |
1635 | * ^ | |
1636 | * Destination: 123345,678 | |
1637 | * ^ | |
1638 | * | |
1639 | * Source: 12345678 | |
1640 | * ^ | |
1641 | * Destination: 12,345,678 | |
1642 | * ^ | |
1643 | * | |
1644 | * Source: 12345678 | |
1645 | * ^ | |
1646 | * Destination: 12,345,678 | |
1647 | * ^ | |
1648 | * | |
1649 | * Source: 12345678 | |
1650 | * ^ | |
1651 | * Destination: 12,345,678 | |
1652 | * ^ | |
1653 | */ | |
1654 | while (rd != str - 1) { | |
1655 | if (i == digits_per_group) { | |
1656 | /* | |
1657 | * Time to append the separator: decrement `wr`, | |
1658 | * but keep `rd` as is. | |
1659 | */ | |
1660 | i = 0; | |
1661 | *wr = sep; | |
1662 | wr--; | |
1663 | continue; | |
1664 | } | |
1665 | ||
1666 | /* Copy read-side character to write-side character */ | |
1667 | *wr = *rd; | |
1668 | wr--; | |
1669 | rd--; | |
1670 | i++; | |
1671 | } | |
1672 | } | |
775d0390 PP |
1673 | |
1674 | BT_HIDDEN | |
1675 | GString *bt_common_fold(const char *str, unsigned int total_length, | |
1676 | unsigned int indent) | |
1677 | { | |
1678 | const unsigned int content_length = total_length - indent; | |
1679 | GString *folded = g_string_new(NULL); | |
1680 | GString *tmp_line = g_string_new(NULL); | |
1681 | gchar **lines = NULL; | |
1682 | gchar **line_words = NULL; | |
1683 | gchar * const *line; | |
1684 | unsigned int i; | |
1685 | ||
1686 | BT_ASSERT(str); | |
1687 | BT_ASSERT(indent < total_length); | |
1688 | BT_ASSERT(tmp_line); | |
1689 | BT_ASSERT(folded); | |
1690 | ||
1691 | if (strlen(str) == 0) { | |
1692 | /* Empty input string: empty output string */ | |
1693 | goto end; | |
1694 | } | |
1695 | ||
1696 | /* Split lines */ | |
1697 | lines = g_strsplit(str, "\n", 0); | |
1698 | BT_ASSERT(lines); | |
1699 | ||
1700 | /* For each source line */ | |
1701 | for (line = lines; *line; line++) { | |
1702 | gchar * const *word; | |
1703 | ||
1704 | /* | |
1705 | * Append empty line without indenting if source line is | |
1706 | * empty. | |
1707 | */ | |
1708 | if (strlen(*line) == 0) { | |
1709 | g_string_append_c(folded, '\n'); | |
1710 | continue; | |
1711 | } | |
1712 | ||
1713 | /* Split words */ | |
1714 | line_words = g_strsplit(*line, " ", 0); | |
1715 | BT_ASSERT(line_words); | |
1716 | ||
1717 | /* | |
1718 | * Indent for first line (we know there's at least one | |
1719 | * word at this point). | |
1720 | */ | |
1721 | for (i = 0; i < indent; i++) { | |
1722 | g_string_append_c(folded, ' '); | |
1723 | } | |
1724 | ||
1725 | /* Append words, folding when necessary */ | |
1726 | g_string_assign(tmp_line, ""); | |
1727 | ||
1728 | for (word = line_words; *word; word++) { | |
1729 | /* | |
1730 | * `tmp_line->len > 0` is in the condition so | |
1731 | * that words that are larger than | |
1732 | * `content_length` are at least written on | |
1733 | * their own line. | |
1734 | * | |
1735 | * `tmp_line->len - 1` because the temporary | |
1736 | * line always contains a trailing space which | |
1737 | * won't be part of the line if we fold. | |
1738 | */ | |
1739 | if (tmp_line->len > 0 && | |
1740 | tmp_line->len - 1 + strlen(*word) >= content_length) { | |
1741 | /* Fold (without trailing space) */ | |
1742 | g_string_append_len(folded, | |
1743 | tmp_line->str, tmp_line->len - 1); | |
1744 | g_string_append_c(folded, '\n'); | |
1745 | ||
1746 | /* Indent new line */ | |
1747 | for (i = 0; i < indent; i++) { | |
1748 | g_string_append_c(folded, ' '); | |
1749 | } | |
1750 | ||
1751 | g_string_assign(tmp_line, ""); | |
1752 | } | |
1753 | ||
1754 | /* Append current word and space to temporary line */ | |
1755 | g_string_append(tmp_line, *word); | |
1756 | g_string_append_c(tmp_line, ' '); | |
1757 | } | |
1758 | ||
1759 | /* Append last line if any, without trailing space */ | |
1760 | if (tmp_line->len > 0) { | |
1761 | g_string_append_len(folded, tmp_line->str, | |
1762 | tmp_line->len - 1); | |
1763 | } | |
1764 | ||
1765 | /* Append source newline */ | |
1766 | g_string_append_c(folded, '\n'); | |
1767 | ||
1768 | /* Free array of this line's words */ | |
1769 | g_strfreev(line_words); | |
1770 | line_words = NULL; | |
1771 | } | |
1772 | ||
1773 | /* Remove trailing newline if any */ | |
1774 | if (folded->str[folded->len - 1] == '\n') { | |
1775 | g_string_truncate(folded, folded->len - 1); | |
1776 | } | |
1777 | ||
1778 | end: | |
1779 | if (lines) { | |
1780 | g_strfreev(lines); | |
1781 | } | |
1782 | ||
1783 | if (line_words) { | |
1784 | g_strfreev(line_words); | |
1785 | } | |
1786 | ||
1787 | if (tmp_line) { | |
1788 | g_string_free(tmp_line, TRUE); | |
1789 | } | |
1790 | ||
1791 | return folded; | |
1792 | } | |
2c4f022e PP |
1793 | |
1794 | #ifdef __MINGW32__ | |
1795 | BT_HIDDEN | |
1796 | int bt_common_get_term_size(unsigned int *width, unsigned int *height) | |
1797 | { | |
1798 | /* Not supported on Windows yet */ | |
1799 | return -1; | |
1800 | } | |
1801 | #else /* __MINGW32__ */ | |
1802 | BT_HIDDEN | |
1803 | int bt_common_get_term_size(unsigned int *width, unsigned int *height) | |
1804 | { | |
1805 | int ret = 0; | |
1806 | struct winsize winsize; | |
1807 | ||
1808 | if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) < 0) { | |
1809 | ret = -1; | |
1810 | goto end; | |
1811 | } | |
1812 | ||
1813 | if (width) { | |
1814 | *width = (unsigned int) winsize.ws_col; | |
1815 | } | |
1816 | ||
1817 | if (height) { | |
1818 | *height = (unsigned int) winsize.ws_row; | |
1819 | } | |
1820 | ||
1821 | end: | |
1822 | return ret; | |
1823 | } | |
1824 | #endif /* __MINGW32__ */ | |
5ab3582b MD |
1825 | |
1826 | BT_HIDDEN | |
1827 | int bt_common_g_string_append_printf(GString *str, const char *fmt, ...) | |
1828 | { | |
1829 | va_list ap; | |
1830 | gsize len, allocated_len, available_len; | |
1831 | int print_len; | |
1832 | ||
1833 | /* str->len excludes \0. */ | |
1834 | len = str->len; | |
1835 | /* Explicitly exclude \0. */ | |
1836 | allocated_len = str->allocated_len - 1; | |
1837 | available_len = allocated_len - len; | |
1838 | ||
1839 | str->len = allocated_len; | |
1840 | va_start(ap, fmt); | |
1841 | print_len = vsnprintf(str->str + len, available_len + 1, fmt, ap); | |
1842 | va_end(ap); | |
1843 | if (print_len < 0) { | |
1844 | return print_len; | |
1845 | } | |
1846 | if (G_UNLIKELY(available_len < print_len)) { | |
1847 | /* Resize. */ | |
1848 | g_string_set_size(str, len + print_len); | |
1849 | va_start(ap, fmt); | |
1850 | print_len = vsprintf(str->str + len, fmt, ap); | |
1851 | va_end(ap); | |
1852 | } else { | |
1853 | str->len = len + print_len; | |
1854 | } | |
1855 | return print_len; | |
1856 | } |