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