1 /*- 2 * Copyright (c) 2003-2007 Tim Kientzle 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(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. 24 * 25 * $FreeBSD: head/lib/libarchive/archive_private.h 201098 2009-12-28 02:58:14Z kientzle $ 26 */ 27 28 #ifndef ARCHIVE_PRIVATE_H_INCLUDED 29 #define ARCHIVE_PRIVATE_H_INCLUDED 30 31 #ifndef __LIBARCHIVE_BUILD 32 #error This header is only to be used internally to libarchive. 33 #endif 34 35 #if HAVE_ICONV_H 36 #include <iconv.h> 37 #endif 38 39 #include "archive.h" 40 #include "archive_string.h" 41 42 #if defined(__GNUC__) && (__GNUC__ > 2 || \ 43 (__GNUC__ == 2 && __GNUC_MINOR__ >= 5)) 44 #define __LA_DEAD __attribute__((__noreturn__)) 45 #else 46 #define __LA_DEAD 47 #endif 48 49 #if defined(__GNUC__) && (__GNUC__ > 2 || \ 50 (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)) 51 #define __LA_UNUSED __attribute__((__unused__)) 52 #else 53 #define __LA_UNUSED 54 #endif 55 56 #define ARCHIVE_WRITE_MAGIC (0xb0c5c0deU) 57 #define ARCHIVE_READ_MAGIC (0xdeb0c5U) 58 #define ARCHIVE_WRITE_DISK_MAGIC (0xc001b0c5U) 59 #define ARCHIVE_READ_DISK_MAGIC (0xbadb0c5U) 60 #define ARCHIVE_MATCH_MAGIC (0xcad11c9U) 61 62 #define ARCHIVE_STATE_NEW 1U 63 #define ARCHIVE_STATE_HEADER 2U 64 #define ARCHIVE_STATE_DATA 4U 65 #define ARCHIVE_STATE_EOF 0x10U 66 #define ARCHIVE_STATE_CLOSED 0x20U 67 #define ARCHIVE_STATE_FATAL 0x8000U 68 #define ARCHIVE_STATE_ANY (0xFFFFU & ~ARCHIVE_STATE_FATAL) 69 70 struct archive_vtable { 71 int (*archive_close)(struct archive *); 72 int (*archive_free)(struct archive *); 73 int (*archive_write_header)(struct archive *, 74 struct archive_entry *); 75 int (*archive_write_finish_entry)(struct archive *); 76 ssize_t (*archive_write_data)(struct archive *, 77 const void *, size_t); 78 ssize_t (*archive_write_data_block)(struct archive *, 79 const void *, size_t, int64_t); 80 81 int (*archive_read_next_header)(struct archive *, 82 struct archive_entry **); 83 int (*archive_read_next_header2)(struct archive *, 84 struct archive_entry *); 85 int (*archive_read_data_block)(struct archive *, 86 const void **, size_t *, int64_t *); 87 88 int (*archive_filter_count)(struct archive *); 89 int64_t (*archive_filter_bytes)(struct archive *, int); 90 int (*archive_filter_code)(struct archive *, int); 91 const char * (*archive_filter_name)(struct archive *, int); 92 }; 93 94 struct archive_string_conv; 95 96 struct archive { 97 /* 98 * The magic/state values are used to sanity-check the 99 * client's usage. If an API function is called at a 100 * ridiculous time, or the client passes us an invalid 101 * pointer, these values allow me to catch that. 102 */ 103 unsigned int magic; 104 unsigned int state; 105 106 /* 107 * Some public API functions depend on the "real" type of the 108 * archive object. 109 */ 110 const struct archive_vtable *vtable; 111 112 int archive_format; 113 const char *archive_format_name; 114 115 /* Number of file entries processed. */ 116 int file_count; 117 118 int archive_error_number; 119 const char *error; 120 struct archive_string error_string; 121 122 char *current_code; 123 unsigned current_codepage; /* Current ACP(ANSI CodePage). */ 124 unsigned current_oemcp; /* Current OEMCP(OEM CodePage). */ 125 struct archive_string_conv *sconv; 126 127 /* 128 * Used by archive_read_data() to track blocks and copy 129 * data to client buffers, filling gaps with zero bytes. 130 */ 131 const char *read_data_block; 132 int64_t read_data_offset; 133 int64_t read_data_output_offset; 134 size_t read_data_remaining; 135 136 /* 137 * Used by formats/filters to determine the amount of data 138 * requested from a call to archive_read_data(). This is only 139 * useful when the format/filter has seek support. 140 */ 141 char read_data_is_posix_read; 142 size_t read_data_requested; 143 }; 144 145 /* Check magic value and state; return(ARCHIVE_FATAL) if it isn't valid. */ 146 int __archive_check_magic(struct archive *, unsigned int magic, 147 unsigned int state, const char *func); 148 #define archive_check_magic(a, expected_magic, allowed_states, function_name) \ 149 do { \ 150 int magic_test = __archive_check_magic((a), (expected_magic), \ 151 (allowed_states), (function_name)); \ 152 if (magic_test == ARCHIVE_FATAL) \ 153 return ARCHIVE_FATAL; \ 154 } while (0) 155 156 void __archive_errx(int retvalue, const char *msg) __LA_DEAD; 157 158 void __archive_ensure_cloexec_flag(int fd); 159 int __archive_mktemp(const char *tmpdir); 160 #if defined(_WIN32) && !defined(__CYGWIN__) 161 int __archive_mkstemp(wchar_t *template); 162 #else 163 int __archive_mkstemp(char *template); 164 #endif 165 166 int __archive_clean(struct archive *); 167 168 void __archive_reset_read_data(struct archive *); 169 170 #define err_combine(a,b) ((a) < (b) ? (a) : (b)) 171 172 #if defined(__BORLANDC__) || (defined(_MSC_VER) && _MSC_VER <= 1300) 173 # define ARCHIVE_LITERAL_LL(x) x##i64 174 # define ARCHIVE_LITERAL_ULL(x) x##ui64 175 #else 176 # define ARCHIVE_LITERAL_LL(x) x##ll 177 # define ARCHIVE_LITERAL_ULL(x) x##ull 178 #endif 179 180 #endif 181