2 * Copyright (c) 2003-2010 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$");
29 #ifdef HAVE_SYS_IOCTL_H
30 #include <sys/ioctl.h>
32 #ifdef HAVE_SYS_STAT_H
53 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
55 #elif defined(__NetBSD__) || defined(__OpenBSD__)
56 #include <sys/disklabel.h>
58 #elif defined(__DragonFly__)
59 #include <sys/diskslice.h>
63 #include "archive_private.h"
64 #include "archive_string.h"
73 struct read_file_data {
77 mode_t st_mode; /* Mode bits for opened file. */
79 enum fnt_e { FNT_STDIN, FNT_MBS, FNT_WCS } filename_type;
81 char m[1];/* MBS filename. */
82 wchar_t w[1];/* WCS filename. */
83 } filename; /* Must be last! */
86 static int file_open(struct archive *, void *);
87 static int file_close(struct archive *, void *);
88 static int file_close2(struct archive *, void *);
89 static int file_switch(struct archive *, void *, void *);
90 static ssize_t file_read(struct archive *, void *, const void **buff);
91 static int64_t file_seek(struct archive *, void *, int64_t request, int);
92 static int64_t file_skip(struct archive *, void *, int64_t request);
93 static int64_t file_skip_lseek(struct archive *, void *, int64_t request);
96 archive_read_open_file(struct archive *a, const char *filename,
99 return (archive_read_open_filename(a, filename, block_size));
103 archive_read_open_filename(struct archive *a, const char *filename,
106 const char *filenames[2];
107 filenames[0] = filename;
109 return archive_read_open_filenames(a, filenames, block_size);
113 archive_read_open_filenames(struct archive *a, const char **filenames,
116 struct read_file_data *mine;
117 const char *filename = NULL;
119 filename = *(filenames++);
121 archive_clear_error(a);
124 if (filename == NULL)
126 mine = (struct read_file_data *)calloc(1,
127 sizeof(*mine) + strlen(filename));
130 strcpy(mine->filename.m, filename);
131 mine->block_size = block_size;
134 mine->st_mode = mine->use_lseek = 0;
135 if (filename == NULL || filename[0] == '\0') {
136 mine->filename_type = FNT_STDIN;
138 mine->filename_type = FNT_MBS;
139 if (archive_read_append_callback_data(a, mine) != (ARCHIVE_OK))
140 return (ARCHIVE_FATAL);
141 if (filenames == NULL)
143 filename = *(filenames++);
144 } while (filename != NULL && filename[0] != '\0');
145 archive_read_set_open_callback(a, file_open);
146 archive_read_set_read_callback(a, file_read);
147 archive_read_set_skip_callback(a, file_skip);
148 archive_read_set_close_callback(a, file_close);
149 archive_read_set_switch_callback(a, file_switch);
150 archive_read_set_seek_callback(a, file_seek);
152 return (archive_read_open1(a));
154 archive_set_error(a, ENOMEM, "No memory");
155 return (ARCHIVE_FATAL);
159 archive_read_open_filename_w(struct archive *a, const wchar_t *wfilename,
162 struct read_file_data *mine = (struct read_file_data *)calloc(1,
163 sizeof(*mine) + wcslen(wfilename) * sizeof(wchar_t));
166 archive_set_error(a, ENOMEM, "No memory");
167 return (ARCHIVE_FATAL);
170 mine->block_size = block_size;
172 if (wfilename == NULL || wfilename[0] == L'\0') {
173 mine->filename_type = FNT_STDIN;
175 #if defined(_WIN32) && !defined(__CYGWIN__)
176 mine->filename_type = FNT_WCS;
177 wcscpy(mine->filename.w, wfilename);
180 * POSIX system does not support a wchar_t interface for
181 * open() system call, so we have to translate a wchar_t
182 * filename to multi-byte one and use it.
184 struct archive_string fn;
186 archive_string_init(&fn);
187 if (archive_string_append_from_wcs(&fn, wfilename,
188 wcslen(wfilename)) != 0) {
190 archive_set_error(a, errno,
191 "Can't allocate memory");
193 archive_set_error(a, EINVAL,
194 "Failed to convert a wide-character"
195 " filename to a multi-byte filename");
196 archive_string_free(&fn);
198 return (ARCHIVE_FATAL);
200 mine->filename_type = FNT_MBS;
201 strcpy(mine->filename.m, fn.s);
202 archive_string_free(&fn);
205 if (archive_read_append_callback_data(a, mine) != (ARCHIVE_OK))
206 return (ARCHIVE_FATAL);
207 archive_read_set_open_callback(a, file_open);
208 archive_read_set_read_callback(a, file_read);
209 archive_read_set_skip_callback(a, file_skip);
210 archive_read_set_close_callback(a, file_close);
211 archive_read_set_switch_callback(a, file_switch);
212 archive_read_set_seek_callback(a, file_seek);
214 return (archive_read_open1(a));
218 file_open(struct archive *a, void *client_data)
221 struct read_file_data *mine = (struct read_file_data *)client_data;
223 const char *filename = NULL;
224 const wchar_t *wfilename = NULL;
226 int is_disk_like = 0;
227 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
228 off_t mediasize = 0; /* FreeBSD-specific, so off_t okay here. */
229 #elif defined(__NetBSD__) || defined(__OpenBSD__)
231 #elif defined(__DragonFly__)
235 archive_clear_error(a);
236 if (mine->filename_type == FNT_STDIN) {
237 /* We used to delegate stdin support by
238 * directly calling archive_read_open_fd(a,0,block_size)
239 * here, but that doesn't (and shouldn't) handle the
240 * end-of-file flush when reading stdout from a pipe.
241 * Basically, read_open_fd() is intended for folks who
242 * are willing to handle such details themselves. This
243 * API is intended to be a little smarter for folks who
244 * want easy handling of the common case.
247 #if defined(__CYGWIN__) || defined(_WIN32)
248 setmode(0, O_BINARY);
251 } else if (mine->filename_type == FNT_MBS) {
252 filename = mine->filename.m;
253 fd = open(filename, O_RDONLY | O_BINARY | O_CLOEXEC);
254 __archive_ensure_cloexec_flag(fd);
256 archive_set_error(a, errno,
257 "Failed to open '%s'", filename);
258 return (ARCHIVE_FATAL);
261 #if defined(_WIN32) && !defined(__CYGWIN__)
262 wfilename = mine->filename.w;
263 fd = _wopen(wfilename, O_RDONLY | O_BINARY);
264 if (fd < 0 && errno == ENOENT) {
266 fullpath = __la_win_permissive_name_w(wfilename);
267 if (fullpath != NULL) {
268 fd = _wopen(fullpath, O_RDONLY | O_BINARY);
273 archive_set_error(a, errno,
274 "Failed to open '%S'", wfilename);
275 return (ARCHIVE_FATAL);
278 archive_set_error(a, ARCHIVE_ERRNO_MISC,
279 "Unexpedted operation in archive_read_open_filename");
280 return (ARCHIVE_FATAL);
283 if (fstat(fd, &st) != 0) {
284 if (mine->filename_type == FNT_WCS)
285 archive_set_error(a, errno, "Can't stat '%S'",
288 archive_set_error(a, errno, "Can't stat '%s'",
290 return (ARCHIVE_FATAL);
294 * Determine whether the input looks like a disk device or a
295 * tape device. The results are used below to select an I/O
297 * = "disk-like" devices support arbitrary lseek() and will
298 * support I/O requests of any size. So we get easy skipping
299 * and can cheat on block sizes to get better performance.
300 * = "tape-like" devices require strict blocking and use
301 * specialized ioctls for seeking.
302 * = "socket-like" devices cannot seek at all but can improve
303 * performance by using nonblocking I/O to read "whatever is
304 * available right now".
306 * Right now, we only specially recognize disk-like devices,
307 * but it should be straightforward to add probes and strategy
308 * here for tape-like and socket-like devices.
310 if (S_ISREG(st.st_mode)) {
311 /* Safety: Tell the extractor not to overwrite the input. */
312 archive_read_extract_set_skip_file(a, st.st_dev, st.st_ino);
313 /* Regular files act like disks. */
316 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
317 /* FreeBSD: if it supports DIOCGMEDIASIZE ioctl, it's disk-like. */
318 else if (S_ISCHR(st.st_mode) &&
319 ioctl(fd, DIOCGMEDIASIZE, &mediasize) == 0 &&
323 #elif defined(__NetBSD__) || defined(__OpenBSD__)
324 /* Net/OpenBSD: if it supports DIOCGDINFO ioctl, it's disk-like. */
325 else if ((S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) &&
326 ioctl(fd, DIOCGDINFO, &dl) == 0 &&
327 dl.d_partitions[DISKPART(st.st_rdev)].p_size > 0) {
330 #elif defined(__DragonFly__)
331 /* DragonFly BSD: if it supports DIOCGPART ioctl, it's disk-like. */
332 else if (S_ISCHR(st.st_mode) &&
333 ioctl(fd, DIOCGPART, &pi) == 0 &&
337 #elif defined(__linux__)
338 /* Linux: All block devices are disk-like. */
339 else if (S_ISBLK(st.st_mode) &&
340 lseek(fd, 0, SEEK_CUR) == 0 &&
341 lseek(fd, 0, SEEK_SET) == 0 &&
342 lseek(fd, 0, SEEK_END) > 0 &&
343 lseek(fd, 0, SEEK_SET) == 0) {
347 /* TODO: Add an "is_tape_like" variable and appropriate tests. */
349 /* Disk-like devices prefer power-of-two block sizes. */
350 /* Use provided block_size as a guide so users have some control. */
352 size_t new_block_size = 64 * 1024;
353 while (new_block_size < mine->block_size
354 && new_block_size < 64 * 1024 * 1024)
356 mine->block_size = new_block_size;
358 buffer = malloc(mine->block_size);
359 if (mine == NULL || buffer == NULL) {
360 archive_set_error(a, ENOMEM, "No memory");
363 return (ARCHIVE_FATAL);
365 mine->buffer = buffer;
367 /* Remember mode so close can decide whether to flush. */
368 mine->st_mode = st.st_mode;
370 /* Disk-like inputs can use lseek(). */
378 file_read(struct archive *a, void *client_data, const void **buff)
380 struct read_file_data *mine = (struct read_file_data *)client_data;
383 /* TODO: If a recent lseek() operation has left us
384 * mis-aligned, read and return a short block to try to get
385 * us back in alignment. */
387 /* TODO: Someday, try mmap() here; if that succeeds, give
388 * the entire file to libarchive as a single block. That
389 * could be a lot faster than block-by-block manual I/O. */
391 /* TODO: We might be able to improve performance on pipes and
392 * sockets by setting non-blocking I/O and just accepting
393 * whatever we get here instead of waiting for a full block
396 *buff = mine->buffer;
398 bytes_read = read(mine->fd, mine->buffer, mine->block_size);
399 if (bytes_read < 0) {
402 else if (mine->filename_type == FNT_STDIN)
403 archive_set_error(a, errno,
404 "Error reading stdin");
405 else if (mine->filename_type == FNT_MBS)
406 archive_set_error(a, errno,
407 "Error reading '%s'", mine->filename.m);
409 archive_set_error(a, errno,
410 "Error reading '%S'", mine->filename.w);
417 * Regular files and disk-like block devices can use simple lseek
418 * without needing to round the request to the block size.
420 * TODO: This can leave future reads mis-aligned. Since we know the
421 * offset here, we should store it and use it in file_read() above
422 * to determine whether we should perform a short read to get back
423 * into alignment. Long series of mis-aligned reads can negatively
424 * impact disk throughput. (Of course, the performance impact should
425 * be carefully tested; extra code complexity is only worthwhile if
426 * it does provide measurable improvement.)
428 * TODO: Be lazy about the actual seek. There are a few pathological
429 * cases where libarchive makes a bunch of seek requests in a row
430 * without any intervening reads. This isn't a huge performance
431 * problem, since the kernel handles seeks lazily already, but
432 * it would be very slightly faster if we simply remembered the
433 * seek request here and then actually performed the seek at the
434 * top of the read callback above.
437 file_skip_lseek(struct archive *a, void *client_data, int64_t request)
439 struct read_file_data *mine = (struct read_file_data *)client_data;
440 #if defined(_WIN32) && !defined(__CYGWIN__)
441 /* We use _lseeki64() on Windows. */
442 int64_t old_offset, new_offset;
444 off_t old_offset, new_offset;
447 /* We use off_t here because lseek() is declared that way. */
449 /* TODO: Deal with case where off_t isn't 64 bits.
450 * This shouldn't be a problem on Linux or other POSIX
451 * systems, since the configuration logic for libarchive
452 * tries to obtain a 64-bit off_t.
454 if ((old_offset = lseek(mine->fd, 0, SEEK_CUR)) >= 0 &&
455 (new_offset = lseek(mine->fd, request, SEEK_CUR)) >= 0)
456 return (new_offset - old_offset);
458 /* If lseek() fails, don't bother trying again. */
461 /* Let libarchive recover with read+discard */
465 /* If the input is corrupted or truncated, fail. */
466 if (mine->filename_type == FNT_STDIN)
467 archive_set_error(a, errno, "Error seeking in stdin");
468 else if (mine->filename_type == FNT_MBS)
469 archive_set_error(a, errno, "Error seeking in '%s'",
472 archive_set_error(a, errno, "Error seeking in '%S'",
479 * TODO: Implement another file_skip_XXXX that uses MTIO ioctls to
480 * accelerate operation on tape drives.
484 file_skip(struct archive *a, void *client_data, int64_t request)
486 struct read_file_data *mine = (struct read_file_data *)client_data;
488 /* Delegate skip requests. */
490 return (file_skip_lseek(a, client_data, request));
492 /* If we can't skip, return 0; libarchive will read+discard instead. */
497 * TODO: Store the offset and use it in the read callback.
500 file_seek(struct archive *a, void *client_data, int64_t request, int whence)
502 struct read_file_data *mine = (struct read_file_data *)client_data;
505 /* We use off_t here because lseek() is declared that way. */
506 /* See above for notes about when off_t is less than 64 bits. */
507 r = lseek(mine->fd, request, whence);
511 /* If the input is corrupted or truncated, fail. */
512 if (mine->filename_type == FNT_STDIN)
513 archive_set_error(a, errno, "Error seeking in stdin");
514 else if (mine->filename_type == FNT_MBS)
515 archive_set_error(a, errno, "Error seeking in '%s'",
518 archive_set_error(a, errno, "Error seeking in '%S'",
520 return (ARCHIVE_FATAL);
524 file_close2(struct archive *a, void *client_data)
526 struct read_file_data *mine = (struct read_file_data *)client_data;
528 (void)a; /* UNUSED */
530 /* Only flush and close if open succeeded. */
533 * Sometimes, we should flush the input before closing.
534 * Regular files: faster to just close without flush.
535 * Disk-like devices: Ditto.
536 * Tapes: must not flush (user might need to
537 * read the "next" item on a non-rewind device).
538 * Pipes and sockets: must flush (otherwise, the
539 * program feeding the pipe or socket may complain).
540 * Here, I flush everything except for regular files and
543 if (!S_ISREG(mine->st_mode)
544 && !S_ISCHR(mine->st_mode)
545 && !S_ISBLK(mine->st_mode)) {
548 bytesRead = read(mine->fd, mine->buffer,
550 } while (bytesRead > 0);
552 /* If a named file was opened, then it needs to be closed. */
553 if (mine->filename_type != FNT_STDIN)
563 file_close(struct archive *a, void *client_data)
565 struct read_file_data *mine = (struct read_file_data *)client_data;
566 file_close2(a, client_data);
572 file_switch(struct archive *a, void *client_data1, void *client_data2)
574 file_close2(a, client_data1);
575 return file_open(a, client_data2);