Annotation of embedaddon/rsync/rsync.h, revision 1.1.1.1
1.1 misho 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-2008 Wayne Davison
6: *
7: * This program is free software; you can redistribute it and/or modify
8: * it under the terms of the GNU General Public License as published by
9: * the Free Software Foundation; either version 3 of the License, or
10: * (at your option) any later version.
11: *
12: * This program is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15: * GNU General Public License for more details.
16: *
17: * You should have received a copy of the GNU General Public License along
18: * with this program; if not, visit the http://fsf.org website.
19: */
20:
21: #define False 0
22: #define True 1
23:
24: #define BLOCK_SIZE 700
25: #define RSYNC_RSH_ENV "RSYNC_RSH"
26: #define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
27:
28: #define RSYNC_NAME "rsync"
29: /* RSYNCD_SYSCONF is now set in config.h */
30: #define RSYNCD_USERCONF "rsyncd.conf"
31:
32: #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
33: #define URL_PREFIX "rsync://"
34:
35: #define SYMLINK_PREFIX "/rsyncd-munged/" /* This MUST have a trailing slash! */
36: #define SYMLINK_PREFIX_LEN ((int)sizeof SYMLINK_PREFIX - 1)
37:
38: #define BACKUP_SUFFIX "~"
39:
40: /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
41: incompatible with older versions :-( */
42: #define CHAR_OFFSET 0
43:
44: /* These flags are only used during the flist transfer. */
45:
46: #define XMIT_TOP_DIR (1<<0)
47: #define XMIT_SAME_MODE (1<<1)
48: #define XMIT_SAME_RDEV_pre28 (1<<2) /* protocols 20 - 27 */
49: #define XMIT_EXTENDED_FLAGS (1<<2) /* protocols 28 - now */
50: #define XMIT_SAME_UID (1<<3)
51: #define XMIT_SAME_GID (1<<4)
52: #define XMIT_SAME_NAME (1<<5)
53: #define XMIT_LONG_NAME (1<<6)
54: #define XMIT_SAME_TIME (1<<7)
55: #define XMIT_SAME_RDEV_MAJOR (1<<8) /* protocols 28 - now (devices only) */
56: #define XMIT_NO_CONTENT_DIR (1<<8) /* protocols 30 - now (dirs only) */
57: #define XMIT_HLINKED (1<<9) /* protocols 28 - now */
58: #define XMIT_SAME_DEV_pre30 (1<<10) /* protocols 28 - 29 */
59: #define XMIT_USER_NAME_FOLLOWS (1<<10) /* protocols 30 - now */
60: #define XMIT_RDEV_MINOR_8_pre30 (1<<11) /* protocols 28 - 29 */
61: #define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - now */
62: #define XMIT_HLINK_FIRST (1<<12) /* protocols 30 - now (HLINKED files only) */
63: #define XMIT_IO_ERROR_ENDLIST (1<<12) /* protocols 31*- now (w/XMIT_EXTENDED_FLAGS) (also protocol 30 w/'f' compat flag) */
64:
65: /* These flags are used in the live flist data. */
66:
67: #define FLAG_TOP_DIR (1<<0) /* sender/receiver/generator */
68: #define FLAG_OWNED_BY_US (1<<0) /* generator: set by make_file() for aux flists only */
69: #define FLAG_FILE_SENT (1<<1) /* sender/receiver/generator */
70: #define FLAG_DIR_CREATED (1<<1) /* generator */
71: #define FLAG_CONTENT_DIR (1<<2) /* sender/receiver/generator */
72: #define FLAG_MOUNT_DIR (1<<3) /* sender/generator (dirs only) */
73: #define FLAG_SKIP_HLINK (1<<3) /* receiver/generator (w/FLAG_HLINKED) */
74: #define FLAG_DUPLICATE (1<<4) /* sender */
75: #define FLAG_MISSING_DIR (1<<4) /* generator */
76: #define FLAG_HLINKED (1<<5) /* receiver/generator (checked on all types) */
77: #define FLAG_HLINK_FIRST (1<<6) /* receiver/generator (w/FLAG_HLINKED) */
78: #define FLAG_IMPLIED_DIR (1<<6) /* sender/receiver/generator (dirs only) */
79: #define FLAG_HLINK_LAST (1<<7) /* receiver/generator */
80: #define FLAG_HLINK_DONE (1<<8) /* receiver/generator (checked on all types) */
81: #define FLAG_LENGTH64 (1<<9) /* sender/receiver/generator */
82: #define FLAG_SKIP_GROUP (1<<10) /* receiver/generator */
83: #define FLAG_TIME_FAILED (1<<11)/* generator */
84:
85: /* These flags are passed to functions but not stored. */
86:
87: #define FLAG_DIVERT_DIRS (1<<16) /* sender, but must be unique */
88:
89: /* These flags are for get_dirlist(). */
90: #define GDL_IGNORE_FILTER_RULES (1<<0)
91:
92: /* Some helper macros for matching bits. */
93: #define BITS_SET(val,bits) (((val) & (bits)) == (bits))
94: #define BITS_SETnUNSET(val,onbits,offbits) (((val) & ((onbits)|(offbits))) == (onbits))
95: #define BITS_EQUAL(b1,b2,mask) (((unsigned)(b1) & (unsigned)(mask)) \
96: == ((unsigned)(b2) & (unsigned)(mask)))
97:
98: /* update this if you make incompatible changes */
99: #define PROTOCOL_VERSION 30
100:
101: /* This is used when working on a new protocol version in CVS, and should
102: * be a new non-zero value for each CVS change that affects the protocol.
103: * It must ALWAYS be 0 when the protocol goes final (and NEVER before)! */
104: #define SUBPROTOCOL_VERSION 0
105:
106: /* We refuse to interoperate with versions that are not in this range.
107: * Note that we assume we'll work with later versions: the onus is on
108: * people writing them to make sure that they don't send us anything
109: * we won't understand.
110: *
111: * Interoperation with old but supported protocol versions
112: * should cause a warning to be printed. At a future date
113: * the old protocol will become the minimum and
114: * compatibility code removed.
115: *
116: * There are two possible explanations for the limit at
117: * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
118: * do not interoperate with us, and (more likely) so that we can
119: * detect an attempt to connect rsync to a non-rsync server, which is
120: * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
121: * MAX_PROTOCOL_VERSION. */
122:
123: #define MIN_PROTOCOL_VERSION 20
124: #define OLD_PROTOCOL_VERSION 25
125: #define MAX_PROTOCOL_VERSION 40
126:
127: #define FILECNT_LOOKAHEAD 1000
128:
129: #define RSYNC_PORT 873
130:
131: #define SPARSE_WRITE_SIZE (1024)
132: #define WRITE_SIZE (32*1024)
133: #define CHUNK_SIZE (32*1024)
134: #define MAX_MAP_SIZE (256*1024)
135: #define IO_BUFFER_SIZE (4092)
136: #define MAX_BLOCK_SIZE ((int32)1 << 17)
137:
138: /* For compatibility with older rsyncs */
139: #define OLD_MAX_BLOCK_SIZE ((int32)1 << 29)
140:
141: #define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
142: #define IOERR_VANISHED (1<<1)
143: #define IOERR_DEL_LIMIT (1<<2)
144:
145: #define MAX_ARGS 1000
146: #define MAX_BASIS_DIRS 20
147: #define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
148:
149: #define MPLEX_BASE 7
150:
151: #define NO_FILTERS 0
152: #define SERVER_FILTERS 1
153: #define ALL_FILTERS 2
154:
155: #define XFLG_FATAL_ERRORS (1<<0)
156: #define XFLG_OLD_PREFIXES (1<<1)
157: #define XFLG_ANCHORED2ABS (1<<2) /* leading slash indicates absolute */
158: #define XFLG_ABS_IF_SLASH (1<<3) /* leading or interior slash is absolute */
159: #define XFLG_DIR2WILD3 (1<<4) /* dir/ match gets trailing *** added */
160:
161: #define ATTRS_REPORT (1<<0)
162: #define ATTRS_SKIP_MTIME (1<<1)
163:
164: #define FULL_FLUSH 1
165: #define NORMAL_FLUSH 0
166:
167: #define PDIR_CREATE 1
168: #define PDIR_DELETE 0
169:
170: /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
171: #define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
172: #define FNAMECMP_BASIS_DIR_HIGH 0x7F
173: #define FNAMECMP_FNAME 0x80
174: #define FNAMECMP_PARTIAL_DIR 0x81
175: #define FNAMECMP_BACKUP 0x82
176: #define FNAMECMP_FUZZY 0x83
177:
178: /* For use by the itemize_changes code */
179: #define ITEM_REPORT_ATIME (1<<0)
180: #define ITEM_REPORT_CHANGE (1<<1)
181: #define ITEM_REPORT_SIZE (1<<2) /* regular files only */
182: #define ITEM_REPORT_TIMEFAIL (1<<2) /* symlinks only */
183: #define ITEM_REPORT_TIME (1<<3)
184: #define ITEM_REPORT_PERMS (1<<4)
185: #define ITEM_REPORT_OWNER (1<<5)
186: #define ITEM_REPORT_GROUP (1<<6)
187: #define ITEM_REPORT_ACL (1<<7)
188: #define ITEM_REPORT_XATTR (1<<8)
189: #define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
190: #define ITEM_XNAME_FOLLOWS (1<<12)
191: #define ITEM_IS_NEW (1<<13)
192: #define ITEM_LOCAL_CHANGE (1<<14)
193: #define ITEM_TRANSFER (1<<15)
194: /* These are outside the range of the transmitted flags. */
195: #define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
196: #define ITEM_DELETED (1<<17) /* used by log_formatted() */
197: #define ITEM_MATCHED (1<<18) /* used by itemize() */
198:
199: #define SIGNIFICANT_ITEM_FLAGS (~(\
200: ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
201:
202: #define CFN_KEEP_DOT_DIRS (1<<0)
203: #define CFN_KEEP_TRAILING_SLASH (1<<1)
204: #define CFN_DROP_TRAILING_DOT_DIR (1<<2)
205: #define CFN_COLLAPSE_DOT_DOT_DIRS (1<<3)
206:
207: #define SP_DEFAULT 0
208: #define SP_KEEP_DOT_DIRS (1<<0)
209:
210: #define CD_NORMAL 0
211: #define CD_SKIP_CHDIR 1
212:
213: /* Log-message categories. FLOG only goes to the log file, not the client;
214: * FCLIENT is the opposite. */
215: enum logcode {
216: FNONE=0, /* never sent */
217: FERROR_XFER=1, FINFO=2, /* sent over socket for any protocol */
218: FERROR=3, FWARNING=4, /* sent over socket for protocols >= 30 */
219: FERROR_SOCKET=5, FLOG=6, /* only sent via receiver -> generator pipe */
220: FERROR_UTF8=8, /* only sent via receiver -> generator pipe */
221: FCLIENT=7 /* never transmitted (e.g. server converts to FINFO) */
222: };
223:
224: /* Messages types that are sent over the message channel. The logcode
225: * values must all be present here with identical numbers. */
226: enum msgcode {
227: MSG_DATA=0, /* raw data on the multiplexed stream */
228: MSG_ERROR_XFER=FERROR_XFER, MSG_INFO=FINFO, /* remote logging */
229: MSG_ERROR=FERROR, MSG_WARNING=FWARNING, /* protocol-30 remote logging */
230: MSG_ERROR_SOCKET=FERROR_SOCKET, /* sibling logging */
231: MSG_ERROR_UTF8=FERROR_UTF8, /* sibling logging */
232: MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, /* sibling logging */
233: MSG_REDO=9, /* reprocess indicated flist index */
234: MSG_FLIST=20, /* extra file list over sibling socket */
235: MSG_FLIST_EOF=21,/* we've transmitted all the file lists */
236: MSG_IO_ERROR=22,/* the sending side had an I/O error */
237: MSG_NOOP=42, /* a do-nothing message */
238: MSG_SUCCESS=100,/* successfully updated indicated flist index */
239: MSG_DELETED=101,/* successfully deleted a file on receiving side */
240: MSG_NO_SEND=102,/* sender failed to open a file we wanted */
241: MSG_DONE=86 /* current phase is done */
242: };
243:
244: #define NDX_DONE -1
245: #define NDX_FLIST_EOF -2
246: #define NDX_FLIST_OFFSET -101
247:
248: #include "errcode.h"
249:
250: #include "config.h"
251:
252: /* The default RSYNC_RSH is always set in config.h. */
253:
254: #include <stdio.h>
255: #ifdef HAVE_SYS_TYPES_H
256: # include <sys/types.h>
257: #endif
258: #ifdef HAVE_SYS_STAT_H
259: # include <sys/stat.h>
260: #endif
261: #ifdef STDC_HEADERS
262: # include <stdlib.h>
263: # include <stddef.h>
264: #else
265: # ifdef HAVE_STDLIB_H
266: # include <stdlib.h>
267: # endif
268: #endif
269: #ifdef HAVE_STRING_H
270: # if !defined STDC_HEADERS && defined HAVE_MEMORY_H
271: # include <memory.h>
272: # endif
273: # include <string.h>
274: #endif
275: #ifdef HAVE_STRINGS_H
276: # include <strings.h>
277: #endif
278: #ifdef HAVE_INTTYPES_H
279: # include <inttypes.h>
280: #endif
281: #ifdef HAVE_STDINT_H
282: # include <stdint.h>
283: #endif
284: #ifdef HAVE_UNISTD_H
285: # include <unistd.h>
286: #endif
287:
288: #ifdef HAVE_SYS_PARAM_H
289: #include <sys/param.h>
290: #endif
291:
292: #if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
293: #include <malloc.h>
294: #endif
295:
296: #ifdef HAVE_SYS_SOCKET_H
297: #include <sys/socket.h>
298: #endif
299:
300: #ifdef TIME_WITH_SYS_TIME
301: #include <sys/time.h>
302: #include <time.h>
303: #else
304: #ifdef HAVE_SYS_TIME_H
305: #include <sys/time.h>
306: #else
307: #include <time.h>
308: #endif
309: #endif
310:
311: #ifdef HAVE_FCNTL_H
312: #include <fcntl.h>
313: #else
314: #ifdef HAVE_SYS_FCNTL_H
315: #include <sys/fcntl.h>
316: #endif
317: #endif
318:
319: #ifdef HAVE_SYS_IOCTL_H
320: #include <sys/ioctl.h>
321: #endif
322:
323: #ifdef HAVE_SYS_FILIO_H
324: #include <sys/filio.h>
325: #endif
326:
327: #include <signal.h>
328: #ifdef HAVE_SYS_WAIT_H
329: #include <sys/wait.h>
330: #endif
331: #ifdef HAVE_CTYPE_H
332: #include <ctype.h>
333: #endif
334: #ifdef HAVE_GRP_H
335: #include <grp.h>
336: #endif
337: #include <errno.h>
338:
339: #ifdef HAVE_UTIME_H
340: #include <utime.h>
341: #endif
342:
343: #if defined HAVE_LUTIMES || defined HAVE_UTIMENSAT
344: #define CAN_SET_SYMLINK_TIMES 1
345: #endif
346:
347: #if defined HAVE_LCHOWN || defined CHOWN_MODIFIES_SYMLINK
348: #define CAN_CHOWN_SYMLINK 1
349: #endif
350:
351: #if defined HAVE_LCHMOD || defined HAVE_SETATTRLIST
352: #define CAN_CHMOD_SYMLINK 1
353: #endif
354:
355: #ifdef HAVE_SYS_SELECT_H
356: #include <sys/select.h>
357: #endif
358:
359: #ifdef HAVE_SYS_MODE_H
360: /* apparently AIX needs this for S_ISLNK */
361: #ifndef S_ISLNK
362: #include <sys/mode.h>
363: #endif
364: #endif
365:
366: /* these are needed for the uid/gid mapping code */
367: #include <pwd.h>
368: #include <grp.h>
369:
370: #include <stdarg.h>
371: #include <netinet/in.h>
372: #include <arpa/inet.h>
373: #ifdef HAVE_NETDB_H
374: #include <netdb.h>
375: #endif
376: #include <syslog.h>
377: #include <sys/file.h>
378:
379: #ifdef HAVE_DIRENT_H
380: # include <dirent.h>
381: #else
382: # define dirent direct
383: # ifdef HAVE_SYS_NDIR_H
384: # include <sys/ndir.h>
385: # endif
386: # ifdef HAVE_SYS_DIR_H
387: # include <sys/dir.h>
388: # endif
389: # ifdef HAVE_NDIR_H
390: # include <ndir.h>
391: # endif
392: #endif
393:
394: #ifdef MAJOR_IN_MKDEV
395: #include <sys/mkdev.h>
396: # if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
397: # define makedev mkdev
398: # endif
399: #elif defined MAJOR_IN_SYSMACROS
400: #include <sys/sysmacros.h>
401: #endif
402:
403: #ifdef MAKEDEV_TAKES_3_ARGS
404: #define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
405: #else
406: #define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
407: #endif
408:
409: #ifdef HAVE_COMPAT_H
410: #include <compat.h>
411: #endif
412:
413: #ifdef HAVE_LIMITS_H
414: # include <limits.h>
415: #endif
416:
417: #if defined USE_ICONV_OPEN && defined HAVE_ICONV_H
418: #include <iconv.h>
419: #ifndef ICONV_CONST
420: #define ICONV_CONST
421: #endif
422: #else
423: #ifdef ICONV_CONST
424: #undef ICONV_CONST
425: #endif
426: #ifdef ICONV_OPTION
427: #undef ICONV_OPTION
428: #endif
429: #ifdef iconv_t
430: #undef iconv_t
431: #endif
432: #define iconv_t int
433: #endif
434:
435: #include <assert.h>
436:
437: #include "lib/pool_alloc.h"
438:
439: #ifndef HAVE_ID_T
440: typedef unsigned int id_t;
441: #endif
442: #ifndef HAVE_PID_T
443: typedef int pid_t;
444: #endif
445: #ifndef HAVE_MODE_T
446: typedef unsigned int mode_t;
447: #endif
448: #ifndef HAVE_OFF_T
449: typedef long off_t;
450: #undef SIZEOF_OFF_T
451: #define SIZEOF_OFF_T SIZEOF_LONG
452: #endif
453: #ifndef HAVE_SIZE_T
454: typedef unsigned int size_t;
455: #endif
456:
457: #define BOOL int
458:
459: #ifndef uchar
460: #define uchar unsigned char
461: #endif
462:
463: #ifdef SIGNED_CHAR_OK
464: #define schar signed char
465: #else
466: #define schar char
467: #endif
468:
469: #ifndef int16
470: #if SIZEOF_INT16_T == 2
471: # define int16 int16_t
472: #else
473: # define int16 short
474: #endif
475: #endif
476:
477: #ifndef uint16
478: #if SIZEOF_UINT16_T == 2
479: # define uint16 uint16_t
480: #else
481: # define uint16 unsigned int16
482: #endif
483: #endif
484:
485: /* Find a variable that is either exactly 32-bits or longer.
486: * If some code depends on 32-bit truncation, it will need to
487: * take special action in a "#if SIZEOF_INT32 > 4" section. */
488: #ifndef int32
489: #if SIZEOF_INT32_T == 4
490: # define int32 int32_t
491: # define SIZEOF_INT32 4
492: #elif SIZEOF_INT == 4
493: # define int32 int
494: # define SIZEOF_INT32 4
495: #elif SIZEOF_LONG == 4
496: # define int32 long
497: # define SIZEOF_INT32 4
498: #elif SIZEOF_SHORT == 4
499: # define int32 short
500: # define SIZEOF_INT32 4
501: #elif SIZEOF_INT > 4
502: # define int32 int
503: # define SIZEOF_INT32 SIZEOF_INT
504: #elif SIZEOF_LONG > 4
505: # define int32 long
506: # define SIZEOF_INT32 SIZEOF_LONG
507: #else
508: # error Could not find a 32-bit integer variable
509: #endif
510: #else
511: # define SIZEOF_INT32 4
512: #endif
513:
514: #ifndef uint32
515: #if SIZEOF_UINT32_T == 4
516: # define uint32 uint32_t
517: #else
518: # define uint32 unsigned int32
519: #endif
520: #endif
521:
522: #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
523: #define OFF_T off_t
524: #define STRUCT_STAT struct stat
525: #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF_T
526: #else
527: #define OFF_T off64_t
528: #define STRUCT_STAT struct stat64
529: #define USE_STAT64_FUNCS 1
530: #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF64_T
531: #endif
532:
533: /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
534: * that's the maximum size the file system can handle and there is no
535: * 64-bit type available. The rsync source must therefore take steps
536: * to ensure that any code that really requires a 64-bit integer has
537: * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
538: * counter). */
539: #if SIZEOF_INT64_T == 8
540: # define int64 int64_t
541: # define SIZEOF_INT64 8
542: #elif SIZEOF_LONG == 8
543: # define int64 long
544: # define SIZEOF_INT64 8
545: #elif SIZEOF_INT == 8
546: # define int64 int
547: # define SIZEOF_INT64 8
548: #elif SIZEOF_LONG_LONG == 8
549: # define int64 long long
550: # define SIZEOF_INT64 8
551: #elif SIZEOF_OFF64_T == 8
552: # define int64 off64_t
553: # define SIZEOF_INT64 8
554: #elif SIZEOF_OFF_T == 8
555: # define int64 off_t
556: # define SIZEOF_INT64 8
557: #elif SIZEOF_INT > 8
558: # define int64 int
559: # define SIZEOF_INT64 SIZEOF_INT
560: #elif SIZEOF_LONG > 8
561: # define int64 long
562: # define SIZEOF_INT64 SIZEOF_LONG
563: #elif SIZEOF_LONG_LONG > 8
564: # define int64 long long
565: # define SIZEOF_INT64 SIZEOF_LONG_LONG
566: #else
567: /* As long as it gets... */
568: # define int64 off_t
569: # define SIZEOF_INT64 SIZEOF_OFF_T
570: #endif
571:
572: struct hashtable {
573: void *nodes;
574: int32 size, entries;
575: uint32 node_size;
576: int key64;
577: };
578:
579: struct ht_int32_node {
580: void *data;
581: int32 key;
582: };
583:
584: struct ht_int64_node {
585: void *data;
586: int64 key;
587: };
588:
589: #define HT_NODE(tbl, bkts, i) ((void*)((char*)(bkts) + (i)*(tbl)->node_size))
590: #define HT_KEY(node, k64) ((k64)? ((struct ht_int64_node*)(node))->key \
591: : (int64)((struct ht_int32_node*)(node))->key)
592:
593: #ifndef MIN
594: #define MIN(a,b) ((a)<(b)?(a):(b))
595: #endif
596:
597: #ifndef MAX
598: #define MAX(a,b) ((a)>(b)?(a):(b))
599: #endif
600:
601: #ifndef MAXHOSTNAMELEN
602: #define MAXHOSTNAMELEN 256
603: #endif
604:
605: #define SUM_LENGTH 16
606: #define SHORT_SUM_LENGTH 2
607: #define BLOCKSUM_BIAS 10
608:
609: #ifndef MAXPATHLEN
610: #define MAXPATHLEN 1024
611: #endif
612:
613: /* We want a roomy line buffer that can hold more than MAXPATHLEN,
614: * and significantly more than an overly short MAXPATHLEN. */
615: #if MAXPATHLEN < 4096
616: #define BIGPATHBUFLEN (4096+1024)
617: #else
618: #define BIGPATHBUFLEN (MAXPATHLEN+1024)
619: #endif
620:
621: #ifndef NAME_MAX
622: #define NAME_MAX 255
623: #endif
624:
625: #ifndef INADDR_NONE
626: #define INADDR_NONE 0xffffffff
627: #endif
628:
629: #ifndef IN_LOOPBACKNET
630: #define IN_LOOPBACKNET 127
631: #endif
632:
633: #if HAVE_UNIXWARE_ACLS|HAVE_SOLARIS_ACLS|HAVE_HPUX_ACLS
634: #define ACLS_NEED_MASK 1
635: #endif
636:
637: union file_extras {
638: int32 num;
639: uint32 unum;
640: };
641:
642: struct file_struct {
643: const char *dirname; /* The dir info inside the transfer */
644: time_t modtime; /* When the item was last modified */
645: uint32 len32; /* Lowest 32 bits of the file's length */
646: uint16 mode; /* The item's type and permissions */
647: uint16 flags; /* The FLAG_* bits for this item */
648: const char basename[1]; /* The basename (AKA filename) follows */
649: };
650:
651: extern int file_extra_cnt;
652: extern int inc_recurse;
653: extern int uid_ndx;
654: extern int gid_ndx;
655: extern int acls_ndx;
656: extern int xattrs_ndx;
657:
658: #define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
659: #define EXTRA_LEN (sizeof (union file_extras))
660: #define PTR_EXTRA_CNT ((sizeof (char *) + EXTRA_LEN - 1) / EXTRA_LEN)
661: #define DEV_EXTRA_CNT 2
662: #define DIRNODE_EXTRA_CNT 3
663: #define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
664:
665: #define REQ_EXTRA(f,ndx) ((union file_extras*)(f) - (ndx))
666: #define OPT_EXTRA(f,bump) ((union file_extras*)(f) - file_extra_cnt - 1 - (bump))
667:
668: #define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
669: #define HLINK_BUMP(f) ((f)->flags & (FLAG_HLINKED|FLAG_HLINK_DONE) ? inc_recurse+1 : 0)
670: #define ACL_BUMP(f) (acls_ndx ? 1 : 0)
671:
672: /* The length applies to all items. */
673: #if SIZEOF_INT64 < 8
674: #define F_LENGTH(f) ((int64)(f)->len32)
675: #else
676: #define F_LENGTH(f) ((int64)(f)->len32 + ((f)->flags & FLAG_LENGTH64 \
677: ? (int64)OPT_EXTRA(f, 0)->unum << 32 : 0))
678: #endif
679:
680: /* If there is a symlink string, it is always right after the basename */
681: #define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
682:
683: /* The sending side always has this available: */
684: #define F_PATHNAME(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_CNT))
685:
686: /* The receiving side always has this available: */
687: #define F_DEPTH(f) REQ_EXTRA(f, 1)->num
688:
689: /* When the associated option is on, all entries will have these present: */
690: #define F_OWNER(f) REQ_EXTRA(f, uid_ndx)->unum
691: #define F_GROUP(f) REQ_EXTRA(f, gid_ndx)->unum
692: #define F_ACL(f) REQ_EXTRA(f, acls_ndx)->num
693: #define F_XATTR(f) REQ_EXTRA(f, xattrs_ndx)->num
694: #define F_NDX(f) REQ_EXTRA(f, unsort_ndx)->num
695:
696: /* These items are per-entry optional: */
697: #define F_HL_GNUM(f) OPT_EXTRA(f, LEN64_BUMP(f))->num /* non-dirs */
698: #define F_HL_PREV(f) OPT_EXTRA(f, LEN64_BUMP(f)+inc_recurse)->num /* non-dirs */
699: #define F_DIR_NODE_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) \
700: + DIRNODE_EXTRA_CNT - 1)->num) /* sender dirs */
701: #define F_DIR_RELNAMES_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + DIRNODE_EXTRA_CNT \
702: + PTR_EXTRA_CNT - 1)->num) /* sender dirs */
703: #define F_DIR_DEFACL(f) OPT_EXTRA(f, LEN64_BUMP(f))->unum /* receiver dirs */
704: #define F_DIR_DEV_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + ACL_BUMP(f) \
705: + DEV_EXTRA_CNT - 1)->unum) /* receiver dirs */
706:
707: /* This optional item might follow an F_HL_*() item.
708: * (Note: a device doesn't need to check LEN64_BUMP(f).) */
709: #define F_RDEV_P(f) (&OPT_EXTRA(f, HLINK_BUMP(f) + DEV_EXTRA_CNT - 1)->unum)
710:
711: /* The sum is only present on regular files. */
712: #define F_SUM(f) ((char*)OPT_EXTRA(f, LEN64_BUMP(f) + HLINK_BUMP(f) \
713: + SUM_EXTRA_CNT - 1))
714:
715: /* Some utility defines: */
716: #define F_IS_ACTIVE(f) (f)->basename[0]
717: #define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
718:
719: #define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
720: #define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
721:
722: /* These access the F_DIR_DEV_P() and F_RDEV_P() values: */
723: #define DEV_MAJOR(a) (a)[0]
724: #define DEV_MINOR(a) (a)[1]
725:
726: /* These access the F_DIRS_NODE_P() values: */
727: #define DIR_PARENT(a) (a)[0]
728: #define DIR_FIRST_CHILD(a) (a)[1]
729: #define DIR_NEXT_SIBLING(a) (a)[2]
730:
731: /*
732: * Start the flist array at FLIST_START entries and grow it
733: * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
734: */
735: #define FLIST_START (32 * 1024)
736: #define FLIST_LINEAR (FLIST_START * 512)
737:
738: /*
739: * Extent size for allocation pools: A minimum size of 128KB
740: * is needed to mmap them so that freeing will release the
741: * space to the OS.
742: *
743: * Larger sizes reduce leftover fragments and speed free calls
744: * (when they happen). Smaller sizes increase the chance of
745: * freed allocations freeing whole extents.
746: */
747: #define NORMAL_EXTENT (256 * 1024)
748: #define SMALL_EXTENT (128 * 1024)
749:
750: #define FLIST_TEMP (1<<1)
751:
752: struct file_list {
753: struct file_list *next, *prev;
754: struct file_struct **files, **sorted;
755: alloc_pool_t file_pool;
756: void *pool_boundary;
757: int used, malloced;
758: int low, high; /* 0-relative index values excluding empties */
759: int ndx_start; /* the start offset for inc_recurse mode */
760: int flist_num; /* 1-relative file_list number or 0 */
761: int parent_ndx; /* dir_flist index of parent directory */
762: int in_progress, to_redo;
763: };
764:
765: #define SUMFLG_SAME_OFFSET (1<<0)
766:
767: struct sum_buf {
768: OFF_T offset; /**< offset in file of this chunk */
769: int32 len; /**< length of chunk of file */
770: uint32 sum1; /**< simple checksum */
771: int32 chain; /**< next hash-table collision */
772: short flags; /**< flag bits */
773: char sum2[SUM_LENGTH]; /**< checksum */
774: };
775:
776: struct sum_struct {
777: OFF_T flength; /**< total file length */
778: struct sum_buf *sums; /**< points to info for each chunk */
779: int32 count; /**< how many chunks */
780: int32 blength; /**< block_length */
781: int32 remainder; /**< flength % block_length */
782: int s2length; /**< sum2_length */
783: };
784:
785: struct map_struct {
786: OFF_T file_size; /* File size (from stat) */
787: OFF_T p_offset; /* Window start */
788: OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
789: char *p; /* Window pointer */
790: int32 p_size; /* Largest window size we allocated */
791: int32 p_len; /* Latest (rounded) window size */
792: int32 def_window_size; /* Default window size */
793: int fd; /* File Descriptor */
794: int status; /* first errno from read errors */
795: };
796:
797: #define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
798: #define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
799: #define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
800: #define MATCHFLG_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
801: #define MATCHFLG_ABS_PATH (1<<4) /* path-match on absolute path */
802: #define MATCHFLG_INCLUDE (1<<5) /* this is an include, not an exclude */
803: #define MATCHFLG_DIRECTORY (1<<6) /* this matches only directories */
804: #define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
805: #define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
806: #define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
807: #define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
808: #define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
809: #define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
810: #define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
811: #define MATCHFLG_NEGATE (1<<14)/* rule matches when pattern does not */
812: #define MATCHFLG_CVS_IGNORE (1<<15)/* rule was -C or :C */
813: #define MATCHFLG_SENDER_SIDE (1<<16)/* rule applies to the sending side */
814: #define MATCHFLG_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
815: #define MATCHFLG_CLEAR_LIST (1<<18)/* this item is the "!" token */
816: #define MATCHFLG_PERISHABLE (1<<19)/* perishable if parent dir goes away */
817:
818: #define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
819: | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
820: | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE \
821: | MATCHFLG_PERISHABLE)
822:
823: struct filter_struct {
824: struct filter_struct *next;
825: char *pattern;
826: uint32 match_flags;
827: union {
828: int slash_cnt;
829: struct filter_list_struct *mergelist;
830: } u;
831: };
832:
833: struct filter_list_struct {
834: struct filter_struct *head;
835: struct filter_struct *tail;
836: char *debug_type;
837: };
838:
839: struct stats {
840: int64 total_size;
841: int64 total_transferred_size;
842: int64 total_written;
843: int64 total_read;
844: int64 literal_data;
845: int64 matched_data;
846: int64 flist_buildtime;
847: int64 flist_xfertime;
848: int64 flist_size;
849: int num_files;
850: int num_transferred_files;
851: };
852:
853: struct chmod_mode_struct;
854:
855: struct flist_ndx_item {
856: struct flist_ndx_item *next;
857: int ndx;
858: };
859:
860: typedef struct {
861: struct flist_ndx_item *head, *tail;
862: } flist_ndx_list;
863:
864: #define EMPTY_ITEM_LIST {NULL, 0, 0}
865:
866: typedef struct {
867: void *items;
868: size_t count;
869: size_t malloced;
870: } item_list;
871:
872: #define EXPAND_ITEM_LIST(lp, type, incr) \
873: (type*)expand_item_list(lp, sizeof (type), #type, incr)
874:
875: #define EMPTY_XBUF {NULL, 0, 0, 0}
876:
877: typedef struct {
878: char *buf;
879: size_t pos; /* pos = read pos in the buf */
880: size_t len; /* len = chars following pos */
881: size_t size; /* size = total space in buf */
882: } xbuf;
883:
884: #define INIT_XBUF(xb, str, ln, sz) (xb).buf = (str), (xb).len = (ln), (xb).size = (sz), (xb).pos = 0
885: #define INIT_XBUF_STRLEN(xb, str) (xb).buf = (str), (xb).len = strlen((xb).buf), (xb).size = (-1), (xb).pos = 0
886: /* This one is used to make an output xbuf based on a char[] buffer: */
887: #define INIT_CONST_XBUF(xb, bf) (xb).buf = (bf), (xb).size = sizeof (bf), (xb).len = (xb).pos = 0
888:
889: #define ICB_EXPAND_OUT (1<<0)
890: #define ICB_INCLUDE_BAD (1<<1)
891: #define ICB_INCLUDE_INCOMPLETE (1<<2)
892:
893: #define RL_EOL_NULLS (1<<0)
894: #define RL_DUMP_COMMENTS (1<<1)
895: #define RL_CONVERT (1<<2)
896:
897: typedef struct {
898: char name_type;
899: char fname[1]; /* has variable size */
900: } relnamecache;
901:
902: #include "byteorder.h"
903: #include "lib/mdigest.h"
904: #include "lib/wildmatch.h"
905: #include "lib/permstring.h"
906: #include "lib/addrinfo.h"
907:
908: #ifndef __GNUC__
909: #define __attribute__(x)
910: #else
911: # if __GNUC__ <= 2
912: # define NORETURN
913: # endif
914: #endif
915:
916: #define UNUSED(x) x __attribute__((__unused__))
917: #ifndef NORETURN
918: #define NORETURN __attribute__((__noreturn__))
919: #endif
920:
921: typedef struct {
922: STRUCT_STAT st;
923: #ifdef SUPPORT_ACLS
924: struct rsync_acl *acc_acl; /* access ACL */
925: struct rsync_acl *def_acl; /* default ACL */
926: #endif
927: #ifdef SUPPORT_XATTRS
928: item_list *xattr;
929: #endif
930: } stat_x;
931:
932: #define ACL_READY(sx) ((sx).acc_acl != NULL)
933: #define XATTR_READY(sx) ((sx).xattr != NULL)
934:
935: #include "proto.h"
936:
937: #ifndef SUPPORT_XATTRS
938: #define x_stat(fn,fst,xst) do_stat(fn,fst)
939: #define x_lstat(fn,fst,xst) do_lstat(fn,fst)
940: #define x_fstat(fd,fst,xst) do_fstat(fd,fst)
941: #endif
942:
943: /* We have replacement versions of these if they're missing. */
944: #ifndef HAVE_ASPRINTF
945: int asprintf(char **ptr, const char *format, ...);
946: #endif
947:
948: #ifndef HAVE_VASPRINTF
949: int vasprintf(char **ptr, const char *format, va_list ap);
950: #endif
951:
952: #if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
953: #define vsnprintf rsync_vsnprintf
954: int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
955: #endif
956:
957: #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
958: #define snprintf rsync_snprintf
959: int snprintf(char *str, size_t count, const char *fmt,...);
960: #endif
961:
962:
963: #ifndef HAVE_STRERROR
964: extern char *sys_errlist[];
965: #define strerror(i) sys_errlist[i]
966: #endif
967:
968: #ifndef HAVE_STRCHR
969: # define strchr index
970: # define strrchr rindex
971: #endif
972:
973: #ifndef HAVE_ERRNO_DECL
974: extern int errno;
975: #endif
976:
977: #ifdef HAVE_READLINK
978: #define SUPPORT_LINKS 1
979: #endif
980: #ifdef HAVE_LINK
981: #define SUPPORT_HARD_LINKS 1
982: #endif
983:
984: #ifdef HAVE_SIGACTION
985: #define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
986: #define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
987: #else
988: #define SIGACTION(n,h) signal(n,h)
989: #endif
990:
991: #ifndef EWOULDBLOCK
992: #define EWOULDBLOCK EAGAIN
993: #endif
994:
995: #ifndef STDIN_FILENO
996: #define STDIN_FILENO 0
997: #endif
998:
999: #ifndef STDOUT_FILENO
1000: #define STDOUT_FILENO 1
1001: #endif
1002:
1003: #ifndef STDERR_FILENO
1004: #define STDERR_FILENO 2
1005: #endif
1006:
1007: #ifndef S_IRUSR
1008: #define S_IRUSR 0400
1009: #endif
1010:
1011: #ifndef S_IWUSR
1012: #define S_IWUSR 0200
1013: #endif
1014:
1015: #ifndef ACCESSPERMS
1016: #define ACCESSPERMS 0777
1017: #endif
1018:
1019: #ifndef S_ISVTX
1020: #define S_ISVTX 0
1021: #endif
1022:
1023: #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
1024:
1025: #ifndef _S_IFMT
1026: #define _S_IFMT 0170000
1027: #endif
1028:
1029: #ifndef _S_IFLNK
1030: #define _S_IFLNK 0120000
1031: #endif
1032:
1033: #ifndef S_ISLNK
1034: #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
1035: #endif
1036:
1037: #ifndef S_ISBLK
1038: #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
1039: #endif
1040:
1041: #ifndef S_ISCHR
1042: #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
1043: #endif
1044:
1045: #ifndef S_ISSOCK
1046: #ifdef _S_IFSOCK
1047: #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
1048: #else
1049: #define S_ISSOCK(mode) (0)
1050: #endif
1051: #endif
1052:
1053: #ifndef S_ISFIFO
1054: #ifdef _S_IFIFO
1055: #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
1056: #else
1057: #define S_ISFIFO(mode) (0)
1058: #endif
1059: #endif
1060:
1061: #ifndef S_ISDIR
1062: #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
1063: #endif
1064:
1065: #ifndef S_ISREG
1066: #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
1067: #endif
1068:
1069: /* work out what fcntl flag to use for non-blocking */
1070: #ifdef O_NONBLOCK
1071: # define NONBLOCK_FLAG O_NONBLOCK
1072: #elif defined SYSV
1073: # define NONBLOCK_FLAG O_NDELAY
1074: #else
1075: # define NONBLOCK_FLAG FNDELAY
1076: #endif
1077:
1078: #ifndef INADDR_LOOPBACK
1079: #define INADDR_LOOPBACK 0x7f000001
1080: #endif
1081:
1082: #ifndef INADDR_NONE
1083: #define INADDR_NONE 0xffffffff
1084: #endif
1085:
1086: #define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
1087: #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
1088:
1089: #define PRESERVE_FILE_TIMES (1<<0)
1090: #define PRESERVE_DIR_TIMES (1<<1)
1091: #define PRESERVE_LINK_TIMES (1<<2)
1092:
1093: /* Initial mask on permissions given to temporary files. Mask off setuid
1094: bits and group access because of potential race-condition security
1095: holes, and mask other access because mode 707 is bizarre */
1096: #define INITACCESSPERMS 0700
1097:
1098: /* handler for null strings in printf format */
1099: #define NS(s) ((s)?(s):"<NULL>")
1100:
1101: /* Convenient wrappers for malloc and realloc. Use them. */
1102: #define new(type) ((type*)malloc(sizeof (type)))
1103: #define new0(type) ((type*)calloc(1, sizeof (type)))
1104: #define new_array(type, num) ((type*)_new_array((num), sizeof (type), 0))
1105: #define new_array0(type, num) ((type*)_new_array((num), sizeof (type), 1))
1106: #define realloc_array(ptr, type, num) ((type*)_realloc_array((ptr), sizeof(type), (num)))
1107:
1108: /* use magic gcc attributes to catch format errors */
1109: void rprintf(enum logcode , const char *, ...)
1110: __attribute__((format (printf, 2, 3)))
1111: ;
1112:
1113: /* This is just like rprintf, but it also tries to print some
1114: * representation of the error code. Normally errcode = errno. */
1115: void rsyserr(enum logcode, int, const char *, ...)
1116: __attribute__((format (printf, 3, 4)))
1117: ;
1118:
1119: /* Make sure that the O_BINARY flag is defined. */
1120: #ifndef O_BINARY
1121: #define O_BINARY 0
1122: #endif
1123:
1124: #ifndef HAVE_STRLCPY
1125: size_t strlcpy(char *d, const char *s, size_t bufsize);
1126: #endif
1127:
1128: #ifndef HAVE_STRLCAT
1129: size_t strlcat(char *d, const char *s, size_t bufsize);
1130: #endif
1131:
1132: #ifndef WEXITSTATUS
1133: #define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
1134: #endif
1135: #ifndef WIFEXITED
1136: #define WIFEXITED(stat) ((int)((stat)&0xFF) == 0)
1137: #endif
1138:
1139: #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
1140:
1141: #ifdef HAVE_GETEUID
1142: #define MY_UID() geteuid()
1143: #else
1144: #define MY_UID() getuid()
1145: #endif
1146:
1147: #ifdef HAVE_GETEGID
1148: #define MY_GID() getegid()
1149: #else
1150: #define MY_GID() getgid()
1151: #endif
1152:
1153: #ifdef FORCE_FD_ZERO_MEMSET
1154: #undef FD_ZERO
1155: #define FD_ZERO(fdsetp) memset(fdsetp, 0, sizeof (fd_set))
1156: #endif
1157:
1158: extern int verbose;
1159:
1160: #ifndef HAVE_INET_NTOP
1161: const char *inet_ntop(int af, const void *src, char *dst, size_t size);
1162: #endif
1163:
1164: #ifndef HAVE_INET_PTON
1165: int inet_pton(int af, const char *src, void *dst);
1166: #endif
1167:
1168: #ifdef MAINTAINER_MODE
1169: const char *get_panic_action(void);
1170: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to rsync.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / rsync