Handle the FLAG_LENGTH64 flag in unmake_file().
[rsync/rsync.git] / rsync.h
CommitLineData
d622d4bf 1/*
0f78b815
WD
2 * Copyright (C) 1996, 2000 Andrew Tridgell
3 * Copyright (C) 1996 Paul Mackerras
4 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
5 * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
e7c67065
WD
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
0f78b815 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
82ad07c4
WD
60#define FLAG_TOP_DIR (1<<0) /* sender/receiver/generator */
61#define FLAG_SENT (1<<1) /* sender/generator */
62#define FLAG_XFER_DIR (1<<2) /* sender/receiver/generator */
63#define FLAG_MOUNT_DIR (1<<3) /* sender/generator */
96293cf9
WD
64#define FLAG_MISSING_DIR (1<<4) /* generator */
65#define FLAG_HLINKED (1<<5) /* receiver/generator */
82ad07c4
WD
66#define FLAG_HLINK_FIRST (1<<6) /* receiver/generator */
67#define FLAG_HLINK_LAST (1<<7) /* receiver/generator */
96293cf9 68#define FLAG_LENGTH64 (1<<8) /* sender/receiver/generator */
520cf417 69
c627d613 70/* update this if you make incompatible changes */
21068d8e 71#define PROTOCOL_VERSION 30
063393d6
MP
72
73/* We refuse to interoperate with versions that are not in this range.
74 * Note that we assume we'll work with later versions: the onus is on
75 * people writing them to make sure that they don't send us anything
76 * we won't understand.
77 *
1b2db7ae
S
78 * Interoperation with old but supported protocol versions
79 * should cause a warning to be printed. At a future date
80 * the old protocol will become the minimum and
81 * compatibility code removed.
82 *
91c4da3f
S
83 * There are two possible explanations for the limit at
84 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
85 * do not interoperate with us, and (more likely) so that we can
86 * detect an attempt to connect rsync to a non-rsync server, which is
87 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
88 * MAX_PROTOCOL_VERSION. */
89
3e491682
S
90#define MIN_PROTOCOL_VERSION 20
91#define OLD_PROTOCOL_VERSION 25
1b2db7ae 92#define MAX_PROTOCOL_VERSION 40
c627d613 93
9486289c
AT
94#define RSYNC_PORT 873
95
d867229b 96#define SPARSE_WRITE_SIZE (1024)
dc5ddbcc 97#define WRITE_SIZE (32*1024)
34ccb63e 98#define CHUNK_SIZE (32*1024)
61542c41 99#define MAX_MAP_SIZE (256*1024)
e3fe383a 100#define IO_BUFFER_SIZE (4092)
2b2ea368 101#define MAX_BLOCK_SIZE ((int32)1 << 29)
c627d613 102
e2d22fee
WD
103#define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
104#define IOERR_VANISHED (1<<1)
ff3d3c32 105#define IOERR_DEL_LIMIT (1<<2)
e2d22fee 106
874895d5 107#define MAX_ARGS 1000
e4977b0b 108#define MAX_BASIS_DIRS 20
c296031d 109#define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
e4977b0b 110
8d9dc9f9 111#define MPLEX_BASE 7
ff41a59f 112
7842418b
WD
113#define NO_FILTERS 0
114#define SERVER_FILTERS 1
115#define ALL_FILTERS 2
4762db4f 116
753b6b46 117#define XFLG_FATAL_ERRORS (1<<0)
3b2461cf
WD
118#define XFLG_OLD_PREFIXES (1<<1)
119#define XFLG_ANCHORED2ABS (1<<2)
699f7024 120#define XFLG_ABS_IF_SLASH (1<<3)
4762db4f 121
8eda7a4b
WD
122#define ATTRS_REPORT (1<<0)
123#define ATTRS_SKIP_MTIME (1<<1)
5c6fc4a6 124
419896af
WD
125#define FULL_FLUSH 1
126#define NORMAL_FLUSH 0
127
a7260c40
WD
128#define PDIR_CREATE 1
129#define PDIR_DELETE 0
130
e341588a
WD
131/* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
132#define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
133#define FNAMECMP_BASIS_DIR_HIGH 0x7F
41cfde6b
WD
134#define FNAMECMP_FNAME 0x80
135#define FNAMECMP_PARTIAL_DIR 0x81
136#define FNAMECMP_BACKUP 0x82
0dd046d3 137#define FNAMECMP_FUZZY 0x83
41cfde6b 138
0cc279e0 139/* For use by the itemize_changes code */
b3222792 140#define ITEM_REPORT_ATIME (1<<0)
0cc279e0
WD
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)
b3222792
WD
147#define ITEM_REPORT_ACL (1<<7)
148#define ITEM_REPORT_XATTR (1<<8)
3019a9ba
WD
149#define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
150#define ITEM_XNAME_FOLLOWS (1<<12)
6d0e5d2e
WD
151#define ITEM_IS_NEW (1<<13)
152#define ITEM_LOCAL_CHANGE (1<<14)
153#define ITEM_TRANSFER (1<<15)
d4d4890d 154/* These are outside the range of the transmitted flags. */
d4d4890d
WD
155#define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
156#define ITEM_DELETED (1<<17) /* used by log_formatted() */
1e4f5f63 157#define ITEM_MATCHED (1<<18) /* used by itemize() */
0cc279e0 158
3019a9ba
WD
159#define SIGNIFICANT_ITEM_FLAGS (~(\
160 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
669e7671 161
df0054ab 162
56aaa4c4
WD
163/* Log-message categories. Only FERROR and FINFO get sent over the socket,
164 * but FLOG and FSOCKERR can be sent over the receiver -> generator pipe.
85909931 165 * FLOG only goes to the log file, not the client; FCLIENT is the opposite. */
011e85a5 166enum logcode { FNONE=0, FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FSOCKERR=5 };
419896af
WD
167
168/* Messages types that are sent over the message channel. The logcode
169 * values must all be present here with identical numbers. */
170enum msgcode {
1dcf3b43
WD
171 MSG_DATA=0, /* raw data on the multiplexed stream */
172 MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
ea26c854 173 MSG_LOG=FLOG, MSG_SOCKERR=FSOCKERR, /* sibling logging */
1dcf3b43
WD
174 MSG_REDO=9, /* reprocess indicated flist index */
175 MSG_SUCCESS=100,/* successfully updated indicated flist index */
176 MSG_DELETED=101,/* successfully deleted a file on receiving side */
177 MSG_DONE=86 /* current phase is done */
419896af 178};
7bec6a5c 179
82ad07c4
WD
180#define NDX_DONE -1
181
65417579
AT
182#include "errcode.h"
183
c627d613
AT
184#include "config.h"
185
e3217f14 186/* The default RSYNC_RSH is always set in config.h. */
24d95c03 187
c627d613 188#include <stdio.h>
4f5b0756 189#ifdef HAVE_SYS_TYPES_H
e95538ca
WD
190# include <sys/types.h>
191#endif
4f5b0756 192#ifdef HAVE_SYS_STAT_H
e95538ca
WD
193# include <sys/stat.h>
194#endif
4f5b0756 195#ifdef STDC_HEADERS
e95538ca
WD
196# include <stdlib.h>
197# include <stddef.h>
198#else
4f5b0756 199# ifdef HAVE_STDLIB_H
e95538ca
WD
200# include <stdlib.h>
201# endif
202#endif
4f5b0756
WD
203#ifdef HAVE_STRING_H
204# if !defined STDC_HEADERS && defined HAVE_MEMORY_H
e95538ca
WD
205# include <memory.h>
206# endif
207# include <string.h>
208#endif
4f5b0756 209#ifdef HAVE_STRINGS_H
e95538ca
WD
210# include <strings.h>
211#endif
4f5b0756 212#ifdef HAVE_UNISTD_H
e95538ca 213# include <unistd.h>
c627d613
AT
214#endif
215
4f5b0756 216#ifdef HAVE_SYS_PARAM_H
e95538ca 217#include <sys/param.h>
38b02c13 218#endif
59192f56 219
4f5b0756 220#if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
59192f56 221#include <malloc.h>
d7b305fd
AT
222#endif
223
4f5b0756 224#ifdef HAVE_SYS_SOCKET_H
fdd71e17
AT
225#include <sys/socket.h>
226#endif
227
4f5b0756 228#ifdef TIME_WITH_SYS_TIME
c627d613
AT
229#include <sys/time.h>
230#include <time.h>
231#else
4f5b0756 232#ifdef HAVE_SYS_TIME_H
c627d613
AT
233#include <sys/time.h>
234#else
235#include <time.h>
236#endif
237#endif
238
4f5b0756 239#ifdef HAVE_FCNTL_H
c627d613
AT
240#include <fcntl.h>
241#else
4f5b0756 242#ifdef HAVE_SYS_FCNTL_H
c627d613
AT
243#include <sys/fcntl.h>
244#endif
245#endif
246
4f5b0756 247#ifdef HAVE_SYS_IOCTL_H
94481d91
AT
248#include <sys/ioctl.h>
249#endif
250
4f5b0756 251#ifdef HAVE_SYS_FILIO_H
94481d91
AT
252#include <sys/filio.h>
253#endif
254
c627d613 255#include <signal.h>
4f5b0756 256#ifdef HAVE_SYS_WAIT_H
c627d613
AT
257#include <sys/wait.h>
258#endif
4f5b0756 259#ifdef HAVE_CTYPE_H
c627d613
AT
260#include <ctype.h>
261#endif
4f5b0756 262#ifdef HAVE_GRP_H
c627d613
AT
263#include <grp.h>
264#endif
265#include <errno.h>
266
4f5b0756 267#ifdef HAVE_UTIME_H
c627d613
AT
268#include <utime.h>
269#endif
270
4f5b0756 271#ifdef HAVE_SYS_SELECT_H
8bf73749
AT
272#include <sys/select.h>
273#endif
274
4f5b0756 275#ifdef HAVE_SYS_MODE_H
773f2bd4 276/* apparently AIX needs this for S_ISLNK */
05a6556d 277#ifndef S_ISLNK
773f2bd4
AT
278#include <sys/mode.h>
279#endif
05a6556d 280#endif
773f2bd4 281
4f5b0756 282#ifdef HAVE_GLOB_H
874895d5
AT
283#include <glob.h>
284#endif
285
f6c34742
AT
286/* these are needed for the uid/gid mapping code */
287#include <pwd.h>
288#include <grp.h>
289
9486289c 290#include <stdarg.h>
f0fca04e
AT
291#include <netinet/in.h>
292#include <arpa/inet.h>
293#include <netdb.h>
ff8b29b8 294#include <syslog.h>
6c8f5373 295#include <sys/file.h>
9486289c 296
4f5b0756 297#ifdef HAVE_DIRENT_H
e8f5b936
AT
298# include <dirent.h>
299#else
300# define dirent direct
4f5b0756 301# ifdef HAVE_SYS_NDIR_H
e8f5b936
AT
302# include <sys/ndir.h>
303# endif
4f5b0756 304# ifdef HAVE_SYS_DIR_H
e8f5b936
AT
305# include <sys/dir.h>
306# endif
4f5b0756 307# ifdef HAVE_NDIR_H
e8f5b936
AT
308# include <ndir.h>
309# endif
310#endif
311
4f5b0756 312#ifdef MAJOR_IN_MKDEV
c39d6514 313#include <sys/mkdev.h>
8a33c406 314# if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
73496a36
WD
315# define makedev mkdev
316# endif
4f5b0756 317#elif defined MAJOR_IN_SYSMACROS
f8ed564c 318#include <sys/sysmacros.h>
c39d6514
WD
319#endif
320
5a3810b4
WD
321#ifdef MAKEDEV_TAKES_3_ARGS
322#define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
323#else
324#define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
325#endif
326
4f5b0756 327#ifdef HAVE_COMPAT_H
e8f5b936
AT
328#include <compat.h>
329#endif
330
ea8291d8
WD
331#ifdef HAVE_LIMITS_H
332# include <limits.h>
333#endif
334
1bfbf40b
MP
335#include <assert.h>
336
9935066b 337#include "lib/pool_alloc.h"
e8f5b936 338
f0fca04e
AT
339#define BOOL int
340
c627d613
AT
341#ifndef uchar
342#define uchar unsigned char
343#endif
344
4f5b0756 345#ifdef SIGNED_CHAR_OK
debb4505
AT
346#define schar signed char
347#else
348#define schar char
349#endif
350
43d0f38b
WD
351/* Find a variable that is either exactly 32-bits or longer.
352 * If some code depends on 32-bit truncation, it will need to
353 * take special action in a "#if SIZEOF_INT32 > 4" section. */
c627d613 354#ifndef int32
43d0f38b
WD
355#if SIZEOF_INT == 4
356# define int32 int
357# define SIZEOF_INT32 4
358#elif SIZEOF_LONG == 4
359# define int32 long
360# define SIZEOF_INT32 4
361#elif SIZEOF_SHORT == 4
362# define int32 short
363# define SIZEOF_INT32 4
364#elif SIZEOF_INT > 4
365# define int32 int
366# define SIZEOF_INT32 SIZEOF_INT
367#elif SIZEOF_LONG > 4
368# define int32 long
369# define SIZEOF_INT32 SIZEOF_LONG
8de330a3 370#else
43d0f38b 371# error Could not find a 32-bit integer variable
c627d613 372#endif
43d0f38b
WD
373#else
374# define SIZEOF_INT32 4
c627d613
AT
375#endif
376
377#ifndef uint32
378#define uint32 unsigned int32
379#endif
380
0dd046d3 381#if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
bcacc18b
AT
382#define OFF_T off_t
383#define STRUCT_STAT struct stat
5b5f7e3b
WD
384#else
385#define OFF_T off64_t
386#define STRUCT_STAT struct stat64
387#define USE_STAT64_FUNCS 1
bcacc18b
AT
388#endif
389
d4198823
WD
390/* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
391 * that's the maximum size the file system can handle and there is no
392 * 64-bit type available. The rsync source must therefore take steps
393 * to ensure that any code that really requires a 64-bit integer has
394 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
395 * counter). */
2c177562 396#if SIZEOF_LONG == 8
d622d4bf
WD
397# define int64 long
398# define SIZEOF_INT64 8
399#elif SIZEOF_INT == 8
400# define int64 int
401# define SIZEOF_INT64 8
402#elif SIZEOF_LONG_LONG == 8
403# define int64 long long
404# define SIZEOF_INT64 8
2c177562
WD
405#elif SIZEOF_OFF64_T == 8
406# define int64 off64_t
407# define SIZEOF_INT64 8
d622d4bf
WD
408#elif SIZEOF_OFF_T == 8
409# define int64 off_t
410# define SIZEOF_INT64 8
411#elif SIZEOF_INT > 8
412# define int64 int
413# define SIZEOF_INT64 SIZEOF_INT
414#elif SIZEOF_LONG > 8
415# define int64 long
416# define SIZEOF_INT64 SIZEOF_LONG
417#elif SIZEOF_LONG_LONG > 8
418# define int64 long long
419# define SIZEOF_INT64 SIZEOF_LONG_LONG
71c46176 420#else
736a6a29 421/* As long as it gets... */
d622d4bf
WD
422# define int64 off_t
423# define SIZEOF_INT64 SIZEOF_OFF_T
71c46176 424#endif
c627d613 425
6abd193f
MP
426/* Starting from protocol version 26, we always use 64-bit
427 * ino_t and dev_t internally, even if this platform does not
428 * allow files to have 64-bit inums. That's because the
429 * receiver needs to find duplicate (dev,ino) tuples to detect
430 * hardlinks, and it might have files coming from a platform
431 * that has 64-bit inums.
432 *
433 * The only exception is if we're on a platform with no 64-bit type at
434 * all.
435 *
436 * Because we use read_longint() to get these off the wire, if you
437 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
438 * with no 64-bit types then you will get an overflow error. Probably
439 * not many people have that combination of machines, and you can
440 * avoid it by not preserving hardlinks or not transferring device
441 * nodes. It's not clear that any other behaviour is better.
442 *
443 * Note that if you transfer devices from a 64-bit-devt machine (say,
444 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
445 * device numbers will be truncated. But it's a kind of silly thing
446 * to do anyhow.
b9df3bf2 447 *
33a2361c
WD
448 * FIXME: I don't think the code in flist.c has ever worked on a system
449 * where dev_t is a struct.
d622d4bf 450 */
33a2361c
WD
451
452struct idev {
82ad07c4 453 int64 ino;
d06f6328 454 int64 dev;
33a2361c 455};
c29ee43d 456
c627d613
AT
457#ifndef MIN
458#define MIN(a,b) ((a)<(b)?(a):(b))
459#endif
460
461#ifndef MAX
462#define MAX(a,b) ((a)>(b)?(a):(b))
463#endif
464
d41c7d02
DD
465#ifndef MAXHOSTNAMELEN
466#define MAXHOSTNAMELEN 256
467#endif
468
c627d613 469/* the length of the md4 checksum */
ebb0a6f6 470#define MD4_SUM_LENGTH 16
c627d613 471#define SUM_LENGTH 16
195bd906
S
472#define SHORT_SUM_LENGTH 2
473#define BLOCKSUM_BIAS 10
c627d613
AT
474
475#ifndef MAXPATHLEN
476#define MAXPATHLEN 1024
477#endif
478
a22ca885
WD
479/* We want a roomy line buffer that can hold more than MAXPATHLEN,
480 * and significantly more than an overly short MAXPATHLEN. */
481#if MAXPATHLEN < 4096
482#define BIGPATHBUFLEN (4096+1024)
483#else
484#define BIGPATHBUFLEN (MAXPATHLEN+1024)
485#endif
486
52d3e106
S
487#ifndef NAME_MAX
488#define NAME_MAX 255
489#endif
490
0473e2a1
AT
491#ifndef INADDR_NONE
492#define INADDR_NONE 0xffffffff
493#endif
494
bda41fa5
WD
495#ifndef IN_LOOPBACKNET
496#define IN_LOOPBACKNET 127
497#endif
498
25bd9945 499#define GID_NONE ((gid_t)-1)
a60e2dca 500
520cf417
WD
501#define HL_CHECK_MASTER 0
502#define HL_SKIP 1
503
82ad07c4 504struct hlist {
44885a39
WD
505 int32 next;
506 int32 hlindex;
82ad07c4 507 unsigned short dest_used;
88a7fb3e
WD
508};
509
c627d613 510struct file_struct {
96293cf9
WD
511 union flist_extras {
512 uid_t uid; /* The user ID number */
513 uid_t gid; /* The group ID number or GID_NONE */
514 struct idev *idev; /* The hard-link info during matching */
515 struct hlist *hlist; /* The hard-link info after matching */
516 uint32 unum; /* An unsigned number */
517 } extras[1];
518 time_t modtime; /* When the item was last modified */
519 const char *dirname; /* The dir info inside the transfer */
f8057304 520 union {
96293cf9
WD
521 const char *root; /* Sender-side dir info outside transfer */
522 int32 depth; /* Receiver-side directory depth info */
f8057304 523 } dir;
96293cf9
WD
524 uint32 len32; /* Lowest 32 bits of the file's length */
525 unsigned short mode; /* The item's type and permissions */
526 unsigned short flags; /* This item MUST remain last! */
c627d613
AT
527};
528
96293cf9
WD
529extern int flist_extra_cnt;
530extern int preserve_uid;
531extern int preserve_gid;
b96efc2f 532
96293cf9
WD
533#define FILE_STRUCT_LEN (offsetof(struct file_struct, flags) \
534 + sizeof (unsigned short))
535#define EXTRA_LEN (sizeof (union flist_extras))
536#define SUM_EXTRA_CNT ((MD4_SUM_LENGTH + EXTRA_LEN - 1) / EXTRA_LEN)
537
538#define REQ_EXTRA(f,ndx) ((f)->extras - (ndx - 1))
539#define OPT_EXTRA(f,bump) ((f)->extras - flist_extra_cnt - (bump))
540#define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
541#define HLINK_BUMP(f) (F_IS_HLINKED(f) ? 1 : 0)
542
543/* Basename (AKA filename) and length applies to all items */
544#define F_BASENAME(f) ((const char*)(f) + FILE_STRUCT_LEN)
545#define F_LENGTH(f) ((OFF_T)(f)->len32 + ((f)->flags & FLAG_LENGTH64 \
546 ? (OFF_T)OPT_EXTRA(f, 0)->unum << 32 : 0u))
82ad07c4 547
96293cf9
WD
548/* If there is a symlink string, it is always right after the basename */
549#define F_SYMLINK(f) (F_BASENAME(f) + strlen(F_BASENAME(f)) + 1)
82ad07c4 550
96293cf9
WD
551/* When the associated option is on, all entries will have these present: */
552#define F_UID(f) REQ_EXTRA(f, preserve_uid)->uid
553#define F_GID(f) REQ_EXTRA(f, preserve_gid)->gid
82ad07c4
WD
554
555/* These are per-entry optional and mutally exclusive: */
96293cf9
WD
556#define F_IDEV(f) OPT_EXTRA(f, LEN64_BUMP(f))->idev
557#define F_HLIST(f) OPT_EXTRA(f, LEN64_BUMP(f))->hlist
82ad07c4 558
96293cf9
WD
559/* These are per-entry optional, but always both or neither:
560 * (Note: a device doesn't need to use LEN64_BUMP(f).) */
561#define F_DMAJOR(f) OPT_EXTRA(f, HLINK_BUMP(f))->unum
562#define F_DMINOR(f) OPT_EXTRA(f, HLINK_BUMP(f) + 1)->unum
82ad07c4 563
96293cf9
WD
564/* The sum is only present on regular files. */
565#define F_SUM(f) ((const char*)OPT_EXTRA(f, LEN64_BUMP(f) + SUM_EXTRA_CNT - 1))
566
567/* A couple bool-type utility functions: */
568#define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
569#define F_IS_ACTIVE(f) F_BASENAME(f)[0]
570
571/*
572 * Start the flist array at FLIST_START entries and grow it
573 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
574 */
575#define FLIST_START (32 * 1024)
576#define FLIST_LINEAR (FLIST_START * 512)
82ad07c4 577
9935066b 578/*
82ad07c4 579 * Extent size for allocation pools: A minimum size of 128KB
9935066b
S
580 * is needed to mmap them so that freeing will release the
581 * space to the OS.
582 *
583 * Larger sizes reduce leftover fragments and speed free calls
82ad07c4 584 * (when they happen). Smaller sizes increase the chance of
9935066b
S
585 * freed allocations freeing whole extents.
586 */
9935066b
S
587#define FILE_EXTENT (256 * 1024)
588#define HLINK_EXTENT (128 * 1024)
589
590#define WITH_HLINK 1
591#define WITHOUT_HLINK 0
3d382777 592
c627d613 593struct file_list {
2b2ea368 594 struct file_struct **files;
9935066b
S
595 alloc_pool_t file_pool;
596 alloc_pool_t hlink_pool;
82ad07c4
WD
597 int count, malloced;
598 int low, high; /* 0-relative index values excluding empties */
c627d613
AT
599};
600
a3221d2a
WD
601#define SUMFLG_SAME_OFFSET (1<<0)
602
c627d613 603struct sum_buf {
6ded1170 604 OFF_T offset; /**< offset in file of this chunk */
a06b419d 605 int32 len; /**< length of chunk of file */
6ded1170 606 uint32 sum1; /**< simple checksum */
d733de97 607 int32 chain; /**< next hash-table collision */
a3221d2a 608 short flags; /**< flag bits */
6ded1170 609 char sum2[SUM_LENGTH]; /**< checksum */
c627d613
AT
610};
611
612struct sum_struct {
6ded1170 613 OFF_T flength; /**< total file length */
2b2ea368 614 struct sum_buf *sums; /**< points to info for each chunk */
15859584 615 int32 count; /**< how many chunks */
a06b419d
WD
616 int32 blength; /**< block_length */
617 int32 remainder; /**< flength % block_length */
da9d12f5 618 int s2length; /**< sum2_length */
c627d613
AT
619};
620
c6e7fcb4 621struct map_struct {
6a7cc46c
S
622 OFF_T file_size; /* File size (from stat) */
623 OFF_T p_offset; /* Window start */
624 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
2b2ea368
WD
625 char *p; /* Window pointer */
626 int32 p_size; /* Largest window size we allocated */
627 int32 p_len; /* Latest (rounded) window size */
628 int32 def_window_size; /* Default window size */
629 int fd; /* File Descriptor */
630 int status; /* first errno from read errors */
c6e7fcb4 631};
c627d613 632
e2d22fee
WD
633#define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
634#define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
685517ab
WD
635#define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
636#define MATCHFLG_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
637#define MATCHFLG_ABS_PATH (1<<4) /* path-match on absolute path */
638#define MATCHFLG_INCLUDE (1<<5) /* this is an include, not an exclude */
639#define MATCHFLG_DIRECTORY (1<<6) /* this matches only directories */
46fa6025
WD
640#define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
641#define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
642#define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
643#define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
644#define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
645#define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
646#define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
53b417e4
WD
647#define MATCHFLG_NEGATE (1<<14)/* rule matches when pattern does not */
648#define MATCHFLG_CVS_IGNORE (1<<15)/* rule was -C or :C */
a427e893
WD
649#define MATCHFLG_SENDER_SIDE (1<<16)/* rule applies to the sending side */
650#define MATCHFLG_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
685517ab 651#define MATCHFLG_CLEAR_LIST (1<<18)/* this item is the "!" token */
c0f1e57b 652#define MATCHFLG_PERISHABLE (1<<19)/* perishable if parent dir goes away */
7c8e23bd 653
3b2461cf 654#define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
a427e893 655 | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
c0f1e57b
WD
656 | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE \
657 | MATCHFLG_PERISHABLE)
3b2461cf 658
7842418b
WD
659struct filter_struct {
660 struct filter_struct *next;
2b6b4d53 661 char *pattern;
53b417e4 662 uint32 match_flags;
46fa6025
WD
663 union {
664 int slash_cnt;
7842418b 665 struct filter_list_struct *mergelist;
46fa6025 666 } u;
2b6b4d53
AT
667};
668
7842418b
WD
669struct filter_list_struct {
670 struct filter_struct *head;
671 struct filter_struct *tail;
ac1d2d33 672 char *debug_type;
63d03319
WD
673};
674
a800434a
AT
675struct stats {
676 int64 total_size;
677 int64 total_transferred_size;
678 int64 total_written;
679 int64 total_read;
680 int64 literal_data;
681 int64 matched_data;
d4198823
WD
682 int64 flist_buildtime;
683 int64 flist_xfertime;
604dbf6d 684 int64 flist_size;
a800434a
AT
685 int num_files;
686 int num_transferred_files;
dc8293ff 687 int current_file_index;
a800434a
AT
688};
689
f7bce90c 690struct chmod_mode_struct;
2b6b4d53 691
c627d613 692#include "byteorder.h"
8de330a3 693#include "lib/mdfour.h"
87f18b62 694#include "lib/wildmatch.h"
740819ef 695#include "lib/permstring.h"
e20a4f84 696#include "lib/addrinfo.h"
0de40240 697
2b916250 698#ifndef __GNUC__
4ea58045 699#define __attribute__(x)
7de7b49f
WD
700# if __GNUC__ <= 2
701# define NORETURN
702# endif
4ea58045
WD
703#endif
704
90b13cf6 705#define UNUSED(x) x __attribute__((__unused__))
7de7b49f 706#ifndef NORETURN
011e85a5 707#define NORETURN __attribute__((__noreturn__))
7de7b49f 708#endif
90b13cf6 709
58c29609
MP
710#include "proto.h"
711
0de40240 712/* We have replacement versions of these if they're missing. */
4f5b0756 713#ifndef HAVE_ASPRINTF
0de40240
MP
714int asprintf(char **ptr, const char *format, ...);
715#endif
716
4f5b0756 717#ifndef HAVE_VASPRINTF
0de40240
MP
718int vasprintf(char **ptr, const char *format, va_list ap);
719#endif
720
4f5b0756 721#if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e
WD
722#define vsnprintf rsync_vsnprintf
723int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
0de40240
MP
724#endif
725
4f5b0756 726#if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e 727#define snprintf rsync_snprintf
82ad07c4 728int snprintf(char *str, size_t count, const char *fmt,...);
0de40240
MP
729#endif
730
731
4f5b0756 732#ifndef HAVE_STRERROR
c627d613
AT
733extern char *sys_errlist[];
734#define strerror(i) sys_errlist[i]
735#endif
736
4f5b0756 737#ifndef HAVE_STRCHR
c627d613
AT
738# define strchr index
739# define strrchr rindex
740#endif
741
4f5b0756 742#ifndef HAVE_ERRNO_DECL
c627d613
AT
743extern int errno;
744#endif
745
9a929c8f
WD
746#ifdef HAVE_READLINK
747#define SUPPORT_LINKS 1
748#endif
749#ifdef HAVE_LINK
750#define SUPPORT_HARD_LINKS 1
751#endif
c627d613 752
5173f99e 753#ifdef HAVE_SIGACTION
90b13cf6
WD
754#define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
755#define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
756#else
757#define SIGACTION(n,h) signal(n,h)
758#endif
720b47f2
AT
759
760#ifndef EWOULDBLOCK
761#define EWOULDBLOCK EAGAIN
762#endif
182dca5c 763
7b8356d0
AT
764#ifndef STDIN_FILENO
765#define STDIN_FILENO 0
766#endif
767
768#ifndef STDOUT_FILENO
769#define STDOUT_FILENO 1
770#endif
771
772#ifndef STDERR_FILENO
773#define STDERR_FILENO 2
774#endif
775
8120a98f
WD
776#ifndef S_IRUSR
777#define S_IRUSR 0400
778#endif
779
7b8356d0
AT
780#ifndef S_IWUSR
781#define S_IWUSR 0200
782#endif
783
b0d791bb
PG
784#ifndef ACCESSPERMS
785#define ACCESSPERMS 0777
786#endif
787
788#ifndef S_ISVTX
789#define S_ISVTX 0
790#endif
791
792#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
793
b280a1f4
AT
794#ifndef _S_IFMT
795#define _S_IFMT 0170000
796#endif
797
798#ifndef _S_IFLNK
799#define _S_IFLNK 0120000
800#endif
801
802#ifndef S_ISLNK
803#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
804#endif
805
1e9f155a
AT
806#ifndef S_ISBLK
807#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
808#endif
809
810#ifndef S_ISCHR
811#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
812#endif
813
a0b65b18
AT
814#ifndef S_ISSOCK
815#ifdef _S_IFSOCK
816#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
817#else
818#define S_ISSOCK(mode) (0)
819#endif
820#endif
821
822#ifndef S_ISFIFO
823#ifdef _S_IFIFO
824#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
825#else
826#define S_ISFIFO(mode) (0)
827#endif
828#endif
829
1e9f155a
AT
830#ifndef S_ISDIR
831#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
832#endif
833
834#ifndef S_ISREG
835#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
836#endif
837
f0359dd0
AT
838/* work out what fcntl flag to use for non-blocking */
839#ifdef O_NONBLOCK
840# define NONBLOCK_FLAG O_NONBLOCK
4f5b0756 841#elif defined SYSV
f0359dd0 842# define NONBLOCK_FLAG O_NDELAY
d622d4bf 843#else
f0359dd0
AT
844# define NONBLOCK_FLAG FNDELAY
845#endif
846
d79c77ca
MP
847#ifndef INADDR_LOOPBACK
848#define INADDR_LOOPBACK 0x7f000001
849#endif
850
851#ifndef INADDR_NONE
852#define INADDR_NONE 0xffffffff
853#endif
a0b65b18 854
b5c6a6ae
WD
855#define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
856#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
7bec6a5c 857
5afd8aed
DD
858/* Initial mask on permissions given to temporary files. Mask off setuid
859 bits and group access because of potential race-condition security
860 holes, and mask other access because mode 707 is bizarre */
972a3619 861#define INITACCESSPERMS 0700
e08bfe12
AT
862
863/* handler for null strings in printf format */
0ee6ca98 864#define NS(s) ((s)?(s):"<NULL>")
e08bfe12 865
58cadc86
WD
866/* Convenient wrappers for malloc and realloc. Use them. */
867#define new(type) ((type *)malloc(sizeof(type)))
868#define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
869#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
fb859e56 870
e08bfe12 871/* use magic gcc attributes to catch format errors */
ff41a59f 872 void rprintf(enum logcode , const char *, ...)
fb859e56 873 __attribute__((format (printf, 2, 3)))
e08bfe12 874;
7b3d4257 875
a039749b
MP
876/* This is just like rprintf, but it also tries to print some
877 * representation of the error code. Normally errcode = errno. */
878void rsyserr(enum logcode, int, const char *, ...)
fb859e56 879 __attribute__((format (printf, 3, 4)))
a039749b
MP
880 ;
881
afbcc8f2
WD
882/* Make sure that the O_BINARY flag is defined. */
883#ifndef O_BINARY
884#define O_BINARY 0
885#endif
5a788ade 886
4f5b0756 887#ifndef HAVE_STRLCPY
5a788ade
AT
888size_t strlcpy(char *d, const char *s, size_t bufsize);
889#endif
890
4f5b0756 891#ifndef HAVE_STRLCAT
5a788ade
AT
892size_t strlcat(char *d, const char *s, size_t bufsize);
893#endif
894
82980a23
AT
895#ifndef WEXITSTATUS
896#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
897#endif
47b032e9
WD
898#ifndef WIFEXITED
899#define WIFEXITED(stat) ((int)((stat)&0xFF) == 0)
900#endif
82980a23 901
a9766ef1 902#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
eecd22ff 903
4f5b0756 904#ifdef HAVE_GETEUID
b2bffbb2
WD
905#define MY_UID() geteuid()
906#else
907#define MY_UID() getuid()
908#endif
909
4f5b0756 910#ifdef HAVE_GETEGID
b2bffbb2
WD
911#define MY_GID() getegid()
912#else
913#define MY_GID() getgid()
914#endif
eecd22ff
MP
915
916extern int verbose;
d5d4b282 917
4f5b0756 918#ifndef HAVE_INET_NTOP
d622d4bf 919const char *inet_ntop(int af, const void *src, char *dst, size_t size);
4f5b0756 920#endif
8f694072 921
4f5b0756 922#ifndef HAVE_INET_PTON
bda41fa5 923int inet_pton(int af, const char *src, void *dst);
8f694072 924#endif
0f0ea7f7 925
f4a0483a
MP
926#ifdef MAINTAINER_MODE
927const char *get_panic_action(void);
928#endif
2dc7b8bd
WD
929
930static inline int
931isDigit(const char *ptr)
932{
933 return isdigit(*(unsigned char *)ptr);
934}
935
936static inline int
937isPrint(const char *ptr)
938{
939 return isprint(*(unsigned char *)ptr);
940}
941
942static inline int
943isSpace(const char *ptr)
944{
945 return isspace(*(unsigned char *)ptr);
946}
947
948static inline int
949isLower(const char *ptr)
950{
951 return islower(*(unsigned char *)ptr);
952}
953
954static inline int
955isUpper(const char *ptr)
956{
957 return isupper(*(unsigned char *)ptr);
958}
959
960static inline int
961toLower(const char *ptr)
962{
963 return tolower(*(unsigned char *)ptr);
964}
965
966static inline int
967toUpper(const char *ptr)
968{
969 return toupper(*(unsigned char *)ptr);
970}