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