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