Tweaked the comment about log-message categories.
[rsync/rsync.git] / rsync.h
1 /*
2  * Copyright (C) 1996, 2000 Andrew Tridgell
3  * Copyright (C) 1996 Paul Mackerras
4  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
5  * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
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 /* RSYNCD_SYSCONF is now set in config.h */
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_RDEV_MAJOR (1<<8)
54 #define XMIT_HAS_IDEV_DATA (1<<9)
55 #define XMIT_SAME_DEV (1<<10)
56 #define XMIT_RDEV_MINOR_IS_SMALL (1<<11)
57
58 /* These flags are used in the live flist data. */
59
60 #define FLAG_TOP_DIR (1<<0)
61 #define FLAG_SENT (1<<1)        /* sender */
62 #define FLAG_HLINK_EOL (1<<1)   /* receiver/generator */
63 #define FLAG_MOUNT_POINT (1<<2) /* sender/generator */
64 #define FLAG_DEL_HERE (1<<3)    /* receiver/generator */
65 #define FLAG_HLINK_TOL (1<<4)   /* receiver/generator */
66 #define FLAG_NO_FUZZY (1<<5)    /* generator */
67
68 /* update this if you make incompatible changes */
69 #define PROTOCOL_VERSION 29
70
71 /* We refuse to interoperate with versions that are not in this range.
72  * Note that we assume we'll work with later versions: the onus is on
73  * people writing them to make sure that they don't send us anything
74  * we won't understand.
75  *
76  * Interoperation with old but supported protocol versions
77  * should cause a warning to be printed.  At a future date
78  * the old protocol will become the minimum and
79  * compatibility code removed.
80  *
81  * There are two possible explanations for the limit at
82  * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
83  * do not interoperate with us, and (more likely) so that we can
84  * detect an attempt to connect rsync to a non-rsync server, which is
85  * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
86  * MAX_PROTOCOL_VERSION. */
87
88 #define MIN_PROTOCOL_VERSION 20
89 #define OLD_PROTOCOL_VERSION 25
90 #define MAX_PROTOCOL_VERSION 40
91
92 #define RSYNC_PORT 873
93
94 #define SPARSE_WRITE_SIZE (1024)
95 #define WRITE_SIZE (32*1024)
96 #define CHUNK_SIZE (32*1024)
97 #define MAX_MAP_SIZE (256*1024)
98 #define IO_BUFFER_SIZE (4092)
99 #define MAX_BLOCK_SIZE ((int32)1 << 29)
100
101 #define IOERR_GENERAL   (1<<0) /* For backward compatibility, this must == 1 */
102 #define IOERR_VANISHED  (1<<1)
103 #define IOERR_DEL_LIMIT (1<<2)
104
105 #define MAX_ARGS 1000
106 #define MAX_BASIS_DIRS 20
107 #define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
108
109 #define MPLEX_BASE 7
110
111 #define NO_FILTERS      0
112 #define SERVER_FILTERS  1
113 #define ALL_FILTERS     2
114
115 #define XFLG_FATAL_ERRORS       (1<<0)
116 #define XFLG_OLD_PREFIXES       (1<<1)
117 #define XFLG_ANCHORED2ABS       (1<<2)
118 #define XFLG_ABS_IF_SLASH       (1<<3)
119
120 #define ATTRS_REPORT            (1<<0)
121 #define ATTRS_SKIP_MTIME        (1<<1)
122
123 #define FULL_FLUSH      1
124 #define NORMAL_FLUSH    0
125
126 #define PDIR_CREATE     1
127 #define PDIR_DELETE     0
128
129 /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
130 #define FNAMECMP_BASIS_DIR_LOW  0x00 /* Must remain 0! */
131 #define FNAMECMP_BASIS_DIR_HIGH 0x7F
132 #define FNAMECMP_FNAME          0x80
133 #define FNAMECMP_PARTIAL_DIR    0x81
134 #define FNAMECMP_BACKUP         0x82
135 #define FNAMECMP_FUZZY          0x83
136
137 /* For use by the itemize_changes code */
138 #define ITEM_REPORT_ATIME (1<<0)
139 #define ITEM_REPORT_CHECKSUM (1<<1)
140 #define ITEM_REPORT_SIZE (1<<2)
141 #define ITEM_REPORT_TIME (1<<3)
142 #define ITEM_REPORT_PERMS (1<<4)
143 #define ITEM_REPORT_OWNER (1<<5)
144 #define ITEM_REPORT_GROUP (1<<6)
145 #define ITEM_REPORT_ACL (1<<7)
146 #define ITEM_REPORT_XATTR (1<<8)
147 #define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
148 #define ITEM_XNAME_FOLLOWS (1<<12)
149 #define ITEM_IS_NEW (1<<13)
150 #define ITEM_LOCAL_CHANGE (1<<14)
151 #define ITEM_TRANSFER (1<<15)
152 /* These are outside the range of the transmitted flags. */
153 #define ITEM_MISSING_DATA (1<<16)          /* used by log_formatted() */
154 #define ITEM_DELETED (1<<17)               /* used by log_formatted() */
155
156 #define SIGNIFICANT_ITEM_FLAGS (~(\
157         ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
158
159
160 /* Log-message categories.  Only FERROR and FINFO get sent over the socket,
161  * but FLOG and FSOCKERR can be sent over the receiver -> generator pipe.
162  * FLOG only goes to the log file, not to the client; FCLIENT is the opposite.
163  * FNAME is a client-side message when outputting a filename on its own. */
164 enum logcode { FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FNAME=5, FSOCKERR=6 };
165
166 /* Messages types that are sent over the message channel.  The logcode
167  * values must all be present here with identical numbers. */
168 enum msgcode {
169         MSG_DATA=0,     /* raw data on the multiplexed stream */
170         MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
171         MSG_LOG=FLOG, MSG_SOCKERR=FSOCKERR, /* sibling logging */
172         MSG_REDO=9,     /* reprocess indicated flist index */
173         MSG_SUCCESS=100,/* successfully updated indicated flist index */
174         MSG_DELETED=101,/* successfully deleted a file on receiving side */
175         MSG_DONE=86     /* current phase is done */
176 };
177
178 #include "errcode.h"
179
180 #include "config.h"
181
182 /* The default RSYNC_RSH is always set in config.h. */
183
184 #include <stdio.h>
185 #ifdef HAVE_SYS_TYPES_H
186 # include <sys/types.h>
187 #endif
188 #ifdef HAVE_SYS_STAT_H
189 # include <sys/stat.h>
190 #endif
191 #ifdef STDC_HEADERS
192 # include <stdlib.h>
193 # include <stddef.h>
194 #else
195 # ifdef HAVE_STDLIB_H
196 #  include <stdlib.h>
197 # endif
198 #endif
199 #ifdef HAVE_STRING_H
200 # if !defined STDC_HEADERS && defined HAVE_MEMORY_H
201 #  include <memory.h>
202 # endif
203 # include <string.h>
204 #endif
205 #ifdef HAVE_STRINGS_H
206 # include <strings.h>
207 #endif
208 #ifdef HAVE_UNISTD_H
209 # include <unistd.h>
210 #endif
211
212 #ifdef HAVE_SYS_PARAM_H
213 #include <sys/param.h>
214 #endif
215
216 #if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
217 #include <malloc.h>
218 #endif
219
220 #ifdef HAVE_SYS_SOCKET_H
221 #include <sys/socket.h>
222 #endif
223
224 #ifdef TIME_WITH_SYS_TIME
225 #include <sys/time.h>
226 #include <time.h>
227 #else
228 #ifdef HAVE_SYS_TIME_H
229 #include <sys/time.h>
230 #else
231 #include <time.h>
232 #endif
233 #endif
234
235 #ifdef HAVE_FCNTL_H
236 #include <fcntl.h>
237 #else
238 #ifdef HAVE_SYS_FCNTL_H
239 #include <sys/fcntl.h>
240 #endif
241 #endif
242
243 #ifdef HAVE_SYS_IOCTL_H
244 #include <sys/ioctl.h>
245 #endif
246
247 #ifdef HAVE_SYS_FILIO_H
248 #include <sys/filio.h>
249 #endif
250
251 #include <signal.h>
252 #ifdef HAVE_SYS_WAIT_H
253 #include <sys/wait.h>
254 #endif
255 #ifdef HAVE_CTYPE_H
256 #include <ctype.h>
257 #endif
258 #ifdef HAVE_GRP_H
259 #include <grp.h>
260 #endif
261 #include <errno.h>
262
263 #ifdef HAVE_UTIME_H
264 #include <utime.h>
265 #endif
266
267 #ifdef HAVE_SYS_SELECT_H
268 #include <sys/select.h>
269 #endif
270
271 #ifdef HAVE_SYS_MODE_H
272 /* apparently AIX needs this for S_ISLNK */
273 #ifndef S_ISLNK
274 #include <sys/mode.h>
275 #endif
276 #endif
277
278 #ifdef HAVE_GLOB_H
279 #include <glob.h>
280 #endif
281
282 /* these are needed for the uid/gid mapping code */
283 #include <pwd.h>
284 #include <grp.h>
285
286 #include <stdarg.h>
287 #include <netinet/in.h>
288 #include <arpa/inet.h>
289 #include <netdb.h>
290 #include <syslog.h>
291 #include <sys/file.h>
292
293 #ifdef HAVE_DIRENT_H
294 # include <dirent.h>
295 #else
296 # define dirent direct
297 # ifdef HAVE_SYS_NDIR_H
298 #  include <sys/ndir.h>
299 # endif
300 # ifdef HAVE_SYS_DIR_H
301 #  include <sys/dir.h>
302 # endif
303 # ifdef HAVE_NDIR_H
304 #  include <ndir.h>
305 # endif
306 #endif
307
308 #ifdef MAJOR_IN_MKDEV
309 #include <sys/mkdev.h>
310 # if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
311 #  define makedev mkdev
312 # endif
313 #elif defined MAJOR_IN_SYSMACROS
314 #include <sys/sysmacros.h>
315 #endif
316
317 #ifdef HAVE_COMPAT_H
318 #include <compat.h>
319 #endif
320
321 #ifdef HAVE_LIMITS_H
322 # include <limits.h>
323 #endif
324
325 #include <assert.h>
326
327 #include "lib/pool_alloc.h"
328
329 #define BOOL int
330
331 #ifndef uchar
332 #define uchar unsigned char
333 #endif
334
335 #ifdef SIGNED_CHAR_OK
336 #define schar signed char
337 #else
338 #define schar char
339 #endif
340
341 /* Find a variable that is either exactly 32-bits or longer.
342  * If some code depends on 32-bit truncation, it will need to
343  * take special action in a "#if SIZEOF_INT32 > 4" section. */
344 #ifndef int32
345 #if SIZEOF_INT == 4
346 # define int32 int
347 # define SIZEOF_INT32 4
348 #elif SIZEOF_LONG == 4
349 # define int32 long
350 # define SIZEOF_INT32 4
351 #elif SIZEOF_SHORT == 4
352 # define int32 short
353 # define SIZEOF_INT32 4
354 #elif SIZEOF_INT > 4
355 # define int32 int
356 # define SIZEOF_INT32 SIZEOF_INT
357 #elif SIZEOF_LONG > 4
358 # define int32 long
359 # define SIZEOF_INT32 SIZEOF_LONG
360 #else
361 # error Could not find a 32-bit integer variable
362 #endif
363 #else
364 # define SIZEOF_INT32 4
365 #endif
366
367 #ifndef uint32
368 #define uint32 unsigned int32
369 #endif
370
371 #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
372 #define OFF_T off_t
373 #define STRUCT_STAT struct stat
374 #else
375 #define OFF_T off64_t
376 #define STRUCT_STAT struct stat64
377 #define USE_STAT64_FUNCS 1
378 #endif
379
380 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
381  * that's the maximum size the file system can handle and there is no
382  * 64-bit type available.  The rsync source must therefore take steps
383  * to ensure that any code that really requires a 64-bit integer has
384  * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
385  * counter). */
386 #if SIZEOF_OFF64_T == 8
387 # define int64 off64_t
388 # define SIZEOF_INT64 8
389 #elif SIZEOF_LONG == 8
390 # define int64 long
391 # define SIZEOF_INT64 8
392 #elif SIZEOF_INT == 8
393 # define int64 int
394 # define SIZEOF_INT64 8
395 #elif SIZEOF_LONG_LONG == 8
396 # define int64 long long
397 # define SIZEOF_INT64 8
398 #elif SIZEOF_OFF_T == 8
399 # define int64 off_t
400 # define SIZEOF_INT64 8
401 #elif SIZEOF_INT > 8
402 # define int64 int
403 # define SIZEOF_INT64 SIZEOF_INT
404 #elif SIZEOF_LONG > 8
405 # define int64 long
406 # define SIZEOF_INT64 SIZEOF_LONG
407 #elif SIZEOF_LONG_LONG > 8
408 # define int64 long long
409 # define SIZEOF_INT64 SIZEOF_LONG_LONG
410 #else
411 /* As long as it gets... */
412 # define int64 off_t
413 # define SIZEOF_INT64 SIZEOF_OFF_T
414 #endif
415
416 /* Starting from protocol version 26, we always use 64-bit
417  * ino_t and dev_t internally, even if this platform does not
418  * allow files to have 64-bit inums.  That's because the
419  * receiver needs to find duplicate (dev,ino) tuples to detect
420  * hardlinks, and it might have files coming from a platform
421  * that has 64-bit inums.
422  *
423  * The only exception is if we're on a platform with no 64-bit type at
424  * all.
425  *
426  * Because we use read_longint() to get these off the wire, if you
427  * transfer devices or hardlinks with dev or inum > 2**32 to a machine
428  * with no 64-bit types then you will get an overflow error.  Probably
429  * not many people have that combination of machines, and you can
430  * avoid it by not preserving hardlinks or not transferring device
431  * nodes.  It's not clear that any other behaviour is better.
432  *
433  * Note that if you transfer devices from a 64-bit-devt machine (say,
434  * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
435  * device numbers will be truncated.  But it's a kind of silly thing
436  * to do anyhow.
437  *
438  * FIXME: I don't think the code in flist.c has ever worked on a system
439  * where dev_t is a struct.
440  */
441
442 struct idev {
443         int64 inode;
444         int64 dev;
445 };
446
447 #ifndef MIN
448 #define MIN(a,b) ((a)<(b)?(a):(b))
449 #endif
450
451 #ifndef MAX
452 #define MAX(a,b) ((a)>(b)?(a):(b))
453 #endif
454
455 #ifndef MAXHOSTNAMELEN
456 #define MAXHOSTNAMELEN 256
457 #endif
458
459 /* the length of the md4 checksum */
460 #define MD4_SUM_LENGTH 16
461 #define SUM_LENGTH 16
462 #define SHORT_SUM_LENGTH 2
463 #define BLOCKSUM_BIAS 10
464
465 #ifndef MAXPATHLEN
466 #define MAXPATHLEN 1024
467 #endif
468
469 /* We want a roomy line buffer that can hold more than MAXPATHLEN,
470  * and significantly more than an overly short MAXPATHLEN. */
471 #if MAXPATHLEN < 4096
472 #define BIGPATHBUFLEN (4096+1024)
473 #else
474 #define BIGPATHBUFLEN (MAXPATHLEN+1024)
475 #endif
476
477 #ifndef NAME_MAX
478 #define NAME_MAX 255
479 #endif
480
481 #ifndef INADDR_NONE
482 #define INADDR_NONE 0xffffffff
483 #endif
484
485 #ifndef IN_LOOPBACKNET
486 #define IN_LOOPBACKNET 127
487 #endif
488
489 #define GID_NONE ((gid_t)-1)
490
491 #define HL_CHECK_MASTER 0
492 #define HL_SKIP         1
493
494 struct hlink {
495         int next;
496         int hlindex;
497 };
498
499 #define F_DEV   link_u.idev->dev
500 #define F_INODE link_u.idev->inode
501
502 #define F_HLINDEX link_u.links->hlindex
503 #define F_NEXT  link_u.links->next
504
505 struct file_struct {
506         union {
507                 dev_t rdev;     /* The device number, if this is a device */
508                 char *sum;      /* Only a normal file can have a checksum */
509                 char *link;     /* Points to symlink string, if a symlink */
510         } u;
511         OFF_T length;
512         char *basename;         /* The current item's name (AKA filename) */
513         char *dirname;          /* The directory info inside the transfer */
514         union {
515                 char *root;     /* Sender-side dir info outside transfer */
516                 int depth;      /* Receiver-side directory depth info */
517         } dir;
518         union {
519                 struct idev *idev;
520                 struct hlink *links;
521         } link_u;
522         time_t modtime;
523         uid_t uid;
524         gid_t gid;
525         mode_t mode;
526         uchar flags;    /* this item MUST remain last */
527 };
528
529 /*
530  * Start the flist array at FLIST_START entries and grow it
531  * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
532  */
533 #define FLIST_START     (32 * 1024)
534 #define FLIST_LINEAR    (FLIST_START * 512)
535
536 /*
537  * Extent size for allocation pools A minimum size of 128KB
538  * is needed to mmap them so that freeing will release the
539  * space to the OS.
540  *
541  * Larger sizes reduce leftover fragments and speed free calls
542  * (when they happen) Smaller sizes increase the chance of
543  * freed allocations freeing whole extents.
544  */
545 #define FILE_EXTENT     (256 * 1024)
546 #define HLINK_EXTENT    (128 * 1024)
547
548 #define WITH_HLINK      1
549 #define WITHOUT_HLINK   0
550
551 struct file_list {
552         struct file_struct **files;
553         alloc_pool_t file_pool;
554         alloc_pool_t hlink_pool;
555         int count;
556         int malloced;
557         int low, high;
558 };
559
560 #define SUMFLG_SAME_OFFSET      (1<<0)
561
562 struct sum_buf {
563         OFF_T offset;           /**< offset in file of this chunk */
564         int32 len;              /**< length of chunk of file */
565         uint32 sum1;            /**< simple checksum */
566         int32 chain;            /**< next hash-table collision */
567         short flags;            /**< flag bits */
568         char sum2[SUM_LENGTH];  /**< checksum  */
569 };
570
571 struct sum_struct {
572         OFF_T flength;          /**< total file length */
573         struct sum_buf *sums;   /**< points to info for each chunk */
574         int32 count;            /**< how many chunks */
575         int32 blength;          /**< block_length */
576         int32 remainder;        /**< flength % block_length */
577         int s2length;           /**< sum2_length */
578 };
579
580 struct map_struct {
581         OFF_T file_size;        /* File size (from stat)                */
582         OFF_T p_offset;         /* Window start                         */
583         OFF_T p_fd_offset;      /* offset of cursor in fd ala lseek     */
584         char *p;                /* Window pointer                       */
585         int32 p_size;           /* Largest window size we allocated     */
586         int32 p_len;            /* Latest (rounded) window size         */
587         int32 def_window_size;  /* Default window size                  */
588         int fd;                 /* File Descriptor                      */
589         int status;             /* first errno from read errors         */
590 };
591
592 #define MATCHFLG_WILD           (1<<0) /* pattern has '*', '[', and/or '?' */
593 #define MATCHFLG_WILD2          (1<<1) /* pattern has '**' */
594 #define MATCHFLG_WILD2_PREFIX   (1<<2) /* pattern starts with "**" */
595 #define MATCHFLG_WILD3_SUFFIX   (1<<3) /* pattern ends with "***" */
596 #define MATCHFLG_ABS_PATH       (1<<4) /* path-match on absolute path */
597 #define MATCHFLG_INCLUDE        (1<<5) /* this is an include, not an exclude */
598 #define MATCHFLG_DIRECTORY      (1<<6) /* this matches only directories */
599 #define MATCHFLG_WORD_SPLIT     (1<<7) /* split rules on whitespace */
600 #define MATCHFLG_NO_INHERIT     (1<<8) /* don't inherit these rules */
601 #define MATCHFLG_NO_PREFIXES    (1<<9) /* parse no prefixes from patterns */
602 #define MATCHFLG_MERGE_FILE     (1<<10)/* specifies a file to merge */
603 #define MATCHFLG_PERDIR_MERGE   (1<<11)/* merge-file is searched per-dir */
604 #define MATCHFLG_EXCLUDE_SELF   (1<<12)/* merge-file name should be excluded */
605 #define MATCHFLG_FINISH_SETUP   (1<<13)/* per-dir merge file needs setup */
606 #define MATCHFLG_NEGATE         (1<<14)/* rule matches when pattern does not */
607 #define MATCHFLG_CVS_IGNORE     (1<<15)/* rule was -C or :C */
608 #define MATCHFLG_SENDER_SIDE    (1<<16)/* rule applies to the sending side */
609 #define MATCHFLG_RECEIVER_SIDE  (1<<17)/* rule applies to the receiving side */
610 #define MATCHFLG_CLEAR_LIST     (1<<18)/* this item is the "!" token */
611
612 #define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
613                                 | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
614                                 | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE)
615
616 struct filter_struct {
617         struct filter_struct *next;
618         char *pattern;
619         uint32 match_flags;
620         union {
621                 int slash_cnt;
622                 struct filter_list_struct *mergelist;
623         } u;
624 };
625
626 struct filter_list_struct {
627         struct filter_struct *head;
628         struct filter_struct *tail;
629         char *debug_type;
630 };
631
632 struct stats {
633         int64 total_size;
634         int64 total_transferred_size;
635         int64 total_written;
636         int64 total_read;
637         int64 literal_data;
638         int64 matched_data;
639         int64 flist_buildtime;
640         int64 flist_xfertime;
641         int flist_size;
642         int num_files;
643         int num_transferred_files;
644         int current_file_index;
645 };
646
647 struct chmod_mode_struct;
648
649 #include "byteorder.h"
650 #include "lib/mdfour.h"
651 #include "lib/wildmatch.h"
652 #include "lib/permstring.h"
653 #include "lib/addrinfo.h"
654
655 #if !defined __GNUC__ || defined __APPLE__
656 /* Apparently the OS X port of gcc gags on __attribute__.
657  *
658  * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
659 #define __attribute__(x)
660 #endif
661
662 #define UNUSED(x) x __attribute__((__unused__))
663
664 #include "proto.h"
665
666 /* We have replacement versions of these if they're missing. */
667 #ifndef HAVE_ASPRINTF
668 int asprintf(char **ptr, const char *format, ...);
669 #endif
670
671 #ifndef HAVE_VASPRINTF
672 int vasprintf(char **ptr, const char *format, va_list ap);
673 #endif
674
675 #if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
676 #define vsnprintf rsync_vsnprintf
677 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
678 #endif
679
680 #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
681 #define snprintf rsync_snprintf
682 int snprintf(char *str,size_t count,const char *fmt,...);
683 #endif
684
685
686 #ifndef HAVE_STRERROR
687 extern char *sys_errlist[];
688 #define strerror(i) sys_errlist[i]
689 #endif
690
691 #ifndef HAVE_STRCHR
692 # define strchr                 index
693 # define strrchr                rindex
694 #endif
695
696 #ifndef HAVE_ERRNO_DECL
697 extern int errno;
698 #endif
699
700 #ifdef HAVE_READLINK
701 #define SUPPORT_LINKS 1
702 #endif
703 #ifdef HAVE_LINK
704 #define SUPPORT_HARD_LINKS 1
705 #endif
706
707 #ifdef HAVE_SIGACTION
708 #define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
709 #define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
710 #else
711 #define SIGACTION(n,h) signal(n,h)
712 #endif
713
714 #ifndef EWOULDBLOCK
715 #define EWOULDBLOCK EAGAIN
716 #endif
717
718 #ifndef STDIN_FILENO
719 #define STDIN_FILENO 0
720 #endif
721
722 #ifndef STDOUT_FILENO
723 #define STDOUT_FILENO 1
724 #endif
725
726 #ifndef STDERR_FILENO
727 #define STDERR_FILENO 2
728 #endif
729
730 #ifndef S_IRUSR
731 #define S_IRUSR 0400
732 #endif
733
734 #ifndef S_IWUSR
735 #define S_IWUSR 0200
736 #endif
737
738 #ifndef ACCESSPERMS
739 #define ACCESSPERMS 0777
740 #endif
741
742 #ifndef S_ISVTX
743 #define S_ISVTX 0
744 #endif
745
746 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
747
748 #ifndef _S_IFMT
749 #define _S_IFMT        0170000
750 #endif
751
752 #ifndef _S_IFLNK
753 #define _S_IFLNK  0120000
754 #endif
755
756 #ifndef S_ISLNK
757 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
758 #endif
759
760 #ifndef S_ISBLK
761 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
762 #endif
763
764 #ifndef S_ISCHR
765 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
766 #endif
767
768 #ifndef S_ISSOCK
769 #ifdef _S_IFSOCK
770 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
771 #else
772 #define S_ISSOCK(mode) (0)
773 #endif
774 #endif
775
776 #ifndef S_ISFIFO
777 #ifdef _S_IFIFO
778 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
779 #else
780 #define S_ISFIFO(mode) (0)
781 #endif
782 #endif
783
784 #ifndef S_ISDIR
785 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
786 #endif
787
788 #ifndef S_ISREG
789 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
790 #endif
791
792 /* work out what fcntl flag to use for non-blocking */
793 #ifdef O_NONBLOCK
794 # define NONBLOCK_FLAG O_NONBLOCK
795 #elif defined SYSV
796 # define NONBLOCK_FLAG O_NDELAY
797 #else
798 # define NONBLOCK_FLAG FNDELAY
799 #endif
800
801 #ifndef INADDR_LOOPBACK
802 #define INADDR_LOOPBACK 0x7f000001
803 #endif
804
805 #ifndef INADDR_NONE
806 #define INADDR_NONE 0xffffffff
807 #endif
808
809 #define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
810 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
811
812 /* Initial mask on permissions given to temporary files.  Mask off setuid
813      bits and group access because of potential race-condition security
814      holes, and mask other access because mode 707 is bizarre */
815 #define INITACCESSPERMS 0700
816
817 /* handler for null strings in printf format */
818 #define NS(s) ((s)?(s):"<NULL>")
819
820 /* Convenient wrappers for malloc and realloc.  Use them. */
821 #define new(type) ((type *)malloc(sizeof(type)))
822 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
823 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
824
825 /* use magic gcc attributes to catch format errors */
826  void rprintf(enum logcode , const char *, ...)
827      __attribute__((format (printf, 2, 3)))
828 ;
829
830 /* This is just like rprintf, but it also tries to print some
831  * representation of the error code.  Normally errcode = errno. */
832 void rsyserr(enum logcode, int, const char *, ...)
833      __attribute__((format (printf, 3, 4)))
834      ;
835
836 /* Make sure that the O_BINARY flag is defined. */
837 #ifndef O_BINARY
838 #define O_BINARY 0
839 #endif
840
841 #ifndef HAVE_STRLCPY
842 size_t strlcpy(char *d, const char *s, size_t bufsize);
843 #endif
844
845 #ifndef HAVE_STRLCAT
846 size_t strlcat(char *d, const char *s, size_t bufsize);
847 #endif
848
849 #ifndef WEXITSTATUS
850 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
851 #endif
852
853 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
854
855 #ifdef HAVE_GETEUID
856 #define MY_UID() geteuid()
857 #else
858 #define MY_UID() getuid()
859 #endif
860
861 #ifdef HAVE_GETEGID
862 #define MY_GID() getegid()
863 #else
864 #define MY_GID() getgid()
865 #endif
866
867 extern int verbose;
868
869 #ifndef HAVE_INET_NTOP
870 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
871 #endif
872
873 #ifndef HAVE_INET_PTON
874 int inet_pton(int af, const char *src, void *dst);
875 #endif
876
877 #ifdef MAINTAINER_MODE
878 const char *get_panic_action(void);
879 #endif