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