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