util.c

   1 /*
   2  * Utility routines used in rsync.
   3  *
   4  * Copyright (C) 1996-2000 Andrew Tridgell
   5  * Copyright (C) 1996 Paul Mackerras
   6  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
   7  * Copyright (C) 2003-2008 Wayne Davison
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, visit the http://fsf.org website.
  21  */
  22
  23 #include "rsync.h"
  24 #include "ifuncs.h"
  25
  26 extern int verbose;
  27 extern int dry_run;
  28 extern int module_id;
  29 extern int modify_window;
  30 extern int relative_paths;
  31 extern int human_readable;
  32 extern char *module_dir;
  33 extern unsigned int module_dirlen;
  34 extern mode_t orig_umask;
  35 extern char *partial_dir;
  36 extern struct filter_list_struct daemon_filter_list;
  37
  38 int sanitize_paths = 0;
  39
  40 char curr_dir[MAXPATHLEN];
  41 unsigned int curr_dir_len;
  42 int curr_dir_depth; /* This is only set for a sanitizing daemon. */
  43
  44 /* Set a fd into nonblocking mode. */
  45 void set_nonblocking(int fd)
  46 {
  47         int val;
  48
  49         if ((val = fcntl(fd, F_GETFL)) == -1)
  50                 return;
  51         if (!(val & NONBLOCK_FLAG)) {
  52                 val |= NONBLOCK_FLAG;
  53                 fcntl(fd, F_SETFL, val);
  54         }
  55 }
  56
  57 /* Set a fd into blocking mode. */
  58 void set_blocking(int fd)
  59 {
  60         int val;
  61
  62         if ((val = fcntl(fd, F_GETFL)) == -1)
  63                 return;
  64         if (val & NONBLOCK_FLAG) {
  65                 val &= ~NONBLOCK_FLAG;
  66                 fcntl(fd, F_SETFL, val);
  67         }
  68 }
  69
  70 /**
  71  * Create a file descriptor pair - like pipe() but use socketpair if
  72  * possible (because of blocking issues on pipes).
  73  *
  74  * Always set non-blocking.
  75  */
  76 int fd_pair(int fd[2])
  77 {
  78         int ret;
  79
  80 #ifdef HAVE_SOCKETPAIR
  81         ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
  82 #else
  83         ret = pipe(fd);
  84 #endif
  85
  86         if (ret == 0) {
  87                 set_nonblocking(fd[0]);
  88                 set_nonblocking(fd[1]);
  89         }
  90
  91         return ret;
  92 }
  93
  94 void print_child_argv(const char *prefix, char **cmd)
  95 {
  96         rprintf(FCLIENT, "%s ", prefix);
  97         for (; *cmd; cmd++) {
  98                 /* Look for characters that ought to be quoted.  This
  99                 * is not a great quoting algorithm, but it's
 100                 * sufficient for a log message. */
 101                 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
 102                            "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 103                            "0123456789"
 104                            ",.-_=+@/") != strlen(*cmd)) {
 105                         rprintf(FCLIENT, "\"%s\" ", *cmd);
 106                 } else {
 107                         rprintf(FCLIENT, "%s ", *cmd);
 108                 }
 109         }
 110         rprintf(FCLIENT, "\n");
 111 }
 112
 113 NORETURN void out_of_memory(const char *str)
 114 {
 115         rprintf(FERROR, "ERROR: out of memory in %s [%s]\n", str, who_am_i());
 116         exit_cleanup(RERR_MALLOC);
 117 }
 118
 119 NORETURN void overflow_exit(const char *str)
 120 {
 121         rprintf(FERROR, "ERROR: buffer overflow in %s [%s]\n", str, who_am_i());
 122         exit_cleanup(RERR_MALLOC);
 123 }
 124
 125 int set_modtime(const char *fname, time_t modtime, mode_t mode)
 126 {
 127 #if !defined HAVE_LUTIMES || !defined HAVE_UTIMES
 128         if (S_ISLNK(mode))
 129                 return 1;
 130 #endif
 131
 132         if (verbose > 2) {
 133                 rprintf(FINFO, "set modtime of %s to (%ld) %s",
 134                         fname, (long)modtime,
 135                         asctime(localtime(&modtime)));
 136         }
 137
 138         if (dry_run)
 139                 return 0;
 140
 141         {
 142 #ifdef HAVE_UTIMES
 143                 struct timeval t[2];
 144                 t[0].tv_sec = time(NULL);
 145                 t[0].tv_usec = 0;
 146                 t[1].tv_sec = modtime;
 147                 t[1].tv_usec = 0;
 148 # ifdef HAVE_LUTIMES
 149                 if (S_ISLNK(mode)) {
 150                         if (lutimes(fname, t) < 0)
 151                                 return errno == ENOSYS ? 1 : -1;
 152                         return 0;
 153                 }
 154 # endif
 155                 return utimes(fname, t);
 156 #elif defined HAVE_STRUCT_UTIMBUF
 157                 struct utimbuf tbuf;
 158                 tbuf.actime = time(NULL);
 159                 tbuf.modtime = modtime;
 160                 return utime(fname,&tbuf);
 161 #elif defined HAVE_UTIME
 162                 time_t t[2];
 163                 t[0] = time(NULL);
 164                 t[1] = modtime;
 165                 return utime(fname,t);
 166 #else
 167 #error No file-time-modification routine found!
 168 #endif
 169         }
 170 }
 171
 172 /* This creates a new directory with default permissions.  Since there
 173  * might be some directory-default permissions affecting this, we can't
 174  * force the permissions directly using the original umask and mkdir(). */
 175 int mkdir_defmode(char *fname)
 176 {
 177         int ret;
 178
 179         umask(orig_umask);
 180         ret = do_mkdir(fname, ACCESSPERMS);
 181         umask(0);
 182
 183         return ret;
 184 }
 185
 186 /* Create any necessary directories in fname.  Any missing directories are
 187  * created with default permissions. */
 188 int create_directory_path(char *fname)
 189 {
 190         char *p;
 191         int ret = 0;
 192
 193         while (*fname == '/')
 194                 fname++;
 195         while (strncmp(fname, "./", 2) == 0)
 196                 fname += 2;
 197
 198         umask(orig_umask);
 199         p = fname;
 200         while ((p = strchr(p,'/')) != NULL) {
 201                 *p = '\0';
 202                 if (do_mkdir(fname, ACCESSPERMS) < 0 && errno != EEXIST)
 203                     ret = -1;
 204                 *p++ = '/';
 205         }
 206         umask(0);
 207
 208         return ret;
 209 }
 210
 211 /**
 212  * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
 213  * interrupted.
 214  *
 215  * @retval len upon success
 216  *
 217  * @retval <0 write's (negative) error code
 218  *
 219  * Derived from GNU C's cccp.c.
 220  */
 221 int full_write(int desc, const char *ptr, size_t len)
 222 {
 223         int total_written;
 224
 225         total_written = 0;
 226         while (len > 0) {
 227                 int written = write(desc, ptr, len);
 228                 if (written < 0)  {
 229                         if (errno == EINTR)
 230                                 continue;
 231                         return written;
 232                 }
 233                 total_written += written;
 234                 ptr += written;
 235                 len -= written;
 236         }
 237         return total_written;
 238 }
 239
 240 /**
 241  * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
 242  * interrupted.
 243  *
 244  * @retval >0 the actual number of bytes read
 245  *
 246  * @retval 0 for EOF
 247  *
 248  * @retval <0 for an error.
 249  *
 250  * Derived from GNU C's cccp.c. */
 251 static int safe_read(int desc, char *ptr, size_t len)
 252 {
 253         int n_chars;
 254
 255         if (len == 0)
 256                 return len;
 257
 258         do {
 259                 n_chars = read(desc, ptr, len);
 260         } while (n_chars < 0 && errno == EINTR);
 261
 262         return n_chars;
 263 }
 264
 265 /* Copy a file.  If ofd < 0, copy_file unlinks and opens the "dest" file.
 266  * Otherwise, it just writes to and closes the provided file descriptor.
 267  *
 268  * This is used in conjunction with the --temp-dir, --backup, and
 269  * --copy-dest options. */
 270 int copy_file(const char *source, const char *dest, int ofd,
 271               mode_t mode, int create_bak_dir)
 272 {
 273         int ifd;
 274         char buf[1024 * 8];
 275         int len;   /* Number of bytes read into `buf'. */
 276
 277         if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
 278                 rsyserr(FERROR_XFER, errno, "open %s", full_fname(source));
 279                 return -1;
 280         }
 281
 282         if (ofd < 0) {
 283                 if (robust_unlink(dest) && errno != ENOENT) {
 284                         rsyserr(FERROR_XFER, errno, "unlink %s", full_fname(dest));
 285                         return -1;
 286                 }
 287
 288                 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0
 289                  && (!create_bak_dir || errno != ENOENT || make_bak_dir(dest) < 0
 290                   || (ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0)) {
 291                         rsyserr(FERROR_XFER, errno, "open %s", full_fname(dest));
 292                         close(ifd);
 293                         return -1;
 294                 }
 295         }
 296
 297         while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
 298                 if (full_write(ofd, buf, len) < 0) {
 299                         rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
 300                         close(ifd);
 301                         close(ofd);
 302                         return -1;
 303                 }
 304         }
 305
 306         if (len < 0) {
 307                 rsyserr(FERROR_XFER, errno, "read %s", full_fname(source));
 308                 close(ifd);
 309                 close(ofd);
 310                 return -1;
 311         }
 312
 313         if (close(ifd) < 0) {
 314                 rsyserr(FWARNING, errno, "close failed on %s",
 315                         full_fname(source));
 316         }
 317
 318         if (close(ofd) < 0) {
 319                 rsyserr(FERROR_XFER, errno, "close failed on %s",
 320                         full_fname(dest));
 321                 return -1;
 322         }
 323
 324         return 0;
 325 }
 326
 327 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
 328 #define MAX_RENAMES_DIGITS 3
 329 #define MAX_RENAMES 1000
 330
 331 /**
 332  * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
 333  * rename to <path>/.rsyncNNN instead.
 334  *
 335  * Note that successive rsync runs will shuffle the filenames around a
 336  * bit as long as the file is still busy; this is because this function
 337  * does not know if the unlink call is due to a new file coming in, or
 338  * --delete trying to remove old .rsyncNNN files, hence it renames it
 339  * each time.
 340  **/
 341 int robust_unlink(const char *fname)
 342 {
 343 #ifndef ETXTBSY
 344         return do_unlink(fname);
 345 #else
 346         static int counter = 1;
 347         int rc, pos, start;
 348         char path[MAXPATHLEN];
 349
 350         rc = do_unlink(fname);
 351         if (rc == 0 || errno != ETXTBSY)
 352                 return rc;
 353
 354         if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
 355                 pos = MAXPATHLEN - 1;
 356
 357         while (pos > 0 && path[pos-1] != '/')
 358                 pos--;
 359         pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
 360
 361         if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
 362                 errno = ETXTBSY;
 363                 return -1;
 364         }
 365
 366         /* start where the last one left off to reduce chance of clashes */
 367         start = counter;
 368         do {
 369                 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
 370                 if (++counter >= MAX_RENAMES)
 371                         counter = 1;
 372         } while ((rc = access(path, 0)) == 0 && counter != start);
 373
 374         if (verbose > 0) {
 375                 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
 376                         fname, path);
 377         }
 378
 379         /* maybe we should return rename()'s exit status? Nah. */
 380         if (do_rename(fname, path) != 0) {
 381                 errno = ETXTBSY;
 382                 return -1;
 383         }
 384         return 0;
 385 #endif
 386 }
 387
 388 /* Returns 0 on successful rename, 1 if we successfully copied the file
 389  * across filesystems, -2 if copy_file() failed, and -1 on other errors.
 390  * If partialptr is not NULL and we need to do a copy, copy the file into
 391  * the active partial-dir instead of over the destination file. */
 392 int robust_rename(const char *from, const char *to, const char *partialptr,
 393                   int mode)
 394 {
 395         int tries = 4;
 396
 397         while (tries--) {
 398                 if (do_rename(from, to) == 0)
 399                         return 0;
 400
 401                 switch (errno) {
 402 #ifdef ETXTBSY
 403                 case ETXTBSY:
 404                         if (robust_unlink(to) != 0)
 405                                 return -1;
 406                         break;
 407 #endif
 408                 case EXDEV:
 409                         if (partialptr) {
 410                                 if (!handle_partial_dir(partialptr,PDIR_CREATE))
 411                                         return -1;
 412                                 to = partialptr;
 413                         }
 414                         if (copy_file(from, to, -1, mode, 0) != 0)
 415                                 return -2;
 416                         do_unlink(from);
 417                         return 1;
 418                 default:
 419                         return -1;
 420                 }
 421         }
 422         return -1;
 423 }
 424
 425 static pid_t all_pids[10];
 426 static int num_pids;
 427
 428 /** Fork and record the pid of the child. **/
 429 pid_t do_fork(void)
 430 {
 431         pid_t newpid = fork();
 432
 433         if (newpid != 0  &&  newpid != -1) {
 434                 all_pids[num_pids++] = newpid;
 435         }
 436         return newpid;
 437 }
 438
 439 /**
 440  * Kill all children.
 441  *
 442  * @todo It would be kind of nice to make sure that they are actually
 443  * all our children before we kill them, because their pids may have
 444  * been recycled by some other process.  Perhaps when we wait for a
 445  * child, we should remove it from this array.  Alternatively we could
 446  * perhaps use process groups, but I think that would not work on
 447  * ancient Unix versions that don't support them.
 448  **/
 449 void kill_all(int sig)
 450 {
 451         int i;
 452
 453         for (i = 0; i < num_pids; i++) {
 454                 /* Let's just be a little careful where we
 455                  * point that gun, hey?  See kill(2) for the
 456                  * magic caused by negative values. */
 457                 pid_t p = all_pids[i];
 458
 459                 if (p == getpid())
 460                         continue;
 461                 if (p <= 0)
 462                         continue;
 463
 464                 kill(p, sig);
 465         }
 466 }
 467
 468 /** Turn a user name into a uid */
 469 int name_to_uid(const char *name, uid_t *uid_p)
 470 {
 471         struct passwd *pass;
 472         if (!name || !*name)
 473                 return 0;
 474         if (!(pass = getpwnam(name)))
 475                 return 0;
 476         *uid_p = pass->pw_uid;
 477         return 1;
 478 }
 479
 480 /** Turn a group name into a gid */
 481 int name_to_gid(const char *name, gid_t *gid_p)
 482 {
 483         struct group *grp;
 484         if (!name || !*name)
 485                 return 0;
 486         if (!(grp = getgrnam(name)))
 487                 return 0;
 488         *gid_p = grp->gr_gid;
 489         return 1;
 490 }
 491
 492 /** Lock a byte range in a open file */
 493 int lock_range(int fd, int offset, int len)
 494 {
 495         struct flock lock;
 496
 497         lock.l_type = F_WRLCK;
 498         lock.l_whence = SEEK_SET;
 499         lock.l_start = offset;
 500         lock.l_len = len;
 501         lock.l_pid = 0;
 502
 503         return fcntl(fd,F_SETLK,&lock) == 0;
 504 }
 505
 506 static int filter_daemon_path(char *arg)
 507 {
 508         if (daemon_filter_list.head) {
 509                 char *s;
 510                 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
 511                         *s = '\0';
 512                         if (check_filter(&daemon_filter_list, arg, 1) < 0) {
 513                                 /* We must leave arg truncated! */
 514                                 return 1;
 515                         }
 516                         *s++ = '/';
 517                 }
 518         }
 519         return 0;
 520 }
 521
 522 void glob_expand(char *s, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
 523 {
 524         char **argv = *argv_ptr;
 525         int argc = *argc_ptr;
 526         int maxargs = *maxargs_ptr;
 527         int count, have_glob_results;
 528
 529 #if !defined HAVE_GLOB || !defined HAVE_GLOB_H
 530         if (argc == maxargs) {
 531                 maxargs += MAX_ARGS;
 532                 if (!(argv = realloc_array(argv, char *, maxargs)))
 533                         out_of_memory("glob_expand");
 534                 *argv_ptr = argv;
 535                 *maxargs_ptr = maxargs;
 536         }
 537         if (!*s)
 538                 s = ".";
 539         s = argv[argc++] = strdup(s);
 540         filter_daemon_path(s);
 541 #else
 542         glob_t globbuf;
 543
 544         if (maxargs <= argc)
 545                 return;
 546         if (!*s)
 547                 s = ".";
 548
 549         if (sanitize_paths)
 550                 s = sanitize_path(NULL, s, "", 0);
 551         else
 552                 s = strdup(s);
 553         if (!s)
 554                 out_of_memory("glob_expand");
 555
 556         memset(&globbuf, 0, sizeof globbuf);
 557         glob(s, 0, NULL, &globbuf);
 558         /* Note: we check the first match against the filter list,
 559          * just in case the user specified a wildcard in the path. */
 560         if ((count = globbuf.gl_pathc) > 0) {
 561                 if (filter_daemon_path(globbuf.gl_pathv[0])) {
 562                         int slashes = 0;
 563                         char *cp;
 564                         /* Truncate original arg at glob's truncation point. */
 565                         for (cp = globbuf.gl_pathv[0]; *cp; cp++) {
 566                                 if (*cp == '/')
 567                                         slashes++;
 568                         }
 569                         for (cp = s; *cp; cp++) {
 570                                 if (*cp == '/') {
 571                                         if (slashes-- <= 0) {
 572                                                 *cp = '\0';
 573                                                 break;
 574                                         }
 575                                 }
 576                         }
 577                         have_glob_results = 0;
 578                         count = 1;
 579                 } else
 580                         have_glob_results = 1;
 581         } else {
 582                 /* This truncates "s" at a filtered element, if present. */
 583                 filter_daemon_path(s);
 584                 have_glob_results = 0;
 585                 count = 1;
 586         }
 587         if (count + argc > maxargs) {
 588                 maxargs += count + MAX_ARGS;
 589                 if (!(argv = realloc_array(argv, char *, maxargs)))
 590                         out_of_memory("glob_expand");
 591                 *argv_ptr = argv;
 592                 *maxargs_ptr = maxargs;
 593         }
 594         if (have_glob_results) {
 595                 int i;
 596                 free(s);
 597                 for (i = 0; i < count; i++) {
 598                         if (!(argv[argc++] = strdup(globbuf.gl_pathv[i])))
 599                                 out_of_memory("glob_expand");
 600                 }
 601         } else
 602                 argv[argc++] = s;
 603         globfree(&globbuf);
 604 #endif
 605         *argc_ptr = argc;
 606 }
 607
 608 /* This routine is only used in daemon mode. */
 609 void glob_expand_module(char *base1, char *arg, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
 610 {
 611         char *p, *s;
 612         char *base = base1;
 613         int base_len = strlen(base);
 614
 615         if (!arg || !*arg)
 616                 return;
 617
 618         if (strncmp(arg, base, base_len) == 0)
 619                 arg += base_len;
 620
 621         if (!(arg = strdup(arg)))
 622                 out_of_memory("glob_expand_module");
 623
 624         if (asprintf(&base," %s/", base1) <= 0)
 625                 out_of_memory("glob_expand_module");
 626         base_len++;
 627
 628         for (s = arg; *s; s = p + base_len) {
 629                 if ((p = strstr(s, base)) != NULL)
 630                         *p = '\0'; /* split it at this point */
 631                 glob_expand(s, argv_ptr, argc_ptr, maxargs_ptr);
 632                 if (!p)
 633                         break;
 634         }
 635
 636         free(arg);
 637         free(base);
 638 }
 639
 640 /**
 641  * Convert a string to lower case
 642  **/
 643 void strlower(char *s)
 644 {
 645         while (*s) {
 646                 if (isUpper(s))
 647                         *s = toLower(s);
 648                 s++;
 649         }
 650 }
 651
 652 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them.  (If
 653  * p1 ends with a '/', no extra '/' is inserted.)  Returns the length of both
 654  * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
 655  * string fits into destsize. */
 656 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
 657 {
 658         size_t len = strlcpy(dest, p1, destsize);
 659         if (len < destsize - 1) {
 660                 if (!len || dest[len-1] != '/')
 661                         dest[len++] = '/';
 662                 if (len < destsize - 1)
 663                         len += strlcpy(dest + len, p2, destsize - len);
 664                 else {
 665                         dest[len] = '\0';
 666                         len += strlen(p2);
 667                 }
 668         }
 669         else
 670                 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
 671         return len;
 672 }
 673
 674 /* Join any number of strings together, putting them in "dest".  The return
 675  * value is the length of all the strings, regardless of whether the null-
 676  * terminated whole fits in destsize.  Your list of string pointers must end
 677  * with a NULL to indicate the end of the list. */
 678 size_t stringjoin(char *dest, size_t destsize, ...)
 679 {
 680         va_list ap;
 681         size_t len, ret = 0;
 682         const char *src;
 683
 684         va_start(ap, destsize);
 685         while (1) {
 686                 if (!(src = va_arg(ap, const char *)))
 687                         break;
 688                 len = strlen(src);
 689                 ret += len;
 690                 if (destsize > 1) {
 691                         if (len >= destsize)
 692                                 len = destsize - 1;
 693                         memcpy(dest, src, len);
 694                         destsize -= len;
 695                         dest += len;
 696                 }
 697         }
 698         *dest = '\0';
 699         va_end(ap);
 700
 701         return ret;
 702 }
 703
 704 int count_dir_elements(const char *p)
 705 {
 706         int cnt = 0, new_component = 1;
 707         while (*p) {
 708                 if (*p++ == '/')
 709                         new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
 710                 else if (new_component) {
 711                         new_component = 0;
 712                         cnt++;
 713                 }
 714         }
 715         return cnt;
 716 }
 717
 718 /* Turns multiple adjacent slashes into a single slash, drops interior "."
 719  * elements, drops an intial "./" unless CFN_KEEP_LEADING_DOT_DIR is flagged,
 720  * will even drop a trailing '.' after a '/' if CFN_DROP_TRAILING_DOT_DIR is
 721  * flagged, removes a trailing slash (perhaps after removing the aforementioned
 722  * dot) unless CFN_KEEP_TRAILING_SLASH is flagged, will even collapse ".."
 723  * elements (except at the start of the string) if CFN_COLLAPSE_DOT_DOT_DIRS
 724  * is flagged.  If the resulting name would be empty, we return ".". */
 725 unsigned int clean_fname(char *name, int flags)
 726 {
 727         char *limit = name - 1, *t = name, *f = name;
 728         int anchored;
 729
 730         if (!name)
 731                 return 0;
 732
 733         if ((anchored = *f == '/') != 0)
 734                 *t++ = *f++;
 735         else if (flags & CFN_KEEP_LEADING_DOT_DIR && *f == '.' && f[1] == '/') {
 736                 *t++ = *f++;
 737                 *t++ = *f++;
 738         }
 739         while (*f) {
 740                 /* discard extra slashes */
 741                 if (*f == '/') {
 742                         f++;
 743                         continue;
 744                 }
 745                 if (*f == '.') {
 746                         /* discard interior "." dirs */
 747                         if (f[1] == '/') {
 748                                 f += 2;
 749                                 continue;
 750                         }
 751                         if (f[1] == '\0' && flags & CFN_DROP_TRAILING_DOT_DIR)
 752                                 break;
 753                         /* collapse ".." dirs */
 754                         if (flags & CFN_COLLAPSE_DOT_DOT_DIRS
 755                          && f[1] == '.' && (f[2] == '/' || !f[2])) {
 756                                 char *s = t - 1;
 757                                 if (s == name && anchored) {
 758                                         f += 2;
 759                                         continue;
 760                                 }
 761                                 while (s > limit && *--s != '/') {}
 762                                 if (s != t - 1 && (s < name || *s == '/')) {
 763                                         t = s + 1;
 764                                         f += 2;
 765                                         continue;
 766                                 }
 767                                 limit = t + 2;
 768                         }
 769                 }
 770                 while (*f && (*t++ = *f++) != '/') {}
 771         }
 772
 773         if (t > name+anchored && t[-1] == '/' && !(flags & CFN_KEEP_TRAILING_SLASH))
 774                 t--;
 775         if (t == name)
 776                 *t++ = '.';
 777         *t = '\0';
 778
 779         return t - name;
 780 }
 781
 782 /* Make path appear as if a chroot had occurred.  This handles a leading
 783  * "/" (either removing it or expanding it) and any leading or embedded
 784  * ".." components that attempt to escape past the module's top dir.
 785  *
 786  * If dest is NULL, a buffer is allocated to hold the result.  It is legal
 787  * to call with the dest and the path (p) pointing to the same buffer, but
 788  * rootdir will be ignored to avoid expansion of the string.
 789  *
 790  * The rootdir string contains a value to use in place of a leading slash.
 791  * Specify NULL to get the default of "module_dir".
 792  *
 793  * The depth var is a count of how many '..'s to allow at the start of the
 794  * path.
 795  *
 796  * We also clean the path in a manner similar to clean_fname() but with a
 797  * few differences:
 798  *
 799  * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
 800  * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
 801  * ALWAYS collapses ".." elements (except for those at the start of the
 802  * string up to "depth" deep).  If the resulting name would be empty,
 803  * change it into a ".". */
 804 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
 805 {
 806         char *start, *sanp;
 807         int rlen = 0, leave_one_dotdir = relative_paths;
 808
 809         if (dest != p) {
 810                 int plen = strlen(p);
 811                 if (*p == '/') {
 812                         if (!rootdir)
 813                                 rootdir = module_dir;
 814                         rlen = strlen(rootdir);
 815                         depth = 0;
 816                         p++;
 817                 }
 818                 if (dest) {
 819                         if (rlen + plen + 1 >= MAXPATHLEN)
 820                                 return NULL;
 821                 } else if (!(dest = new_array(char, rlen + plen + 1)))
 822                         out_of_memory("sanitize_path");
 823                 if (rlen) {
 824                         memcpy(dest, rootdir, rlen);
 825                         if (rlen > 1)
 826                                 dest[rlen++] = '/';
 827                 }
 828         }
 829
 830         start = sanp = dest + rlen;
 831         /* This loop iterates once per filename component in p, pointing at
 832          * the start of the name (past any prior slash) for each iteration. */
 833         while (*p) {
 834                 /* discard leading or extra slashes */
 835                 if (*p == '/') {
 836                         p++;
 837                         continue;
 838                 }
 839                 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
 840                         if (leave_one_dotdir && p[1])
 841                                 leave_one_dotdir = 0;
 842                         else {
 843                                 /* skip "." component */
 844                                 p++;
 845                                 continue;
 846                         }
 847                 }
 848                 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
 849                         /* ".." component followed by slash or end */
 850                         if (depth <= 0 || sanp != start) {
 851                                 p += 2;
 852                                 if (sanp != start) {
 853                                         /* back up sanp one level */
 854                                         --sanp; /* now pointing at slash */
 855                                         while (sanp > start && sanp[-1] != '/') {
 856                                                 /* skip back up to slash */
 857                                                 sanp--;
 858                                         }
 859                                 }
 860                                 continue;
 861                         }
 862                         /* allow depth levels of .. at the beginning */
 863                         depth--;
 864                         /* move the virtual beginning to leave the .. alone */
 865                         start = sanp + 3;
 866                 }
 867                 /* copy one component through next slash */
 868                 while (*p && (*sanp++ = *p++) != '/') {}
 869         }
 870         if (sanp == dest) {
 871                 /* ended up with nothing, so put in "." component */
 872                 *sanp++ = '.';
 873         }
 874         *sanp = '\0';
 875
 876         return dest;
 877 }
 878
 879 /* Like chdir(), but it keeps track of the current directory (in the
 880  * global "curr_dir"), and ensures that the path size doesn't overflow.
 881  * Also cleans the path using the clean_fname() function. */
 882 int push_dir(const char *dir, int set_path_only)
 883 {
 884         static int initialised;
 885         unsigned int len;
 886
 887         if (!initialised) {
 888                 initialised = 1;
 889                 getcwd(curr_dir, sizeof curr_dir - 1);
 890                 curr_dir_len = strlen(curr_dir);
 891         }
 892
 893         if (!dir)       /* this call was probably just to initialize */
 894                 return 0;
 895
 896         len = strlen(dir);
 897         if (len == 1 && *dir == '.')
 898                 return 1;
 899
 900         if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir) {
 901                 errno = ENAMETOOLONG;
 902                 return 0;
 903         }
 904
 905         if (!set_path_only && chdir(dir))
 906                 return 0;
 907
 908         if (*dir == '/') {
 909                 memcpy(curr_dir, dir, len + 1);
 910                 curr_dir_len = len;
 911         } else {
 912                 curr_dir[curr_dir_len++] = '/';
 913                 memcpy(curr_dir + curr_dir_len, dir, len + 1);
 914                 curr_dir_len += len;
 915         }
 916
 917         curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
 918         if (sanitize_paths) {
 919                 if (module_dirlen > curr_dir_len)
 920                         module_dirlen = curr_dir_len;
 921                 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
 922         }
 923
 924         if (verbose >= 5 && !set_path_only)
 925                 rprintf(FINFO, "[%s] push_dir(%s)\n", who_am_i(), curr_dir);
 926
 927         return 1;
 928 }
 929
 930 /**
 931  * Reverse a push_dir() call.  You must pass in an absolute path
 932  * that was copied from a prior value of "curr_dir".
 933  **/
 934 int pop_dir(const char *dir)
 935 {
 936         if (chdir(dir))
 937                 return 0;
 938
 939         curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
 940         if (curr_dir_len >= sizeof curr_dir)
 941                 curr_dir_len = sizeof curr_dir - 1;
 942         if (sanitize_paths)
 943                 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
 944
 945         if (verbose >= 5)
 946                 rprintf(FINFO, "[%s] pop_dir(%s)\n", who_am_i(), curr_dir);
 947
 948         return 1;
 949 }
 950
 951 /**
 952  * Return a quoted string with the full pathname of the indicated filename.
 953  * The string " (in MODNAME)" may also be appended.  The returned pointer
 954  * remains valid until the next time full_fname() is called.
 955  **/
 956 char *full_fname(const char *fn)
 957 {
 958         static char *result = NULL;
 959         char *m1, *m2, *m3;
 960         char *p1, *p2;
 961
 962         if (result)
 963                 free(result);
 964
 965         if (*fn == '/')
 966                 p1 = p2 = "";
 967         else {
 968                 p1 = curr_dir + module_dirlen;
 969                 for (p2 = p1; *p2 == '/'; p2++) {}
 970                 if (*p2)
 971                         p2 = "/";
 972         }
 973         if (module_id >= 0) {
 974                 m1 = " (in ";
 975                 m2 = lp_name(module_id);
 976                 m3 = ")";
 977         } else
 978                 m1 = m2 = m3 = "";
 979
 980         if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) <= 0)
 981                 out_of_memory("full_fname");
 982
 983         return result;
 984 }
 985
 986 static char partial_fname[MAXPATHLEN];
 987
 988 char *partial_dir_fname(const char *fname)
 989 {
 990         char *t = partial_fname;
 991         int sz = sizeof partial_fname;
 992         const char *fn;
 993
 994         if ((fn = strrchr(fname, '/')) != NULL) {
 995                 fn++;
 996                 if (*partial_dir != '/') {
 997                         int len = fn - fname;
 998                         strncpy(t, fname, len); /* safe */
 999                         t += len;
1000                         sz -= len;
1001                 }
1002         } else
1003                 fn = fname;
1004         if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
1005                 return NULL;
1006         if (daemon_filter_list.head) {
1007                 t = strrchr(partial_fname, '/');
1008                 *t = '\0';
1009                 if (check_filter(&daemon_filter_list, partial_fname, 1) < 0)
1010                         return NULL;
1011                 *t = '/';
1012                 if (check_filter(&daemon_filter_list, partial_fname, 0) < 0)
1013                         return NULL;
1014         }
1015
1016         return partial_fname;
1017 }
1018
1019 /* If no --partial-dir option was specified, we don't need to do anything
1020  * (the partial-dir is essentially '.'), so just return success. */
1021 int handle_partial_dir(const char *fname, int create)
1022 {
1023         char *fn, *dir;
1024
1025         if (fname != partial_fname)
1026                 return 1;
1027         if (!create && *partial_dir == '/')
1028                 return 1;
1029         if (!(fn = strrchr(partial_fname, '/')))
1030                 return 1;
1031
1032         *fn = '\0';
1033         dir = partial_fname;
1034         if (create) {
1035                 STRUCT_STAT st;
1036                 int statret = do_lstat(dir, &st);
1037                 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1038                         if (do_unlink(dir) < 0)
1039                                 return 0;
1040                         statret = -1;
1041                 }
1042                 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1043                         return 0;
1044         } else
1045                 do_rmdir(dir);
1046         *fn = '/';
1047
1048         return 1;
1049 }
1050
1051 /**
1052  * Determine if a symlink points outside the current directory tree.
1053  * This is considered "unsafe" because e.g. when mirroring somebody
1054  * else's machine it might allow them to establish a symlink to
1055  * /etc/passwd, and then read it through a web server.
1056  *
1057  * Null symlinks and absolute symlinks are always unsafe.
1058  *
1059  * Basically here we are concerned with symlinks whose target contains
1060  * "..", because this might cause us to walk back up out of the
1061  * transferred directory.  We are not allowed to go back up and
1062  * reenter.
1063  *
1064  * @param dest Target of the symlink in question.
1065  *
1066  * @param src Top source directory currently applicable.  Basically this
1067  * is the first parameter to rsync in a simple invocation, but it's
1068  * modified by flist.c in slightly complex ways.
1069  *
1070  * @retval True if unsafe
1071  * @retval False is unsafe
1072  *
1073  * @sa t_unsafe.c
1074  **/
1075 int unsafe_symlink(const char *dest, const char *src)
1076 {
1077         const char *name, *slash;
1078         int depth = 0;
1079
1080         /* all absolute and null symlinks are unsafe */
1081         if (!dest || !*dest || *dest == '/')
1082                 return 1;
1083
1084         /* find out what our safety margin is */
1085         for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1086                 if (strncmp(name, "../", 3) == 0) {
1087                         depth = 0;
1088                 } else if (strncmp(name, "./", 2) == 0) {
1089                         /* nothing */
1090                 } else {
1091                         depth++;
1092                 }
1093         }
1094         if (strcmp(name, "..") == 0)
1095                 depth = 0;
1096
1097         for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1098                 if (strncmp(name, "../", 3) == 0) {
1099                         /* if at any point we go outside the current directory
1100                            then stop - it is unsafe */
1101                         if (--depth < 0)
1102                                 return 1;
1103                 } else if (strncmp(name, "./", 2) == 0) {
1104                         /* nothing */
1105                 } else {
1106                         depth++;
1107                 }
1108         }
1109         if (strcmp(name, "..") == 0)
1110                 depth--;
1111
1112         return (depth < 0);
1113 }
1114
1115 /* Return the int64 number as a string.  If the --human-readable option was
1116  * specified, we may output the number in K, M, or G units.  We can return
1117  * up to 4 buffers at a time. */
1118 char *human_num(int64 num)
1119 {
1120         static char bufs[4][128]; /* more than enough room */
1121         static unsigned int n;
1122         char *s;
1123
1124         n = (n + 1) % (sizeof bufs / sizeof bufs[0]);
1125
1126         if (human_readable) {
1127                 char units = '\0';
1128                 int mult = human_readable == 1 ? 1000 : 1024;
1129                 double dnum = 0;
1130                 if (num > mult*mult*mult) {
1131                         dnum = (double)num / (mult*mult*mult);
1132                         units = 'G';
1133                 } else if (num > mult*mult) {
1134                         dnum = (double)num / (mult*mult);
1135                         units = 'M';
1136                 } else if (num > mult) {
1137                         dnum = (double)num / mult;
1138                         units = 'K';
1139                 }
1140                 if (units) {
1141                         snprintf(bufs[n], sizeof bufs[0], "%.2f%c", dnum, units);
1142                         return bufs[n];
1143                 }
1144         }
1145
1146         s = bufs[n] + sizeof bufs[0] - 1;
1147         *s = '\0';
1148
1149         if (!num)
1150                 *--s = '0';
1151         while (num) {
1152                 *--s = (char)(num % 10) + '0';
1153                 num /= 10;
1154         }
1155         return s;
1156 }
1157
1158 /* Return the double number as a string.  If the --human-readable option was
1159  * specified, we may output the number in K, M, or G units.  We use a buffer
1160  * from human_num() to return our result. */
1161 char *human_dnum(double dnum, int decimal_digits)
1162 {
1163         char *buf = human_num(dnum);
1164         int len = strlen(buf);
1165         if (isDigit(buf + len - 1)) {
1166                 /* There's extra room in buf prior to the start of the num. */
1167                 buf -= decimal_digits + 1;
1168                 snprintf(buf, len + decimal_digits + 2, "%.*f", decimal_digits, dnum);
1169         }
1170         return buf;
1171 }
1172
1173 /* Return the date and time as a string.  Some callers tweak returned buf. */
1174 char *timestring(time_t t)
1175 {
1176         static char TimeBuf[200];
1177         struct tm *tm = localtime(&t);
1178         char *p;
1179
1180 #ifdef HAVE_STRFTIME
1181         strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1182 #else
1183         strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1184 #endif
1185
1186         if ((p = strchr(TimeBuf, '\n')) != NULL)
1187                 *p = '\0';
1188
1189         return TimeBuf;
1190 }
1191
1192 /**
1193  * Sleep for a specified number of milliseconds.
1194  *
1195  * Always returns TRUE.  (In the future it might return FALSE if
1196  * interrupted.)
1197  **/
1198 int msleep(int t)
1199 {
1200         int tdiff = 0;
1201         struct timeval tval, t1, t2;
1202
1203         gettimeofday(&t1, NULL);
1204
1205         while (tdiff < t) {
1206                 tval.tv_sec = (t-tdiff)/1000;
1207                 tval.tv_usec = 1000*((t-tdiff)%1000);
1208
1209                 errno = 0;
1210                 select(0,NULL,NULL, NULL, &tval);
1211
1212                 gettimeofday(&t2, NULL);
1213                 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
1214                         (t2.tv_usec - t1.tv_usec)/1000;
1215         }
1216
1217         return True;
1218 }
1219
1220 /* Determine if two time_t values are equivalent (either exact, or in
1221  * the modification timestamp window established by --modify-window).
1222  *
1223  * @retval 0 if the times should be treated as the same
1224  *
1225  * @retval +1 if the first is later
1226  *
1227  * @retval -1 if the 2nd is later
1228  **/
1229 int cmp_time(time_t file1, time_t file2)
1230 {
1231         if (file2 > file1) {
1232                 if (file2 - file1 <= modify_window)
1233                         return 0;
1234                 return -1;
1235         }
1236         if (file1 - file2 <= modify_window)
1237                 return 0;
1238         return 1;
1239 }
1240
1241
1242 #ifdef __INSURE__XX
1243 #include <dlfcn.h>
1244
1245 /**
1246    This routine is a trick to immediately catch errors when debugging
1247    with insure. A xterm with a gdb is popped up when insure catches
1248    a error. It is Linux specific.
1249 **/
1250 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1251 {
1252         static int (*fn)();
1253         int ret;
1254         char *cmd;
1255
1256         asprintf(&cmd, "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; gdb /proc/%d/exe %d'",
1257                 getpid(), getpid(), getpid());
1258
1259         if (!fn) {
1260                 static void *h;
1261                 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1262                 fn = dlsym(h, "_Insure_trap_error");
1263         }
1264
1265         ret = fn(a1, a2, a3, a4, a5, a6);
1266
1267         system(cmd);
1268
1269         free(cmd);
1270
1271         return ret;
1272 }
1273 #endif
1274
1275 #define MALLOC_MAX 0x40000000
1276
1277 void *_new_array(unsigned long num, unsigned int size, int use_calloc)
1278 {
1279         if (num >= MALLOC_MAX/size)
1280                 return NULL;
1281         return use_calloc ? calloc(num, size) : malloc(num * size);
1282 }
1283
1284 void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1285 {
1286         if (num >= MALLOC_MAX/size)
1287                 return NULL;
1288         if (!ptr)
1289                 return malloc(size * num);
1290         return realloc(ptr, size * num);
1291 }
1292
1293 /* Take a filename and filename length and return the most significant
1294  * filename suffix we can find.  This ignores suffixes such as "~",
1295  * ".bak", ".orig", ".~1~", etc. */
1296 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1297 {
1298         const char *suf, *s;
1299         BOOL had_tilde;
1300         int s_len;
1301
1302         /* One or more dots at the start aren't a suffix. */
1303         while (fn_len && *fn == '.') fn++, fn_len--;
1304
1305         /* Ignore the ~ in a "foo~" filename. */
1306         if (fn_len > 1 && fn[fn_len-1] == '~')
1307                 fn_len--, had_tilde = True;
1308         else
1309                 had_tilde = False;
1310
1311         /* Assume we don't find an suffix. */
1312         suf = "";
1313         *len_ptr = 0;
1314
1315         /* Find the last significant suffix. */
1316         for (s = fn + fn_len; fn_len > 1; ) {
1317                 while (*--s != '.' && s != fn) {}
1318                 if (s == fn)
1319                         break;
1320                 s_len = fn_len - (s - fn);
1321                 fn_len = s - fn;
1322                 if (s_len == 4) {
1323                         if (strcmp(s+1, "bak") == 0
1324                          || strcmp(s+1, "old") == 0)
1325                                 continue;
1326                 } else if (s_len == 5) {
1327                         if (strcmp(s+1, "orig") == 0)
1328                                 continue;
1329                 } else if (s_len > 2 && had_tilde
1330                     && s[1] == '~' && isDigit(s + 2))
1331                         continue;
1332                 *len_ptr = s_len;
1333                 suf = s;
1334                 if (s_len == 1)
1335                         break;
1336                 /* Determine if the suffix is all digits. */
1337                 for (s++, s_len--; s_len > 0; s++, s_len--) {
1338                         if (!isDigit(s))
1339                                 return suf;
1340                 }
1341                 /* An all-digit suffix may not be that signficant. */
1342                 s = suf;
1343         }
1344
1345         return suf;
1346 }
1347
1348 /* This is an implementation of the Levenshtein distance algorithm.  It
1349  * was implemented to avoid needing a two-dimensional matrix (to save
1350  * memory).  It was also tweaked to try to factor in the ASCII distance
1351  * between changed characters as a minor distance quantity.  The normal
1352  * Levenshtein units of distance (each signifying a single change between
1353  * the two strings) are defined as a "UNIT". */
1354
1355 #define UNIT (1 << 16)
1356
1357 uint32 fuzzy_distance(const char *s1, int len1, const char *s2, int len2)
1358 {
1359         uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1360         int32 cost;
1361         int i1, i2;
1362
1363         if (!len1 || !len2) {
1364                 if (!len1) {
1365                         s1 = s2;
1366                         len1 = len2;
1367                 }
1368                 for (i1 = 0, cost = 0; i1 < len1; i1++)
1369                         cost += s1[i1];
1370                 return (int32)len1 * UNIT + cost;
1371         }
1372
1373         for (i2 = 0; i2 < len2; i2++)
1374                 a[i2] = (i2+1) * UNIT;
1375
1376         for (i1 = 0; i1 < len1; i1++) {
1377                 diag = i1 * UNIT;
1378                 above = (i1+1) * UNIT;
1379                 for (i2 = 0; i2 < len2; i2++) {
1380                         left = a[i2];
1381                         if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1382                                 if (cost < 0)
1383                                         cost = UNIT - cost;
1384                                 else
1385                                         cost = UNIT + cost;
1386                         }
1387                         diag_inc = diag + cost;
1388                         left_inc = left + UNIT + *((uchar*)s1+i1);
1389                         above_inc = above + UNIT + *((uchar*)s2+i2);
1390                         a[i2] = above = left < above
1391                               ? (left_inc < diag_inc ? left_inc : diag_inc)
1392                               : (above_inc < diag_inc ? above_inc : diag_inc);
1393                         diag = left;
1394                 }
1395         }
1396
1397         return a[len2-1];
1398 }
1399
1400 #define BB_SLOT_SIZE     (16*1024)          /* Desired size in bytes */
1401 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1402 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1403
1404 struct bitbag {
1405     uint32 **bits;
1406     int slot_cnt;
1407 };
1408
1409 struct bitbag *bitbag_create(int max_ndx)
1410 {
1411         struct bitbag *bb = new(struct bitbag);
1412         bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1413
1414         if (!(bb->bits = (uint32**)calloc(bb->slot_cnt, sizeof (uint32*))))
1415                 out_of_memory("bitbag_create");
1416
1417         return bb;
1418 }
1419
1420 void bitbag_set_bit(struct bitbag *bb, int ndx)
1421 {
1422         int slot = ndx / BB_PER_SLOT_BITS;
1423         ndx %= BB_PER_SLOT_BITS;
1424
1425         if (!bb->bits[slot]) {
1426                 if (!(bb->bits[slot] = (uint32*)calloc(BB_PER_SLOT_INTS, 4)))
1427                         out_of_memory("bitbag_set_bit");
1428         }
1429
1430         bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1431 }
1432
1433 #if 0 /* not needed yet */
1434 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1435 {
1436         int slot = ndx / BB_PER_SLOT_BITS;
1437         ndx %= BB_PER_SLOT_BITS;
1438
1439         if (!bb->bits[slot])
1440                 return;
1441
1442         bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1443 }
1444
1445 int bitbag_check_bit(struct bitbag *bb, int ndx)
1446 {
1447         int slot = ndx / BB_PER_SLOT_BITS;
1448         ndx %= BB_PER_SLOT_BITS;
1449
1450         if (!bb->bits[slot])
1451                 return 0;
1452
1453         return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1454 }
1455 #endif
1456
1457 /* Call this with -1 to start checking from 0.  Returns -1 at the end. */
1458 int bitbag_next_bit(struct bitbag *bb, int after)
1459 {
1460         uint32 bits, mask;
1461         int i, ndx = after + 1;
1462         int slot = ndx / BB_PER_SLOT_BITS;
1463         ndx %= BB_PER_SLOT_BITS;
1464
1465         mask = (1u << (ndx % 32)) - 1;
1466         for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1467                 if (!bb->bits[slot])
1468                         continue;
1469                 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1470                         if (!(bits = bb->bits[slot][i] & ~mask))
1471                                 continue;
1472                         /* The xor magic figures out the lowest enabled bit in
1473                          * bits, and the switch quickly computes log2(bit). */
1474                         switch (bits ^ (bits & (bits-1))) {
1475 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1476                             LOG2(0);  LOG2(1);  LOG2(2);  LOG2(3);
1477                             LOG2(4);  LOG2(5);  LOG2(6);  LOG2(7);
1478                             LOG2(8);  LOG2(9);  LOG2(10); LOG2(11);
1479                             LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1480                             LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1481                             LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1482                             LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1483                             LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1484                         }
1485                         return -1; /* impossible... */
1486                 }
1487         }
1488
1489         return -1;
1490 }
1491
1492 void *expand_item_list(item_list *lp, size_t item_size,
1493                        const char *desc, int incr)
1494 {
1495         /* First time through, 0 <= 0, so list is expanded. */
1496         if (lp->malloced <= lp->count) {
1497                 void *new_ptr;
1498                 size_t new_size = lp->malloced;
1499                 if (incr < 0)
1500                         new_size += -incr; /* increase slowly */
1501                 else if (new_size < (size_t)incr)
1502                         new_size += incr;
1503                 else
1504                         new_size *= 2;
1505                 new_ptr = realloc_array(lp->items, char, new_size * item_size);
1506                 if (verbose >= 4) {
1507                         rprintf(FINFO, "[%s] expand %s to %.0f bytes, did%s move\n",
1508                                 who_am_i(), desc, (double)new_size * item_size,
1509                                 new_ptr == lp->items ? " not" : "");
1510                 }
1511                 if (!new_ptr)
1512                         out_of_memory("expand_item_list");
1513
1514                 lp->items = new_ptr;
1515                 lp->malloced = new_size;
1516         }
1517         return (char*)lp->items + (lp->count++ * item_size);
1518 }