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 *);
49 static off_t pkg_atol(const char *, unsigned);
51 struct fs_ops pkgfs_fsops = {
62 #define PKG_BUFSIZE 512
63 #define PKG_MAXCACHESZ 16384
65 #define PKG_FILEEXT ".tgz"
68 * Layout of POSIX 'ustar' header.
79 char ut_linkname[100];
80 char ut_magic[6]; /* For POSIX: "ustar\0" */
81 char ut_version[2]; /* For POSIX: "00" */
104 u_char __padding[12];
111 struct package *tf_pkg;
112 struct tarfile *tf_next;
113 struct ustar_hdr tf_hdr;
123 struct package *pkg_chain;
127 struct tarfile *pkg_first;
128 struct tarfile *pkg_last;
129 u_char pkg_buf[PKG_BUFSIZE];
132 static struct package *package = NULL;
134 static int new_package(int, struct package **);
139 struct package *chain;
140 struct tarfile *tf, *tfn;
142 while (package != NULL) {
143 inflateEnd(&package->pkg_zs);
144 close(package->pkg_fd);
146 tf = package->pkg_first;
149 if (tf->tf_cachesz > 0)
155 chain = package->pkg_chain;
162 pkgfs_init(const char *pkgname, struct fs_ops *proto)
168 if (proto != &pkgfs_fsops)
171 exclusive_file_system = proto;
173 fd = open(pkgname, O_RDONLY);
175 exclusive_file_system = NULL;
180 error = new_package(fd, &pkg);
189 pkg->pkg_chain = package;
191 exclusive_file_system = &pkgfs_fsops;
195 static int get_mode(struct tarfile *);
196 static int get_zipped(struct package *, void *, size_t);
197 static int new_package(int, struct package **);
198 static struct tarfile *scan_tarfile(struct package *, struct tarfile *);
201 pkg_open(const char *fn, struct open_file *f)
205 if (fn == NULL || f == NULL)
212 * We can only read from a package, so reject request to open
213 * for write-only or read-write.
215 if (f->f_flags != F_READ)
219 * Scan the file headers for the named file. We stop scanning
220 * at the first filename that has the .pkg extension. This is
221 * a package within a package. We assume we have all the files
222 * we need up-front and without having to dig within nested
225 * Note that we preserve streaming properties as much as possible.
231 * Allow opening of the root directory for use by readdir()
232 * to support listing files in the package.
239 tf = scan_tarfile(package, NULL);
241 if (strcmp(fn, tf->tf_hdr.ut_name) == 0) {
243 tf->tf_fp = 0; /* Reset the file pointer. */
246 tf = scan_tarfile(package, tf);
252 pkg_close(struct open_file *f)
256 tf = (struct tarfile *)f->f_fsdata;
261 * Free up the cache if we read all of the file.
263 if (tf->tf_fp == tf->tf_size && tf->tf_cachesz > 0) {
271 pkg_read(struct open_file *f, void *buf, size_t size, size_t *res)
278 tf = (struct tarfile *)f->f_fsdata;
289 sz = tf->tf_size - fp;
290 if (fp < tf->tf_cachesz && tf->tf_cachesz < tf->tf_size)
291 sz = tf->tf_cachesz - fp;
297 if (fp < tf->tf_cachesz) {
298 /* Satisfy the request from cache. */
299 memcpy(p, tf->tf_cache + fp, sz);
306 if (get_zipped(tf->tf_pkg, p, sz) == -1) {
315 if (tf->tf_cachesz != 0)
318 tf->tf_cachesz = (sz <= PKG_MAXCACHESZ) ? sz : PKG_MAXCACHESZ;
319 tf->tf_cache = malloc(tf->tf_cachesz);
320 if (tf->tf_cache != NULL)
321 memcpy(tf->tf_cache, buf, tf->tf_cachesz);
329 return ((sz == -1) ? errno : 0);
333 pkg_seek(struct open_file *f, off_t ofs, int whence)
342 tf = (struct tarfile *)f->f_fsdata;
350 delta = ofs - tf->tf_fp;
356 delta = tf->tf_size - tf->tf_fp + ofs;
364 /* seeking backwards - ok if within cache */
365 if (tf->tf_cachesz > 0 && tf->tf_fp <= tf->tf_cachesz) {
366 nofs = tf->tf_fp + delta;
372 DBG(("%s: negative file seek (%jd)\n", __func__,
378 while (delta > 0 && tf->tf_fp < tf->tf_size) {
379 sz = (delta > sizeof(buf)) ? sizeof(buf) : delta;
380 error = pkg_read(f, buf, sz, &res);
392 pkg_stat(struct open_file *f, struct stat *sb)
396 tf = (struct tarfile *)f->f_fsdata;
399 memset(sb, 0, sizeof(*sb));
400 sb->st_mode = get_mode(tf);
401 if ((sb->st_mode & S_IFMT) == 0) {
402 /* tar file bug - assume regular file */
403 sb->st_mode |= S_IFREG;
405 sb->st_size = tf->tf_size;
406 sb->st_blocks = (tf->tf_size + 511) / 512;
407 sb->st_mtime = pkg_atol(tf->tf_hdr.ut_mtime, 12);
408 sb->st_dev = (off_t)tf->tf_pkg;
409 sb->st_ino = tf->tf_ofs; /* unique per tf_pkg */
414 pkg_readdir(struct open_file *f, struct dirent *d)
418 tf = (struct tarfile *)f->f_fsdata;
422 tf = scan_tarfile(package, NULL);
427 d->d_reclen = sizeof(*d);
429 memcpy(d->d_name, tf->tf_hdr.ut_name, sizeof(d->d_name));
434 * Low-level support functions.
438 get_byte(struct package *pkg, off_t *op)
442 if (pkg->pkg_zs.avail_in == 0) {
443 c = read(pkg->pkg_fd, pkg->pkg_buf, PKG_BUFSIZE);
446 pkg->pkg_zs.avail_in = c;
447 pkg->pkg_zs.next_in = pkg->pkg_buf;
450 c = *pkg->pkg_zs.next_in;
451 pkg->pkg_zs.next_in++;
452 pkg->pkg_zs.avail_in--;
458 get_zipped(struct package *pkg, void *buf, size_t bufsz)
462 pkg->pkg_zs.next_out = buf;
463 pkg->pkg_zs.avail_out = bufsz;
465 while (pkg->pkg_zs.avail_out) {
466 if (pkg->pkg_zs.avail_in == 0) {
467 c = read(pkg->pkg_fd, pkg->pkg_buf, PKG_BUFSIZE);
472 pkg->pkg_zs.avail_in = c;
473 pkg->pkg_zs.next_in = pkg->pkg_buf;
476 c = inflate(&pkg->pkg_zs, Z_SYNC_FLUSH);
477 if (c != Z_OK && c != Z_STREAM_END) {
483 pkg->pkg_ofs += bufsz;
488 cache_data(struct tarfile *tf)
494 DBG(("%s: no file to cache data for?\n", __func__));
501 DBG(("%s: no package associated with file?\n", __func__));
506 if (tf->tf_ofs != pkg->pkg_ofs) {
507 DBG(("%s: caching after partial read of file %s?\n",
508 __func__, tf->tf_hdr.ut_name));
513 /* We don't cache everything... */
514 if (tf->tf_size > PKG_MAXCACHESZ) {
519 /* All files are padded to a multiple of 512 bytes. */
520 sz = (tf->tf_size + 0x1ff) & ~0x1ff;
522 tf->tf_cache = malloc(sz);
523 if (tf->tf_cache == NULL) {
524 DBG(("%s: could not allocate %d bytes\n", __func__, (int)sz));
530 return (get_zipped(pkg, tf->tf_cache, sz));
534 * Note that this implementation does not (and should not!) obey
535 * locale settings; you cannot simply substitute strtol here, since
536 * it does obey locale.
539 pkg_atol8(const char *p, unsigned char_cnt)
541 int64_t l, limit, last_digit_limit;
542 int digit, sign, base;
545 limit = INT64_MAX / base;
546 last_digit_limit = INT64_MAX % base;
548 while (*p == ' ' || *p == '\t')
558 while (digit >= 0 && digit < base && char_cnt-- > 0) {
559 if (l>limit || (l == limit && digit > last_digit_limit)) {
560 l = UINT64_MAX; /* Truncate on overflow. */
563 l = (l * base) + digit;
566 return (sign < 0) ? -l : l;
570 * Parse a base-256 integer. This is just a straight signed binary
571 * value in big-endian order, except that the high-order bit is
572 * ignored. Remember that "int64_t" may or may not be exactly 64
573 * bits; the implementation here tries to avoid making any assumptions
574 * about the actual size of an int64_t. It does assume we're using
575 * twos-complement arithmetic, though.
578 pkg_atol256(const char *_p, unsigned char_cnt)
580 int64_t l, upper_limit, lower_limit;
581 const unsigned char *p = (const unsigned char *)_p;
583 upper_limit = INT64_MAX / 256;
584 lower_limit = INT64_MIN / 256;
586 /* Pad with 1 or 0 bits, depending on sign. */
587 if ((0x40 & *p) == 0x40)
591 l = (l << 6) | (0x3f & *p++);
592 while (--char_cnt > 0) {
593 if (l > upper_limit) {
594 l = INT64_MAX; /* Truncate on overflow */
596 } else if (l < lower_limit) {
600 l = (l << 8) | (0xff & (int64_t)*p++);
606 pkg_atol(const char *p, unsigned char_cnt)
609 * Technically, GNU pkg considers a field to be in base-256
610 * only if the first byte is 0xff or 0x80.
613 return (pkg_atol256(p, char_cnt));
614 return (pkg_atol8(p, char_cnt));
618 get_mode(struct tarfile *tf)
620 return (pkg_atol(tf->tf_hdr.ut_mode, sizeof(tf->tf_hdr.ut_mode)));
624 #define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
625 #define HEAD_CRC 0x02 /* bit 1 set: header CRC present */
626 #define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
627 #define ORIG_NAME 0x08 /* bit 3 set: original file name present */
628 #define COMMENT 0x10 /* bit 4 set: file comment present */
629 #define RESERVED 0xE0 /* bits 5..7: reserved */
632 new_package(int fd, struct package **pp)
638 pkg = malloc(sizeof(*pkg));
642 bzero(pkg, sizeof(*pkg));
652 if (get_byte(pkg, &ofs) != 0x1f || get_byte(pkg, &ofs) != 0x8b)
655 if (get_byte(pkg, &ofs) != Z_DEFLATED)
658 flags = get_byte(pkg, &ofs);
659 if (flags & RESERVED)
662 /* Skip time, xflags and OS code. */
663 for (i = 0; i < 6; i++) {
664 if (get_byte(pkg, &ofs) == -1)
668 /* Skip extra field. */
669 if (flags & EXTRA_FIELD) {
670 i = (get_byte(pkg, &ofs) & 0xff) |
671 ((get_byte(pkg, &ofs) << 8) & 0xff);
673 if (get_byte(pkg, &ofs) == -1)
678 /* Skip original file name. */
679 if (flags & ORIG_NAME) {
681 i = get_byte(pkg, &ofs);
682 } while (i != 0 && i != -1);
687 /* Print the comment if it's there. */
688 if (flags & COMMENT) {
690 i = get_byte(pkg, &ofs);
700 if (flags & HEAD_CRC) {
701 if (get_byte(pkg, &ofs) == -1)
703 if (get_byte(pkg, &ofs) == -1)
708 * Done parsing the ZIP header. Spkgt the inflation engine.
710 error = inflateInit2(&pkg->pkg_zs, -15);
722 static struct tarfile *
723 scan_tarfile(struct package *pkg, struct tarfile *last)
730 cur = (last != NULL) ? last->tf_next : pkg->pkg_first;
732 ofs = (last != NULL) ? last->tf_ofs + last->tf_size :
734 ofs = (ofs + 0x1ff) & ~0x1ff;
736 /* Check if we've reached EOF. */
737 if (ofs < pkg->pkg_ofs) {
742 if (ofs != pkg->pkg_ofs) {
743 if (last != NULL && pkg->pkg_ofs == last->tf_ofs) {
744 if (cache_data(last) == -1)
747 sz = ofs - pkg->pkg_ofs;
749 if (sz > sizeof(buf))
751 if (get_zipped(pkg, buf, sz) == -1)
753 sz = ofs - pkg->pkg_ofs;
758 cur = malloc(sizeof(*cur));
761 memset(cur, 0, sizeof(*cur));
765 if (get_zipped(pkg, &cur->tf_hdr,
766 sizeof(cur->tf_hdr)) == -1) {
772 * There are always 2 empty blocks appended to
773 * a PKG. It marks the end of the archive.
775 if (strncmp(cur->tf_hdr.ut_magic, "ustar", 5) != 0) {
781 cur->tf_ofs = pkg->pkg_ofs;
782 cur->tf_size = pkg_atol(cur->tf_hdr.ut_size,
783 sizeof(cur->tf_hdr.ut_size));
785 if (cur->tf_hdr.ut_name[0] != '+')
789 * Skip package meta-files.
791 ofs = cur->tf_ofs + cur->tf_size;
792 ofs = (ofs + 0x1ff) & ~0x1ff;
793 while (pkg->pkg_ofs < ofs) {
794 if (get_zipped(pkg, buf, sizeof(buf)) == -1) {
804 pkg->pkg_first = cur;