ba744bff2da640eed755fe14775e4f72b849766f
[paraslash.git] / string.c
1 /*
2  * Copyright (C) 2004-2013 Andre Noll <maan@systemlinux.org>
3  *
4  * Licensed under the GPL v2. For licencing details see COPYING.
5  */
6
7 /** \file string.c Memory allocation and string handling functions. */
8
9 #include <sys/time.h> /* gettimeofday */
10 #include <pwd.h>
11 #include <sys/utsname.h> /* uname() */
12 #include <string.h>
13 #include <regex.h>
14
15 #include "para.h"
16 #include "string.h"
17 #include "error.h"
18
19 /**
20  * Paraslash's version of realloc().
21  *
22  * \param p Pointer to the memory block, may be \p NULL.
23  * \param size The desired new size.
24  *
25  * A wrapper for realloc(3). It calls \p exit(\p EXIT_FAILURE) on errors,
26  * i.e. there is no need to check the return value in the caller.
27  *
28  * \return A pointer to  the newly allocated memory, which is suitably aligned
29  * for any kind of variable and may be different from \a p.
30  *
31  * \sa realloc(3).
32  */
33 __must_check __malloc void *para_realloc(void *p, size_t size)
34 {
35         /*
36          * No need to check for NULL pointers: If p is NULL, the call
37          * to realloc is equivalent to malloc(size)
38          */
39         assert(size);
40         if (!(p = realloc(p, size))) {
41                 PARA_EMERG_LOG("realloc failed (size = %zu), aborting\n",
42                         size);
43                 exit(EXIT_FAILURE);
44         }
45         return p;
46 }
47
48 /**
49  * Paraslash's version of malloc().
50  *
51  * \param size The desired new size.
52  *
53  * A wrapper for malloc(3) which exits on errors.
54  *
55  * \return A pointer to the allocated memory, which is suitably aligned for any
56  * kind of variable.
57  *
58  * \sa malloc(3).
59  */
60 __must_check __malloc void *para_malloc(size_t size)
61 {
62         void *p;
63
64         assert(size);
65         p = malloc(size);
66         if (!p) {
67                 PARA_EMERG_LOG("malloc failed (size = %zu), aborting\n",
68                         size);
69                 exit(EXIT_FAILURE);
70         }
71         return p;
72 }
73
74 /**
75  * Paraslash's version of calloc().
76  *
77  * \param size The desired new size.
78  *
79  * A wrapper for calloc(3) which exits on errors.
80  *
81  * \return A pointer to the allocated and zeroed-out memory, which is suitably
82  * aligned for any kind of variable.
83  *
84  * \sa calloc(3)
85  */
86 __must_check __malloc void *para_calloc(size_t size)
87 {
88         void *ret = para_malloc(size);
89
90         memset(ret, 0, size);
91         return ret;
92 }
93
94 /**
95  * Paraslash's version of strdup().
96  *
97  * \param s The string to be duplicated.
98  *
99  * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e.
100  * there is no need to check the return value in the caller.
101  *
102  * \return A pointer to the duplicated string. If \a s was the \p NULL pointer,
103  * an pointer to an empty string is returned.
104  *
105  * \sa strdup(3)
106  */
107 __must_check __malloc char *para_strdup(const char *s)
108 {
109         char *ret;
110
111         if ((ret = strdup(s? s: "")))
112                 return ret;
113         PARA_EMERG_LOG("strdup failed, aborting\n");
114         exit(EXIT_FAILURE);
115 }
116
117 /**
118  * Print a formated message to a dynamically allocated string.
119  *
120  * \param result The formated string is returned here.
121  * \param fmt The format string.
122  * \param ap Initialized list of arguments.
123  *
124  * This function is similar to vasprintf(), a GNU extension which is not in C
125  * or POSIX. It allocates a string large enough to hold the output including
126  * the terminating null byte. The allocated string is returned via the first
127  * argument and must be freed by the caller. However, unlike vasprintf(), this
128  * function calls exit() if insufficient memory is available, while vasprintf()
129  * returns -1 in this case.
130  *
131  * \return Number of bytes written, not including the terminating \p NULL
132  * character.
133  *
134  * \sa printf(3), vsnprintf(3), va_start(3), vasprintf(3), \ref xasprintf().
135  */
136 __printf_2_0 unsigned xvasprintf(char **result, const char *fmt, va_list ap)
137 {
138         int ret;
139         size_t size;
140         va_list aq;
141
142         va_copy(aq, ap);
143         ret = vsnprintf(NULL, 0, fmt, aq);
144         va_end(aq);
145         assert(ret >= 0);
146         size = ret + 1;
147         *result = para_malloc(size);
148         va_copy(aq, ap);
149         ret = vsnprintf(*result, size, fmt, aq);
150         va_end(aq);
151         assert(ret >= 0 && ret < size);
152         return ret;
153 }
154
155 /**
156  * Print to a dynamically allocated string, variable number of arguments.
157  *
158  * \param result See \ref xvasprintf().
159  * \param fmt Usual format string.
160  *
161  * \return The return value of the underlying call to \ref xvasprintf().
162  *
163  * \sa \ref xvasprintf() and the references mentioned there.
164  */
165 __printf_2_3 unsigned xasprintf(char **result, const char *fmt, ...)
166 {
167         va_list ap;
168         unsigned ret;
169
170         va_start(ap, fmt);
171         ret = xvasprintf(result, fmt, ap);
172         va_end(ap);
173         return ret;
174 }
175
176 /**
177  * Allocate a sufficiently large string and print into it.
178  *
179  * \param fmt A usual format string.
180  *
181  * Produce output according to \p fmt. No artificial bound on the length of the
182  * resulting string is imposed.
183  *
184  * \return This function either returns a pointer to a string that must be
185  * freed by the caller or aborts without returning.
186  *
187  * \sa printf(3), xasprintf().
188  */
189 __must_check __printf_1_2 __malloc char *make_message(const char *fmt, ...)
190 {
191         char *msg;
192         va_list ap;
193
194         va_start(ap, fmt);
195         xvasprintf(&msg, fmt, ap);
196         va_end(ap);
197         return msg;
198 }
199
200 /**
201  * Free the content of a pointer and set it to \p NULL.
202  *
203  * This is equivalent to "free(*arg); *arg = NULL;".
204  *
205  * \param arg The pointer whose content should be freed.
206  */
207 void freep(void *arg)
208 {
209         void **ptr = (void **)arg;
210         free(*ptr);
211         *ptr = NULL;
212 }
213
214 /**
215  * Paraslash's version of strcat().
216  *
217  * \param a String to be appended to.
218  * \param b String to append.
219  *
220  * Append \p b to \p a.
221  *
222  * \return If \a a is \p NULL, return a pointer to a copy of \a b, i.e.
223  * para_strcat(NULL, b) is equivalent to para_strdup(b). If \a b is \p NULL,
224  * return \a a without making a copy of \a a.  Otherwise, construct the
225  * concatenation \a c, free \a a (but not \a b) and return \a c.
226  *
227  * \sa strcat(3)
228  */
229 __must_check __malloc char *para_strcat(char *a, const char *b)
230 {
231         char *tmp;
232
233         if (!a)
234                 return para_strdup(b);
235         if (!b)
236                 return a;
237         tmp = make_message("%s%s", a, b);
238         free(a);
239         return tmp;
240 }
241
242 /**
243  * Paraslash's version of dirname().
244  *
245  * \param name Pointer to the full path.
246  *
247  * Compute the directory component of \p name.
248  *
249  * \return If \a name is \p NULL or the empty string, return \p NULL.
250  * Otherwise, Make a copy of \a name and return its directory component. Caller
251  * is responsible to free the result.
252  */
253 __must_check __malloc char *para_dirname(const char *name)
254 {
255         char *p, *ret;
256
257         if (!name || !*name)
258                 return NULL;
259         ret = para_strdup(name);
260         p = strrchr(ret, '/');
261         if (!p)
262                 *ret = '\0';
263         else
264                 *p = '\0';
265         return ret;
266 }
267
268 /**
269  * Paraslash's version of basename().
270  *
271  * \param name Pointer to the full path.
272  *
273  * Compute the filename component of \a name.
274  *
275  * \return \p NULL if (a) \a name is the empty string or \p NULL, or (b) name
276  * ends with a slash.  Otherwise, a pointer within \a name is returned.  Caller
277  * must not free the result.
278  */
279 __must_check char *para_basename(const char *name)
280 {
281         char *ret;
282
283         if (!name || !*name)
284                 return NULL;
285         ret = strrchr(name, '/');
286         if (!ret)
287                 return (char *)name;
288         ret++;
289         return ret;
290 }
291
292 /**
293  * Cut trailing newline.
294  *
295  * \param buf The string to be chopped.
296  *
297  * Replace the last character in \p buf by zero if it is equal to
298  * the newline character.
299  */
300 void chop(char *buf)
301 {
302         int n = strlen(buf);
303
304         if (!n)
305                 return;
306         if (buf[n - 1] == '\n')
307                 buf[n - 1] = '\0';
308 }
309
310 /**
311  * Get the logname of the current user.
312  *
313  * \return A dynamically allocated string that must be freed by the caller. On
314  * errors, the string "unknown_user" is returned, i.e. this function never
315  * returns \p NULL.
316  *
317  * \sa getpwuid(3).
318  */
319 __must_check __malloc char *para_logname(void)
320 {
321         struct passwd *pw = getpwuid(getuid());
322         return para_strdup(pw? pw->pw_name : "unknown_user");
323 }
324
325 /**
326  * Get the home directory of the current user.
327  *
328  * \return A dynamically allocated string that must be freed by the caller. If
329  * the home directory could not be found, this function returns "/tmp".
330  */
331 __must_check __malloc char *para_homedir(void)
332 {
333         struct passwd *pw = getpwuid(getuid());
334         return para_strdup(pw? pw->pw_dir : "/tmp");
335 }
336
337 /**
338  * Get the own hostname.
339  *
340  * \return A dynamically allocated string containing the hostname.
341  *
342  * \sa uname(2).
343  */
344 __malloc char *para_hostname(void)
345 {
346         struct utsname u;
347
348         uname(&u);
349         return para_strdup(u.nodename);
350 }
351
352 /**
353  * Call a custom function for each complete line.
354  *
355  * \param flags Any combination of flags defined in \ref for_each_line_flags.
356  * \param buf The buffer containing data separated by newlines.
357  * \param size The number of bytes in \a buf.
358  * \param line_handler The custom function.
359  * \param private_data Pointer passed to \a line_handler.
360  *
361  * For each complete line in \p buf, \p line_handler is called. The first
362  * argument to \p line_handler is (a copy of) the current line, and \p
363  * private_data is passed as the second argument.  If the \p FELF_READ_ONLY
364  * flag is unset, a pointer into \a buf is passed to the line handler,
365  * otherwise a pointer to a copy of the current line is passed instead. This
366  * copy is freed immediately after the line handler returns.
367  *
368  * The function returns if \p line_handler returns a negative value or no more
369  * lines are in the buffer.  The rest of the buffer (last chunk containing an
370  * incomplete line) is moved to the beginning of the buffer if FELF_READ_ONLY is
371  * unset.
372  *
373  * \return On success this function returns the number of bytes not handled to
374  * \p line_handler. The only possible error is a negative return value from the
375  * line handler. In this case processing stops and the return value of the line
376  * handler is returned to indicate failure.
377  *
378  * \sa \ref for_each_line_flags.
379  */
380 int for_each_line(unsigned flags, char *buf, size_t size,
381                 line_handler_t *line_handler, void *private_data)
382 {
383         char *start = buf, *end;
384         int ret, i, num_lines = 0;
385
386 //      PARA_NOTICE_LOG("buf: %s\n", buf);
387         while (start < buf + size) {
388                 char *next_null;
389                 char *next_cr;
390
391                 next_cr = memchr(start, '\n', buf + size - start);
392                 next_null = memchr(start, '\0', buf + size - start);
393                 if (!next_cr && !next_null)
394                         break;
395                 if (next_cr && next_null) {
396                         end = next_cr < next_null? next_cr : next_null;
397                 } else if (next_null) {
398                         end = next_null;
399                 } else
400                         end = next_cr;
401                 num_lines++;
402                 if (!(flags & FELF_DISCARD_FIRST) || start != buf) {
403                         if (flags & FELF_READ_ONLY) {
404                                 size_t s = end - start;
405                                 char *b = para_malloc(s + 1);
406                                 memcpy(b, start, s);
407                                 b[s] = '\0';
408                                 ret = line_handler(b, private_data);
409                                 free(b);
410                         } else {
411                                 *end = '\0';
412                                 ret = line_handler(start, private_data);
413                         }
414                         if (ret < 0)
415                                 return ret;
416                 }
417                 start = ++end;
418         }
419         i = buf + size - start;
420         if (i && i != size && !(flags & FELF_READ_ONLY))
421                 memmove(buf, start, i);
422         return i;
423 }
424
425 /** Return the hex characters of the lower 4 bits. */
426 #define hex(a) (hexchar[(a) & 15])
427
428 static void write_size_header(char *buf, int n)
429 {
430         static char hexchar[] = "0123456789abcdef";
431
432         buf[0] = hex(n >> 12);
433         buf[1] = hex(n >> 8);
434         buf[2] = hex(n >> 4);
435         buf[3] = hex(n);
436         buf[4] = ' ';
437 }
438
439 /**
440  * Read a four-byte hex-number and return its value.
441  *
442  * Each status item sent by para_server is prefixed with such a hex number in
443  * ASCII which describes the size of the status item.
444  *
445  * \param buf The buffer which must be at least four bytes long.
446  *
447  * \return The value of the hex number on success, \p -E_SIZE_PREFIX if the
448  * buffer did not contain only hex digits.
449  */
450 int read_size_header(const char *buf)
451 {
452         int i, len = 0;
453
454         for (i = 0; i < 4; i++) {
455                 unsigned char c = buf[i];
456                 len <<= 4;
457                 if (c >= '0' && c <= '9') {
458                         len += c - '0';
459                         continue;
460                 }
461                 if (c >= 'a' && c <= 'f') {
462                         len += c - 'a' + 10;
463                         continue;
464                 }
465                 return -E_SIZE_PREFIX;
466         }
467         if (buf[4] != ' ')
468                 return -E_SIZE_PREFIX;
469         return len;
470 }
471
472 /**
473  * Safely print into a buffer at a given offset.
474  *
475  * \param b Determines the buffer, its size, and the offset.
476  * \param fmt The format string.
477  *
478  * This function prints into the buffer given by \a b at the offset which is
479  * also given by \a b. If there is not enough space to hold the result, the
480  * buffer size is doubled until the underlying call to vsnprintf() succeeds
481  * or the size of the buffer exceeds the maximal size specified in \a b.
482  *
483  * In the latter case the unmodified \a buf and \a offset values as well as the
484  * private_data pointer of \a b are passed to the \a max_size_handler of \a b.
485  * If this function succeeds, i.e. returns a non-negative value, the offset of
486  * \a b is reset to zero and the given data is written to the beginning of the
487  * buffer. If \a max_size_handler() returns a negative value, this value is
488  * returned by \a para_printf().
489  *
490  * Upon return, the offset of \a b is adjusted accordingly so that subsequent
491  * calls to this function append data to what is already contained in the
492  * buffer.
493  *
494  * It's OK to call this function with \p b->buf being \p NULL. In this case, an
495  * initial buffer is allocated.
496  *
497  * \return The number of bytes printed into the buffer (not including the
498  * terminating \p NULL byte) on success, negative on errors. If there is no
499  * size-bound on \a b, i.e. if \p b->max_size is zero, this function never
500  * fails.
501  *
502  * \sa make_message(), vsnprintf(3).
503  */
504 __printf_2_3 int para_printf(struct para_buffer *b, const char *fmt, ...)
505 {
506         int ret, sz_off = (b->flags & PBF_SIZE_PREFIX)? 5 : 0;
507
508         if (!b->buf) {
509                 b->buf = para_malloc(128);
510                 b->size = 128;
511                 b->offset = 0;
512         }
513         while (1) {
514                 char *p = b->buf + b->offset;
515                 size_t size = b->size - b->offset;
516                 va_list ap;
517
518                 if (size > sz_off) {
519                         va_start(ap, fmt);
520                         ret = vsnprintf(p + sz_off, size - sz_off, fmt, ap);
521                         va_end(ap);
522                         if (ret > -1 && ret < size - sz_off) { /* success */
523                                 b->offset += ret + sz_off;
524                                 if (sz_off)
525                                         write_size_header(p, ret);
526                                 return ret + sz_off;
527                         }
528                 }
529                 /* check if we may grow the buffer */
530                 if (!b->max_size || 2 * b->size < b->max_size) { /* yes */
531                         /* try again with more space */
532                         b->size *= 2;
533                         b->buf = para_realloc(b->buf, b->size);
534                         continue;
535                 }
536                 /* can't grow buffer */
537                 if (!b->offset || !b->max_size_handler) /* message too large */
538                         return -ERRNO_TO_PARA_ERROR(ENOSPC);
539                 ret = b->max_size_handler(b->buf, b->offset, b->private_data);
540                 if (ret < 0)
541                         return ret;
542                 b->offset = 0;
543         }
544 }
545
546 /** \cond llong_minmax */
547 /* LLONG_MAX and LLONG_MIN might not be defined. */
548 #ifndef LLONG_MAX
549 #define LLONG_MAX 9223372036854775807LL
550 #endif
551 #ifndef LLONG_MIN
552 #define LLONG_MIN (-LLONG_MAX - 1LL)
553 #endif
554 /** \endcond llong_minmax */
555
556 /**
557  * Convert a string to a 64-bit signed integer value.
558  *
559  * \param str The string to be converted.
560  * \param value Result pointer.
561  *
562  * \return Standard.
563  *
564  * \sa para_atoi32(), strtol(3), atoi(3).
565  */
566 int para_atoi64(const char *str, int64_t *value)
567 {
568         char *endptr;
569         long long tmp;
570
571         errno = 0; /* To distinguish success/failure after call */
572         tmp = strtoll(str, &endptr, 10);
573         if (errno == ERANGE && (tmp == LLONG_MAX || tmp == LLONG_MIN))
574                 return -E_ATOI_OVERFLOW;
575         if (errno != 0 && tmp == 0) /* other error */
576                 return -E_STRTOLL;
577         if (endptr == str)
578                 return -E_ATOI_NO_DIGITS;
579         if (*endptr != '\0') /* Further characters after number */
580                 return -E_ATOI_JUNK_AT_END;
581         *value = tmp;
582         return 1;
583 }
584
585 /**
586  * Convert a string to a 32-bit signed integer value.
587  *
588  * \param str The string to be converted.
589  * \param value Result pointer.
590  *
591  * \return Standard.
592  *
593  * \sa para_atoi64().
594 */
595 int para_atoi32(const char *str, int32_t *value)
596 {
597         int64_t tmp;
598         int ret;
599         const int32_t max = 2147483647;
600
601         ret = para_atoi64(str, &tmp);
602         if (ret < 0)
603                 return ret;
604         if (tmp > max || tmp < -max - 1)
605                 return -E_ATOI_OVERFLOW;
606         *value = tmp;
607         return 1;
608 }
609
610 static inline int loglevel_equal(const char *arg, const char * const ll)
611 {
612         return !strncasecmp(arg, ll, strlen(ll));
613 }
614
615 /**
616  * Compute the loglevel number from its name.
617  *
618  * \param txt The name of the loglevel (debug, info, ...).
619  *
620  * \return The numeric representation of the loglevel name.
621  */
622 int get_loglevel_by_name(const char *txt)
623 {
624         if (loglevel_equal(txt, "debug"))
625                 return LL_DEBUG;
626         if (loglevel_equal(txt, "info"))
627                 return LL_INFO;
628         if (loglevel_equal(txt, "notice"))
629                 return LL_NOTICE;
630         if (loglevel_equal(txt, "warning"))
631                 return LL_WARNING;
632         if (loglevel_equal(txt, "error"))
633                 return LL_ERROR;
634         if (loglevel_equal(txt, "crit"))
635                 return LL_CRIT;
636         if (loglevel_equal(txt, "emerg"))
637                 return LL_EMERG;
638         return -1;
639 }
640
641 static int get_next_word(const char *buf, const char *delim, char **word)
642 {
643         enum line_state_flags {LSF_HAVE_WORD = 1, LSF_BACKSLASH = 2,
644                 LSF_SINGLE_QUOTE = 4, LSF_DOUBLE_QUOTE = 8};
645         const char *in;
646         char *out;
647         int ret, state = 0;
648
649         out = para_malloc(strlen(buf) + 1);
650         *out = '\0';
651         *word = out;
652         for (in = buf; *in; in++) {
653                 const char *p;
654
655                 switch (*in) {
656                 case '\\':
657                         if (state & LSF_BACKSLASH) /* \\ */
658                                 goto copy_char;
659                         state |= LSF_BACKSLASH;
660                         state |= LSF_HAVE_WORD;
661                         continue;
662                 case 'n':
663                 case 't':
664                         if (state & LSF_BACKSLASH) { /* \n or \t */
665                                 *out++ = (*in == 'n')? '\n' : '\t';
666                                 state &= ~LSF_BACKSLASH;
667                                 continue;
668                         }
669                         goto copy_char;
670                 case '"':
671                         if (state & LSF_BACKSLASH) /* \" */
672                                 goto copy_char;
673                         if (state & LSF_SINGLE_QUOTE) /* '" */
674                                 goto copy_char;
675                         if (state & LSF_DOUBLE_QUOTE) {
676                                 state &= ~LSF_DOUBLE_QUOTE;
677                                 continue;
678                         }
679                         state |= LSF_HAVE_WORD;
680                         state |= LSF_DOUBLE_QUOTE;
681                         continue;
682                 case '\'':
683                         if (state & LSF_BACKSLASH) /* \' */
684                                 goto copy_char;
685                         if (state & LSF_DOUBLE_QUOTE) /* "' */
686                                 goto copy_char;
687                         if (state & LSF_SINGLE_QUOTE) {
688                                 state &= ~LSF_SINGLE_QUOTE;
689                                 continue;
690                         }
691                         state |= LSF_HAVE_WORD;
692                         state |= LSF_SINGLE_QUOTE;
693                         continue;
694                 }
695                 for (p = delim; *p; p++) {
696                         if (*in != *p)
697                                 continue;
698                         if (state & LSF_BACKSLASH)
699                                 goto copy_char;
700                         if (state & LSF_SINGLE_QUOTE)
701                                 goto copy_char;
702                         if (state & LSF_DOUBLE_QUOTE)
703                                 goto copy_char;
704                         if (state & LSF_HAVE_WORD)
705                                 goto success;
706                         break;
707                 }
708                 if (*p) /* ignore delimiter at the beginning */
709                         continue;
710 copy_char:
711                 state |= LSF_HAVE_WORD;
712                 *out++ = *in;
713                 state &= ~LSF_BACKSLASH;
714         }
715         ret = 0;
716         if (!(state & LSF_HAVE_WORD))
717                 goto out;
718         ret = -ERRNO_TO_PARA_ERROR(EINVAL);
719         if (state & LSF_BACKSLASH) {
720                 PARA_ERROR_LOG("trailing backslash\n");
721                 goto out;
722         }
723         if ((state & LSF_SINGLE_QUOTE) || (state & LSF_DOUBLE_QUOTE)) {
724                 PARA_ERROR_LOG("unmatched quote character\n");
725                 goto out;
726         }
727 success:
728         *out = '\0';
729         return in - buf;
730 out:
731         free(*word);
732         *word = NULL;
733         return ret;
734 }
735
736 /**
737  * Get the number of the word the cursor is on.
738  *
739  * \param buf The zero-terminated line buffer.
740  * \param delim Characters that separate words.
741  * \param point The cursor position.
742  *
743  * \return Zero-based word number.
744  */
745 int compute_word_num(const char *buf, const char *delim, int point)
746 {
747         int ret, num_words;
748         const char *p;
749         char *word;
750
751         for (p = buf, num_words = 0; ; p += ret, num_words++) {
752                 ret = get_next_word(p, delim, &word);
753                 if (ret <= 0)
754                         break;
755                 free(word);
756                 if (p + ret >= buf + point)
757                         break;
758         }
759         return num_words;
760 }
761
762 /**
763  * Free an array of words created by create_argv() or create_shifted_argv().
764  *
765  * \param argv A pointer previously obtained by \ref create_argv().
766  */
767 void free_argv(char **argv)
768 {
769         int i;
770
771         if (!argv)
772                 return;
773         for (i = 0; argv[i]; i++)
774                 free(argv[i]);
775         free(argv);
776 }
777
778 static int create_argv_offset(int offset, const char *buf, const char *delim,
779                 char ***result)
780 {
781         char *word, **argv = para_malloc((offset + 1) * sizeof(char *));
782         const char *p;
783         int i, ret;
784
785         for (i = 0; i < offset; i++)
786                 argv[i] = NULL;
787         for (p = buf; p && *p; p += ret, i++) {
788                 ret = get_next_word(p, delim, &word);
789                 if (ret < 0)
790                         goto err;
791                 if (!ret)
792                         break;
793                 argv = para_realloc(argv, (i + 2) * sizeof(char*));
794                 argv[i] = word;
795         }
796         argv[i] = NULL;
797         *result = argv;
798         return i;
799 err:
800         while (i > 0)
801                 free(argv[--i]);
802         free(argv);
803         *result = NULL;
804         return ret;
805 }
806
807 /**
808  * Split a buffer into words.
809  *
810  * This parser honors single and double quotes, backslash-escaped characters
811  * and special characters like \p \\n. The result contains pointers to copies
812  * of the words contained in \a buf and has to be freed by using \ref
813  * free_argv().
814  *
815  * \param buf The buffer to be split.
816  * \param delim Each character in this string is treated as a separator.
817  * \param result The array of words is returned here.
818  *
819  * \return Number of words in \a buf, negative on errors.
820  */
821 int create_argv(const char *buf, const char *delim, char ***result)
822 {
823         return create_argv_offset(0, buf, delim, result);
824 }
825
826 /**
827  * Split a buffer into words, offset one.
828  *
829  * This is similar to \ref create_argv() but the returned array is one element
830  * larger, words start at index one and element zero is initialized to \p NULL.
831  * Callers must set element zero to a non-NULL value before calling free_argv()
832  * on the returned array to avoid a memory leak.
833  *
834  * \param buf See \ref create_argv().
835  * \param delim See \ref create_argv().
836  * \param result See \ref create_argv().
837  *
838  * \return Number of words plus one on success, negative on errors.
839  */
840 int create_shifted_argv(const char *buf, const char *delim, char ***result)
841 {
842         return create_argv_offset(1, buf, delim, result);
843 }
844
845 /**
846  * Find out if the given string is contained in the arg vector.
847  *
848  * \param arg The string to look for.
849  * \param argv The array to search.
850  *
851  * \return The first index whose value equals \a arg, or \p -E_ARG_NOT_FOUND if
852  * arg was not found in \a argv.
853  */
854 int find_arg(const char *arg, char **argv)
855 {
856         int i;
857
858         if (!argv)
859                 return -E_ARG_NOT_FOUND;
860         for (i = 0; argv[i]; i++)
861                 if (strcmp(arg, argv[i]) == 0)
862                         return i;
863         return -E_ARG_NOT_FOUND;
864 }
865
866 /**
867  * Compile a regular expression.
868  *
869  * This simple wrapper calls regcomp() and logs a message on errors.
870  *
871  * \param preg See regcomp(3).
872  * \param regex See regcomp(3).
873  * \param cflags See regcomp(3).
874  *
875  * \return Standard.
876  */
877 int para_regcomp(regex_t *preg, const char *regex, int cflags)
878 {
879         char *buf;
880         size_t size;
881         int ret = regcomp(preg, regex, cflags);
882
883         if (ret == 0)
884                 return 1;
885         size = regerror(ret, preg, NULL, 0);
886         buf = para_malloc(size);
887         regerror(ret, preg, buf, size);
888         PARA_ERROR_LOG("%s\n", buf);
889         free(buf);
890         return -E_REGEX;
891 }
892
893 /**
894  * strdup() for not necessarily zero-terminated strings.
895  *
896  * \param src The source buffer.
897  * \param len The number of bytes to be copied.
898  *
899  * \return A 0-terminated buffer of length \a len + 1.
900  *
901  * This is similar to strndup(), which is a GNU extension. However, one
902  * difference is that strndup() returns \p NULL if insufficient memory was
903  * available while this function aborts in this case.
904  *
905  * \sa strdup(), \ref para_strdup().
906  */
907 char *safe_strdup(const char *src, size_t len)
908 {
909         char *p;
910
911         assert(len < (size_t)-1);
912         p = para_malloc(len + 1);
913         if (len > 0)
914                 memcpy(p, src, len);
915         p[len] = '\0';
916         return p;
917 }
918
919 /**
920  * Copy the value of a key=value pair.
921  *
922  * This checks whether the given buffer starts with "key=", ignoring case. If
923  * yes, a copy of the value is returned. The source buffer may not be
924  * zero-terminated.
925  *
926  * \param src The source buffer.
927  * \param len The number of bytes of the tag.
928  * \param key Only copy if it is the value of this key.
929  *
930  * \return A zero-terminated buffer, or \p NULL if the key was
931  * not of the given type.
932  */
933 char *key_value_copy(const char *src, size_t len, const char *key)
934 {
935         int keylen = strlen(key);
936
937         if (len <= keylen)
938                 return NULL;
939         if (strncasecmp(src, key, keylen))
940                 return NULL;
941         if (src[keylen] != '=')
942                 return NULL;
943         return safe_strdup(src + keylen + 1, len - keylen - 1);
944 }