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