rsync.h

   1 /*
   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-2007 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 version 2 as
   9  * published by the Free Software Foundation.
  10  *
  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.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #define False 0
  22 #define True 1
  23
  24 #define BLOCK_SIZE 700
  25 #define RSYNC_RSH_ENV "RSYNC_RSH"
  26 #define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
  27
  28 #define RSYNC_NAME "rsync"
  29 /* RSYNCD_SYSCONF is now set in config.h */
  30 #define RSYNCD_USERCONF "rsyncd.conf"
  31
  32 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
  33 #define URL_PREFIX "rsync://"
  34
  35 #define BACKUP_SUFFIX "~"
  36
  37 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
  38    incompatible with older versions :-( */
  39 #define CHAR_OFFSET 0
  40
  41 /* These flags are only used during the flist transfer. */
  42
  43 #define XMIT_TOP_DIR (1<<0)
  44 #define XMIT_SAME_MODE (1<<1)
  45 #define XMIT_SAME_RDEV_pre28 (1<<2)     /* protocols 20 - 27  */
  46 #define XMIT_EXTENDED_FLAGS (1<<2)      /* protocols 28 - NOW */
  47 #define XMIT_SAME_UID (1<<3)
  48 #define XMIT_SAME_GID (1<<4)
  49 #define XMIT_SAME_NAME (1<<5)
  50 #define XMIT_LONG_NAME (1<<6)
  51 #define XMIT_SAME_TIME (1<<7)
  52 #define XMIT_SAME_RDEV_MAJOR (1<<8)     /* protocols 28 - NOW */
  53 #define XMIT_HLINKED (1<<9)             /* protocols 28 - NOW */
  54 #define XMIT_SAME_DEV_pre30 (1<<10)     /* protocols 28 - 29  */
  55 #define XMIT_USER_NAME_FOLLOWS (1<<10)  /* protocols 30 - NOW */
  56 #define XMIT_RDEV_MINOR_8_pre30 (1<<11) /* protocols 28 - 29  */
  57 #define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - NOW */
  58 #define XMIT_HLINK_FIRST (1<<12)        /* protocols 30 - NOW */
  59
  60 /* These flags are used in the live flist data. */
  61
  62 #define FLAG_TOP_DIR (1<<0)     /* sender/receiver/generator */
  63 #define FLAG_FILE_SENT (1<<1)   /* sender/receiver/generator */
  64 #define FLAG_DIR_CHANGED (1<<1) /* generator */
  65 #define FLAG_XFER_DIR (1<<2)    /* sender/receiver/generator */
  66 #define FLAG_MOUNT_DIR (1<<3)   /* sender/generator */
  67 #define FLAG_MISSING_DIR (1<<4) /* generator */
  68 #define FLAG_HLINKED (1<<5)     /* receiver/generator */
  69 #define FLAG_HLINK_FIRST (1<<6) /* receiver/generator */
  70 #define FLAG_HLINK_LAST (1<<7)  /* receiver/generator */
  71 #define FLAG_HLINK_DONE (1<<8)  /* receiver/generator */
  72 #define FLAG_LENGTH64 (1<<9)    /* sender/receiver/generator */
  73
  74 /* These flags are passed to functions but not stored. */
  75
  76 #define FLAG_DIVERT_DIRS (1<<16)/* sender */
  77
  78 #define BITS_SET(val,bits) (((val) & (bits)) == (bits))
  79 #define BITS_SETnUNSET(val,onbits,offbits) (((val) & ((onbits)|(offbits))) == (onbits))
  80 #define BITS_EQUAL(b1,b2,mask) (((unsigned)(b1) & (unsigned)(mask)) \
  81                              == ((unsigned)(b2) & (unsigned)(mask)))
  82
  83 /* update this if you make incompatible changes */
  84 #define PROTOCOL_VERSION 30
  85
  86 /* This is used when working on a new protocol version in CVS, and should
  87  * be a new non-zero value for each CVS change that affects the protocol.
  88  * It must ALWAYS be 0 when the protocol goes final! */
  89 #define SUBPROTOCOL_VERSION 2
  90
  91 /* We refuse to interoperate with versions that are not in this range.
  92  * Note that we assume we'll work with later versions: the onus is on
  93  * people writing them to make sure that they don't send us anything
  94  * we won't understand.
  95  *
  96  * Interoperation with old but supported protocol versions
  97  * should cause a warning to be printed.  At a future date
  98  * the old protocol will become the minimum and
  99  * compatibility code removed.
 100  *
 101  * There are two possible explanations for the limit at
 102  * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
 103  * do not interoperate with us, and (more likely) so that we can
 104  * detect an attempt to connect rsync to a non-rsync server, which is
 105  * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
 106  * MAX_PROTOCOL_VERSION. */
 107
 108 #define MIN_PROTOCOL_VERSION 20
 109 #define OLD_PROTOCOL_VERSION 25
 110 #define MAX_PROTOCOL_VERSION 40
 111
 112 #define FILECNT_LOOKAHEAD 1000
 113
 114 #define RSYNC_PORT 873
 115
 116 #define SPARSE_WRITE_SIZE (1024)
 117 #define WRITE_SIZE (32*1024)
 118 #define CHUNK_SIZE (32*1024)
 119 #define MAX_MAP_SIZE (256*1024)
 120 #define IO_BUFFER_SIZE (4092)
 121 #define MAX_BLOCK_SIZE ((int32)1 << 29)
 122
 123 #define IOERR_GENERAL   (1<<0) /* For backward compatibility, this must == 1 */
 124 #define IOERR_VANISHED  (1<<1)
 125 #define IOERR_DEL_LIMIT (1<<2)
 126
 127 #define MAX_ARGS 1000
 128 #define MAX_BASIS_DIRS 20
 129 #define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
 130
 131 #define MPLEX_BASE 7
 132
 133 #define NO_FILTERS      0
 134 #define SERVER_FILTERS  1
 135 #define ALL_FILTERS     2
 136
 137 #define XFLG_FATAL_ERRORS       (1<<0)
 138 #define XFLG_OLD_PREFIXES       (1<<1)
 139 #define XFLG_ANCHORED2ABS       (1<<2)
 140 #define XFLG_ABS_IF_SLASH       (1<<3)
 141
 142 #define ATTRS_REPORT            (1<<0)
 143 #define ATTRS_SKIP_MTIME        (1<<1)
 144
 145 #define FULL_FLUSH      1
 146 #define NORMAL_FLUSH    0
 147
 148 #define PDIR_CREATE     1
 149 #define PDIR_DELETE     0
 150
 151 /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
 152 #define FNAMECMP_BASIS_DIR_LOW  0x00 /* Must remain 0! */
 153 #define FNAMECMP_BASIS_DIR_HIGH 0x7F
 154 #define FNAMECMP_FNAME          0x80
 155 #define FNAMECMP_PARTIAL_DIR    0x81
 156 #define FNAMECMP_BACKUP         0x82
 157 #define FNAMECMP_FUZZY          0x83
 158
 159 /* For use by the itemize_changes code */
 160 #define ITEM_REPORT_ATIME (1<<0)
 161 #define ITEM_REPORT_CHECKSUM (1<<1)
 162 #define ITEM_REPORT_SIZE (1<<2)
 163 #define ITEM_REPORT_TIME (1<<3)
 164 #define ITEM_REPORT_PERMS (1<<4)
 165 #define ITEM_REPORT_OWNER (1<<5)
 166 #define ITEM_REPORT_GROUP (1<<6)
 167 #define ITEM_REPORT_ACL (1<<7)
 168 #define ITEM_REPORT_XATTR (1<<8)
 169 #define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
 170 #define ITEM_XNAME_FOLLOWS (1<<12)
 171 #define ITEM_IS_NEW (1<<13)
 172 #define ITEM_LOCAL_CHANGE (1<<14)
 173 #define ITEM_TRANSFER (1<<15)
 174 /* These are outside the range of the transmitted flags. */
 175 #define ITEM_MISSING_DATA (1<<16)          /* used by log_formatted() */
 176 #define ITEM_DELETED (1<<17)               /* used by log_formatted() */
 177 #define ITEM_MATCHED (1<<18)               /* used by itemize() */
 178
 179 #define SIGNIFICANT_ITEM_FLAGS (~(\
 180         ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
 181
 182
 183 /* Log-message categories.  Only FERROR and FINFO get sent over the socket,
 184  * but FLOG and FSOCKERR can be sent over the receiver -> generator pipe.
 185  * FLOG only goes to the log file, not the client; FCLIENT is the opposite. */
 186 enum logcode { FNONE=0, FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FSOCKERR=5 };
 187
 188 /* Messages types that are sent over the message channel.  The logcode
 189  * values must all be present here with identical numbers. */
 190 enum msgcode {
 191         MSG_DATA=0,     /* raw data on the multiplexed stream */
 192         MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
 193         MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, MSG_SOCKERR=FSOCKERR, /* sibling logging */
 194         MSG_REDO=9,     /* reprocess indicated flist index */
 195         MSG_FLIST=20,   /* extra file list over sibling socket */
 196         MSG_FLIST_EOF=21,/* we've transmitted all the file lists */
 197         MSG_IO_ERROR=22,/* the sending side had an I/O error */
 198         MSG_NOOP=42,    /* a do-nothing message */
 199         MSG_SUCCESS=100,/* successfully updated indicated flist index */
 200         MSG_DELETED=101,/* successfully deleted a file on receiving side */
 201         MSG_NO_SEND=102,/* sender failed to open a file we wanted */
 202         MSG_DONE=86     /* current phase is done */
 203 };
 204
 205 #define NDX_DONE -1
 206 #define NDX_FLIST_EOF -2
 207 #define NDX_FLIST_OFFSET -101
 208
 209 #include "errcode.h"
 210
 211 #include "config.h"
 212
 213 /* The default RSYNC_RSH is always set in config.h. */
 214
 215 #include <stdio.h>
 216 #ifdef HAVE_SYS_TYPES_H
 217 # include <sys/types.h>
 218 #endif
 219 #ifdef HAVE_SYS_STAT_H
 220 # include <sys/stat.h>
 221 #endif
 222 #ifdef STDC_HEADERS
 223 # include <stdlib.h>
 224 # include <stddef.h>
 225 #else
 226 # ifdef HAVE_STDLIB_H
 227 #  include <stdlib.h>
 228 # endif
 229 #endif
 230 #ifdef HAVE_STRING_H
 231 # if !defined STDC_HEADERS && defined HAVE_MEMORY_H
 232 #  include <memory.h>
 233 # endif
 234 # include <string.h>
 235 #endif
 236 #ifdef HAVE_STRINGS_H
 237 # include <strings.h>
 238 #endif
 239 #ifdef HAVE_INTTYPES_H
 240 # include <inttypes.h>
 241 #endif
 242 #ifdef HAVE_UNISTD_H
 243 # include <unistd.h>
 244 #endif
 245
 246 #ifdef HAVE_SYS_PARAM_H
 247 #include <sys/param.h>
 248 #endif
 249
 250 #if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
 251 #include <malloc.h>
 252 #endif
 253
 254 #ifdef HAVE_SYS_SOCKET_H
 255 #include <sys/socket.h>
 256 #endif
 257
 258 #ifdef TIME_WITH_SYS_TIME
 259 #include <sys/time.h>
 260 #include <time.h>
 261 #else
 262 #ifdef HAVE_SYS_TIME_H
 263 #include <sys/time.h>
 264 #else
 265 #include <time.h>
 266 #endif
 267 #endif
 268
 269 #ifdef HAVE_FCNTL_H
 270 #include <fcntl.h>
 271 #else
 272 #ifdef HAVE_SYS_FCNTL_H
 273 #include <sys/fcntl.h>
 274 #endif
 275 #endif
 276
 277 #ifdef HAVE_SYS_IOCTL_H
 278 #include <sys/ioctl.h>
 279 #endif
 280
 281 #ifdef HAVE_SYS_FILIO_H
 282 #include <sys/filio.h>
 283 #endif
 284
 285 #include <signal.h>
 286 #ifdef HAVE_SYS_WAIT_H
 287 #include <sys/wait.h>
 288 #endif
 289 #ifdef HAVE_CTYPE_H
 290 #include <ctype.h>
 291 #endif
 292 #ifdef HAVE_GRP_H
 293 #include <grp.h>
 294 #endif
 295 #include <errno.h>
 296
 297 #ifdef HAVE_UTIME_H
 298 #include <utime.h>
 299 #endif
 300
 301 #ifdef HAVE_SYS_SELECT_H
 302 #include <sys/select.h>
 303 #endif
 304
 305 #ifdef HAVE_SYS_MODE_H
 306 /* apparently AIX needs this for S_ISLNK */
 307 #ifndef S_ISLNK
 308 #include <sys/mode.h>
 309 #endif
 310 #endif
 311
 312 #ifdef HAVE_GLOB_H
 313 #include <glob.h>
 314 #endif
 315
 316 /* these are needed for the uid/gid mapping code */
 317 #include <pwd.h>
 318 #include <grp.h>
 319
 320 #include <stdarg.h>
 321 #include <netinet/in.h>
 322 #include <arpa/inet.h>
 323 #include <netdb.h>
 324 #include <syslog.h>
 325 #include <sys/file.h>
 326
 327 #ifdef HAVE_DIRENT_H
 328 # include <dirent.h>
 329 #else
 330 # define dirent direct
 331 # ifdef HAVE_SYS_NDIR_H
 332 #  include <sys/ndir.h>
 333 # endif
 334 # ifdef HAVE_SYS_DIR_H
 335 #  include <sys/dir.h>
 336 # endif
 337 # ifdef HAVE_NDIR_H
 338 #  include <ndir.h>
 339 # endif
 340 #endif
 341
 342 #ifdef MAJOR_IN_MKDEV
 343 #include <sys/mkdev.h>
 344 # if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
 345 #  define makedev mkdev
 346 # endif
 347 #elif defined MAJOR_IN_SYSMACROS
 348 #include <sys/sysmacros.h>
 349 #endif
 350
 351 #ifdef MAKEDEV_TAKES_3_ARGS
 352 #define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
 353 #else
 354 #define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
 355 #endif
 356
 357 #ifdef HAVE_COMPAT_H
 358 #include <compat.h>
 359 #endif
 360
 361 #ifdef HAVE_LIMITS_H
 362 # include <limits.h>
 363 #endif
 364
 365 #include <assert.h>
 366
 367 #include "lib/pool_alloc.h"
 368
 369 #define BOOL int
 370
 371 #ifndef uchar
 372 #define uchar unsigned char
 373 #endif
 374
 375 #ifdef SIGNED_CHAR_OK
 376 #define schar signed char
 377 #else
 378 #define schar char
 379 #endif
 380
 381 #ifndef int16
 382 #if SIZEOF_INT16_T == 2
 383 # define int16 int16_t
 384 #else
 385 # define int16 short
 386 #endif
 387 #endif
 388
 389 #ifndef uint16
 390 #if SIZEOF_UINT16_T == 2
 391 # define uint16 uint16_t
 392 #else
 393 # define uint16 unsigned int16
 394 #endif
 395 #endif
 396
 397 /* Find a variable that is either exactly 32-bits or longer.
 398  * If some code depends on 32-bit truncation, it will need to
 399  * take special action in a "#if SIZEOF_INT32 > 4" section. */
 400 #ifndef int32
 401 #if SIZEOF_INT32_T == 4
 402 # define int32 int32_t
 403 # define SIZEOF_INT32 4
 404 #elif SIZEOF_INT == 4
 405 # define int32 int
 406 # define SIZEOF_INT32 4
 407 #elif SIZEOF_LONG == 4
 408 # define int32 long
 409 # define SIZEOF_INT32 4
 410 #elif SIZEOF_SHORT == 4
 411 # define int32 short
 412 # define SIZEOF_INT32 4
 413 #elif SIZEOF_INT > 4
 414 # define int32 int
 415 # define SIZEOF_INT32 SIZEOF_INT
 416 #elif SIZEOF_LONG > 4
 417 # define int32 long
 418 # define SIZEOF_INT32 SIZEOF_LONG
 419 #else
 420 # error Could not find a 32-bit integer variable
 421 #endif
 422 #else
 423 # define SIZEOF_INT32 4
 424 #endif
 425
 426 #ifndef uint32
 427 #if SIZEOF_UINT32_T == 4
 428 # define uint32 uint32_t
 429 #else
 430 # define uint32 unsigned int32
 431 #endif
 432 #endif
 433
 434 #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
 435 #define OFF_T off_t
 436 #define STRUCT_STAT struct stat
 437 #else
 438 #define OFF_T off64_t
 439 #define STRUCT_STAT struct stat64
 440 #define USE_STAT64_FUNCS 1
 441 #endif
 442
 443 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
 444  * that's the maximum size the file system can handle and there is no
 445  * 64-bit type available.  The rsync source must therefore take steps
 446  * to ensure that any code that really requires a 64-bit integer has
 447  * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
 448  * counter). */
 449 #if SIZEOF_INT64_T == 8
 450 # define int64 int64_t
 451 # define SIZEOF_INT64 8
 452 #elif SIZEOF_LONG == 8
 453 # define int64 long
 454 # define SIZEOF_INT64 8
 455 #elif SIZEOF_INT == 8
 456 # define int64 int
 457 # define SIZEOF_INT64 8
 458 #elif SIZEOF_LONG_LONG == 8
 459 # define int64 long long
 460 # define SIZEOF_INT64 8
 461 #elif SIZEOF_OFF64_T == 8
 462 # define int64 off64_t
 463 # define SIZEOF_INT64 8
 464 #elif SIZEOF_OFF_T == 8
 465 # define int64 off_t
 466 # define SIZEOF_INT64 8
 467 #elif SIZEOF_INT > 8
 468 # define int64 int
 469 # define SIZEOF_INT64 SIZEOF_INT
 470 #elif SIZEOF_LONG > 8
 471 # define int64 long
 472 # define SIZEOF_INT64 SIZEOF_LONG
 473 #elif SIZEOF_LONG_LONG > 8
 474 # define int64 long long
 475 # define SIZEOF_INT64 SIZEOF_LONG_LONG
 476 #else
 477 /* As long as it gets... */
 478 # define int64 off_t
 479 # define SIZEOF_INT64 SIZEOF_OFF_T
 480 #endif
 481
 482 /* Starting from protocol version 26, we always use 64-bit
 483  * ino_t and dev_t internally, even if this platform does not
 484  * allow files to have 64-bit inums.  That's because the
 485  * receiver needs to find duplicate (dev,ino) tuples to detect
 486  * hardlinks, and it might have files coming from a platform
 487  * that has 64-bit inums.
 488  *
 489  * The only exception is if we're on a platform with no 64-bit type at
 490  * all.
 491  *
 492  * Because we use read_longint() to get these off the wire, if you
 493  * transfer devices or hardlinks with dev or inum > 2**32 to a machine
 494  * with no 64-bit types then you will get an overflow error.  Probably
 495  * not many people have that combination of machines, and you can
 496  * avoid it by not preserving hardlinks or not transferring device
 497  * nodes.  It's not clear that any other behaviour is better.
 498  *
 499  * Note that if you transfer devices from a 64-bit-devt machine (say,
 500  * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
 501  * device numbers will be truncated.  But it's a kind of silly thing
 502  * to do anyhow.
 503  *
 504  * FIXME: I don't think the code in flist.c has ever worked on a system
 505  * where dev_t is a struct.
 506  */
 507
 508 struct idev_node {
 509         int64 key;
 510         void *data;
 511 };
 512
 513 #ifndef MIN
 514 #define MIN(a,b) ((a)<(b)?(a):(b))
 515 #endif
 516
 517 #ifndef MAX
 518 #define MAX(a,b) ((a)>(b)?(a):(b))
 519 #endif
 520
 521 #ifndef MAXHOSTNAMELEN
 522 #define MAXHOSTNAMELEN 256
 523 #endif
 524
 525 #define SUM_LENGTH 16
 526 #define SHORT_SUM_LENGTH 2
 527 #define BLOCKSUM_BIAS 10
 528
 529 #ifndef MAXPATHLEN
 530 #define MAXPATHLEN 1024
 531 #endif
 532
 533 /* We want a roomy line buffer that can hold more than MAXPATHLEN,
 534  * and significantly more than an overly short MAXPATHLEN. */
 535 #if MAXPATHLEN < 4096
 536 #define BIGPATHBUFLEN (4096+1024)
 537 #else
 538 #define BIGPATHBUFLEN (MAXPATHLEN+1024)
 539 #endif
 540
 541 #ifndef NAME_MAX
 542 #define NAME_MAX 255
 543 #endif
 544
 545 #ifndef INADDR_NONE
 546 #define INADDR_NONE 0xffffffff
 547 #endif
 548
 549 #ifndef IN_LOOPBACKNET
 550 #define IN_LOOPBACKNET 127
 551 #endif
 552
 553 #if HAVE_UNIXWARE_ACLS|HAVE_SOLARIS_ACLS|HAVE_HPUX_ACLS
 554 #define ACLS_NEED_MASK 1
 555 #endif
 556
 557 #define GID_NONE ((gid_t)-1)
 558
 559 union file_extras {
 560         int32 num;
 561         uint32 unum;
 562 };
 563
 564 struct file_struct {
 565         const char *dirname;    /* The dir info inside the transfer */
 566         time_t modtime;         /* When the item was last modified */
 567         uint32 len32;           /* Lowest 32 bits of the file's length */
 568         uint16 mode;            /* The item's type and permissions */
 569         uint16 flags;           /* The FLAG_* bits for this item */
 570         const char basename[1]; /* The basename (AKA filename) follows */
 571 };
 572
 573 extern int file_extra_cnt;
 574 extern int preserve_uid;
 575 extern int preserve_gid;
 576 extern int preserve_acls;
 577 extern int preserve_xattrs;
 578
 579 #define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
 580 #define EXTRA_LEN (sizeof (union file_extras))
 581 #define PTR_EXTRA_LEN ((sizeof (char *) + EXTRA_LEN - 1) / EXTRA_LEN)
 582 #define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
 583
 584 #define REQ_EXTRA(f,ndx) ((union file_extras*)(f) - (ndx))
 585 #define OPT_EXTRA(f,bump) ((union file_extras*)(f) - file_extra_cnt - 1 - (bump))
 586
 587 #define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
 588 #define HLINK_BUMP(f) (F_IS_HLINKED(f) ? 1 : 0)
 589
 590 /* The length applies to all items. */
 591 #if SIZEOF_INT64 < 8
 592 #define F_LENGTH(f) ((int64)(f)->len32)
 593 #else
 594 #define F_LENGTH(f) ((int64)(f)->len32 + ((f)->flags & FLAG_LENGTH64 \
 595                    ? (int64)OPT_EXTRA(f, 0)->unum << 32 : 0))
 596 #endif
 597
 598 /* If there is a symlink string, it is always right after the basename */
 599 #define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
 600
 601 /* The sending side always has this available: */
 602 #define F_ROOTDIR(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_LEN))
 603
 604 /* The receiving side always has this available: */
 605 #define F_DEPTH(f) REQ_EXTRA(f, 1)->num
 606
 607 /* When the associated option is on, all entries will have these present: */
 608 #define F_OWNER(f) REQ_EXTRA(f, preserve_uid)->unum
 609 #define F_GROUP(f) REQ_EXTRA(f, preserve_gid)->unum
 610 #define F_ACL(f) REQ_EXTRA(f, preserve_acls)->num
 611 #define F_XATTR(f) REQ_EXTRA(f, preserve_xattrs)->num
 612
 613 /* These items are per-entry optional and mutally exclusive: */
 614 #define F_HL_GNUM(f) OPT_EXTRA(f, LEN64_BUMP(f))->num
 615 #define F_HL_PREV(f) OPT_EXTRA(f, LEN64_BUMP(f))->num
 616 #define F_DEF_ACL(f) OPT_EXTRA(f, LEN64_BUMP(f))->unum
 617 #define F_DIRDEV_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + 2 - 1)->unum)
 618 #define F_DIRNODE_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + 3 - 1)->num)
 619
 620 /* This optional item might follow an F_HL_*() item.
 621  * (Note: a device doesn't need to check LEN64_BUMP(f).) */
 622 #define F_RDEV_P(f) (&OPT_EXTRA(f, HLINK_BUMP(f) + 2 - 1)->unum)
 623
 624 /* The sum is only present on regular files. */
 625 #define F_SUM(f) ((const char*)OPT_EXTRA(f, LEN64_BUMP(f) + HLINK_BUMP(f) \
 626                                           + SUM_EXTRA_CNT - 1))
 627
 628 /* Some utility defines: */
 629 #define F_IS_ACTIVE(f) (f)->basename[0]
 630 #define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
 631
 632 #define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
 633 #define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
 634
 635 #define F_UID(f) ((uid_t)F_OWNER(f))
 636 #define F_GID(f) ((gid_t)F_GROUP(f))
 637
 638 #define DEV_MAJOR(a) (a)[0]
 639 #define DEV_MINOR(a) (a)[1]
 640
 641 #define DIR_PARENT(a) (a)[0]
 642 #define DIR_FIRST_CHILD(a) (a)[1]
 643 #define DIR_NEXT_SIBLING(a) (a)[2]
 644
 645 /*
 646  * Start the flist array at FLIST_START entries and grow it
 647  * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
 648  */
 649 #define FLIST_START     (32 * 1024)
 650 #define FLIST_LINEAR    (FLIST_START * 512)
 651
 652 /*
 653  * Extent size for allocation pools: A minimum size of 128KB
 654  * is needed to mmap them so that freeing will release the
 655  * space to the OS.
 656  *
 657  * Larger sizes reduce leftover fragments and speed free calls
 658  * (when they happen). Smaller sizes increase the chance of
 659  * freed allocations freeing whole extents.
 660  */
 661 #define FILE_EXTENT     (256 * 1024)
 662 #define HLINK_EXTENT    (128 * 1024)
 663
 664 #define FLIST_TEMP      (1<<1)
 665
 666 struct file_list {
 667         struct file_list *next, *prev;
 668         struct file_struct **files;
 669         alloc_pool_t file_pool;
 670         int count, malloced;
 671         int low, high; /* 0-relative index values excluding empties */
 672         int ndx_start; /* the start offset for inc_recurse mode */
 673         int parent_ndx; /* dir_flist index of parent directory */
 674         int in_progress, to_redo;
 675 };
 676
 677 #define SUMFLG_SAME_OFFSET      (1<<0)
 678
 679 struct sum_buf {
 680         OFF_T offset;           /**< offset in file of this chunk */
 681         int32 len;              /**< length of chunk of file */
 682         uint32 sum1;            /**< simple checksum */
 683         int32 chain;            /**< next hash-table collision */
 684         short flags;            /**< flag bits */
 685         char sum2[SUM_LENGTH];  /**< checksum  */
 686 };
 687
 688 struct sum_struct {
 689         OFF_T flength;          /**< total file length */
 690         struct sum_buf *sums;   /**< points to info for each chunk */
 691         int32 count;            /**< how many chunks */
 692         int32 blength;          /**< block_length */
 693         int32 remainder;        /**< flength % block_length */
 694         int s2length;           /**< sum2_length */
 695 };
 696
 697 struct map_struct {
 698         OFF_T file_size;        /* File size (from stat)                */
 699         OFF_T p_offset;         /* Window start                         */
 700         OFF_T p_fd_offset;      /* offset of cursor in fd ala lseek     */
 701         char *p;                /* Window pointer                       */
 702         int32 p_size;           /* Largest window size we allocated     */
 703         int32 p_len;            /* Latest (rounded) window size         */
 704         int32 def_window_size;  /* Default window size                  */
 705         int fd;                 /* File Descriptor                      */
 706         int status;             /* first errno from read errors         */
 707 };
 708
 709 #define MATCHFLG_WILD           (1<<0) /* pattern has '*', '[', and/or '?' */
 710 #define MATCHFLG_WILD2          (1<<1) /* pattern has '**' */
 711 #define MATCHFLG_WILD2_PREFIX   (1<<2) /* pattern starts with "**" */
 712 #define MATCHFLG_WILD3_SUFFIX   (1<<3) /* pattern ends with "***" */
 713 #define MATCHFLG_ABS_PATH       (1<<4) /* path-match on absolute path */
 714 #define MATCHFLG_INCLUDE        (1<<5) /* this is an include, not an exclude */
 715 #define MATCHFLG_DIRECTORY      (1<<6) /* this matches only directories */
 716 #define MATCHFLG_WORD_SPLIT     (1<<7) /* split rules on whitespace */
 717 #define MATCHFLG_NO_INHERIT     (1<<8) /* don't inherit these rules */
 718 #define MATCHFLG_NO_PREFIXES    (1<<9) /* parse no prefixes from patterns */
 719 #define MATCHFLG_MERGE_FILE     (1<<10)/* specifies a file to merge */
 720 #define MATCHFLG_PERDIR_MERGE   (1<<11)/* merge-file is searched per-dir */
 721 #define MATCHFLG_EXCLUDE_SELF   (1<<12)/* merge-file name should be excluded */
 722 #define MATCHFLG_FINISH_SETUP   (1<<13)/* per-dir merge file needs setup */
 723 #define MATCHFLG_NEGATE         (1<<14)/* rule matches when pattern does not */
 724 #define MATCHFLG_CVS_IGNORE     (1<<15)/* rule was -C or :C */
 725 #define MATCHFLG_SENDER_SIDE    (1<<16)/* rule applies to the sending side */
 726 #define MATCHFLG_RECEIVER_SIDE  (1<<17)/* rule applies to the receiving side */
 727 #define MATCHFLG_CLEAR_LIST     (1<<18)/* this item is the "!" token */
 728 #define MATCHFLG_PERISHABLE     (1<<19)/* perishable if parent dir goes away */
 729
 730 #define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
 731                                 | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
 732                                 | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE \
 733                                 | MATCHFLG_PERISHABLE)
 734
 735 struct filter_struct {
 736         struct filter_struct *next;
 737         char *pattern;
 738         uint32 match_flags;
 739         union {
 740                 int slash_cnt;
 741                 struct filter_list_struct *mergelist;
 742         } u;
 743 };
 744
 745 struct filter_list_struct {
 746         struct filter_struct *head;
 747         struct filter_struct *tail;
 748         char *debug_type;
 749 };
 750
 751 struct stats {
 752         int64 total_size;
 753         int64 total_transferred_size;
 754         int64 total_written;
 755         int64 total_read;
 756         int64 literal_data;
 757         int64 matched_data;
 758         int64 flist_buildtime;
 759         int64 flist_xfertime;
 760         int64 flist_size;
 761         int num_files;
 762         int num_transferred_files;
 763         int current_file_index;
 764 };
 765
 766 struct chmod_mode_struct;
 767
 768 #define EMPTY_ITEM_LIST {NULL, 0, 0}
 769
 770 typedef struct {
 771         void *items;
 772         size_t count;
 773         size_t malloced;
 774 } item_list;
 775
 776 #define EXPAND_ITEM_LIST(lp, type, incr) \
 777         (type*)expand_item_list(lp, sizeof (type), #type, incr)
 778
 779 #include "byteorder.h"
 780 #include "lib/mdigest.h"
 781 #include "lib/wildmatch.h"
 782 #include "lib/permstring.h"
 783 #include "lib/addrinfo.h"
 784
 785 #ifndef __GNUC__
 786 #define __attribute__(x)
 787 #else
 788 # if __GNUC__ <= 2
 789 # define NORETURN
 790 # endif
 791 #endif
 792
 793 #define UNUSED(x) x __attribute__((__unused__))
 794 #ifndef NORETURN
 795 #define NORETURN __attribute__((__noreturn__))
 796 #endif
 797
 798 typedef struct {
 799     STRUCT_STAT st;
 800 #ifdef SUPPORT_ACLS
 801     struct rsync_acl *acc_acl; /* access ACL */
 802     struct rsync_acl *def_acl; /* default ACL */
 803 #endif
 804 #ifdef SUPPORT_XATTRS
 805     item_list *xattr;
 806 #endif
 807 } statx;
 808
 809 #define ACL_READY(sx) ((sx).acc_acl != NULL)
 810 #define XATTR_READY(sx) ((sx).xattr != NULL)
 811
 812 #include "proto.h"
 813
 814 /* We have replacement versions of these if they're missing. */
 815 #ifndef HAVE_ASPRINTF
 816 int asprintf(char **ptr, const char *format, ...);
 817 #endif
 818
 819 #ifndef HAVE_VASPRINTF
 820 int vasprintf(char **ptr, const char *format, va_list ap);
 821 #endif
 822
 823 #if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
 824 #define vsnprintf rsync_vsnprintf
 825 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
 826 #endif
 827
 828 #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
 829 #define snprintf rsync_snprintf
 830 int snprintf(char *str, size_t count, const char *fmt,...);
 831 #endif
 832
 833
 834 #ifndef HAVE_STRERROR
 835 extern char *sys_errlist[];
 836 #define strerror(i) sys_errlist[i]
 837 #endif
 838
 839 #ifndef HAVE_STRCHR
 840 # define strchr                 index
 841 # define strrchr                rindex
 842 #endif
 843
 844 #ifndef HAVE_ERRNO_DECL
 845 extern int errno;
 846 #endif
 847
 848 #ifdef HAVE_READLINK
 849 #define SUPPORT_LINKS 1
 850 #endif
 851 #ifdef HAVE_LINK
 852 #define SUPPORT_HARD_LINKS 1
 853 #endif
 854
 855 #ifdef HAVE_SIGACTION
 856 #define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
 857 #define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
 858 #else
 859 #define SIGACTION(n,h) signal(n,h)
 860 #endif
 861
 862 #ifndef EWOULDBLOCK
 863 #define EWOULDBLOCK EAGAIN
 864 #endif
 865
 866 #ifndef STDIN_FILENO
 867 #define STDIN_FILENO 0
 868 #endif
 869
 870 #ifndef STDOUT_FILENO
 871 #define STDOUT_FILENO 1
 872 #endif
 873
 874 #ifndef STDERR_FILENO
 875 #define STDERR_FILENO 2
 876 #endif
 877
 878 #ifndef S_IRUSR
 879 #define S_IRUSR 0400
 880 #endif
 881
 882 #ifndef S_IWUSR
 883 #define S_IWUSR 0200
 884 #endif
 885
 886 #ifndef ACCESSPERMS
 887 #define ACCESSPERMS 0777
 888 #endif
 889
 890 #ifndef S_ISVTX
 891 #define S_ISVTX 0
 892 #endif
 893
 894 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
 895
 896 #ifndef _S_IFMT
 897 #define _S_IFMT        0170000
 898 #endif
 899
 900 #ifndef _S_IFLNK
 901 #define _S_IFLNK  0120000
 902 #endif
 903
 904 #ifndef S_ISLNK
 905 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
 906 #endif
 907
 908 #ifndef S_ISBLK
 909 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
 910 #endif
 911
 912 #ifndef S_ISCHR
 913 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
 914 #endif
 915
 916 #ifndef S_ISSOCK
 917 #ifdef _S_IFSOCK
 918 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
 919 #else
 920 #define S_ISSOCK(mode) (0)
 921 #endif
 922 #endif
 923
 924 #ifndef S_ISFIFO
 925 #ifdef _S_IFIFO
 926 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
 927 #else
 928 #define S_ISFIFO(mode) (0)
 929 #endif
 930 #endif
 931
 932 #ifndef S_ISDIR
 933 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
 934 #endif
 935
 936 #ifndef S_ISREG
 937 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
 938 #endif
 939
 940 /* work out what fcntl flag to use for non-blocking */
 941 #ifdef O_NONBLOCK
 942 # define NONBLOCK_FLAG O_NONBLOCK
 943 #elif defined SYSV
 944 # define NONBLOCK_FLAG O_NDELAY
 945 #else
 946 # define NONBLOCK_FLAG FNDELAY
 947 #endif
 948
 949 #ifndef INADDR_LOOPBACK
 950 #define INADDR_LOOPBACK 0x7f000001
 951 #endif
 952
 953 #ifndef INADDR_NONE
 954 #define INADDR_NONE 0xffffffff
 955 #endif
 956
 957 #define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
 958 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
 959
 960 /* Initial mask on permissions given to temporary files.  Mask off setuid
 961      bits and group access because of potential race-condition security
 962      holes, and mask other access because mode 707 is bizarre */
 963 #define INITACCESSPERMS 0700
 964
 965 /* handler for null strings in printf format */
 966 #define NS(s) ((s)?(s):"<NULL>")
 967
 968 /* Convenient wrappers for malloc and realloc.  Use them. */
 969 #define new(type) ((type *)malloc(sizeof(type)))
 970 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
 971 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
 972
 973 /* use magic gcc attributes to catch format errors */
 974  void rprintf(enum logcode , const char *, ...)
 975      __attribute__((format (printf, 2, 3)))
 976 ;
 977
 978 /* This is just like rprintf, but it also tries to print some
 979  * representation of the error code.  Normally errcode = errno. */
 980 void rsyserr(enum logcode, int, const char *, ...)
 981      __attribute__((format (printf, 3, 4)))
 982      ;
 983
 984 /* Make sure that the O_BINARY flag is defined. */
 985 #ifndef O_BINARY
 986 #define O_BINARY 0
 987 #endif
 988
 989 #ifndef HAVE_STRLCPY
 990 size_t strlcpy(char *d, const char *s, size_t bufsize);
 991 #endif
 992
 993 #ifndef HAVE_STRLCAT
 994 size_t strlcat(char *d, const char *s, size_t bufsize);
 995 #endif
 996
 997 #ifndef WEXITSTATUS
 998 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
 999 #endif
1000 #ifndef WIFEXITED
1001 #define WIFEXITED(stat)         ((int)((stat)&0xFF) == 0)
1002 #endif
1003
1004 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
1005
1006 #ifdef HAVE_GETEUID
1007 #define MY_UID() geteuid()
1008 #else
1009 #define MY_UID() getuid()
1010 #endif
1011
1012 #ifdef HAVE_GETEGID
1013 #define MY_GID() getegid()
1014 #else
1015 #define MY_GID() getgid()
1016 #endif
1017
1018 extern int verbose;
1019
1020 #ifndef HAVE_INET_NTOP
1021 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
1022 #endif
1023
1024 #ifndef HAVE_INET_PTON
1025 int inet_pton(int af, const char *src, void *dst);
1026 #endif
1027
1028 #ifdef MAINTAINER_MODE
1029 const char *get_panic_action(void);
1030 #endif
1031
1032 static inline int
1033 isDigit(const char *ptr)
1034 {
1035         return isdigit(*(unsigned char *)ptr);
1036 }
1037
1038 static inline int
1039 isPrint(const char *ptr)
1040 {
1041         return isprint(*(unsigned char *)ptr);
1042 }
1043
1044 static inline int
1045 isSpace(const char *ptr)
1046 {
1047         return isspace(*(unsigned char *)ptr);
1048 }
1049
1050 static inline int
1051 isLower(const char *ptr)
1052 {
1053         return islower(*(unsigned char *)ptr);
1054 }
1055
1056 static inline int
1057 isUpper(const char *ptr)
1058 {
1059         return isupper(*(unsigned char *)ptr);
1060 }
1061
1062 static inline int
1063 toLower(const char *ptr)
1064 {
1065         return tolower(*(unsigned char *)ptr);
1066 }
1067
1068 static inline int
1069 toUpper(const char *ptr)
1070 {
1071         return toupper(*(unsigned char *)ptr);
1072 }