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