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