Use "#if" (not "#ifdef") for configure-defined macros.
[rsync/rsync.git] / rsync.h
CommitLineData
d622d4bf 1/*
a039749b 2 Copyright (C) by Andrew Tridgell 1996, 2000
c627d613 3 Copyright (C) Paul Mackerras 1996
736a6a29 4 Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
d622d4bf 5
c627d613
AT
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.
d622d4bf 10
c627d613
AT
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.
d622d4bf 15
c627d613
AT
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
0de40240 21
d41c7d02
DD
22#define False 0
23#define True 1
24
c627d613
AT
25#define BLOCK_SIZE 700
26#define RSYNC_RSH_ENV "RSYNC_RSH"
8dd99390 27#define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
7b8356d0 28
c627d613 29#define RSYNC_NAME "rsync"
cd3fe9fb 30/* RSYNCD_SYSCONF is now set in config.h */
30e8c8e1 31#define RSYNCD_USERCONF "rsyncd.conf"
f0fca04e 32
5e71c444 33#define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
f7632fc6
AT
34#define URL_PREFIX "rsync://"
35
c627d613
AT
36#define BACKUP_SUFFIX "~"
37
1b01b295 38/* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
6543dc0c 39 incompatible with older versions :-( */
1b01b295
AT
40#define CHAR_OFFSET 0
41
a5f9cff2
WD
42/* These flags are only used during the flist transfer. */
43
71e27c46 44#define XMIT_DEL_START (1<<0)
a5f9cff2
WD
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)
af107f6c 53#define XMIT_SAME_RDEV_MAJOR (1<<8)
a5f9cff2
WD
54#define XMIT_HAS_IDEV_DATA (1<<9)
55#define XMIT_SAME_DEV (1<<10)
af107f6c 56#define XMIT_RDEV_MINOR_IS_SMALL (1<<11)
a5f9cff2
WD
57
58/* These flags are used in the live flist data. */
59
71e27c46 60#define FLAG_DEL_START (1<<0)
a5f9cff2 61#define FLAG_HLINK_EOL (1<<1) /* generator only */
ae289aec 62#define FLAG_MOUNT_POINT (1<<2) /* sender only */
520cf417 63
c627d613 64/* update this if you make incompatible changes */
2b2ea368 65#define PROTOCOL_VERSION 29
063393d6
MP
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 *
1b2db7ae
S
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 *
91c4da3f
S
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
3e491682
S
84#define MIN_PROTOCOL_VERSION 20
85#define OLD_PROTOCOL_VERSION 25
1b2db7ae 86#define MAX_PROTOCOL_VERSION 40
c627d613 87
9486289c
AT
88#define RSYNC_PORT 873
89
d867229b 90#define SPARSE_WRITE_SIZE (1024)
dc5ddbcc 91#define WRITE_SIZE (32*1024)
34ccb63e 92#define CHUNK_SIZE (32*1024)
61542c41 93#define MAX_MAP_SIZE (256*1024)
e3fe383a 94#define IO_BUFFER_SIZE (4092)
2b2ea368 95#define MAX_BLOCK_SIZE ((int32)1 << 29)
c627d613 96
e2d22fee
WD
97#define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
98#define IOERR_VANISHED (1<<1)
99
874895d5 100#define MAX_ARGS 1000
f0fca04e 101
e4977b0b
WD
102#define MAX_BASIS_DIRS 20
103
8d9dc9f9 104#define MPLEX_BASE 7
ff41a59f 105
7842418b
WD
106#define NO_FILTERS 0
107#define SERVER_FILTERS 1
108#define ALL_FILTERS 2
4762db4f 109
753b6b46
WD
110#define XFLG_FATAL_ERRORS (1<<0)
111#define XFLG_DEF_INCLUDE (1<<1)
46fa6025 112#define XFLG_DEF_EXCLUDE (1<<2)
753b6b46 113#define XFLG_WORD_SPLIT (1<<3)
3e976df0 114#define XFLG_DIRECTORY (1<<4)
46fa6025
WD
115#define XFLG_NO_PREFIXES (1<<5)
116#define XFLG_ABS_PATH (1<<6)
4762db4f 117
38443188
WD
118#define PERMS_REPORT (1<<0)
119#define PERMS_SKIP_MTIME (1<<1)
5c6fc4a6 120
419896af
WD
121#define FULL_FLUSH 1
122#define NORMAL_FLUSH 0
123
a7260c40
WD
124#define PDIR_CREATE 1
125#define PDIR_DELETE 0
126
e341588a
WD
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
41cfde6b
WD
130#define FNAMECMP_FNAME 0x80
131#define FNAMECMP_PARTIAL_DIR 0x81
132#define FNAMECMP_BACKUP 0x82
133
eb1accaa 134/* For calling delete_file() */
f5ea4b3b 135#define DEL_DIR (1<<0)
757e0a54
WD
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)
eb1accaa 139
df0054ab 140
419896af
WD
141/* Log-message categories. FLOG is only used on the daemon side to
142 * output messages to the log file. */
143enum 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. */
147enum msgcode {
cde719f4 148 MSG_DONE=5, /* current phase is done */
419896af 149 MSG_REDO=4, /* reprocess indicated flist index */
cde719f4
WD
150 MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */
151 MSG_DATA=0 /* raw data on the multiplexed stream */
419896af 152};
7bec6a5c 153
65417579
AT
154#include "errcode.h"
155
c627d613
AT
156#include "config.h"
157
e3217f14 158/* The default RSYNC_RSH is always set in config.h. */
24d95c03 159
c627d613 160#include <sys/types.h>
6ed67e6d 161
c627d613
AT
162#ifdef HAVE_UNISTD_H
163#include <unistd.h>
164#endif
165#include <stdio.h>
3591c066 166#include <stddef.h>
c627d613
AT
167
168#ifdef HAVE_SYS_PARAM_H
169#include <sys/param.h>
170#endif
171
d7b305fd
AT
172#ifdef HAVE_STDLIB_H
173#include <stdlib.h>
38b02c13 174#endif
59192f56
WD
175
176#if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
177#include <malloc.h>
d7b305fd
AT
178#endif
179
fdd71e17
AT
180#ifdef HAVE_SYS_SOCKET_H
181#include <sys/socket.h>
182#endif
183
d7b305fd
AT
184#ifdef HAVE_STRING_H
185#include <string.h>
c627d613
AT
186#endif
187
c627d613
AT
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
94481d91
AT
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
c627d613
AT
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
c627d613
AT
229#ifdef HAVE_UTIME_H
230#include <utime.h>
231#endif
232
8bf73749
AT
233#ifdef HAVE_SYS_SELECT_H
234#include <sys/select.h>
235#endif
236
773f2bd4
AT
237#ifdef HAVE_SYS_MODE_H
238/* apparently AIX needs this for S_ISLNK */
05a6556d 239#ifndef S_ISLNK
773f2bd4
AT
240#include <sys/mode.h>
241#endif
05a6556d 242#endif
773f2bd4 243
932be9aa 244#ifdef HAVE_GLOB_H
874895d5
AT
245#include <glob.h>
246#endif
247
f6c34742
AT
248/* these are needed for the uid/gid mapping code */
249#include <pwd.h>
250#include <grp.h>
251
9486289c 252#include <stdarg.h>
f0fca04e
AT
253#include <netinet/in.h>
254#include <arpa/inet.h>
255#include <netdb.h>
ff8b29b8 256#include <syslog.h>
6c8f5373 257#include <sys/file.h>
9486289c 258
e8f5b936
AT
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
71f70514 274#if MAJOR_IN_MKDEV
c39d6514 275#include <sys/mkdev.h>
73496a36
WD
276# if !defined(makedev) && defined(mkdev)
277# define makedev mkdev
278# endif
71f70514 279#elif MAJOR_IN_SYSMACROS
f8ed564c 280#include <sys/sysmacros.h>
c39d6514
WD
281#endif
282
e8f5b936
AT
283#ifdef HAVE_COMPAT_H
284#include <compat.h>
285#endif
286
1bfbf40b
MP
287#include <assert.h>
288
9935066b 289#include "lib/pool_alloc.h"
e8f5b936 290
f0fca04e
AT
291#define BOOL int
292
c627d613
AT
293#ifndef uchar
294#define uchar unsigned char
295#endif
296
4a6c209a 297#if SIGNED_CHAR_OK
debb4505
AT
298#define schar signed char
299#else
300#define schar char
301#endif
302
c627d613
AT
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
8de330a3
AT
310#else
311/* I hope this works */
312#define int32 int
f3737e06 313#define LARGE_INT32
c627d613
AT
314#endif
315#endif
316
317#ifndef uint32
318#define uint32 unsigned int32
319#endif
320
d679c839 321#if SIZEOF_OFF64_T
bcacc18b
AT
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
d4198823
WD
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). */
d622d4bf
WD
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
71c46176 359#else
736a6a29 360/* As long as it gets... */
d622d4bf
WD
361# define int64 off_t
362# define SIZEOF_INT64 SIZEOF_OFF_T
71c46176 363#endif
c627d613 364
6abd193f
MP
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.
b9df3bf2 386 *
33a2361c
WD
387 * FIXME: I don't think the code in flist.c has ever worked on a system
388 * where dev_t is a struct.
d622d4bf 389 */
33a2361c
WD
390
391struct idev {
d06f6328
WD
392 int64 inode;
393 int64 dev;
33a2361c 394};
c29ee43d 395
c627d613
AT
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
d41c7d02
DD
404#ifndef MAXHOSTNAMELEN
405#define MAXHOSTNAMELEN 256
406#endif
407
c627d613 408/* the length of the md4 checksum */
ebb0a6f6 409#define MD4_SUM_LENGTH 16
c627d613 410#define SUM_LENGTH 16
195bd906
S
411#define SHORT_SUM_LENGTH 2
412#define BLOCKSUM_BIAS 10
c627d613
AT
413
414#ifndef MAXPATHLEN
415#define MAXPATHLEN 1024
416#endif
417
52d3e106
S
418#ifndef NAME_MAX
419#define NAME_MAX 255
420#endif
421
0473e2a1
AT
422#ifndef INADDR_NONE
423#define INADDR_NONE 0xffffffff
424#endif
425
bda41fa5
WD
426#ifndef IN_LOOPBACKNET
427#define IN_LOOPBACKNET 127
428#endif
429
25bd9945 430#define GID_NONE ((gid_t)-1)
a60e2dca 431
520cf417
WD
432#define HL_CHECK_MASTER 0
433#define HL_SKIP 1
434
88a7fb3e 435struct hlink {
88a7fb3e 436 struct file_struct *next;
2b2ea368 437 int hlindex;
88a7fb3e
WD
438};
439
88a7fb3e
WD
440#define F_DEV link_u.idev->dev
441#define F_INODE link_u.idev->inode
442
520cf417 443#define F_HLINDEX link_u.links->hlindex
fe70ad26
WD
444#define F_NEXT link_u.links->next
445
c627d613 446struct file_struct {
80707c98 447 union {
af107f6c 448 dev_t rdev; /* The device number, if this is a device */
80707c98 449 char *sum; /* Only a normal file can have a checksum */
af107f6c 450 char *link; /* Points to symlink string, if a symlink */
80707c98 451 } u;
0596df00
WD
452 OFF_T length;
453 char *basename;
454 char *dirname;
455 char *basedir;
88a7fb3e
WD
456 union {
457 struct idev *idev;
458 struct hlink *links;
459 } link_u;
0596df00 460 time_t modtime;
88a7fb3e
WD
461 uid_t uid;
462 gid_t gid;
0596df00 463 mode_t mode;
5009de7d 464 uchar flags; /* this item MUST remain last */
c627d613
AT
465};
466
a85906c7
S
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)
b96efc2f 473
9935066b
S
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 */
9935066b
S
483#define FILE_EXTENT (256 * 1024)
484#define HLINK_EXTENT (128 * 1024)
485
486#define WITH_HLINK 1
487#define WITHOUT_HLINK 0
3d382777 488
c627d613 489struct file_list {
2b2ea368 490 struct file_struct **files;
9935066b
S
491 alloc_pool_t file_pool;
492 alloc_pool_t hlink_pool;
2b2ea368
WD
493 int count;
494 int malloced;
c627d613
AT
495};
496
a3221d2a
WD
497#define SUMFLG_SAME_OFFSET (1<<0)
498
c627d613 499struct sum_buf {
6ded1170 500 OFF_T offset; /**< offset in file of this chunk */
a06b419d 501 int32 len; /**< length of chunk of file */
6ded1170 502 uint32 sum1; /**< simple checksum */
a3221d2a 503 short flags; /**< flag bits */
6ded1170 504 char sum2[SUM_LENGTH]; /**< checksum */
c627d613
AT
505};
506
507struct sum_struct {
6ded1170 508 OFF_T flength; /**< total file length */
2b2ea368 509 struct sum_buf *sums; /**< points to info for each chunk */
6ded1170 510 size_t count; /**< how many chunks */
a06b419d
WD
511 int32 blength; /**< block_length */
512 int32 remainder; /**< flength % block_length */
da9d12f5 513 int s2length; /**< sum2_length */
c627d613
AT
514};
515
c6e7fcb4 516struct map_struct {
6a7cc46c
S
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 */
2b2ea368
WD
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 */
c6e7fcb4 526};
c627d613 527
e2d22fee
WD
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 */
669a3192
WD
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 */
46fa6025
WD
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 */
7842418b
WD
542struct filter_struct {
543 struct filter_struct *next;
2b6b4d53 544 char *pattern;
669a3192 545 unsigned int match_flags;
46fa6025
WD
546 union {
547 int slash_cnt;
7842418b 548 struct filter_list_struct *mergelist;
46fa6025 549 } u;
2b6b4d53
AT
550};
551
7842418b
WD
552struct filter_list_struct {
553 struct filter_struct *head;
554 struct filter_struct *tail;
ac1d2d33 555 char *debug_type;
63d03319
WD
556};
557
a800434a
AT
558struct 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;
d4198823
WD
565 int64 flist_buildtime;
566 int64 flist_xfertime;
a800434a
AT
567 int flist_size;
568 int num_files;
569 int num_transferred_files;
dc8293ff 570 int current_file_index;
a800434a
AT
571};
572
2b6b4d53 573
3b3a2fbc
AT
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 */
71c46176 577static inline int flist_up(struct file_list *flist, int i)
3b3a2fbc 578{
3ec4dd97 579 while (!flist->files[i]->basename) i++;
3b3a2fbc
AT
580 return i;
581}
582
c627d613 583#include "byteorder.h"
8de330a3 584#include "lib/mdfour.h"
87f18b62 585#include "lib/wildmatch.h"
740819ef 586#include "lib/permstring.h"
e20a4f84 587#include "lib/addrinfo.h"
0de40240 588
58c29609
MP
589#include "proto.h"
590
0de40240
MP
591/* We have replacement versions of these if they're missing. */
592#ifndef HAVE_ASPRINTF
593int asprintf(char **ptr, const char *format, ...);
594#endif
595
596#ifndef HAVE_VASPRINTF
597int vasprintf(char **ptr, const char *format, va_list ap);
598#endif
599
6813fa7e
WD
600#if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
601#define vsnprintf rsync_vsnprintf
602int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
0de40240
MP
603#endif
604
6813fa7e
WD
605#if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
606#define snprintf rsync_snprintf
0de40240
MP
607int snprintf(char *str,size_t count,const char *fmt,...);
608#endif
609
610
c627d613
AT
611#if !HAVE_STRERROR
612extern 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
c627d613
AT
621#ifndef HAVE_ERRNO_DECL
622extern int errno;
623#endif
624
cbbe4892 625#define SUPPORT_LINKS HAVE_READLINK
dc5ddbcc 626#define SUPPORT_HARD_LINKS HAVE_LINK
c627d613 627
ac1eb754 628#define SIGNAL_CAST (RETSIGTYPE (*)())
720b47f2
AT
629
630#ifndef EWOULDBLOCK
631#define EWOULDBLOCK EAGAIN
632#endif
182dca5c 633
7b8356d0
AT
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
8120a98f
WD
646#ifndef S_IRUSR
647#define S_IRUSR 0400
648#endif
649
7b8356d0
AT
650#ifndef S_IWUSR
651#define S_IWUSR 0200
652#endif
653
b0d791bb
PG
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
b280a1f4
AT
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
1e9f155a
AT
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
a0b65b18
AT
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
1e9f155a
AT
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
f0359dd0
AT
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
d622d4bf 713#else
f0359dd0
AT
714# define NONBLOCK_FLAG FNDELAY
715#endif
716
d79c77ca
MP
717#ifndef INADDR_LOOPBACK
718#define INADDR_LOOPBACK 0x7f000001
719#endif
720
721#ifndef INADDR_NONE
722#define INADDR_NONE 0xffffffff
723#endif
a0b65b18
AT
724
725#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
7bec6a5c 726
5afd8aed
DD
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 */
972a3619 730#define INITACCESSPERMS 0700
e08bfe12
AT
731
732/* handler for null strings in printf format */
733#define NS(s) ((s)?(s):"<NULL>")
734
fb859e56 735#if !defined(__GNUC__) || defined(APPLE)
999dfffc
MP
736/* Apparently the OS X port of gcc gags on __attribute__.
737 *
738 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
d622d4bf 739#define __attribute__(x)
fb859e56
MP
740
741#endif
742
58cadc86
WD
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)))
fb859e56 747
e08bfe12 748/* use magic gcc attributes to catch format errors */
ff41a59f 749 void rprintf(enum logcode , const char *, ...)
fb859e56 750 __attribute__((format (printf, 2, 3)))
e08bfe12 751;
7b3d4257 752
a039749b
MP
753/* This is just like rprintf, but it also tries to print some
754 * representation of the error code. Normally errcode = errno. */
755void rsyserr(enum logcode, int, const char *, ...)
fb859e56 756 __attribute__((format (printf, 3, 4)))
a039749b
MP
757 ;
758
7b3d4257
AT
759#ifdef REPLACE_INET_NTOA
760#define inet_ntoa rep_inet_ntoa
761#endif
5a788ade 762
afbcc8f2
WD
763/* Make sure that the O_BINARY flag is defined. */
764#ifndef O_BINARY
765#define O_BINARY 0
766#endif
5a788ade
AT
767
768#ifndef HAVE_STRLCPY
769size_t strlcpy(char *d, const char *s, size_t bufsize);
770#endif
771
772#ifndef HAVE_STRLCAT
773size_t strlcat(char *d, const char *s, size_t bufsize);
774#endif
775
82980a23
AT
776#ifndef WEXITSTATUS
777#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
778#endif
779
a9766ef1 780#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
eecd22ff 781
b2bffbb2
WD
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
eecd22ff
MP
793
794extern int verbose;
d5d4b282 795
8f694072 796#ifndef HAVE_INET_NTOP
d622d4bf 797const char *inet_ntop(int af, const void *src, char *dst, size_t size);
8f694072
MP
798#endif /* !HAVE_INET_NTOP */
799
800#ifndef HAVE_INET_PTON
bda41fa5 801int inet_pton(int af, const char *src, void *dst);
8f694072 802#endif
0f0ea7f7 803
f4a0483a
MP
804#ifdef MAINTAINER_MODE
805const char *get_panic_action(void);
806#endif
807
fb859e56 808#define UNUSED(x) x __attribute__((__unused__))
eca2adb4 809
c80b3d8c 810extern const char *io_write_phase, *io_read_phase;