src/liblzma/common/common.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 //
   3 /// \file       common.h
   4 /// \brief      Definitions common to the whole liblzma library
   5 //
   6 //  Copyright (C) 2007-2008 Lasse Collin
   7 //
   8 //  This library is free software; you can redistribute it and/or
   9 //  modify it under the terms of the GNU Lesser General Public
  10 //  License as published by the Free Software Foundation; either
  11 //  version 2.1 of the License, or (at your option) any later version.
  12 //
  13 //  This library is distributed in the hope that it will be useful,
  14 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 //  Lesser General Public License for more details.
  17 //
  18 ///////////////////////////////////////////////////////////////////////////////
  19
  20 #ifndef LZMA_COMMON_H
  21 #define LZMA_COMMON_H
  22
  23 #include "../../common/sysdefs.h"
  24 #include "../../common/mythread.h"
  25 #include "../../common/integer.h"
  26
  27 // Don't use ifdef...
  28 #if HAVE_VISIBILITY
  29 #       define LZMA_VISIBILITY __attribute__((__visibility__("default")))
  30 #else
  31 #       define LZMA_VISIBILITY
  32 #endif
  33
  34 #ifdef _WIN32
  35 #       define LZMA_EXPORT __cdecl __declspec(dllexport)
  36 #else
  37 #       define LZMA_EXPORT
  38 #endif
  39
  40 #define LZMA_API LZMA_VISIBILITY LZMA_EXPORT
  41
  42 #include "lzma.h"
  43
  44 // These allow helping the compiler in some often-executed branches, whose
  45 // result is almost always the same.
  46 #ifdef __GNUC__
  47 #       define likely(expr) __builtin_expect(expr, true)
  48 #       define unlikely(expr) __builtin_expect(expr, false)
  49 #else
  50 #       define likely(expr) (expr)
  51 #       define unlikely(expr) (expr)
  52 #endif
  53
  54
  55 /// Size of temporary buffers needed in some filters
  56 #define LZMA_BUFFER_SIZE 4096
  57
  58
  59 /// Starting value for memory usage estimates. Instead of calculating size
  60 /// of _every_ structure and taking into accont malloc() overhead etc. we
  61 /// add a base size to all memory usage estimates. It's not very accurate
  62 /// but should be easily good enough.
  63 #define LZMA_MEMUSAGE_BASE (UINT64_C(1) << 15)
  64
  65 /// Start of internal Filter ID space. These IDs must never be used
  66 /// in Streams.
  67 #define LZMA_FILTER_RESERVED_START (LZMA_VLI_C(1) << 62)
  68
  69
  70 /// Internal helper filter used by Subblock decoder. It is mapped to an
  71 /// otherwise invalid Filter ID, which is impossible to get from any input
  72 /// file (even if malicious file).
  73 #define LZMA_FILTER_SUBBLOCK_HELPER LZMA_VLI_C(0x7000000000000001)
  74
  75
  76 /// Supported flags that can be passed to lzma_stream_decoder()
  77 /// or lzma_auto_decoder().
  78 #define LZMA_SUPPORTED_FLAGS \
  79         ( LZMA_TELL_NO_CHECK \
  80         | LZMA_TELL_UNSUPPORTED_CHECK \
  81         | LZMA_TELL_ANY_CHECK \
  82         | LZMA_CONCATENATED )
  83
  84
  85 /// Type of encoder/decoder specific data; the actual structure is defined
  86 /// differently in different coders.
  87 typedef struct lzma_coder_s lzma_coder;
  88
  89 typedef struct lzma_next_coder_s lzma_next_coder;
  90
  91 typedef struct lzma_filter_info_s lzma_filter_info;
  92
  93
  94 /// Type of a function used to initialize a filter encoder or decoder
  95 typedef lzma_ret (*lzma_init_function)(
  96                 lzma_next_coder *next, lzma_allocator *allocator,
  97                 const lzma_filter_info *filters);
  98
  99 /// Type of a function to do some kind of coding work (filters, Stream,
 100 /// Block encoders/decoders etc.). Some special coders use don't use both
 101 /// input and output buffers, but for simplicity they still use this same
 102 /// function prototype.
 103 typedef lzma_ret (*lzma_code_function)(
 104                 lzma_coder *coder, lzma_allocator *allocator,
 105                 const uint8_t *restrict in, size_t *restrict in_pos,
 106                 size_t in_size, uint8_t *restrict out,
 107                 size_t *restrict out_pos, size_t out_size,
 108                 lzma_action action);
 109
 110 /// Type of a function to free the memory allocated for the coder
 111 typedef void (*lzma_end_function)(
 112                 lzma_coder *coder, lzma_allocator *allocator);
 113
 114
 115 /// Raw coder validates and converts an array of lzma_filter structures to
 116 /// an array of lzma_filter_info structures. This array is used with
 117 /// lzma_next_filter_init to initialize the filter chain.
 118 struct lzma_filter_info_s {
 119         /// Pointer to function used to initialize the filter.
 120         /// This is NULL to indicate end of array.
 121         lzma_init_function init;
 122
 123         /// Pointer to filter's options structure
 124         void *options;
 125 };
 126
 127
 128 /// Hold data and function pointers of the next filter in the chain.
 129 struct lzma_next_coder_s {
 130         /// Pointer to coder-specific data
 131         lzma_coder *coder;
 132
 133         /// "Pointer" to init function. This is never called here.
 134         /// We need only to detect if we are initializing a coder
 135         /// that was allocated earlier. See lzma_next_coder_init and
 136         /// lzma_next_strm_init macros in this file.
 137         uintptr_t init;
 138
 139         /// Pointer to function to do the actual coding
 140         lzma_code_function code;
 141
 142         /// Pointer to function to free lzma_next_coder.coder. This can
 143         /// be NULL; in that case, lzma_free is called to free
 144         /// lzma_next_coder.coder.
 145         lzma_end_function end;
 146
 147         /// Pointer to function to return the type of the integrity check.
 148         /// Most coders won't support this.
 149         lzma_check (*get_check)(const lzma_coder *coder);
 150
 151         /// Pointer to function to get and/or change the memory usage limit.
 152         /// If new_memlimit == 0, the limit is not changed.
 153         lzma_ret (*memconfig)(lzma_coder *coder, uint64_t *memusage,
 154                         uint64_t *old_memlimit, uint64_t new_memlimit);
 155 };
 156
 157
 158 /// Macro to initialize lzma_next_coder structure
 159 #define LZMA_NEXT_CODER_INIT \
 160         (lzma_next_coder){ \
 161                 .coder = NULL, \
 162                 .init = (uintptr_t)(NULL), \
 163                 .code = NULL, \
 164                 .end = NULL, \
 165                 .get_check = NULL, \
 166                 .memconfig = NULL, \
 167         }
 168
 169
 170 /// Internal data for lzma_strm_init, lzma_code, and lzma_end. A pointer to
 171 /// this is stored in lzma_stream.
 172 struct lzma_internal_s {
 173         /// The actual coder that should do something useful
 174         lzma_next_coder next;
 175
 176         /// Track the state of the coder. This is used to validate arguments
 177         /// so that the actual coders can rely on e.g. that LZMA_SYNC_FLUSH
 178         /// is used on every call to lzma_code until next.code has returned
 179         /// LZMA_STREAM_END.
 180         enum {
 181                 ISEQ_RUN,
 182                 ISEQ_SYNC_FLUSH,
 183                 ISEQ_FULL_FLUSH,
 184                 ISEQ_FINISH,
 185                 ISEQ_END,
 186                 ISEQ_ERROR,
 187         } sequence;
 188
 189         /// A copy of lzma_stream avail_in. This is used to verify that the
 190         /// amount of input doesn't change once e.g. LZMA_FINISH has been
 191         /// used.
 192         size_t avail_in;
 193
 194         /// Indicates which lzma_action values are allowed by next.code.
 195         bool supported_actions[4];
 196
 197         /// If true, lzma_code will return LZMA_BUF_ERROR if no progress was
 198         /// made (no input consumed and no output produced by next.code).
 199         bool allow_buf_error;
 200 };
 201
 202
 203 /// Allocates memory
 204 extern void *lzma_alloc(size_t size, lzma_allocator *allocator)
 205                 lzma_attribute((malloc));
 206
 207 /// Frees memory
 208 extern void lzma_free(void *ptr, lzma_allocator *allocator);
 209
 210
 211 /// Allocates strm->internal if it is NULL, and initializes *strm and
 212 /// strm->internal. This function is only called via lzma_next_strm_init macro.
 213 extern lzma_ret lzma_strm_init(lzma_stream *strm);
 214
 215 /// Initializes the next filter in the chain, if any. This takes care of
 216 /// freeing the memory of previously initialized filter if it is different
 217 /// than the filter being initialized now. This way the actual filter
 218 /// initialization functions don't need to use lzma_next_coder_init macro.
 219 extern lzma_ret lzma_next_filter_init(lzma_next_coder *next,
 220                 lzma_allocator *allocator, const lzma_filter_info *filters);
 221
 222 /// Frees the memory allocated for next->coder either using next->end or,
 223 /// if next->end is NULL, using lzma_free.
 224 extern void lzma_next_end(lzma_next_coder *next, lzma_allocator *allocator);
 225
 226
 227 /// Copy as much data as possible from in[] to out[] and update *in_pos
 228 /// and *out_pos accordingly. Returns the number of bytes copied.
 229 extern size_t lzma_bufcpy(const uint8_t *restrict in, size_t *restrict in_pos,
 230                 size_t in_size, uint8_t *restrict out,
 231                 size_t *restrict out_pos, size_t out_size);
 232
 233
 234 /// \brief      Return if expression doesn't evaluate to LZMA_OK
 235 ///
 236 /// There are several situations where we want to return immediatelly
 237 /// with the value of expr if it isn't LZMA_OK. This macro shortens
 238 /// the code a little.
 239 #define return_if_error(expr) \
 240 do { \
 241         const lzma_ret ret_ = (expr); \
 242         if (ret_ != LZMA_OK) \
 243                 return ret_; \
 244 } while (0)
 245
 246
 247 /// If next isn't already initialized, free the previous coder. Then mark
 248 /// that next is _possibly_ initialized for the coder using this macro.
 249 /// "Possibly" means that if e.g. allocation of next->coder fails, the
 250 /// structure isn't actually initialized for this coder, but leaving
 251 /// next->init to func is still OK.
 252 #define lzma_next_coder_init(func, next, allocator) \
 253 do { \
 254         if ((uintptr_t)(&func) != (next)->init) \
 255                 lzma_next_end(next, allocator); \
 256         (next)->init = (uintptr_t)(&func); \
 257 } while (0)
 258
 259
 260 /// Initializes lzma_strm and calls func() to initialize strm->internal->next.
 261 /// (The function being called will use lzma_next_coder_init()). If
 262 /// initialization fails, memory that wasn't freed by func() is freed
 263 /// along strm->internal.
 264 #define lzma_next_strm_init(func, strm, ...) \
 265 do { \
 266         return_if_error(lzma_strm_init(strm)); \
 267         const lzma_ret ret_ = func(&(strm)->internal->next, \
 268                         (strm)->allocator, __VA_ARGS__); \
 269         if (ret_ != LZMA_OK) { \
 270                 lzma_end(strm); \
 271                 return ret_; \
 272         } \
 273 } while (0)
 274
 275 #endif