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