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