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>
46 #include "namespace.h"
48 #include "string_utils.h"
51 #include "include/strlcpy.h"
55 #include "include/strlcat.h"
58 lxc_log_define(string_utils
, lxc
);
60 char **lxc_va_arg_list_to_argv(va_list ap
, size_t skip
, int do_strdup
)
63 size_t count
= 1 + skip
;
66 /* first determine size of argument list, we don't want to reallocate
71 char *arg
= va_arg(ap2
, char *);
78 result
= calloc(count
, sizeof(char *));
84 char *arg
= va_arg(ap
, char *);
87 arg
= do_strdup
? strdup(arg
) : arg
;
90 result
[count
++] = arg
;
93 /* calloc has already set last element to NULL*/
101 const char **lxc_va_arg_list_to_argv_const(va_list ap
, size_t skip
)
103 return (const char **)lxc_va_arg_list_to_argv(ap
, skip
, 0);
106 char *lxc_string_replace(const char *needle
, const char *replacement
,
107 const char *haystack
)
109 ssize_t len
= -1, saved_len
= -1;
111 size_t replacement_len
= strlen(replacement
);
112 size_t needle_len
= strlen(needle
);
114 /* should be executed exactly twice */
115 while (len
== -1 || result
== NULL
) {
121 result
= calloc(1, len
+ 1);
130 for (last_p
= (char *)haystack
, p
= strstr(last_p
, needle
); p
;
131 last_p
= p
, p
= strstr(last_p
, needle
)) {
132 part_len
= (ssize_t
)(p
- last_p
);
133 if (result
&& part_len
> 0)
134 memcpy(&result
[len
], last_p
, part_len
);
138 if (result
&& replacement_len
> 0)
139 memcpy(&result
[len
], replacement
,
142 len
+= replacement_len
;
146 part_len
= strlen(last_p
);
147 if (result
&& part_len
> 0)
148 memcpy(&result
[len
], last_p
, part_len
);
153 /* make sure we did the same thing twice,
154 * once for calculating length, the other
155 * time for copying data */
156 if (saved_len
!= len
) {
161 /* make sure we didn't overwrite any buffer,
162 * due to calloc the string should be 0-terminated */
163 if (result
[len
] != '\0') {
171 bool lxc_string_in_array(const char *needle
, const char **haystack
)
173 for (; haystack
&& *haystack
; haystack
++)
174 if (!strcmp(needle
, *haystack
))
180 char *lxc_string_join(const char *sep
, const char **parts
, bool use_as_prefix
)
184 size_t sep_len
= strlen(sep
);
185 size_t result_len
= use_as_prefix
* sep_len
;
188 /* calculate new string length */
189 for (p
= (char **)parts
; *p
; p
++)
190 result_len
+= (p
> (char **)parts
) * sep_len
+ strlen(*p
);
192 buf_len
= result_len
+ 1;
193 result
= calloc(buf_len
, 1);
198 (void)strlcpy(result
, sep
, buf_len
);
200 for (p
= (char **)parts
; *p
; p
++) {
201 if (p
> (char **)parts
)
202 (void)strlcat(result
, sep
, buf_len
);
204 (void)strlcat(result
, *p
, buf_len
);
210 char **lxc_normalize_path(const char *path
)
214 size_t components_len
= 0;
217 components
= lxc_string_split(path
, '/');
221 for (p
= components
; *p
; p
++)
224 /* resolve '.' and '..' */
225 for (pos
= 0; pos
< components_len
;) {
226 if (!strcmp(components
[pos
], ".") ||
227 (!strcmp(components
[pos
], "..") && pos
== 0)) {
228 /* eat this element */
229 free(components
[pos
]);
230 memmove(&components
[pos
], &components
[pos
+ 1],
231 sizeof(char *) * (components_len
- pos
));
233 } else if (!strcmp(components
[pos
], "..")) {
234 /* eat this and the previous element */
235 free(components
[pos
- 1]);
236 free(components
[pos
]);
237 memmove(&components
[pos
- 1], &components
[pos
+ 1],
238 sizeof(char *) * (components_len
- pos
));
249 char *lxc_deslashify(const char *path
)
259 parts
= lxc_normalize_path(dup
);
265 /* We'll end up here if path == "///" or path == "". */
269 lxc_free_array((void **)parts
, free
);
273 n
= strcspn(dup
, "/");
276 lxc_free_array((void **)parts
, free
);
286 p
= lxc_string_join("/", (const char **)parts
, *dup
== '/');
288 lxc_free_array((void **)parts
, free
);
292 char *lxc_append_paths(const char *first
, const char *second
)
297 const char *pattern
= "%s%s";
299 len
= strlen(first
) + strlen(second
) + 1;
300 if (second
[0] != '/') {
305 result
= calloc(1, len
);
309 ret
= snprintf(result
, len
, pattern
, first
, second
);
310 if (ret
< 0 || (size_t)ret
>= len
) {
318 bool lxc_string_in_list(const char *needle
, const char *haystack
, char _sep
)
321 char sep
[2] = { _sep
, '\0' };
324 if (!haystack
|| !needle
)
327 len
= strlen(haystack
);
328 str
= alloca(len
+ 1);
329 (void)strlcpy(str
, haystack
, len
+ 1);
331 lxc_iterate_parts(token
, str
, sep
)
332 if (strcmp(needle
, token
) == 0)
338 char **lxc_string_split(const char *string
, char _sep
)
341 char sep
[2] = {_sep
, '\0'};
342 char **tmp
= NULL
, **result
= NULL
;
343 size_t result_capacity
= 0;
344 size_t result_count
= 0;
349 return calloc(1, sizeof(char *));
351 len
= strlen(string
);
352 str
= alloca(len
+ 1);
353 (void)strlcpy(str
, string
, len
+ 1);
355 lxc_iterate_parts(token
, str
, sep
) {
356 r
= lxc_grow_array((void ***)&result
, &result_capacity
, result_count
+ 1, 16);
360 result
[result_count
] = strdup(token
);
361 if (!result
[result_count
])
367 /* if we allocated too much, reduce it */
368 tmp
= realloc(result
, (result_count
+ 1) * sizeof(char *));
374 /* Make sure we don't return uninitialized memory. */
375 if (result_count
== 0)
382 lxc_free_array((void **)result
, free
);
387 static bool complete_word(char ***result
, char *start
, char *end
, size_t *cap
,
392 r
= lxc_grow_array((void ***)result
, cap
, 2 + *cnt
, 16);
396 (*result
)[*cnt
] = strndup(start
, end
- start
);
397 if (!(*result
)[*cnt
])
406 * Given a a string 'one two "three four"', split into three words,
407 * one, two, and "three four"
409 char **lxc_string_split_quoted(char *string
)
411 char *nextword
= string
, *p
, state
;
412 char **result
= NULL
;
413 size_t result_capacity
= 0;
414 size_t result_count
= 0;
416 if (!string
|| !*string
)
417 return calloc(1, sizeof(char *));
419 // TODO I'm *not* handling escaped quote
421 for (p
= string
; *p
; p
++) {
426 else if (*p
== '"' || *p
== '\'') {
436 complete_word(&result
, nextword
, p
, &result_capacity
, &result_count
);
444 complete_word(&result
, nextword
+1, p
, &result_capacity
, &result_count
);
453 complete_word(&result
, nextword
, p
, &result_capacity
, &result_count
);
455 return realloc(result
, (result_count
+ 1) * sizeof(char *));
458 char **lxc_string_split_and_trim(const char *string
, char _sep
)
461 char sep
[2] = { _sep
, '\0' };
462 char **result
= NULL
;
463 size_t result_capacity
= 0;
464 size_t result_count
= 0;
470 return calloc(1, sizeof(char *));
472 len
= strlen(string
);
473 str
= alloca(len
+ 1);
474 (void)strlcpy(str
, string
, len
+ 1);
476 lxc_iterate_parts(token
, str
, sep
) {
477 while (token
[0] == ' ' || token
[0] == '\t')
481 while (i
> 0 && (token
[i
- 1] == ' ' || token
[i
- 1] == '\t')) {
486 r
= lxc_grow_array((void ***)&result
, &result_capacity
, result_count
+ 1, 16);
490 result
[result_count
] = strdup(token
);
491 if (!result
[result_count
])
497 /* if we allocated too much, reduce it */
498 return realloc(result
, (result_count
+ 1) * sizeof(char *));
502 lxc_free_array((void **)result
, free
);
507 void lxc_free_array(void **array
, lxc_free_fn element_free_fn
)
511 for (p
= array
; p
&& *p
; p
++)
517 int lxc_grow_array(void ***array
, size_t *capacity
, size_t new_size
, size_t capacity_increment
)
522 /* first time around, catch some trivial mistakes of the user
523 * only initializing one of these */
524 if (!*array
|| !*capacity
) {
529 new_capacity
= *capacity
;
530 while (new_size
+ 1 > new_capacity
)
531 new_capacity
+= capacity_increment
;
533 if (new_capacity
!= *capacity
) {
534 /* we have to reallocate */
535 new_array
= realloc(*array
, new_capacity
* sizeof(void *));
539 memset(&new_array
[*capacity
], 0, (new_capacity
- (*capacity
)) * sizeof(void *));
541 *capacity
= new_capacity
;
544 /* array has sufficient elements */
548 size_t lxc_array_len(void **array
)
553 for (p
= array
; p
&& *p
; p
++)
559 void **lxc_append_null_to_array(void **array
, size_t count
)
563 /* Append NULL to the array */
565 temp
= realloc(array
, (count
+ 1) * sizeof(*array
));
568 for (i
= 0; i
< count
; i
++)
581 static int lxc_append_null_to_list(void ***list
)
587 for (; (*list
)[newentry
]; newentry
++) {
591 tmp
= realloc(*list
, (newentry
+ 2) * sizeof(void **));
596 (*list
)[newentry
+ 1] = NULL
;
601 int lxc_append_string(char ***list
, char *entry
)
606 newentry
= lxc_append_null_to_list((void ***)list
);
610 copy
= strdup(entry
);
614 (*list
)[newentry
] = copy
;
619 int lxc_safe_uint(const char *numstr
, unsigned int *converted
)
622 unsigned long int uli
;
624 while (isspace(*numstr
))
631 uli
= strtoul(numstr
, &err
, 0);
632 if (errno
== ERANGE
&& uli
== ULONG_MAX
)
635 if (err
== numstr
|| *err
!= '\0')
641 *converted
= (unsigned int)uli
;
645 int lxc_safe_ulong(const char *numstr
, unsigned long *converted
)
648 unsigned long int uli
;
650 while (isspace(*numstr
))
657 uli
= strtoul(numstr
, &err
, 0);
658 if (errno
== ERANGE
&& uli
== ULONG_MAX
)
661 if (err
== numstr
|| *err
!= '\0')
668 int lxc_safe_uint64(const char *numstr
, uint64_t *converted
, int base
)
673 while (isspace(*numstr
))
680 u
= strtoull(numstr
, &err
, base
);
681 if (errno
== ERANGE
&& u
== ULLONG_MAX
)
684 if (err
== numstr
|| *err
!= '\0')
691 int lxc_safe_int(const char *numstr
, int *converted
)
697 sli
= strtol(numstr
, &err
, 0);
698 if (errno
== ERANGE
&& (sli
== LONG_MAX
|| sli
== LONG_MIN
))
701 if (errno
!= 0 && sli
== 0)
704 if (err
== numstr
|| *err
!= '\0')
707 if (sli
> INT_MAX
|| sli
< INT_MIN
)
710 *converted
= (int)sli
;
714 int lxc_safe_long(const char *numstr
, long int *converted
)
720 sli
= strtol(numstr
, &err
, 0);
721 if (errno
== ERANGE
&& (sli
== LONG_MAX
|| sli
== LONG_MIN
))
724 if (errno
!= 0 && sli
== 0)
727 if (err
== numstr
|| *err
!= '\0')
734 int lxc_safe_long_long(const char *numstr
, long long int *converted
)
737 signed long long int sli
;
740 sli
= strtoll(numstr
, &err
, 0);
741 if (errno
== ERANGE
&& (sli
== LLONG_MAX
|| sli
== LLONG_MIN
))
744 if (errno
!= 0 && sli
== 0)
747 if (err
== numstr
|| *err
!= '\0')
754 char *must_concat(const char *first
, ...)
758 size_t cur_len
, it_len
;
760 dest
= must_copy_string(first
);
761 cur_len
= it_len
= strlen(first
);
763 va_start(args
, first
);
764 while ((cur
= va_arg(args
, char *)) != NULL
) {
765 it_len
= strlen(cur
);
767 dest
= must_realloc(dest
, cur_len
+ it_len
+ 1);
769 (void)memcpy(dest
+ cur_len
, cur
, it_len
);
778 char *must_make_path(const char *first
, ...)
782 size_t full_len
= strlen(first
);
785 dest
= must_copy_string(first
);
787 va_start(args
, first
);
788 while ((cur
= va_arg(args
, char *)) != NULL
) {
789 full_len
+= strlen(cur
);
793 buf_len
= full_len
+ 1;
794 dest
= must_realloc(dest
, buf_len
);
797 (void)strlcat(dest
, "/", buf_len
);
798 (void)strlcat(dest
, cur
, buf_len
);
805 char *must_append_path(char *first
, ...)
813 full_len
= strlen(first
);
814 va_start(args
, first
);
815 while ((cur
= va_arg(args
, char *)) != NULL
) {
816 full_len
+= strlen(cur
);
820 buf_len
= full_len
+ 1;
821 dest
= must_realloc(dest
, buf_len
);
824 (void)strlcat(dest
, "/", buf_len
);
825 (void)strlcat(dest
, cur
, buf_len
);
832 char *must_copy_string(const char *entry
)
846 void *must_realloc(void *orig
, size_t sz
)
851 ret
= realloc(orig
, sz
);
857 int parse_byte_size_string(const char *s
, int64_t *converted
)
861 int64_t mltpl
, overflow
;
863 char dup
[LXC_NUMSTRLEN64
+ 2];
864 char suffix
[3] = {0};
866 if (!s
|| !strcmp(s
, ""))
869 end
= stpncpy(dup
, s
, sizeof(dup
) - 1);
873 if (isdigit(*(end
- 1)))
875 else if (isalpha(*(end
- 1)))
880 if (suffix_len
> 0 && (end
- 2) == dup
&& !isdigit(*(end
- 2)))
883 if (suffix_len
> 0 && isalpha(*(end
- 2)))
886 if (suffix_len
> 0) {
887 memcpy(suffix
, end
- suffix_len
, suffix_len
);
888 *(suffix
+ suffix_len
) = '\0';
889 *(end
- suffix_len
) = '\0';
891 dup
[lxc_char_right_gc(dup
, strlen(dup
))] = '\0';
893 ret
= lxc_safe_long_long(dup
, &conv
);
897 if (suffix_len
!= 2) {
902 if (strcasecmp(suffix
, "KB") == 0)
904 else if (strcasecmp(suffix
, "MB") == 0)
906 else if (strcasecmp(suffix
, "GB") == 0)
907 mltpl
= 1024 * 1024 * 1024;
911 overflow
= conv
* mltpl
;
912 if (conv
!= 0 && (overflow
/ conv
) != mltpl
)
915 *converted
= overflow
;
919 void remove_trailing_newlines(char *l
)
926 while (--p
>= l
&& *p
== '\n')
930 int lxc_char_left_gc(const char *buffer
, size_t len
)
934 for (i
= 0; i
< len
; i
++) {
935 if (buffer
[i
] == ' ' ||
945 int lxc_char_right_gc(const char *buffer
, size_t len
)
949 for (i
= len
- 1; i
>= 0; i
--) {
950 if (buffer
[i
] == ' ' ||
962 char *lxc_trim_whitespace_in_place(char *buffer
)
964 buffer
+= lxc_char_left_gc(buffer
, strlen(buffer
));
965 buffer
[lxc_char_right_gc(buffer
, strlen(buffer
))] = '\0';
969 int lxc_is_line_empty(const char *line
)
972 size_t len
= strlen(line
);
974 for (i
= 0; i
< len
; i
++)
975 if (line
[i
] != ' ' && line
[i
] != '\t' &&
976 line
[i
] != '\n' && line
[i
] != '\r' &&
977 line
[i
] != '\f' && line
[i
] != '\0')