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