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