1228753Smm/*- 2228753Smm * Copyright (c) 2003-2007 Tim Kientzle 3228753Smm * All rights reserved. 4228753Smm * 5228753Smm * Redistribution and use in source and binary forms, with or without 6228753Smm * modification, are permitted provided that the following conditions 7228753Smm * are met: 8228753Smm * 1. Redistributions of source code must retain the above copyright 9228753Smm * notice, this list of conditions and the following disclaimer. 10228753Smm * 2. Redistributions in binary form must reproduce the above copyright 11228753Smm * notice, this list of conditions and the following disclaimer in the 12228753Smm * documentation and/or other materials provided with the distribution. 13228753Smm * 14228753Smm * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR 15228753Smm * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 16228753Smm * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 17228753Smm * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT, 18228753Smm * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 19228753Smm * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 20228753Smm * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 21228753Smm * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22228753Smm * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 23228753Smm * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24228753Smm * 25229592Smm * $FreeBSD$ 26228753Smm */ 27228753Smm 28228753Smm#ifndef __LIBARCHIVE_BUILD 29228753Smm#error This header is only to be used internally to libarchive. 30228753Smm#endif 31228753Smm 32228753Smm#ifndef ARCHIVE_PRIVATE_H_INCLUDED 33228753Smm#define ARCHIVE_PRIVATE_H_INCLUDED 34228753Smm 35228753Smm#include "archive.h" 36228753Smm#include "archive_string.h" 37228753Smm 38228753Smm#if defined(__GNUC__) && (__GNUC__ > 2 || \ 39228753Smm (__GNUC__ == 2 && __GNUC_MINOR__ >= 5)) 40228753Smm#define __LA_DEAD __attribute__((__noreturn__)) 41228753Smm#else 42228753Smm#define __LA_DEAD 43228753Smm#endif 44228753Smm 45228753Smm#define ARCHIVE_WRITE_MAGIC (0xb0c5c0deU) 46228753Smm#define ARCHIVE_READ_MAGIC (0xdeb0c5U) 47228753Smm#define ARCHIVE_WRITE_DISK_MAGIC (0xc001b0c5U) 48228753Smm#define ARCHIVE_READ_DISK_MAGIC (0xbadb0c5U) 49228753Smm 50228753Smm#define ARCHIVE_STATE_ANY 0xFFFFU 51228753Smm#define ARCHIVE_STATE_NEW 1U 52228753Smm#define ARCHIVE_STATE_HEADER 2U 53228753Smm#define ARCHIVE_STATE_DATA 4U 54228753Smm#define ARCHIVE_STATE_DATA_END 8U 55228753Smm#define ARCHIVE_STATE_EOF 0x10U 56228753Smm#define ARCHIVE_STATE_CLOSED 0x20U 57228753Smm#define ARCHIVE_STATE_FATAL 0x8000U 58228753Smm 59228753Smmstruct archive_vtable { 60228753Smm int (*archive_close)(struct archive *); 61229592Smm int (*archive_free)(struct archive *); 62228753Smm int (*archive_write_header)(struct archive *, 63228753Smm struct archive_entry *); 64228753Smm int (*archive_write_finish_entry)(struct archive *); 65228753Smm ssize_t (*archive_write_data)(struct archive *, 66228753Smm const void *, size_t); 67228753Smm ssize_t (*archive_write_data_block)(struct archive *, 68228753Smm const void *, size_t, off_t); 69228753Smm}; 70228753Smm 71228753Smmstruct archive { 72228753Smm /* 73228753Smm * The magic/state values are used to sanity-check the 74228753Smm * client's usage. If an API function is called at a 75228753Smm * ridiculous time, or the client passes us an invalid 76228753Smm * pointer, these values allow me to catch that. 77228753Smm */ 78228753Smm unsigned int magic; 79228753Smm unsigned int state; 80228753Smm 81228753Smm /* 82228753Smm * Some public API functions depend on the "real" type of the 83228753Smm * archive object. 84228753Smm */ 85228753Smm struct archive_vtable *vtable; 86228753Smm 87228753Smm int archive_format; 88228753Smm const char *archive_format_name; 89228753Smm 90228753Smm int compression_code; /* Currently active compression. */ 91228753Smm const char *compression_name; 92228753Smm 93228753Smm /* Position in UNCOMPRESSED data stream. */ 94228753Smm int64_t file_position; 95228753Smm /* Position in COMPRESSED data stream. */ 96228753Smm int64_t raw_position; 97228753Smm /* Number of file entries processed. */ 98228753Smm int file_count; 99228753Smm 100228753Smm int archive_error_number; 101228753Smm const char *error; 102228753Smm struct archive_string error_string; 103228753Smm}; 104228753Smm 105228753Smm/* Check magic value and state; exit if it isn't valid. */ 106228753Smmvoid __archive_check_magic(struct archive *, unsigned int magic, 107228753Smm unsigned int state, const char *func); 108228753Smm 109228753Smmvoid __archive_errx(int retvalue, const char *msg) __LA_DEAD; 110228753Smm 111228753Smmint __archive_parse_options(const char *p, const char *fn, 112228753Smm int keysize, char *key, int valsize, char *val); 113228753Smm 114228753Smm#define err_combine(a,b) ((a) < (b) ? (a) : (b)) 115228753Smm 116228753Smm#if defined(__BORLANDC__) || (defined(_MSC_VER) && _MSC_VER <= 1300) 117228753Smm# define ARCHIVE_LITERAL_LL(x) x##i64 118228753Smm# define ARCHIVE_LITERAL_ULL(x) x##ui64 119228753Smm#else 120228753Smm# define ARCHIVE_LITERAL_LL(x) x##ll 121228753Smm# define ARCHIVE_LITERAL_ULL(x) x##ull 122228753Smm#endif 123228753Smm 124228753Smm#endif 125