X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/47f1218d6949a1156034f734cc746b19e759566f..fb4c98c2c8a618855ebe4d11c36f8a120fab2aa1:/util.c diff --git a/util.c b/util.c index 3fd65f4f..9b54c05a 100644 --- a/util.c +++ b/util.c @@ -2,7 +2,7 @@ Copyright (C) 1996-2000 by Andrew Tridgell Copyright (C) Paul Mackerras 1996 - Copyright (C) 2001 by Martin Pool + Copyright (C) 2001, 2002 by Martin Pool 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 @@ -19,19 +19,21 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ -/* - Utilities used in rsync +/** + * + * @file util.c + * + * Utilities used in rsync + **/ - tridge, June 1996 - */ #include "rsync.h" extern int verbose; -/**************************************************************************** -Set a fd into nonblocking mode -****************************************************************************/ +/** + Set a fd into nonblocking mode +**/ void set_nonblocking(int fd) { int val; @@ -44,9 +46,9 @@ void set_nonblocking(int fd) } } -/**************************************************************************** +/** Set a fd into blocking mode -****************************************************************************/ +*/ void set_blocking(int fd) { int val; @@ -60,10 +62,11 @@ void set_blocking(int fd) } -/* create a file descriptor pair - like pipe() but use socketpair if - possible (because of blocking issues on pipes) +/** + Create a file descriptor pair - like pipe() but use socketpair if + possible (because of blocking issues on pipes). - always set non-blocking + Always set non-blocking. */ int fd_pair(int fd[2]) { @@ -84,72 +87,100 @@ int fd_pair(int fd[2]) } -/* this is derived from CVS code +static void print_child_argv(char **cmd) +{ + rprintf(FINFO, "opening connection using "); + for (; *cmd; cmd++) { + /* Look for characters that ought to be quoted. This + * is not a great quoting algorithm, but it's + * sufficient for a log message. */ + if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz" + "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + "0123456789" + ",.-_=+@/") != strlen(*cmd)) { + rprintf(FINFO, "\"%s\" ", *cmd); + } else { + rprintf(FINFO, "%s ", *cmd); + } + } + rprintf(FINFO, "\n"); +} - note that in the child STDIN is set to blocking and STDOUT - is set to non-blocking. This is necessary as rsh relies on stdin being blocking - and ssh relies on stdout being non-blocking - if blocking_io is set then use blocking io on both fds. That can be - used to cope with badly broken rsh implementations like the one on - solaris. - */ -pid_t piped_child(char **command,int *f_in,int *f_out) +/** + * Create a child connected to use on stdin/stdout. + * + * This is derived from CVS code + * + * Note that in the child STDIN is set to blocking and STDOUT + * is set to non-blocking. This is necessary as rsh relies on stdin being blocking + * and ssh relies on stdout being non-blocking + * + * If blocking_io is set then use blocking io on both fds. That can be + * used to cope with badly broken rsh implementations like the one on + * Solaris. + **/ +pid_t piped_child(char **command, int *f_in, int *f_out) { - pid_t pid; - int to_child_pipe[2]; - int from_child_pipe[2]; - extern int blocking_io; - - if (fd_pair(to_child_pipe) < 0 || - fd_pair(from_child_pipe) < 0) { - rprintf(FERROR,"pipe: %s\n",strerror(errno)); - exit_cleanup(RERR_IPC); - } - - - pid = do_fork(); - if (pid == -1) { - rprintf(FERROR,"fork: %s\n",strerror(errno)); - exit_cleanup(RERR_IPC); - } - - if (pid == 0) - { - extern int orig_umask; - if (dup2(to_child_pipe[0], STDIN_FILENO) < 0 || - close(to_child_pipe[1]) < 0 || - close(from_child_pipe[0]) < 0 || - dup2(from_child_pipe[1], STDOUT_FILENO) < 0) { - rprintf(FERROR,"Failed to dup/close : %s\n",strerror(errno)); - exit_cleanup(RERR_IPC); - } - if (to_child_pipe[0] != STDIN_FILENO) close(to_child_pipe[0]); - if (from_child_pipe[1] != STDOUT_FILENO) close(from_child_pipe[1]); - umask(orig_umask); - set_blocking(STDIN_FILENO); - if (blocking_io) { - set_blocking(STDOUT_FILENO); - } - execvp(command[0], command); - rprintf(FERROR,"Failed to exec %s : %s\n", - command[0],strerror(errno)); - exit_cleanup(RERR_IPC); - } + pid_t pid; + int to_child_pipe[2]; + int from_child_pipe[2]; + extern int blocking_io; + + if (verbose >= 2) { + print_child_argv(command); + } - if (close(from_child_pipe[1]) < 0 || - close(to_child_pipe[0]) < 0) { - rprintf(FERROR,"Failed to close : %s\n",strerror(errno)); - exit_cleanup(RERR_IPC); - } + if (fd_pair(to_child_pipe) < 0 || fd_pair(from_child_pipe) < 0) { + rprintf(FERROR, "pipe: %s\n", strerror(errno)); + exit_cleanup(RERR_IPC); + } - *f_in = from_child_pipe[0]; - *f_out = to_child_pipe[1]; - return pid; + pid = do_fork(); + if (pid == -1) { + rprintf(FERROR, "fork: %s\n", strerror(errno)); + exit_cleanup(RERR_IPC); + } + + if (pid == 0) { + extern int orig_umask; + if (dup2(to_child_pipe[0], STDIN_FILENO) < 0 || + close(to_child_pipe[1]) < 0 || + close(from_child_pipe[0]) < 0 || + dup2(from_child_pipe[1], STDOUT_FILENO) < 0) { + rprintf(FERROR, "Failed to dup/close : %s\n", + strerror(errno)); + exit_cleanup(RERR_IPC); + } + if (to_child_pipe[0] != STDIN_FILENO) + close(to_child_pipe[0]); + if (from_child_pipe[1] != STDOUT_FILENO) + close(from_child_pipe[1]); + umask(orig_umask); + set_blocking(STDIN_FILENO); + if (blocking_io) { + set_blocking(STDOUT_FILENO); + } + execvp(command[0], command); + rprintf(FERROR, "Failed to exec %s : %s\n", + command[0], strerror(errno)); + exit_cleanup(RERR_IPC); + } + + if (close(from_child_pipe[1]) < 0 || close(to_child_pipe[0]) < 0) { + rprintf(FERROR, "Failed to close : %s\n", strerror(errno)); + exit_cleanup(RERR_IPC); + } + + *f_in = from_child_pipe[0]; + *f_out = to_child_pipe[1]; + + return pid; } -pid_t local_child(int argc, char **argv,int *f_in,int *f_out) +pid_t local_child(int argc, char **argv,int *f_in,int *f_out, + int (*child_main)(int, char **)) { pid_t pid; int to_child_pipe[2]; @@ -173,10 +204,7 @@ pid_t local_child(int argc, char **argv,int *f_in,int *f_out) extern int am_sender; extern int am_server; - if (read_batch) - am_sender = 0; - else - am_sender = !am_sender; + am_sender = read_batch ? 0 : !am_sender; am_server = 1; if (dup2(to_child_pipe[0], STDIN_FILENO) < 0 || @@ -188,7 +216,7 @@ pid_t local_child(int argc, char **argv,int *f_in,int *f_out) } if (to_child_pipe[0] != STDIN_FILENO) close(to_child_pipe[0]); if (from_child_pipe[1] != STDOUT_FILENO) close(from_child_pipe[1]); - start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv); + child_main(argc, argv); } if (close(from_child_pipe[1]) < 0 || @@ -219,10 +247,18 @@ void overflow(char *str) -int set_modtime(char *fname,time_t modtime) +int set_modtime(char *fname, time_t modtime) { extern int dry_run; - if (dry_run) return 0; + if (dry_run) + return 0; + + if (verbose > 2) { + rprintf(FINFO, "set modtime of %s to (%ld) %s", + fname, (long) modtime, + asctime(localtime(&modtime))); + } + { #ifdef HAVE_UTIMBUF struct utimbuf tbuf; @@ -246,11 +282,11 @@ int set_modtime(char *fname,time_t modtime) } -/**************************************************************************** -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 -****************************************************************************/ +/** + 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) { extern int orig_umask; @@ -270,12 +306,17 @@ int create_directory_path(char *fname) } -/* Write LEN bytes at PTR to descriptor DESC, retrying if interrupted. - Return LEN upon success, write's (negative) error code otherwise. - - derived from GNU C's cccp.c. -*/ -static int full_write(int desc, char *ptr, int len) +/** + * Write @p len bytes at @p ptr to descriptor @p desc, retrying if + * interrupted. + * + * @retval len upon success + * + * @retval <0 write's (negative) error code + * + * Derived from GNU C's cccp.c. + */ +static int full_write(int desc, char *ptr, size_t len) { int total_written; @@ -296,16 +337,23 @@ static int full_write(int desc, char *ptr, int len) return total_written; } -/* Read LEN bytes at PTR from descriptor DESC, retrying if interrupted. - Return the actual number of bytes read, zero for EOF, or negative - for an error. - derived from GNU C's cccp.c. */ -static int safe_read(int desc, char *ptr, int len) +/** + * Read @p len bytes at @p ptr from descriptor @p desc, retrying if + * interrupted. + * + * @retval >0 the actual number of bytes read + * + * @retval 0 for EOF + * + * @retval <0 for an error. + * + * Derived from GNU C's cccp.c. */ +static int safe_read(int desc, char *ptr, size_t len) { int n_chars; - if (len <= 0) + if (len == 0) return len; #ifdef EINTR @@ -320,7 +368,9 @@ static int safe_read(int desc, char *ptr, int len) } -/* copy a file - this is used in conjunction with the --temp-dir option */ +/** Copy a file. + * + * This is used in conjunction with the --temp-dir option */ int copy_file(char *source, char *dest, mode_t mode) { int ifd; @@ -371,18 +421,21 @@ int copy_file(char *source, char *dest, mode_t mode) return 0; } -/* - Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so - rename to /.rsyncNNN instead. Note that successive rsync runs - will shuffle the filenames around a bit as long as the file is still - busy; this is because this function does not know if the unlink call - is due to a new file coming in, or --delete trying to remove old - .rsyncNNN files, hence it renames it each time. -*/ /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */ #define MAX_RENAMES_DIGITS 3 #define MAX_RENAMES 1000 +/** + * + Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so + rename to /.rsyncNNN instead. + + Note that successive rsync runs will shuffle the filenames around a + bit as long as the file is still busy; this is because this function + does not know if the unlink call is due to a new file coming in, or + --delete trying to remove old .rsyncNNN files, hence it renames it + each time. +*/ int robust_unlink(char *fname) { #ifndef ETXTBSY @@ -449,28 +502,48 @@ int robust_rename(char *from, char *to) static pid_t all_pids[10]; static int num_pids; -/* fork and record the pid of the child */ +/** Fork and record the pid of the child. **/ pid_t do_fork(void) { pid_t newpid = fork(); - if (newpid) { + if (newpid != 0 && newpid != -1) { all_pids[num_pids++] = newpid; } return newpid; } -/* kill all children */ +/** + * Kill all children. + * + * @todo It would be kind of nice to make sure that they are actually + * all our children before we kill them, because their pids may have + * been recycled by some other process. Perhaps when we wait for a + * child, we should remove it from this array. Alternatively we could + * perhaps use process groups, but I think that would not work on + * ancient Unix versions that don't support them. + **/ void kill_all(int sig) { int i; - for (i=0;i/.." (recursively) + * * Can only shrink paths, so sanitizes in place. + * * While we're at it, remove double slashes and "." components like * clean_fname does(), but DON'T remove a trailing slash because that * is sometimes significant on command line arguments. + * * If "reldir" is non-null, it is a sanitized directory that the path will be * relative to, so allow as many ".." at the beginning of the path as * there are components in reldir. This is used for symbolic link targets. @@ -656,9 +733,9 @@ void clean_fname(char *name) * path, but that would blow the assumption that the path doesn't grow and * it is not likely to end up being a valid symlink anyway, so just do * the normal removal of the leading "/" instead. + * * Contributed by Dave Dykstra */ - void sanitize_path(char *p, char *reldir) { char *start, *sanp; @@ -747,7 +824,7 @@ void sanitize_path(char *p, char *reldir) static char curr_dir[MAXPATHLEN]; -/* like chdir() but can be reversed with pop_dir() if save is set. It +/** like chdir() but can be reversed with pop_dir() if save is set. It is also much faster as it remembers where we have been */ char *push_dir(char *dir, int save) { @@ -779,7 +856,7 @@ char *push_dir(char *dir, int save) return ret; } -/* reverse a push_dir call */ +/** Reverse a push_dir call */ int pop_dir(char *dir) { int ret; @@ -797,7 +874,7 @@ int pop_dir(char *dir) return 0; } -/* we need to supply our own strcmp function for file list comparisons +/** 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) { @@ -824,6 +901,8 @@ static unsigned long msdiff(struct timeval *t1, struct timeval *t2) /** + * @param ofs Current position in file + * @param size Total size of file * @param is_last True if this is the last time progress will be * printed for this file, so we should output a newline. (Not * necessarily the same as all bytes being received.) @@ -831,13 +910,20 @@ static unsigned long msdiff(struct timeval *t1, struct timeval *t2) static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now, int is_last) { - int pct = (int)((100.0*ofs)/size); + int pct = (ofs == size) ? 100 : (int)((100.0*ofs)/size); unsigned long diff = msdiff(&start_time, now); - double rate = diff ? ((ofs-start_ofs) / diff) * 1000.0/1024.0 : 0; + double rate = diff ? (double) (ofs-start_ofs) * 1000.0 / diff / 1024.0 : 0; const char *units; + /* If we've finished transferring this file, show the time taken; + * otherwise show expected time to complete. That's kind of + * inconsistent, but people can probably cope. Hopefully we'll + * get more consistent and complete progress reporting soon. -- + * mbp */ + double remain = is_last + ? (double) diff / 1000.0 + : rate ? (double) (size-ofs) / rate / 1000.0 : 0.0; + int remain_h, remain_m, remain_s; - if (ofs == size) pct = 100; - if (rate > 1024*1024) { rate /= 1024.0 * 1024.0; units = "GB/s"; @@ -847,9 +933,14 @@ static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now, } else { units = "kB/s"; } + + remain_s = (int) remain % 60; + remain_m = (int) (remain / 60.0) % 60; + remain_h = (int) (remain / 3600.0); - rprintf(FINFO, "%12.0f %3d%% %7.2f%s%s", + rprintf(FINFO, "%12.0f %3d%% %7.2f%s %4d:%02d:%02d%s", (double) ofs, pct, rate, units, + remain_h, remain_m, remain_s, is_last ? "\n" : "\r"); } @@ -892,7 +983,22 @@ void show_progress(OFF_T ofs, OFF_T size) } } -/* determine if a symlink points outside the current directory tree */ + +/** + * Determine if a symlink points outside the current directory tree. + * This is considered "unsafe" because e.g. when mirroring somebody + * else's machine it might allow them to establish a symlink to + * /etc/passwd, and then read it through a web server. + * + * @param dest Target of the symlink in question. + * + * @param src Top source directory currently applicable. Basically this + * is the first parameter to rsync in a simple invocation, but it's + * modified by flist.c in slightly complex ways. + * + * @retval True if unsafe + * @retval False is unsafe + **/ int unsafe_symlink(char *dest, char *src) { char *tok; @@ -940,9 +1046,9 @@ int unsafe_symlink(char *dest, char *src) } -/**************************************************************************** - return the date and time as a string -****************************************************************************/ +/** + Return the date and time as a string +*/ char *timestring(time_t t) { static char TimeBuf[200]; @@ -992,12 +1098,17 @@ int msleep(int t) } -/******************************************************************* - Determine if two file modification times are equivalent (either exact - or in the modification timestamp window established by --modify-window) - Returns 0 if the times should be treated as the same, 1 if the - first is later and -1 if the 2nd is later - *******************************************************************/ +/** + * Determine if two file modification times 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 + * + * @retval +1 if the first is later + * + * @retval -1 if the 2nd is later + **/ int cmp_modtime(time_t file1, time_t file2) { extern int modify_window; @@ -1014,11 +1125,11 @@ int cmp_modtime(time_t file1, time_t file2) #ifdef __INSURE__XX #include -/******************************************************************* -This routine is a trick to immediately catch errors when debugging -with insure. A xterm with a gdb is popped up when insure catches -a error. It is Linux specific. -********************************************************************/ +/** + This routine is a trick to immediately catch errors when debugging + with insure. A xterm with a gdb is popped up when insure catches + a error. It is Linux specific. +**/ int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6) { static int (*fn)();