lib/libstand/gzipfs.c

   1 /*
   2  * Copyright (c) 1998 Michael Smith.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "stand.h"
  31
  32 #include <sys/stat.h>
  33 #include <string.h>
  34 #include <zlib.h>
  35
  36 #define Z_BUFSIZE 2048  /* XXX larger? */
  37
  38 struct z_file
  39 {
  40     int                 zf_rawfd;
  41     off_t               zf_dataoffset;
  42     z_stream            zf_zstream;
  43     char                zf_buf[Z_BUFSIZE];
  44 };
  45
  46 static int      zf_fill(struct z_file *z);
  47 static int      zf_open(const char *path, struct open_file *f);
  48 static int      zf_close(struct open_file *f);
  49 static int      zf_read(struct open_file *f, void *buf, size_t size, size_t *resid);
  50 static off_t    zf_seek(struct open_file *f, off_t offset, int where);
  51 static int      zf_stat(struct open_file *f, struct stat *sb);
  52
  53 struct fs_ops gzipfs_fsops = {
  54     "zip",
  55     zf_open,
  56     zf_close,
  57     zf_read,
  58     null_write,
  59     zf_seek,
  60     zf_stat,
  61     null_readdir
  62 };
  63
  64 #if 0
  65 void *
  66 calloc(int items, size_t size)
  67 {
  68     return(malloc(items * size));
  69 }
  70 #endif
  71
  72 static int
  73 zf_fill(struct z_file *zf)
  74 {
  75     int         result;
  76     int         req;
  77
  78     req = Z_BUFSIZE - zf->zf_zstream.avail_in;
  79     result = 0;
  80
  81     /* If we need more */
  82     if (req > 0) {
  83         /* move old data to bottom of buffer */
  84         if (req < Z_BUFSIZE)
  85             bcopy(zf->zf_buf + req, zf->zf_buf, Z_BUFSIZE - req);
  86
  87         /* read to fill buffer and update availibility data */
  88         result = read(zf->zf_rawfd, zf->zf_buf + zf->zf_zstream.avail_in, req);
  89         zf->zf_zstream.next_in = zf->zf_buf;
  90         if (result >= 0)
  91             zf->zf_zstream.avail_in += result;
  92     }
  93     return(result);
  94 }
  95
  96 /*
  97  * Adapted from get_byte/check_header in libz
  98  *
  99  * Returns 0 if the header is OK, nonzero if not.
 100  */
 101 static int
 102 get_byte(struct z_file *zf, off_t *curoffp)
 103 {
 104     if ((zf->zf_zstream.avail_in == 0) && (zf_fill(zf) == -1))
 105         return(-1);
 106     zf->zf_zstream.avail_in--;
 107     ++*curoffp;
 108     return(*(zf->zf_zstream.next_in)++);
 109 }
 110
 111 static int gz_magic[2] = {0x1f, 0x8b}; /* gzip magic header */
 112
 113 /* gzip flag byte */
 114 #define ASCII_FLAG      0x01 /* bit 0 set: file probably ascii text */
 115 #define HEAD_CRC        0x02 /* bit 1 set: header CRC present */
 116 #define EXTRA_FIELD     0x04 /* bit 2 set: extra field present */
 117 #define ORIG_NAME       0x08 /* bit 3 set: original file name present */
 118 #define COMMENT         0x10 /* bit 4 set: file comment present */
 119 #define RESERVED        0xE0 /* bits 5..7: reserved */
 120
 121 static int
 122 check_header(struct z_file *zf)
 123 {
 124     int         method; /* method byte */
 125     int         flags;  /* flags byte */
 126     uInt        len;
 127     int         c;
 128
 129     zf->zf_dataoffset = 0;
 130     /* Check the gzip magic header */
 131     for (len = 0; len < 2; len++) {
 132         c = get_byte(zf, &zf->zf_dataoffset);
 133         if (c != gz_magic[len]) {
 134             return(1);
 135         }
 136     }
 137     method = get_byte(zf, &zf->zf_dataoffset);
 138     flags = get_byte(zf, &zf->zf_dataoffset);
 139     if (method != Z_DEFLATED || (flags & RESERVED) != 0) {
 140         return(1);
 141     }
 142
 143     /* Discard time, xflags and OS code: */
 144     for (len = 0; len < 6; len++) (void)get_byte(zf, &zf->zf_dataoffset);
 145
 146     if ((flags & EXTRA_FIELD) != 0) { /* skip the extra field */
 147         len  =  (uInt)get_byte(zf, &zf->zf_dataoffset);
 148         len += ((uInt)get_byte(zf, &zf->zf_dataoffset))<<8;
 149         /* len is garbage if EOF but the loop below will quit anyway */
 150         while (len-- != 0 && get_byte(zf, &zf->zf_dataoffset) != -1) ;
 151     }
 152     if ((flags & ORIG_NAME) != 0) { /* skip the original file name */
 153         while ((c = get_byte(zf, &zf->zf_dataoffset)) != 0 && c != -1) ;
 154     }
 155     if ((flags & COMMENT) != 0) {   /* skip the .gz file comment */
 156         while ((c = get_byte(zf, &zf->zf_dataoffset)) != 0 && c != -1) ;
 157     }
 158     if ((flags & HEAD_CRC) != 0) {  /* skip the header crc */
 159         for (len = 0; len < 2; len++) c = get_byte(zf, &zf->zf_dataoffset);
 160     }
 161     /* if there's data left, we're in business */
 162     return((c == -1) ? 1 : 0);
 163 }
 164
 165 static int
 166 zf_open(const char *fname, struct open_file *f)
 167 {
 168     static char         *zfname;
 169     int                 rawfd;
 170     struct z_file       *zf;
 171     char                *cp;
 172     int                 error;
 173     struct stat         sb;
 174
 175     /* Have to be in "just read it" mode */
 176     if (f->f_flags != F_READ)
 177         return(EPERM);
 178
 179     /* If the name already ends in .gz or .bz2, ignore it */
 180     if ((cp = strrchr(fname, '.')) && (!strcmp(cp, ".gz")
 181             || !strcmp(cp, ".bz2") || !strcmp(cp, ".split")))
 182         return(ENOENT);
 183
 184     /* Construct new name */
 185     zfname = malloc(strlen(fname) + 4);
 186     if (zfname == NULL)
 187         return(ENOMEM);
 188     sprintf(zfname, "%s.gz", fname);
 189
 190     /* Try to open the compressed datafile */
 191     rawfd = open(zfname, O_RDONLY);
 192     free(zfname);
 193     if (rawfd == -1)
 194         return(ENOENT);
 195
 196     if (fstat(rawfd, &sb) < 0) {
 197         printf("zf_open: stat failed\n");
 198         close(rawfd);
 199         return(ENOENT);
 200     }
 201     if (!S_ISREG(sb.st_mode)) {
 202         printf("zf_open: not a file\n");
 203         close(rawfd);
 204         return(EISDIR);                 /* best guess */
 205     }
 206
 207     /* Allocate a z_file structure, populate it */
 208     zf = malloc(sizeof(struct z_file));
 209     if (zf == NULL)
 210         return(ENOMEM);
 211     bzero(zf, sizeof(struct z_file));
 212     zf->zf_rawfd = rawfd;
 213
 214     /* Verify that the file is gzipped (XXX why do this afterwards?) */
 215     if (check_header(zf)) {
 216         close(zf->zf_rawfd);
 217         inflateEnd(&(zf->zf_zstream));
 218         free(zf);
 219         return(EFTYPE);
 220     }
 221
 222     /* Initialise the inflation engine */
 223     if ((error = inflateInit2(&(zf->zf_zstream), -15)) != Z_OK) {
 224         printf("zf_open: inflateInit returned %d : %s\n", error, zf->zf_zstream.msg);
 225         close(zf->zf_rawfd);
 226         free(zf);
 227         return(EIO);
 228     }
 229
 230     /* Looks OK, we'll take it */
 231     f->f_fsdata = zf;
 232     return(0);
 233 }
 234
 235 static int
 236 zf_close(struct open_file *f)
 237 {
 238     struct z_file       *zf = (struct z_file *)f->f_fsdata;
 239
 240     inflateEnd(&(zf->zf_zstream));
 241     close(zf->zf_rawfd);
 242     free(zf);
 243     return(0);
 244 }
 245
 246 static int
 247 zf_read(struct open_file *f, void *buf, size_t size, size_t *resid)
 248 {
 249     struct z_file       *zf = (struct z_file *)f->f_fsdata;
 250     int                 error;
 251
 252     zf->zf_zstream.next_out = buf;                      /* where and how much */
 253     zf->zf_zstream.avail_out = size;
 254
 255     while (zf->zf_zstream.avail_out) {
 256         if ((zf->zf_zstream.avail_in == 0) && (zf_fill(zf) == -1)) {
 257             printf("zf_read: fill error\n");
 258             return(EIO);
 259         }
 260         if (zf->zf_zstream.avail_in == 0) {             /* oops, unexpected EOF */
 261             printf("zf_read: unexpected EOF\n");
 262             if (zf->zf_zstream.avail_out == size)
 263                 return (EIO);
 264             break;
 265         }
 266
 267         error = inflate(&zf->zf_zstream, Z_SYNC_FLUSH); /* decompression pass */
 268         if (error == Z_STREAM_END) {                    /* EOF, all done */
 269             break;
 270         }
 271         if (error != Z_OK) {                            /* argh, decompression error */
 272             printf("inflate: %s\n", zf->zf_zstream.msg);
 273             return(EIO);
 274         }
 275     }
 276     if (resid != NULL)
 277         *resid = zf->zf_zstream.avail_out;
 278     return(0);
 279 }
 280
 281 static int
 282 zf_rewind(struct open_file *f)
 283 {
 284     struct z_file       *zf = (struct z_file *)f->f_fsdata;
 285
 286     if (lseek(zf->zf_rawfd, zf->zf_dataoffset, SEEK_SET) == -1)
 287         return -1;
 288     zf->zf_zstream.avail_in = 0;
 289     zf->zf_zstream.next_in = NULL;
 290     (void)inflateReset(&zf->zf_zstream);
 291
 292     return 0;
 293 }
 294
 295 static off_t
 296 zf_seek(struct open_file *f, off_t offset, int where)
 297 {
 298     struct z_file       *zf = (struct z_file *)f->f_fsdata;
 299     off_t               target;
 300     char                discard[16];
 301
 302     switch (where) {
 303     case SEEK_SET:
 304         target = offset;
 305         break;
 306     case SEEK_CUR:
 307         target = offset + zf->zf_zstream.total_out;
 308         break;
 309     case SEEK_END:
 310         target = -1;
 311     default:
 312         errno = EINVAL;
 313         return (-1);
 314     }
 315
 316     /* rewind if required */
 317     if (target < zf->zf_zstream.total_out && zf_rewind(f) != 0)
 318         return -1;
 319
 320     /* skip forwards if required */
 321     while (target > zf->zf_zstream.total_out) {
 322         errno = zf_read(f, discard, min(sizeof(discard),
 323             target - zf->zf_zstream.total_out), NULL);
 324         if (errno)
 325             return(-1);
 326     }
 327     /* This is where we are (be honest if we overshot) */
 328     return (zf->zf_zstream.total_out);
 329 }
 330
 331
 332 static int
 333 zf_stat(struct open_file *f, struct stat *sb)
 334 {
 335     struct z_file       *zf = (struct z_file *)f->f_fsdata;
 336     int                 result;
 337
 338     /* stat as normal, but indicate that size is unknown */
 339     if ((result = fstat(zf->zf_rawfd, sb)) == 0)
 340         sb->st_size = -1;
 341     return(result);
 342 }
 343
 344
 345