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