3 * Copyright © 2018 Christian Brauner <christian.brauner@ubuntu.com>.
4 * Copyright © 2018 Canonical Ltd.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2, as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #define __STDC_FORMAT_MACROS /* Required for PRIu64 to work. */
37 #include <sys/mount.h>
38 #include <sys/param.h>
39 #include <sys/prctl.h>
41 #include <sys/types.h>
47 #include "namespace.h"
49 #include "string_utils.h"
52 #include "include/strlcpy.h"
56 #include "include/strlcat.h"
59 lxc_log_define(string_utils
, lxc
);
61 char **lxc_va_arg_list_to_argv(va_list ap
, size_t skip
, int do_strdup
)
64 size_t count
= 1 + skip
;
67 /* first determine size of argument list, we don't want to reallocate
72 char *arg
= va_arg(ap2
, char *);
79 result
= calloc(count
, sizeof(char *));
85 char *arg
= va_arg(ap
, char *);
88 arg
= do_strdup
? strdup(arg
) : arg
;
91 result
[count
++] = arg
;
94 /* calloc has already set last element to NULL*/
102 const char **lxc_va_arg_list_to_argv_const(va_list ap
, size_t skip
)
104 return (const char **)lxc_va_arg_list_to_argv(ap
, skip
, 0);
107 char *lxc_string_replace(const char *needle
, const char *replacement
,
108 const char *haystack
)
110 ssize_t len
= -1, saved_len
= -1;
112 size_t replacement_len
= strlen(replacement
);
113 size_t needle_len
= strlen(needle
);
115 /* should be executed exactly twice */
116 while (len
== -1 || result
== NULL
) {
122 result
= calloc(1, len
+ 1);
131 for (last_p
= (char *)haystack
, p
= strstr(last_p
, needle
); p
;
132 last_p
= p
, p
= strstr(last_p
, needle
)) {
133 part_len
= (ssize_t
)(p
- last_p
);
134 if (result
&& part_len
> 0)
135 memcpy(&result
[len
], last_p
, part_len
);
139 if (result
&& replacement_len
> 0)
140 memcpy(&result
[len
], replacement
,
143 len
+= replacement_len
;
147 part_len
= strlen(last_p
);
148 if (result
&& part_len
> 0)
149 memcpy(&result
[len
], last_p
, part_len
);
154 /* make sure we did the same thing twice,
155 * once for calculating length, the other
156 * time for copying data */
157 if (saved_len
!= len
) {
162 /* make sure we didn't overwrite any buffer,
163 * due to calloc the string should be 0-terminated */
164 if (result
[len
] != '\0') {
172 bool lxc_string_in_array(const char *needle
, const char **haystack
)
174 for (; haystack
&& *haystack
; haystack
++)
175 if (!strcmp(needle
, *haystack
))
181 char *lxc_string_join(const char *sep
, const char **parts
, bool use_as_prefix
)
185 size_t sep_len
= strlen(sep
);
186 size_t result_len
= use_as_prefix
* sep_len
;
189 /* calculate new string length */
190 for (p
= (char **)parts
; *p
; p
++)
191 result_len
+= (p
> (char **)parts
) * sep_len
+ strlen(*p
);
193 buf_len
= result_len
+ 1;
194 result
= calloc(buf_len
, 1);
199 (void)strlcpy(result
, sep
, buf_len
);
201 for (p
= (char **)parts
; *p
; p
++) {
202 if (p
> (char **)parts
)
203 (void)strlcat(result
, sep
, buf_len
);
205 (void)strlcat(result
, *p
, buf_len
);
211 char **lxc_normalize_path(const char *path
)
215 size_t components_len
= 0;
218 components
= lxc_string_split(path
, '/');
222 for (p
= components
; *p
; p
++)
225 /* resolve '.' and '..' */
226 for (pos
= 0; pos
< components_len
;) {
227 if (!strcmp(components
[pos
], ".") ||
228 (!strcmp(components
[pos
], "..") && pos
== 0)) {
229 /* eat this element */
230 free(components
[pos
]);
231 memmove(&components
[pos
], &components
[pos
+ 1],
232 sizeof(char *) * (components_len
- pos
));
234 } else if (!strcmp(components
[pos
], "..")) {
235 /* eat this and the previous element */
236 free(components
[pos
- 1]);
237 free(components
[pos
]);
238 memmove(&components
[pos
- 1], &components
[pos
+ 1],
239 sizeof(char *) * (components_len
- pos
));
250 char *lxc_deslashify(const char *path
)
260 parts
= lxc_normalize_path(dup
);
266 /* We'll end up here if path == "///" or path == "". */
270 lxc_free_array((void **)parts
, free
);
274 n
= strcspn(dup
, "/");
277 lxc_free_array((void **)parts
, free
);
287 p
= lxc_string_join("/", (const char **)parts
, *dup
== '/');
289 lxc_free_array((void **)parts
, free
);
293 char *lxc_append_paths(const char *first
, const char *second
)
298 const char *pattern
= "%s%s";
300 len
= strlen(first
) + strlen(second
) + 1;
301 if (second
[0] != '/') {
306 result
= calloc(1, len
);
310 ret
= snprintf(result
, len
, pattern
, first
, second
);
311 if (ret
< 0 || (size_t)ret
>= len
) {
319 bool lxc_string_in_list(const char *needle
, const char *haystack
, char _sep
)
322 char sep
[2] = { _sep
, '\0' };
325 if (!haystack
|| !needle
)
328 len
= strlen(haystack
);
329 str
= alloca(len
+ 1);
330 (void)strlcpy(str
, haystack
, len
+ 1);
332 lxc_iterate_parts(token
, str
, sep
)
333 if (strcmp(needle
, token
) == 0)
339 char **lxc_string_split(const char *string
, char _sep
)
342 char sep
[2] = {_sep
, '\0'};
343 char **tmp
= NULL
, **result
= NULL
;
344 size_t result_capacity
= 0;
345 size_t result_count
= 0;
350 return calloc(1, sizeof(char *));
352 len
= strlen(string
);
353 str
= alloca(len
+ 1);
354 (void)strlcpy(str
, string
, len
+ 1);
356 lxc_iterate_parts(token
, str
, sep
) {
357 r
= lxc_grow_array((void ***)&result
, &result_capacity
, result_count
+ 1, 16);
361 result
[result_count
] = strdup(token
);
362 if (!result
[result_count
])
368 /* if we allocated too much, reduce it */
369 tmp
= realloc(result
, (result_count
+ 1) * sizeof(char *));
375 /* Make sure we don't return uninitialized memory. */
376 if (result_count
== 0)
383 lxc_free_array((void **)result
, free
);
388 static bool complete_word(char ***result
, char *start
, char *end
, size_t *cap
,
393 r
= lxc_grow_array((void ***)result
, cap
, 2 + *cnt
, 16);
397 (*result
)[*cnt
] = strndup(start
, end
- start
);
398 if (!(*result
)[*cnt
])
407 * Given a a string 'one two "three four"', split into three words,
408 * one, two, and "three four"
410 char **lxc_string_split_quoted(char *string
)
412 char *nextword
= string
, *p
, state
;
413 char **result
= NULL
;
414 size_t result_capacity
= 0;
415 size_t result_count
= 0;
417 if (!string
|| !*string
)
418 return calloc(1, sizeof(char *));
420 // TODO I'm *not* handling escaped quote
422 for (p
= string
; *p
; p
++) {
427 else if (*p
== '"' || *p
== '\'') {
437 complete_word(&result
, nextword
, p
, &result_capacity
, &result_count
);
445 complete_word(&result
, nextword
+1, p
, &result_capacity
, &result_count
);
454 complete_word(&result
, nextword
, p
, &result_capacity
, &result_count
);
456 return realloc(result
, (result_count
+ 1) * sizeof(char *));
459 char **lxc_string_split_and_trim(const char *string
, char _sep
)
462 char sep
[2] = { _sep
, '\0' };
463 char **result
= NULL
;
464 size_t result_capacity
= 0;
465 size_t result_count
= 0;
471 return calloc(1, sizeof(char *));
473 len
= strlen(string
);
474 str
= alloca(len
+ 1);
475 (void)strlcpy(str
, string
, len
+ 1);
477 lxc_iterate_parts(token
, str
, sep
) {
478 while (token
[0] == ' ' || token
[0] == '\t')
482 while (i
> 0 && (token
[i
- 1] == ' ' || token
[i
- 1] == '\t')) {
487 r
= lxc_grow_array((void ***)&result
, &result_capacity
, result_count
+ 1, 16);
491 result
[result_count
] = strdup(token
);
492 if (!result
[result_count
])
498 /* if we allocated too much, reduce it */
499 return realloc(result
, (result_count
+ 1) * sizeof(char *));
503 lxc_free_array((void **)result
, free
);
508 void lxc_free_array(void **array
, lxc_free_fn element_free_fn
)
512 for (p
= array
; p
&& *p
; p
++)
518 int lxc_grow_array(void ***array
, size_t *capacity
, size_t new_size
, size_t capacity_increment
)
523 /* first time around, catch some trivial mistakes of the user
524 * only initializing one of these */
525 if (!*array
|| !*capacity
) {
530 new_capacity
= *capacity
;
531 while (new_size
+ 1 > new_capacity
)
532 new_capacity
+= capacity_increment
;
534 if (new_capacity
!= *capacity
) {
535 /* we have to reallocate */
536 new_array
= realloc(*array
, new_capacity
* sizeof(void *));
540 memset(&new_array
[*capacity
], 0, (new_capacity
- (*capacity
)) * sizeof(void *));
542 *capacity
= new_capacity
;
545 /* array has sufficient elements */
549 size_t lxc_array_len(void **array
)
554 for (p
= array
; p
&& *p
; p
++)
560 void **lxc_append_null_to_array(void **array
, size_t count
)
564 /* Append NULL to the array */
566 temp
= realloc(array
, (count
+ 1) * sizeof(*array
));
569 for (i
= 0; i
< count
; i
++)
582 static int lxc_append_null_to_list(void ***list
)
588 for (; (*list
)[newentry
]; newentry
++) {
592 tmp
= realloc(*list
, (newentry
+ 2) * sizeof(void **));
597 (*list
)[newentry
+ 1] = NULL
;
602 int lxc_append_string(char ***list
, char *entry
)
607 newentry
= lxc_append_null_to_list((void ***)list
);
611 copy
= strdup(entry
);
615 (*list
)[newentry
] = copy
;
620 int lxc_safe_uint(const char *numstr
, unsigned int *converted
)
623 unsigned long int uli
;
625 while (isspace(*numstr
))
632 uli
= strtoul(numstr
, &err
, 0);
633 if (errno
== ERANGE
&& uli
== ULONG_MAX
)
636 if (err
== numstr
|| *err
!= '\0')
642 *converted
= (unsigned int)uli
;
646 int lxc_safe_ulong(const char *numstr
, unsigned long *converted
)
649 unsigned long int uli
;
651 while (isspace(*numstr
))
658 uli
= strtoul(numstr
, &err
, 0);
659 if (errno
== ERANGE
&& uli
== ULONG_MAX
)
662 if (err
== numstr
|| *err
!= '\0')
669 int lxc_safe_uint64(const char *numstr
, uint64_t *converted
, int base
)
674 while (isspace(*numstr
))
681 u
= strtoull(numstr
, &err
, base
);
682 if (errno
== ERANGE
&& u
== UINT64_MAX
)
685 if (err
== numstr
|| *err
!= '\0')
692 int lxc_safe_int(const char *numstr
, int *converted
)
698 sli
= strtol(numstr
, &err
, 0);
699 if (errno
== ERANGE
&& (sli
== LONG_MAX
|| sli
== LONG_MIN
))
702 if (errno
!= 0 && sli
== 0)
705 if (err
== numstr
|| *err
!= '\0')
708 if (sli
> INT_MAX
|| sli
< INT_MIN
)
711 *converted
= (int)sli
;
715 int lxc_safe_long(const char *numstr
, long int *converted
)
721 sli
= strtol(numstr
, &err
, 0);
722 if (errno
== ERANGE
&& (sli
== LONG_MAX
|| sli
== LONG_MIN
))
725 if (errno
!= 0 && sli
== 0)
728 if (err
== numstr
|| *err
!= '\0')
735 int lxc_safe_long_long(const char *numstr
, long long int *converted
)
738 signed long long int sli
;
741 sli
= strtoll(numstr
, &err
, 0);
742 if (errno
== ERANGE
&& (sli
== LLONG_MAX
|| sli
== LLONG_MIN
))
745 if (errno
!= 0 && sli
== 0)
748 if (err
== numstr
|| *err
!= '\0')
755 char *must_concat(const char *first
, ...)
759 size_t cur_len
, it_len
;
761 dest
= must_copy_string(first
);
762 cur_len
= it_len
= strlen(first
);
764 va_start(args
, first
);
765 while ((cur
= va_arg(args
, char *)) != NULL
) {
766 it_len
= strlen(cur
);
768 dest
= must_realloc(dest
, cur_len
+ it_len
+ 1);
770 (void)memcpy(dest
+ cur_len
, cur
, it_len
);
779 char *must_make_path(const char *first
, ...)
783 size_t full_len
= strlen(first
);
786 dest
= must_copy_string(first
);
788 va_start(args
, first
);
789 while ((cur
= va_arg(args
, char *)) != NULL
) {
790 full_len
+= strlen(cur
);
794 buf_len
= full_len
+ 1;
795 dest
= must_realloc(dest
, buf_len
);
798 (void)strlcat(dest
, "/", buf_len
);
799 (void)strlcat(dest
, cur
, buf_len
);
806 char *must_append_path(char *first
, ...)
814 full_len
= strlen(first
);
815 va_start(args
, first
);
816 while ((cur
= va_arg(args
, char *)) != NULL
) {
817 full_len
+= strlen(cur
);
821 buf_len
= full_len
+ 1;
822 dest
= must_realloc(dest
, buf_len
);
825 (void)strlcat(dest
, "/", buf_len
);
826 (void)strlcat(dest
, cur
, buf_len
);
833 char *must_copy_string(const char *entry
)
847 void *must_realloc(void *orig
, size_t sz
)
852 ret
= realloc(orig
, sz
);
858 int parse_byte_size_string(const char *s
, int64_t *converted
)
862 int64_t mltpl
, overflow
;
864 char dup
[INTTYPE_TO_STRLEN(int64_t)];
865 char suffix
[3] = {0};
867 if (!s
|| !strcmp(s
, ""))
870 end
= stpncpy(dup
, s
, sizeof(dup
) - 1);
874 if (isdigit(*(end
- 1)))
876 else if (isalpha(*(end
- 1)))
881 if (suffix_len
> 0 && (end
- 2) == dup
&& !isdigit(*(end
- 2)))
884 if (suffix_len
> 0 && isalpha(*(end
- 2)))
887 if (suffix_len
> 0) {
888 memcpy(suffix
, end
- suffix_len
, suffix_len
);
889 *(suffix
+ suffix_len
) = '\0';
890 *(end
- suffix_len
) = '\0';
892 dup
[lxc_char_right_gc(dup
, strlen(dup
))] = '\0';
894 ret
= lxc_safe_long_long(dup
, &conv
);
898 if (suffix_len
!= 2) {
903 if (strcasecmp(suffix
, "KB") == 0)
905 else if (strcasecmp(suffix
, "MB") == 0)
907 else if (strcasecmp(suffix
, "GB") == 0)
908 mltpl
= 1024 * 1024 * 1024;
912 overflow
= conv
* mltpl
;
913 if (conv
!= 0 && (overflow
/ conv
) != mltpl
)
916 *converted
= overflow
;
920 void remove_trailing_newlines(char *l
)
927 while (--p
>= l
&& *p
== '\n')
931 int lxc_char_left_gc(const char *buffer
, size_t len
)
935 for (i
= 0; i
< len
; i
++) {
936 if (buffer
[i
] == ' ' ||
946 int lxc_char_right_gc(const char *buffer
, size_t len
)
950 for (i
= len
- 1; i
>= 0; i
--) {
951 if (buffer
[i
] == ' ' ||
963 char *lxc_trim_whitespace_in_place(char *buffer
)
965 buffer
+= lxc_char_left_gc(buffer
, strlen(buffer
));
966 buffer
[lxc_char_right_gc(buffer
, strlen(buffer
))] = '\0';
970 int lxc_is_line_empty(const char *line
)
973 size_t len
= strlen(line
);
975 for (i
= 0; i
< len
; i
++)
976 if (line
[i
] != ' ' && line
[i
] != '\t' &&
977 line
[i
] != '\n' && line
[i
] != '\r' &&
978 line
[i
] != '\f' && line
[i
] != '\0')
983 void remove_trailing_slashes(char *p
)
986 while (--l
>= 0 && (p
[l
] == '/' || p
[l
] == '\n'))