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