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