- Changed the main core of system include files to use the same "#if"
[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 <stdio.h>
e95538ca
WD
161#if HAVE_SYS_TYPES_H
162# include <sys/types.h>
163#endif
164#if HAVE_SYS_STAT_H
165# include <sys/stat.h>
166#endif
167#if STDC_HEADERS
168# include <stdlib.h>
169# include <stddef.h>
170#else
171# if HAVE_STDLIB_H
172# include <stdlib.h>
173# endif
174#endif
175#if HAVE_STRING_H
176# if !STDC_HEADERS && HAVE_MEMORY_H
177# include <memory.h>
178# endif
179# include <string.h>
180#endif
181#if HAVE_STRINGS_H
182# include <strings.h>
183#endif
184#if HAVE_INTTYPES_H
185# include <inttypes.h>
186#else
187# if HAVE_STDINT_H
188# include <stdint.h>
189# endif
190#endif
191#if HAVE_UNISTD_H
192# include <unistd.h>
c627d613
AT
193#endif
194
e95538ca
WD
195#if HAVE_SYS_PARAM_H
196#include <sys/param.h>
38b02c13 197#endif
59192f56 198
e95538ca 199#if HAVE_MALLOC_H && (HAVE_MALLINFO || !HAVE_STDLIB_H)
59192f56 200#include <malloc.h>
d7b305fd
AT
201#endif
202
e95538ca 203#if HAVE_SYS_SOCKET_H
fdd71e17
AT
204#include <sys/socket.h>
205#endif
206
e95538ca 207#if TIME_WITH_SYS_TIME
c627d613
AT
208#include <sys/time.h>
209#include <time.h>
210#else
e95538ca 211#if HAVE_SYS_TIME_H
c627d613
AT
212#include <sys/time.h>
213#else
214#include <time.h>
215#endif
216#endif
217
e95538ca 218#if HAVE_FCNTL_H
c627d613
AT
219#include <fcntl.h>
220#else
e95538ca 221#if HAVE_SYS_FCNTL_H
c627d613
AT
222#include <sys/fcntl.h>
223#endif
224#endif
225
e95538ca 226#if HAVE_SYS_IOCTL_H
94481d91
AT
227#include <sys/ioctl.h>
228#endif
229
e95538ca 230#if HAVE_SYS_FILIO_H
94481d91
AT
231#include <sys/filio.h>
232#endif
233
c627d613 234#include <signal.h>
e95538ca 235#if HAVE_SYS_WAIT_H
c627d613
AT
236#include <sys/wait.h>
237#endif
e95538ca 238#if HAVE_CTYPE_H
c627d613
AT
239#include <ctype.h>
240#endif
e95538ca 241#if HAVE_GRP_H
c627d613
AT
242#include <grp.h>
243#endif
244#include <errno.h>
245
e95538ca 246#if HAVE_UTIME_H
c627d613
AT
247#include <utime.h>
248#endif
249
e95538ca 250#if HAVE_SYS_SELECT_H
8bf73749
AT
251#include <sys/select.h>
252#endif
253
e95538ca 254#if HAVE_SYS_MODE_H
773f2bd4 255/* apparently AIX needs this for S_ISLNK */
05a6556d 256#ifndef S_ISLNK
773f2bd4
AT
257#include <sys/mode.h>
258#endif
05a6556d 259#endif
773f2bd4 260
e95538ca 261#if HAVE_GLOB_H
874895d5
AT
262#include <glob.h>
263#endif
264
f6c34742
AT
265/* these are needed for the uid/gid mapping code */
266#include <pwd.h>
267#include <grp.h>
268
9486289c 269#include <stdarg.h>
f0fca04e
AT
270#include <netinet/in.h>
271#include <arpa/inet.h>
272#include <netdb.h>
ff8b29b8 273#include <syslog.h>
6c8f5373 274#include <sys/file.h>
9486289c 275
e8f5b936
AT
276#if HAVE_DIRENT_H
277# include <dirent.h>
278#else
279# define dirent direct
280# if HAVE_SYS_NDIR_H
281# include <sys/ndir.h>
282# endif
283# if HAVE_SYS_DIR_H
284# include <sys/dir.h>
285# endif
286# if HAVE_NDIR_H
287# include <ndir.h>
288# endif
289#endif
290
71f70514 291#if MAJOR_IN_MKDEV
c39d6514 292#include <sys/mkdev.h>
73496a36
WD
293# if !defined(makedev) && defined(mkdev)
294# define makedev mkdev
295# endif
71f70514 296#elif MAJOR_IN_SYSMACROS
f8ed564c 297#include <sys/sysmacros.h>
c39d6514
WD
298#endif
299
e95538ca 300#if HAVE_COMPAT_H
e8f5b936
AT
301#include <compat.h>
302#endif
303
1bfbf40b
MP
304#include <assert.h>
305
9935066b 306#include "lib/pool_alloc.h"
e8f5b936 307
f0fca04e
AT
308#define BOOL int
309
c627d613
AT
310#ifndef uchar
311#define uchar unsigned char
312#endif
313
4a6c209a 314#if SIGNED_CHAR_OK
debb4505
AT
315#define schar signed char
316#else
317#define schar char
318#endif
319
c627d613
AT
320#ifndef int32
321#if (SIZEOF_INT == 4)
322#define int32 int
323#elif (SIZEOF_LONG == 4)
324#define int32 long
325#elif (SIZEOF_SHORT == 4)
326#define int32 short
8de330a3
AT
327#else
328/* I hope this works */
329#define int32 int
f3737e06 330#define LARGE_INT32
c627d613
AT
331#endif
332#endif
333
334#ifndef uint32
335#define uint32 unsigned int32
336#endif
337
d679c839 338#if SIZEOF_OFF64_T
bcacc18b
AT
339#define OFF_T off64_t
340#define STRUCT_STAT struct stat64
341#else
342#define OFF_T off_t
343#define STRUCT_STAT struct stat
344#endif
345
d4198823
WD
346/* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
347 * that's the maximum size the file system can handle and there is no
348 * 64-bit type available. The rsync source must therefore take steps
349 * to ensure that any code that really requires a 64-bit integer has
350 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
351 * counter). */
d622d4bf
WD
352#if SIZEOF_OFF64_T == 8
353# define int64 off64_t
354# define SIZEOF_INT64 8
355#elif SIZEOF_LONG == 8
356# define int64 long
357# define SIZEOF_INT64 8
358#elif SIZEOF_INT == 8
359# define int64 int
360# define SIZEOF_INT64 8
361#elif SIZEOF_LONG_LONG == 8
362# define int64 long long
363# define SIZEOF_INT64 8
364#elif SIZEOF_OFF_T == 8
365# define int64 off_t
366# define SIZEOF_INT64 8
367#elif SIZEOF_INT > 8
368# define int64 int
369# define SIZEOF_INT64 SIZEOF_INT
370#elif SIZEOF_LONG > 8
371# define int64 long
372# define SIZEOF_INT64 SIZEOF_LONG
373#elif SIZEOF_LONG_LONG > 8
374# define int64 long long
375# define SIZEOF_INT64 SIZEOF_LONG_LONG
71c46176 376#else
736a6a29 377/* As long as it gets... */
d622d4bf
WD
378# define int64 off_t
379# define SIZEOF_INT64 SIZEOF_OFF_T
71c46176 380#endif
c627d613 381
6abd193f
MP
382/* Starting from protocol version 26, we always use 64-bit
383 * ino_t and dev_t internally, even if this platform does not
384 * allow files to have 64-bit inums. That's because the
385 * receiver needs to find duplicate (dev,ino) tuples to detect
386 * hardlinks, and it might have files coming from a platform
387 * that has 64-bit inums.
388 *
389 * The only exception is if we're on a platform with no 64-bit type at
390 * all.
391 *
392 * Because we use read_longint() to get these off the wire, if you
393 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
394 * with no 64-bit types then you will get an overflow error. Probably
395 * not many people have that combination of machines, and you can
396 * avoid it by not preserving hardlinks or not transferring device
397 * nodes. It's not clear that any other behaviour is better.
398 *
399 * Note that if you transfer devices from a 64-bit-devt machine (say,
400 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
401 * device numbers will be truncated. But it's a kind of silly thing
402 * to do anyhow.
b9df3bf2 403 *
33a2361c
WD
404 * FIXME: I don't think the code in flist.c has ever worked on a system
405 * where dev_t is a struct.
d622d4bf 406 */
33a2361c
WD
407
408struct idev {
d06f6328
WD
409 int64 inode;
410 int64 dev;
33a2361c 411};
c29ee43d 412
c627d613
AT
413#ifndef MIN
414#define MIN(a,b) ((a)<(b)?(a):(b))
415#endif
416
417#ifndef MAX
418#define MAX(a,b) ((a)>(b)?(a):(b))
419#endif
420
d41c7d02
DD
421#ifndef MAXHOSTNAMELEN
422#define MAXHOSTNAMELEN 256
423#endif
424
c627d613 425/* the length of the md4 checksum */
ebb0a6f6 426#define MD4_SUM_LENGTH 16
c627d613 427#define SUM_LENGTH 16
195bd906
S
428#define SHORT_SUM_LENGTH 2
429#define BLOCKSUM_BIAS 10
c627d613
AT
430
431#ifndef MAXPATHLEN
432#define MAXPATHLEN 1024
433#endif
434
52d3e106
S
435#ifndef NAME_MAX
436#define NAME_MAX 255
437#endif
438
0473e2a1
AT
439#ifndef INADDR_NONE
440#define INADDR_NONE 0xffffffff
441#endif
442
bda41fa5
WD
443#ifndef IN_LOOPBACKNET
444#define IN_LOOPBACKNET 127
445#endif
446
25bd9945 447#define GID_NONE ((gid_t)-1)
a60e2dca 448
520cf417
WD
449#define HL_CHECK_MASTER 0
450#define HL_SKIP 1
451
88a7fb3e 452struct hlink {
88a7fb3e 453 struct file_struct *next;
2b2ea368 454 int hlindex;
88a7fb3e
WD
455};
456
88a7fb3e
WD
457#define F_DEV link_u.idev->dev
458#define F_INODE link_u.idev->inode
459
520cf417 460#define F_HLINDEX link_u.links->hlindex
fe70ad26
WD
461#define F_NEXT link_u.links->next
462
c627d613 463struct file_struct {
80707c98 464 union {
af107f6c 465 dev_t rdev; /* The device number, if this is a device */
80707c98 466 char *sum; /* Only a normal file can have a checksum */
af107f6c 467 char *link; /* Points to symlink string, if a symlink */
80707c98 468 } u;
0596df00
WD
469 OFF_T length;
470 char *basename;
471 char *dirname;
472 char *basedir;
88a7fb3e
WD
473 union {
474 struct idev *idev;
475 struct hlink *links;
476 } link_u;
0596df00 477 time_t modtime;
88a7fb3e
WD
478 uid_t uid;
479 gid_t gid;
0596df00 480 mode_t mode;
5009de7d 481 uchar flags; /* this item MUST remain last */
c627d613
AT
482};
483
a85906c7
S
484/*
485 * Start the flist array at FLIST_START entries and grow it
486 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
487 */
488#define FLIST_START (32 * 1024)
489#define FLIST_LINEAR (FLIST_START * 512)
b96efc2f 490
9935066b
S
491/*
492 * Extent size for allocation pools A minimum size of 128KB
493 * is needed to mmap them so that freeing will release the
494 * space to the OS.
495 *
496 * Larger sizes reduce leftover fragments and speed free calls
497 * (when they happen) Smaller sizes increase the chance of
498 * freed allocations freeing whole extents.
499 */
9935066b
S
500#define FILE_EXTENT (256 * 1024)
501#define HLINK_EXTENT (128 * 1024)
502
503#define WITH_HLINK 1
504#define WITHOUT_HLINK 0
3d382777 505
c627d613 506struct file_list {
2b2ea368 507 struct file_struct **files;
9935066b
S
508 alloc_pool_t file_pool;
509 alloc_pool_t hlink_pool;
2b2ea368
WD
510 int count;
511 int malloced;
c627d613
AT
512};
513
a3221d2a
WD
514#define SUMFLG_SAME_OFFSET (1<<0)
515
c627d613 516struct sum_buf {
6ded1170 517 OFF_T offset; /**< offset in file of this chunk */
a06b419d 518 int32 len; /**< length of chunk of file */
6ded1170 519 uint32 sum1; /**< simple checksum */
a3221d2a 520 short flags; /**< flag bits */
6ded1170 521 char sum2[SUM_LENGTH]; /**< checksum */
c627d613
AT
522};
523
524struct sum_struct {
6ded1170 525 OFF_T flength; /**< total file length */
2b2ea368 526 struct sum_buf *sums; /**< points to info for each chunk */
6ded1170 527 size_t count; /**< how many chunks */
a06b419d
WD
528 int32 blength; /**< block_length */
529 int32 remainder; /**< flength % block_length */
da9d12f5 530 int s2length; /**< sum2_length */
c627d613
AT
531};
532
c6e7fcb4 533struct map_struct {
6a7cc46c
S
534 OFF_T file_size; /* File size (from stat) */
535 OFF_T p_offset; /* Window start */
536 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
2b2ea368
WD
537 char *p; /* Window pointer */
538 int32 p_size; /* Largest window size we allocated */
539 int32 p_len; /* Latest (rounded) window size */
540 int32 def_window_size; /* Default window size */
541 int fd; /* File Descriptor */
542 int status; /* first errno from read errors */
c6e7fcb4 543};
c627d613 544
e2d22fee
WD
545#define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
546#define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
547#define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with '**' */
548#define MATCHFLG_ABS_PATH (1<<3) /* path-match on absolute path */
669a3192
WD
549#define MATCHFLG_INCLUDE (1<<4) /* this is an include, not an exclude */
550#define MATCHFLG_DIRECTORY (1<<5) /* this matches only directories */
551#define MATCHFLG_CLEAR_LIST (1<<6) /* this item is the "!" token */
46fa6025
WD
552#define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
553#define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
554#define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
555#define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
556#define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
557#define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
558#define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
7842418b
WD
559struct filter_struct {
560 struct filter_struct *next;
2b6b4d53 561 char *pattern;
669a3192 562 unsigned int match_flags;
46fa6025
WD
563 union {
564 int slash_cnt;
7842418b 565 struct filter_list_struct *mergelist;
46fa6025 566 } u;
2b6b4d53
AT
567};
568
7842418b
WD
569struct filter_list_struct {
570 struct filter_struct *head;
571 struct filter_struct *tail;
ac1d2d33 572 char *debug_type;
63d03319
WD
573};
574
a800434a
AT
575struct stats {
576 int64 total_size;
577 int64 total_transferred_size;
578 int64 total_written;
579 int64 total_read;
580 int64 literal_data;
581 int64 matched_data;
d4198823
WD
582 int64 flist_buildtime;
583 int64 flist_xfertime;
a800434a
AT
584 int flist_size;
585 int num_files;
586 int num_transferred_files;
dc8293ff 587 int current_file_index;
a800434a
AT
588};
589
2b6b4d53 590
3b3a2fbc
AT
591/* we need this function because of the silly way in which duplicate
592 entries are handled in the file lists - we can't change this
593 without breaking existing versions */
71c46176 594static inline int flist_up(struct file_list *flist, int i)
3b3a2fbc 595{
3ec4dd97 596 while (!flist->files[i]->basename) i++;
3b3a2fbc
AT
597 return i;
598}
599
c627d613 600#include "byteorder.h"
8de330a3 601#include "lib/mdfour.h"
87f18b62 602#include "lib/wildmatch.h"
740819ef 603#include "lib/permstring.h"
e20a4f84 604#include "lib/addrinfo.h"
0de40240 605
58c29609
MP
606#include "proto.h"
607
0de40240 608/* We have replacement versions of these if they're missing. */
e95538ca 609#if !HAVE_ASPRINTF
0de40240
MP
610int asprintf(char **ptr, const char *format, ...);
611#endif
612
e95538ca 613#if !HAVE_VASPRINTF
0de40240
MP
614int vasprintf(char **ptr, const char *format, va_list ap);
615#endif
616
e95538ca 617#if !HAVE_VSNPRINTF || !HAVE_C99_VSNPRINTF
6813fa7e
WD
618#define vsnprintf rsync_vsnprintf
619int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
0de40240
MP
620#endif
621
e95538ca 622#if !HAVE_SNPRINTF || !HAVE_C99_VSNPRINTF
6813fa7e 623#define snprintf rsync_snprintf
0de40240
MP
624int snprintf(char *str,size_t count,const char *fmt,...);
625#endif
626
627
c627d613
AT
628#if !HAVE_STRERROR
629extern char *sys_errlist[];
630#define strerror(i) sys_errlist[i]
631#endif
632
e95538ca 633#if !HAVE_STRCHR
c627d613
AT
634# define strchr index
635# define strrchr rindex
636#endif
637
e95538ca 638#if !HAVE_ERRNO_DECL
c627d613
AT
639extern int errno;
640#endif
641
cbbe4892 642#define SUPPORT_LINKS HAVE_READLINK
dc5ddbcc 643#define SUPPORT_HARD_LINKS HAVE_LINK
c627d613 644
ac1eb754 645#define SIGNAL_CAST (RETSIGTYPE (*)())
720b47f2
AT
646
647#ifndef EWOULDBLOCK
648#define EWOULDBLOCK EAGAIN
649#endif
182dca5c 650
7b8356d0
AT
651#ifndef STDIN_FILENO
652#define STDIN_FILENO 0
653#endif
654
655#ifndef STDOUT_FILENO
656#define STDOUT_FILENO 1
657#endif
658
659#ifndef STDERR_FILENO
660#define STDERR_FILENO 2
661#endif
662
8120a98f
WD
663#ifndef S_IRUSR
664#define S_IRUSR 0400
665#endif
666
7b8356d0
AT
667#ifndef S_IWUSR
668#define S_IWUSR 0200
669#endif
670
b0d791bb
PG
671#ifndef ACCESSPERMS
672#define ACCESSPERMS 0777
673#endif
674
675#ifndef S_ISVTX
676#define S_ISVTX 0
677#endif
678
679#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
680
b280a1f4
AT
681#ifndef _S_IFMT
682#define _S_IFMT 0170000
683#endif
684
685#ifndef _S_IFLNK
686#define _S_IFLNK 0120000
687#endif
688
689#ifndef S_ISLNK
690#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
691#endif
692
1e9f155a
AT
693#ifndef S_ISBLK
694#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
695#endif
696
697#ifndef S_ISCHR
698#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
699#endif
700
a0b65b18
AT
701#ifndef S_ISSOCK
702#ifdef _S_IFSOCK
703#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
704#else
705#define S_ISSOCK(mode) (0)
706#endif
707#endif
708
709#ifndef S_ISFIFO
710#ifdef _S_IFIFO
711#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
712#else
713#define S_ISFIFO(mode) (0)
714#endif
715#endif
716
1e9f155a
AT
717#ifndef S_ISDIR
718#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
719#endif
720
721#ifndef S_ISREG
722#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
723#endif
724
f0359dd0
AT
725/* work out what fcntl flag to use for non-blocking */
726#ifdef O_NONBLOCK
727# define NONBLOCK_FLAG O_NONBLOCK
728#elif defined(SYSV)
729# define NONBLOCK_FLAG O_NDELAY
d622d4bf 730#else
f0359dd0
AT
731# define NONBLOCK_FLAG FNDELAY
732#endif
733
d79c77ca
MP
734#ifndef INADDR_LOOPBACK
735#define INADDR_LOOPBACK 0x7f000001
736#endif
737
738#ifndef INADDR_NONE
739#define INADDR_NONE 0xffffffff
740#endif
a0b65b18
AT
741
742#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
7bec6a5c 743
5afd8aed
DD
744/* Initial mask on permissions given to temporary files. Mask off setuid
745 bits and group access because of potential race-condition security
746 holes, and mask other access because mode 707 is bizarre */
972a3619 747#define INITACCESSPERMS 0700
e08bfe12
AT
748
749/* handler for null strings in printf format */
750#define NS(s) ((s)?(s):"<NULL>")
751
fb859e56 752#if !defined(__GNUC__) || defined(APPLE)
999dfffc
MP
753/* Apparently the OS X port of gcc gags on __attribute__.
754 *
755 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
d622d4bf 756#define __attribute__(x)
fb859e56
MP
757
758#endif
759
58cadc86
WD
760/* Convenient wrappers for malloc and realloc. Use them. */
761#define new(type) ((type *)malloc(sizeof(type)))
762#define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
763#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
fb859e56 764
e08bfe12 765/* use magic gcc attributes to catch format errors */
ff41a59f 766 void rprintf(enum logcode , const char *, ...)
fb859e56 767 __attribute__((format (printf, 2, 3)))
e08bfe12 768;
7b3d4257 769
a039749b
MP
770/* This is just like rprintf, but it also tries to print some
771 * representation of the error code. Normally errcode = errno. */
772void rsyserr(enum logcode, int, const char *, ...)
fb859e56 773 __attribute__((format (printf, 3, 4)))
a039749b
MP
774 ;
775
e95538ca 776#if REPLACE_INET_NTOA
7b3d4257
AT
777#define inet_ntoa rep_inet_ntoa
778#endif
5a788ade 779
afbcc8f2
WD
780/* Make sure that the O_BINARY flag is defined. */
781#ifndef O_BINARY
782#define O_BINARY 0
783#endif
5a788ade 784
e95538ca 785#if !HAVE_STRLCPY
5a788ade
AT
786size_t strlcpy(char *d, const char *s, size_t bufsize);
787#endif
788
e95538ca 789#if !HAVE_STRLCAT
5a788ade
AT
790size_t strlcat(char *d, const char *s, size_t bufsize);
791#endif
792
82980a23
AT
793#ifndef WEXITSTATUS
794#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
795#endif
796
a9766ef1 797#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
eecd22ff 798
e95538ca 799#if HAVE_GETEUID
b2bffbb2
WD
800#define MY_UID() geteuid()
801#else
802#define MY_UID() getuid()
803#endif
804
e95538ca 805#if HAVE_GETEGID
b2bffbb2
WD
806#define MY_GID() getegid()
807#else
808#define MY_GID() getgid()
809#endif
eecd22ff
MP
810
811extern int verbose;
d5d4b282 812
e95538ca 813#if !HAVE_INET_NTOP
d622d4bf 814const char *inet_ntop(int af, const void *src, char *dst, size_t size);
8f694072
MP
815#endif /* !HAVE_INET_NTOP */
816
e95538ca 817#if !HAVE_INET_PTON
bda41fa5 818int inet_pton(int af, const char *src, void *dst);
8f694072 819#endif
0f0ea7f7 820
f4a0483a
MP
821#ifdef MAINTAINER_MODE
822const char *get_panic_action(void);
823#endif
824
fb859e56 825#define UNUSED(x) x __attribute__((__unused__))
eca2adb4 826
c80b3d8c 827extern const char *io_write_phase, *io_read_phase;