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