- Updated the address for the FSF in the opening comment.
[rsync/rsync.git] / util.c
diff --git a/util.c b/util.c
index 1297834..2ec56a7 100644 (file)
--- a/util.c
+++ b/util.c
@@ -1,8 +1,10 @@
-/*  -*- c-file-style: "linux" -*-
+/*
+ * Utility routines used in rsync.
  *
- * Copyright (C) 1996-2000 by Andrew Tridgell
- * Copyright (C) Paul Mackerras 1996
- * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
+ * Copyright (C) 1996-2000 Andrew Tridgell
+ * Copyright (C) 1996 Paul Mackerras
+ * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
-/**
- * @file
- *
- * Utilities used in rsync
- **/
-
 #include "rsync.h"
 
 extern int verbose;
@@ -32,16 +28,14 @@ extern int dry_run;
 extern int module_id;
 extern int modify_window;
 extern int relative_paths;
+extern int human_readable;
+extern mode_t orig_umask;
 extern char *partial_dir;
 extern struct filter_list_struct server_filter_list;
 
 int sanitize_paths = 0;
 
-
-
-/**
- * Set a fd into nonblocking mode
- **/
+/* Set a fd into nonblocking mode. */
 void set_nonblocking(int fd)
 {
        int val;
@@ -54,9 +48,7 @@ void set_nonblocking(int fd)
        }
 }
 
-/**
- * Set a fd into blocking mode
- **/
+/* Set a fd into blocking mode. */
 void set_blocking(int fd)
 {
        int val;
@@ -69,7 +61,6 @@ void set_blocking(int fd)
        }
 }
 
-
 /**
  * Create a file descriptor pair - like pipe() but use socketpair if
  * possible (because of blocking issues on pipes).
@@ -94,7 +85,6 @@ int fd_pair(int fd[2])
        return ret;
 }
 
-
 void print_child_argv(char **cmd)
 {
        rprintf(FINFO, "opening connection using ");
@@ -106,15 +96,14 @@ void print_child_argv(char **cmd)
                           "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
                           "0123456789"
                           ",.-_=+@/") != strlen(*cmd)) {
-                       rprintf(FINFO, "\"%s\" ", safe_fname(*cmd));
+                       rprintf(FINFO, "\"%s\" ", *cmd);
                } else {
-                       rprintf(FINFO, "%s ", safe_fname(*cmd));
+                       rprintf(FINFO, "%s ", *cmd);
                }
        }
        rprintf(FINFO, "\n");
 }
 
-
 void out_of_memory(char *str)
 {
        rprintf(FERROR, "ERROR: out of memory in %s\n", str);
@@ -127,8 +116,6 @@ void overflow_exit(char *str)
        exit_cleanup(RERR_MALLOC);
 }
 
-
-
 int set_modtime(char *fname, time_t modtime, mode_t mode)
 {
 #if !defined HAVE_LUTIMES || !defined HAVE_UTIMES
@@ -138,7 +125,7 @@ int set_modtime(char *fname, time_t modtime, mode_t mode)
 
        if (verbose > 2) {
                rprintf(FINFO, "set modtime of %s to (%ld) %s",
-                       safe_fname(fname), (long)modtime,
+                       fname, (long)modtime,
                        asctime(localtime(&modtime)));
        }
 
@@ -173,31 +160,44 @@ int set_modtime(char *fname, time_t modtime, mode_t mode)
        }
 }
 
+/* This creates a new directory with default permissions.  Since there
+ * might be some directory-default permissions affecting this, we can't
+ * force the permissions directly using the original umask and mkdir(). */
+int mkdir_defmode(char *fname)
+{
+       int ret;
 
-/**
-   Create any necessary directories in fname. Unfortunately we don't know
-   what perms to give the directory when this is called so we need to rely
-   on the umask
-**/
-int create_directory_path(char *fname, int base_umask)
+       umask(orig_umask);
+       ret = do_mkdir(fname, ACCESSPERMS);
+       umask(0);
+
+       return ret;
+}
+
+/* Create any necessary directories in fname.  Any missing directories are
+ * created with default permissions. */
+int create_directory_path(char *fname)
 {
        char *p;
+       int ret = 0;
 
        while (*fname == '/')
                fname++;
        while (strncmp(fname, "./", 2) == 0)
                fname += 2;
 
+       umask(orig_umask);
        p = fname;
        while ((p = strchr(p,'/')) != NULL) {
-               *p = 0;
-               do_mkdir(fname, 0777 & ~base_umask);
-               *p = '/';
-               p++;
+               *p = '\0';
+               if (do_mkdir(fname, ACCESSPERMS) < 0 && errno != EEXIST)
+                   ret = -1;
+               *p++ = '/';
        }
-       return 0;
-}
+       umask(0);
 
+       return ret;
+}
 
 /**
  * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
@@ -228,7 +228,6 @@ int full_write(int desc, char *ptr, size_t len)
        return total_written;
 }
 
-
 /**
  * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
  * interrupted.
@@ -254,12 +253,11 @@ static int safe_read(int desc, char *ptr, size_t len)
        return n_chars;
 }
 
-
 /** Copy a file.
  *
  * This is used in conjunction with the --temp-dir, --backup, and
  * --copy-dest options. */
-int copy_file(char *source, char *dest, mode_t mode)
+int copy_file(const char *source, const char *dest, mode_t mode)
 {
        int ifd;
        int ofd;
@@ -328,7 +326,7 @@ int copy_file(char *source, char *dest, mode_t mode)
  * --delete trying to remove old .rsyncNNN files, hence it renames it
  * each time.
  **/
-int robust_unlink(char *fname)
+int robust_unlink(const char *fname)
 {
 #ifndef ETXTBSY
        return do_unlink(fname);
@@ -363,7 +361,7 @@ int robust_unlink(char *fname)
 
        if (verbose > 0) {
                rprintf(FINFO,"renaming %s to %s because of text busy\n",
-                       safe_fname(fname), safe_fname(path));
+                       fname, path);
        }
 
        /* maybe we should return rename()'s exit status? Nah. */
@@ -376,8 +374,11 @@ int robust_unlink(char *fname)
 }
 
 /* Returns 0 on successful rename, 1 if we successfully copied the file
- * across filesystems, -2 if copy_file() failed, and -1 on other errors. */
-int robust_rename(char *from, char *to, int mode)
+ * across filesystems, -2 if copy_file() failed, and -1 on other errors.
+ * If partialptr is not NULL and we need to do a copy, copy the file into
+ * the active partial-dir instead of over the destination file. */
+int robust_rename(char *from, char *to, char *partialptr,
+                 int mode)
 {
        int tries = 4;
 
@@ -393,6 +394,11 @@ int robust_rename(char *from, char *to, int mode)
                        break;
 #endif
                case EXDEV:
+                       if (partialptr) {
+                               if (!handle_partial_dir(partialptr,PDIR_CREATE))
+                                       return -1;
+                               to = partialptr;
+                       }
                        if (copy_file(from, to, mode) != 0)
                                return -2;
                        do_unlink(from);
@@ -404,7 +410,6 @@ int robust_rename(char *from, char *to, int mode)
        return -1;
 }
 
-
 static pid_t all_pids[10];
 static int num_pids;
 
@@ -448,7 +453,6 @@ void kill_all(int sig)
        }
 }
 
-
 /** Turn a user name into a uid */
 int name_to_uid(char *name, uid_t *uid)
 {
@@ -477,7 +481,6 @@ int name_to_gid(char *name, gid_t *gid)
        return 0;
 }
 
-
 /** Lock a byte range in a open file */
 int lock_range(int fd, int offset, int len)
 {
@@ -746,7 +749,7 @@ unsigned int clean_fname(char *name, BOOL collapse_dot_dot)
  * of the path.  Use -1 to allow unlimited depth.
  *
  * We also clean the path in a manner similar to clean_fname() but with a
- * few differences: 
+ * few differences:
  *
  * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
  * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
@@ -791,7 +794,7 @@ char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
                 * always be left pointing after a slash
                 */
                if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
-                       if (leave_one_dotdir && p[1] && sanp != dest)
+                       if (leave_one_dotdir && p[1])
                                leave_one_dotdir = 0;
                        else {
                                /* skip "." component */
@@ -892,43 +895,6 @@ int pop_dir(char *dir)
        return 1;
 }
 
-/* Return the filename, turning any non-printable characters into escaped
- * characters (e.g. \n -> \012, \ -> \\).  This ensures that outputting it
- * cannot generate an empty line nor corrupt the screen.  This function can
- * return only MAX_SAFE_NAMES values at a time!  The returned value can be
- * longer than MAXPATHLEN (because we may be trying to output an error about
- * a too-long filename)! */
-char *safe_fname(const char *fname)
-{
-#define MAX_SAFE_NAMES 4
-       static char fbuf[MAX_SAFE_NAMES][MAXPATHLEN*2];
-       static int ndx = 0;
-       int limit = sizeof fbuf / MAX_SAFE_NAMES - 1;
-       char *t;
-
-       ndx = (ndx + 1) % MAX_SAFE_NAMES;
-       for (t = fbuf[ndx]; *fname; fname++) {
-               if (*fname == '\\') {
-                       if ((limit -= 2) < 0)
-                               break;
-                       *t++ = '\\';
-                       *t++ = '\\';
-               } else if (!isprint(*(uchar*)fname)) {
-                       if ((limit -= 4) < 0)
-                               break;
-                       sprintf(t, "\\%03o", *(uchar*)fname);
-                       t += 4;
-               } else {
-                       if (--limit < 0)
-                               break;
-                       *t++ = *fname;
-               }
-       }
-       *t = '\0';
-
-       return fbuf[ndx];
-}
-
 /**
  * Return a quoted string with the full pathname of the indicated filename.
  * The string " (in MODNAME)" may also be appended.  The returned pointer
@@ -943,7 +909,6 @@ char *full_fname(const char *fn)
        if (result)
                free(result);
 
-       fn = safe_fname(fn);
        if (*fn == '/')
                p1 = p2 = "";
        else {
@@ -1038,22 +1003,6 @@ int handle_partial_dir(const char *fname, int create)
        return 1;
 }
 
-/** We need to supply our own strcmp function for file list comparisons
-   to ensure that signed/unsigned usage is consistent between machines. */
-int u_strcmp(const char *cs1, const char *cs2)
-{
-       const uchar *s1 = (const uchar *)cs1;
-       const uchar *s2 = (const uchar *)cs2;
-
-       while (*s1 && *s2 && (*s1 == *s2)) {
-               s1++; s2++;
-       }
-
-       return (int)*s1 - (int)*s2;
-}
-
-
-
 /**
  * Determine if a symlink points outside the current directory tree.
  * This is considered "unsafe" because e.g. when mirroring somebody
@@ -1118,6 +1067,63 @@ int unsafe_symlink(const char *dest, const char *src)
        return (depth < 0);
 }
 
+/* Return the int64 number as a string.  If the --human-readable option was
+ * specified, we may output the number in K, M, or G units.  We can return
+ * up to 4 buffers at a time. */
+char *human_num(int64 num)
+{
+       static char bufs[4][128]; /* more than enough room */
+       static unsigned int n;
+       char *s;
+
+       n = (n + 1) % (sizeof bufs / sizeof bufs[0]);
+
+       if (human_readable) {
+               char units = '\0';
+               int mult = human_readable == 1 ? 1000 : 1024;
+               double dnum = 0;
+               if (num > mult*mult*mult) {
+                       dnum = (double)num / (mult*mult*mult);
+                       units = 'G';
+               } else if (num > mult*mult) {
+                       dnum = (double)num / (mult*mult);
+                       units = 'M';
+               } else if (num > mult) {
+                       dnum = (double)num / mult;
+                       units = 'K';
+               }
+               if (units) {
+                       sprintf(bufs[n], "%.2f%c", dnum, units);
+                       return bufs[n];
+               }
+       }
+
+       s = bufs[n] + sizeof bufs[0] - 1;
+       *s = '\0';
+
+       if (!num)
+               *--s = '0';
+       while (num) {
+               *--s = (num % 10) + '0';
+               num /= 10;
+       }
+       return s;
+}
+
+/* Return the double number as a string.  If the --human-readable option was
+ * specified, we may output the number in K, M, or G units.  We use a buffer
+ * from human_num() to return our result. */
+char *human_dnum(double dnum, int decimal_digits)
+{
+       char *buf = human_num(dnum);
+       int len = strlen(buf);
+       if (isdigit(*(uchar*)(buf+len-1))) {
+               /* There's extra room in buf prior to the start of the num. */
+               buf -= decimal_digits + 1;
+               snprintf(buf, len + decimal_digits + 2, "%.*f", decimal_digits, dnum);
+       }
+       return buf;
+}
 
 /**
  * Return the date and time as a string
@@ -1126,6 +1132,7 @@ char *timestring(time_t t)
 {
        static char TimeBuf[200];
        struct tm *tm = localtime(&t);
+       char *p;
 
 #ifdef HAVE_STRFTIME
        strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
@@ -1133,14 +1140,12 @@ char *timestring(time_t t)
        strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
 #endif
 
-       if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
-               TimeBuf[strlen(TimeBuf)-1] = 0;
-       }
+       if ((p = strchr(TimeBuf, '\n')) != NULL)
+               *p = '\0';
 
-       return(TimeBuf);
+       return TimeBuf;
 }
 
-
 /**
  * Sleep for a specified number of milliseconds.
  *
@@ -1169,11 +1174,8 @@ int msleep(int t)
        return True;
 }
 
-
-/**
- * Determine if two file modification times are equivalent (either
- * exact or in the modification timestamp window established by
- * --modify-window).
+/* Determine if two time_t values are equivalent (either exact, or in
+ * the modification timestamp window established by --modify-window).
  *
  * @retval 0 if the times should be treated as the same
  *
@@ -1181,7 +1183,7 @@ int msleep(int t)
  *
  * @retval -1 if the 2nd is later
  **/
-int cmp_modtime(time_t file1, time_t file2)
+int cmp_time(time_t file1, time_t file2)
 {
        if (file2 > file1) {
                if (file2 - file1 <= modify_window)
@@ -1227,7 +1229,6 @@ int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
 }
 #endif
 
-
 #define MALLOC_MAX 0x40000000
 
 void *_new_array(unsigned int size, unsigned long num)
@@ -1353,3 +1354,95 @@ uint32 fuzzy_distance(const char *s1, int len1, const char *s2, int len2)
 
        return a[len2-1];
 }
+
+#define BB_SLOT_SIZE     (16*1024)          /* Desired size in bytes */
+#define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
+#define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
+
+struct bitbag {
+    uint32 **bits;
+    int slot_cnt;
+};
+
+struct bitbag *bitbag_create(int max_ndx)
+{
+       struct bitbag *bb = new(struct bitbag);
+       bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
+
+       if (!(bb->bits = (uint32**)calloc(bb->slot_cnt, sizeof (uint32*))))
+               out_of_memory("bitbag_create");
+
+       return bb;
+}
+
+void bitbag_set_bit(struct bitbag *bb, int ndx)
+{
+       int slot = ndx / BB_PER_SLOT_BITS;
+       ndx %= BB_PER_SLOT_BITS;
+
+       if (!bb->bits[slot]) {
+               if (!(bb->bits[slot] = (uint32*)calloc(BB_PER_SLOT_INTS, 4)))
+                       out_of_memory("bitbag_set_bit");
+       }
+
+       bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
+}
+
+#if 0 /* not needed yet */
+void bitbag_clear_bit(struct bitbag *bb, int ndx)
+{
+       int slot = ndx / BB_PER_SLOT_BITS;
+       ndx %= BB_PER_SLOT_BITS;
+
+       if (!bb->bits[slot])
+               return;
+
+       bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
+}
+
+int bitbag_check_bit(struct bitbag *bb, int ndx)
+{
+       int slot = ndx / BB_PER_SLOT_BITS;
+       ndx %= BB_PER_SLOT_BITS;
+
+       if (!bb->bits[slot])
+               return 0;
+
+       return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
+}
+#endif
+
+/* Call this with -1 to start checking from 0.  Returns -1 at the end. */
+int bitbag_next_bit(struct bitbag *bb, int after)
+{
+       uint32 bits, mask;
+       int i, ndx = after + 1;
+       int slot = ndx / BB_PER_SLOT_BITS;
+       ndx %= BB_PER_SLOT_BITS;
+
+       mask = (1u << (ndx % 32)) - 1;
+       for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
+               if (!bb->bits[slot])
+                       continue;
+               for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
+                       if (!(bits = bb->bits[slot][i] & ~mask))
+                               continue;
+                       /* The xor magic figures out the lowest enabled bit in
+                        * bits, and the switch quickly computes log2(bit). */
+                       switch (bits ^ (bits & (bits-1))) {
+#define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
+                           LOG2(0);  LOG2(1);  LOG2(2);  LOG2(3);
+                           LOG2(4);  LOG2(5);  LOG2(6);  LOG2(7);
+                           LOG2(8);  LOG2(9);  LOG2(10); LOG2(11);
+                           LOG2(12); LOG2(13); LOG2(14); LOG2(15);
+                           LOG2(16); LOG2(17); LOG2(18); LOG2(19);
+                           LOG2(20); LOG2(21); LOG2(22); LOG2(23);
+                           LOG2(24); LOG2(25); LOG2(26); LOG2(27);
+                           LOG2(28); LOG2(29); LOG2(30); LOG2(31);
+                       }
+                       return -1; /* impossible... */
+               }
+       }
+
+       return -1;
+}