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