Chris@4: /* zran.c -- example of zlib/gzip stream indexing and random access
Chris@4:  * Copyright (C) 2005 Mark Adler
Chris@4:  * For conditions of distribution and use, see copyright notice in zlib.h
Chris@4:    Version 1.0  29 May 2005  Mark Adler */
Chris@4: 
Chris@4: /* Illustrate the use of Z_BLOCK, inflatePrime(), and inflateSetDictionary()
Chris@4:    for random access of a compressed file.  A file containing a zlib or gzip
Chris@4:    stream is provided on the command line.  The compressed stream is decoded in
Chris@4:    its entirety, and an index built with access points about every SPAN bytes
Chris@4:    in the uncompressed output.  The compressed file is left open, and can then
Chris@4:    be read randomly, having to decompress on the average SPAN/2 uncompressed
Chris@4:    bytes before getting to the desired block of data.
Chris@4: 
Chris@4:    An access point can be created at the start of any deflate block, by saving
Chris@4:    the starting file offset and bit of that block, and the 32K bytes of
Chris@4:    uncompressed data that precede that block.  Also the uncompressed offset of
Chris@4:    that block is saved to provide a referece for locating a desired starting
Chris@4:    point in the uncompressed stream.  build_index() works by decompressing the
Chris@4:    input zlib or gzip stream a block at a time, and at the end of each block
Chris@4:    deciding if enough uncompressed data has gone by to justify the creation of
Chris@4:    a new access point.  If so, that point is saved in a data structure that
Chris@4:    grows as needed to accommodate the points.
Chris@4: 
Chris@4:    To use the index, an offset in the uncompressed data is provided, for which
Chris@4:    the latest accees point at or preceding that offset is located in the index.
Chris@4:    The input file is positioned to the specified location in the index, and if
Chris@4:    necessary the first few bits of the compressed data is read from the file.
Chris@4:    inflate is initialized with those bits and the 32K of uncompressed data, and
Chris@4:    the decompression then proceeds until the desired offset in the file is
Chris@4:    reached.  Then the decompression continues to read the desired uncompressed
Chris@4:    data from the file.
Chris@4: 
Chris@4:    Another approach would be to generate the index on demand.  In that case,
Chris@4:    requests for random access reads from the compressed data would try to use
Chris@4:    the index, but if a read far enough past the end of the index is required,
Chris@4:    then further index entries would be generated and added.
Chris@4: 
Chris@4:    There is some fair bit of overhead to starting inflation for the random
Chris@4:    access, mainly copying the 32K byte dictionary.  So if small pieces of the
Chris@4:    file are being accessed, it would make sense to implement a cache to hold
Chris@4:    some lookahead and avoid many calls to extract() for small lengths.
Chris@4: 
Chris@4:    Another way to build an index would be to use inflateCopy().  That would
Chris@4:    not be constrained to have access points at block boundaries, but requires
Chris@4:    more memory per access point, and also cannot be saved to file due to the
Chris@4:    use of pointers in the state.  The approach here allows for storage of the
Chris@4:    index in a file.
Chris@4:  */
Chris@4: 
Chris@4: #include <stdio.h>
Chris@4: #include <stdlib.h>
Chris@4: #include <string.h>
Chris@4: #include "zlib.h"
Chris@4: 
Chris@4: #define local static
Chris@4: 
Chris@4: #define SPAN 1048576L       /* desired distance between access points */
Chris@4: #define WINSIZE 32768U      /* sliding window size */
Chris@4: #define CHUNK 16384         /* file input buffer size */
Chris@4: 
Chris@4: /* access point entry */
Chris@4: struct point {
Chris@4:     off_t out;          /* corresponding offset in uncompressed data */
Chris@4:     off_t in;           /* offset in input file of first full byte */
Chris@4:     int bits;           /* number of bits (1-7) from byte at in - 1, or 0 */
Chris@4:     unsigned char window[WINSIZE];  /* preceding 32K of uncompressed data */
Chris@4: };
Chris@4: 
Chris@4: /* access point list */
Chris@4: struct access {
Chris@4:     int have;           /* number of list entries filled in */
Chris@4:     int size;           /* number of list entries allocated */
Chris@4:     struct point *list; /* allocated list */
Chris@4: };
Chris@4: 
Chris@4: /* Deallocate an index built by build_index() */
Chris@4: local void free_index(struct access *index)
Chris@4: {
Chris@4:     if (index != NULL) {
Chris@4:         free(index->list);
Chris@4:         free(index);
Chris@4:     }
Chris@4: }
Chris@4: 
Chris@4: /* Add an entry to the access point list.  If out of memory, deallocate the
Chris@4:    existing list and return NULL. */
Chris@4: local struct access *addpoint(struct access *index, int bits,
Chris@4:     off_t in, off_t out, unsigned left, unsigned char *window)
Chris@4: {
Chris@4:     struct point *next;
Chris@4: 
Chris@4:     /* if list is empty, create it (start with eight points) */
Chris@4:     if (index == NULL) {
Chris@4:         index = malloc(sizeof(struct access));
Chris@4:         if (index == NULL) return NULL;
Chris@4:         index->list = malloc(sizeof(struct point) << 3);
Chris@4:         if (index->list == NULL) {
Chris@4:             free(index);
Chris@4:             return NULL;
Chris@4:         }
Chris@4:         index->size = 8;
Chris@4:         index->have = 0;
Chris@4:     }
Chris@4: 
Chris@4:     /* if list is full, make it bigger */
Chris@4:     else if (index->have == index->size) {
Chris@4:         index->size <<= 1;
Chris@4:         next = realloc(index->list, sizeof(struct point) * index->size);
Chris@4:         if (next == NULL) {
Chris@4:             free_index(index);
Chris@4:             return NULL;
Chris@4:         }
Chris@4:         index->list = next;
Chris@4:     }
Chris@4: 
Chris@4:     /* fill in entry and increment how many we have */
Chris@4:     next = index->list + index->have;
Chris@4:     next->bits = bits;
Chris@4:     next->in = in;
Chris@4:     next->out = out;
Chris@4:     if (left)
Chris@4:         memcpy(next->window, window + WINSIZE - left, left);
Chris@4:     if (left < WINSIZE)
Chris@4:         memcpy(next->window + left, window, WINSIZE - left);
Chris@4:     index->have++;
Chris@4: 
Chris@4:     /* return list, possibly reallocated */
Chris@4:     return index;
Chris@4: }
Chris@4: 
Chris@4: /* Make one entire pass through the compressed stream and build an index, with
Chris@4:    access points about every span bytes of uncompressed output -- span is
Chris@4:    chosen to balance the speed of random access against the memory requirements
Chris@4:    of the list, about 32K bytes per access point.  Note that data after the end
Chris@4:    of the first zlib or gzip stream in the file is ignored.  build_index()
Chris@4:    returns the number of access points on success (>= 1), Z_MEM_ERROR for out
Chris@4:    of memory, Z_DATA_ERROR for an error in the input file, or Z_ERRNO for a
Chris@4:    file read error.  On success, *built points to the resulting index. */
Chris@4: local int build_index(FILE *in, off_t span, struct access **built)
Chris@4: {
Chris@4:     int ret;
Chris@4:     off_t totin, totout;        /* our own total counters to avoid 4GB limit */
Chris@4:     off_t last;                 /* totout value of last access point */
Chris@4:     struct access *index;       /* access points being generated */
Chris@4:     z_stream strm;
Chris@4:     unsigned char input[CHUNK];
Chris@4:     unsigned char window[WINSIZE];
Chris@4: 
Chris@4:     /* initialize inflate */
Chris@4:     strm.zalloc = Z_NULL;
Chris@4:     strm.zfree = Z_NULL;
Chris@4:     strm.opaque = Z_NULL;
Chris@4:     strm.avail_in = 0;
Chris@4:     strm.next_in = Z_NULL;
Chris@4:     ret = inflateInit2(&strm, 47);      /* automatic zlib or gzip decoding */
Chris@4:     if (ret != Z_OK)
Chris@4:         return ret;
Chris@4: 
Chris@4:     /* inflate the input, maintain a sliding window, and build an index -- this
Chris@4:        also validates the integrity of the compressed data using the check
Chris@4:        information at the end of the gzip or zlib stream */
Chris@4:     totin = totout = last = 0;
Chris@4:     index = NULL;               /* will be allocated by first addpoint() */
Chris@4:     strm.avail_out = 0;
Chris@4:     do {
Chris@4:         /* get some compressed data from input file */
Chris@4:         strm.avail_in = fread(input, 1, CHUNK, in);
Chris@4:         if (ferror(in)) {
Chris@4:             ret = Z_ERRNO;
Chris@4:             goto build_index_error;
Chris@4:         }
Chris@4:         if (strm.avail_in == 0) {
Chris@4:             ret = Z_DATA_ERROR;
Chris@4:             goto build_index_error;
Chris@4:         }
Chris@4:         strm.next_in = input;
Chris@4: 
Chris@4:         /* process all of that, or until end of stream */
Chris@4:         do {
Chris@4:             /* reset sliding window if necessary */
Chris@4:             if (strm.avail_out == 0) {
Chris@4:                 strm.avail_out = WINSIZE;
Chris@4:                 strm.next_out = window;
Chris@4:             }
Chris@4: 
Chris@4:             /* inflate until out of input, output, or at end of block --
Chris@4:                update the total input and output counters */
Chris@4:             totin += strm.avail_in;
Chris@4:             totout += strm.avail_out;
Chris@4:             ret = inflate(&strm, Z_BLOCK);      /* return at end of block */
Chris@4:             totin -= strm.avail_in;
Chris@4:             totout -= strm.avail_out;
Chris@4:             if (ret == Z_NEED_DICT)
Chris@4:                 ret = Z_DATA_ERROR;
Chris@4:             if (ret == Z_MEM_ERROR || ret == Z_DATA_ERROR)
Chris@4:                 goto build_index_error;
Chris@4:             if (ret == Z_STREAM_END)
Chris@4:                 break;
Chris@4: 
Chris@4:             /* if at end of block, consider adding an index entry (note that if
Chris@4:                data_type indicates an end-of-block, then all of the
Chris@4:                uncompressed data from that block has been delivered, and none
Chris@4:                of the compressed data after that block has been consumed,
Chris@4:                except for up to seven bits) -- the totout == 0 provides an
Chris@4:                entry point after the zlib or gzip header, and assures that the
Chris@4:                index always has at least one access point; we avoid creating an
Chris@4:                access point after the last block by checking bit 6 of data_type
Chris@4:              */
Chris@4:             if ((strm.data_type & 128) && !(strm.data_type & 64) &&
Chris@4:                 (totout == 0 || totout - last > span)) {
Chris@4:                 index = addpoint(index, strm.data_type & 7, totin,
Chris@4:                                  totout, strm.avail_out, window);
Chris@4:                 if (index == NULL) {
Chris@4:                     ret = Z_MEM_ERROR;
Chris@4:                     goto build_index_error;
Chris@4:                 }
Chris@4:                 last = totout;
Chris@4:             }
Chris@4:         } while (strm.avail_in != 0);
Chris@4:     } while (ret != Z_STREAM_END);
Chris@4: 
Chris@4:     /* clean up and return index (release unused entries in list) */
Chris@4:     (void)inflateEnd(&strm);
Chris@4:     index = realloc(index, sizeof(struct point) * index->have);
Chris@4:     index->size = index->have;
Chris@4:     *built = index;
Chris@4:     return index->size;
Chris@4: 
Chris@4:     /* return error */
Chris@4:   build_index_error:
Chris@4:     (void)inflateEnd(&strm);
Chris@4:     if (index != NULL)
Chris@4:         free_index(index);
Chris@4:     return ret;
Chris@4: }
Chris@4: 
Chris@4: /* Use the index to read len bytes from offset into buf, return bytes read or
Chris@4:    negative for error (Z_DATA_ERROR or Z_MEM_ERROR).  If data is requested past
Chris@4:    the end of the uncompressed data, then extract() will return a value less
Chris@4:    than len, indicating how much as actually read into buf.  This function
Chris@4:    should not return a data error unless the file was modified since the index
Chris@4:    was generated.  extract() may also return Z_ERRNO if there is an error on
Chris@4:    reading or seeking the input file. */
Chris@4: local int extract(FILE *in, struct access *index, off_t offset,
Chris@4:                   unsigned char *buf, int len)
Chris@4: {
Chris@4:     int ret, skip;
Chris@4:     z_stream strm;
Chris@4:     struct point *here;
Chris@4:     unsigned char input[CHUNK];
Chris@4:     unsigned char discard[WINSIZE];
Chris@4: 
Chris@4:     /* proceed only if something reasonable to do */
Chris@4:     if (len < 0)
Chris@4:         return 0;
Chris@4: 
Chris@4:     /* find where in stream to start */
Chris@4:     here = index->list;
Chris@4:     ret = index->have;
Chris@4:     while (--ret && here[1].out <= offset)
Chris@4:         here++;
Chris@4: 
Chris@4:     /* initialize file and inflate state to start there */
Chris@4:     strm.zalloc = Z_NULL;
Chris@4:     strm.zfree = Z_NULL;
Chris@4:     strm.opaque = Z_NULL;
Chris@4:     strm.avail_in = 0;
Chris@4:     strm.next_in = Z_NULL;
Chris@4:     ret = inflateInit2(&strm, -15);         /* raw inflate */
Chris@4:     if (ret != Z_OK)
Chris@4:         return ret;
Chris@4:     ret = fseeko(in, here->in - (here->bits ? 1 : 0), SEEK_SET);
Chris@4:     if (ret == -1)
Chris@4:         goto extract_ret;
Chris@4:     if (here->bits) {
Chris@4:         ret = getc(in);
Chris@4:         if (ret == -1) {
Chris@4:             ret = ferror(in) ? Z_ERRNO : Z_DATA_ERROR;
Chris@4:             goto extract_ret;
Chris@4:         }
Chris@4:         (void)inflatePrime(&strm, here->bits, ret >> (8 - here->bits));
Chris@4:     }
Chris@4:     (void)inflateSetDictionary(&strm, here->window, WINSIZE);
Chris@4: 
Chris@4:     /* skip uncompressed bytes until offset reached, then satisfy request */
Chris@4:     offset -= here->out;
Chris@4:     strm.avail_in = 0;
Chris@4:     skip = 1;                               /* while skipping to offset */
Chris@4:     do {
Chris@4:         /* define where to put uncompressed data, and how much */
Chris@4:         if (offset == 0 && skip) {          /* at offset now */
Chris@4:             strm.avail_out = len;
Chris@4:             strm.next_out = buf;
Chris@4:             skip = 0;                       /* only do this once */
Chris@4:         }
Chris@4:         if (offset > WINSIZE) {             /* skip WINSIZE bytes */
Chris@4:             strm.avail_out = WINSIZE;
Chris@4:             strm.next_out = discard;
Chris@4:             offset -= WINSIZE;
Chris@4:         }
Chris@4:         else if (offset != 0) {             /* last skip */
Chris@4:             strm.avail_out = (unsigned)offset;
Chris@4:             strm.next_out = discard;
Chris@4:             offset = 0;
Chris@4:         }
Chris@4: 
Chris@4:         /* uncompress until avail_out filled, or end of stream */
Chris@4:         do {
Chris@4:             if (strm.avail_in == 0) {
Chris@4:                 strm.avail_in = fread(input, 1, CHUNK, in);
Chris@4:                 if (ferror(in)) {
Chris@4:                     ret = Z_ERRNO;
Chris@4:                     goto extract_ret;
Chris@4:                 }
Chris@4:                 if (strm.avail_in == 0) {
Chris@4:                     ret = Z_DATA_ERROR;
Chris@4:                     goto extract_ret;
Chris@4:                 }
Chris@4:                 strm.next_in = input;
Chris@4:             }
Chris@4:             ret = inflate(&strm, Z_NO_FLUSH);       /* normal inflate */
Chris@4:             if (ret == Z_NEED_DICT)
Chris@4:                 ret = Z_DATA_ERROR;
Chris@4:             if (ret == Z_MEM_ERROR || ret == Z_DATA_ERROR)
Chris@4:                 goto extract_ret;
Chris@4:             if (ret == Z_STREAM_END)
Chris@4:                 break;
Chris@4:         } while (strm.avail_out != 0);
Chris@4: 
Chris@4:         /* if reach end of stream, then don't keep trying to get more */
Chris@4:         if (ret == Z_STREAM_END)
Chris@4:             break;
Chris@4: 
Chris@4:         /* do until offset reached and requested data read, or stream ends */
Chris@4:     } while (skip);
Chris@4: 
Chris@4:     /* compute number of uncompressed bytes read after offset */
Chris@4:     ret = skip ? 0 : len - strm.avail_out;
Chris@4: 
Chris@4:     /* clean up and return bytes read or error */
Chris@4:   extract_ret:
Chris@4:     (void)inflateEnd(&strm);
Chris@4:     return ret;
Chris@4: }
Chris@4: 
Chris@4: /* Demonstrate the use of build_index() and extract() by processing the file
Chris@4:    provided on the command line, and the extracting 16K from about 2/3rds of
Chris@4:    the way through the uncompressed output, and writing that to stdout. */
Chris@4: int main(int argc, char **argv)
Chris@4: {
Chris@4:     int len;
Chris@4:     off_t offset;
Chris@4:     FILE *in;
Chris@4:     struct access *index = NULL;
Chris@4:     unsigned char buf[CHUNK];
Chris@4: 
Chris@4:     /* open input file */
Chris@4:     if (argc != 2) {
Chris@4:         fprintf(stderr, "usage: zran file.gz\n");
Chris@4:         return 1;
Chris@4:     }
Chris@4:     in = fopen(argv[1], "rb");
Chris@4:     if (in == NULL) {
Chris@4:         fprintf(stderr, "zran: could not open %s for reading\n", argv[1]);
Chris@4:         return 1;
Chris@4:     }
Chris@4: 
Chris@4:     /* build index */
Chris@4:     len = build_index(in, SPAN, &index);
Chris@4:     if (len < 0) {
Chris@4:         fclose(in);
Chris@4:         switch (len) {
Chris@4:         case Z_MEM_ERROR:
Chris@4:             fprintf(stderr, "zran: out of memory\n");
Chris@4:             break;
Chris@4:         case Z_DATA_ERROR:
Chris@4:             fprintf(stderr, "zran: compressed data error in %s\n", argv[1]);
Chris@4:             break;
Chris@4:         case Z_ERRNO:
Chris@4:             fprintf(stderr, "zran: read error on %s\n", argv[1]);
Chris@4:             break;
Chris@4:         default:
Chris@4:             fprintf(stderr, "zran: error %d while building index\n", len);
Chris@4:         }
Chris@4:         return 1;
Chris@4:     }
Chris@4:     fprintf(stderr, "zran: built index with %d access points\n", len);
Chris@4: 
Chris@4:     /* use index by reading some bytes from an arbitrary offset */
Chris@4:     offset = (index->list[index->have - 1].out << 1) / 3;
Chris@4:     len = extract(in, index, offset, buf, CHUNK);
Chris@4:     if (len < 0)
Chris@4:         fprintf(stderr, "zran: extraction failed: %s error\n",
Chris@4:                 len == Z_MEM_ERROR ? "out of memory" : "input corrupted");
Chris@4:     else {
Chris@4:         fwrite(buf, 1, len, stdout);
Chris@4:         fprintf(stderr, "zran: extracted %d bytes at %llu\n", len, offset);
Chris@4:     }
Chris@4: 
Chris@4:     /* clean up and exit */
Chris@4:     free_index(index);
Chris@4:     fclose(in);
Chris@4:     return 0;
Chris@4: }