2 * Copyright (c) 2003-2007 Tim Kientzle
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(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include "archive_platform.h"
27 __FBSDID("$FreeBSD: src/lib/libarchive/archive_write_set_format_cpio.c,v 1.14 2008/03/15 11:04:45 kientzle Exp $");
41 #include "archive_entry.h"
42 #include "archive_private.h"
43 #include "archive_write_private.h"
45 static ssize_t archive_write_cpio_data(struct archive_write *,
46 const void *buff, size_t s);
47 static int archive_write_cpio_finish(struct archive_write *);
48 static int archive_write_cpio_destroy(struct archive_write *);
49 static int archive_write_cpio_finish_entry(struct archive_write *);
50 static int archive_write_cpio_header(struct archive_write *,
51 struct archive_entry *);
52 static int format_octal(int64_t, void *, int);
53 static int64_t format_octal_recursive(int64_t, char *, int);
56 uint64_t entry_bytes_remaining;
74 * Set output format to 'cpio' format.
77 archive_write_set_format_cpio(struct archive *_a)
79 struct archive_write *a = (struct archive_write *)_a;
82 /* If someone else was already registered, unregister them. */
83 if (a->format_destroy != NULL)
84 (a->format_destroy)(a);
86 cpio = (struct cpio *)malloc(sizeof(*cpio));
88 archive_set_error(&a->archive, ENOMEM, "Can't allocate cpio data");
89 return (ARCHIVE_FATAL);
91 memset(cpio, 0, sizeof(*cpio));
92 a->format_data = cpio;
94 a->pad_uncompressed = 1;
95 a->format_name = "cpio";
96 a->format_write_header = archive_write_cpio_header;
97 a->format_write_data = archive_write_cpio_data;
98 a->format_finish_entry = archive_write_cpio_finish_entry;
99 a->format_finish = archive_write_cpio_finish;
100 a->format_destroy = archive_write_cpio_destroy;
101 a->archive.archive_format = ARCHIVE_FORMAT_CPIO_POSIX;
102 a->archive.archive_format_name = "POSIX cpio";
107 archive_write_cpio_header(struct archive_write *a, struct archive_entry *entry)
110 const char *p, *path;
112 struct cpio_header h;
114 cpio = (struct cpio *)a->format_data;
117 path = archive_entry_pathname(entry);
118 pathlength = strlen(path) + 1; /* Include trailing null. */
120 memset(&h, 0, sizeof(h));
121 format_octal(070707, &h.c_magic, sizeof(h.c_magic));
122 format_octal(archive_entry_dev(entry), &h.c_dev, sizeof(h.c_dev));
124 * TODO: Generate artificial inode numbers rather than just
125 * re-using the ones off the disk. That way, the 18-bit c_ino
126 * field only limits the number of files in the archive.
128 if (archive_entry_ino(entry) > 0777777) {
129 archive_set_error(&a->archive, ERANGE, "large inode number truncated");
133 format_octal(archive_entry_ino(entry) & 0777777, &h.c_ino, sizeof(h.c_ino));
134 format_octal(archive_entry_mode(entry), &h.c_mode, sizeof(h.c_mode));
135 format_octal(archive_entry_uid(entry), &h.c_uid, sizeof(h.c_uid));
136 format_octal(archive_entry_gid(entry), &h.c_gid, sizeof(h.c_gid));
137 format_octal(archive_entry_nlink(entry), &h.c_nlink, sizeof(h.c_nlink));
138 if (archive_entry_filetype(entry) == AE_IFBLK
139 || archive_entry_filetype(entry) == AE_IFCHR)
140 format_octal(archive_entry_dev(entry), &h.c_rdev, sizeof(h.c_rdev));
142 format_octal(0, &h.c_rdev, sizeof(h.c_rdev));
143 format_octal(archive_entry_mtime(entry), &h.c_mtime, sizeof(h.c_mtime));
144 format_octal(pathlength, &h.c_namesize, sizeof(h.c_namesize));
146 /* Non-regular files don't store bodies. */
147 if (archive_entry_filetype(entry) != AE_IFREG)
148 archive_entry_set_size(entry, 0);
150 /* Symlinks get the link written as the body of the entry. */
151 p = archive_entry_symlink(entry);
152 if (p != NULL && *p != '\0')
153 format_octal(strlen(p), &h.c_filesize, sizeof(h.c_filesize));
155 format_octal(archive_entry_size(entry),
156 &h.c_filesize, sizeof(h.c_filesize));
158 ret = (a->compressor.write)(a, &h, sizeof(h));
159 if (ret != ARCHIVE_OK)
160 return (ARCHIVE_FATAL);
162 ret = (a->compressor.write)(a, path, pathlength);
163 if (ret != ARCHIVE_OK)
164 return (ARCHIVE_FATAL);
166 cpio->entry_bytes_remaining = archive_entry_size(entry);
168 /* Write the symlink now. */
169 if (p != NULL && *p != '\0')
170 ret = (a->compressor.write)(a, p, strlen(p));
176 archive_write_cpio_data(struct archive_write *a, const void *buff, size_t s)
181 cpio = (struct cpio *)a->format_data;
182 if (s > cpio->entry_bytes_remaining)
183 s = cpio->entry_bytes_remaining;
185 ret = (a->compressor.write)(a, buff, s);
186 cpio->entry_bytes_remaining -= s;
194 * Format a number into the specified field.
197 format_octal(int64_t v, void *p, int digits)
202 max = (((int64_t)1) << (digits * 3)) - 1;
203 if (v >= 0 && v <= max) {
204 format_octal_recursive(v, (char *)p, digits);
207 format_octal_recursive(max, (char *)p, digits);
214 format_octal_recursive(int64_t v, char *p, int s)
218 v = format_octal_recursive(v, p+1, s-1);
224 archive_write_cpio_finish(struct archive_write *a)
228 struct archive_entry *trailer;
230 cpio = (struct cpio *)a->format_data;
231 trailer = archive_entry_new();
232 /* nlink = 1 here for GNU cpio compat. */
233 archive_entry_set_nlink(trailer, 1);
234 archive_entry_set_pathname(trailer, "TRAILER!!!");
235 er = archive_write_cpio_header(a, trailer);
236 archive_entry_free(trailer);
241 archive_write_cpio_destroy(struct archive_write *a)
245 cpio = (struct cpio *)a->format_data;
247 a->format_data = NULL;
252 archive_write_cpio_finish_entry(struct archive_write *a)
257 cpio = (struct cpio *)a->format_data;
259 while (cpio->entry_bytes_remaining > 0) {
260 to_write = cpio->entry_bytes_remaining < a->null_length ?
261 cpio->entry_bytes_remaining : a->null_length;
262 ret = (a->compressor.write)(a, a->nulls, to_write);
263 if (ret != ARCHIVE_OK)
265 cpio->entry_bytes_remaining -= to_write;