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