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-2020 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 3 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, visit the http://fsf.org website.
  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 SYMLINK_PREFIX "/rsyncd-munged/"  /* This MUST have a trailing slash! */
  36 #define SYMLINK_PREFIX_LEN ((int)sizeof SYMLINK_PREFIX - 1)
  37
  38 #define BACKUP_SUFFIX "~"
  39
  40 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
  41    incompatible with older versions :-( */
  42 #define CHAR_OFFSET 0
  43
  44 /* These flags are only used during the flist transfer. */
  45
  46 #define XMIT_TOP_DIR (1<<0)
  47 #define XMIT_SAME_MODE (1<<1)
  48 #define XMIT_SAME_RDEV_pre28 (1<<2)     /* protocols 20 - 27  */
  49 #define XMIT_EXTENDED_FLAGS (1<<2)      /* protocols 28 - now */
  50 #define XMIT_SAME_UID (1<<3)
  51 #define XMIT_SAME_GID (1<<4)
  52 #define XMIT_SAME_NAME (1<<5)
  53 #define XMIT_LONG_NAME (1<<6)
  54 #define XMIT_SAME_TIME (1<<7)
  55
  56 #define XMIT_SAME_RDEV_MAJOR (1<<8)     /* protocols 28 - now (devices only) */
  57 #define XMIT_NO_CONTENT_DIR (1<<8)      /* protocols 30 - now (dirs only) */
  58 #define XMIT_HLINKED (1<<9)             /* protocols 28 - now (non-dirs) */
  59 #define XMIT_SAME_DEV_pre30 (1<<10)     /* protocols 28 - 29  */
  60 #define XMIT_USER_NAME_FOLLOWS (1<<10)  /* protocols 30 - now */
  61 #define XMIT_RDEV_MINOR_8_pre30 (1<<11) /* protocols 28 - 29  */
  62 #define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - now */
  63 #define XMIT_HLINK_FIRST (1<<12)        /* protocols 30 - now (HLINKED files only) */
  64 #define XMIT_IO_ERROR_ENDLIST (1<<12)   /* protocols 31*- now (w/XMIT_EXTENDED_FLAGS) (also protocol 30 w/'f' compat flag) */
  65 #define XMIT_MOD_NSEC (1<<13)           /* protocols 31 - now */
  66 #define XMIT_SAME_ATIME (1<<14)         /* any protocol - restricted by command-line option */
  67 #define XMIT_UNUSED_15 (1<<15)          /* unused flag bit */
  68
  69 /* The following XMIT flags require an rsync that uses a varint for the flag values */
  70
  71 #define XMIT_RESERVED_16 (1<<16)        /* reserved for future fileflags use */
  72 #define XMIT_RESERVED_17 (1<<17)        /* reserved for future crtimes use */
  73
  74 /* These flags are used in the live flist data. */
  75
  76 #define FLAG_TOP_DIR (1<<0)     /* sender/receiver/generator */
  77 #define FLAG_OWNED_BY_US (1<<0) /* generator: set by make_file() for aux flists only */
  78 #define FLAG_FILE_SENT (1<<1)   /* sender/receiver/generator */
  79 #define FLAG_DIR_CREATED (1<<1) /* generator */
  80 #define FLAG_CONTENT_DIR (1<<2) /* sender/receiver/generator */
  81 #define FLAG_MOUNT_DIR (1<<3)   /* sender/generator (dirs only) */
  82 #define FLAG_SKIP_HLINK (1<<3)  /* receiver/generator (w/FLAG_HLINKED) */
  83 #define FLAG_DUPLICATE (1<<4)   /* sender */
  84 #define FLAG_MISSING_DIR (1<<4) /* generator */
  85 #define FLAG_HLINKED (1<<5)     /* receiver/generator (checked on all types) */
  86 #define FLAG_HLINK_FIRST (1<<6) /* receiver/generator (w/FLAG_HLINKED) */
  87 #define FLAG_IMPLIED_DIR (1<<6) /* sender/receiver/generator (dirs only) */
  88 #define FLAG_HLINK_LAST (1<<7)  /* receiver/generator */
  89 #define FLAG_HLINK_DONE (1<<8)  /* receiver/generator (checked on all types) */
  90 #define FLAG_LENGTH64 (1<<9)    /* sender/receiver/generator */
  91 #define FLAG_SKIP_GROUP (1<<10) /* receiver/generator */
  92 #define FLAG_TIME_FAILED (1<<11)/* generator */
  93 #define FLAG_MOD_NSEC (1<<12)   /* sender/receiver/generator */
  94
  95 /* These flags are passed to functions but not stored. */
  96
  97 #define FLAG_DIVERT_DIRS (1<<16)   /* sender, but must be unique */
  98 #define FLAG_PERHAPS_DIR (1<<17)   /* generator */
  99
 100 /* These flags are for get_dirlist(). */
 101 #define GDL_IGNORE_FILTER_RULES (1<<0)
 102 #define GDL_PERHAPS_DIR (1<<1)
 103
 104 /* Some helper macros for matching bits. */
 105 #define BITS_SET(val,bits) (((val) & (bits)) == (bits))
 106 #define BITS_SETnUNSET(val,onbits,offbits) (((val) & ((onbits)|(offbits))) == (onbits))
 107 #define BITS_EQUAL(b1,b2,mask) (((unsigned)(b1) & (unsigned)(mask)) \
 108                              == ((unsigned)(b2) & (unsigned)(mask)))
 109
 110 /* update this if you make incompatible changes */
 111 #define PROTOCOL_VERSION 31
 112
 113 /* This is used when working on a new protocol version in CVS, and should
 114  * be a new non-zero value for each CVS change that affects the protocol.
 115  * It must ALWAYS be 0 when the protocol goes final (and NEVER before)! */
 116 #define SUBPROTOCOL_VERSION 0
 117
 118 /* We refuse to interoperate with versions that are not in this range.
 119  * Note that we assume we'll work with later versions: the onus is on
 120  * people writing them to make sure that they don't send us anything
 121  * we won't understand.
 122  *
 123  * Interoperation with old but supported protocol versions
 124  * should cause a warning to be printed.  At a future date
 125  * the old protocol will become the minimum and
 126  * compatibility code removed.
 127  *
 128  * There are two possible explanations for the limit at
 129  * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
 130  * do not interoperate with us, and (more likely) so that we can
 131  * detect an attempt to connect rsync to a non-rsync server, which is
 132  * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
 133  * MAX_PROTOCOL_VERSION. */
 134
 135 #define MIN_PROTOCOL_VERSION 20
 136 #define OLD_PROTOCOL_VERSION 25
 137 #define MAX_PROTOCOL_VERSION 40
 138
 139 #define MIN_FILECNT_LOOKAHEAD 1000
 140 #define MAX_FILECNT_LOOKAHEAD 10000
 141
 142 #define RSYNC_PORT 873
 143
 144 #define SPARSE_WRITE_SIZE (1024)
 145 #define WRITE_SIZE (32*1024)
 146 #define CHUNK_SIZE (32*1024)
 147 #define MAX_MAP_SIZE (256*1024)
 148 #define IO_BUFFER_SIZE (32*1024)
 149 #define MAX_BLOCK_SIZE ((int32)1 << 17)
 150
 151 /* For compatibility with older rsyncs */
 152 #define OLD_MAX_BLOCK_SIZE ((int32)1 << 29)
 153
 154 #define ROUND_UP_1024(siz) ((siz) & (1024-1) ? ((siz) | (1024-1)) + 1 : (siz))
 155
 156 #define IOERR_GENERAL   (1<<0) /* For backward compatibility, this must == 1 */
 157 #define IOERR_VANISHED  (1<<1)
 158 #define IOERR_DEL_LIMIT (1<<2)
 159
 160 #define MAX_ARGS 1000
 161 #define MAX_BASIS_DIRS 20
 162 #define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
 163
 164 #define MPLEX_BASE 7
 165
 166 #define NO_FILTERS      0
 167 #define SERVER_FILTERS  1
 168 #define ALL_FILTERS     2
 169
 170 #define XFLG_FATAL_ERRORS       (1<<0)
 171 #define XFLG_OLD_PREFIXES       (1<<1)
 172 #define XFLG_ANCHORED2ABS       (1<<2) /* leading slash indicates absolute */
 173 #define XFLG_ABS_IF_SLASH       (1<<3) /* leading or interior slash is absolute */
 174 #define XFLG_DIR2WILD3          (1<<4) /* dir/ match gets trailing *** added */
 175
 176 #define ATTRS_REPORT            (1<<0)
 177 #define ATTRS_SKIP_MTIME        (1<<1)
 178 #define ATTRS_SET_NANO          (1<<2)
 179 #define ATTRS_SKIP_ATIME        (1<<3)
 180
 181 #define MSG_FLUSH       2
 182 #define FULL_FLUSH      1
 183 #define NORMAL_FLUSH    0
 184
 185 #define PDIR_CREATE     1
 186 #define PDIR_DELETE     0
 187
 188 /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
 189 #define FNAMECMP_BASIS_DIR_LOW  0x00 /* Must remain 0! */
 190 #define FNAMECMP_BASIS_DIR_HIGH 0x7F
 191 #define FNAMECMP_FNAME          0x80
 192 #define FNAMECMP_PARTIAL_DIR    0x81
 193 #define FNAMECMP_BACKUP         0x82
 194 #define FNAMECMP_FUZZY          0x83
 195
 196 /* For use by the itemize_changes code */
 197 #define ITEM_REPORT_ATIME (1<<0)
 198 #define ITEM_REPORT_CHANGE (1<<1)
 199 #define ITEM_REPORT_SIZE (1<<2)     /* regular files only */
 200 #define ITEM_REPORT_TIMEFAIL (1<<2) /* symlinks only */
 201 #define ITEM_REPORT_TIME (1<<3)
 202 #define ITEM_REPORT_PERMS (1<<4)
 203 #define ITEM_REPORT_OWNER (1<<5)
 204 #define ITEM_REPORT_GROUP (1<<6)
 205 #define ITEM_REPORT_ACL (1<<7)
 206 #define ITEM_REPORT_XATTR (1<<8)
 207 #define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
 208 #define ITEM_XNAME_FOLLOWS (1<<12)
 209 #define ITEM_IS_NEW (1<<13)
 210 #define ITEM_LOCAL_CHANGE (1<<14)
 211 #define ITEM_TRANSFER (1<<15)
 212 /* These are outside the range of the transmitted flags. */
 213 #define ITEM_MISSING_DATA (1<<16)          /* used by log_formatted() */
 214 #define ITEM_DELETED (1<<17)               /* used by log_formatted() */
 215 #define ITEM_MATCHED (1<<18)               /* used by itemize() */
 216
 217 #define SIGNIFICANT_ITEM_FLAGS (~(\
 218         ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
 219
 220 #define CFN_KEEP_DOT_DIRS (1<<0)
 221 #define CFN_KEEP_TRAILING_SLASH (1<<1)
 222 #define CFN_DROP_TRAILING_DOT_DIR (1<<2)
 223 #define CFN_COLLAPSE_DOT_DOT_DIRS (1<<3)
 224 #define CFN_REFUSE_DOT_DOT_DIRS (1<<4)
 225
 226 #define SP_DEFAULT 0
 227 #define SP_KEEP_DOT_DIRS (1<<0)
 228
 229 #define CD_NORMAL 0
 230 #define CD_SKIP_CHDIR 1
 231
 232 /* Log-message categories.  FLOG only goes to the log file, not the client;
 233  * FCLIENT is the opposite. */
 234 enum logcode {
 235     FNONE=0, /* never sent */
 236     FERROR_XFER=1, FINFO=2, /* sent over socket for any protocol */
 237     FERROR=3, FWARNING=4, /* sent over socket for protocols >= 30 */
 238     FERROR_SOCKET=5, FLOG=6, /* only sent via receiver -> generator pipe */
 239     FERROR_UTF8=8, /* only sent via receiver -> generator pipe */
 240     FCLIENT=7 /* never transmitted (e.g. server converts to FINFO) */
 241 };
 242
 243 /* Messages types that are sent over the message channel.  The logcode
 244  * values must all be present here with identical numbers. */
 245 enum msgcode {
 246         MSG_DATA=0,     /* raw data on the multiplexed stream */
 247         MSG_ERROR_XFER=FERROR_XFER, MSG_INFO=FINFO, /* remote logging */
 248         MSG_ERROR=FERROR, MSG_WARNING=FWARNING, /* protocol-30 remote logging */
 249         MSG_ERROR_SOCKET=FERROR_SOCKET, /* sibling logging */
 250         MSG_ERROR_UTF8=FERROR_UTF8, /* sibling logging */
 251         MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, /* sibling logging */
 252         MSG_REDO=9,     /* reprocess indicated flist index */
 253         MSG_STATS=10,   /* message has stats data for generator */
 254         MSG_IO_ERROR=22,/* the sending side had an I/O error */
 255         MSG_IO_TIMEOUT=33,/* tell client about a daemon's timeout value */
 256         MSG_NOOP=42,    /* a do-nothing message (legacy protocol-30 only) */
 257         MSG_ERROR_EXIT=86, /* synchronize an error exit (siblings and protocol >= 31) */
 258         MSG_SUCCESS=100,/* successfully updated indicated flist index */
 259         MSG_DELETED=101,/* successfully deleted a file on receiving side */
 260         MSG_NO_SEND=102,/* sender failed to open a file we wanted */
 261 };
 262
 263 #define NDX_DONE -1
 264 #define NDX_FLIST_EOF -2
 265 #define NDX_DEL_STATS -3
 266 #define NDX_FLIST_OFFSET -101
 267
 268 /* For calling delete_item() and delete_dir_contents(). */
 269 #define DEL_NO_UID_WRITE        (1<<0) /* file/dir has our uid w/o write perm */
 270 #define DEL_RECURSE             (1<<1) /* if dir, delete all contents */
 271 #define DEL_DIR_IS_EMPTY        (1<<2) /* internal delete_FUNCTIONS use only */
 272 #define DEL_FOR_FILE            (1<<3) /* making room for a replacement file */
 273 #define DEL_FOR_DIR             (1<<4) /* making room for a replacement dir */
 274 #define DEL_FOR_SYMLINK         (1<<5) /* making room for a replacement symlink */
 275 #define DEL_FOR_DEVICE          (1<<6) /* making room for a replacement device */
 276 #define DEL_FOR_SPECIAL         (1<<7) /* making room for a replacement special */
 277 #define DEL_FOR_BACKUP          (1<<8) /* the delete is for a backup operation */
 278
 279 #define DEL_MAKE_ROOM (DEL_FOR_FILE|DEL_FOR_DIR|DEL_FOR_SYMLINK|DEL_FOR_DEVICE|DEL_FOR_SPECIAL)
 280
 281 enum delret {
 282         DR_SUCCESS = 0, DR_FAILURE, DR_AT_LIMIT, DR_NOT_EMPTY
 283 };
 284
 285 /* Defines for make_path() */
 286 #define MKP_DROP_NAME           (1<<0) /* drop trailing filename or trailing slash */
 287 #define MKP_SKIP_SLASH          (1<<1) /* skip one or more leading slashes */
 288
 289 /* Defines for maybe_send_keepalive() */
 290 #define MSK_ALLOW_FLUSH         (1<<0)
 291 #define MSK_ACTIVE_RECEIVER     (1<<1)
 292
 293 #include "errcode.h"
 294
 295 #include "config.h"
 296
 297 /* The default RSYNC_RSH is always set in config.h. */
 298
 299 #include <stdio.h>
 300 #ifdef HAVE_SYS_TYPES_H
 301 # include <sys/types.h>
 302 #endif
 303 #ifdef HAVE_SYS_STAT_H
 304 # include <sys/stat.h>
 305 #endif
 306 #ifdef STDC_HEADERS
 307 # include <stdlib.h>
 308 # include <stddef.h>
 309 #else
 310 # ifdef HAVE_STDLIB_H
 311 #  include <stdlib.h>
 312 # endif
 313 #endif
 314 #ifdef HAVE_STRING_H
 315 # if !defined STDC_HEADERS && defined HAVE_MEMORY_H
 316 #  include <memory.h>
 317 # endif
 318 # include <string.h>
 319 #endif
 320 #ifdef HAVE_STRINGS_H
 321 # include <strings.h>
 322 #endif
 323 #ifdef HAVE_INTTYPES_H
 324 # include <inttypes.h>
 325 #endif
 326 #ifdef HAVE_STDINT_H
 327 # include <stdint.h>
 328 #endif
 329 #ifdef HAVE_UNISTD_H
 330 # include <unistd.h>
 331 #endif
 332
 333 #ifdef HAVE_SYS_PARAM_H
 334 #include <sys/param.h>
 335 #endif
 336
 337 #if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
 338 #include <malloc.h>
 339 #endif
 340
 341 #ifdef HAVE_SYS_SOCKET_H
 342 #include <sys/socket.h>
 343 #endif
 344
 345 #ifdef TIME_WITH_SYS_TIME
 346 #include <sys/time.h>
 347 #include <time.h>
 348 #else
 349 #ifdef HAVE_SYS_TIME_H
 350 #include <sys/time.h>
 351 #else
 352 #include <time.h>
 353 #endif
 354 #endif
 355
 356 #ifdef HAVE_FCNTL_H
 357 #include <fcntl.h>
 358 #else
 359 #ifdef HAVE_SYS_FCNTL_H
 360 #include <sys/fcntl.h>
 361 #endif
 362 #endif
 363
 364 #ifdef HAVE_SYS_IOCTL_H
 365 #include <sys/ioctl.h>
 366 #endif
 367
 368 #ifdef HAVE_SYS_FILIO_H
 369 #include <sys/filio.h>
 370 #endif
 371
 372 #include <signal.h>
 373 #ifdef HAVE_SYS_WAIT_H
 374 #include <sys/wait.h>
 375 #endif
 376 #ifdef HAVE_CTYPE_H
 377 #include <ctype.h>
 378 #endif
 379 #ifdef HAVE_GRP_H
 380 #include <grp.h>
 381 #endif
 382 #include <errno.h>
 383
 384 #ifdef HAVE_UTIME_H
 385 #include <utime.h>
 386 #endif
 387
 388 #if defined HAVE_UTIMENSAT || defined HAVE_LUTIMES || defined HAVE_SETATTRLIST
 389 #define CAN_SET_SYMLINK_TIMES 1
 390 #endif
 391
 392 #if defined HAVE_LCHOWN || defined CHOWN_MODIFIES_SYMLINK
 393 #define CAN_CHOWN_SYMLINK 1
 394 #endif
 395
 396 #if defined HAVE_LCHMOD || defined HAVE_SETATTRLIST
 397 #define CAN_CHMOD_SYMLINK 1
 398 #endif
 399
 400 #if defined HAVE_UTIMENSAT || defined HAVE_SETATTRLIST
 401 #define CAN_SET_NSEC 1
 402 #endif
 403
 404 #ifdef CAN_SET_NSEC
 405 #ifdef HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 406 #define ST_MTIME_NSEC st_mtim.tv_nsec
 407 #define ST_ATIME_NSEC st_atim.tv_nsec
 408 #elif defined(HAVE_STRUCT_STAT_ST_MTIMENSEC)
 409 #define ST_MTIME_NSEC st_mtimensec
 410 #define ST_ATIME_NSEC st_atimensec
 411 #elif defined(HAVE_STRUCT_STAT_ST_MTIMESPEC_TV_NSEC)
 412 #define ST_MTIME_NSEC st_mtimespec.tv_nsec
 413 #define ST_ATIME_NSEC st_atimespec.tv_nsec
 414 #endif
 415 #endif
 416
 417 #ifdef HAVE_SYS_SELECT_H
 418 #include <sys/select.h>
 419 #endif
 420
 421 #ifdef HAVE_SYS_MODE_H
 422 /* apparently AIX needs this for S_ISLNK */
 423 #ifndef S_ISLNK
 424 #include <sys/mode.h>
 425 #endif
 426 #endif
 427
 428 /* these are needed for the uid/gid mapping code */
 429 #include <pwd.h>
 430 #include <grp.h>
 431
 432 #include <stdarg.h>
 433 #include <netinet/in.h>
 434 #include <arpa/inet.h>
 435 #ifdef HAVE_NETDB_H
 436 #include <netdb.h>
 437 #endif
 438 #include <syslog.h>
 439 #include <sys/file.h>
 440
 441 #ifdef HAVE_DIRENT_H
 442 # include <dirent.h>
 443 #else
 444 # define dirent direct
 445 # ifdef HAVE_SYS_NDIR_H
 446 #  include <sys/ndir.h>
 447 # endif
 448 # ifdef HAVE_SYS_DIR_H
 449 #  include <sys/dir.h>
 450 # endif
 451 # ifdef HAVE_NDIR_H
 452 #  include <ndir.h>
 453 # endif
 454 #endif
 455
 456 #ifdef MAJOR_IN_MKDEV
 457 #include <sys/mkdev.h>
 458 # if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
 459 #  define makedev mkdev
 460 # endif
 461 #elif defined MAJOR_IN_SYSMACROS
 462 #include <sys/sysmacros.h>
 463 #endif
 464
 465 #ifdef MAKEDEV_TAKES_3_ARGS
 466 #define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
 467 #else
 468 #define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
 469 #endif
 470
 471 #ifdef HAVE_COMPAT_H
 472 #include <compat.h>
 473 #endif
 474
 475 #ifdef HAVE_LIMITS_H
 476 # include <limits.h>
 477 #endif
 478
 479 #if defined USE_ICONV_OPEN && defined HAVE_ICONV_H
 480 #include <iconv.h>
 481 #ifndef ICONV_CONST
 482 #define ICONV_CONST
 483 #endif
 484 #else
 485 #ifdef ICONV_CONST
 486 #undef ICONV_CONST
 487 #endif
 488 #ifdef ICONV_OPTION
 489 #undef ICONV_OPTION
 490 #endif
 491 #ifdef iconv_t
 492 #undef iconv_t
 493 #endif
 494 #define iconv_t int
 495 #endif
 496
 497 #include <assert.h>
 498
 499 #include "lib/pool_alloc.h"
 500
 501 #ifndef HAVE_ID_T
 502 typedef unsigned int id_t;
 503 #endif
 504 #ifndef HAVE_PID_T
 505 typedef int pid_t;
 506 #endif
 507 #ifndef HAVE_MODE_T
 508 typedef unsigned int mode_t;
 509 #endif
 510 #ifndef HAVE_OFF_T
 511 typedef long off_t;
 512 #undef SIZEOF_OFF_T
 513 #define SIZEOF_OFF_T SIZEOF_LONG
 514 #endif
 515 #ifndef HAVE_SIZE_T
 516 typedef unsigned int size_t;
 517 #endif
 518
 519 #define BOOL int
 520
 521 #ifndef uchar
 522 #define uchar unsigned char
 523 #endif
 524
 525 #ifdef SIGNED_CHAR_OK
 526 #define schar signed char
 527 #else
 528 #define schar char
 529 #endif
 530
 531 #ifndef int16
 532 #if SIZEOF_INT16_T == 2
 533 # define int16 int16_t
 534 #else
 535 # define int16 short
 536 #endif
 537 #endif
 538
 539 #ifndef uint16
 540 #if SIZEOF_UINT16_T == 2
 541 # define uint16 uint16_t
 542 #else
 543 # define uint16 unsigned int16
 544 #endif
 545 #endif
 546
 547 /* Find a variable that is either exactly 32-bits or longer.
 548  * If some code depends on 32-bit truncation, it will need to
 549  * take special action in a "#if SIZEOF_INT32 > 4" section. */
 550 #ifndef int32
 551 #if SIZEOF_INT32_T == 4
 552 # define int32 int32_t
 553 # define SIZEOF_INT32 4
 554 #elif SIZEOF_INT == 4
 555 # define int32 int
 556 # define SIZEOF_INT32 4
 557 #elif SIZEOF_LONG == 4
 558 # define int32 long
 559 # define SIZEOF_INT32 4
 560 #elif SIZEOF_SHORT == 4
 561 # define int32 short
 562 # define SIZEOF_INT32 4
 563 #elif SIZEOF_INT > 4
 564 # define int32 int
 565 # define SIZEOF_INT32 SIZEOF_INT
 566 #elif SIZEOF_LONG > 4
 567 # define int32 long
 568 # define SIZEOF_INT32 SIZEOF_LONG
 569 #else
 570 # error Could not find a 32-bit integer variable
 571 #endif
 572 #else
 573 # define SIZEOF_INT32 4
 574 #endif
 575
 576 #ifndef uint32
 577 #if SIZEOF_UINT32_T == 4
 578 # define uint32 uint32_t
 579 #else
 580 # define uint32 unsigned int32
 581 #endif
 582 #endif
 583
 584 #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
 585 #define OFF_T off_t
 586 #define STRUCT_STAT struct stat
 587 #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF_T
 588 #else
 589 #define OFF_T off64_t
 590 #define STRUCT_STAT struct stat64
 591 #define USE_STAT64_FUNCS 1
 592 #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF64_T
 593 #endif
 594
 595 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
 596  * that's the maximum size the file system can handle and there is no
 597  * 64-bit type available.  The rsync source must therefore take steps
 598  * to ensure that any code that really requires a 64-bit integer has
 599  * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
 600  * counter). */
 601 #if SIZEOF_INT64_T == 8
 602 # define int64 int64_t
 603 # define SIZEOF_INT64 8
 604 #elif SIZEOF_LONG == 8
 605 # define int64 long
 606 # define SIZEOF_INT64 8
 607 #elif SIZEOF_INT == 8
 608 # define int64 int
 609 # define SIZEOF_INT64 8
 610 #elif SIZEOF_LONG_LONG == 8
 611 # define int64 long long
 612 # define SIZEOF_INT64 8
 613 #elif SIZEOF_OFF64_T == 8
 614 # define int64 off64_t
 615 # define SIZEOF_INT64 8
 616 #elif SIZEOF_OFF_T == 8
 617 # define int64 off_t
 618 # define SIZEOF_INT64 8
 619 #elif SIZEOF_INT > 8
 620 # define int64 int
 621 # define SIZEOF_INT64 SIZEOF_INT
 622 #elif SIZEOF_LONG > 8
 623 # define int64 long
 624 # define SIZEOF_INT64 SIZEOF_LONG
 625 #elif SIZEOF_LONG_LONG > 8
 626 # define int64 long long
 627 # define SIZEOF_INT64 SIZEOF_LONG_LONG
 628 #else
 629 /* As long as it gets... */
 630 # define int64 off_t
 631 # define SIZEOF_INT64 SIZEOF_OFF_T
 632 #endif
 633
 634 #define HT_KEY32 0
 635 #define HT_KEY64 1
 636
 637 struct hashtable {
 638         void *nodes;
 639         int32 size, entries;
 640         uint32 node_size;
 641         short key64;
 642 };
 643
 644 struct ht_int32_node {
 645         void *data;
 646         int32 key;
 647 };
 648
 649 struct ht_int64_node {
 650         void *data;
 651         int64 key;
 652 };
 653
 654 #define HT_NODE(tbl, bkts, i) ((void*)((char*)(bkts) + (i)*(tbl)->node_size))
 655 #define HT_KEY(node, k64) ((k64)? ((struct ht_int64_node*)(node))->key \
 656                          : (int64)((struct ht_int32_node*)(node))->key)
 657
 658 #ifndef MIN
 659 #define MIN(a,b) ((a)<(b)?(a):(b))
 660 #endif
 661
 662 #ifndef MAX
 663 #define MAX(a,b) ((a)>(b)?(a):(b))
 664 #endif
 665
 666 #ifndef MAXHOSTNAMELEN
 667 #define MAXHOSTNAMELEN 256
 668 #endif
 669
 670 #define SUM_LENGTH 16
 671 #define SHORT_SUM_LENGTH 2
 672 #define BLOCKSUM_BIAS 10
 673
 674 #ifndef MAXPATHLEN
 675 #define MAXPATHLEN 1024
 676 #endif
 677
 678 /* We want a roomy line buffer that can hold more than MAXPATHLEN,
 679  * and significantly more than an overly short MAXPATHLEN. */
 680 #if MAXPATHLEN < 4096
 681 #define BIGPATHBUFLEN (4096+1024)
 682 #else
 683 #define BIGPATHBUFLEN (MAXPATHLEN+1024)
 684 #endif
 685
 686 #ifndef NAME_MAX
 687 #define NAME_MAX 255
 688 #endif
 689
 690 #ifndef INADDR_NONE
 691 #define INADDR_NONE 0xffffffff
 692 #endif
 693
 694 #ifndef IN_LOOPBACKNET
 695 #define IN_LOOPBACKNET 127
 696 #endif
 697
 698 #if HAVE_UNIXWARE_ACLS|HAVE_SOLARIS_ACLS|HAVE_HPUX_ACLS
 699 #define ACLS_NEED_MASK 1
 700 #endif
 701
 702 #if defined HAVE_FALLOCATE || HAVE_SYS_FALLOCATE
 703 #ifdef HAVE_LINUX_FALLOC_H
 704 #include <linux/falloc.h>
 705 #endif
 706 #ifdef FALLOC_FL_KEEP_SIZE
 707 #define SUPPORT_PREALLOCATION 1
 708 #elif defined HAVE_FTRUNCATE
 709 #define SUPPORT_PREALLOCATION 1
 710 #define PREALLOCATE_NEEDS_TRUNCATE 1
 711 #endif
 712 #else /* !fallocate */
 713 #if defined HAVE_EFFICIENT_POSIX_FALLOCATE && defined HAVE_FTRUNCATE
 714 #define SUPPORT_PREALLOCATION 1
 715 #define PREALLOCATE_NEEDS_TRUNCATE 1
 716 #endif
 717 #endif
 718
 719 #if SIZEOF_CHARP == 4
 720 # define PTRS_ARE_32 1
 721 # define PTR_EXTRA_CNT 1
 722 #elif SIZEOF_CHARP == 8
 723 # define PTRS_ARE_64 1
 724 # define PTR_EXTRA_CNT EXTRA64_CNT
 725 #else
 726 # error Character pointers are not 4 or 8 bytes.
 727 #endif
 728
 729 union file_extras {
 730         int32 num;
 731         uint32 unum;
 732 #ifdef PTRS_ARE_32
 733         const char* ptr;
 734 #endif
 735 };
 736
 737 union file_extras64 {
 738         int64 num;
 739 #ifdef PTRS_ARE_64
 740         const char* ptr;
 741 #endif
 742 };
 743
 744 struct file_struct {
 745         const char *dirname;    /* The dir info inside the transfer */
 746         time_t modtime;         /* When the item was last modified */
 747         uint32 len32;           /* Lowest 32 bits of the file's length */
 748         uint16 mode;            /* The item's type and permissions */
 749         uint16 flags;           /* The FLAG_* bits for this item */
 750         const char basename[1]; /* The basename (AKA filename) follows */
 751 };
 752
 753 extern int file_extra_cnt;
 754 extern int inc_recurse;
 755 extern int atimes_ndx;
 756 extern int pathname_ndx;
 757 extern int depth_ndx;
 758 extern int uid_ndx;
 759 extern int gid_ndx;
 760 extern int acls_ndx;
 761 extern int xattrs_ndx;
 762
 763 #define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
 764 #define EXTRA_LEN (sizeof (union file_extras))
 765 #define DEV_EXTRA_CNT 2
 766 #define DIRNODE_EXTRA_CNT 3
 767 #define EXTRA64_CNT ((sizeof (union file_extras64) + EXTRA_LEN - 1) / EXTRA_LEN)
 768 #define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
 769
 770 #define REQ_EXTRA(f,ndx) ((union file_extras*)(f) - (ndx))
 771 #define OPT_EXTRA(f,bump) ((union file_extras*)(f) - file_extra_cnt - 1 - (bump))
 772
 773 /* These are guaranteed to be allocated first in the array so that they
 774  * are aligned for direct int64-pointer access. */
 775 #define REQ_EXTRA64(f,ndx) ((union file_extras64*)REQ_EXTRA(f,ndx))
 776
 777 #define NSEC_BUMP(f) ((f)->flags & FLAG_MOD_NSEC ? 1 : 0)
 778 #define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
 779 #define START_BUMP(f) (NSEC_BUMP(f) + LEN64_BUMP(f))
 780 #define HLINK_BUMP(f) ((f)->flags & (FLAG_HLINKED|FLAG_HLINK_DONE) ? inc_recurse+1 : 0)
 781 #define ACL_BUMP(f) (acls_ndx ? 1 : 0)
 782
 783 /* The length applies to all items. */
 784 #if SIZEOF_INT64 < 8
 785 #define F_LENGTH(f) ((int64)(f)->len32)
 786 #else
 787 #define F_HIGH_LEN(f) (OPT_EXTRA(f, NSEC_BUMP(f))->unum)
 788 #define F_LENGTH(f) ((int64)(f)->len32 + ((f)->flags & FLAG_LENGTH64 ? (int64)F_HIGH_LEN(f) << 32 : 0))
 789 #endif
 790
 791 #define F_MOD_NSEC(f) OPT_EXTRA(f, 0)->unum
 792 #define F_MOD_NSEC_or_0(f) ((f)->flags & FLAG_MOD_NSEC ? F_MOD_NSEC(f) : 0)
 793
 794 /* If there is a symlink string, it is always right after the basename */
 795 #define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
 796
 797 /* The sending side always has this available: */
 798 #ifdef PTRS_ARE_32
 799 #define F_PATHNAME(f) REQ_EXTRA(f, pathname_ndx)->ptr
 800 #else
 801 #define F_PATHNAME(f) REQ_EXTRA64(f, pathname_ndx)->ptr
 802 #endif
 803
 804 /* The receiving side always has this available: */
 805 #define F_DEPTH(f) REQ_EXTRA(f, depth_ndx)->num
 806
 807 /* When the associated option is on, all entries will have these present: */
 808 #define F_OWNER(f) REQ_EXTRA(f, uid_ndx)->unum
 809 #define F_GROUP(f) REQ_EXTRA(f, gid_ndx)->unum
 810 #define F_ACL(f) REQ_EXTRA(f, acls_ndx)->num
 811 #define F_XATTR(f) REQ_EXTRA(f, xattrs_ndx)->num
 812 #define F_NDX(f) REQ_EXTRA(f, unsort_ndx)->num
 813 #define F_ATIME(f) REQ_EXTRA64(f, atimes_ndx)->num
 814
 815 /* These items are per-entry optional: */
 816 #define F_HL_GNUM(f) OPT_EXTRA(f, START_BUMP(f))->num /* non-dirs */
 817 #define F_HL_PREV(f) OPT_EXTRA(f, START_BUMP(f)+inc_recurse)->num /* non-dirs */
 818 #define F_DIR_NODE_P(f) (&OPT_EXTRA(f, START_BUMP(f) \
 819                                 + DIRNODE_EXTRA_CNT - 1)->num) /* sender dirs */
 820 #define F_DIR_RELNAMES_P(f) (&OPT_EXTRA(f, START_BUMP(f) + DIRNODE_EXTRA_CNT \
 821                                 + PTR_EXTRA_CNT - 1)->num) /* sender dirs */
 822 #define F_DIR_DEFACL(f) OPT_EXTRA(f, START_BUMP(f))->unum /* receiver dirs */
 823 #define F_DIR_DEV_P(f) (&OPT_EXTRA(f, START_BUMP(f) + ACL_BUMP(f) \
 824                                 + DEV_EXTRA_CNT - 1)->unum) /* receiver dirs */
 825
 826 /* This optional item might follow an F_HL_*() item. */
 827 #define F_RDEV_P(f) (&OPT_EXTRA(f, START_BUMP(f) + HLINK_BUMP(f) + DEV_EXTRA_CNT - 1)->unum)
 828
 829 /* The sum is only present on regular files. */
 830 #define F_SUM(f) ((char*)OPT_EXTRA(f, START_BUMP(f) + HLINK_BUMP(f) \
 831                                     + SUM_EXTRA_CNT - 1))
 832
 833 /* Some utility defines: */
 834 #define F_IS_ACTIVE(f) (f)->basename[0]
 835 #define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
 836
 837 #define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
 838 #define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
 839
 840 /* These access the F_DIR_DEV_P() and F_RDEV_P() values: */
 841 #define DEV_MAJOR(a) (a)[0]
 842 #define DEV_MINOR(a) (a)[1]
 843
 844 /* These access the F_DIRS_NODE_P() values: */
 845 #define DIR_PARENT(a) (a)[0]
 846 #define DIR_FIRST_CHILD(a) (a)[1]
 847 #define DIR_NEXT_SIBLING(a) (a)[2]
 848
 849 #define IS_MISSING_FILE(statbuf) ((statbuf).st_mode == 0)
 850
 851 /*
 852  * Start the flist array at FLIST_START entries and grow it
 853  * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
 854  */
 855 #define FLIST_START     (32 * 1024)
 856 #define FLIST_LINEAR    (FLIST_START * 512)
 857
 858 /*
 859  * Extent size for allocation pools: A minimum size of 128KB
 860  * is needed to mmap them so that freeing will release the
 861  * space to the OS.
 862  *
 863  * Larger sizes reduce leftover fragments and speed free calls
 864  * (when they happen). Smaller sizes increase the chance of
 865  * freed allocations freeing whole extents.
 866  */
 867 #define NORMAL_EXTENT   (256 * 1024)
 868 #define SMALL_EXTENT    (128 * 1024)
 869
 870 #define FLIST_TEMP      (1<<1)
 871
 872 struct file_list {
 873         struct file_list *next, *prev;
 874         struct file_struct **files, **sorted;
 875         alloc_pool_t file_pool;
 876         void *pool_boundary;
 877         int used, malloced;
 878         int low, high;  /* 0-relative index values excluding empties */
 879         int ndx_start;  /* the start offset for inc_recurse mode */
 880         int flist_num;  /* 1-relative file_list number or 0 */
 881         int parent_ndx; /* dir_flist index of parent directory */
 882         int in_progress, to_redo;
 883 };
 884
 885 #define SUMFLG_SAME_OFFSET      (1<<0)
 886
 887 struct sum_buf {
 888         OFF_T offset;           /**< offset in file of this chunk */
 889         int32 len;              /**< length of chunk of file */
 890         uint32 sum1;            /**< simple checksum */
 891         int32 chain;            /**< next hash-table collision */
 892         short flags;            /**< flag bits */
 893         char sum2[SUM_LENGTH];  /**< checksum  */
 894 };
 895
 896 struct sum_struct {
 897         OFF_T flength;          /**< total file length */
 898         struct sum_buf *sums;   /**< points to info for each chunk */
 899         int32 count;            /**< how many chunks */
 900         int32 blength;          /**< block_length */
 901         int32 remainder;        /**< flength % block_length */
 902         int s2length;           /**< sum2_length */
 903 };
 904
 905 struct map_struct {
 906         OFF_T file_size;        /* File size (from stat)                */
 907         OFF_T p_offset;         /* Window start                         */
 908         OFF_T p_fd_offset;      /* offset of cursor in fd ala lseek     */
 909         char *p;                /* Window pointer                       */
 910         int32 p_size;           /* Largest window size we allocated     */
 911         int32 p_len;            /* Latest (rounded) window size         */
 912         int32 def_window_size;  /* Default window size                  */
 913         int fd;                 /* File Descriptor                      */
 914         int status;             /* first errno from read errors         */
 915 };
 916
 917 #define NAME_IS_FILE            (0)    /* filter name as a file */
 918 #define NAME_IS_DIR             (1<<0) /* filter name as a dir */
 919 #define NAME_IS_XATTR           (1<<2) /* filter name as an xattr */
 920
 921 #define FILTRULE_WILD           (1<<0) /* pattern has '*', '[', and/or '?' */
 922 #define FILTRULE_WILD2          (1<<1) /* pattern has '**' */
 923 #define FILTRULE_WILD2_PREFIX   (1<<2) /* pattern starts with "**" */
 924 #define FILTRULE_WILD3_SUFFIX   (1<<3) /* pattern ends with "***" */
 925 #define FILTRULE_ABS_PATH       (1<<4) /* path-match on absolute path */
 926 #define FILTRULE_INCLUDE        (1<<5) /* this is an include, not an exclude */
 927 #define FILTRULE_DIRECTORY      (1<<6) /* this matches only directories */
 928 #define FILTRULE_WORD_SPLIT     (1<<7) /* split rules on whitespace */
 929 #define FILTRULE_NO_INHERIT     (1<<8) /* don't inherit these rules */
 930 #define FILTRULE_NO_PREFIXES    (1<<9) /* parse no prefixes from patterns */
 931 #define FILTRULE_MERGE_FILE     (1<<10)/* specifies a file to merge */
 932 #define FILTRULE_PERDIR_MERGE   (1<<11)/* merge-file is searched per-dir */
 933 #define FILTRULE_EXCLUDE_SELF   (1<<12)/* merge-file name should be excluded */
 934 #define FILTRULE_FINISH_SETUP   (1<<13)/* per-dir merge file needs setup */
 935 #define FILTRULE_NEGATE         (1<<14)/* rule matches when pattern does not */
 936 #define FILTRULE_CVS_IGNORE     (1<<15)/* rule was -C or :C */
 937 #define FILTRULE_SENDER_SIDE    (1<<16)/* rule applies to the sending side */
 938 #define FILTRULE_RECEIVER_SIDE  (1<<17)/* rule applies to the receiving side */
 939 #define FILTRULE_CLEAR_LIST     (1<<18)/* this item is the "!" token */
 940 #define FILTRULE_PERISHABLE     (1<<19)/* perishable if parent dir goes away */
 941 #define FILTRULE_XATTR          (1<<20)/* rule only applies to xattr names */
 942
 943 #define FILTRULES_SIDES (FILTRULE_SENDER_SIDE | FILTRULE_RECEIVER_SIDE)
 944
 945 typedef struct filter_struct {
 946         struct filter_struct *next;
 947         char *pattern;
 948         uint32 rflags;
 949         union {
 950                 int slash_cnt;
 951                 struct filter_list_struct *mergelist;
 952         } u;
 953 } filter_rule;
 954
 955 typedef struct filter_list_struct {
 956         filter_rule *head;
 957         filter_rule *tail;
 958         char *debug_type;
 959 } filter_rule_list;
 960
 961 struct stats {
 962         int64 total_size;
 963         int64 total_transferred_size;
 964         int64 total_written;
 965         int64 total_read;
 966         int64 literal_data;
 967         int64 matched_data;
 968         int64 flist_buildtime;
 969         int64 flist_xfertime;
 970         int64 flist_size;
 971         int num_files, num_dirs, num_symlinks, num_devices, num_specials;
 972         int created_files, created_dirs, created_symlinks, created_devices, created_specials;
 973         int deleted_files, deleted_dirs, deleted_symlinks, deleted_devices, deleted_specials;
 974         int xferred_files;
 975 };
 976
 977 struct chmod_mode_struct;
 978
 979 struct flist_ndx_item {
 980         struct flist_ndx_item *next;
 981         int ndx;
 982 };
 983
 984 typedef struct {
 985         struct flist_ndx_item *head, *tail;
 986 } flist_ndx_list;
 987
 988 #define EMPTY_ITEM_LIST {NULL, 0, 0}
 989
 990 typedef struct {
 991         void *items;
 992         size_t count;
 993         size_t malloced;
 994 } item_list;
 995
 996 #define EXPAND_ITEM_LIST(lp, type, incr) \
 997         (type*)expand_item_list(lp, sizeof (type), #type, incr)
 998
 999 #define EMPTY_XBUF {NULL, 0, 0, 0}
1000
1001 typedef struct {
1002         char *buf;
1003         size_t pos;  /* pos = read pos in the buf */
1004         size_t len;  /* len = chars following pos */
1005         size_t size; /* size = total space in buf */
1006 } xbuf;
1007
1008 #define INIT_XBUF(xb, str, ln, sz) (xb).buf = (str), (xb).len = (ln), (xb).size = (sz), (xb).pos = 0
1009 #define INIT_XBUF_STRLEN(xb, str) (xb).buf = (str), (xb).len = strlen((xb).buf), (xb).size = (size_t)-1, (xb).pos = 0
1010 /* This one is used to make an output xbuf based on a char[] buffer: */
1011 #define INIT_CONST_XBUF(xb, bf) (xb).buf = (bf), (xb).size = sizeof (bf), (xb).len = (xb).pos = 0
1012
1013 #define ICB_EXPAND_OUT (1<<0)
1014 #define ICB_INCLUDE_BAD (1<<1)
1015 #define ICB_INCLUDE_INCOMPLETE (1<<2)
1016 #define ICB_CIRCULAR_OUT (1<<3)
1017 #define ICB_INIT (1<<4)
1018
1019 #define IOBUF_KEEP_BUFS 0
1020 #define IOBUF_FREE_BUFS 1
1021
1022 #define MPLX_SWITCHING IOBUF_KEEP_BUFS
1023 #define MPLX_ALL_DONE IOBUF_FREE_BUFS
1024 #define MPLX_TO_BUFFERED 2
1025
1026 #define RL_EOL_NULLS (1<<0)
1027 #define RL_DUMP_COMMENTS (1<<1)
1028 #define RL_CONVERT (1<<2)
1029
1030 typedef struct {
1031         char name_type;
1032         char fname[1]; /* has variable size */
1033 } relnamecache;
1034
1035 #include "byteorder.h"
1036 #include "lib/mdigest.h"
1037 #include "lib/wildmatch.h"
1038 #include "lib/permstring.h"
1039 #include "lib/addrinfo.h"
1040
1041 #ifndef __GNUC__
1042 #define __attribute__(x)
1043 #else
1044 # if __GNUC__ <= 2
1045 # define NORETURN
1046 # endif
1047 #endif
1048
1049 #define UNUSED(x) x __attribute__((__unused__))
1050 #ifndef NORETURN
1051 #define NORETURN __attribute__((__noreturn__))
1052 #endif
1053
1054 typedef struct {
1055     STRUCT_STAT st;
1056 #ifdef SUPPORT_ACLS
1057     struct rsync_acl *acc_acl; /* access ACL */
1058     struct rsync_acl *def_acl; /* default ACL */
1059 #endif
1060 #ifdef SUPPORT_XATTRS
1061     item_list *xattr;
1062 #endif
1063 } stat_x;
1064
1065 #define ACL_READY(sx) ((sx).acc_acl != NULL)
1066 #define XATTR_READY(sx) ((sx).xattr != NULL)
1067
1068 #define CLVL_NOT_SPECIFIED INT_MIN
1069
1070 #define CPRES_AUTO (-1)
1071 #define CPRES_NONE 0
1072 #define CPRES_ZLIB 1
1073 #define CPRES_ZLIBX 2
1074 #define CPRES_LZ4 3
1075 #define CPRES_ZSTD 4
1076
1077 struct name_num_item {
1078         int num;
1079         const char *name, *main_name;
1080 };
1081
1082 struct name_num_obj {
1083         const char *type;
1084         const char *negotiated_name;
1085         uchar *saw;
1086         int saw_len;
1087         int negotiated_num;
1088         struct name_num_item list[];
1089 };
1090
1091 #ifndef __cplusplus
1092 #include "proto.h"
1093 #endif
1094
1095 #ifndef SUPPORT_XATTRS
1096 #define x_stat(fn,fst,xst) do_stat(fn,fst)
1097 #define x_lstat(fn,fst,xst) do_lstat(fn,fst)
1098 #define x_fstat(fd,fst,xst) do_fstat(fd,fst)
1099 #endif
1100
1101 /* We have replacement versions of these if they're missing. */
1102 #ifndef HAVE_ASPRINTF
1103 int asprintf(char **ptr, const char *format, ...);
1104 #endif
1105
1106 #ifndef HAVE_VASPRINTF
1107 int vasprintf(char **ptr, const char *format, va_list ap);
1108 #endif
1109
1110 #if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
1111 #define vsnprintf rsync_vsnprintf
1112 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1113 #endif
1114
1115 #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
1116 #define snprintf rsync_snprintf
1117 int snprintf(char *str, size_t count, const char *fmt,...);
1118 #endif
1119
1120 #ifndef HAVE_STRERROR
1121 extern char *sys_errlist[];
1122 #define strerror(i) sys_errlist[i]
1123 #endif
1124
1125 #ifndef HAVE_STRCHR
1126 # define strchr                 index
1127 # define strrchr                rindex
1128 #endif
1129
1130 #ifndef HAVE_ERRNO_DECL
1131 extern int errno;
1132 #endif
1133
1134 #ifdef HAVE_READLINK
1135 #define SUPPORT_LINKS 1
1136 #if !defined NO_SYMLINK_XATTRS && !defined NO_SYMLINK_USER_XATTRS
1137 #define do_readlink(path, buf, bufsiz) readlink(path, buf, bufsiz)
1138 #endif
1139 #endif
1140 #ifdef HAVE_LINK
1141 #define SUPPORT_HARD_LINKS 1
1142 #endif
1143
1144 #ifdef HAVE_SIGACTION
1145 #define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
1146 #define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
1147 #else
1148 #define SIGACTION(n,h) signal(n,h)
1149 #endif
1150
1151 #ifndef EWOULDBLOCK
1152 #define EWOULDBLOCK EAGAIN
1153 #endif
1154
1155 #ifndef STDIN_FILENO
1156 #define STDIN_FILENO 0
1157 #endif
1158
1159 #ifndef STDOUT_FILENO
1160 #define STDOUT_FILENO 1
1161 #endif
1162
1163 #ifndef STDERR_FILENO
1164 #define STDERR_FILENO 2
1165 #endif
1166
1167 #ifndef S_IRUSR
1168 #define S_IRUSR 0400
1169 #endif
1170
1171 #ifndef S_IWUSR
1172 #define S_IWUSR 0200
1173 #endif
1174
1175 #ifndef ACCESSPERMS
1176 #define ACCESSPERMS 0777
1177 #endif
1178
1179 #ifndef S_ISVTX
1180 #define S_ISVTX 0
1181 #endif
1182
1183 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
1184
1185 #ifndef _S_IFMT
1186 #define _S_IFMT        0170000
1187 #endif
1188
1189 #ifndef _S_IFLNK
1190 #define _S_IFLNK  0120000
1191 #endif
1192
1193 #ifndef S_ISLNK
1194 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
1195 #endif
1196
1197 #ifndef S_ISBLK
1198 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
1199 #endif
1200
1201 #ifndef S_ISCHR
1202 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
1203 #endif
1204
1205 #ifndef S_ISSOCK
1206 #ifdef _S_IFSOCK
1207 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
1208 #else
1209 #define S_ISSOCK(mode) (0)
1210 #endif
1211 #endif
1212
1213 #ifndef S_ISFIFO
1214 #ifdef _S_IFIFO
1215 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
1216 #else
1217 #define S_ISFIFO(mode) (0)
1218 #endif
1219 #endif
1220
1221 #ifndef S_ISDIR
1222 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
1223 #endif
1224
1225 #ifndef S_ISREG
1226 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
1227 #endif
1228
1229 /* work out what fcntl flag to use for non-blocking */
1230 #ifdef O_NONBLOCK
1231 # define NONBLOCK_FLAG O_NONBLOCK
1232 #elif defined SYSV
1233 # define NONBLOCK_FLAG O_NDELAY
1234 #else
1235 # define NONBLOCK_FLAG FNDELAY
1236 #endif
1237
1238 #ifndef INADDR_LOOPBACK
1239 #define INADDR_LOOPBACK 0x7f000001
1240 #endif
1241
1242 #ifndef INADDR_NONE
1243 #define INADDR_NONE 0xffffffff
1244 #endif
1245
1246 #define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
1247 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
1248
1249 #define PRESERVE_FILE_TIMES     (1<<0)
1250 #define PRESERVE_DIR_TIMES      (1<<1)
1251 #define PRESERVE_LINK_TIMES     (1<<2)
1252
1253 /* Initial mask on permissions given to temporary files.  Mask off setuid
1254      bits and group access because of potential race-condition security
1255      holes, and mask other access because mode 707 is bizarre */
1256 #define INITACCESSPERMS 0700
1257
1258 /* handler for null strings in printf format */
1259 #define NS(s) ((s)?(s):"<NULL>")
1260
1261 /* Convenient wrappers for malloc and realloc.  Use them. */
1262 #define new(type) ((type*)malloc(sizeof (type)))
1263 #define new0(type) ((type*)calloc(1, sizeof (type)))
1264 #define new_array(type, num) ((type*)_new_array((num), sizeof (type), 0))
1265 #define new_array0(type, num) ((type*)_new_array((num), sizeof (type), 1))
1266 #define realloc_array(ptr, type, num) ((type*)_realloc_array((ptr), sizeof(type), (num)))
1267
1268 /* use magic gcc attributes to catch format errors */
1269  void rprintf(enum logcode , const char *, ...)
1270      __attribute__((format (printf, 2, 3)))
1271 ;
1272
1273 /* This is just like rprintf, but it also tries to print some
1274  * representation of the error code.  Normally errcode = errno. */
1275 void rsyserr(enum logcode, int, const char *, ...)
1276      __attribute__((format (printf, 3, 4)))
1277      ;
1278
1279 /* Make sure that the O_BINARY flag is defined. */
1280 #ifndef O_BINARY
1281 #define O_BINARY 0
1282 #endif
1283
1284 #ifndef HAVE_STRLCPY
1285 size_t strlcpy(char *d, const char *s, size_t bufsize);
1286 #endif
1287
1288 #ifndef HAVE_STRLCAT
1289 size_t strlcat(char *d, const char *s, size_t bufsize);
1290 #endif
1291
1292 #ifndef WEXITSTATUS
1293 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
1294 #endif
1295 #ifndef WIFEXITED
1296 #define WIFEXITED(stat)         ((int)((stat)&0xFF) == 0)
1297 #endif
1298
1299 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
1300
1301 #ifdef HAVE_GETEUID
1302 #define MY_UID() geteuid()
1303 #else
1304 #define MY_UID() getuid()
1305 #endif
1306
1307 #ifdef HAVE_GETEGID
1308 #define MY_GID() getegid()
1309 #else
1310 #define MY_GID() getgid()
1311 #endif
1312
1313 #ifdef FORCE_FD_ZERO_MEMSET
1314 #undef FD_ZERO
1315 #define FD_ZERO(fdsetp) memset(fdsetp, 0, sizeof (fd_set))
1316 #endif
1317
1318 extern short info_levels[], debug_levels[];
1319
1320 #define INFO_GTE(flag, lvl) (info_levels[INFO_##flag] >= (lvl))
1321 #define INFO_EQ(flag, lvl) (info_levels[INFO_##flag] == (lvl))
1322 #define DEBUG_GTE(flag, lvl) (debug_levels[DEBUG_##flag] >= (lvl))
1323 #define DEBUG_EQ(flag, lvl) (debug_levels[DEBUG_##flag] == (lvl))
1324
1325 #define INFO_BACKUP 0
1326 #define INFO_COPY (INFO_BACKUP+1)
1327 #define INFO_DEL (INFO_COPY+1)
1328 #define INFO_FLIST (INFO_DEL+1)
1329 #define INFO_MISC (INFO_FLIST+1)
1330 #define INFO_MOUNT (INFO_MISC+1)
1331 #define INFO_NAME (INFO_MOUNT+1)
1332 #define INFO_PROGRESS (INFO_NAME+1)
1333 #define INFO_REMOVE (INFO_PROGRESS+1)
1334 #define INFO_SKIP (INFO_REMOVE+1)
1335 #define INFO_STATS (INFO_SKIP+1)
1336 #define INFO_SYMSAFE (INFO_STATS+1)
1337
1338 #define COUNT_INFO (INFO_SYMSAFE+1)
1339
1340 #define DEBUG_ACL 0
1341 #define DEBUG_BACKUP (DEBUG_ACL+1)
1342 #define DEBUG_BIND (DEBUG_BACKUP+1)
1343 #define DEBUG_CHDIR (DEBUG_BIND+1)
1344 #define DEBUG_CONNECT (DEBUG_CHDIR+1)
1345 #define DEBUG_CMD (DEBUG_CONNECT+1)
1346 #define DEBUG_DEL (DEBUG_CMD+1)
1347 #define DEBUG_DELTASUM (DEBUG_DEL+1)
1348 #define DEBUG_DUP (DEBUG_DELTASUM+1)
1349 #define DEBUG_EXIT (DEBUG_DUP+1)
1350 #define DEBUG_FILTER (DEBUG_EXIT+1)
1351 #define DEBUG_FLIST (DEBUG_FILTER+1)
1352 #define DEBUG_FUZZY (DEBUG_FLIST+1)
1353 #define DEBUG_GENR (DEBUG_FUZZY+1)
1354 #define DEBUG_HASH (DEBUG_GENR+1)
1355 #define DEBUG_HLINK (DEBUG_HASH+1)
1356 #define DEBUG_ICONV (DEBUG_HLINK+1)
1357 #define DEBUG_IO (DEBUG_ICONV+1)
1358 #define DEBUG_NSTR (DEBUG_IO+1)
1359 #define DEBUG_OWN (DEBUG_NSTR+1)
1360 #define DEBUG_PROTO (DEBUG_OWN+1)
1361 #define DEBUG_RECV (DEBUG_PROTO+1)
1362 #define DEBUG_SEND (DEBUG_RECV+1)
1363 #define DEBUG_TIME (DEBUG_SEND+1)
1364
1365 #define COUNT_DEBUG (DEBUG_TIME+1)
1366
1367 #ifndef HAVE_INET_NTOP
1368 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
1369 #endif
1370
1371 #ifndef HAVE_INET_PTON
1372 int inet_pton(int af, const char *src, void *dst);
1373 #endif
1374
1375 #ifndef HAVE_GETPASS
1376 char *getpass(const char *prompt);
1377 #endif
1378
1379 #ifdef MAINTAINER_MODE
1380 const char *get_panic_action(void);
1381 #endif