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