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