lib/got_lib_deflate.h

   1 /*
   2  * Copyright (c) 2019 Stefan Sperling <stsp@openbsd.org>
   3  *
   4  * Permission to use, copy, modify, and distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 struct got_deflate_checksum {
  18         /* If not NULL, mix output bytes into this CRC checksum. */
  19         uint32_t *output_crc;
  20
  21         /* If not NULL, mix output bytes into this hash context. */
  22         struct got_hash *output_ctx;
  23 };
  24
  25 struct got_deflate_buf {
  26         z_stream z;
  27         uint8_t *inbuf;
  28         size_t inlen;
  29         uint8_t *outbuf;
  30         size_t outlen;
  31         int flags;
  32 #define GOT_DEFLATE_F_HAVE_MORE         0x01
  33 #define GOT_DEFLATE_F_OWN_OUTBUF        0x02
  34 };
  35
  36 #define GOT_DEFLATE_BUFSIZE             8192
  37
  38 const struct got_error *got_deflate_init(struct got_deflate_buf *, uint8_t *,
  39     size_t);
  40 const struct got_error *got_deflate_read(struct got_deflate_buf *, FILE *,
  41     off_t, size_t *, off_t *);
  42 const struct got_error *got_deflate_read_mmap(struct got_deflate_buf *,
  43     uint8_t *, size_t, size_t, size_t *, size_t *);
  44 void got_deflate_end(struct got_deflate_buf *);
  45 const struct got_error *got_deflate_to_fd(off_t *, FILE *, off_t, int,
  46     struct got_deflate_checksum *);
  47 const struct got_error *got_deflate_to_fd_mmap(off_t *, uint8_t *,
  48     size_t, size_t, int, struct got_deflate_checksum *);
  49 const struct got_error *got_deflate_to_file(off_t *, FILE *, off_t, FILE *,
  50     struct got_deflate_checksum *);
  51 const struct got_error *got_deflate_to_file_mmap(off_t *, uint8_t *,
  52     size_t, size_t, FILE *, struct got_deflate_checksum *);
  53 const struct got_error *got_deflate_flush(struct got_deflate_buf *, FILE *,
  54     struct got_deflate_checksum *, off_t *);
  55 const struct got_error *got_deflate_append_to_file_mmap(
  56     struct got_deflate_buf *, off_t *, uint8_t *, size_t, size_t, FILE *,
  57     struct got_deflate_checksum *);
  58 const struct got_error *got_deflate_to_mem_mmap(uint8_t **, size_t *, size_t *,
  59     struct got_deflate_checksum *, uint8_t *, size_t, size_t);