Mention updated config files.
[rsync.git] / token.c
diff --git a/token.c b/token.c
index f169b756965af7077c3774c86b917968ba92c9bb..c108b3af576e1a8c343b062e3552627ea7aa0373 100644 (file)
--- a/token.c
+++ b/token.c
@@ -3,7 +3,7 @@
  *
  * Copyright (C) 1996 Andrew Tridgell
  * Copyright (C) 1996 Paul Mackerras
- * Copyright (C) 2003-2020 Wayne Davison
+ * Copyright (C) 2003-2022 Wayne Davison
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -39,7 +39,6 @@ extern char *skip_compress;
 #define Z_INSERT_ONLY Z_SYNC_FLUSH
 #endif
 
-static int compression_level; /* The compression level for the current file. */
 static int skip_compression_level; /* The least possible compressing for handling skip-compress files. */
 static int per_file_default_level; /* The default level that each new file gets prior to checking its suffix. */
 
@@ -57,6 +56,8 @@ void init_compression_level(void)
        int min_level, max_level, def_level, off_level;
 
        switch (do_compression) {
+       case CPRES_NONE:
+               return;
        case CPRES_ZLIB:
        case CPRES_ZLIBX:
                min_level = 1;
@@ -70,8 +71,10 @@ void init_compression_level(void)
        case CPRES_ZSTD:
                min_level = skip_compression_level = ZSTD_minCLevel();
                max_level = ZSTD_maxCLevel();
-               def_level = 3;
+               def_level = ZSTD_CLEVEL_DEFAULT;
                off_level = CLVL_NOT_SPECIFIED;
+               if (do_compression_level == 0)
+                       do_compression_level = def_level;
                break;
 #endif
 #ifdef SUPPORT_LZ4
@@ -83,7 +86,7 @@ void init_compression_level(void)
                break;
 #endif
        default: /* paranoia to prevent missing case values */
-               exit_cleanup(RERR_UNSUPPORTED);
+               NOISY_DEATH("Unknown do_compression value");
        }
 
        if (do_compression_level == CLVL_NOT_SPECIFIED)
@@ -125,8 +128,7 @@ static void add_suffix(struct suffix_tree **prior, char ltr, const char *str)
                if (node->letter > ltr)
                        break;
        }
-       if (!(newnode = new(struct suffix_tree)))
-               out_of_memory("add_suffix");
+       newnode = new(struct suffix_tree);
        newnode->sibling = node;
        newnode->child = NULL;
        newnode->letter = ltr;
@@ -143,8 +145,7 @@ static void add_nocompress_suffixes(const char *str)
        char *buf, *t;
        const char *f = str;
 
-       if (!(buf = new_array(char, strlen(f) + 1)))
-               out_of_memory("add_nocompress_suffixes");
+       buf = new_array(char, strlen(f) + 1);
 
        while (*f) {
                if (*f == '/') {
@@ -182,8 +183,7 @@ static void init_set_compression(void)
        else
                f = lp_dont_compress(module_id);
 
-       if (!(match_list = t = new_array(char, strlen(f) + 2)))
-               out_of_memory("set_compression");
+       match_list = t = new_array(char, strlen(f) + 2);
 
        per_file_default_level = do_compression_level;
 
@@ -223,9 +223,11 @@ static void init_set_compression(void)
 /* determine the compression level based on a wildcard filename list */
 void set_compression(const char *fname)
 {
+#if 0 /* No compression algorithms currently allow mid-stream changing of the level. */
        const struct suffix_tree *node;
        const char *s;
        char ltr;
+#endif
 
        if (!do_compression)
                return;
@@ -233,6 +235,7 @@ void set_compression(const char *fname)
        if (!match_list)
                init_set_compression();
 
+#if 0
        compression_level = per_file_default_level;
 
        if (!*match_list && !suftree)
@@ -269,6 +272,9 @@ void set_compression(const char *fname)
                if (!(node = node->child))
                        return;
        }
+#else
+       (void)fname;
+#endif
 }
 
 /* non-compressing recv token */
@@ -278,11 +284,8 @@ static int32 simple_recv_token(int f, char **data)
        static char *buf;
        int32 n;
 
-       if (!buf) {
+       if (!buf)
                buf = new_array(char, CHUNK_SIZE);
-               if (!buf)
-                       out_of_memory("simple_recv_token");
-       }
 
        if (residue == 0) {
                int32 i = read_int(f);
@@ -299,8 +302,7 @@ static int32 simple_recv_token(int f, char **data)
 }
 
 /* non-compressing send token */
-static void simple_send_token(int f, int32 token, struct map_struct *buf,
-                             OFF_T offset, int32 n)
+static void simple_send_token(int f, int32 token, struct map_struct *buf, OFF_T offset, int32 n)
 {
        if (n > 0) {
                int32 len = 0;
@@ -353,8 +355,7 @@ static char *obuf;
 
 /* Send a deflated token */
 static void
-send_deflated_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
-                   int32 nb, int32 toklen)
+send_deflated_token(int f, int32 token, struct map_struct *buf, OFF_T offset, int32 nb, int32 toklen)
 {
        static int init_done, flush_pending;
        int32 n, r;
@@ -365,14 +366,13 @@ send_deflated_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
                        tx_strm.next_in = NULL;
                        tx_strm.zalloc = NULL;
                        tx_strm.zfree = NULL;
-                       if (deflateInit2(&tx_strm, compression_level,
+                       if (deflateInit2(&tx_strm, per_file_default_level,
                                         Z_DEFLATED, -15, 8,
                                         Z_DEFAULT_STRATEGY) != Z_OK) {
                                rprintf(FERROR, "compression init failed\n");
                                exit_cleanup(RERR_PROTOCOL);
                        }
-                       if ((obuf = new_array(char, OBUF_SIZE)) == NULL)
-                               out_of_memory("send_deflated_token");
+                       obuf = new_array(char, OBUF_SIZE);
                        init_done = 1;
                } else
                        deflateReset(&tx_strm);
@@ -381,8 +381,7 @@ send_deflated_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
                flush_pending = 0;
        } else if (last_token == -2) {
                run_start = token;
-       } else if (nb != 0 || token != last_token + 1
-                  || token >= run_start + 65536) {
+       } else if (nb != 0 || token != last_token + 1 || token >= run_start + 65536) {
                /* output previous run */
                r = run_start - last_run_end;
                n = last_token - run_start;
@@ -426,8 +425,7 @@ send_deflated_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
                                         * buffer, in case they are the
                                         * last 4.  Move them to the front.
                                         */
-                                       memcpy(tx_strm.next_out,
-                                              obuf+MAX_DATA_COUNT-2, 4);
+                                       memcpy(tx_strm.next_out, obuf+MAX_DATA_COUNT-2, 4);
                                        tx_strm.next_out += 4;
                                        tx_strm.avail_out -= 4;
                                }
@@ -517,9 +515,8 @@ static int32 recv_deflated_token(int f, char **data)
                                        rprintf(FERROR, "inflate init failed\n");
                                        exit_cleanup(RERR_PROTOCOL);
                                }
-                               if (!(cbuf = new_array(char, MAX_DATA_COUNT))
-                                   || !(dbuf = new_array(char, AVAIL_OUT_SIZE(CHUNK_SIZE))))
-                                       out_of_memory("recv_deflated_token");
+                               cbuf = new_array(char, MAX_DATA_COUNT);
+                               dbuf = new_array(char, AVAIL_OUT_SIZE(CHUNK_SIZE));
                                init_done = 1;
                        } else {
                                inflateReset(&rx_strm);
@@ -578,7 +575,7 @@ static int32 recv_deflated_token(int f, char **data)
                                rx_strm.avail_in = 4;
                                rx_strm.next_in = (Bytef *)cbuf;
                                cbuf[0] = cbuf[1] = 0;
-                               cbuf[2] = cbuf[3] = 0xff;
+                               cbuf[2] = cbuf[3] = (char)0xff;
                                inflate(&rx_strm, Z_SYNC_FLUSH);
                                recv_state = r_idle;
                        }
@@ -678,8 +675,7 @@ static ZSTD_inBuffer zstd_in_buff;
 static ZSTD_outBuffer zstd_out_buff;
 static ZSTD_CCtx *zstd_cctx;
 
-static void send_zstd_token(int f, int32 token, struct map_struct *buf,
-                           OFF_T offset, int32 nb)
+static void send_zstd_token(int f, int32 token, struct map_struct *buf, OFF_T offset, int32 nb)
 {
        static int comp_init_done, flush_pending;
        ZSTD_EndDirective flush = ZSTD_e_continue;
@@ -687,7 +683,6 @@ static void send_zstd_token(int f, int32 token, struct map_struct *buf,
 
        /* initialization */
        if (!comp_init_done) {
-
                zstd_cctx = ZSTD_createCCtx();
                if (!zstd_cctx) {
                        rprintf(FERROR, "compression init failed\n");
@@ -695,11 +690,8 @@ static void send_zstd_token(int f, int32 token, struct map_struct *buf,
                }
 
                obuf = new_array(char, OBUF_SIZE);
-               if (!obuf)
-                       out_of_memory("send_deflated_token");
 
-               ZSTD_CCtx_setParameter(zstd_cctx, ZSTD_c_compressionLevel,
-                                      do_compression_level);
+               ZSTD_CCtx_setParameter(zstd_cctx, ZSTD_c_compressionLevel, do_compression_level);
                zstd_out_buff.dst = obuf + 2;
 
                comp_init_done = 1;
@@ -711,10 +703,7 @@ static void send_zstd_token(int f, int32 token, struct map_struct *buf,
                flush_pending = 0;
        } else if (last_token == -2) {
                run_start = token;
-
-       } else if (nb != 0 || token != last_token + 1
-                  || token >= run_start + 65536) {
-
+       } else if (nb != 0 || token != last_token + 1 || token >= run_start + 65536) {
                /* output previous run */
                r = run_start - last_run_end;
                n = last_token - run_start;
@@ -796,7 +785,6 @@ static int32 recv_zstd_token(int f, char **data)
        int r;
 
        if (!decomp_init_done) {
-
                zstd_dctx = ZSTD_createDCtx();
                if (!zstd_dctx) {
                        rprintf(FERROR, "ZSTD_createDStream failed\n");
@@ -807,8 +795,6 @@ static int32 recv_zstd_token(int f, char **data)
                out_buffer_size = ZSTD_DStreamOutSize() * 2;
                cbuf = new_array(char, MAX_DATA_COUNT);
                dbuf = new_array(char, out_buffer_size);
-               if (!cbuf || !dbuf)
-                       out_of_memory("recv_zstd_token");
 
                zstd_in_buff.src = cbuf;
                zstd_out_buff.dst = dbuf;
@@ -816,30 +802,31 @@ static int32 recv_zstd_token(int f, char **data)
                decomp_init_done = 1;
        }
 
-       do {
-       switch (recv_state) {
-       case r_init:
-               recv_state = r_idle;
-               rx_token = 0;
-               break;
-
-       case r_idle:
-               flag = read_byte(f);
-               if ((flag & 0xC0) == DEFLATED_DATA) {
-                       n = ((flag & 0x3f) << 8) + read_byte(f);
-                       read_buf(f, cbuf, n);
+       for (;;) {
+               switch (recv_state) {
+               case r_init:
+                       recv_state = r_idle;
+                       rx_token = 0;
+                       break;
 
-                       zstd_in_buff.size = n;
-                       zstd_in_buff.pos = 0;
+               case r_idle:
+                       flag = read_byte(f);
+                       if ((flag & 0xC0) == DEFLATED_DATA) {
+                               n = ((flag & 0x3f) << 8) + read_byte(f);
+                               read_buf(f, cbuf, n);
 
-                       recv_state = r_inflating;
+                               zstd_in_buff.size = n;
+                               zstd_in_buff.pos = 0;
 
-               } else if (flag == END_FLAG) {
-                       /* that's all folks */
-                       recv_state = r_init;
-                       return 0;
+                               recv_state = r_inflating;
+                               break;
+                       }
 
-               } else {
+                       if (flag == END_FLAG) {
+                               /* that's all folks */
+                               recv_state = r_init;
+                               return 0;
+                       }
                        /* here we have a token of some kind */
                        if (flag & TOKEN_REL) {
                                rx_token += flag & 0x3f;
@@ -852,45 +839,42 @@ static int32 recv_zstd_token(int f, char **data)
                                recv_state = r_running;
                        }
                        return -1 - rx_token;
-               }
-               break;
 
-       case r_inflating:
-               zstd_out_buff.size = out_buffer_size;
-               zstd_out_buff.pos = 0;
+               case r_inflated: /* zstd doesn't get into this state */
+                       break;
 
-               r = ZSTD_decompressStream(zstd_dctx, &zstd_out_buff, &zstd_in_buff);
-               n = zstd_out_buff.pos;
-               if (ZSTD_isError(r)) {
-                       rprintf(FERROR, "ZSTD decomp returned %d (%d bytes)\n", r, n);
-                       exit_cleanup(RERR_STREAMIO);
-               }
+               case r_inflating:
+                       zstd_out_buff.size = out_buffer_size;
+                       zstd_out_buff.pos = 0;
 
-               /*
-                * If the input buffer is fully consumed and the output
-                * buffer is not full then next step is to read more
-                * data.
-                */
-               if (zstd_in_buff.size == zstd_in_buff.pos && n < out_buffer_size)
-                       recv_state = r_idle;
+                       r = ZSTD_decompressStream(zstd_dctx, &zstd_out_buff, &zstd_in_buff);
+                       n = zstd_out_buff.pos;
+                       if (ZSTD_isError(r)) {
+                               rprintf(FERROR, "ZSTD decomp returned %d (%d bytes)\n", r, n);
+                               exit_cleanup(RERR_STREAMIO);
+                       }
 
-               if (n != 0) {
-                       *data = dbuf;
-                       return n;
-               }
-               break;
+                       /*
+                        * If the input buffer is fully consumed and the output
+                        * buffer is not full then next step is to read more
+                        * data.
+                        */
+                       if (zstd_in_buff.size == zstd_in_buff.pos && n < out_buffer_size)
+                               recv_state = r_idle;
 
-       case r_running:
-               ++rx_token;
-               if (--rx_run == 0)
-                       recv_state = r_idle;
-               return -1 - rx_token;
-               break;
+                       if (n != 0) {
+                               *data = dbuf;
+                               return n;
+                       }
+                       break;
 
-       case r_inflated:
-               break;
+               case r_running:
+                       ++rx_token;
+                       if (--rx_run == 0)
+                               recv_state = r_idle;
+                       return -1 - rx_token;
+               }
        }
-       } while (1);
 }
 #endif /* SUPPORT_ZSTD */
 
@@ -904,8 +888,7 @@ send_compressed_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
 
        if (last_token == -1) {
                if (!init_done) {
-                       if ((obuf = new_array(char, size)) == NULL)
-                               out_of_memory("send_compressed_token");
+                       obuf = new_array(char, size);
                        init_done = 1;
                }
                last_run_end = 0;
@@ -913,8 +896,7 @@ send_compressed_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
                flush_pending = 0;
        } else if (last_token == -2) {
                run_start = token;
-       } else if (nb != 0 || token != last_token + 1
-                  || token >= run_start + 65536) {
+       } else if (nb != 0 || token != last_token + 1 || token >= run_start + 65536) {
                /* output previous run */
                r = run_start - last_run_end;
                n = last_token - run_start;
@@ -939,7 +921,6 @@ send_compressed_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
                const char *next_in;
 
                do {
-                       char *ptr = obuf;
                        char *next_out = obuf + 2;
 
                        if (available_out == 0) {
@@ -954,10 +935,10 @@ send_compressed_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
                                exit_cleanup(RERR_STREAMIO);
                        }
                        if (available_out <= MAX_DATA_COUNT) {
-                               ptr[0] = DEFLATED_DATA + (available_out >> 8);
-                               ptr[1] = available_out;
+                               obuf[0] = DEFLATED_DATA + (available_out >> 8);
+                               obuf[1] = available_out;
 
-                               write_buf(f, ptr, available_out + 2);
+                               write_buf(f, obuf, available_out + 2);
 
                                available_out = 0;
                                nb -= available_in;
@@ -966,14 +947,14 @@ send_compressed_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
                } while (nb != 0);
                flush_pending = token == -2;
        }
-       if (token == -1)
+       if (token == -1) {
                /* end of file - clean up */
                write_byte(f, END_FLAG);
+       }
 }
 
 static int32 recv_compressed_token(int f, char **data)
 {
-       static int32 saved_flag;
        static int init_done;
        int32 n, flag;
        int size = MAX(LZ4_compressBound(CHUNK_SIZE), MAX_DATA_COUNT+2);
@@ -985,21 +966,16 @@ static int32 recv_compressed_token(int f, char **data)
                switch (recv_state) {
                case r_init:
                        if (!init_done) {
-                               if (!(cbuf = new_array(char, MAX_DATA_COUNT))
-                                   || !(dbuf = new_array(char, size)))
-                                       out_of_memory("recv_compressed_token");
+                               cbuf = new_array(char, MAX_DATA_COUNT);
+                               dbuf = new_array(char, size);
                                init_done = 1;
                        }
                        recv_state = r_idle;
                        rx_token = 0;
                        break;
+
                case r_idle:
-               case r_inflated:
-                       if (saved_flag) {
-                               flag = saved_flag & 0xff;
-                               saved_flag = 0;
-                       } else
-                               flag = read_byte(f);
+                       flag = read_byte(f);
                        if ((flag & 0xC0) == DEFLATED_DATA) {
                                n = ((flag & 0x3f) << 8) + read_byte(f);
                                read_buf(f, cbuf, n);
@@ -1009,9 +985,6 @@ static int32 recv_compressed_token(int f, char **data)
                                break;
                        }
 
-                       if (recv_state == r_inflated)
-                               recv_state = r_idle;
-
                        if (flag == END_FLAG) {
                                /* that's all folks */
                                recv_state = r_init;
@@ -1037,10 +1010,13 @@ static int32 recv_compressed_token(int f, char **data)
                                rprintf(FERROR, "uncompress failed: %d\n", avail_out);
                                exit_cleanup(RERR_STREAMIO);
                        }
-                       recv_state = r_inflated;
+                       recv_state = r_idle;
                        *data = dbuf;
                        return avail_out;
 
+               case r_inflated: /* lz4 doesn't get into this state */
+                       break;
+
                case r_running:
                        ++rx_token;
                        if (--rx_run == 0)
@@ -1048,53 +1024,7 @@ static int32 recv_compressed_token(int f, char **data)
                        return -1 - rx_token;
                }
        }
-
-}
-
-# if 0
-static void see_uncompressed_token(char *buf, int32 len)
-{
-       static const char *next_in;
-       static int avail_in;
-       int avail_out;
-
-       int32 blklen;
-       char hdr[5];
-
-       avail_in = 0;
-       blklen = 0;
-       hdr[0] = 0;
-       do {
-               if (avail_in == 0 && len != 0) {
-                       if (blklen == 0) {
-                               /* Give it a fake stored-block header. */
-                               next_in = hdr;
-                               avail_in = 5;
-                               blklen = len;
-                               if (blklen > 0xffff)
-                                       blklen = 0xffff;
-                               hdr[1] = blklen;
-                               hdr[2] = blklen >> 8;
-                               hdr[3] = ~hdr[1];
-                               hdr[4] = ~hdr[2];
-                       } else {
-                               next_in = (char *)buf;
-                               avail_in = blklen;
-                               if (protocol_version >= 31) /* Newer protocols avoid a data-duplicating bug */
-                                       buf += blklen;
-                               len -= blklen;
-                               blklen = 0;
-                       }
-               }
-               avail_out = LZ4_decompress_safe(next_in, dbuf, avail_in, LZ4_compressBound(CHUNK_SIZE));
-               if (avail_out < 0) {
-                       rprintf(FERROR, "uncompress failed: %d\n", avail_out);
-                       exit_cleanup(RERR_STREAMIO);
-               }
-
-       } while (len);
 }
-# endif /* 0 */
 #endif /* SUPPORT_LZ4 */
 
 /**
@@ -1105,18 +1035,27 @@ static void see_uncompressed_token(char *buf, int32 len)
 void send_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
                int32 n, int32 toklen)
 {
-       if (!do_compression)
+       switch (do_compression) {
+       case CPRES_NONE:
                simple_send_token(f, token, buf, offset, n);
+               break;
+       case CPRES_ZLIB:
+       case CPRES_ZLIBX:
+               send_deflated_token(f, token, buf, offset, n, toklen);
+               break;
 #ifdef SUPPORT_ZSTD
-       else if (do_compression == CPRES_ZSTD)
+       case CPRES_ZSTD:
                send_zstd_token(f, token, buf, offset, n);
+               break;
 #endif
 #ifdef SUPPORT_LZ4
-       else if (do_compression == CPRES_LZ4)
+       case CPRES_LZ4:
                send_compressed_token(f, token, buf, offset, n);
+               break;
 #endif
-       else
-               send_deflated_token(f, token, buf, offset, n, toklen);
+       default:
+               NOISY_DEATH("Unknown do_compression value");
+       }
 }
 
 /*
@@ -1127,21 +1066,23 @@ void send_token(int f, int32 token, struct map_struct *buf, OFF_T offset,
  */
 int32 recv_token(int f, char **data)
 {
-       int tok;
-
-       if (!do_compression)
-               tok = simple_recv_token(f,data);
+       switch (do_compression) {
+       case CPRES_NONE:
+               return simple_recv_token(f,data);
+       case CPRES_ZLIB:
+       case CPRES_ZLIBX:
+               return recv_deflated_token(f, data);
 #ifdef SUPPORT_ZSTD
-       else if (do_compression == CPRES_ZSTD)
-               tok = recv_zstd_token(f, data);
+       case CPRES_ZSTD:
+               return recv_zstd_token(f, data);
 #endif
 #ifdef SUPPORT_LZ4
-       else if (do_compression == CPRES_LZ4)
-               tok = recv_compressed_token(f, data);
+       case CPRES_LZ4:
+               return recv_compressed_token(f, data);
 #endif
-       else /* CPRES_ZLIB & CPRES_ZLIBX */
-               tok = recv_deflated_token(f, data);
-       return tok;
+       default:
+               NOISY_DEATH("Unknown do_compression value");
+       }
 }
 
 /*
@@ -1149,12 +1090,24 @@ int32 recv_token(int f, char **data)
  */
 void see_token(char *data, int32 toklen)
 {
-       if (do_compression == CPRES_ZLIB)
+       switch (do_compression) {
+       case CPRES_NONE:
+               break;
+       case CPRES_ZLIB:
                see_deflate_token(data, toklen);
+               break;
+       case CPRES_ZLIBX:
+               break;
+#ifdef SUPPORT_ZSTD
+       case CPRES_ZSTD:
+               break;
+#endif
 #ifdef SUPPORT_LZ4
-# if 0
-       else if (do_compression == CPRES_LZ4)
-               see_uncompressed_token(data, toklen);
-# endif
+       case CPRES_LZ4:
+               /*see_uncompressed_token(data, toklen);*/
+               break;
 #endif
+       default:
+               NOISY_DEATH("Unknown do_compression value");
+       }
 }