X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/5e71c4446e10c27c1db0c7e7e5b71be68f3b88de..58cadc8608fbb2cbc7b74578cd92de4337a4b887:/rsync.h diff --git a/rsync.h b/rsync.h index d24cdf79..3a39f15e 100644 --- a/rsync.h +++ b/rsync.h @@ -1,6 +1,7 @@ /* - Copyright (C) Andrew Tridgell 1996 + Copyright (C) by Andrew Tridgell 1996, 2000 Copyright (C) Paul Mackerras 1996 + 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 @@ -17,11 +18,16 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ + +#define False 0 +#define True 1 + #define BLOCK_SIZE 700 #define RSYNC_RSH_ENV "RSYNC_RSH" #define RSYNC_NAME "rsync" -#define RSYNCD_CONF "/etc/rsyncd.conf" +#define RSYNCD_SYSCONF "/etc/rsyncd.conf" +#define RSYNCD_USERCONF "rsyncd.conf" #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock" #define URL_PREFIX "rsync://" @@ -29,7 +35,7 @@ #define BACKUP_SUFFIX "~" /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is - imcompatible with older versions :-( */ + incompatible with older versions :-( */ #define CHAR_OFFSET 0 @@ -44,9 +50,28 @@ #define SAME_TIME (1<<7) /* update this if you make incompatible changes */ -#define PROTOCOL_VERSION 19 -#define MIN_PROTOCOL_VERSION 11 -#define MAX_PROTOCOL_VERSION 30 +#define PROTOCOL_VERSION 27 + +/* We refuse to interoperate with versions that are not in this range. + * Note that we assume we'll work with later versions: the onus is on + * people writing them to make sure that they don't send us anything + * we won't understand. + * + * Interoperation with old but supported protocol versions + * should cause a warning to be printed. At a future date + * the old protocol will become the minimum and + * compatibility code removed. + * + * There are two possible explanations for the limit at + * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that + * do not interoperate with us, and (more likely) so that we can + * detect an attempt to connect rsync to a non-rsync server, which is + * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and + * MAX_PROTOCOL_VERSION. */ + +#define MIN_PROTOCOL_VERSION 17 +#define OLD_PROTOCOL_VERSION 20 +#define MAX_PROTOCOL_VERSION 40 #define RSYNC_PORT 873 @@ -55,33 +80,36 @@ #define CHUNK_SIZE (32*1024) #define MAX_MAP_SIZE (256*1024) #define IO_BUFFER_SIZE (4092) -#define MAX_READ_BUFFER (1024*1024) #define MAX_ARGS 1000 #define MPLEX_BASE 7 -#define FERROR 1 -#define FINFO 2 -#define FLOG 3 + +#define NO_EXCLUDES 0 +#define SERVER_EXCLUDES 1 +#define ALL_EXCLUDES 2 + +#define MISSING_OK 0 +#define MISSING_FATAL 1 + +#define ADD_INCLUDE 1 +#define ADD_EXCLUDE 0 + +/* Log values. I *think* what these mean is: FLOG goes to the server + * logfile; FERROR and FINFO try to end up on the client, with + * different levels of filtering. */ +enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 }; #include "errcode.h" #include "config.h" -#if HAVE_REMSH -#define RSYNC_RSH "remsh" -#else -#define RSYNC_RSH "rsh" -#endif +/* The default RSYNC_RSH is always set in config.h, either to "remsh", + * "rsh", or otherwise something specified by the user. HAVE_REMSH + * controls parameter munging for HP/UX, etc. */ #include -#ifdef HAVE_GETOPT_LONG -#include -#else -#include "lib/getopt.h" -#endif - #ifdef HAVE_UNISTD_H #include #endif @@ -96,6 +124,10 @@ #include #endif +#if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H)) +#include +#endif + #ifdef HAVE_SYS_SOCKET_H #include #endif @@ -104,10 +136,6 @@ #include #endif -#ifdef HAVE_MALLOC_H -#include -#endif - #ifdef TIME_WITH_SYS_TIME #include #include @@ -164,12 +192,6 @@ #endif #endif -#ifdef HAVE_FNMATCH -#include -#else -#include "lib/fnmatch.h" -#endif - #ifdef HAVE_GLOB_H #include #endif @@ -204,6 +226,8 @@ #include #endif +#include + #define BOOL int @@ -252,15 +276,55 @@ #elif HAVE_LONGLONG #define int64 long long #else +/* As long as it gets... */ #define int64 off_t #define NO_INT64 #endif -#if HAVE_SHORT_INO_T -#define INO_T uint32 +#if (SIZEOF_LONG == 8) +#define uint64 unsigned long +#elif (SIZEOF_INT == 8) +#define uint64 unsigned int +#elif HAVE_LONGLONG +#define uint64 unsigned long long #else -#define INO_T ino_t -#endif +/* As long as it gets... */ +#define uint64 unsigned off_t +#endif + +/* Starting from protocol version 26, we always use 64-bit + * ino_t and dev_t internally, even if this platform does not + * allow files to have 64-bit inums. That's because the + * receiver needs to find duplicate (dev,ino) tuples to detect + * hardlinks, and it might have files coming from a platform + * that has 64-bit inums. + * + * The only exception is if we're on a platform with no 64-bit type at + * all. + * + * Because we use read_longint() to get these off the wire, if you + * transfer devices or hardlinks with dev or inum > 2**32 to a machine + * with no 64-bit types then you will get an overflow error. Probably + * not many people have that combination of machines, and you can + * avoid it by not preserving hardlinks or not transferring device + * nodes. It's not clear that any other behaviour is better. + * + * Note that if you transfer devices from a 64-bit-devt machine (say, + * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the + * device numbers will be truncated. But it's a kind of silly thing + * to do anyhow. + * + * FIXME: In future, we should probable split the device number into + * major/minor, and transfer the two parts as 32-bit ints. That gives + * you somewhat more of a chance that they'll come from a big machine + * to a little one in a useful way. + * + * FIXME: Really we need an unsigned type, and we perhaps ought to + * cope with platforms on which this is an unsigned int or even a + * struct. Later. + */ +#define INO64_T uint64 +#define DEV64_T uint64 #ifndef MIN #define MIN(a,b) ((a)<(b)?(a):(b)) @@ -270,26 +334,44 @@ #define MAX(a,b) ((a)>(b)?(a):(b)) #endif +#ifndef MAXHOSTNAMELEN +#define MAXHOSTNAMELEN 256 +#endif + /* the length of the md4 checksum */ #define MD4_SUM_LENGTH 16 #define SUM_LENGTH 16 +#define SHORT_SUM_LENGTH 2 +#define BLOCKSUM_BIAS 10 #ifndef MAXPATHLEN #define MAXPATHLEN 1024 #endif +#ifndef NAME_MAX +#define NAME_MAX 255 +#endif + #ifndef INADDR_NONE #define INADDR_NONE 0xffffffff #endif +#ifndef IN_LOOPBACKNET +#define IN_LOOPBACKNET 127 +#endif + struct file_struct { unsigned flags; time_t modtime; OFF_T length; mode_t mode; - INO_T inode; - dev_t dev; - dev_t rdev; + + INO64_T inode; + /** Device this file lives upon */ + DEV64_T dev; + + /** If this is a device node, the device number. */ + DEV64_T rdev; uid_t uid; gid_t gid; char *basename; @@ -300,41 +382,63 @@ struct file_struct { }; +#define ARENA_SIZE (32 * 1024) + +struct string_area { + char *base; + char *end; + char *current; + struct string_area *next; +}; + struct file_list { int count; int malloced; struct file_struct **files; + struct string_area *string_area; }; struct sum_buf { - OFF_T offset; /* offset in file of this chunk */ - int len; /* length of chunk of file */ - int i; /* index of this chunk */ - uint32 sum1; /* simple checksum */ - char sum2[SUM_LENGTH]; /* checksum */ + OFF_T offset; /**< offset in file of this chunk */ + int len; /**< length of chunk of file */ + int i; /**< index of this chunk */ + uint32 sum1; /**< simple checksum */ + char sum2[SUM_LENGTH]; /**< checksum */ }; struct sum_struct { - OFF_T flength; /* total file length */ - int count; /* how many chunks */ - int remainder; /* flength % block_length */ - int n; /* block_length */ - struct sum_buf *sums; /* points to info for each chunk */ + OFF_T flength; /**< total file length */ + size_t count; /**< how many chunks */ + size_t remainder; /**< flength % block_length */ + size_t blength; /**< block_length */ + size_t s2length; /**< sum2_length */ + struct sum_buf *sums; /**< points to info for each chunk */ }; struct map_struct { - char *p; - int fd,p_size,p_len; - OFF_T file_size, p_offset, p_fd_offset; + char *p; /* Window pointer */ + int fd; /* File Descriptor */ + int p_size; /* Window size at allocation */ + int p_len; /* Window size after fill */ + /* p_size and p_len could be + * consolodated by using a local + * variable in map_ptr() */ + int status; /* first errno from read errors */ + OFF_T file_size; /* File size (from stat) */ + OFF_T p_offset; /* Window start */ + OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */ }; +#define MATCHFLG_WILD 0x0001 /* pattern has '*', '[', and/or '?' */ +#define MATCHFLG_WILD2 0x0002 /* pattern has '**' */ +#define MATCHFLG_WILD2_PREFIX 0x0004 /* pattern starts with '**' */ +#define MATCHFLG_ABS_PATH 0x0008 /* path-match on absolute path */ struct exclude_struct { - char *orig; char *pattern; - int regular_exp; + int match_flags; int include; int directory; - int local; + int slash_cnt; }; struct stats { @@ -360,9 +464,32 @@ static inline int flist_up(struct file_list *flist, int i) } #include "byteorder.h" -#include "version.h" -#include "proto.h" #include "lib/mdfour.h" +#include "lib/wildmatch.h" +#include "lib/permstring.h" +#include "lib/addrinfo.h" + +#include "proto.h" + +/* We have replacement versions of these if they're missing. */ +#ifndef HAVE_ASPRINTF +int asprintf(char **ptr, const char *format, ...); +#endif + +#ifndef HAVE_VASPRINTF +int vasprintf(char **ptr, const char *format, va_list ap); +#endif + +#if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF) +#define vsnprintf rsync_vsnprintf +int vsnprintf(char *str, size_t count, const char *fmt, va_list args); +#endif + +#if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF) +#define snprintf rsync_snprintf +int snprintf(char *str,size_t count,const char *fmt,...); +#endif + #if !HAVE_STRERROR extern char *sys_errlist[]; @@ -381,6 +508,9 @@ extern int errno; #define SUPPORT_LINKS HAVE_READLINK #define SUPPORT_HARD_LINKS HAVE_LINK +/* This could be bad on systems which have no lchown and where chown + * follows symbollic links. On such systems it might be better not to + * try to chown symlinks at all. */ #ifndef HAVE_LCHOWN #define lchown chown #endif @@ -407,6 +537,16 @@ extern int errno; #define S_IWUSR 0200 #endif +#ifndef ACCESSPERMS +#define ACCESSPERMS 0777 +#endif + +#ifndef S_ISVTX +#define S_ISVTX 0 +#endif + +#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS) + #ifndef _S_IFMT #define _S_IFMT 0170000 #endif @@ -451,27 +591,65 @@ extern int errno; #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG)) #endif +/* work out what fcntl flag to use for non-blocking */ +#ifdef O_NONBLOCK +# define NONBLOCK_FLAG O_NONBLOCK +#elif defined(SYSV) +# define NONBLOCK_FLAG O_NDELAY +#else +# define NONBLOCK_FLAG FNDELAY +#endif -#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode)) +#ifndef INADDR_LOOPBACK +#define INADDR_LOOPBACK 0x7f000001 +#endif -#ifndef ACCESSPERMS -#define ACCESSPERMS 0777 +#ifndef INADDR_NONE +#define INADDR_NONE 0xffffffff #endif +#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode)) + +/* Initial mask on permissions given to temporary files. Mask off setuid + bits and group access because of potential race-condition security + holes, and mask other access because mode 707 is bizarre */ +#define INITACCESSPERMS 0700 + /* handler for null strings in printf format */ #define NS(s) ((s)?(s):"") -/* use magic gcc attributes to catch format errors */ - void rprintf(int , const char *, ...) -#ifdef __GNUC__ - __attribute__ ((format (printf, 2, 3))) +#if !defined(__GNUC__) || defined(APPLE) +/* Apparently the OS X port of gcc gags on __attribute__. + * + * */ +#define __attribute__(x) + #endif + +/* Convenient wrappers for malloc and realloc. Use them. */ +#define new(type) ((type *)malloc(sizeof(type))) +#define new_array(type, num) ((type *)_new_array(sizeof(type), (num))) +#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num))) + +/* use magic gcc attributes to catch format errors */ + void rprintf(enum logcode , const char *, ...) + __attribute__((format (printf, 2, 3))) ; +/* This is just like rprintf, but it also tries to print some + * representation of the error code. Normally errcode = errno. */ +void rsyserr(enum logcode, int, const char *, ...) + __attribute__((format (printf, 3, 4))) + ; + #ifdef REPLACE_INET_NTOA #define inet_ntoa rep_inet_ntoa #endif +/* Make sure that the O_BINARY flag is defined. */ +#ifndef O_BINARY +#define O_BINARY 0 +#endif #ifndef HAVE_STRLCPY size_t strlcpy(char *d, const char *s, size_t bufsize); @@ -481,4 +659,28 @@ size_t strlcpy(char *d, const char *s, size_t bufsize); size_t strlcat(char *d, const char *s, size_t bufsize); #endif +#ifndef WEXITSTATUS +#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF)) +#endif + #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__) + + +extern int verbose; + +#ifndef HAVE_INET_NTOP +const char * +inet_ntop(int af, const void *src, char *dst, size_t size); +#endif /* !HAVE_INET_NTOP */ + +#ifndef HAVE_INET_PTON +int inet_pton(int af, const char *src, void *dst); +#endif + +#ifdef MAINTAINER_MODE +const char *get_panic_action(void); +#endif + +#define UNUSED(x) x __attribute__((__unused__)) + +extern const char *io_write_phase, *io_read_phase;