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