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