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-2007 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;
151 return 0; /* ignore errors */
154 return utimes(fname, t);
155 #elif defined HAVE_UTIMBUF
157 tbuf.actime = time(NULL);
158 tbuf.modtime = modtime;
159 return utime(fname,&tbuf);
160 #elif defined HAVE_UTIME
164 return utime(fname,t);
166 #error No file-time-modification routine found!
171 /* This creates a new directory with default permissions. Since there
172 * might be some directory-default permissions affecting this, we can't
173 * force the permissions directly using the original umask and mkdir(). */
174 int mkdir_defmode(char *fname)
179 ret = do_mkdir(fname, ACCESSPERMS);
185 /* Create any necessary directories in fname. Any missing directories are
186 * created with default permissions. */
187 int create_directory_path(char *fname)
192 while (*fname == '/')
194 while (strncmp(fname, "./", 2) == 0)
199 while ((p = strchr(p,'/')) != NULL) {
201 if (do_mkdir(fname, ACCESSPERMS) < 0 && errno != EEXIST)
211 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
214 * @retval len upon success
216 * @retval <0 write's (negative) error code
218 * Derived from GNU C's cccp.c.
220 int full_write(int desc, const char *ptr, size_t len)
226 int written = write(desc, ptr, len);
232 total_written += written;
236 return total_written;
240 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
243 * @retval >0 the actual number of bytes read
247 * @retval <0 for an error.
249 * Derived from GNU C's cccp.c. */
250 static int safe_read(int desc, char *ptr, size_t len)
258 n_chars = read(desc, ptr, len);
259 } while (n_chars < 0 && errno == EINTR);
266 * This is used in conjunction with the --temp-dir, --backup, and
267 * --copy-dest options. */
268 int copy_file(const char *source, const char *dest, mode_t mode, int create_bak_dir)
273 int len; /* Number of bytes read into `buf'. */
275 if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
276 rsyserr(FERROR, errno, "open %s", full_fname(source));
280 if (robust_unlink(dest) && errno != ENOENT) {
281 rsyserr(FERROR, errno, "unlink %s", full_fname(dest));
285 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0
286 && (!create_bak_dir || errno != ENOENT || make_bak_dir(dest) < 0
287 || (ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0)) {
288 rsyserr(FERROR, errno, "open %s", full_fname(dest));
293 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
294 if (full_write(ofd, buf, len) < 0) {
295 rsyserr(FERROR, errno, "write %s", full_fname(dest));
303 rsyserr(FERROR, errno, "read %s", full_fname(source));
309 if (close(ifd) < 0) {
310 rsyserr(FINFO, errno, "close failed on %s",
314 if (close(ofd) < 0) {
315 rsyserr(FERROR, errno, "close failed on %s",
323 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
324 #define MAX_RENAMES_DIGITS 3
325 #define MAX_RENAMES 1000
328 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
329 * rename to <path>/.rsyncNNN instead.
331 * Note that successive rsync runs will shuffle the filenames around a
332 * bit as long as the file is still busy; this is because this function
333 * does not know if the unlink call is due to a new file coming in, or
334 * --delete trying to remove old .rsyncNNN files, hence it renames it
337 int robust_unlink(const char *fname)
340 return do_unlink(fname);
342 static int counter = 1;
344 char path[MAXPATHLEN];
346 rc = do_unlink(fname);
347 if (rc == 0 || errno != ETXTBSY)
350 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
351 pos = MAXPATHLEN - 1;
353 while (pos > 0 && path[pos-1] != '/')
355 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
357 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
362 /* start where the last one left off to reduce chance of clashes */
365 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
366 if (++counter >= MAX_RENAMES)
368 } while ((rc = access(path, 0)) == 0 && counter != start);
371 rprintf(FINFO,"renaming %s to %s because of text busy\n",
375 /* maybe we should return rename()'s exit status? Nah. */
376 if (do_rename(fname, path) != 0) {
384 /* Returns 0 on successful rename, 1 if we successfully copied the file
385 * across filesystems, -2 if copy_file() failed, and -1 on other errors.
386 * If partialptr is not NULL and we need to do a copy, copy the file into
387 * the active partial-dir instead of over the destination file. */
388 int robust_rename(const char *from, const char *to, const char *partialptr,
394 if (do_rename(from, to) == 0)
400 if (robust_unlink(to) != 0)
406 if (!handle_partial_dir(partialptr,PDIR_CREATE))
410 if (copy_file(from, to, mode, 0) != 0)
421 static pid_t all_pids[10];
424 /** Fork and record the pid of the child. **/
427 pid_t newpid = fork();
429 if (newpid != 0 && newpid != -1) {
430 all_pids[num_pids++] = newpid;
438 * @todo It would be kind of nice to make sure that they are actually
439 * all our children before we kill them, because their pids may have
440 * been recycled by some other process. Perhaps when we wait for a
441 * child, we should remove it from this array. Alternatively we could
442 * perhaps use process groups, but I think that would not work on
443 * ancient Unix versions that don't support them.
445 void kill_all(int sig)
449 for (i = 0; i < num_pids; i++) {
450 /* Let's just be a little careful where we
451 * point that gun, hey? See kill(2) for the
452 * magic caused by negative values. */
453 pid_t p = all_pids[i];
464 /** Turn a user name into a uid */
465 int name_to_uid(const char *name, uid_t *uid)
470 pass = getpwnam(name);
478 /** Turn a group name into a gid */
479 int name_to_gid(const char *name, gid_t *gid)
484 grp = getgrnam(name);
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, NULL);
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, gets rid of "./"
691 * elements (but not a trailing dot dir), removes a trailing slash, and
692 * optionally collapses ".." elements (except for those at the start of the
693 * string). If the resulting name would be empty, change it into a ".". */
694 unsigned int clean_fname(char *name, BOOL collapse_dot_dot)
696 char *limit = name - 1, *t = name, *f = name;
702 if ((anchored = *f == '/') != 0)
705 /* discard extra slashes */
711 /* discard "." dirs (but NOT a trailing '.'!) */
716 /* collapse ".." dirs */
718 && f[1] == '.' && (f[2] == '/' || !f[2])) {
720 if (s == name && anchored) {
724 while (s > limit && *--s != '/') {}
725 if (s != t - 1 && (s < name || *s == '/')) {
733 while (*f && (*t++ = *f++) != '/') {}
736 if (t > name+anchored && t[-1] == '/')
745 /* Make path appear as if a chroot had occurred. This handles a leading
746 * "/" (either removing it or expanding it) and any leading or embedded
747 * ".." components that attempt to escape past the module's top dir.
749 * If dest is NULL, a buffer is allocated to hold the result. It is legal
750 * to call with the dest and the path (p) pointing to the same buffer, but
751 * rootdir will be ignored to avoid expansion of the string.
753 * The rootdir string contains a value to use in place of a leading slash.
754 * Specify NULL to get the default of "module_dir".
756 * The depth var is a count of how many '..'s to allow at the start of the
757 * path. If symlink is set, combine its value with the "p" value to get
758 * the target path, and **return NULL if any '..'s try to escape**.
760 * We also clean the path in a manner similar to clean_fname() but with a
763 * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
764 * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
765 * ALWAYS collapses ".." elements (except for those at the start of the
766 * string up to "depth" deep). If the resulting name would be empty,
767 * change it into a ".". */
768 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth,
771 char *start, *sanp, *save_dest = dest;
772 int rlen = 0, leave_one_dotdir = relative_paths;
774 if (symlink && *symlink == '/') {
780 int plen = strlen(p);
783 rootdir = module_dir;
784 rlen = strlen(rootdir);
789 if (rlen + plen + 1 >= MAXPATHLEN)
791 } else if (!(dest = new_array(char, rlen + plen + 1)))
792 out_of_memory("sanitize_path");
794 memcpy(dest, rootdir, rlen);
800 start = sanp = dest + rlen;
803 if (!symlink || !*symlink)
805 while (sanp != start && sanp[-1] != '/') {
806 /* strip last element */
809 /* Append a relative symlink */
813 /* discard leading or extra slashes */
818 /* this loop iterates once per filename component in p.
819 * both p (and sanp if the original had a slash) should
820 * always be left pointing after a slash
822 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
823 if (leave_one_dotdir && p[1])
824 leave_one_dotdir = 0;
826 /* skip "." component */
831 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
832 /* ".." component followed by slash or end */
833 if (depth <= 0 || sanp != start) {
834 if (symlink && sanp == start) {
841 /* back up sanp one level */
842 --sanp; /* now pointing at slash */
843 while (sanp > start && sanp[-1] != '/') {
844 /* skip back up to slash */
850 /* allow depth levels of .. at the beginning */
852 /* move the virtual beginning to leave the .. alone */
855 /* copy one component through next slash */
856 while (*p && (*sanp++ = *p++) != '/') {}
859 /* ended up with nothing, so put in "." component */
867 /* Like chdir(), but it keeps track of the current directory (in the
868 * global "curr_dir"), and ensures that the path size doesn't overflow.
869 * Also cleans the path using the clean_fname() function. */
870 int push_dir(const char *dir, int set_path_only)
872 static int initialised;
877 getcwd(curr_dir, sizeof curr_dir - 1);
878 curr_dir_len = strlen(curr_dir);
881 if (!dir) /* this call was probably just to initialize */
885 if (len == 1 && *dir == '.')
888 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir) {
889 errno = ENAMETOOLONG;
893 if (!set_path_only && chdir(dir))
897 memcpy(curr_dir, dir, len + 1);
900 curr_dir[curr_dir_len++] = '/';
901 memcpy(curr_dir + curr_dir_len, dir, len + 1);
905 curr_dir_len = clean_fname(curr_dir, 1);
906 if (sanitize_paths) {
907 if (module_dirlen > curr_dir_len)
908 module_dirlen = curr_dir_len;
909 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
916 * Reverse a push_dir() call. You must pass in an absolute path
917 * that was copied from a prior value of "curr_dir".
919 int pop_dir(const char *dir)
924 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
925 if (curr_dir_len >= sizeof curr_dir)
926 curr_dir_len = sizeof curr_dir - 1;
928 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
934 * Return a quoted string with the full pathname of the indicated filename.
935 * The string " (in MODNAME)" may also be appended. The returned pointer
936 * remains valid until the next time full_fname() is called.
938 char *full_fname(const char *fn)
940 static char *result = NULL;
950 p1 = curr_dir + module_dirlen;
951 for (p2 = p1; *p2 == '/'; p2++) {}
955 if (module_id >= 0) {
957 m2 = lp_name(module_id);
962 if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) <= 0)
963 out_of_memory("full_fname");
968 static char partial_fname[MAXPATHLEN];
970 char *partial_dir_fname(const char *fname)
972 char *t = partial_fname;
973 int sz = sizeof partial_fname;
976 if ((fn = strrchr(fname, '/')) != NULL) {
978 if (*partial_dir != '/') {
979 int len = fn - fname;
980 strncpy(t, fname, len); /* safe */
986 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
988 if (server_filter_list.head) {
989 t = strrchr(partial_fname, '/');
991 if (check_filter(&server_filter_list, partial_fname, 1) < 0)
994 if (check_filter(&server_filter_list, partial_fname, 0) < 0)
998 return partial_fname;
1001 /* If no --partial-dir option was specified, we don't need to do anything
1002 * (the partial-dir is essentially '.'), so just return success. */
1003 int handle_partial_dir(const char *fname, int create)
1007 if (fname != partial_fname)
1009 if (!create && *partial_dir == '/')
1011 if (!(fn = strrchr(partial_fname, '/')))
1015 dir = partial_fname;
1018 int statret = do_lstat(dir, &st);
1019 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1020 if (do_unlink(dir) < 0)
1024 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1034 * Determine if a symlink points outside the current directory tree.
1035 * This is considered "unsafe" because e.g. when mirroring somebody
1036 * else's machine it might allow them to establish a symlink to
1037 * /etc/passwd, and then read it through a web server.
1039 * Null symlinks and absolute symlinks are always unsafe.
1041 * Basically here we are concerned with symlinks whose target contains
1042 * "..", because this might cause us to walk back up out of the
1043 * transferred directory. We are not allowed to go back up and
1046 * @param dest Target of the symlink in question.
1048 * @param src Top source directory currently applicable. Basically this
1049 * is the first parameter to rsync in a simple invocation, but it's
1050 * modified by flist.c in slightly complex ways.
1052 * @retval True if unsafe
1053 * @retval False is unsafe
1057 int unsafe_symlink(const char *dest, const char *src)
1059 const char *name, *slash;
1062 /* all absolute and null symlinks are unsafe */
1063 if (!dest || !*dest || *dest == '/')
1066 /* find out what our safety margin is */
1067 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1068 if (strncmp(name, "../", 3) == 0) {
1070 } else if (strncmp(name, "./", 2) == 0) {
1076 if (strcmp(name, "..") == 0)
1079 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1080 if (strncmp(name, "../", 3) == 0) {
1081 /* if at any point we go outside the current directory
1082 then stop - it is unsafe */
1085 } else if (strncmp(name, "./", 2) == 0) {
1091 if (strcmp(name, "..") == 0)
1097 /* Return the int64 number as a string. If the --human-readable option was
1098 * specified, we may output the number in K, M, or G units. We can return
1099 * up to 4 buffers at a time. */
1100 char *human_num(int64 num)
1102 static char bufs[4][128]; /* more than enough room */
1103 static unsigned int n;
1106 n = (n + 1) % (sizeof bufs / sizeof bufs[0]);
1108 if (human_readable) {
1110 int mult = human_readable == 1 ? 1000 : 1024;
1112 if (num > mult*mult*mult) {
1113 dnum = (double)num / (mult*mult*mult);
1115 } else if (num > mult*mult) {
1116 dnum = (double)num / (mult*mult);
1118 } else if (num > mult) {
1119 dnum = (double)num / mult;
1123 snprintf(bufs[n], sizeof bufs[0], "%.2f%c", dnum, units);
1128 s = bufs[n] + sizeof bufs[0] - 1;
1134 *--s = (char)(num % 10) + '0';
1140 /* Return the double number as a string. If the --human-readable option was
1141 * specified, we may output the number in K, M, or G units. We use a buffer
1142 * from human_num() to return our result. */
1143 char *human_dnum(double dnum, int decimal_digits)
1145 char *buf = human_num(dnum);
1146 int len = strlen(buf);
1147 if (isDigit(buf + len - 1)) {
1148 /* There's extra room in buf prior to the start of the num. */
1149 buf -= decimal_digits + 1;
1150 snprintf(buf, len + decimal_digits + 2, "%.*f", decimal_digits, dnum);
1155 /* Return the date and time as a string. Some callers tweak returned buf. */
1156 char *timestring(time_t t)
1158 static char TimeBuf[200];
1159 struct tm *tm = localtime(&t);
1162 #ifdef HAVE_STRFTIME
1163 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1165 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1168 if ((p = strchr(TimeBuf, '\n')) != NULL)
1175 * Sleep for a specified number of milliseconds.
1177 * Always returns TRUE. (In the future it might return FALSE if
1183 struct timeval tval, t1, t2;
1185 gettimeofday(&t1, NULL);
1188 tval.tv_sec = (t-tdiff)/1000;
1189 tval.tv_usec = 1000*((t-tdiff)%1000);
1192 select(0,NULL,NULL, NULL, &tval);
1194 gettimeofday(&t2, NULL);
1195 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
1196 (t2.tv_usec - t1.tv_usec)/1000;
1202 /* Determine if two time_t values are equivalent (either exact, or in
1203 * the modification timestamp window established by --modify-window).
1205 * @retval 0 if the times should be treated as the same
1207 * @retval +1 if the first is later
1209 * @retval -1 if the 2nd is later
1211 int cmp_time(time_t file1, time_t file2)
1213 if (file2 > file1) {
1214 if (file2 - file1 <= modify_window)
1218 if (file1 - file2 <= modify_window)
1228 This routine is a trick to immediately catch errors when debugging
1229 with insure. A xterm with a gdb is popped up when insure catches
1230 a error. It is Linux specific.
1232 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1238 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'",
1239 getpid(), getpid(), getpid());
1243 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1244 fn = dlsym(h, "_Insure_trap_error");
1247 ret = fn(a1, a2, a3, a4, a5, a6);
1257 #define MALLOC_MAX 0x40000000
1259 void *_new_array(unsigned long num, unsigned int size, int use_calloc)
1261 if (num >= MALLOC_MAX/size)
1263 return use_calloc ? calloc(num, size) : malloc(num * size);
1266 void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1268 if (num >= MALLOC_MAX/size)
1271 return malloc(size * num);
1272 return realloc(ptr, size * num);
1275 /* Take a filename and filename length and return the most significant
1276 * filename suffix we can find. This ignores suffixes such as "~",
1277 * ".bak", ".orig", ".~1~", etc. */
1278 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1280 const char *suf, *s;
1284 /* One or more dots at the start aren't a suffix. */
1285 while (fn_len && *fn == '.') fn++, fn_len--;
1287 /* Ignore the ~ in a "foo~" filename. */
1288 if (fn_len > 1 && fn[fn_len-1] == '~')
1289 fn_len--, had_tilde = True;
1293 /* Assume we don't find an suffix. */
1297 /* Find the last significant suffix. */
1298 for (s = fn + fn_len; fn_len > 1; ) {
1299 while (*--s != '.' && s != fn) {}
1302 s_len = fn_len - (s - fn);
1305 if (strcmp(s+1, "bak") == 0
1306 || strcmp(s+1, "old") == 0)
1308 } else if (s_len == 5) {
1309 if (strcmp(s+1, "orig") == 0)
1311 } else if (s_len > 2 && had_tilde
1312 && s[1] == '~' && isDigit(s + 2))
1318 /* Determine if the suffix is all digits. */
1319 for (s++, s_len--; s_len > 0; s++, s_len--) {
1323 /* An all-digit suffix may not be that signficant. */
1330 /* This is an implementation of the Levenshtein distance algorithm. It
1331 * was implemented to avoid needing a two-dimensional matrix (to save
1332 * memory). It was also tweaked to try to factor in the ASCII distance
1333 * between changed characters as a minor distance quantity. The normal
1334 * Levenshtein units of distance (each signifying a single change between
1335 * the two strings) are defined as a "UNIT". */
1337 #define UNIT (1 << 16)
1339 uint32 fuzzy_distance(const char *s1, int len1, const char *s2, int len2)
1341 uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1345 if (!len1 || !len2) {
1350 for (i1 = 0, cost = 0; i1 < len1; i1++)
1352 return (int32)len1 * UNIT + cost;
1355 for (i2 = 0; i2 < len2; i2++)
1356 a[i2] = (i2+1) * UNIT;
1358 for (i1 = 0; i1 < len1; i1++) {
1360 above = (i1+1) * UNIT;
1361 for (i2 = 0; i2 < len2; i2++) {
1363 if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1369 diag_inc = diag + cost;
1370 left_inc = left + UNIT + *((uchar*)s1+i1);
1371 above_inc = above + UNIT + *((uchar*)s2+i2);
1372 a[i2] = above = left < above
1373 ? (left_inc < diag_inc ? left_inc : diag_inc)
1374 : (above_inc < diag_inc ? above_inc : diag_inc);
1382 #define BB_SLOT_SIZE (16*1024) /* Desired size in bytes */
1383 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1384 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1391 struct bitbag *bitbag_create(int max_ndx)
1393 struct bitbag *bb = new(struct bitbag);
1394 bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1396 if (!(bb->bits = (uint32**)calloc(bb->slot_cnt, sizeof (uint32*))))
1397 out_of_memory("bitbag_create");
1402 void bitbag_set_bit(struct bitbag *bb, int ndx)
1404 int slot = ndx / BB_PER_SLOT_BITS;
1405 ndx %= BB_PER_SLOT_BITS;
1407 if (!bb->bits[slot]) {
1408 if (!(bb->bits[slot] = (uint32*)calloc(BB_PER_SLOT_INTS, 4)))
1409 out_of_memory("bitbag_set_bit");
1412 bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1415 #if 0 /* not needed yet */
1416 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1418 int slot = ndx / BB_PER_SLOT_BITS;
1419 ndx %= BB_PER_SLOT_BITS;
1421 if (!bb->bits[slot])
1424 bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1427 int bitbag_check_bit(struct bitbag *bb, int ndx)
1429 int slot = ndx / BB_PER_SLOT_BITS;
1430 ndx %= BB_PER_SLOT_BITS;
1432 if (!bb->bits[slot])
1435 return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1439 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
1440 int bitbag_next_bit(struct bitbag *bb, int after)
1443 int i, ndx = after + 1;
1444 int slot = ndx / BB_PER_SLOT_BITS;
1445 ndx %= BB_PER_SLOT_BITS;
1447 mask = (1u << (ndx % 32)) - 1;
1448 for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1449 if (!bb->bits[slot])
1451 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1452 if (!(bits = bb->bits[slot][i] & ~mask))
1454 /* The xor magic figures out the lowest enabled bit in
1455 * bits, and the switch quickly computes log2(bit). */
1456 switch (bits ^ (bits & (bits-1))) {
1457 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1458 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
1459 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
1460 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
1461 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1462 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1463 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1464 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1465 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1467 return -1; /* impossible... */
1474 void *expand_item_list(item_list *lp, size_t item_size,
1475 const char *desc, int incr)
1477 /* First time through, 0 <= 0, so list is expanded. */
1478 if (lp->malloced <= lp->count) {
1480 size_t new_size = lp->malloced;
1482 new_size += -incr; /* increase slowly */
1483 else if (new_size < (size_t)incr)
1487 new_ptr = realloc_array(lp->items, char, new_size * item_size);
1489 rprintf(FINFO, "[%s] expand %s to %.0f bytes, did%s move\n",
1490 who_am_i(), desc, (double)new_size * item_size,
1491 new_ptr == lp->items ? " not" : "");
1494 out_of_memory("expand_item_list");
1496 lp->items = new_ptr;
1497 lp->malloced = new_size;
1499 return (char*)lp->items + (lp->count++ * item_size);