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