2 * Routines used by the file-transfer code.
4 * Copyright (C) 1996 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2003-2019 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
26 extern int do_compression;
27 extern int protocol_version;
29 extern int def_compress_level;
30 extern char *skip_compress;
32 static int compression_level, per_file_default_level;
35 struct suffix_tree *sibling;
36 struct suffix_tree *child;
37 char letter, word_end;
40 static char *match_list;
41 static struct suffix_tree *suftree;
43 static void add_suffix(struct suffix_tree **prior, char ltr, const char *str)
45 struct suffix_tree *node, *newnode;
48 const char *after = strchr(str, ']');
49 /* Treat "[foo" and "[]" as having a literal '['. */
50 if (after && after++ != str+1) {
51 while ((ltr = *str++) != ']')
52 add_suffix(prior, ltr, after);
57 for (node = *prior; node; prior = &node->sibling, node = node->sibling) {
58 if (node->letter == ltr) {
60 add_suffix(&node->child, *str, str+1);
65 if (node->letter > ltr)
68 if (!(newnode = new(struct suffix_tree)))
69 out_of_memory("add_suffix");
70 newnode->sibling = node;
71 newnode->child = NULL;
72 newnode->letter = ltr;
75 add_suffix(&newnode->child, *str, str+1);
76 newnode->word_end = 0;
78 newnode->word_end = 1;
81 static void add_nocompress_suffixes(const char *str)
86 if (!(buf = new_array(char, strlen(f) + 1)))
87 out_of_memory("add_nocompress_suffixes");
101 } while (*++f != '/' && *f);
104 add_suffix(&suftree, *buf, buf+1);
110 static void init_set_compression(void)
116 add_nocompress_suffixes(skip_compress);
118 /* A non-daemon transfer skips the default suffix list if the
119 * user specified --skip-compress. */
120 if (skip_compress && module_id < 0)
123 f = lp_dont_compress(module_id);
125 if (!(match_list = t = new_array(char, strlen(f) + 2)))
126 out_of_memory("set_compression");
128 per_file_default_level = def_compress_level;
142 } while (*++f != ' ' && *f);
145 if (t - start == 1+1 && *start == '*') {
146 /* Optimize a match-string of "*". */
149 per_file_default_level = 0;
153 /* Move *.foo items into the stuffix tree. */
154 if (*start == '*' && start[1] == '.' && start[2]
155 && !strpbrk(start+2, ".?*")) {
156 add_suffix(&suftree, start[2], start+3);
163 /* determine the compression level based on a wildcard filename list */
164 void set_compression(const char *fname)
166 const struct suffix_tree *node;
174 init_set_compression();
176 compression_level = per_file_default_level;
178 if (!*match_list && !suftree)
181 if ((s = strrchr(fname, '/')) != NULL)
184 for (s = match_list; *s; s += strlen(s) + 1) {
185 if (iwildmatch(s, fname)) {
186 compression_level = 0;
191 if (!(node = suftree) || !(s = strrchr(fname, '.'))
192 || s == fname || !(ltr = *++s))
198 while (node->letter != ltr) {
199 if (node->letter > ltr)
201 if (!(node = node->sibling))
204 if ((ltr = *++s) == '\0') {
206 compression_level = 0;
209 if (!(node = node->child))
214 /* non-compressing recv token */
215 static int32 simple_recv_token(int f, char **data)
217 static int32 residue;
222 buf = new_array(char, CHUNK_SIZE);
224 out_of_memory("simple_recv_token");
228 int32 i = read_int(f);
235 n = MIN(CHUNK_SIZE,residue);
241 /* non-compressing send token */
242 static void simple_send_token(int f, int32 token, struct map_struct *buf,
243 OFF_T offset, int32 n)
248 int32 n1 = MIN(CHUNK_SIZE, n-len);
250 write_buf(f, map_ptr(buf, offset+len, n1), n1);
254 /* a -2 token means to send data only and no token */
256 write_int(f, -(token+1));
259 /* Flag bytes in compressed stream are encoded as follows: */
260 #define END_FLAG 0 /* that's all folks */
261 #define TOKEN_LONG 0x20 /* followed by 32-bit token number */
262 #define TOKENRUN_LONG 0x21 /* ditto with 16-bit run count */
263 #define DEFLATED_DATA 0x40 /* + 6-bit high len, then low len byte */
264 #define TOKEN_REL 0x80 /* + 6-bit relative token number */
265 #define TOKENRUN_REL 0xc0 /* ditto with 16-bit run count */
267 #define MAX_DATA_COUNT 16383 /* fit 14 bit count into 2 bytes with flags */
269 /* zlib.h says that if we want to be able to compress something in a single
270 * call, avail_out must be at least 0.1% larger than avail_in plus 12 bytes.
271 * We'll add in 0.1%+16, just to be safe (and we'll avoid floating point,
272 * to ensure that this is a compile-time value). */
273 #define AVAIL_OUT_SIZE(avail_in_size) ((avail_in_size)*1001/1000+16)
275 /* For coding runs of tokens */
276 static int32 last_token = -1;
277 static int32 run_start;
278 static int32 last_run_end;
280 /* Deflation state */
281 static z_stream tx_strm;
286 /* We want obuf to be able to hold both MAX_DATA_COUNT+2 bytes as well as
287 * AVAIL_OUT_SIZE(CHUNK_SIZE) bytes, so make sure that it's large enough. */
288 #if MAX_DATA_COUNT+2 > AVAIL_OUT_SIZE(CHUNK_SIZE)
289 #define OBUF_SIZE (MAX_DATA_COUNT+2)
291 #define OBUF_SIZE AVAIL_OUT_SIZE(CHUNK_SIZE)
294 /* Send a deflated token */
296 send_deflated_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
297 int32 nb, int32 toklen)
300 static int init_done, flush_pending;
302 if (last_token == -1) {
305 tx_strm.next_in = NULL;
306 tx_strm.zalloc = NULL;
307 tx_strm.zfree = NULL;
308 if (deflateInit2(&tx_strm, compression_level,
310 Z_DEFAULT_STRATEGY) != Z_OK) {
311 rprintf(FERROR, "compression init failed\n");
312 exit_cleanup(RERR_PROTOCOL);
314 if ((obuf = new_array(char, OBUF_SIZE)) == NULL)
315 out_of_memory("send_deflated_token");
318 deflateReset(&tx_strm);
322 } else if (last_token == -2) {
324 } else if (nb != 0 || token != last_token + 1
325 || token >= run_start + 65536) {
326 /* output previous run */
327 r = run_start - last_run_end;
328 n = last_token - run_start;
329 if (r >= 0 && r <= 63) {
330 write_byte(f, (n==0? TOKEN_REL: TOKENRUN_REL) + r);
332 write_byte(f, (n==0? TOKEN_LONG: TOKENRUN_LONG));
333 write_int(f, run_start);
337 write_byte(f, n >> 8);
339 last_run_end = last_token;
345 if (nb != 0 || flush_pending) {
346 /* deflate the data starting at offset */
347 int flush = Z_NO_FLUSH;
348 tx_strm.avail_in = 0;
349 tx_strm.avail_out = 0;
351 if (tx_strm.avail_in == 0 && nb != 0) {
352 /* give it some more input */
353 n = MIN(nb, CHUNK_SIZE);
354 tx_strm.next_in = (Bytef *)
355 map_ptr(buf, offset, n);
356 tx_strm.avail_in = n;
360 if (tx_strm.avail_out == 0) {
361 tx_strm.next_out = (Bytef *)(obuf + 2);
362 tx_strm.avail_out = MAX_DATA_COUNT;
363 if (flush != Z_NO_FLUSH) {
365 * We left the last 4 bytes in the
366 * buffer, in case they are the
367 * last 4. Move them to the front.
369 memcpy(tx_strm.next_out,
370 obuf+MAX_DATA_COUNT-2, 4);
371 tx_strm.next_out += 4;
372 tx_strm.avail_out -= 4;
375 if (nb == 0 && token != -2)
376 flush = Z_SYNC_FLUSH;
377 r = deflate(&tx_strm, flush);
379 rprintf(FERROR, "deflate returned %d\n", r);
380 exit_cleanup(RERR_STREAMIO);
382 if (nb == 0 || tx_strm.avail_out == 0) {
383 n = MAX_DATA_COUNT - tx_strm.avail_out;
384 if (flush != Z_NO_FLUSH) {
386 * We have to trim off the last 4
387 * bytes of output when flushing
388 * (they are just 0, 0, ff, ff).
393 obuf[0] = DEFLATED_DATA + (n >> 8);
395 write_buf(f, obuf, n+2);
398 } while (nb != 0 || tx_strm.avail_out == 0);
399 flush_pending = token == -2;
403 /* end of file - clean up */
404 write_byte(f, END_FLAG);
405 } else if (token != -2 && do_compression == 1) {
406 /* Add the data in the current block to the compressor's
407 * history and hash table. */
408 #ifndef EXTERNAL_ZLIB
410 /* Break up long sections in the same way that
411 * see_deflate_token() does. */
412 int32 n1 = toklen > 0xffff ? 0xffff : toklen;
414 tx_strm.next_in = (Bytef *)map_ptr(buf, offset, n1);
415 tx_strm.avail_in = n1;
416 if (protocol_version >= 31) /* Newer protocols avoid a data-duplicating bug */
418 tx_strm.next_out = (Bytef *) obuf;
419 tx_strm.avail_out = AVAIL_OUT_SIZE(CHUNK_SIZE);
420 r = deflate(&tx_strm, Z_INSERT_ONLY);
421 if (r != Z_OK || tx_strm.avail_in != 0) {
422 rprintf(FERROR, "deflate on token returned %d (%d bytes left)\n",
423 r, tx_strm.avail_in);
424 exit_cleanup(RERR_STREAMIO);
426 } while (toklen > 0);
429 rprintf(FERROR, "Impossible error in external-zlib code (1).\n");
430 exit_cleanup(RERR_STREAMIO);
435 /* tells us what the receiver is in the middle of doing */
436 static enum { r_init, r_idle, r_running, r_inflating, r_inflated } recv_state;
438 /* for inflating stuff */
439 static z_stream rx_strm;
443 /* for decoding runs of tokens */
444 static int32 rx_token;
447 /* Receive a deflated token and inflate it */
448 static int32 recv_deflated_token(int f, char **data)
450 static int init_done;
451 static int32 saved_flag;
456 switch (recv_state) {
459 rx_strm.next_out = NULL;
460 rx_strm.zalloc = NULL;
461 rx_strm.zfree = NULL;
462 if (inflateInit2(&rx_strm, -15) != Z_OK) {
463 rprintf(FERROR, "inflate init failed\n");
464 exit_cleanup(RERR_PROTOCOL);
466 if (!(cbuf = new_array(char, MAX_DATA_COUNT))
467 || !(dbuf = new_array(char, AVAIL_OUT_SIZE(CHUNK_SIZE))))
468 out_of_memory("recv_deflated_token");
471 inflateReset(&rx_strm);
480 flag = saved_flag & 0xff;
484 if ((flag & 0xC0) == DEFLATED_DATA) {
485 n = ((flag & 0x3f) << 8) + read_byte(f);
486 read_buf(f, cbuf, n);
487 rx_strm.next_in = (Bytef *)cbuf;
488 rx_strm.avail_in = n;
489 recv_state = r_inflating;
492 if (recv_state == r_inflated) {
493 /* check previous inflated stuff ended correctly */
494 rx_strm.avail_in = 0;
495 rx_strm.next_out = (Bytef *)dbuf;
496 rx_strm.avail_out = AVAIL_OUT_SIZE(CHUNK_SIZE);
497 r = inflate(&rx_strm, Z_SYNC_FLUSH);
498 n = AVAIL_OUT_SIZE(CHUNK_SIZE) - rx_strm.avail_out;
500 * Z_BUF_ERROR just means no progress was
501 * made, i.e. the decompressor didn't have
502 * any pending output for us.
504 if (r != Z_OK && r != Z_BUF_ERROR) {
505 rprintf(FERROR, "inflate flush returned %d (%d bytes)\n",
507 exit_cleanup(RERR_STREAMIO);
509 if (n != 0 && r != Z_BUF_ERROR) {
510 /* have to return some more data and
511 save the flag for later. */
512 saved_flag = flag + 0x10000;
517 * At this point the decompressor should
518 * be expecting to see the 0, 0, ff, ff bytes.
520 if (!inflateSyncPoint(&rx_strm)) {
521 rprintf(FERROR, "decompressor lost sync!\n");
522 exit_cleanup(RERR_STREAMIO);
524 rx_strm.avail_in = 4;
525 rx_strm.next_in = (Bytef *)cbuf;
526 cbuf[0] = cbuf[1] = 0;
527 cbuf[2] = cbuf[3] = 0xff;
528 inflate(&rx_strm, Z_SYNC_FLUSH);
531 if (flag == END_FLAG) {
532 /* that's all folks */
537 /* here we have a token of some kind */
538 if (flag & TOKEN_REL) {
539 rx_token += flag & 0x3f;
542 rx_token = read_int(f);
544 rx_run = read_byte(f);
545 rx_run += read_byte(f) << 8;
546 recv_state = r_running;
548 return -1 - rx_token;
551 rx_strm.next_out = (Bytef *)dbuf;
552 rx_strm.avail_out = AVAIL_OUT_SIZE(CHUNK_SIZE);
553 r = inflate(&rx_strm, Z_NO_FLUSH);
554 n = AVAIL_OUT_SIZE(CHUNK_SIZE) - rx_strm.avail_out;
556 rprintf(FERROR, "inflate returned %d (%d bytes)\n", r, n);
557 exit_cleanup(RERR_STREAMIO);
559 if (rx_strm.avail_in == 0)
560 recv_state = r_inflated;
571 return -1 - rx_token;
577 * put the data corresponding to a token that we've just returned
578 * from recv_deflated_token into the decompressor's history buffer.
580 static void see_deflate_token(char *buf, int32 len)
582 #ifndef EXTERNAL_ZLIB
585 unsigned char hdr[5];
587 rx_strm.avail_in = 0;
591 if (rx_strm.avail_in == 0 && len != 0) {
593 /* Give it a fake stored-block header. */
594 rx_strm.next_in = (Bytef *)hdr;
595 rx_strm.avail_in = 5;
600 hdr[2] = blklen >> 8;
604 rx_strm.next_in = (Bytef *)buf;
605 rx_strm.avail_in = blklen;
606 if (protocol_version >= 31) /* Newer protocols avoid a data-duplicating bug */
612 rx_strm.next_out = (Bytef *)dbuf;
613 rx_strm.avail_out = AVAIL_OUT_SIZE(CHUNK_SIZE);
614 r = inflate(&rx_strm, Z_SYNC_FLUSH);
615 if (r != Z_OK && r != Z_BUF_ERROR) {
616 rprintf(FERROR, "inflate (token) returned %d\n", r);
617 exit_cleanup(RERR_STREAMIO);
619 } while (len || rx_strm.avail_out == 0);
622 rprintf(FERROR, "Impossible error in external-zlib code (2).\n");
623 exit_cleanup(RERR_STREAMIO);
628 * Transmit a verbatim buffer of length @p n followed by a token.
629 * If token == -1 then we have reached EOF
630 * If n == 0 then don't send a buffer
632 void send_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
633 int32 n, int32 toklen)
636 simple_send_token(f, token, buf, offset, n);
638 send_deflated_token(f, token, buf, offset, n, toklen);
642 * receive a token or buffer from the other end. If the reurn value is >0 then
643 * it is a data buffer of that length, and *data will point at the data.
644 * if the return value is -i then it represents token i-1
645 * if the return value is 0 then the end has been reached
647 int32 recv_token(int f, char **data)
651 if (!do_compression) {
652 tok = simple_recv_token(f,data);
654 tok = recv_deflated_token(f, data);
660 * look at the data corresponding to a token, if necessary
662 void see_token(char *data, int32 toklen)
664 if (do_compression == 1)
665 see_deflate_token(data, toklen);