lib/got_lib_inflate.h

   1 /*
   2  * Copyright (c) 2018 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_inflate_checksum {
  18         /* If not NULL, mix input bytes into this CRC checksum. */
  19         uint32_t *input_crc;
  20
  21         /* if not NULL, mix input bytes into this hash context. */
  22         struct got_hash *input_ctx;
  23
  24         /* If not NULL, mix output bytes into this CRC checksum. */
  25         uint32_t *output_crc;
  26
  27         /* If not NULL, mix output bytes into this hash context. */
  28         struct got_hash *output_ctx;
  29 };
  30
  31 struct got_inflate_buf {
  32         z_stream z;
  33         uint8_t *inbuf;
  34         size_t inlen;
  35         uint8_t *outbuf;
  36         size_t outlen;
  37         int flags;
  38 #define GOT_INFLATE_F_HAVE_MORE         0x01
  39 #define GOT_INFLATE_F_OWN_OUTBUF        0x02
  40         struct got_inflate_checksum *csum;
  41 };
  42
  43 #define GOT_INFLATE_BUFSIZE             32768
  44
  45 const struct got_error *got_inflate_init(struct got_inflate_buf *, uint8_t *,
  46     size_t, struct got_inflate_checksum *);
  47 const struct got_error *got_inflate_read(struct got_inflate_buf *, FILE *,
  48     size_t *, size_t *);
  49 const struct got_error *got_inflate_read_fd(struct got_inflate_buf *, int,
  50     size_t *, size_t *);
  51 const struct got_error *got_inflate_read_mmap(struct got_inflate_buf *,
  52     uint8_t *, size_t, size_t, size_t *, size_t *);
  53 void got_inflate_end(struct got_inflate_buf *);
  54 const struct got_error *got_inflate_to_mem(uint8_t **, size_t *, size_t *,
  55     struct got_inflate_checksum *, FILE *);
  56 const struct got_error *got_inflate_to_mem_fd(uint8_t **, size_t *, size_t *,
  57     struct got_inflate_checksum *, size_t, int);
  58 const struct got_error *got_inflate_to_mem_mmap(uint8_t **, size_t *, size_t *,
  59     struct got_inflate_checksum *, uint8_t *, size_t, size_t);
  60 const struct got_error *got_inflate_to_file(size_t *, FILE *,
  61     struct got_inflate_checksum *, FILE *);
  62 const struct got_error *got_inflate_to_file_fd(size_t *, size_t *,
  63     struct got_inflate_checksum *, int, FILE *);
  64 const struct got_error *got_inflate_to_fd(size_t *, FILE *,
  65     struct got_inflate_checksum *, int);
  66 const struct got_error *got_inflate_to_file_mmap(size_t *, size_t *,
  67     struct got_inflate_checksum *, uint8_t *, size_t, size_t, FILE *);