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