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