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