Annotation of src/usr.bin/rsync/extern.h, Revision 1.21
1.21 ! benno 1: /* $Id: extern.h,v 1.20 2019/02/18 21:55:27 benno Exp $ */
1.1 benno 2: /*
3: * Copyright (c) 2019 Kristaps Dzonsons <kristaps@bsd.lv>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
17: #ifndef EXTERN_H
18: #define EXTERN_H
19:
20: /*
21: * This is the rsync protocol version that we support.
22: */
23: #define RSYNC_PROTOCOL (27)
24:
25: /*
26: * Maximum amount of file data sent over the wire at once.
27: */
28: #define MAX_CHUNK (32 * 1024)
29:
30: /*
31: * This is the minimum size for a block of data not including those in
32: * the remainder block.
33: */
34: #define BLOCK_SIZE_MIN (700)
35:
36: /*
37: * The sender and receiver use a two-phase synchronisation process.
38: * The first uses two-byte hashes; the second, 16-byte.
39: * (The second must hold a full MD4 digest.)
40: */
41: #define CSUM_LENGTH_PHASE1 (2)
42: #define CSUM_LENGTH_PHASE2 (16)
43:
1.14 florian 44: /*
45: * Use this for debugging deadlocks.
46: * All poll events will use it and catch time-outs.
47: */
48: #define POLL_TIMEOUT (INFTIM)
1.13 florian 49:
1.1 benno 50: /*
51: * Operating mode for a client or a server.
52: * Sender means we synchronise local files with those from remote.
53: * Receiver is the opposite.
54: * This is relative to which host we're running on.
55: */
56: enum fmode {
57: FARGS_SENDER,
58: FARGS_RECEIVER
59: };
60:
61: /*
62: * File arguments given on the command line.
63: * See struct opts.
64: */
65: struct fargs {
66: char *host; /* hostname or NULL if local */
67: char **sources; /* transfer source */
68: size_t sourcesz; /* number of sources */
69: char *sink; /* transfer endpoint */
70: enum fmode mode; /* mode of operation */
71: int remote; /* uses rsync:// or :: for remote */
72: char *module; /* if rsync://, the module */
73: };
74:
75: /*
76: * The subset of stat(2) information that we need.
77: * (There are some parts we don't use yet.)
78: */
79: struct flstat {
1.12 florian 80: mode_t mode; /* mode */
81: uid_t uid; /* user */
82: gid_t gid; /* group */
83: dev_t rdev; /* device type */
84: off_t size; /* size */
85: time_t mtime; /* modification */
1.1 benno 86: unsigned int flags;
1.12 florian 87: #define FLSTAT_TOP_DIR 0x01 /* a top-level directory */
1.1 benno 88:
89: };
90:
91: /*
92: * A list of files with their statistics.
93: */
94: struct flist {
95: char *path; /* path relative to root */
96: const char *wpath; /* "working" path for receiver */
97: struct flstat st; /* file information */
98: char *link; /* symlink target or NULL */
99: };
100:
101: /*
102: * Options passed into the command line.
103: * See struct fargs.
104: */
105: struct opts {
1.3 deraadt 106: int sender; /* --sender */
107: int server; /* --server */
108: int recursive; /* -r */
109: int verbose; /* -v */
110: int dry_run; /* -n */
111: int preserve_times; /* -t */
112: int preserve_perms; /* -p */
113: int preserve_links; /* -l */
1.5 benno 114: int preserve_gids; /* -g */
1.9 florian 115: int preserve_uids; /* -u */
1.3 deraadt 116: int del; /* --delete */
1.12 florian 117: int devices; /* --devices */
118: int specials; /* --specials */
1.3 deraadt 119: char *rsync_path; /* --rsync-path */
1.4 deraadt 120: char *ssh_prog; /* --rsh or -e */
1.18 deraadt 121: char *port; /* --port */
1.1 benno 122: };
123:
124: /*
125: * An individual block description for a file.
126: * See struct blkset.
127: */
128: struct blk {
129: off_t offs; /* offset in file */
130: size_t idx; /* block index */
131: size_t len; /* bytes in block */
132: uint32_t chksum_short; /* fast checksum */
133: unsigned char chksum_long[CSUM_LENGTH_PHASE2]; /* slow checksum */
134: };
135:
1.14 florian 136: enum blkstatst {
137: BLKSTAT_NONE = 0,
1.21 ! benno 138: BLKSTAT_NEXT,
1.14 florian 139: BLKSTAT_DATA,
140: BLKSTAT_TOK,
141: BLKSTAT_HASH,
1.21 ! benno 142: BLKSTAT_DONE,
! 143: BLKSTAT_PHASE,
1.14 florian 144: };
145:
1.1 benno 146: /*
1.13 florian 147: * Information for the sender updating receiver blocks reentrantly.
148: */
149: struct blkstat {
1.14 florian 150: off_t offs; /* position in sender file */
151: off_t total; /* total amount processed */
152: off_t dirty; /* total amount sent */
153: size_t hint; /* optimisation: next probable match */
154: void *map; /* mapped file or MAP_FAILED otherwise */
155: size_t mapsz; /* size of file or zero */
156: int fd; /* descriptor girding the map */
157: enum blkstatst curst; /* FSM for sending file blocks */
158: off_t curpos; /* sending: position in file to send */
159: off_t curlen; /* sending: length of send */
160: int32_t curtok; /* sending: next matching token or zero */
1.13 florian 161: };
162:
163: /*
1.1 benno 164: * When transferring file contents, we break the file down into blocks
165: * and work with those.
166: */
167: struct blkset {
168: off_t size; /* file size */
169: size_t rem; /* terminal block length if non-zero */
170: size_t len; /* block length */
171: size_t csum; /* checksum length */
172: struct blk *blks; /* all blocks */
173: size_t blksz; /* number of blks */
174: };
175:
176: /*
177: * Values required during a communication session.
178: */
179: struct sess {
180: const struct opts *opts; /* system options */
181: int32_t seed; /* checksum seed */
182: int32_t lver; /* local version */
183: int32_t rver; /* remote version */
184: uint64_t total_read; /* non-logging wire/reads */
185: uint64_t total_size; /* total file size */
186: uint64_t total_write; /* non-logging wire/writes */
187: int mplex_reads; /* multiplexing reads? */
188: size_t mplex_read_remain; /* remaining bytes */
189: int mplex_writes; /* multiplexing writes? */
190: };
191:
1.6 benno 192: /*
193: * Combination of name and numeric id for groups and users.
194: */
195: struct ident {
196: int32_t id; /* the gid_t or uid_t */
197: int32_t mapped; /* if receiving, the mapped gid */
198: char *name; /* resolved name */
199: };
200:
1.1 benno 201: struct download;
202: struct upload;
203:
1.17 deraadt 204: #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b))
1.14 florian 205:
1.1 benno 206: #define LOG0(_sess, _fmt, ...) \
207: rsync_log((_sess), __FILE__, __LINE__, -1, (_fmt), ##__VA_ARGS__)
208: #define LOG1(_sess, _fmt, ...) \
209: rsync_log((_sess), __FILE__, __LINE__, 0, (_fmt), ##__VA_ARGS__)
210: #define LOG2(_sess, _fmt, ...) \
211: rsync_log((_sess), __FILE__, __LINE__, 1, (_fmt), ##__VA_ARGS__)
212: #define LOG3(_sess, _fmt, ...) \
213: rsync_log((_sess), __FILE__, __LINE__, 2, (_fmt), ##__VA_ARGS__)
214: #define LOG4(_sess, _fmt, ...) \
215: rsync_log((_sess), __FILE__, __LINE__, 3, (_fmt), ##__VA_ARGS__)
216: #define ERRX1(_sess, _fmt, ...) \
217: rsync_errx1((_sess), __FILE__, __LINE__, (_fmt), ##__VA_ARGS__)
218: #define WARNX(_sess, _fmt, ...) \
219: rsync_warnx((_sess), __FILE__, __LINE__, (_fmt), ##__VA_ARGS__)
220: #define WARN(_sess, _fmt, ...) \
221: rsync_warn((_sess), 0, __FILE__, __LINE__, (_fmt), ##__VA_ARGS__)
222: #define WARN1(_sess, _fmt, ...) \
223: rsync_warn((_sess), 1, __FILE__, __LINE__, (_fmt), ##__VA_ARGS__)
224: #define WARN2(_sess, _fmt, ...) \
225: rsync_warn((_sess), 2, __FILE__, __LINE__, (_fmt), ##__VA_ARGS__)
226: #define ERR(_sess, _fmt, ...) \
227: rsync_err((_sess), __FILE__, __LINE__, (_fmt), ##__VA_ARGS__)
228: #define ERRX(_sess, _fmt, ...) \
229: rsync_errx((_sess), __FILE__, __LINE__, (_fmt), ##__VA_ARGS__)
230:
231: __BEGIN_DECLS
232:
233: void rsync_log(struct sess *,
234: const char *, size_t, int, const char *, ...)
235: __attribute__((format(printf, 5, 6)));
236: void rsync_warnx1(struct sess *,
237: const char *, size_t, const char *, ...)
238: __attribute__((format(printf, 4, 5)));
239: void rsync_warn(struct sess *, int,
240: const char *, size_t, const char *, ...)
241: __attribute__((format(printf, 5, 6)));
242: void rsync_warnx(struct sess *, const char *,
243: size_t, const char *, ...)
244: __attribute__((format(printf, 4, 5)));
245: void rsync_err(struct sess *, const char *,
246: size_t, const char *, ...)
247: __attribute__((format(printf, 4, 5)));
248: void rsync_errx(struct sess *, const char *,
249: size_t, const char *, ...)
250: __attribute__((format(printf, 4, 5)));
251: void rsync_errx1(struct sess *, const char *,
252: size_t, const char *, ...)
253: __attribute__((format(printf, 4, 5)));
254:
1.2 benno 255: int flist_del(struct sess *, int,
1.1 benno 256: const struct flist *, size_t);
257: int flist_gen(struct sess *, size_t, char **,
258: struct flist **, size_t *);
259: int flist_gen_local(struct sess *, const char *,
260: struct flist **, size_t *);
261: void flist_free(struct flist *, size_t);
262: int flist_recv(struct sess *, int,
263: struct flist **, size_t *);
264: int flist_send(struct sess *, int, int,
265: const struct flist *, size_t);
1.2 benno 266: int flist_gen_dels(struct sess *, const char *,
1.1 benno 267: struct flist **, size_t *,
268: const struct flist *, size_t);
269:
270: char **fargs_cmdline(struct sess *, const struct fargs *);
271:
272: int io_read_buf(struct sess *, int, void *, size_t);
273: int io_read_byte(struct sess *, int, uint8_t *);
274: int io_read_check(struct sess *, int);
275: int io_read_flush(struct sess *, int);
276: int io_read_int(struct sess *, int, int32_t *);
277: int io_read_long(struct sess *, int, int64_t *);
278: int io_read_size(struct sess *, int, size_t *);
279: int io_read_ulong(struct sess *, int, uint64_t *);
280: int io_write_buf(struct sess *, int, const void *, size_t);
281: int io_write_byte(struct sess *, int, uint8_t);
282: int io_write_int(struct sess *, int, int32_t);
283: int io_write_line(struct sess *, int, const char *);
284: int io_write_long(struct sess *, int, int64_t);
285:
1.14 florian 286: int io_lowbuffer_alloc(struct sess *, void **,
287: size_t *, size_t *, size_t);
288: void io_lowbuffer_int(struct sess *, void *,
289: size_t *, size_t, int32_t);
290: void io_lowbuffer_buf(struct sess *, void *,
291: size_t *, size_t, const void *, size_t);
292:
1.2 benno 293: void io_buffer_int(struct sess *, void *,
1.1 benno 294: size_t *, size_t, int32_t);
1.2 benno 295: void io_buffer_buf(struct sess *, void *,
1.1 benno 296: size_t *, size_t, const void *, size_t);
297:
1.2 benno 298: void io_unbuffer_int(struct sess *, const void *,
1.1 benno 299: size_t *, size_t, int32_t *);
1.2 benno 300: int io_unbuffer_size(struct sess *, const void *,
1.1 benno 301: size_t *, size_t, size_t *);
1.2 benno 302: void io_unbuffer_buf(struct sess *, const void *,
1.1 benno 303: size_t *, size_t, void *, size_t);
304:
305: void rsync_child(const struct opts *, int, const struct fargs *)
306: __attribute__((noreturn));
307: int rsync_receiver(struct sess *, int, int, const char *);
308: int rsync_sender(struct sess *, int, int, size_t, char **);
309: int rsync_client(const struct opts *, int, const struct fargs *);
310: int rsync_socket(const struct opts *, const struct fargs *);
311: int rsync_server(const struct opts *, size_t, char *[]);
312: int rsync_downloader(struct download *, struct sess *, int *);
1.15 florian 313: int rsync_set_metadata(struct sess *, int, int,
1.10 florian 314: const struct flist *, const char *);
1.16 deraadt 315: int rsync_set_metadata_at(struct sess *, int, int,
1.12 florian 316: const struct flist *, const char *);
1.2 benno 317: int rsync_uploader(struct upload *,
1.1 benno 318: int *, struct sess *, int *);
319: int rsync_uploader_tail(struct upload *, struct sess *);
320:
321: struct download *download_alloc(struct sess *, int,
322: const struct flist *, size_t, int);
323: void download_free(struct download *);
1.12 florian 324: struct upload *upload_alloc(struct sess *, const char *, int, int, size_t,
1.1 benno 325: const struct flist *, size_t, mode_t);
326: void upload_free(struct upload *);
327:
328: struct blkset *blk_recv(struct sess *, int, const char *);
1.21 ! benno 329: void blk_recv_ack(struct sess *,
! 330: char [20], const struct blkset *, int32_t);
1.14 florian 331: void blk_match(struct sess *, const struct blkset *,
1.13 florian 332: const char *, struct blkstat *);
1.1 benno 333: int blk_send(struct sess *, int, size_t,
334: const struct blkset *, const char *);
335: int blk_send_ack(struct sess *, int, struct blkset *);
336:
337: uint32_t hash_fast(const void *, size_t);
338: void hash_slow(const void *, size_t,
339: unsigned char *, const struct sess *);
340: void hash_file(const void *, size_t,
341: unsigned char *, const struct sess *);
342:
343: int mkpath(struct sess *, char *);
1.11 florian 344:
345: int mkstempat(int, char *);
346: char *mkstemplinkat(char*, int, char *);
1.12 florian 347: char *mkstempfifoat(int, char *);
348: char *mkstempnodat(int, char *, mode_t, dev_t);
349: char *mkstempsock(const char *, char *);
1.21 ! benno 350: int mktemplate(struct sess *, char **, const char *, int);
1.1 benno 351:
352: char *symlink_read(struct sess *, const char *);
353: char *symlinkat_read(struct sess *, int, const char *);
354:
355: int sess_stats_send(struct sess *, int);
356: int sess_stats_recv(struct sess *, int);
1.6 benno 357:
1.9 florian 358: int idents_add(struct sess *, int, struct ident **, size_t *,
359: int32_t);
360: void idents_assign_gid(struct sess *,
361: struct flist *, size_t, const struct ident *, size_t);
362: void idents_assign_uid(struct sess *,
363: struct flist *, size_t, const struct ident *, size_t);
1.6 benno 364: void idents_free(struct ident *, size_t);
1.7 benno 365: int idents_recv(struct sess *, int, struct ident **, size_t *);
1.9 florian 366: void idents_remap(struct sess *, int, struct ident *, size_t);
1.6 benno 367: int idents_send(struct sess *, int, const struct ident *, size_t);
1.1 benno 368:
369: __END_DECLS
370:
371: #endif /*!EXTERN_H*/
![[BACK]](/icons/back.gif){kind=icon}
Return to extern.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / rsync