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