1 /* $Id: extern.h,v 1.33 2020/05/17 19:54:41 deraadt Exp $ */ 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 44 /* 45 * Use this for debugging deadlocks. 46 * All poll events will use it and catch time-outs. 47 */ 48 #define POLL_TIMEOUT (INFTIM) 49 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 { 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 */ 86 unsigned int flags; 87 #define FLSTAT_TOP_DIR 0x01 /* a top-level directory */ 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 { 106 int sender; /* --sender */ 107 int server; /* --server */ 108 int recursive; /* -r */ 109 int dry_run; /* -n */ 110 int preserve_times; /* -t */ 111 int preserve_perms; /* -p */ 112 int preserve_links; /* -l */ 113 int preserve_gids; /* -g */ 114 int preserve_uids; /* -u */ 115 int del; /* --delete */ 116 int devices; /* --devices */ 117 int specials; /* --specials */ 118 int numeric_ids; /* --numeric-ids */ 119 int one_file_system; /* -x */ 120 char *rsync_path; /* --rsync-path */ 121 char *ssh_prog; /* --rsh or -e */ 122 char *port; /* --port */ 123 char *address; /* --address */ 124 }; 125 126 /* 127 * An individual block description for a file. 128 * See struct blkset. 129 */ 130 struct blk { 131 off_t offs; /* offset in file */ 132 size_t idx; /* block index */ 133 size_t len; /* bytes in block */ 134 uint32_t chksum_short; /* fast checksum */ 135 unsigned char chksum_long[CSUM_LENGTH_PHASE2]; /* slow checksum */ 136 }; 137 138 enum blkstatst { 139 BLKSTAT_NONE = 0, 140 BLKSTAT_NEXT, 141 BLKSTAT_DATA, 142 BLKSTAT_TOK, 143 BLKSTAT_HASH, 144 BLKSTAT_DONE, 145 BLKSTAT_PHASE, 146 }; 147 148 /* 149 * Information for the sender updating receiver blocks reentrantly. 150 */ 151 struct blkstat { 152 off_t offs; /* position in sender file */ 153 off_t total; /* total amount processed */ 154 off_t dirty; /* total amount sent */ 155 size_t hint; /* optimisation: next probable match */ 156 void *map; /* mapped file or MAP_FAILED otherwise */ 157 size_t mapsz; /* size of file or zero */ 158 int fd; /* descriptor girding the map */ 159 enum blkstatst curst; /* FSM for sending file blocks */ 160 off_t curpos; /* sending: position in file to send */ 161 off_t curlen; /* sending: length of send */ 162 int32_t curtok; /* sending: next matching token or zero */ 163 struct blktab *blktab; /* hashtable of blocks */ 164 uint32_t s1; /* partial sum for computing fast hash */ 165 uint32_t s2; /* partial sum for computing fast hash */ 166 }; 167 168 /* 169 * When transferring file contents, we break the file down into blocks 170 * and work with those. 171 */ 172 struct blkset { 173 off_t size; /* file size */ 174 size_t rem; /* terminal block length if non-zero */ 175 size_t len; /* block length */ 176 size_t csum; /* checksum length */ 177 struct blk *blks; /* all blocks */ 178 size_t blksz; /* number of blks */ 179 }; 180 181 /* 182 * Values required during a communication session. 183 */ 184 struct sess { 185 const struct opts *opts; /* system options */ 186 int32_t seed; /* checksum seed */ 187 int32_t lver; /* local version */ 188 int32_t rver; /* remote version */ 189 uint64_t total_read; /* non-logging wire/reads */ 190 uint64_t total_size; /* total file size */ 191 uint64_t total_write; /* non-logging wire/writes */ 192 int mplex_reads; /* multiplexing reads? */ 193 size_t mplex_read_remain; /* remaining bytes */ 194 int mplex_writes; /* multiplexing writes? */ 195 }; 196 197 /* 198 * Combination of name and numeric id for groups and users. 199 */ 200 struct ident { 201 int32_t id; /* the gid_t or uid_t */ 202 int32_t mapped; /* if receiving, the mapped gid */ 203 char *name; /* resolved name */ 204 }; 205 206 typedef struct arglist arglist; 207 struct arglist { 208 char **list; 209 u_int num; 210 u_int nalloc; 211 }; 212 void addargs(arglist *, char *, ...) 213 __attribute__((format(printf, 2, 3))); 214 void freeargs(arglist *); 215 216 struct download; 217 struct upload; 218 219 extern int verbose; 220 221 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) 222 223 #define LOG0(_fmt, ...) \ 224 rsync_log( -1, (_fmt), ##__VA_ARGS__) 225 #define LOG1(_fmt, ...) \ 226 rsync_log( 0, (_fmt), ##__VA_ARGS__) 227 #define LOG2(_fmt, ...) \ 228 rsync_log( 1, (_fmt), ##__VA_ARGS__) 229 #define LOG3(_fmt, ...) \ 230 rsync_log( 2, (_fmt), ##__VA_ARGS__) 231 #define LOG4(_fmt, ...) \ 232 rsync_log( 3, (_fmt), ##__VA_ARGS__) 233 #define ERRX1(_fmt, ...) \ 234 rsync_errx1( (_fmt), ##__VA_ARGS__) 235 #define WARNX(_fmt, ...) \ 236 rsync_warnx( (_fmt), ##__VA_ARGS__) 237 #define WARN(_fmt, ...) \ 238 rsync_warn(0, (_fmt), ##__VA_ARGS__) 239 #define WARN1(_fmt, ...) \ 240 rsync_warn(1, (_fmt), ##__VA_ARGS__) 241 #define WARN2(_fmt, ...) \ 242 rsync_warn(2, (_fmt), ##__VA_ARGS__) 243 #define ERR(_fmt, ...) \ 244 rsync_err( (_fmt), ##__VA_ARGS__) 245 #define ERRX(_fmt, ...) \ 246 rsync_errx( (_fmt), ##__VA_ARGS__) 247 248 void rsync_log(int, const char *, ...) 249 __attribute__((format(printf, 2, 3))); 250 void rsync_warnx1(const char *, ...) 251 __attribute__((format(printf, 1, 2))); 252 void rsync_warn(int, const char *, ...) 253 __attribute__((format(printf, 2, 3))); 254 void rsync_warnx(const char *, ...) 255 __attribute__((format(printf, 1, 2))); 256 void rsync_err(const char *, ...) 257 __attribute__((format(printf, 1, 2))); 258 void rsync_errx(const char *, ...) 259 __attribute__((format(printf, 1, 2))); 260 void rsync_errx1(const char *, ...) 261 __attribute__((format(printf, 1, 2))); 262 263 int flist_del(struct sess *, int, 264 const struct flist *, size_t); 265 int flist_gen(struct sess *, size_t, char **, 266 struct flist **, size_t *); 267 int flist_gen_local(struct sess *, const char *, 268 struct flist **, size_t *); 269 void flist_free(struct flist *, size_t); 270 int flist_recv(struct sess *, int, 271 struct flist **, size_t *); 272 int flist_send(struct sess *, int, int, 273 const struct flist *, size_t); 274 int flist_gen_dels(struct sess *, const char *, 275 struct flist **, size_t *, 276 const struct flist *, size_t); 277 278 char **fargs_cmdline(struct sess *, const struct fargs *, size_t *); 279 280 int io_read_buf(struct sess *, int, void *, size_t); 281 int io_read_byte(struct sess *, int, uint8_t *); 282 int io_read_check(int); 283 int io_read_flush(struct sess *, int); 284 int io_read_int(struct sess *, int, int32_t *); 285 int io_read_uint(struct sess *, int, uint32_t *); 286 int io_read_long(struct sess *, int, int64_t *); 287 int io_read_size(struct sess *, int, size_t *); 288 int io_read_ulong(struct sess *, int, uint64_t *); 289 int io_write_buf(struct sess *, int, const void *, size_t); 290 int io_write_byte(struct sess *, int, uint8_t); 291 int io_write_int(struct sess *, int, int32_t); 292 int io_write_uint(struct sess *, int, uint32_t); 293 int io_write_line(struct sess *, int, const char *); 294 int io_write_long(struct sess *, int, int64_t); 295 int io_write_ulong(struct sess *, int, uint64_t); 296 297 int io_lowbuffer_alloc(struct sess *, void **, 298 size_t *, size_t *, size_t); 299 void io_lowbuffer_int(struct sess *, void *, 300 size_t *, size_t, int32_t); 301 void io_lowbuffer_buf(struct sess *, void *, 302 size_t *, size_t, const void *, size_t); 303 304 void io_buffer_int(void *, size_t *, size_t, int32_t); 305 void io_buffer_buf(void *, size_t *, size_t, const void *, size_t); 306 307 void io_unbuffer_int(const void *, 308 size_t *, size_t, int32_t *); 309 int io_unbuffer_size(const void *, size_t *, size_t, size_t *); 310 void io_unbuffer_buf(const void *, size_t *, size_t, void *, size_t); 311 312 int rsync_receiver(struct sess *, int, int, const char *); 313 int rsync_sender(struct sess *, int, int, size_t, char **); 314 int rsync_client(const struct opts *, int, const struct fargs *); 315 int rsync_connect(const struct opts *, int *, 316 const struct fargs *); 317 int rsync_socket(const struct opts *, int, const struct fargs *); 318 int rsync_server(const struct opts *, size_t, char *[]); 319 int rsync_downloader(struct download *, struct sess *, int *); 320 int rsync_set_metadata(struct sess *, int, int, 321 const struct flist *, const char *); 322 int rsync_set_metadata_at(struct sess *, int, int, 323 const struct flist *, const char *); 324 int rsync_uploader(struct upload *, 325 int *, struct sess *, int *); 326 int rsync_uploader_tail(struct upload *, struct sess *); 327 328 struct download *download_alloc(struct sess *, int, 329 const struct flist *, size_t, int); 330 void download_free(struct download *); 331 struct upload *upload_alloc(const char *, int, int, size_t, 332 const struct flist *, size_t, mode_t); 333 void upload_free(struct upload *); 334 335 struct blktab *blkhash_alloc(void); 336 int blkhash_set(struct blktab *, const struct blkset *); 337 void blkhash_free(struct blktab *); 338 339 struct blkset *blk_recv(struct sess *, int, const char *); 340 void blk_recv_ack(char [20], const struct blkset *, int32_t); 341 void blk_match(struct sess *, const struct blkset *, 342 const char *, struct blkstat *); 343 int blk_send(struct sess *, int, size_t, 344 const struct blkset *, const char *); 345 int blk_send_ack(struct sess *, int, struct blkset *); 346 347 uint32_t hash_fast(const void *, size_t); 348 void hash_slow(const void *, size_t, 349 unsigned char *, const struct sess *); 350 void hash_file(const void *, size_t, 351 unsigned char *, const struct sess *); 352 353 int mkpath(char *); 354 355 int mkstempat(int, char *); 356 char *mkstemplinkat(char*, int, char *); 357 char *mkstempfifoat(int, char *); 358 char *mkstempnodat(int, char *, mode_t, dev_t); 359 char *mkstempsock(const char *, char *); 360 int mktemplate(char **, const char *, int); 361 362 char *symlink_read(const char *); 363 char *symlinkat_read(int, const char *); 364 365 int sess_stats_send(struct sess *, int); 366 int sess_stats_recv(struct sess *, int); 367 368 int idents_add(int, struct ident **, size_t *, int32_t); 369 void idents_assign_gid(struct sess *, 370 struct flist *, size_t, const struct ident *, size_t); 371 void idents_assign_uid(struct sess *, 372 struct flist *, size_t, const struct ident *, size_t); 373 void idents_free(struct ident *, size_t); 374 int idents_recv(struct sess *, int, struct ident **, size_t *); 375 void idents_remap(struct sess *, int, struct ident *, size_t); 376 int idents_send(struct sess *, int, const struct ident *, size_t); 377 378 #endif /*!EXTERN_H*/ 379