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