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