rsync.h

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