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