Improved the differentiation of the transmit flags from the live flags
[rsync/rsync.git] / rsync.h
1 /* 
2    Copyright (C) by Andrew Tridgell 1996, 2000
3    Copyright (C) Paul Mackerras 1996
4    Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
5    
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21
22 #define False 0
23 #define True 1
24
25 #define BLOCK_SIZE 700
26 #define RSYNC_RSH_ENV "RSYNC_RSH"
27 #define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
28
29 #define RSYNC_NAME "rsync"
30 #define RSYNCD_SYSCONF "/etc/rsyncd.conf"
31 #define RSYNCD_USERCONF "rsyncd.conf"
32
33 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
34 #define URL_PREFIX "rsync://"
35
36 #define BACKUP_SUFFIX "~"
37
38 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
39    incompatible with older versions :-( */
40 #define CHAR_OFFSET 0
41
42 /* These flags are only used during the flist transfer. */
43
44 #define XMIT_TOP_DIR (1<<0)
45 #define XMIT_SAME_MODE (1<<1)
46 #define XMIT_EXTENDED_FLAGS (1<<2)
47 #define XMIT_SAME_RDEV_pre28 XMIT_EXTENDED_FLAGS /* Only in protocols < 28 */
48 #define XMIT_SAME_UID (1<<3)
49 #define XMIT_SAME_GID (1<<4)
50 #define XMIT_SAME_NAME (1<<5)
51 #define XMIT_LONG_NAME (1<<6)
52 #define XMIT_SAME_TIME (1<<7)
53 #define XMIT_SAME_HIGH_RDEV (1<<8)
54 #define XMIT_HAS_IDEV_DATA (1<<9)
55 #define XMIT_SAME_DEV (1<<10)
56
57 /* These flags are used in the live flist data. */
58
59 #define FLAG_TOP_DIR (1<<0)
60 #define FLAG_HLINK_EOL (1<<1)   /* generator only */
61
62 /* update this if you make incompatible changes */
63 #define PROTOCOL_VERSION 28
64
65 /* We refuse to interoperate with versions that are not in this range.
66  * Note that we assume we'll work with later versions: the onus is on
67  * people writing them to make sure that they don't send us anything
68  * we won't understand.
69  *
70  * Interoperation with old but supported protocol versions
71  * should cause a warning to be printed.  At a future date
72  * the old protocol will become the minimum and
73  * compatibility code removed.
74  *
75  * There are two possible explanations for the limit at
76  * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
77  * do not interoperate with us, and (more likely) so that we can
78  * detect an attempt to connect rsync to a non-rsync server, which is
79  * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
80  * MAX_PROTOCOL_VERSION. */
81
82 #define MIN_PROTOCOL_VERSION 19
83 #define OLD_PROTOCOL_VERSION 20
84 #define MAX_PROTOCOL_VERSION 40
85
86 #define RSYNC_PORT 873
87
88 #define SPARSE_WRITE_SIZE (1024)
89 #define WRITE_SIZE (32*1024)
90 #define CHUNK_SIZE (32*1024)
91 #define MAX_MAP_SIZE (256*1024)
92 #define IO_BUFFER_SIZE (4092)
93
94 #define IOERR_GENERAL   (1<<0) /* For backward compatibility, this must == 1 */
95 #define IOERR_VANISHED  (1<<1)
96
97 #define MAX_ARGS 1000
98
99 #define MPLEX_BASE 7
100
101 #define NO_EXCLUDES     0
102 #define SERVER_EXCLUDES 1
103 #define ALL_EXCLUDES    2
104
105 #define MISSING_OK    0
106 #define MISSING_FATAL 1
107
108 #define ADD_INCLUDE 1
109 #define ADD_EXCLUDE 0
110
111 #define FULL_FLUSH      1
112 #define NORMAL_FLUSH    0
113
114 /* Log-message categories.  FLOG is only used on the daemon side to
115  * output messages to the log file. */
116 enum logcode { FERROR=1, FINFO=2, FLOG=3 };
117
118 /* Messages types that are sent over the message channel.  The logcode
119  * values must all be present here with identical numbers. */
120 enum msgcode {
121         MSG_DATA=0,     /* raw data on the multiplexed stream */
122         MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */
123         MSG_REDO=4,     /* reprocess indicated flist index */
124         MSG_DONE=5,     /* current phase is done */
125 };
126
127 #include "errcode.h"
128
129 #include "config.h"
130
131 /* The default RSYNC_RSH is always set in config.h. */
132
133 #include <sys/types.h>
134
135 #ifdef HAVE_UNISTD_H
136 #include <unistd.h>
137 #endif
138 #include <stdio.h>
139 #include <stddef.h>
140
141 #ifdef HAVE_SYS_PARAM_H
142 #include <sys/param.h>
143 #endif
144
145 #ifdef HAVE_STDLIB_H
146 #include <stdlib.h>
147 #endif
148
149 #if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
150 #include <malloc.h>
151 #endif
152
153 #ifdef HAVE_SYS_SOCKET_H
154 #include <sys/socket.h>
155 #endif
156
157 #ifdef HAVE_STRING_H
158 #include <string.h>
159 #endif
160
161 #ifdef TIME_WITH_SYS_TIME
162 #include <sys/time.h>
163 #include <time.h>
164 #else
165 #ifdef HAVE_SYS_TIME_H
166 #include <sys/time.h>
167 #else
168 #include <time.h>
169 #endif
170 #endif
171
172 #ifdef HAVE_FCNTL_H
173 #include <fcntl.h>
174 #else
175 #ifdef HAVE_SYS_FCNTL_H
176 #include <sys/fcntl.h>
177 #endif
178 #endif
179
180 #include <sys/stat.h>
181
182 #ifdef HAVE_SYS_IOCTL_H
183 #include <sys/ioctl.h>
184 #endif
185
186 #ifdef HAVE_SYS_FILIO_H
187 #include <sys/filio.h>
188 #endif
189
190 #include <signal.h>
191 #ifdef HAVE_SYS_WAIT_H
192 #include <sys/wait.h>
193 #endif
194 #ifdef HAVE_CTYPE_H
195 #include <ctype.h>
196 #endif
197 #ifdef HAVE_GRP_H
198 #include <grp.h>
199 #endif
200 #include <errno.h>
201
202 #ifdef HAVE_UTIME_H
203 #include <utime.h>
204 #endif
205
206 #ifdef HAVE_SYS_SELECT_H
207 #include <sys/select.h>
208 #endif
209
210 #ifdef HAVE_SYS_MODE_H
211 /* apparently AIX needs this for S_ISLNK */
212 #ifndef S_ISLNK
213 #include <sys/mode.h>
214 #endif
215 #endif
216
217 #ifdef HAVE_GLOB_H
218 #include <glob.h>
219 #endif
220
221 /* these are needed for the uid/gid mapping code */
222 #include <pwd.h>
223 #include <grp.h>
224
225 #include <stdarg.h>
226 #include <netinet/in.h>
227 #include <arpa/inet.h>
228 #include <netdb.h>
229 #include <syslog.h>
230 #include <sys/file.h>
231
232 #if HAVE_DIRENT_H
233 # include <dirent.h>
234 #else
235 # define dirent direct
236 # if HAVE_SYS_NDIR_H
237 #  include <sys/ndir.h>
238 # endif
239 # if HAVE_SYS_DIR_H
240 #  include <sys/dir.h>
241 # endif
242 # if HAVE_NDIR_H
243 #  include <ndir.h>
244 # endif
245 #endif
246
247 #ifdef HAVE_COMPAT_H
248 #include <compat.h>
249 #endif
250
251 #include <assert.h>
252
253
254 #define BOOL int
255
256 #ifndef uchar
257 #define uchar unsigned char
258 #endif
259
260 #if HAVE_UNSIGNED_CHAR
261 #define schar signed char
262 #else
263 #define schar char
264 #endif
265
266 #ifndef int32
267 #if (SIZEOF_INT == 4)
268 #define int32 int
269 #elif (SIZEOF_LONG == 4)
270 #define int32 long
271 #elif (SIZEOF_SHORT == 4)
272 #define int32 short
273 #else
274 /* I hope this works */
275 #define int32 int
276 #define LARGE_INT32
277 #endif
278 #endif
279
280 #ifndef uint32
281 #define uint32 unsigned int32
282 #endif
283
284 #if HAVE_OFF64_T
285 #define OFF_T off64_t
286 #define STRUCT_STAT struct stat64
287 #else
288 #define OFF_T off_t
289 #define STRUCT_STAT struct stat
290 #endif
291
292 #if HAVE_OFF64_T
293 #define int64 off64_t
294 #elif (SIZEOF_LONG == 8) 
295 #define int64 long
296 #elif (SIZEOF_INT == 8) 
297 #define int64 int
298 #elif HAVE_LONGLONG
299 #define int64 long long
300 #else
301 /* As long as it gets... */
302 #define int64 off_t
303 #define NO_INT64
304 #endif
305
306 #if (SIZEOF_LONG == 8) 
307 #define uint64 unsigned long
308 #elif (SIZEOF_INT == 8) 
309 #define uint64 unsigned int
310 #elif HAVE_LONGLONG
311 #define uint64 unsigned long long
312 #else
313 /* As long as it gets... */
314 #define uint64 unsigned off_t
315 #endif
316
317 /* Starting from protocol version 26, we always use 64-bit
318  * ino_t and dev_t internally, even if this platform does not
319  * allow files to have 64-bit inums.  That's because the
320  * receiver needs to find duplicate (dev,ino) tuples to detect
321  * hardlinks, and it might have files coming from a platform
322  * that has 64-bit inums.
323  *
324  * The only exception is if we're on a platform with no 64-bit type at
325  * all.
326  *
327  * Because we use read_longint() to get these off the wire, if you
328  * transfer devices or hardlinks with dev or inum > 2**32 to a machine
329  * with no 64-bit types then you will get an overflow error.  Probably
330  * not many people have that combination of machines, and you can
331  * avoid it by not preserving hardlinks or not transferring device
332  * nodes.  It's not clear that any other behaviour is better.
333  *
334  * Note that if you transfer devices from a 64-bit-devt machine (say,
335  * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
336  * device numbers will be truncated.  But it's a kind of silly thing
337  * to do anyhow.
338  *
339  * FIXME: In future, we should probable split the device number into
340  * major/minor, and transfer the two parts as 32-bit ints.  That gives
341  * you somewhat more of a chance that they'll come from a big machine
342  * to a little one in a useful way.
343  *
344  * FIXME: Really we need an unsigned type, and we perhaps ought to
345  * cope with platforms on which this is an unsigned int or even a
346  * struct.  Later.
347  */ 
348 #define INO64_T uint64
349 #define DEV64_T uint64
350
351 #ifndef MIN
352 #define MIN(a,b) ((a)<(b)?(a):(b))
353 #endif
354
355 #ifndef MAX
356 #define MAX(a,b) ((a)>(b)?(a):(b))
357 #endif
358
359 #ifndef MAXHOSTNAMELEN
360 #define MAXHOSTNAMELEN 256
361 #endif
362
363 /* the length of the md4 checksum */
364 #define MD4_SUM_LENGTH 16
365 #define SUM_LENGTH 16
366 #define SHORT_SUM_LENGTH 2
367 #define BLOCKSUM_BIAS 10
368
369 #ifndef MAXPATHLEN
370 #define MAXPATHLEN 1024
371 #endif
372
373 #ifndef NAME_MAX
374 #define NAME_MAX 255
375 #endif
376
377 #ifndef INADDR_NONE
378 #define INADDR_NONE 0xffffffff
379 #endif
380
381 #ifndef IN_LOOPBACKNET
382 #define IN_LOOPBACKNET 127
383 #endif
384
385 #define GID_NONE (gid_t) -1
386
387 #define HL_CHECK_MASTER 0
388 #define HL_SKIP         1
389
390 struct hlink {
391         int hlindex;
392         struct file_struct *next;
393 };
394
395 struct idev {
396         INO64_T inode;
397         DEV64_T dev;
398 };
399
400 #define F_DEV   link_u.idev->dev
401 #define F_INODE link_u.idev->inode
402
403 #define F_HLINDEX link_u.links->hlindex
404 #define F_NEXT  link_u.links->next
405
406 struct file_struct {
407         time_t modtime;
408         OFF_T length;
409         mode_t mode;
410         union {
411                 DEV64_T rdev;   /* The device number, if this is a device */
412                 char *sum;      /* Only a normal file can have a checksum */
413                 char *link;     /* Holds symlink string, if a symlink */
414         } u;
415         union {
416                 struct idev *idev;
417                 struct hlink *links;
418         } link_u;
419         char *basename;
420         char *dirname;
421         char *basedir;
422         uid_t uid;
423         gid_t gid;
424         uchar flags;
425 };
426
427 #define ARENA_SIZE      (32 * 1024)
428
429 struct string_area {
430         char *base;
431         char *end;
432         char *current;
433         struct string_area *next;
434 };
435
436 struct file_list {
437         int count;
438         int malloced;
439         struct file_struct **files;
440         struct string_area *string_area;
441 };
442
443 struct sum_buf {
444         OFF_T offset;           /**< offset in file of this chunk */
445         unsigned int len;       /**< length of chunk of file */
446         int i;                  /**< index of this chunk */
447         uint32 sum1;            /**< simple checksum */
448         char sum2[SUM_LENGTH];  /**< checksum  */
449 };
450
451 struct sum_struct {
452         OFF_T flength;          /**< total file length */
453         size_t count;           /**< how many chunks */
454         unsigned int blength;   /**< block_length */
455         unsigned int remainder; /**< flength % block_length */
456         int s2length;           /**< sum2_length */
457         struct sum_buf *sums;   /**< points to info for each chunk */
458 };
459
460 struct map_struct {
461         char *p;                /* Window pointer                       */
462         int fd;                 /* File Descriptor                      */
463         int p_size;             /* Window size at allocation            */
464         int p_len;              /* Window size after fill               */
465                                 /*    p_size and p_len could be
466                                  *    consolodated by using a local
467                                  *    variable in map_ptr()             */
468         int status;             /* first errno from read errors         */
469         OFF_T file_size;        /* File size (from stat)                */
470         OFF_T p_offset;         /* Window start                         */
471         OFF_T p_fd_offset;      /* offset of cursor in fd ala lseek     */
472 };
473
474 #define MATCHFLG_WILD           (1<<0) /* pattern has '*', '[', and/or '?' */
475 #define MATCHFLG_WILD2          (1<<1) /* pattern has '**' */
476 #define MATCHFLG_WILD2_PREFIX   (1<<2) /* pattern starts with '**' */
477 #define MATCHFLG_ABS_PATH       (1<<3) /* path-match on absolute path */
478 struct exclude_struct {
479         char *pattern;
480         int match_flags;
481         int include;
482         int directory;
483         int slash_cnt;
484 };
485
486 struct stats {
487         int64 total_size;
488         int64 total_transferred_size;
489         int64 total_written;
490         int64 total_read;
491         int64 literal_data;
492         int64 matched_data;
493         int flist_size;
494         int num_files;
495         int num_transferred_files;
496         int current_file_index;
497 };
498
499
500 /* we need this function because of the silly way in which duplicate
501    entries are handled in the file lists - we can't change this
502    without breaking existing versions */
503 static inline int flist_up(struct file_list *flist, int i)
504 {
505         while (!flist->files[i]->basename) i++;
506         return i;
507 }
508
509 #include "byteorder.h"
510 #include "lib/mdfour.h"
511 #include "lib/wildmatch.h"
512 #include "lib/permstring.h"
513 #include "lib/addrinfo.h"
514
515 #include "proto.h"
516
517 /* We have replacement versions of these if they're missing. */
518 #ifndef HAVE_ASPRINTF
519 int asprintf(char **ptr, const char *format, ...);
520 #endif
521
522 #ifndef HAVE_VASPRINTF
523 int vasprintf(char **ptr, const char *format, va_list ap);
524 #endif
525
526 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
527 #define vsnprintf rsync_vsnprintf
528 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
529 #endif
530
531 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
532 #define snprintf rsync_snprintf
533 int snprintf(char *str,size_t count,const char *fmt,...);
534 #endif
535
536
537 #if !HAVE_STRERROR
538 extern char *sys_errlist[];
539 #define strerror(i) sys_errlist[i]
540 #endif
541
542 #ifndef HAVE_STRCHR
543 # define strchr                 index
544 # define strrchr                rindex
545 #endif
546
547 #ifndef HAVE_ERRNO_DECL
548 extern int errno;
549 #endif
550
551 #define SUPPORT_LINKS HAVE_READLINK
552 #define SUPPORT_HARD_LINKS HAVE_LINK
553
554 /* This could be bad on systems which have no lchown and where chown
555  * follows symbollic links.  On such systems it might be better not to
556  * try to chown symlinks at all. */
557 #ifndef HAVE_LCHOWN
558 #define lchown chown
559 #endif
560
561 #define SIGNAL_CAST (RETSIGTYPE (*)())
562
563 #ifndef EWOULDBLOCK
564 #define EWOULDBLOCK EAGAIN
565 #endif
566
567 #ifndef STDIN_FILENO
568 #define STDIN_FILENO 0
569 #endif
570
571 #ifndef STDOUT_FILENO
572 #define STDOUT_FILENO 1
573 #endif
574
575 #ifndef STDERR_FILENO
576 #define STDERR_FILENO 2
577 #endif
578
579 #ifndef S_IWUSR
580 #define S_IWUSR 0200
581 #endif
582
583 #ifndef ACCESSPERMS
584 #define ACCESSPERMS 0777
585 #endif
586
587 #ifndef S_ISVTX
588 #define S_ISVTX 0
589 #endif
590
591 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
592
593 #ifndef _S_IFMT
594 #define _S_IFMT        0170000
595 #endif
596
597 #ifndef _S_IFLNK
598 #define _S_IFLNK  0120000
599 #endif
600
601 #ifndef S_ISLNK
602 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
603 #endif
604
605 #ifndef S_ISBLK
606 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
607 #endif
608
609 #ifndef S_ISCHR
610 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
611 #endif
612
613 #ifndef S_ISSOCK
614 #ifdef _S_IFSOCK
615 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
616 #else
617 #define S_ISSOCK(mode) (0)
618 #endif
619 #endif
620
621 #ifndef S_ISFIFO
622 #ifdef _S_IFIFO
623 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
624 #else
625 #define S_ISFIFO(mode) (0)
626 #endif
627 #endif
628
629 #ifndef S_ISDIR
630 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
631 #endif
632
633 #ifndef S_ISREG
634 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
635 #endif
636
637 /* work out what fcntl flag to use for non-blocking */
638 #ifdef O_NONBLOCK
639 # define NONBLOCK_FLAG O_NONBLOCK
640 #elif defined(SYSV)
641 # define NONBLOCK_FLAG O_NDELAY
642 #else 
643 # define NONBLOCK_FLAG FNDELAY
644 #endif
645
646 #ifndef INADDR_LOOPBACK
647 #define INADDR_LOOPBACK 0x7f000001
648 #endif
649
650 #ifndef INADDR_NONE
651 #define INADDR_NONE 0xffffffff
652 #endif
653
654 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
655
656 /* Initial mask on permissions given to temporary files.  Mask off setuid
657      bits and group access because of potential race-condition security
658      holes, and mask other access because mode 707 is bizarre */
659 #define INITACCESSPERMS 0700
660
661 /* handler for null strings in printf format */
662 #define NS(s) ((s)?(s):"<NULL>")
663
664 #if !defined(__GNUC__) || defined(APPLE)
665 /* Apparently the OS X port of gcc gags on __attribute__.
666  *
667  * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
668 #define __attribute__(x) 
669
670 #endif
671
672 /* Convenient wrappers for malloc and realloc.  Use them. */
673 #define new(type) ((type *)malloc(sizeof(type)))
674 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
675 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
676
677 /* use magic gcc attributes to catch format errors */
678  void rprintf(enum logcode , const char *, ...)
679      __attribute__((format (printf, 2, 3)))
680 ;
681
682 /* This is just like rprintf, but it also tries to print some
683  * representation of the error code.  Normally errcode = errno. */
684 void rsyserr(enum logcode, int, const char *, ...)
685      __attribute__((format (printf, 3, 4)))
686      ;
687
688 #ifdef REPLACE_INET_NTOA
689 #define inet_ntoa rep_inet_ntoa
690 #endif
691
692 /* Make sure that the O_BINARY flag is defined. */
693 #ifndef O_BINARY
694 #define O_BINARY 0
695 #endif
696
697 #ifndef HAVE_STRLCPY
698 size_t strlcpy(char *d, const char *s, size_t bufsize);
699 #endif
700
701 #ifndef HAVE_STRLCAT
702 size_t strlcat(char *d, const char *s, size_t bufsize);
703 #endif
704
705 #ifndef WEXITSTATUS
706 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
707 #endif
708
709 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
710
711
712 extern int verbose;
713
714 #ifndef HAVE_INET_NTOP
715 const char *                 
716 inet_ntop(int af, const void *src, char *dst, size_t size);
717 #endif /* !HAVE_INET_NTOP */
718
719 #ifndef HAVE_INET_PTON
720 int inet_pton(int af, const char *src, void *dst);
721 #endif
722
723 #ifdef MAINTAINER_MODE
724 const char *get_panic_action(void);
725 #endif
726
727 #define UNUSED(x) x __attribute__((__unused__))
728
729 extern const char *io_write_phase, *io_read_phase;