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