contrib/libarchive/libarchive/archive_private.h

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