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