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