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