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