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