2 * Utility routines used in rsync.
4 * Copyright (C) 1996-2000 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2003-2008 Wayne Davison
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.
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.
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.
29 extern int modify_window;
30 extern int relative_paths;
31 extern int human_readable;
32 extern char *module_dir;
33 extern unsigned int module_dirlen;
34 extern mode_t orig_umask;
35 extern char *partial_dir;
36 extern struct filter_list_struct server_filter_list;
38 int sanitize_paths = 0;
40 char curr_dir[MAXPATHLEN];
41 unsigned int curr_dir_len;
42 int curr_dir_depth; /* This is only set for a sanitizing daemon. */
44 /* Set a fd into nonblocking mode. */
45 void set_nonblocking(int fd)
49 if ((val = fcntl(fd, F_GETFL)) == -1)
51 if (!(val & NONBLOCK_FLAG)) {
53 fcntl(fd, F_SETFL, val);
57 /* Set a fd into blocking mode. */
58 void set_blocking(int fd)
62 if ((val = fcntl(fd, F_GETFL)) == -1)
64 if (val & NONBLOCK_FLAG) {
65 val &= ~NONBLOCK_FLAG;
66 fcntl(fd, F_SETFL, val);
71 * Create a file descriptor pair - like pipe() but use socketpair if
72 * possible (because of blocking issues on pipes).
74 * Always set non-blocking.
76 int fd_pair(int fd[2])
80 #ifdef HAVE_SOCKETPAIR
81 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
87 set_nonblocking(fd[0]);
88 set_nonblocking(fd[1]);
94 void print_child_argv(const char *prefix, char **cmd)
96 rprintf(FCLIENT, "%s ", prefix);
98 /* Look for characters that ought to be quoted. This
99 * is not a great quoting algorithm, but it's
100 * sufficient for a log message. */
101 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
102 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
104 ",.-_=+@/") != strlen(*cmd)) {
105 rprintf(FCLIENT, "\"%s\" ", *cmd);
107 rprintf(FCLIENT, "%s ", *cmd);
110 rprintf(FCLIENT, "\n");
113 NORETURN void out_of_memory(const char *str)
115 rprintf(FERROR, "ERROR: out of memory in %s [%s]\n", str, who_am_i());
116 exit_cleanup(RERR_MALLOC);
119 NORETURN void overflow_exit(const char *str)
121 rprintf(FERROR, "ERROR: buffer overflow in %s [%s]\n", str, who_am_i());
122 exit_cleanup(RERR_MALLOC);
125 int set_modtime(const char *fname, time_t modtime, mode_t mode)
127 #if !defined HAVE_LUTIMES || !defined HAVE_UTIMES
133 rprintf(FINFO, "set modtime of %s to (%ld) %s",
134 fname, (long)modtime,
135 asctime(localtime(&modtime)));
144 t[0].tv_sec = time(NULL);
146 t[1].tv_sec = modtime;
150 if (lutimes(fname, t) < 0)
151 return errno == ENOSYS ? 1 : -1;
155 return utimes(fname, t);
156 #elif defined HAVE_STRUCT_UTIMBUF
158 tbuf.actime = time(NULL);
159 tbuf.modtime = modtime;
160 return utime(fname,&tbuf);
161 #elif defined HAVE_UTIME
165 return utime(fname,t);
167 #error No file-time-modification routine found!
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)
180 ret = do_mkdir(fname, ACCESSPERMS);
186 /* Create any necessary directories in fname. Any missing directories are
187 * created with default permissions. */
188 int create_directory_path(char *fname)
193 while (*fname == '/')
195 while (strncmp(fname, "./", 2) == 0)
200 while ((p = strchr(p,'/')) != NULL) {
202 if (do_mkdir(fname, ACCESSPERMS) < 0 && errno != EEXIST)
212 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
215 * @retval len upon success
217 * @retval <0 write's (negative) error code
219 * Derived from GNU C's cccp.c.
221 int full_write(int desc, const char *ptr, size_t len)
227 int written = write(desc, ptr, len);
233 total_written += written;
237 return total_written;
241 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
244 * @retval >0 the actual number of bytes read
248 * @retval <0 for an error.
250 * Derived from GNU C's cccp.c. */
251 static int safe_read(int desc, char *ptr, size_t len)
259 n_chars = read(desc, ptr, len);
260 } while (n_chars < 0 && errno == EINTR);
265 /* Copy a file. If ofd < 0, copy_file unlinks and opens the "dest" file.
266 * Otherwise, it just writes to and closes the provided file descriptor.
268 * This is used in conjunction with the --temp-dir, --backup, and
269 * --copy-dest options. */
270 int copy_file(const char *source, const char *dest, int ofd,
271 mode_t mode, int create_bak_dir)
275 int len; /* Number of bytes read into `buf'. */
277 if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
278 rsyserr(FERROR_XFER, errno, "open %s", full_fname(source));
283 if (robust_unlink(dest) && errno != ENOENT) {
284 rsyserr(FERROR_XFER, errno, "unlink %s", full_fname(dest));
288 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0
289 && (!create_bak_dir || errno != ENOENT || make_bak_dir(dest) < 0
290 || (ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0)) {
291 rsyserr(FERROR_XFER, errno, "open %s", full_fname(dest));
297 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
298 if (full_write(ofd, buf, len) < 0) {
299 rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
307 rsyserr(FERROR_XFER, errno, "read %s", full_fname(source));
313 if (close(ifd) < 0) {
314 rsyserr(FWARNING, errno, "close failed on %s",
318 if (close(ofd) < 0) {
319 rsyserr(FERROR_XFER, errno, "close failed on %s",
327 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
328 #define MAX_RENAMES_DIGITS 3
329 #define MAX_RENAMES 1000
332 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
333 * rename to <path>/.rsyncNNN instead.
335 * Note that successive rsync runs will shuffle the filenames around a
336 * bit as long as the file is still busy; this is because this function
337 * does not know if the unlink call is due to a new file coming in, or
338 * --delete trying to remove old .rsyncNNN files, hence it renames it
341 int robust_unlink(const char *fname)
344 return do_unlink(fname);
346 static int counter = 1;
348 char path[MAXPATHLEN];
350 rc = do_unlink(fname);
351 if (rc == 0 || errno != ETXTBSY)
354 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
355 pos = MAXPATHLEN - 1;
357 while (pos > 0 && path[pos-1] != '/')
359 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
361 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
366 /* start where the last one left off to reduce chance of clashes */
369 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
370 if (++counter >= MAX_RENAMES)
372 } while ((rc = access(path, 0)) == 0 && counter != start);
375 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
379 /* maybe we should return rename()'s exit status? Nah. */
380 if (do_rename(fname, path) != 0) {
388 /* Returns 0 on successful rename, 1 if we successfully copied the file
389 * across filesystems, -2 if copy_file() failed, and -1 on other errors.
390 * If partialptr is not NULL and we need to do a copy, copy the file into
391 * the active partial-dir instead of over the destination file. */
392 int robust_rename(const char *from, const char *to, const char *partialptr,
398 if (do_rename(from, to) == 0)
404 if (robust_unlink(to) != 0)
410 if (!handle_partial_dir(partialptr,PDIR_CREATE))
414 if (copy_file(from, to, -1, mode, 0) != 0)
425 static pid_t all_pids[10];
428 /** Fork and record the pid of the child. **/
431 pid_t newpid = fork();
433 if (newpid != 0 && newpid != -1) {
434 all_pids[num_pids++] = newpid;
442 * @todo It would be kind of nice to make sure that they are actually
443 * all our children before we kill them, because their pids may have
444 * been recycled by some other process. Perhaps when we wait for a
445 * child, we should remove it from this array. Alternatively we could
446 * perhaps use process groups, but I think that would not work on
447 * ancient Unix versions that don't support them.
449 void kill_all(int sig)
453 for (i = 0; i < num_pids; i++) {
454 /* Let's just be a little careful where we
455 * point that gun, hey? See kill(2) for the
456 * magic caused by negative values. */
457 pid_t p = all_pids[i];
468 /** Turn a user name into a uid */
469 int name_to_uid(const char *name, uid_t *uid_p)
474 if (!(pass = getpwnam(name)))
476 *uid_p = pass->pw_uid;
480 /** Turn a group name into a gid */
481 int name_to_gid(const char *name, gid_t *gid_p)
486 if (!(grp = getgrnam(name)))
488 *gid_p = grp->gr_gid;
492 /** Lock a byte range in a open file */
493 int lock_range(int fd, int offset, int len)
497 lock.l_type = F_WRLCK;
498 lock.l_whence = SEEK_SET;
499 lock.l_start = offset;
503 return fcntl(fd,F_SETLK,&lock) == 0;
506 static int filter_server_path(char *arg)
510 if (server_filter_list.head) {
511 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
513 if (check_filter(&server_filter_list, arg, 1) < 0) {
514 /* We must leave arg truncated! */
523 void glob_expand(char *s, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
525 char **argv = *argv_ptr;
526 int argc = *argc_ptr;
527 int maxargs = *maxargs_ptr;
528 #if !defined HAVE_GLOB || !defined HAVE_GLOB_H
529 if (argc == maxargs) {
531 if (!(argv = realloc_array(argv, char *, maxargs)))
532 out_of_memory("glob_expand");
534 *maxargs_ptr = maxargs;
538 s = argv[argc++] = strdup(s);
539 filter_server_path(s);
549 s = sanitize_path(NULL, s, "", 0);
553 out_of_memory("glob_expand");
555 memset(&globbuf, 0, sizeof globbuf);
556 if (!filter_server_path(s))
557 glob(s, 0, NULL, &globbuf);
558 if (MAX((int)globbuf.gl_pathc, 1) > maxargs - argc) {
559 maxargs += globbuf.gl_pathc + MAX_ARGS;
560 if (!(argv = realloc_array(argv, char *, maxargs)))
561 out_of_memory("glob_expand");
563 *maxargs_ptr = maxargs;
565 if (globbuf.gl_pathc == 0)
570 for (i = 0; i < (int)globbuf.gl_pathc; i++) {
571 if (!(argv[argc++] = strdup(globbuf.gl_pathv[i])))
572 out_of_memory("glob_expand");
580 /* This routine is only used in daemon mode. */
581 void glob_expand_module(char *base1, char *arg, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
585 int base_len = strlen(base);
590 if (strncmp(arg, base, base_len) == 0)
593 if (!(arg = strdup(arg)))
594 out_of_memory("glob_expand_module");
596 if (asprintf(&base," %s/", base1) <= 0)
597 out_of_memory("glob_expand_module");
600 for (s = arg; *s; s = p + base_len) {
601 if ((p = strstr(s, base)) != NULL)
602 *p = '\0'; /* split it at this point */
603 glob_expand(s, argv_ptr, argc_ptr, maxargs_ptr);
613 * Convert a string to lower case
615 void strlower(char *s)
624 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
625 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
626 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
627 * string fits into destsize. */
628 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
630 size_t len = strlcpy(dest, p1, destsize);
631 if (len < destsize - 1) {
632 if (!len || dest[len-1] != '/')
634 if (len < destsize - 1)
635 len += strlcpy(dest + len, p2, destsize - len);
642 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
646 /* Join any number of strings together, putting them in "dest". The return
647 * value is the length of all the strings, regardless of whether the null-
648 * terminated whole fits in destsize. Your list of string pointers must end
649 * with a NULL to indicate the end of the list. */
650 size_t stringjoin(char *dest, size_t destsize, ...)
656 va_start(ap, destsize);
658 if (!(src = va_arg(ap, const char *)))
665 memcpy(dest, src, len);
676 int count_dir_elements(const char *p)
678 int cnt = 0, new_component = 1;
681 new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
682 else if (new_component) {
690 /* Turns multiple adjacent slashes into a single slash, drops interior "."
691 * elements, drops an intial "./" unless CFN_KEEP_LEADING_DOT_DIR is flagged,
692 * will even drop a trailing '.' after a '/' if CFN_DROP_TRAILING_DOT_DIR is
693 * flagged, removes a trailing slash (perhaps after removing the aforementioned
694 * dot) unless CFN_KEEP_TRAILING_SLASH is flagged, will even collapse ".."
695 * elements (except at the start of the string) if CFN_COLLAPSE_DOT_DOT_DIRS
696 * is flagged. If the resulting name would be empty, we return ".". */
697 unsigned int clean_fname(char *name, int flags)
699 char *limit = name - 1, *t = name, *f = name;
705 if ((anchored = *f == '/') != 0)
707 else if (flags & CFN_KEEP_LEADING_DOT_DIR && *f == '.' && f[1] == '/') {
712 /* discard extra slashes */
718 /* discard interior "." dirs */
723 if (f[1] == '\0' && flags & CFN_DROP_TRAILING_DOT_DIR)
725 /* collapse ".." dirs */
726 if (flags & CFN_COLLAPSE_DOT_DOT_DIRS
727 && f[1] == '.' && (f[2] == '/' || !f[2])) {
729 if (s == name && anchored) {
733 while (s > limit && *--s != '/') {}
734 if (s != t - 1 && (s < name || *s == '/')) {
742 while (*f && (*t++ = *f++) != '/') {}
745 if (t > name+anchored && t[-1] == '/' && !(flags & CFN_KEEP_TRAILING_SLASH))
754 /* Make path appear as if a chroot had occurred. This handles a leading
755 * "/" (either removing it or expanding it) and any leading or embedded
756 * ".." components that attempt to escape past the module's top dir.
758 * If dest is NULL, a buffer is allocated to hold the result. It is legal
759 * to call with the dest and the path (p) pointing to the same buffer, but
760 * rootdir will be ignored to avoid expansion of the string.
762 * The rootdir string contains a value to use in place of a leading slash.
763 * Specify NULL to get the default of "module_dir".
765 * The depth var is a count of how many '..'s to allow at the start of the
768 * We also clean the path in a manner similar to clean_fname() but with a
771 * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
772 * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
773 * ALWAYS collapses ".." elements (except for those at the start of the
774 * string up to "depth" deep). If the resulting name would be empty,
775 * change it into a ".". */
776 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
779 int rlen = 0, leave_one_dotdir = relative_paths;
782 int plen = strlen(p);
785 rootdir = module_dir;
786 rlen = strlen(rootdir);
791 if (rlen + plen + 1 >= MAXPATHLEN)
793 } else if (!(dest = new_array(char, rlen + plen + 1)))
794 out_of_memory("sanitize_path");
796 memcpy(dest, rootdir, rlen);
802 start = sanp = dest + rlen;
804 /* discard leading or extra slashes */
809 /* this loop iterates once per filename component in p.
810 * both p (and sanp if the original had a slash) should
811 * always be left pointing after a slash
813 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
814 if (leave_one_dotdir && p[1])
815 leave_one_dotdir = 0;
817 /* skip "." component */
822 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
823 /* ".." component followed by slash or end */
824 if (depth <= 0 || sanp != start) {
827 /* back up sanp one level */
828 --sanp; /* now pointing at slash */
829 while (sanp > start && sanp[-1] != '/') {
830 /* skip back up to slash */
836 /* allow depth levels of .. at the beginning */
838 /* move the virtual beginning to leave the .. alone */
841 /* copy one component through next slash */
842 while (*p && (*sanp++ = *p++) != '/') {}
845 /* ended up with nothing, so put in "." component */
853 /* Like chdir(), but it keeps track of the current directory (in the
854 * global "curr_dir"), and ensures that the path size doesn't overflow.
855 * Also cleans the path using the clean_fname() function. */
856 int push_dir(const char *dir, int set_path_only)
858 static int initialised;
863 getcwd(curr_dir, sizeof curr_dir - 1);
864 curr_dir_len = strlen(curr_dir);
867 if (!dir) /* this call was probably just to initialize */
871 if (len == 1 && *dir == '.')
874 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir) {
875 errno = ENAMETOOLONG;
879 if (!set_path_only && chdir(dir))
883 memcpy(curr_dir, dir, len + 1);
886 curr_dir[curr_dir_len++] = '/';
887 memcpy(curr_dir + curr_dir_len, dir, len + 1);
891 curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
892 if (sanitize_paths) {
893 if (module_dirlen > curr_dir_len)
894 module_dirlen = curr_dir_len;
895 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
898 if (verbose >= 5 && !set_path_only)
899 rprintf(FINFO, "[%s] push_dir(%s)\n", who_am_i(), curr_dir);
905 * Reverse a push_dir() call. You must pass in an absolute path
906 * that was copied from a prior value of "curr_dir".
908 int pop_dir(const char *dir)
913 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
914 if (curr_dir_len >= sizeof curr_dir)
915 curr_dir_len = sizeof curr_dir - 1;
917 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
920 rprintf(FINFO, "[%s] pop_dir(%s)\n", who_am_i(), curr_dir);
926 * Return a quoted string with the full pathname of the indicated filename.
927 * The string " (in MODNAME)" may also be appended. The returned pointer
928 * remains valid until the next time full_fname() is called.
930 char *full_fname(const char *fn)
932 static char *result = NULL;
942 p1 = curr_dir + module_dirlen;
943 for (p2 = p1; *p2 == '/'; p2++) {}
947 if (module_id >= 0) {
949 m2 = lp_name(module_id);
954 if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) <= 0)
955 out_of_memory("full_fname");
960 static char partial_fname[MAXPATHLEN];
962 char *partial_dir_fname(const char *fname)
964 char *t = partial_fname;
965 int sz = sizeof partial_fname;
968 if ((fn = strrchr(fname, '/')) != NULL) {
970 if (*partial_dir != '/') {
971 int len = fn - fname;
972 strncpy(t, fname, len); /* safe */
978 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
980 if (server_filter_list.head) {
981 t = strrchr(partial_fname, '/');
983 if (check_filter(&server_filter_list, partial_fname, 1) < 0)
986 if (check_filter(&server_filter_list, partial_fname, 0) < 0)
990 return partial_fname;
993 /* If no --partial-dir option was specified, we don't need to do anything
994 * (the partial-dir is essentially '.'), so just return success. */
995 int handle_partial_dir(const char *fname, int create)
999 if (fname != partial_fname)
1001 if (!create && *partial_dir == '/')
1003 if (!(fn = strrchr(partial_fname, '/')))
1007 dir = partial_fname;
1010 int statret = do_lstat(dir, &st);
1011 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1012 if (do_unlink(dir) < 0)
1016 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1026 * Determine if a symlink points outside the current directory tree.
1027 * This is considered "unsafe" because e.g. when mirroring somebody
1028 * else's machine it might allow them to establish a symlink to
1029 * /etc/passwd, and then read it through a web server.
1031 * Null symlinks and absolute symlinks are always unsafe.
1033 * Basically here we are concerned with symlinks whose target contains
1034 * "..", because this might cause us to walk back up out of the
1035 * transferred directory. We are not allowed to go back up and
1038 * @param dest Target of the symlink in question.
1040 * @param src Top source directory currently applicable. Basically this
1041 * is the first parameter to rsync in a simple invocation, but it's
1042 * modified by flist.c in slightly complex ways.
1044 * @retval True if unsafe
1045 * @retval False is unsafe
1049 int unsafe_symlink(const char *dest, const char *src)
1051 const char *name, *slash;
1054 /* all absolute and null symlinks are unsafe */
1055 if (!dest || !*dest || *dest == '/')
1058 /* find out what our safety margin is */
1059 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1060 if (strncmp(name, "../", 3) == 0) {
1062 } else if (strncmp(name, "./", 2) == 0) {
1068 if (strcmp(name, "..") == 0)
1071 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1072 if (strncmp(name, "../", 3) == 0) {
1073 /* if at any point we go outside the current directory
1074 then stop - it is unsafe */
1077 } else if (strncmp(name, "./", 2) == 0) {
1083 if (strcmp(name, "..") == 0)
1089 /* Return the int64 number as a string. If the --human-readable option was
1090 * specified, we may output the number in K, M, or G units. We can return
1091 * up to 4 buffers at a time. */
1092 char *human_num(int64 num)
1094 static char bufs[4][128]; /* more than enough room */
1095 static unsigned int n;
1098 n = (n + 1) % (sizeof bufs / sizeof bufs[0]);
1100 if (human_readable) {
1102 int mult = human_readable == 1 ? 1000 : 1024;
1104 if (num > mult*mult*mult) {
1105 dnum = (double)num / (mult*mult*mult);
1107 } else if (num > mult*mult) {
1108 dnum = (double)num / (mult*mult);
1110 } else if (num > mult) {
1111 dnum = (double)num / mult;
1115 snprintf(bufs[n], sizeof bufs[0], "%.2f%c", dnum, units);
1120 s = bufs[n] + sizeof bufs[0] - 1;
1126 *--s = (char)(num % 10) + '0';
1132 /* Return the double number as a string. If the --human-readable option was
1133 * specified, we may output the number in K, M, or G units. We use a buffer
1134 * from human_num() to return our result. */
1135 char *human_dnum(double dnum, int decimal_digits)
1137 char *buf = human_num(dnum);
1138 int len = strlen(buf);
1139 if (isDigit(buf + len - 1)) {
1140 /* There's extra room in buf prior to the start of the num. */
1141 buf -= decimal_digits + 1;
1142 snprintf(buf, len + decimal_digits + 2, "%.*f", decimal_digits, dnum);
1147 /* Return the date and time as a string. Some callers tweak returned buf. */
1148 char *timestring(time_t t)
1150 static char TimeBuf[200];
1151 struct tm *tm = localtime(&t);
1154 #ifdef HAVE_STRFTIME
1155 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1157 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1160 if ((p = strchr(TimeBuf, '\n')) != NULL)
1167 * Sleep for a specified number of milliseconds.
1169 * Always returns TRUE. (In the future it might return FALSE if
1175 struct timeval tval, t1, t2;
1177 gettimeofday(&t1, NULL);
1180 tval.tv_sec = (t-tdiff)/1000;
1181 tval.tv_usec = 1000*((t-tdiff)%1000);
1184 select(0,NULL,NULL, NULL, &tval);
1186 gettimeofday(&t2, NULL);
1187 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
1188 (t2.tv_usec - t1.tv_usec)/1000;
1194 /* Determine if two time_t values are equivalent (either exact, or in
1195 * the modification timestamp window established by --modify-window).
1197 * @retval 0 if the times should be treated as the same
1199 * @retval +1 if the first is later
1201 * @retval -1 if the 2nd is later
1203 int cmp_time(time_t file1, time_t file2)
1205 if (file2 > file1) {
1206 if (file2 - file1 <= modify_window)
1210 if (file1 - file2 <= modify_window)
1220 This routine is a trick to immediately catch errors when debugging
1221 with insure. A xterm with a gdb is popped up when insure catches
1222 a error. It is Linux specific.
1224 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1230 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'",
1231 getpid(), getpid(), getpid());
1235 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1236 fn = dlsym(h, "_Insure_trap_error");
1239 ret = fn(a1, a2, a3, a4, a5, a6);
1249 #define MALLOC_MAX 0x40000000
1251 void *_new_array(unsigned long num, unsigned int size, int use_calloc)
1253 if (num >= MALLOC_MAX/size)
1255 return use_calloc ? calloc(num, size) : malloc(num * size);
1258 void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1260 if (num >= MALLOC_MAX/size)
1263 return malloc(size * num);
1264 return realloc(ptr, size * num);
1267 /* Take a filename and filename length and return the most significant
1268 * filename suffix we can find. This ignores suffixes such as "~",
1269 * ".bak", ".orig", ".~1~", etc. */
1270 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1272 const char *suf, *s;
1276 /* One or more dots at the start aren't a suffix. */
1277 while (fn_len && *fn == '.') fn++, fn_len--;
1279 /* Ignore the ~ in a "foo~" filename. */
1280 if (fn_len > 1 && fn[fn_len-1] == '~')
1281 fn_len--, had_tilde = True;
1285 /* Assume we don't find an suffix. */
1289 /* Find the last significant suffix. */
1290 for (s = fn + fn_len; fn_len > 1; ) {
1291 while (*--s != '.' && s != fn) {}
1294 s_len = fn_len - (s - fn);
1297 if (strcmp(s+1, "bak") == 0
1298 || strcmp(s+1, "old") == 0)
1300 } else if (s_len == 5) {
1301 if (strcmp(s+1, "orig") == 0)
1303 } else if (s_len > 2 && had_tilde
1304 && s[1] == '~' && isDigit(s + 2))
1310 /* Determine if the suffix is all digits. */
1311 for (s++, s_len--; s_len > 0; s++, s_len--) {
1315 /* An all-digit suffix may not be that signficant. */
1322 /* This is an implementation of the Levenshtein distance algorithm. It
1323 * was implemented to avoid needing a two-dimensional matrix (to save
1324 * memory). It was also tweaked to try to factor in the ASCII distance
1325 * between changed characters as a minor distance quantity. The normal
1326 * Levenshtein units of distance (each signifying a single change between
1327 * the two strings) are defined as a "UNIT". */
1329 #define UNIT (1 << 16)
1331 uint32 fuzzy_distance(const char *s1, int len1, const char *s2, int len2)
1333 uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1337 if (!len1 || !len2) {
1342 for (i1 = 0, cost = 0; i1 < len1; i1++)
1344 return (int32)len1 * UNIT + cost;
1347 for (i2 = 0; i2 < len2; i2++)
1348 a[i2] = (i2+1) * UNIT;
1350 for (i1 = 0; i1 < len1; i1++) {
1352 above = (i1+1) * UNIT;
1353 for (i2 = 0; i2 < len2; i2++) {
1355 if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1361 diag_inc = diag + cost;
1362 left_inc = left + UNIT + *((uchar*)s1+i1);
1363 above_inc = above + UNIT + *((uchar*)s2+i2);
1364 a[i2] = above = left < above
1365 ? (left_inc < diag_inc ? left_inc : diag_inc)
1366 : (above_inc < diag_inc ? above_inc : diag_inc);
1374 #define BB_SLOT_SIZE (16*1024) /* Desired size in bytes */
1375 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1376 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1383 struct bitbag *bitbag_create(int max_ndx)
1385 struct bitbag *bb = new(struct bitbag);
1386 bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1388 if (!(bb->bits = (uint32**)calloc(bb->slot_cnt, sizeof (uint32*))))
1389 out_of_memory("bitbag_create");
1394 void bitbag_set_bit(struct bitbag *bb, int ndx)
1396 int slot = ndx / BB_PER_SLOT_BITS;
1397 ndx %= BB_PER_SLOT_BITS;
1399 if (!bb->bits[slot]) {
1400 if (!(bb->bits[slot] = (uint32*)calloc(BB_PER_SLOT_INTS, 4)))
1401 out_of_memory("bitbag_set_bit");
1404 bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1407 #if 0 /* not needed yet */
1408 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1410 int slot = ndx / BB_PER_SLOT_BITS;
1411 ndx %= BB_PER_SLOT_BITS;
1413 if (!bb->bits[slot])
1416 bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1419 int bitbag_check_bit(struct bitbag *bb, int ndx)
1421 int slot = ndx / BB_PER_SLOT_BITS;
1422 ndx %= BB_PER_SLOT_BITS;
1424 if (!bb->bits[slot])
1427 return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1431 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
1432 int bitbag_next_bit(struct bitbag *bb, int after)
1435 int i, ndx = after + 1;
1436 int slot = ndx / BB_PER_SLOT_BITS;
1437 ndx %= BB_PER_SLOT_BITS;
1439 mask = (1u << (ndx % 32)) - 1;
1440 for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1441 if (!bb->bits[slot])
1443 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1444 if (!(bits = bb->bits[slot][i] & ~mask))
1446 /* The xor magic figures out the lowest enabled bit in
1447 * bits, and the switch quickly computes log2(bit). */
1448 switch (bits ^ (bits & (bits-1))) {
1449 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1450 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
1451 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
1452 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
1453 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1454 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1455 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1456 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1457 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1459 return -1; /* impossible... */
1466 void *expand_item_list(item_list *lp, size_t item_size,
1467 const char *desc, int incr)
1469 /* First time through, 0 <= 0, so list is expanded. */
1470 if (lp->malloced <= lp->count) {
1472 size_t new_size = lp->malloced;
1474 new_size += -incr; /* increase slowly */
1475 else if (new_size < (size_t)incr)
1479 new_ptr = realloc_array(lp->items, char, new_size * item_size);
1481 rprintf(FINFO, "[%s] expand %s to %.0f bytes, did%s move\n",
1482 who_am_i(), desc, (double)new_size * item_size,
1483 new_ptr == lp->items ? " not" : "");
1486 out_of_memory("expand_item_list");
1488 lp->items = new_ptr;
1489 lp->malloced = new_size;
1491 return (char*)lp->items + (lp->count++ * item_size);