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