2 * Copyright (c) 2007-2014, Juniper Networks, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
33 #include <sys/stdint.h>
38 #define DBG(x) printf x
43 static int pkg_open(const char *, struct open_file *);
44 static int pkg_close(struct open_file *);
45 static int pkg_read(struct open_file *, void *, size_t, size_t *);
46 static off_t pkg_seek(struct open_file *, off_t, int);
47 static int pkg_stat(struct open_file *, struct stat *);
48 static int pkg_readdir(struct open_file *, struct dirent *);
50 struct fs_ops pkgfs_fsops = {
61 #define PKG_BUFSIZE 512
62 #define PKG_MAXCACHESZ 4096
64 #define PKG_FILEEXT ".tgz"
67 * Layout of POSIX 'ustar' header.
78 char ut_linkname[100];
79 char ut_magic[6]; /* For POSIX: "ustar\0" */
80 char ut_version[2]; /* For POSIX: "00" */
103 u_char __padding[12];
110 struct package *tf_pkg;
111 struct tarfile *tf_next;
112 struct ustar_hdr tf_hdr;
122 struct package *pkg_chain;
126 struct tarfile *pkg_first;
127 struct tarfile *pkg_last;
128 u_char pkg_buf[PKG_BUFSIZE];
131 static struct package *package = NULL;
133 static int new_package(int, struct package **);
138 struct package *chain;
139 struct tarfile *tf, *tfn;
141 while (package != NULL) {
142 inflateEnd(&package->pkg_zs);
143 close(package->pkg_fd);
145 tf = package->pkg_first;
148 if (tf->tf_cachesz > 0)
154 chain = package->pkg_chain;
161 pkgfs_init(const char *pkgname, struct fs_ops *proto)
167 if (proto != &pkgfs_fsops)
170 exclusive_file_system = proto;
172 fd = open(pkgname, O_RDONLY);
174 exclusive_file_system = NULL;
179 error = new_package(fd, &pkg);
188 pkg->pkg_chain = package;
190 exclusive_file_system = &pkgfs_fsops;
194 static int get_mode(struct tarfile *);
195 static int get_zipped(struct package *, void *, size_t);
196 static int new_package(int, struct package **);
197 static struct tarfile *scan_tarfile(struct package *, struct tarfile *);
200 pkg_open(const char *fn, struct open_file *f)
204 if (fn == NULL || f == NULL)
211 * We can only read from a package, so reject request to open
212 * for write-only or read-write.
214 if (f->f_flags != F_READ)
218 * Scan the file headers for the named file. We stop scanning
219 * at the first filename that has the .pkg extension. This is
220 * a package within a package. We assume we have all the files
221 * we need up-front and without having to dig within nested
224 * Note that we preserve streaming properties as much as possible.
230 * Allow opening of the root directory for use by readdir()
231 * to support listing files in the package.
238 tf = scan_tarfile(package, NULL);
240 if (strcmp(fn, tf->tf_hdr.ut_name) == 0) {
242 tf->tf_fp = 0; /* Reset the file pointer. */
245 tf = scan_tarfile(package, tf);
251 pkg_close(struct open_file *f)
255 tf = (struct tarfile *)f->f_fsdata;
260 * Free up the cache if we read all of the file.
262 if (tf->tf_fp == tf->tf_size && tf->tf_cachesz > 0) {
270 pkg_read(struct open_file *f, void *buf, size_t size, size_t *res)
277 tf = (struct tarfile *)f->f_fsdata;
288 sz = tf->tf_size - fp;
289 if (fp < tf->tf_cachesz && tf->tf_cachesz < tf->tf_size)
290 sz = tf->tf_cachesz - fp;
296 if (fp < tf->tf_cachesz) {
297 /* Satisfy the request from cache. */
298 memcpy(p, tf->tf_cache + fp, sz);
305 if (get_zipped(tf->tf_pkg, p, sz) == -1) {
314 if (tf->tf_cachesz != 0)
317 tf->tf_cachesz = (sz <= PKG_MAXCACHESZ) ? sz : PKG_MAXCACHESZ;
318 tf->tf_cache = malloc(tf->tf_cachesz);
319 if (tf->tf_cache != NULL)
320 memcpy(tf->tf_cache, buf, tf->tf_cachesz);
328 return ((sz == -1) ? errno : 0);
332 pkg_seek(struct open_file *f, off_t ofs, int whence)
340 tf = (struct tarfile *)f->f_fsdata;
348 delta = ofs - tf->tf_fp;
354 delta = tf->tf_size - tf->tf_fp + ofs;
362 DBG(("%s: negative file seek (%jd)\n", __func__,
368 while (delta > 0 && tf->tf_fp < tf->tf_size) {
369 sz = (delta > sizeof(buf)) ? sizeof(buf) : delta;
370 error = pkg_read(f, buf, sz, &res);
382 pkg_stat(struct open_file *f, struct stat *sb)
386 tf = (struct tarfile *)f->f_fsdata;
389 memset(sb, 0, sizeof(*sb));
390 sb->st_mode = get_mode(tf);
391 sb->st_size = tf->tf_size;
392 sb->st_blocks = (tf->tf_size + 511) / 512;
397 pkg_readdir(struct open_file *f, struct dirent *d)
401 tf = (struct tarfile *)f->f_fsdata;
405 tf = scan_tarfile(package, NULL);
410 d->d_reclen = sizeof(*d);
412 memcpy(d->d_name, tf->tf_hdr.ut_name, sizeof(d->d_name));
417 * Low-level support functions.
421 get_byte(struct package *pkg, off_t *op)
425 if (pkg->pkg_zs.avail_in == 0) {
426 c = read(pkg->pkg_fd, pkg->pkg_buf, PKG_BUFSIZE);
429 pkg->pkg_zs.avail_in = c;
430 pkg->pkg_zs.next_in = pkg->pkg_buf;
433 c = *pkg->pkg_zs.next_in;
434 pkg->pkg_zs.next_in++;
435 pkg->pkg_zs.avail_in--;
441 get_zipped(struct package *pkg, void *buf, size_t bufsz)
445 pkg->pkg_zs.next_out = buf;
446 pkg->pkg_zs.avail_out = bufsz;
448 while (pkg->pkg_zs.avail_out) {
449 if (pkg->pkg_zs.avail_in == 0) {
450 c = read(pkg->pkg_fd, pkg->pkg_buf, PKG_BUFSIZE);
455 pkg->pkg_zs.avail_in = c;
456 pkg->pkg_zs.next_in = pkg->pkg_buf;
459 c = inflate(&pkg->pkg_zs, Z_SYNC_FLUSH);
460 if (c != Z_OK && c != Z_STREAM_END) {
466 pkg->pkg_ofs += bufsz;
471 cache_data(struct tarfile *tf)
477 DBG(("%s: no file to cache data for?\n", __func__));
484 DBG(("%s: no package associated with file?\n", __func__));
489 if (tf->tf_ofs != pkg->pkg_ofs) {
490 DBG(("%s: caching after partial read of file %s?\n",
491 __func__, tf->tf_hdr.ut_name));
496 /* We don't cache everything... */
497 if (tf->tf_size > PKG_MAXCACHESZ) {
502 /* All files are padded to a multiple of 512 bytes. */
503 sz = (tf->tf_size + 0x1ff) & ~0x1ff;
505 tf->tf_cache = malloc(sz);
506 if (tf->tf_cache == NULL) {
507 DBG(("%s: could not allocate %d bytes\n", __func__, (int)sz));
513 return (get_zipped(pkg, tf->tf_cache, sz));
517 * Note that this implementation does not (and should not!) obey
518 * locale settings; you cannot simply substitute strtol here, since
519 * it does obey locale.
522 pkg_atol8(const char *p, unsigned char_cnt)
524 int64_t l, limit, last_digit_limit;
525 int digit, sign, base;
528 limit = INT64_MAX / base;
529 last_digit_limit = INT64_MAX % base;
531 while (*p == ' ' || *p == '\t')
541 while (digit >= 0 && digit < base && char_cnt-- > 0) {
542 if (l>limit || (l == limit && digit > last_digit_limit)) {
543 l = UINT64_MAX; /* Truncate on overflow. */
546 l = (l * base) + digit;
549 return (sign < 0) ? -l : l;
553 * Parse a base-256 integer. This is just a straight signed binary
554 * value in big-endian order, except that the high-order bit is
555 * ignored. Remember that "int64_t" may or may not be exactly 64
556 * bits; the implementation here tries to avoid making any assumptions
557 * about the actual size of an int64_t. It does assume we're using
558 * twos-complement arithmetic, though.
561 pkg_atol256(const char *_p, unsigned char_cnt)
563 int64_t l, upper_limit, lower_limit;
564 const unsigned char *p = (const unsigned char *)_p;
566 upper_limit = INT64_MAX / 256;
567 lower_limit = INT64_MIN / 256;
569 /* Pad with 1 or 0 bits, depending on sign. */
570 if ((0x40 & *p) == 0x40)
574 l = (l << 6) | (0x3f & *p++);
575 while (--char_cnt > 0) {
576 if (l > upper_limit) {
577 l = INT64_MAX; /* Truncate on overflow */
579 } else if (l < lower_limit) {
583 l = (l << 8) | (0xff & (int64_t)*p++);
589 pkg_atol(const char *p, unsigned char_cnt)
592 * Technically, GNU pkg considers a field to be in base-256
593 * only if the first byte is 0xff or 0x80.
596 return (pkg_atol256(p, char_cnt));
597 return (pkg_atol8(p, char_cnt));
601 get_mode(struct tarfile *tf)
603 return (pkg_atol(tf->tf_hdr.ut_mode, sizeof(tf->tf_hdr.ut_mode)));
607 #define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
608 #define HEAD_CRC 0x02 /* bit 1 set: header CRC present */
609 #define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
610 #define ORIG_NAME 0x08 /* bit 3 set: original file name present */
611 #define COMMENT 0x10 /* bit 4 set: file comment present */
612 #define RESERVED 0xE0 /* bits 5..7: reserved */
615 new_package(int fd, struct package **pp)
621 pkg = malloc(sizeof(*pkg));
625 bzero(pkg, sizeof(*pkg));
635 if (get_byte(pkg, &ofs) != 0x1f || get_byte(pkg, &ofs) != 0x8b)
638 if (get_byte(pkg, &ofs) != Z_DEFLATED)
641 flags = get_byte(pkg, &ofs);
642 if (flags & RESERVED)
645 /* Skip time, xflags and OS code. */
646 for (i = 0; i < 6; i++) {
647 if (get_byte(pkg, &ofs) == -1)
651 /* Skip extra field. */
652 if (flags & EXTRA_FIELD) {
653 i = (get_byte(pkg, &ofs) & 0xff) |
654 ((get_byte(pkg, &ofs) << 8) & 0xff);
656 if (get_byte(pkg, &ofs) == -1)
661 /* Skip original file name. */
662 if (flags & ORIG_NAME) {
664 i = get_byte(pkg, &ofs);
665 } while (i != 0 && i != -1);
670 /* Print the comment if it's there. */
671 if (flags & COMMENT) {
673 i = get_byte(pkg, &ofs);
683 if (flags & HEAD_CRC) {
684 if (get_byte(pkg, &ofs) == -1)
686 if (get_byte(pkg, &ofs) == -1)
691 * Done parsing the ZIP header. Spkgt the inflation engine.
693 error = inflateInit2(&pkg->pkg_zs, -15);
705 static struct tarfile *
706 scan_tarfile(struct package *pkg, struct tarfile *last)
713 cur = (last != NULL) ? last->tf_next : pkg->pkg_first;
715 ofs = (last != NULL) ? last->tf_ofs + last->tf_size :
717 ofs = (ofs + 0x1ff) & ~0x1ff;
719 /* Check if we've reached EOF. */
720 if (ofs < pkg->pkg_ofs) {
725 if (ofs != pkg->pkg_ofs) {
726 if (last != NULL && pkg->pkg_ofs == last->tf_ofs) {
727 if (cache_data(last) == -1)
730 sz = ofs - pkg->pkg_ofs;
732 if (sz > sizeof(buf))
734 if (get_zipped(pkg, buf, sz) == -1)
736 sz = ofs - pkg->pkg_ofs;
741 cur = malloc(sizeof(*cur));
744 memset(cur, 0, sizeof(*cur));
748 if (get_zipped(pkg, &cur->tf_hdr,
749 sizeof(cur->tf_hdr)) == -1) {
755 * There are always 2 empty blocks appended to
756 * a PKG. It marks the end of the archive.
758 if (strncmp(cur->tf_hdr.ut_magic, "ustar", 5) != 0) {
764 cur->tf_ofs = pkg->pkg_ofs;
765 cur->tf_size = pkg_atol(cur->tf_hdr.ut_size,
766 sizeof(cur->tf_hdr.ut_size));
768 if (cur->tf_hdr.ut_name[0] != '+')
772 * Skip package meta-files.
774 ofs = cur->tf_ofs + cur->tf_size;
775 ofs = (ofs + 0x1ff) & ~0x1ff;
776 while (pkg->pkg_ofs < ofs) {
777 if (get_zipped(pkg, buf, sizeof(buf)) == -1) {
787 pkg->pkg_first = cur;