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;
}
}
-/****************************************************************************
+/**
Set a fd into blocking mode
-****************************************************************************/
+*/
void set_blocking(int fd)
{
int val;
}
-/* 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])
{
}
-/* 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.
- */
+/**
+ * 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;
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];
}
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 ||
}
-/****************************************************************************
-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;
}
-/* 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.
-*/
+/**
+ * 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;
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. */
+/**
+ * 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;
}
-/* 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;
return 0;
}
-/*
- Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
- rename to <path>/.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 <path>/.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
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<num_pids;i++) {
- if (all_pids[i] != getpid())
- kill(all_pids[i], sig);
+
+ for (i = 0; i < num_pids; i++) {
+ /* Let's just be a little careful where we
+ * point that gun, hey? See kill(2) for the
+ * magic caused by negative values. */
+ pid_t p = all_pids[i];
+
+ if (p == getpid())
+ continue;
+ if (p <= 0)
+ continue;
+
+ kill(p, sig);
}
}
-/* turn a user name into a uid */
+
+/** Turn a user name into a uid */
int name_to_uid(char *name, uid_t *uid)
{
struct passwd *pass;
return 0;
}
-/* turn a group name into a gid */
+/** Turn a group name into a gid */
int name_to_gid(char *name, gid_t *gid)
{
struct group *grp;
}
-/* lock a byte range in a open file */
+/** Lock a byte range in a open file */
int lock_range(int fd, int offset, int len)
{
struct flock lock;
free(base);
}
-/*******************************************************************
- convert a string to lower case
-********************************************************************/
+/**
+ * Convert a string to lower case
+ **/
void strlower(char *s)
{
while (*s) {
}
}
-/*
+/**
* Make path appear as if a chroot had occurred:
+ *
* 1. remove leading "/" (or replace with "." if at end)
* 2. remove leading ".." components (except those allowed by "reldir")
* 3. delete any other "<dir>/.." (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.
* 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 <dwd@bell-labs.com>
*/
-
void sanitize_path(char *p, char *reldir)
{
char *start, *sanp;
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)
{
return ret;
}
-/* reverse a push_dir call */
+/** Reverse a push_dir call */
int pop_dir(char *dir)
{
int ret;
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)
{
unsigned long diff = msdiff(&start_time, now);
double rate = diff ? (double) (ofs-start_ofs) * 1000.0 / diff / 1024.0 : 0;
const char *units;
- double remain = rate ? (double) (size-ofs) / rate / 1000.0: 0.0;
+ /* 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 (rate > 1024*1024) {
}
}
-/* 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;
}
-/****************************************************************************
- 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];
}
-/*******************************************************************
- 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;
#ifdef __INSURE__XX
#include <dlfcn.h>
-/*******************************************************************
-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)();
Matt McCutchen's Web Site / rsync / rsync.git / blobdiff