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