Factor out common logic of unchanged_attrs and itemize into report_ATTR
[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>
d3d07a5e 5 * Copyright (C) 2003-2008 Wayne Davison
0f78b815
WD
6 *
7 * This program is free software; you can redistribute it and/or modify
8e41b68e
WD
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
0f78b815
WD
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 17 * You should have received a copy of the GNU General Public License along
4fd842f9 18 * with this program; if not, visit the http://fsf.org website.
0f78b815 19 */
0de40240 20
d41c7d02
DD
21#define False 0
22#define True 1
23
c627d613
AT
24#define BLOCK_SIZE 700
25#define RSYNC_RSH_ENV "RSYNC_RSH"
8dd99390 26#define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
7b8356d0 27
c627d613 28#define RSYNC_NAME "rsync"
cd3fe9fb 29/* RSYNCD_SYSCONF is now set in config.h */
30e8c8e1 30#define RSYNCD_USERCONF "rsyncd.conf"
f0fca04e 31
5e71c444 32#define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
f7632fc6
AT
33#define URL_PREFIX "rsync://"
34
41adbcec 35#define SYMLINK_PREFIX "/rsyncd-munged/" /* This MUST have a trailing slash! */
9585b276
WD
36#define SYMLINK_PREFIX_LEN ((int)sizeof SYMLINK_PREFIX - 1)
37
c627d613
AT
38#define BACKUP_SUFFIX "~"
39
1b01b295 40/* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
6543dc0c 41 incompatible with older versions :-( */
1b01b295
AT
42#define CHAR_OFFSET 0
43
a5f9cff2
WD
44/* These flags are only used during the flist transfer. */
45
ec33e0e6 46#define XMIT_TOP_DIR (1<<0)
a5f9cff2 47#define XMIT_SAME_MODE (1<<1)
18438f0b 48#define XMIT_SAME_RDEV_pre28 (1<<2) /* protocols 20 - 27 */
cf2d2665 49#define XMIT_EXTENDED_FLAGS (1<<2) /* protocols 28 - now */
a5f9cff2
WD
50#define XMIT_SAME_UID (1<<3)
51#define XMIT_SAME_GID (1<<4)
52#define XMIT_SAME_NAME (1<<5)
53#define XMIT_LONG_NAME (1<<6)
54#define XMIT_SAME_TIME (1<<7)
cf2d2665 55#define XMIT_SAME_RDEV_MAJOR (1<<8) /* protocols 28 - now (devices only) */
ae11e4ee 56#define XMIT_NO_CONTENT_DIR (1<<8) /* protocols 30 - now (dirs only) */
cf2d2665 57#define XMIT_HLINKED (1<<9) /* protocols 28 - now */
18438f0b 58#define XMIT_SAME_DEV_pre30 (1<<10) /* protocols 28 - 29 */
cf2d2665 59#define XMIT_USER_NAME_FOLLOWS (1<<10) /* protocols 30 - now */
18438f0b 60#define XMIT_RDEV_MINOR_8_pre30 (1<<11) /* protocols 28 - 29 */
cf2d2665
WD
61#define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - now */
62#define XMIT_HLINK_FIRST (1<<12) /* protocols 30 - now (HLINKED files only) */
e1fe1d55 63#define XMIT_IO_ERROR_ENDLIST (1<<12) /* protocols 31*- now (w/XMIT_EXTENDED_FLAGS) (also protocol 30 w/'f' compat flag) */
1a2e41af 64#define XMIT_MOD_NSEC (1<<13) /* protocols 31 - now */
a5f9cff2
WD
65
66/* These flags are used in the live flist data. */
67
82ad07c4 68#define FLAG_TOP_DIR (1<<0) /* sender/receiver/generator */
57edc480 69#define FLAG_OWNED_BY_US (1<<0) /* generator: set by make_file() for aux flists only */
9ec3828b 70#define FLAG_FILE_SENT (1<<1) /* sender/receiver/generator */
48a481c4 71#define FLAG_DIR_CREATED (1<<1) /* generator */
ae11e4ee 72#define FLAG_CONTENT_DIR (1<<2) /* sender/receiver/generator */
c9b62cf3
WD
73#define FLAG_MOUNT_DIR (1<<3) /* sender/generator (dirs only) */
74#define FLAG_SKIP_HLINK (1<<3) /* receiver/generator (w/FLAG_HLINKED) */
505c0579 75#define FLAG_DUPLICATE (1<<4) /* sender */
96293cf9 76#define FLAG_MISSING_DIR (1<<4) /* generator */
ae11e4ee
WD
77#define FLAG_HLINKED (1<<5) /* receiver/generator (checked on all types) */
78#define FLAG_HLINK_FIRST (1<<6) /* receiver/generator (w/FLAG_HLINKED) */
79#define FLAG_IMPLIED_DIR (1<<6) /* sender/receiver/generator (dirs only) */
82ad07c4 80#define FLAG_HLINK_LAST (1<<7) /* receiver/generator */
ae11e4ee 81#define FLAG_HLINK_DONE (1<<8) /* receiver/generator (checked on all types) */
bfd31372 82#define FLAG_LENGTH64 (1<<9) /* sender/receiver/generator */
ff2001b9 83#define FLAG_SKIP_GROUP (1<<10) /* receiver/generator */
1ed56a05 84#define FLAG_TIME_FAILED (1<<11)/* generator */
1a2e41af 85#define FLAG_MOD_NSEC (1<<12) /* sender/receiver/generator */
bfd31372 86
9ec3828b
WD
87/* These flags are passed to functions but not stored. */
88
69be312b 89#define FLAG_DIVERT_DIRS (1<<16) /* sender, but must be unique */
9ec3828b 90
69be312b
WD
91/* These flags are for get_dirlist(). */
92#define GDL_IGNORE_FILTER_RULES (1<<0)
93
94/* Some helper macros for matching bits. */
bfd31372
WD
95#define BITS_SET(val,bits) (((val) & (bits)) == (bits))
96#define BITS_SETnUNSET(val,onbits,offbits) (((val) & ((onbits)|(offbits))) == (onbits))
0a62f5f3
WD
97#define BITS_EQUAL(b1,b2,mask) (((unsigned)(b1) & (unsigned)(mask)) \
98 == ((unsigned)(b2) & (unsigned)(mask)))
520cf417 99
c627d613 100/* update this if you make incompatible changes */
8b3e6052 101#define PROTOCOL_VERSION 31
063393d6 102
4471d9e5
WD
103/* This is used when working on a new protocol version in CVS, and should
104 * be a new non-zero value for each CVS change that affects the protocol.
8b3e6052 105 * It must ALWAYS be 0 when the protocol goes final (and NEVER before)! */
78286a03 106#define SUBPROTOCOL_VERSION 13
4471d9e5 107
063393d6
MP
108/* We refuse to interoperate with versions that are not in this range.
109 * Note that we assume we'll work with later versions: the onus is on
110 * people writing them to make sure that they don't send us anything
111 * we won't understand.
112 *
1b2db7ae
S
113 * Interoperation with old but supported protocol versions
114 * should cause a warning to be printed. At a future date
115 * the old protocol will become the minimum and
116 * compatibility code removed.
117 *
91c4da3f
S
118 * There are two possible explanations for the limit at
119 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
120 * do not interoperate with us, and (more likely) so that we can
121 * detect an attempt to connect rsync to a non-rsync server, which is
122 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
123 * MAX_PROTOCOL_VERSION. */
124
3e491682
S
125#define MIN_PROTOCOL_VERSION 20
126#define OLD_PROTOCOL_VERSION 25
1b2db7ae 127#define MAX_PROTOCOL_VERSION 40
c627d613 128
ce827c3e
WD
129#define MIN_FILECNT_LOOKAHEAD 1000
130#define MAX_FILECNT_LOOKAHEAD 10000
3831f063 131
9486289c
AT
132#define RSYNC_PORT 873
133
d867229b 134#define SPARSE_WRITE_SIZE (1024)
dc5ddbcc 135#define WRITE_SIZE (32*1024)
34ccb63e 136#define CHUNK_SIZE (32*1024)
61542c41 137#define MAX_MAP_SIZE (256*1024)
20caffd2 138#define IO_BUFFER_SIZE (32*1024)
4c17cdcb 139#define MAX_BLOCK_SIZE ((int32)1 << 17)
c627d613 140
8bd77e70
WD
141/* For compatibility with older rsyncs */
142#define OLD_MAX_BLOCK_SIZE ((int32)1 << 29)
143
907e6a32
WD
144#define ROUND_UP_1024(siz) ((siz) & (1024-1) ? ((siz) | (1024-1)) + 1 : (siz))
145
e2d22fee
WD
146#define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
147#define IOERR_VANISHED (1<<1)
ff3d3c32 148#define IOERR_DEL_LIMIT (1<<2)
e2d22fee 149
874895d5 150#define MAX_ARGS 1000
e4977b0b 151#define MAX_BASIS_DIRS 20
c296031d 152#define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
e4977b0b 153
8d9dc9f9 154#define MPLEX_BASE 7
ff41a59f 155
7842418b
WD
156#define NO_FILTERS 0
157#define SERVER_FILTERS 1
158#define ALL_FILTERS 2
4762db4f 159
753b6b46 160#define XFLG_FATAL_ERRORS (1<<0)
3b2461cf 161#define XFLG_OLD_PREFIXES (1<<1)
f5aeb6ff
WD
162#define XFLG_ANCHORED2ABS (1<<2) /* leading slash indicates absolute */
163#define XFLG_ABS_IF_SLASH (1<<3) /* leading or interior slash is absolute */
164#define XFLG_DIR2WILD3 (1<<4) /* dir/ match gets trailing *** added */
4762db4f 165
8eda7a4b
WD
166#define ATTRS_REPORT (1<<0)
167#define ATTRS_SKIP_MTIME (1<<1)
5c6fc4a6 168
419896af
WD
169#define FULL_FLUSH 1
170#define NORMAL_FLUSH 0
171
a7260c40
WD
172#define PDIR_CREATE 1
173#define PDIR_DELETE 0
174
e341588a
WD
175/* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
176#define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
177#define FNAMECMP_BASIS_DIR_HIGH 0x7F
41cfde6b
WD
178#define FNAMECMP_FNAME 0x80
179#define FNAMECMP_PARTIAL_DIR 0x81
180#define FNAMECMP_BACKUP 0x82
0dd046d3 181#define FNAMECMP_FUZZY 0x83
41cfde6b 182
0cc279e0 183/* For use by the itemize_changes code */
b3222792 184#define ITEM_REPORT_ATIME (1<<0)
1ed9018e
WD
185#define ITEM_REPORT_CHANGE (1<<1)
186#define ITEM_REPORT_SIZE (1<<2) /* regular files only */
187#define ITEM_REPORT_TIMEFAIL (1<<2) /* symlinks only */
0cc279e0
WD
188#define ITEM_REPORT_TIME (1<<3)
189#define ITEM_REPORT_PERMS (1<<4)
190#define ITEM_REPORT_OWNER (1<<5)
191#define ITEM_REPORT_GROUP (1<<6)
b3222792
WD
192#define ITEM_REPORT_ACL (1<<7)
193#define ITEM_REPORT_XATTR (1<<8)
3019a9ba
WD
194#define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
195#define ITEM_XNAME_FOLLOWS (1<<12)
6d0e5d2e
WD
196#define ITEM_IS_NEW (1<<13)
197#define ITEM_LOCAL_CHANGE (1<<14)
198#define ITEM_TRANSFER (1<<15)
d4d4890d 199/* These are outside the range of the transmitted flags. */
d4d4890d
WD
200#define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
201#define ITEM_DELETED (1<<17) /* used by log_formatted() */
1e4f5f63 202#define ITEM_MATCHED (1<<18) /* used by itemize() */
0cc279e0 203
3019a9ba
WD
204#define SIGNIFICANT_ITEM_FLAGS (~(\
205 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
669e7671 206
d48810ba 207#define CFN_KEEP_DOT_DIRS (1<<0)
c73f2a38
WD
208#define CFN_KEEP_TRAILING_SLASH (1<<1)
209#define CFN_DROP_TRAILING_DOT_DIR (1<<2)
210#define CFN_COLLAPSE_DOT_DOT_DIRS (1<<3)
df0054ab 211
d48810ba
WD
212#define SP_DEFAULT 0
213#define SP_KEEP_DOT_DIRS (1<<0)
214
29a89172
WD
215#define CD_NORMAL 0
216#define CD_SKIP_CHDIR 1
217
3f0211b6
WD
218/* Log-message categories. FLOG only goes to the log file, not the client;
219 * FCLIENT is the opposite. */
220enum logcode {
221 FNONE=0, /* never sent */
222 FERROR_XFER=1, FINFO=2, /* sent over socket for any protocol */
223 FERROR=3, FWARNING=4, /* sent over socket for protocols >= 30 */
224 FERROR_SOCKET=5, FLOG=6, /* only sent via receiver -> generator pipe */
7c7462cd 225 FERROR_UTF8=8, /* only sent via receiver -> generator pipe */
3f0211b6
WD
226 FCLIENT=7 /* never transmitted (e.g. server converts to FINFO) */
227};
419896af
WD
228
229/* Messages types that are sent over the message channel. The logcode
230 * values must all be present here with identical numbers. */
231enum msgcode {
1dcf3b43 232 MSG_DATA=0, /* raw data on the multiplexed stream */
3f0211b6
WD
233 MSG_ERROR_XFER=FERROR_XFER, MSG_INFO=FINFO, /* remote logging */
234 MSG_ERROR=FERROR, MSG_WARNING=FWARNING, /* protocol-30 remote logging */
235 MSG_ERROR_SOCKET=FERROR_SOCKET, /* sibling logging */
7c7462cd 236 MSG_ERROR_UTF8=FERROR_UTF8, /* sibling logging */
3f0211b6 237 MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, /* sibling logging */
1dcf3b43 238 MSG_REDO=9, /* reprocess indicated flist index */
20caffd2 239 MSG_STATS=10, /* message has stats data for generator */
9ec3828b 240 MSG_IO_ERROR=22,/* the sending side had an I/O error */
a0f1ed55 241 MSG_IO_TIMEOUT=33,/* tell client about a daemon's timeout value */
92d02148 242 MSG_NOOP=42, /* a do-nothing message (legacy protocol-30 only) */
05c36015 243 MSG_ERROR_EXIT=86, /* synchronize an error exit (siblings and protocol >= 31) */
1dcf3b43
WD
244 MSG_SUCCESS=100,/* successfully updated indicated flist index */
245 MSG_DELETED=101,/* successfully deleted a file on receiving side */
9ec3828b 246 MSG_NO_SEND=102,/* sender failed to open a file we wanted */
419896af 247};
7bec6a5c 248
82ad07c4 249#define NDX_DONE -1
9ec3828b 250#define NDX_FLIST_EOF -2
20caffd2 251#define NDX_DEL_STATS -3
9ec3828b 252#define NDX_FLIST_OFFSET -101
82ad07c4 253
974e1819
WD
254/* For calling delete_item() and delete_dir_contents(). */
255#define DEL_NO_UID_WRITE (1<<0) /* file/dir has our uid w/o write perm */
256#define DEL_RECURSE (1<<1) /* if dir, delete all contents */
257#define DEL_DIR_IS_EMPTY (1<<2) /* internal delete_FUNCTIONS use only */
258#define DEL_FOR_FILE (1<<3) /* making room for a replacement file */
259#define DEL_FOR_DIR (1<<4) /* making room for a replacement dir */
260#define DEL_FOR_SYMLINK (1<<5) /* making room for a replacement symlink */
261#define DEL_FOR_DEVICE (1<<6) /* making room for a replacement device */
262#define DEL_FOR_SPECIAL (1<<7) /* making room for a replacement special */
21cddef2 263#define DEL_FOR_BACKUP (1<<8) /* the delete is for a backup operation */
974e1819
WD
264
265#define DEL_MAKE_ROOM (DEL_FOR_FILE|DEL_FOR_DIR|DEL_FOR_SYMLINK|DEL_FOR_DEVICE|DEL_FOR_SPECIAL)
266
267enum delret {
268 DR_SUCCESS = 0, DR_FAILURE, DR_AT_LIMIT, DR_NOT_EMPTY
269};
270
3696674b
WD
271/* Defines for make_path() */
272#define MKP_DROP_NAME (1<<0) /* drop trailing filename or trailing slash */
273#define MKP_SKIP_SLASH (1<<1) /* skip one or more leading slashes */
274
05c36015
WD
275/* Defines for maybe_send_keepalive() */
276#define MSK_ALLOW_FLUSH (1<<0)
277#define MSK_ACTIVE_RECEIVER (1<<1)
278
65417579
AT
279#include "errcode.h"
280
c627d613
AT
281#include "config.h"
282
e3217f14 283/* The default RSYNC_RSH is always set in config.h. */
24d95c03 284
c627d613 285#include <stdio.h>
4f5b0756 286#ifdef HAVE_SYS_TYPES_H
e95538ca
WD
287# include <sys/types.h>
288#endif
4f5b0756 289#ifdef HAVE_SYS_STAT_H
e95538ca
WD
290# include <sys/stat.h>
291#endif
4f5b0756 292#ifdef STDC_HEADERS
e95538ca
WD
293# include <stdlib.h>
294# include <stddef.h>
295#else
4f5b0756 296# ifdef HAVE_STDLIB_H
e95538ca
WD
297# include <stdlib.h>
298# endif
299#endif
4f5b0756
WD
300#ifdef HAVE_STRING_H
301# if !defined STDC_HEADERS && defined HAVE_MEMORY_H
e95538ca
WD
302# include <memory.h>
303# endif
304# include <string.h>
305#endif
4f5b0756 306#ifdef HAVE_STRINGS_H
e95538ca
WD
307# include <strings.h>
308#endif
2d2414f3
WD
309#ifdef HAVE_INTTYPES_H
310# include <inttypes.h>
311#endif
b4b24520
WD
312#ifdef HAVE_STDINT_H
313# include <stdint.h>
314#endif
4f5b0756 315#ifdef HAVE_UNISTD_H
e95538ca 316# include <unistd.h>
c627d613
AT
317#endif
318
4f5b0756 319#ifdef HAVE_SYS_PARAM_H
e95538ca 320#include <sys/param.h>
38b02c13 321#endif
59192f56 322
4f5b0756 323#if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
59192f56 324#include <malloc.h>
d7b305fd
AT
325#endif
326
4f5b0756 327#ifdef HAVE_SYS_SOCKET_H
fdd71e17
AT
328#include <sys/socket.h>
329#endif
330
4f5b0756 331#ifdef TIME_WITH_SYS_TIME
c627d613
AT
332#include <sys/time.h>
333#include <time.h>
334#else
4f5b0756 335#ifdef HAVE_SYS_TIME_H
c627d613
AT
336#include <sys/time.h>
337#else
338#include <time.h>
339#endif
340#endif
341
4f5b0756 342#ifdef HAVE_FCNTL_H
c627d613
AT
343#include <fcntl.h>
344#else
4f5b0756 345#ifdef HAVE_SYS_FCNTL_H
c627d613
AT
346#include <sys/fcntl.h>
347#endif
348#endif
349
4f5b0756 350#ifdef HAVE_SYS_IOCTL_H
94481d91
AT
351#include <sys/ioctl.h>
352#endif
353
4f5b0756 354#ifdef HAVE_SYS_FILIO_H
94481d91
AT
355#include <sys/filio.h>
356#endif
357
c627d613 358#include <signal.h>
4f5b0756 359#ifdef HAVE_SYS_WAIT_H
c627d613
AT
360#include <sys/wait.h>
361#endif
4f5b0756 362#ifdef HAVE_CTYPE_H
c627d613
AT
363#include <ctype.h>
364#endif
4f5b0756 365#ifdef HAVE_GRP_H
c627d613
AT
366#include <grp.h>
367#endif
368#include <errno.h>
369
4f5b0756 370#ifdef HAVE_UTIME_H
c627d613
AT
371#include <utime.h>
372#endif
373
1a2e41af 374#if defined HAVE_UTIMENSAT || defined HAVE_LUTIMES
accc091f
WD
375#define CAN_SET_SYMLINK_TIMES 1
376#endif
377
743348e8
WD
378#if defined HAVE_LCHOWN || defined CHOWN_MODIFIES_SYMLINK
379#define CAN_CHOWN_SYMLINK 1
380#endif
381
382#if defined HAVE_LCHMOD || defined HAVE_SETATTRLIST
383#define CAN_CHMOD_SYMLINK 1
384#endif
385
852585b1
WD
386#ifdef HAVE_UTIMENSAT
387#ifdef HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
388#define ST_MTIME_NSEC st_mtim.tv_nsec
389#elif defined(HAVE_STRUCT_STAT_ST_MTIMENSEC)
390#define ST_MTIME_NSEC st_mtimensec
391#endif
392#endif
393
4f5b0756 394#ifdef HAVE_SYS_SELECT_H
8bf73749
AT
395#include <sys/select.h>
396#endif
397
4f5b0756 398#ifdef HAVE_SYS_MODE_H
773f2bd4 399/* apparently AIX needs this for S_ISLNK */
05a6556d 400#ifndef S_ISLNK
773f2bd4
AT
401#include <sys/mode.h>
402#endif
05a6556d 403#endif
773f2bd4 404
f6c34742
AT
405/* these are needed for the uid/gid mapping code */
406#include <pwd.h>
407#include <grp.h>
408
9486289c 409#include <stdarg.h>
f0fca04e
AT
410#include <netinet/in.h>
411#include <arpa/inet.h>
6e1fa33f 412#ifdef HAVE_NETDB_H
f0fca04e 413#include <netdb.h>
6e1fa33f 414#endif
ff8b29b8 415#include <syslog.h>
6c8f5373 416#include <sys/file.h>
9486289c 417
4f5b0756 418#ifdef HAVE_DIRENT_H
e8f5b936
AT
419# include <dirent.h>
420#else
421# define dirent direct
4f5b0756 422# ifdef HAVE_SYS_NDIR_H
e8f5b936
AT
423# include <sys/ndir.h>
424# endif
4f5b0756 425# ifdef HAVE_SYS_DIR_H
e8f5b936
AT
426# include <sys/dir.h>
427# endif
4f5b0756 428# ifdef HAVE_NDIR_H
e8f5b936
AT
429# include <ndir.h>
430# endif
431#endif
432
4f5b0756 433#ifdef MAJOR_IN_MKDEV
c39d6514 434#include <sys/mkdev.h>
8a33c406 435# if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
73496a36
WD
436# define makedev mkdev
437# endif
4f5b0756 438#elif defined MAJOR_IN_SYSMACROS
f8ed564c 439#include <sys/sysmacros.h>
c39d6514
WD
440#endif
441
5a3810b4
WD
442#ifdef MAKEDEV_TAKES_3_ARGS
443#define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
444#else
445#define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
446#endif
447
4f5b0756 448#ifdef HAVE_COMPAT_H
e8f5b936
AT
449#include <compat.h>
450#endif
451
ea8291d8
WD
452#ifdef HAVE_LIMITS_H
453# include <limits.h>
454#endif
455
49c24071 456#if defined USE_ICONV_OPEN && defined HAVE_ICONV_H
332cf6df
WD
457#include <iconv.h>
458#ifndef ICONV_CONST
459#define ICONV_CONST
460#endif
4a1edb63
WD
461#else
462#ifdef ICONV_CONST
332cf6df
WD
463#undef ICONV_CONST
464#endif
21546571
WD
465#ifdef ICONV_OPTION
466#undef ICONV_OPTION
467#endif
4a1edb63
WD
468#ifdef iconv_t
469#undef iconv_t
470#endif
471#define iconv_t int
472#endif
332cf6df 473
1bfbf40b
MP
474#include <assert.h>
475
9935066b 476#include "lib/pool_alloc.h"
e8f5b936 477
88a74268 478#ifndef HAVE_ID_T
d9e92804 479typedef unsigned int id_t;
88a74268
WD
480#endif
481#ifndef HAVE_PID_T
482typedef int pid_t;
483#endif
484#ifndef HAVE_MODE_T
d9e92804 485typedef unsigned int mode_t;
88a74268
WD
486#endif
487#ifndef HAVE_OFF_T
488typedef long off_t;
c6679e04
WD
489#undef SIZEOF_OFF_T
490#define SIZEOF_OFF_T SIZEOF_LONG
88a74268
WD
491#endif
492#ifndef HAVE_SIZE_T
493typedef unsigned int size_t;
494#endif
495
f0fca04e
AT
496#define BOOL int
497
c627d613
AT
498#ifndef uchar
499#define uchar unsigned char
500#endif
501
4f5b0756 502#ifdef SIGNED_CHAR_OK
debb4505
AT
503#define schar signed char
504#else
505#define schar char
506#endif
507
2d2414f3
WD
508#ifndef int16
509#if SIZEOF_INT16_T == 2
510# define int16 int16_t
511#else
512# define int16 short
513#endif
514#endif
515
516#ifndef uint16
517#if SIZEOF_UINT16_T == 2
518# define uint16 uint16_t
519#else
520# define uint16 unsigned int16
521#endif
522#endif
523
43d0f38b
WD
524/* Find a variable that is either exactly 32-bits or longer.
525 * If some code depends on 32-bit truncation, it will need to
526 * take special action in a "#if SIZEOF_INT32 > 4" section. */
c627d613 527#ifndef int32
2d2414f3
WD
528#if SIZEOF_INT32_T == 4
529# define int32 int32_t
530# define SIZEOF_INT32 4
531#elif SIZEOF_INT == 4
43d0f38b
WD
532# define int32 int
533# define SIZEOF_INT32 4
534#elif SIZEOF_LONG == 4
535# define int32 long
536# define SIZEOF_INT32 4
537#elif SIZEOF_SHORT == 4
538# define int32 short
539# define SIZEOF_INT32 4
540#elif SIZEOF_INT > 4
541# define int32 int
542# define SIZEOF_INT32 SIZEOF_INT
543#elif SIZEOF_LONG > 4
544# define int32 long
545# define SIZEOF_INT32 SIZEOF_LONG
8de330a3 546#else
43d0f38b 547# error Could not find a 32-bit integer variable
c627d613 548#endif
43d0f38b
WD
549#else
550# define SIZEOF_INT32 4
c627d613
AT
551#endif
552
553#ifndef uint32
2d2414f3
WD
554#if SIZEOF_UINT32_T == 4
555# define uint32 uint32_t
556#else
557# define uint32 unsigned int32
558#endif
c627d613
AT
559#endif
560
0dd046d3 561#if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
bcacc18b
AT
562#define OFF_T off_t
563#define STRUCT_STAT struct stat
4ecf3e06 564#define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF_T
5b5f7e3b
WD
565#else
566#define OFF_T off64_t
567#define STRUCT_STAT struct stat64
568#define USE_STAT64_FUNCS 1
4ecf3e06 569#define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF64_T
bcacc18b
AT
570#endif
571
d4198823
WD
572/* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
573 * that's the maximum size the file system can handle and there is no
574 * 64-bit type available. The rsync source must therefore take steps
575 * to ensure that any code that really requires a 64-bit integer has
576 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
577 * counter). */
2d2414f3
WD
578#if SIZEOF_INT64_T == 8
579# define int64 int64_t
580# define SIZEOF_INT64 8
581#elif SIZEOF_LONG == 8
d622d4bf
WD
582# define int64 long
583# define SIZEOF_INT64 8
584#elif SIZEOF_INT == 8
585# define int64 int
586# define SIZEOF_INT64 8
587#elif SIZEOF_LONG_LONG == 8
588# define int64 long long
589# define SIZEOF_INT64 8
2c177562
WD
590#elif SIZEOF_OFF64_T == 8
591# define int64 off64_t
592# define SIZEOF_INT64 8
d622d4bf
WD
593#elif SIZEOF_OFF_T == 8
594# define int64 off_t
595# define SIZEOF_INT64 8
596#elif SIZEOF_INT > 8
597# define int64 int
598# define SIZEOF_INT64 SIZEOF_INT
599#elif SIZEOF_LONG > 8
600# define int64 long
601# define SIZEOF_INT64 SIZEOF_LONG
602#elif SIZEOF_LONG_LONG > 8
603# define int64 long long
604# define SIZEOF_INT64 SIZEOF_LONG_LONG
71c46176 605#else
736a6a29 606/* As long as it gets... */
d622d4bf
WD
607# define int64 off_t
608# define SIZEOF_INT64 SIZEOF_OFF_T
71c46176 609#endif
c627d613 610
83135e8f
WD
611struct hashtable {
612 void *nodes;
613 int32 size, entries;
614 uint32 node_size;
0c096e29 615 short key64;
83135e8f
WD
616};
617
618struct ht_int32_node {
619 void *data;
620 int32 key;
621};
622
623struct ht_int64_node {
14d776ff 624 void *data;
83135e8f 625 int64 key;
14d776ff
WD
626};
627
83135e8f
WD
628#define HT_NODE(tbl, bkts, i) ((void*)((char*)(bkts) + (i)*(tbl)->node_size))
629#define HT_KEY(node, k64) ((k64)? ((struct ht_int64_node*)(node))->key \
630 : (int64)((struct ht_int32_node*)(node))->key)
631
c627d613
AT
632#ifndef MIN
633#define MIN(a,b) ((a)<(b)?(a):(b))
634#endif
635
636#ifndef MAX
637#define MAX(a,b) ((a)>(b)?(a):(b))
638#endif
639
d41c7d02
DD
640#ifndef MAXHOSTNAMELEN
641#define MAXHOSTNAMELEN 256
642#endif
643
c627d613 644#define SUM_LENGTH 16
195bd906
S
645#define SHORT_SUM_LENGTH 2
646#define BLOCKSUM_BIAS 10
c627d613
AT
647
648#ifndef MAXPATHLEN
649#define MAXPATHLEN 1024
650#endif
651
a22ca885
WD
652/* We want a roomy line buffer that can hold more than MAXPATHLEN,
653 * and significantly more than an overly short MAXPATHLEN. */
654#if MAXPATHLEN < 4096
655#define BIGPATHBUFLEN (4096+1024)
656#else
657#define BIGPATHBUFLEN (MAXPATHLEN+1024)
658#endif
659
52d3e106
S
660#ifndef NAME_MAX
661#define NAME_MAX 255
662#endif
663
0473e2a1
AT
664#ifndef INADDR_NONE
665#define INADDR_NONE 0xffffffff
666#endif
667
bda41fa5
WD
668#ifndef IN_LOOPBACKNET
669#define IN_LOOPBACKNET 127
670#endif
671
1c3344a1
WD
672#if HAVE_UNIXWARE_ACLS|HAVE_SOLARIS_ACLS|HAVE_HPUX_ACLS
673#define ACLS_NEED_MASK 1
674#endif
675
28b519c9 676#if defined HAVE_FALLOCATE || HAVE_SYS_FALLOCATE
ac30d22a 677#ifdef HAVE_LINUX_FALLOC_H
28b519c9 678#include <linux/falloc.h>
ac30d22a 679#endif
28b519c9
WD
680#ifdef FALLOC_FL_KEEP_SIZE
681#define SUPPORT_PREALLOCATION 1
682#elif defined HAVE_FTRUNCATE
683#define SUPPORT_PREALLOCATION 1
684#define PREALLOCATE_NEEDS_TRUNCATE 1
685#endif
686#else /* !fallocate */
687#if defined HAVE_EFFICIENT_POSIX_FALLOCATE && defined HAVE_FTRUNCATE
688#define SUPPORT_PREALLOCATION 1
689#define PREALLOCATE_NEEDS_TRUNCATE 1
690#endif
691#endif
692
5b30412c 693union file_extras {
bd6edd3f
WD
694 int32 num;
695 uint32 unum;
5b30412c
WD
696};
697
c627d613 698struct file_struct {
2d2414f3
WD
699 const char *dirname; /* The dir info inside the transfer */
700 time_t modtime; /* When the item was last modified */
701 uint32 len32; /* Lowest 32 bits of the file's length */
702 uint16 mode; /* The item's type and permissions */
703 uint16 flags; /* The FLAG_* bits for this item */
704 const char basename[1]; /* The basename (AKA filename) follows */
c627d613
AT
705};
706
99a957d3 707extern int file_extra_cnt;
cf2d2665 708extern int inc_recurse;
9742b386
WD
709extern int uid_ndx;
710extern int gid_ndx;
711extern int acls_ndx;
712extern int xattrs_ndx;
b96efc2f 713
c58c1dc4 714#define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
5b30412c 715#define EXTRA_LEN (sizeof (union file_extras))
4b163f00 716#define PTR_EXTRA_CNT ((sizeof (char *) + EXTRA_LEN - 1) / EXTRA_LEN)
a08979d5
WD
717#define DEV_EXTRA_CNT 2
718#define DIRNODE_EXTRA_CNT 3
a0456b9c 719#define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
96293cf9 720
5b30412c 721#define REQ_EXTRA(f,ndx) ((union file_extras*)(f) - (ndx))
99a957d3 722#define OPT_EXTRA(f,bump) ((union file_extras*)(f) - file_extra_cnt - 1 - (bump))
b37b7c99 723
1a2e41af 724#define NSEC_BUMP(f) ((f)->flags & FLAG_MOD_NSEC ? 1 : 0)
96293cf9 725#define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
1a2e41af 726#define START_BUMP(f) (NSEC_BUMP(f) + LEN64_BUMP(f))
7b46e30f 727#define HLINK_BUMP(f) ((f)->flags & (FLAG_HLINKED|FLAG_HLINK_DONE) ? inc_recurse+1 : 0)
a08979d5 728#define ACL_BUMP(f) (acls_ndx ? 1 : 0)
96293cf9 729
c58c1dc4 730/* The length applies to all items. */
bf466c0f
WD
731#if SIZEOF_INT64 < 8
732#define F_LENGTH(f) ((int64)(f)->len32)
733#else
734#define F_LENGTH(f) ((int64)(f)->len32 + ((f)->flags & FLAG_LENGTH64 \
de32838e 735 ? (int64)OPT_EXTRA(f, NSEC_BUMP(f))->unum << 32 : 0))
bf466c0f 736#endif
82ad07c4 737
de32838e 738#define F_MOD_NSEC(f) ((f)->flags & FLAG_MOD_NSEC ? OPT_EXTRA(f, 0)->unum : 0)
1a2e41af 739
96293cf9 740/* If there is a symlink string, it is always right after the basename */
c58c1dc4 741#define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
82ad07c4 742
bd6edd3f 743/* The sending side always has this available: */
4b163f00 744#define F_PATHNAME(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_CNT))
bd6edd3f
WD
745
746/* The receiving side always has this available: */
747#define F_DEPTH(f) REQ_EXTRA(f, 1)->num
748
96293cf9 749/* When the associated option is on, all entries will have these present: */
9742b386
WD
750#define F_OWNER(f) REQ_EXTRA(f, uid_ndx)->unum
751#define F_GROUP(f) REQ_EXTRA(f, gid_ndx)->unum
752#define F_ACL(f) REQ_EXTRA(f, acls_ndx)->num
753#define F_XATTR(f) REQ_EXTRA(f, xattrs_ndx)->num
f7a76b9c 754#define F_NDX(f) REQ_EXTRA(f, unsort_ndx)->num
82ad07c4 755
a08979d5 756/* These items are per-entry optional: */
1a2e41af
WD
757#define F_HL_GNUM(f) OPT_EXTRA(f, START_BUMP(f))->num /* non-dirs */
758#define F_HL_PREV(f) OPT_EXTRA(f, START_BUMP(f)+inc_recurse)->num /* non-dirs */
759#define F_DIR_NODE_P(f) (&OPT_EXTRA(f, START_BUMP(f) \
a08979d5 760 + DIRNODE_EXTRA_CNT - 1)->num) /* sender dirs */
1a2e41af 761#define F_DIR_RELNAMES_P(f) (&OPT_EXTRA(f, START_BUMP(f) + DIRNODE_EXTRA_CNT \
4b163f00 762 + PTR_EXTRA_CNT - 1)->num) /* sender dirs */
1a2e41af
WD
763#define F_DIR_DEFACL(f) OPT_EXTRA(f, START_BUMP(f))->unum /* receiver dirs */
764#define F_DIR_DEV_P(f) (&OPT_EXTRA(f, START_BUMP(f) + ACL_BUMP(f) \
a08979d5 765 + DEV_EXTRA_CNT - 1)->unum) /* receiver dirs */
82ad07c4 766
1a2e41af
WD
767/* This optional item might follow an F_HL_*() item. */
768#define F_RDEV_P(f) (&OPT_EXTRA(f, START_BUMP(f) + HLINK_BUMP(f) + DEV_EXTRA_CNT - 1)->unum)
82ad07c4 769
96293cf9 770/* The sum is only present on regular files. */
1a2e41af 771#define F_SUM(f) ((char*)OPT_EXTRA(f, START_BUMP(f) + HLINK_BUMP(f) \
a08979d5 772 + SUM_EXTRA_CNT - 1))
96293cf9 773
b37b7c99 774/* Some utility defines: */
c58c1dc4 775#define F_IS_ACTIVE(f) (f)->basename[0]
bfd31372 776#define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
5bb73485 777
b7cfb9e2
WD
778#define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
779#define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
96293cf9 780
4b163f00 781/* These access the F_DIR_DEV_P() and F_RDEV_P() values: */
b37b7c99
WD
782#define DEV_MAJOR(a) (a)[0]
783#define DEV_MINOR(a) (a)[1]
784
4b163f00 785/* These access the F_DIRS_NODE_P() values: */
9ec3828b
WD
786#define DIR_PARENT(a) (a)[0]
787#define DIR_FIRST_CHILD(a) (a)[1]
788#define DIR_NEXT_SIBLING(a) (a)[2]
789
96293cf9
WD
790/*
791 * Start the flist array at FLIST_START entries and grow it
792 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
793 */
794#define FLIST_START (32 * 1024)
795#define FLIST_LINEAR (FLIST_START * 512)
82ad07c4 796
9935066b 797/*
82ad07c4 798 * Extent size for allocation pools: A minimum size of 128KB
9935066b
S
799 * is needed to mmap them so that freeing will release the
800 * space to the OS.
801 *
802 * Larger sizes reduce leftover fragments and speed free calls
82ad07c4 803 * (when they happen). Smaller sizes increase the chance of
9935066b
S
804 * freed allocations freeing whole extents.
805 */
f5ba7bfb
WD
806#define NORMAL_EXTENT (256 * 1024)
807#define SMALL_EXTENT (128 * 1024)
9935066b 808
9ec3828b
WD
809#define FLIST_TEMP (1<<1)
810
c627d613 811struct file_list {
9ec3828b 812 struct file_list *next, *prev;
332cf6df 813 struct file_struct **files, **sorted;
9935066b 814 alloc_pool_t file_pool;
f5ba7bfb 815 void *pool_boundary;
9decb4d2
WD
816 int used, malloced;
817 int low, high; /* 0-relative index values excluding empties */
818 int ndx_start; /* the start offset for inc_recurse mode */
65b4e4b2 819 int flist_num; /* 1-relative file_list number or 0 */
9ec3828b
WD
820 int parent_ndx; /* dir_flist index of parent directory */
821 int in_progress, to_redo;
c627d613
AT
822};
823
a3221d2a
WD
824#define SUMFLG_SAME_OFFSET (1<<0)
825
c627d613 826struct sum_buf {
6ded1170 827 OFF_T offset; /**< offset in file of this chunk */
a06b419d 828 int32 len; /**< length of chunk of file */
6ded1170 829 uint32 sum1; /**< simple checksum */
d733de97 830 int32 chain; /**< next hash-table collision */
a3221d2a 831 short flags; /**< flag bits */
6ded1170 832 char sum2[SUM_LENGTH]; /**< checksum */
c627d613
AT
833};
834
835struct sum_struct {
6ded1170 836 OFF_T flength; /**< total file length */
2b2ea368 837 struct sum_buf *sums; /**< points to info for each chunk */
15859584 838 int32 count; /**< how many chunks */
a06b419d
WD
839 int32 blength; /**< block_length */
840 int32 remainder; /**< flength % block_length */
da9d12f5 841 int s2length; /**< sum2_length */
c627d613
AT
842};
843
c6e7fcb4 844struct map_struct {
6a7cc46c
S
845 OFF_T file_size; /* File size (from stat) */
846 OFF_T p_offset; /* Window start */
847 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
2b2ea368
WD
848 char *p; /* Window pointer */
849 int32 p_size; /* Largest window size we allocated */
850 int32 p_len; /* Latest (rounded) window size */
851 int32 def_window_size; /* Default window size */
852 int fd; /* File Descriptor */
853 int status; /* first errno from read errors */
c6e7fcb4 854};
c627d613 855
b32d4254
WD
856#define FILTRULE_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
857#define FILTRULE_WILD2 (1<<1) /* pattern has '**' */
858#define FILTRULE_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
859#define FILTRULE_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
860#define FILTRULE_ABS_PATH (1<<4) /* path-match on absolute path */
861#define FILTRULE_INCLUDE (1<<5) /* this is an include, not an exclude */
862#define FILTRULE_DIRECTORY (1<<6) /* this matches only directories */
863#define FILTRULE_WORD_SPLIT (1<<7) /* split rules on whitespace */
864#define FILTRULE_NO_INHERIT (1<<8) /* don't inherit these rules */
865#define FILTRULE_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
866#define FILTRULE_MERGE_FILE (1<<10)/* specifies a file to merge */
867#define FILTRULE_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
868#define FILTRULE_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
869#define FILTRULE_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
870#define FILTRULE_NEGATE (1<<14)/* rule matches when pattern does not */
871#define FILTRULE_CVS_IGNORE (1<<15)/* rule was -C or :C */
872#define FILTRULE_SENDER_SIDE (1<<16)/* rule applies to the sending side */
873#define FILTRULE_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
874#define FILTRULE_CLEAR_LIST (1<<18)/* this item is the "!" token */
875#define FILTRULE_PERISHABLE (1<<19)/* perishable if parent dir goes away */
876
c8fa85b2 877#define FILTRULES_SIDES (FILTRULE_SENDER_SIDE | FILTRULE_RECEIVER_SIDE)
3b2461cf 878
7b6c5c77 879typedef struct filter_struct {
7842418b 880 struct filter_struct *next;
2b6b4d53 881 char *pattern;
b32d4254 882 uint32 rflags;
46fa6025
WD
883 union {
884 int slash_cnt;
7842418b 885 struct filter_list_struct *mergelist;
46fa6025 886 } u;
7b6c5c77 887} filter_rule;
2b6b4d53 888
7b6c5c77
WD
889typedef struct filter_list_struct {
890 filter_rule *head;
891 filter_rule *tail;
892 filter_rule *parent_dirscan_head;
ac1d2d33 893 char *debug_type;
7b6c5c77 894} filter_rule_list;
63d03319 895
a800434a
AT
896struct stats {
897 int64 total_size;
898 int64 total_transferred_size;
899 int64 total_written;
900 int64 total_read;
901 int64 literal_data;
902 int64 matched_data;
d4198823
WD
903 int64 flist_buildtime;
904 int64 flist_xfertime;
604dbf6d 905 int64 flist_size;
e366e530
WD
906 int num_files, num_dirs, num_symlinks, num_devices, num_specials;
907 int created_files, created_dirs, created_symlinks, created_devices, created_specials;
908 int deleted_files, deleted_dirs, deleted_symlinks, deleted_devices, deleted_specials;
909 int xferred_files;
a800434a
AT
910};
911
f7bce90c 912struct chmod_mode_struct;
2b6b4d53 913
e0c572c5
WD
914struct flist_ndx_item {
915 struct flist_ndx_item *next;
916 int ndx;
917};
918
919typedef struct {
920 struct flist_ndx_item *head, *tail;
921} flist_ndx_list;
922
1c3344a1
WD
923#define EMPTY_ITEM_LIST {NULL, 0, 0}
924
925typedef struct {
926 void *items;
927 size_t count;
928 size_t malloced;
929} item_list;
930
931#define EXPAND_ITEM_LIST(lp, type, incr) \
932 (type*)expand_item_list(lp, sizeof (type), #type, incr)
933
2ac081ff
WD
934#define EMPTY_XBUF {NULL, 0, 0, 0}
935
936typedef struct {
937 char *buf;
938 size_t pos; /* pos = read pos in the buf */
939 size_t len; /* len = chars following pos */
940 size_t size; /* size = total space in buf */
941} xbuf;
942
943#define INIT_XBUF(xb, str, ln, sz) (xb).buf = (str), (xb).len = (ln), (xb).size = (sz), (xb).pos = 0
bb640d32 944#define INIT_XBUF_STRLEN(xb, str) (xb).buf = (str), (xb).len = strlen((xb).buf), (xb).size = (size_t)-1, (xb).pos = 0
2ac081ff
WD
945/* This one is used to make an output xbuf based on a char[] buffer: */
946#define INIT_CONST_XBUF(xb, bf) (xb).buf = (bf), (xb).size = sizeof (bf), (xb).len = (xb).pos = 0
947
948#define ICB_EXPAND_OUT (1<<0)
949#define ICB_INCLUDE_BAD (1<<1)
950#define ICB_INCLUDE_INCOMPLETE (1<<2)
20caffd2 951#define ICB_CIRCULAR_OUT (1<<3)
d8a7290f 952#define ICB_INIT (1<<4)
2ac081ff 953
705132bc
WD
954#define IOBUF_KEEP_BUFS 0
955#define IOBUF_FREE_BUFS 1
956
957#define MPLX_SWITCHING IOBUF_KEEP_BUFS
958#define MPLX_ALL_DONE IOBUF_FREE_BUFS
959#define MPLX_TO_BUFFERED 2
960
2ac081ff
WD
961#define RL_EOL_NULLS (1<<0)
962#define RL_DUMP_COMMENTS (1<<1)
963#define RL_CONVERT (1<<2)
964
54410882 965typedef struct {
c73f2a38 966 char name_type;
54410882
WD
967 char fname[1]; /* has variable size */
968} relnamecache;
969
c627d613 970#include "byteorder.h"
a0456b9c 971#include "lib/mdigest.h"
87f18b62 972#include "lib/wildmatch.h"
740819ef 973#include "lib/permstring.h"
e20a4f84 974#include "lib/addrinfo.h"
0de40240 975
2b916250 976#ifndef __GNUC__
4ea58045 977#define __attribute__(x)
1b896f8d 978#else
7de7b49f
WD
979# if __GNUC__ <= 2
980# define NORETURN
981# endif
4ea58045
WD
982#endif
983
90b13cf6 984#define UNUSED(x) x __attribute__((__unused__))
7de7b49f 985#ifndef NORETURN
011e85a5 986#define NORETURN __attribute__((__noreturn__))
7de7b49f 987#endif
90b13cf6 988
1c3344a1
WD
989typedef struct {
990 STRUCT_STAT st;
991#ifdef SUPPORT_ACLS
992 struct rsync_acl *acc_acl; /* access ACL */
993 struct rsync_acl *def_acl; /* default ACL */
994#endif
16edf865
WD
995#ifdef SUPPORT_XATTRS
996 item_list *xattr;
997#endif
13710874 998} stat_x;
1c3344a1
WD
999
1000#define ACL_READY(sx) ((sx).acc_acl != NULL)
16edf865 1001#define XATTR_READY(sx) ((sx).xattr != NULL)
1c3344a1 1002
58c29609
MP
1003#include "proto.h"
1004
9439c0cb
WD
1005#ifndef SUPPORT_XATTRS
1006#define x_stat(fn,fst,xst) do_stat(fn,fst)
1007#define x_lstat(fn,fst,xst) do_lstat(fn,fst)
1008#define x_fstat(fd,fst,xst) do_fstat(fd,fst)
1009#endif
1010
0de40240 1011/* We have replacement versions of these if they're missing. */
4f5b0756 1012#ifndef HAVE_ASPRINTF
0de40240
MP
1013int asprintf(char **ptr, const char *format, ...);
1014#endif
1015
4f5b0756 1016#ifndef HAVE_VASPRINTF
0de40240
MP
1017int vasprintf(char **ptr, const char *format, va_list ap);
1018#endif
1019
4f5b0756 1020#if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e
WD
1021#define vsnprintf rsync_vsnprintf
1022int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
0de40240
MP
1023#endif
1024
4f5b0756 1025#if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e 1026#define snprintf rsync_snprintf
82ad07c4 1027int snprintf(char *str, size_t count, const char *fmt,...);
0de40240
MP
1028#endif
1029
1030
4f5b0756 1031#ifndef HAVE_STRERROR
c627d613
AT
1032extern char *sys_errlist[];
1033#define strerror(i) sys_errlist[i]
1034#endif
1035
4f5b0756 1036#ifndef HAVE_STRCHR
c627d613
AT
1037# define strchr index
1038# define strrchr rindex
1039#endif
1040
4f5b0756 1041#ifndef HAVE_ERRNO_DECL
c627d613
AT
1042extern int errno;
1043#endif
1044
9a929c8f
WD
1045#ifdef HAVE_READLINK
1046#define SUPPORT_LINKS 1
a59a7b24 1047#if !defined NO_SYMLINK_XATTRS && !defined NO_SYMLINK_USER_XATTRS
6e310d38
WD
1048#define do_readlink(path, buf, bufsiz) readlink(path, buf, bufsiz)
1049#endif
9a929c8f
WD
1050#endif
1051#ifdef HAVE_LINK
1052#define SUPPORT_HARD_LINKS 1
1053#endif
c627d613 1054
5173f99e 1055#ifdef HAVE_SIGACTION
90b13cf6
WD
1056#define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
1057#define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
1058#else
1059#define SIGACTION(n,h) signal(n,h)
1060#endif
720b47f2
AT
1061
1062#ifndef EWOULDBLOCK
1063#define EWOULDBLOCK EAGAIN
1064#endif
182dca5c 1065
7b8356d0
AT
1066#ifndef STDIN_FILENO
1067#define STDIN_FILENO 0
1068#endif
1069
1070#ifndef STDOUT_FILENO
1071#define STDOUT_FILENO 1
1072#endif
1073
1074#ifndef STDERR_FILENO
1075#define STDERR_FILENO 2
1076#endif
1077
8120a98f
WD
1078#ifndef S_IRUSR
1079#define S_IRUSR 0400
1080#endif
1081
7b8356d0
AT
1082#ifndef S_IWUSR
1083#define S_IWUSR 0200
1084#endif
1085
b0d791bb
PG
1086#ifndef ACCESSPERMS
1087#define ACCESSPERMS 0777
1088#endif
1089
1090#ifndef S_ISVTX
1091#define S_ISVTX 0
1092#endif
1093
1094#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
1095
b280a1f4
AT
1096#ifndef _S_IFMT
1097#define _S_IFMT 0170000
1098#endif
1099
1100#ifndef _S_IFLNK
1101#define _S_IFLNK 0120000
1102#endif
1103
1104#ifndef S_ISLNK
1105#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
1106#endif
1107
1e9f155a
AT
1108#ifndef S_ISBLK
1109#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
1110#endif
1111
1112#ifndef S_ISCHR
1113#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
1114#endif
1115
a0b65b18
AT
1116#ifndef S_ISSOCK
1117#ifdef _S_IFSOCK
1118#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
1119#else
1120#define S_ISSOCK(mode) (0)
1121#endif
1122#endif
1123
1124#ifndef S_ISFIFO
1125#ifdef _S_IFIFO
1126#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
1127#else
1128#define S_ISFIFO(mode) (0)
1129#endif
1130#endif
1131
1e9f155a
AT
1132#ifndef S_ISDIR
1133#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
1134#endif
1135
1136#ifndef S_ISREG
1137#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
1138#endif
1139
f0359dd0
AT
1140/* work out what fcntl flag to use for non-blocking */
1141#ifdef O_NONBLOCK
1142# define NONBLOCK_FLAG O_NONBLOCK
4f5b0756 1143#elif defined SYSV
f0359dd0 1144# define NONBLOCK_FLAG O_NDELAY
d622d4bf 1145#else
f0359dd0
AT
1146# define NONBLOCK_FLAG FNDELAY
1147#endif
1148
d79c77ca
MP
1149#ifndef INADDR_LOOPBACK
1150#define INADDR_LOOPBACK 0x7f000001
1151#endif
1152
1153#ifndef INADDR_NONE
1154#define INADDR_NONE 0xffffffff
1155#endif
a0b65b18 1156
b5c6a6ae
WD
1157#define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
1158#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
7bec6a5c 1159
2624e005
WD
1160#define PRESERVE_FILE_TIMES (1<<0)
1161#define PRESERVE_DIR_TIMES (1<<1)
1162#define PRESERVE_LINK_TIMES (1<<2)
1163
5afd8aed
DD
1164/* Initial mask on permissions given to temporary files. Mask off setuid
1165 bits and group access because of potential race-condition security
1166 holes, and mask other access because mode 707 is bizarre */
972a3619 1167#define INITACCESSPERMS 0700
e08bfe12
AT
1168
1169/* handler for null strings in printf format */
0ee6ca98 1170#define NS(s) ((s)?(s):"<NULL>")
e08bfe12 1171
58cadc86 1172/* Convenient wrappers for malloc and realloc. Use them. */
a4431563
WD
1173#define new(type) ((type*)malloc(sizeof (type)))
1174#define new0(type) ((type*)calloc(1, sizeof (type)))
1175#define new_array(type, num) ((type*)_new_array((num), sizeof (type), 0))
1176#define new_array0(type, num) ((type*)_new_array((num), sizeof (type), 1))
1177#define realloc_array(ptr, type, num) ((type*)_realloc_array((ptr), sizeof(type), (num)))
fb859e56 1178
e08bfe12 1179/* use magic gcc attributes to catch format errors */
ff41a59f 1180 void rprintf(enum logcode , const char *, ...)
fb859e56 1181 __attribute__((format (printf, 2, 3)))
e08bfe12 1182;
7b3d4257 1183
a039749b
MP
1184/* This is just like rprintf, but it also tries to print some
1185 * representation of the error code. Normally errcode = errno. */
1186void rsyserr(enum logcode, int, const char *, ...)
fb859e56 1187 __attribute__((format (printf, 3, 4)))
a039749b
MP
1188 ;
1189
afbcc8f2
WD
1190/* Make sure that the O_BINARY flag is defined. */
1191#ifndef O_BINARY
1192#define O_BINARY 0
1193#endif
5a788ade 1194
4f5b0756 1195#ifndef HAVE_STRLCPY
5a788ade
AT
1196size_t strlcpy(char *d, const char *s, size_t bufsize);
1197#endif
1198
4f5b0756 1199#ifndef HAVE_STRLCAT
5a788ade
AT
1200size_t strlcat(char *d, const char *s, size_t bufsize);
1201#endif
1202
82980a23
AT
1203#ifndef WEXITSTATUS
1204#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
1205#endif
47b032e9
WD
1206#ifndef WIFEXITED
1207#define WIFEXITED(stat) ((int)((stat)&0xFF) == 0)
1208#endif
82980a23 1209
a9766ef1 1210#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
eecd22ff 1211
4f5b0756 1212#ifdef HAVE_GETEUID
b2bffbb2
WD
1213#define MY_UID() geteuid()
1214#else
1215#define MY_UID() getuid()
1216#endif
1217
4f5b0756 1218#ifdef HAVE_GETEGID
b2bffbb2
WD
1219#define MY_GID() getegid()
1220#else
1221#define MY_GID() getgid()
1222#endif
eecd22ff 1223
aa0e6b99
WD
1224#ifdef FORCE_FD_ZERO_MEMSET
1225#undef FD_ZERO
1226#define FD_ZERO(fdsetp) memset(fdsetp, 0, sizeof (fd_set))
1227#endif
1228
951e826b
WD
1229extern short info_levels[], debug_levels[];
1230
1231#define INFO_GTE(flag, lvl) (info_levels[INFO_##flag] >= (lvl))
1232#define INFO_EQ(flag, lvl) (info_levels[INFO_##flag] == (lvl))
1233#define DEBUG_GTE(flag, lvl) (debug_levels[DEBUG_##flag] >= (lvl))
1234#define DEBUG_EQ(flag, lvl) (debug_levels[DEBUG_##flag] == (lvl))
1235
1236#define INFO_BACKUP 0
1237#define INFO_COPY (INFO_BACKUP+1)
1238#define INFO_DEL (INFO_COPY+1)
1239#define INFO_FLIST (INFO_DEL+1)
1240#define INFO_MISC (INFO_FLIST+1)
1241#define INFO_MOUNT (INFO_MISC+1)
1242#define INFO_NAME (INFO_MOUNT+1)
1243#define INFO_PROGRESS (INFO_NAME+1)
1244#define INFO_REMOVE (INFO_PROGRESS+1)
1245#define INFO_SKIP (INFO_REMOVE+1)
1246#define INFO_STATS (INFO_SKIP+1)
1247#define INFO_SYMSAFE (INFO_STATS+1)
1248
1249#define COUNT_INFO (INFO_SYMSAFE+1)
1250
1251#define DEBUG_ACL 0
1252#define DEBUG_BACKUP (DEBUG_ACL+1)
1253#define DEBUG_BIND (DEBUG_BACKUP+1)
1254#define DEBUG_CHDIR (DEBUG_BIND+1)
1255#define DEBUG_CONNECT (DEBUG_CHDIR+1)
5a18b34d 1256#define DEBUG_CMD (DEBUG_CONNECT+1)
951e826b 1257#define DEBUG_DEL (DEBUG_CMD+1)
5a18b34d
WD
1258#define DEBUG_DELTASUM (DEBUG_DEL+1)
1259#define DEBUG_DUP (DEBUG_DELTASUM+1)
951e826b
WD
1260#define DEBUG_EXIT (DEBUG_DUP+1)
1261#define DEBUG_FILTER (DEBUG_EXIT+1)
1262#define DEBUG_FLIST (DEBUG_FILTER+1)
1263#define DEBUG_FUZZY (DEBUG_FLIST+1)
1264#define DEBUG_GENR (DEBUG_FUZZY+1)
b3347e2a
WD
1265#define DEBUG_HASH (DEBUG_GENR+1)
1266#define DEBUG_HLINK (DEBUG_HASH+1)
951e826b 1267#define DEBUG_ICONV (DEBUG_HLINK+1)
20caffd2
WD
1268#define DEBUG_IO (DEBUG_ICONV+1)
1269#define DEBUG_OWN (DEBUG_IO+1)
951e826b
WD
1270#define DEBUG_PROTO (DEBUG_OWN+1)
1271#define DEBUG_RECV (DEBUG_PROTO+1)
1272#define DEBUG_SEND (DEBUG_RECV+1)
1273#define DEBUG_TIME (DEBUG_SEND+1)
1274
1275#define COUNT_DEBUG (DEBUG_TIME+1)
d5d4b282 1276
4f5b0756 1277#ifndef HAVE_INET_NTOP
d622d4bf 1278const char *inet_ntop(int af, const void *src, char *dst, size_t size);
4f5b0756 1279#endif
8f694072 1280
4f5b0756 1281#ifndef HAVE_INET_PTON
bda41fa5 1282int inet_pton(int af, const char *src, void *dst);
8f694072 1283#endif
0f0ea7f7 1284
f4a0483a
MP
1285#ifdef MAINTAINER_MODE
1286const char *get_panic_action(void);
1287#endif