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