string.c

   1 /*
   2  * Copyright (C) 2004-2008 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 "para.h"
  10 #include "string.h"
  11
  12 #include <sys/time.h> /* gettimeofday */
  13 #include <pwd.h>
  14 #include <sys/utsname.h> /* uname() */
  15 #include <string.h>
  16
  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         assert(size);
  63         void *p = malloc(size);
  64
  65         if (!p) {
  66                 PARA_EMERG_LOG("malloc failed (size = %zu),  aborting\n",
  67                         size);
  68                 exit(EXIT_FAILURE);
  69         }
  70         return p;
  71 }
  72
  73 /**
  74  * Paraslash's version of calloc().
  75  *
  76  * \param size The desired new size.
  77  *
  78  * A wrapper for calloc(3) which exits on errors.
  79  *
  80  * \return A pointer to the allocated and zeroed-out memory, which is suitably
  81  * aligned for any kind of variable.
  82  *
  83  * \sa calloc(3)
  84  */
  85 __must_check __malloc void *para_calloc(size_t size)
  86 {
  87         void *ret = para_malloc(size);
  88
  89         memset(ret, 0, size);
  90         return ret;
  91 }
  92
  93 /**
  94  * Pparaslash's version of strdup().
  95  *
  96  * \param s The string to be duplicated.
  97  *
  98  * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e.
  99  * there is no need to check the return value in the caller.
 100  *
 101  * \return A pointer to the duplicated string. If \p s was the NULL pointer,
 102  * an pointer to an empty string is returned.
 103  *
 104  * \sa strdup(3)
 105  */
 106 __must_check __malloc char *para_strdup(const char *s)
 107 {
 108         char *ret;
 109
 110         if ((ret = strdup(s? s: "")))
 111                 return ret;
 112         PARA_EMERG_LOG("strdup failed, aborting\n");
 113         exit(EXIT_FAILURE);
 114 }
 115
 116 /**
 117  * Allocate a sufficiently large string and print into it.
 118  *
 119  * \param fmt A usual format string.
 120  *
 121  * Produce output according to \p fmt. No artificial bound on the length of the
 122  * resulting string is imposed.
 123  *
 124  * \return This function either returns a pointer to a string that must be
 125  * freed by the caller or aborts without returning.
 126  *
 127  * \sa printf(3).
 128  */
 129 __must_check __printf_1_2 __malloc char *make_message(const char *fmt, ...)
 130 {
 131         char *msg;
 132
 133         PARA_VSPRINTF(fmt, msg);
 134         return msg;
 135 }
 136
 137 /**
 138  * Paraslash's version of strcat().
 139  *
 140  * \param a String to be appended to.
 141  * \param b String to append.
 142  *
 143  * Append \p b to \p a.
 144  *
 145  * \return If \a a is \p NULL, return a pointer to a copy of \a b, i.e.
 146  * para_strcat(NULL, b) is equivalent to para_strdup(b). If \a b is \p NULL,
 147  * return \a a without making a copy of \a a.  Otherwise, construct the
 148  * concatenation \a c, free \a a (but not \a b) and return \a c.
 149  *
 150  * \sa strcat(3)
 151  */
 152 __must_check __malloc char *para_strcat(char *a, const char *b)
 153 {
 154         char *tmp;
 155
 156         if (!a)
 157                 return para_strdup(b);
 158         if (!b)
 159                 return a;
 160         tmp = make_message("%s%s", a, b);
 161         free(a);
 162         return tmp;
 163 }
 164
 165 /**
 166  * Paraslash's version of dirname().
 167  *
 168  * \param name Pointer to the full path.
 169  *
 170  * Compute the directory component of \p name.
 171  *
 172  * \return If \a name is \p NULL or the empty string, return \p NULL.
 173  * Otherwise, Make a copy of \a name and return its directory component. Caller
 174  * is responsible to free the result.
 175  */
 176 __must_check __malloc char *para_dirname(const char *name)
 177 {
 178         char *p, *ret;
 179
 180         if (!name || !*name)
 181                 return NULL;
 182         ret = para_strdup(name);
 183         p = strrchr(ret, '/');
 184         if (!p)
 185                 *ret = '\0';
 186         else
 187                 *p = '\0';
 188         return ret;
 189 }
 190
 191 /**
 192  * Paraslash's version of basename().
 193  *
 194  * \param name Pointer to the full path.
 195  *
 196  * Compute the filename component of \a name.
 197  *
 198  * \return \p NULL if (a) \a name is the empty string or \p NULL, or (b) name
 199  * ends with a slash.  Otherwise, a pointer within \a name is returned.  Caller
 200  * must not free the result.
 201  */
 202 __must_check const char *para_basename(const char *name)
 203 {
 204         const char *ret;
 205
 206         if (!name || !*name)
 207                 return NULL;
 208         ret = strrchr(name, '/');
 209         if (!ret)
 210                 return name;
 211         ret++;
 212         return ret;
 213 }
 214
 215 /**
 216  * Cut trailing newline.
 217  *
 218  * \param buf The string to be chopped.
 219  *
 220  * Replace the last character in \p buf by zero if it is euqal to
 221  * the newline character.
 222  */
 223 void chop(char *buf)
 224 {
 225         int n = strlen(buf);
 226         if (!n)
 227                 return;
 228         if (buf[n - 1] == '\n')
 229                 buf[n - 1] = '\0';
 230 }
 231
 232 /**
 233  * Get a random filename.
 234  *
 235  * This is by no means a secure way to create temporary files in a hostile
 236  * direcory like \p /tmp. However, it is OK to use for temp files, fifos,
 237  * sockets that are created in ~/.paraslash. Result must be freed by the
 238  * caller.
 239  *
 240  * \return A pointer to a random filename.
 241  */
 242 __must_check __malloc char *para_tmpname(void)
 243 {
 244         struct timeval now;
 245         unsigned int seed;
 246
 247         gettimeofday(&now, NULL);
 248         seed = now.tv_usec;
 249         srand(seed);
 250         return make_message("%08i", rand());
 251 }
 252
 253 /**
 254  * Create unique temporary file.
 255  *
 256  * \param template The template to be passed to mkstemp().
 257  * \param mode The desired mode of the tempfile.
 258  *
 259  * This wrapper for mkstemp additionally uses fchmod() to
 260  * set the given mode of the tempfile if mkstemp() returned success.
 261  *
 262  * \return The file descriptor of the temp file just created on success.
 263  * On errors, a negative value is returned.
 264  */
 265 __must_check int para_mkstemp(char *template, mode_t mode)
 266 {
 267         int tmp, fd = mkstemp(template);
 268
 269         if (fd < 0)
 270                 return -ERRNO_TO_PARA_ERROR(errno);
 271         tmp = fchmod(fd, mode);
 272         if (tmp >= 0)
 273                 return fd;
 274         tmp = errno;
 275         close(fd);
 276         unlink(template);
 277         return -ERRNO_TO_PARA_ERROR(tmp);
 278 }
 279
 280 /**
 281  * Get the logname of the current user.
 282  *
 283  * \return A dynammically allocated string that must be freed by the caller. On
 284  * errors, the string "unknown user" is returned, i.e. this function never
 285  * returns \p NULL.
 286  *
 287  * \sa getpwuid(3).
 288  */
 289 __must_check __malloc char *para_logname(void)
 290 {
 291         struct passwd *pw = getpwuid(getuid());
 292         return para_strdup(pw? pw->pw_name : "unknown_user");
 293 }
 294
 295 /**
 296  * Get the home directory of the current user.
 297  *
 298  * \return A dynammically allocated string that must be freed by the caller. If
 299  * the home directory could not be found, this function returns "/tmp".
 300  */
 301 __must_check __malloc char *para_homedir(void)
 302 {
 303         struct passwd *pw = getpwuid(getuid());
 304         return para_strdup(pw? pw->pw_dir : "/tmp");
 305 }
 306
 307 /**
 308  * Split string and return pointers to its parts.
 309  *
 310  * \param args The string to be split.
 311  * \param argv_ptr Pointer to the list of substrings.
 312  * \param delim Delimiter.
 313  *
 314  * This function modifies \a args by replacing each occurance of \a delim by
 315  * zero. A \p NULL-terminated array of pointers to char* is allocated dynamically
 316  * and these pointers are initialized to point to the broken-up substrings
 317  * within \a args. A pointer to this array is returned via \a argv_ptr.
 318  *
 319  * \return The number of substrings found in \a args.
 320  */
 321 __must_check unsigned split_args(char *args, char *** const argv_ptr, const char *delim)
 322 {
 323         char *p = args;
 324         char **argv;
 325         size_t n = 0, i, j;
 326
 327         p = args + strspn(args, delim);
 328         for (;;) {
 329                 i = strcspn(p, delim);
 330                 if (!i)
 331                         break;
 332                 p += i;
 333                 n++;
 334                 p += strspn(p, delim);
 335         }
 336         *argv_ptr = para_malloc((n + 1) * sizeof(char *));
 337         argv = *argv_ptr;
 338         i = 0;
 339         p = args + strspn(args, delim);
 340         while (p) {
 341                 argv[i] = p;
 342                 j = strcspn(p, delim);
 343                 if (!j)
 344                         break;
 345                 p += strcspn(p, delim);
 346                 if (*p) {
 347                         *p = '\0';
 348                         p++;
 349                         p += strspn(p, delim);
 350                 }
 351                 i++;
 352         }
 353         argv[n] = NULL;
 354         return n;
 355 }
 356
 357 /**
 358  * Ensure that file descriptors 0, 1, and 2 are valid.
 359  *
 360  * Common approach that opens /dev/null until it gets a file descriptor greater
 361  * than two.
 362  *
 363  * \sa okir's Black Hats Manual.
 364  */
 365 void valid_fd_012(void)
 366 {
 367         while (1) {
 368                 int fd = open("/dev/null", O_RDWR);
 369                 if (fd < 0)
 370                         exit(EXIT_FAILURE);
 371                 if (fd > 2) {
 372                         close(fd);
 373                         break;
 374                 }
 375         }
 376 }
 377
 378 /**
 379  * Get the own hostname.
 380  *
 381  * \return A dynammically allocated string containing the hostname.
 382  *
 383  * \sa uname(2).
 384  */
 385 __malloc char *para_hostname(void)
 386 {
 387         struct utsname u;
 388
 389         uname(&u);
 390         return para_strdup(u.nodename);
 391 }
 392
 393 /**
 394  * Used to distinguish between read-only and read-write mode.
 395  *
 396  * \sa for_each_line(), for_each_line_ro().
 397  */
 398 enum for_each_line_modes{
 399         /** Activate read-only mode. */
 400         LINE_MODE_RO,
 401         /** Activate read-write mode. */
 402         LINE_MODE_RW
 403 };
 404
 405 static int for_each_complete_line(enum for_each_line_modes mode, char *buf,
 406                 size_t size, line_handler_t *line_handler, void *private_data)
 407 {
 408         char *start = buf, *end;
 409         int ret, i, num_lines = 0;
 410
 411 //      PARA_NOTICE_LOG("buf: %s\n", buf);
 412         while (start < buf + size) {
 413                 char *next_null;
 414                 char *next_cr;
 415
 416                 next_cr = memchr(start, '\n', buf + size - start);
 417                 next_null = memchr(start, '\0', buf + size - start);
 418                 if (!next_cr && !next_null)
 419                         break;
 420                 if (next_cr && next_null) {
 421                         end = next_cr < next_null? next_cr : next_null;
 422                 } else if (next_null) {
 423                         end = next_null;
 424                 } else
 425                         end = next_cr;
 426                 num_lines++;
 427                 if (!line_handler) {
 428                         start = ++end;
 429                         continue;
 430                 }
 431                 if (mode == LINE_MODE_RO) {
 432                         size_t s = end - start;
 433                         char *b = para_malloc(s + 1);
 434                         memcpy(b, start, s);
 435                         b[s] = '\0';
 436 //                      PARA_NOTICE_LOG("b: %s, start: %s\n", b, start);
 437                         ret = line_handler(b, private_data);
 438                         free(b);
 439                 } else {
 440                         *end = '\0';
 441                         ret = line_handler(start, private_data);
 442                 }
 443                 if (ret < 0)
 444                         return ret;
 445                 start = ++end;
 446         }
 447         if (!line_handler || mode == LINE_MODE_RO)
 448                 return num_lines;
 449         i = buf + size - start;
 450         if (i && i != size)
 451                 memmove(buf, start, i);
 452         return i;
 453 }
 454
 455 /**
 456  * Call a custom function for each complete line.
 457  *
 458  * \param buf The buffer containing data seperated by newlines.
 459  * \param size The number of bytes in \a buf.
 460  * \param line_handler The custom function.
 461  * \param private_data Pointer passed to \a line_handler.
 462  *
 463  * If \p line_handler is \p NULL, the function returns the number of complete
 464  * lines in \p buf.  Otherwise, \p line_handler is called for each complete
 465  * line in \p buf.  The first argument to \p line_handler is the current line,
 466  * and \p private_data is passed as the second argument.  The function returns
 467  * if \p line_handler returns a negative value or no more lines are in the
 468  * buffer.  The rest of the buffer (last chunk containing an incomplete line)
 469  * is moved to the beginning of the buffer.
 470  *
 471  * \return If \p line_handler is not \p NULL, this function returns the number
 472  * of bytes not handled to \p line_handler on success, or the negative return
 473  * value of the \p line_handler on errors.
 474  *
 475  * \sa for_each_line_ro().
 476  */
 477 int for_each_line(char *buf, size_t size, line_handler_t *line_handler,
 478                 void *private_data)
 479 {
 480         return for_each_complete_line(LINE_MODE_RW, buf, size, line_handler,
 481                 private_data);
 482 }
 483
 484 /**
 485  * Call a custom function for each complete line.
 486  *
 487  * \param buf Same meaning as in \p for_each_line().
 488  * \param size Same meaning as in \p for_each_line().
 489  * \param line_handler Same meaning as in \p for_each_line().
 490  * \param private_data Same meaning as in \p for_each_line().
 491  *
 492  * This function behaves like \p for_each_line(), but \a buf is left unchanged.
 493  *
 494  * \return On success, the function returns the number of complete lines in \p
 495  * buf, otherwise the (negative) return value of \p line_handler is returned.
 496  *
 497  * \sa for_each_line().
 498  */
 499 int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
 500                 void *private_data)
 501 {
 502         return for_each_complete_line(LINE_MODE_RO, buf, size, line_handler,
 503                 private_data);
 504 }
 505
 506 /**
 507  * Safely print into a buffer at a given offset
 508  *
 509  * \param b Determines the buffer, its size, and the offset.
 510  * \param fmt The format string.
 511  *
 512  * This function prints into the buffer given by \a b at the offset which is
 513  * also given by \a b. If there is not enough space to hold the result, the
 514  * buffer size is doubled until the underlying call to vsnprintf() succeeds.
 515  * Upon return, the offset of \a b is adjusted accordingly so that subsequent
 516  * calls to this function append data to what is already contained in the
 517  * buffer.
 518  *
 519  * It's OK to call this function with \p b->buf being \p NULL. In this case, an
 520  * initial buffer is allocated.
 521  *
 522  * \return The number of bytes printed into the buffer (not including the
 523  * therminating \p NULL byte).
 524  *
 525  * \sa make_message(), vsnprintf(3).
 526  */
 527 __printf_2_3 int para_printf(struct para_buffer *b, const char *fmt, ...)
 528 {
 529         int ret;
 530
 531         if (!b->buf) {
 532                 b->buf = para_malloc(128);
 533                 b->size = 128;
 534                 b->offset = 0;
 535         } else if (b->size <= b->offset + 1) {
 536                 b->size *= 2;
 537                 b->buf = para_realloc(b->buf, b->size);
 538         }
 539         while (1) {
 540                 char *p = b->buf + b->offset;
 541                 size_t size = b->size - b->offset;
 542                 va_list ap;
 543                 va_start(ap, fmt);
 544                 ret = vsnprintf(p, size, fmt, ap);
 545                 va_end(ap);
 546                 if (ret > -1 && ret < size) { /* success */
 547                         b->offset += ret;
 548                         break;
 549                 }
 550                 /* try again with more space */
 551                 b->size *= 2;
 552                 b->buf = para_realloc(b->buf, b->size);
 553         }
 554         return ret;
 555 }
 556
 557 /** \cond LLONG_MAX and LLONG_LIN might not be defined. */
 558 #ifndef LLONG_MAX
 559 #define LLONG_MAX (1 << (sizeof(long) - 1))
 560 #endif
 561 #ifndef LLONG_MIN
 562 #define LLONG_MIN (-LLONG_MAX - 1LL)
 563 #endif
 564 /** \endcond */
 565
 566 /**
 567  * Convert a string to a 64-bit signed integer value.
 568  *
 569  * \param str The string to be converted.
 570  * \param value Result pointer.
 571  *
 572  * \return Standard.
 573  *
 574  * \sa para_atoi32(), strtol(3), atoi(3).
 575  */
 576 int para_atoi64(const char *str, int64_t *value)
 577 {
 578         char *endptr;
 579         long long tmp;
 580
 581         errno = 0; /* To distinguish success/failure after call */
 582         tmp = strtoll(str, &endptr, 10);
 583         if (errno == ERANGE && (tmp == LLONG_MAX || tmp == LLONG_MIN))
 584                 return -E_ATOI_OVERFLOW;
 585         if (errno != 0 && tmp == 0) /* other error */
 586                 return -E_STRTOLL;
 587         if (endptr == str)
 588                 return -E_ATOI_NO_DIGITS;
 589         if (*endptr != '\0') /* Further characters after number */
 590                 return -E_ATOI_JUNK_AT_END;
 591         *value = tmp;
 592         return 1;
 593 }
 594
 595 /**
 596  * Convert a string to a 32-bit signed integer value.
 597  *
 598  * \param str The string to be converted.
 599  * \param value Result pointer.
 600  *
 601  * \return Standard.
 602  *
 603  * \sa para_atoi64().
 604 */
 605 int para_atoi32(const char *str, int32_t *value)
 606 {
 607         int64_t tmp;
 608         int ret;
 609         const int32_t max = 2147483647;
 610
 611         ret = para_atoi64(str, &tmp);
 612         if (ret < 0)
 613                 return ret;
 614         if (tmp > max || tmp < -max - 1)
 615                 return -E_ATOI_OVERFLOW;
 616         *value = tmp;
 617         return 1;
 618 }