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