1 ///////////////////////////////////////////////////////////////////////////////
4 /// \brief Definitions common to the whole liblzma library
6 // Author: Lasse Collin
8 // This file has been put into the public domain.
9 // You can do whatever you want with this file.
11 ///////////////////////////////////////////////////////////////////////////////
18 #include "tuklib_integer.h"
20 #if defined(_WIN32) || defined(__CYGWIN__)
22 # define LZMA_API_EXPORT __declspec(dllexport)
24 # define LZMA_API_EXPORT
26 // Don't use ifdef or defined() below.
28 # define LZMA_API_EXPORT __attribute__((__visibility__("default")))
30 # define LZMA_API_EXPORT
33 #define LZMA_API(type) LZMA_API_EXPORT type LZMA_API_CALL
37 // These allow helping the compiler in some often-executed branches, whose
38 // result is almost always the same.
40 # define likely(expr) __builtin_expect(expr, true)
41 # define unlikely(expr) __builtin_expect(expr, false)
43 # define likely(expr) (expr)
44 # define unlikely(expr) (expr)
48 /// Size of temporary buffers needed in some filters
49 #define LZMA_BUFFER_SIZE 4096
52 /// Starting value for memory usage estimates. Instead of calculating size
53 /// of _every_ structure and taking into account malloc() overhead etc., we
54 /// add a base size to all memory usage estimates. It's not very accurate
55 /// but should be easily good enough.
56 #define LZMA_MEMUSAGE_BASE (UINT64_C(1) << 15)
58 /// Start of internal Filter ID space. These IDs must never be used
60 #define LZMA_FILTER_RESERVED_START (LZMA_VLI_C(1) << 62)
63 /// Internal helper filter used by Subblock decoder. It is mapped to an
64 /// otherwise invalid Filter ID, which is impossible to get from any input
65 /// file (even if malicious file).
66 #define LZMA_FILTER_SUBBLOCK_HELPER LZMA_VLI_C(0x7000000000000001)
69 /// Supported flags that can be passed to lzma_stream_decoder()
70 /// or lzma_auto_decoder().
71 #define LZMA_SUPPORTED_FLAGS \
72 ( LZMA_TELL_NO_CHECK \
73 | LZMA_TELL_UNSUPPORTED_CHECK \
74 | LZMA_TELL_ANY_CHECK \
78 /// Type of encoder/decoder specific data; the actual structure is defined
79 /// differently in different coders.
80 typedef struct lzma_coder_s lzma_coder;
82 typedef struct lzma_next_coder_s lzma_next_coder;
84 typedef struct lzma_filter_info_s lzma_filter_info;
87 /// Type of a function used to initialize a filter encoder or decoder
88 typedef lzma_ret (*lzma_init_function)(
89 lzma_next_coder *next, lzma_allocator *allocator,
90 const lzma_filter_info *filters);
92 /// Type of a function to do some kind of coding work (filters, Stream,
93 /// Block encoders/decoders etc.). Some special coders use don't use both
94 /// input and output buffers, but for simplicity they still use this same
95 /// function prototype.
96 typedef lzma_ret (*lzma_code_function)(
97 lzma_coder *coder, lzma_allocator *allocator,
98 const uint8_t *restrict in, size_t *restrict in_pos,
99 size_t in_size, uint8_t *restrict out,
100 size_t *restrict out_pos, size_t out_size,
103 /// Type of a function to free the memory allocated for the coder
104 typedef void (*lzma_end_function)(
105 lzma_coder *coder, lzma_allocator *allocator);
108 /// Raw coder validates and converts an array of lzma_filter structures to
109 /// an array of lzma_filter_info structures. This array is used with
110 /// lzma_next_filter_init to initialize the filter chain.
111 struct lzma_filter_info_s {
112 /// Filter ID. This is used only by the encoder
113 /// with lzma_filters_update().
116 /// Pointer to function used to initialize the filter.
117 /// This is NULL to indicate end of array.
118 lzma_init_function init;
120 /// Pointer to filter's options structure
125 /// Hold data and function pointers of the next filter in the chain.
126 struct lzma_next_coder_s {
127 /// Pointer to coder-specific data
130 /// Filter ID. This is LZMA_VLI_UNKNOWN when this structure doesn't
131 /// point to a filter coder.
134 /// "Pointer" to init function. This is never called here.
135 /// We need only to detect if we are initializing a coder
136 /// that was allocated earlier. See lzma_next_coder_init and
137 /// lzma_next_strm_init macros in this file.
140 /// Pointer to function to do the actual coding
141 lzma_code_function code;
143 /// Pointer to function to free lzma_next_coder.coder. This can
144 /// be NULL; in that case, lzma_free is called to free
145 /// lzma_next_coder.coder.
146 lzma_end_function end;
148 /// Pointer to function to return the type of the integrity check.
149 /// Most coders won't support this.
150 lzma_check (*get_check)(const lzma_coder *coder);
152 /// Pointer to function to get and/or change the memory usage limit.
153 /// If new_memlimit == 0, the limit is not changed.
154 lzma_ret (*memconfig)(lzma_coder *coder, uint64_t *memusage,
155 uint64_t *old_memlimit, uint64_t new_memlimit);
157 /// Update the filter-specific options or the whole filter chain
159 lzma_ret (*update)(lzma_coder *coder, lzma_allocator *allocator,
160 const lzma_filter *filters,
161 const lzma_filter *reversed_filters);
165 /// Macro to initialize lzma_next_coder structure
166 #define LZMA_NEXT_CODER_INIT \
169 .init = (uintptr_t)(NULL), \
170 .id = LZMA_VLI_UNKNOWN, \
179 /// Internal data for lzma_strm_init, lzma_code, and lzma_end. A pointer to
180 /// this is stored in lzma_stream.
181 struct lzma_internal_s {
182 /// The actual coder that should do something useful
183 lzma_next_coder next;
185 /// Track the state of the coder. This is used to validate arguments
186 /// so that the actual coders can rely on e.g. that LZMA_SYNC_FLUSH
187 /// is used on every call to lzma_code until next.code has returned
198 /// A copy of lzma_stream avail_in. This is used to verify that the
199 /// amount of input doesn't change once e.g. LZMA_FINISH has been
203 /// Indicates which lzma_action values are allowed by next.code.
204 bool supported_actions[4];
206 /// If true, lzma_code will return LZMA_BUF_ERROR if no progress was
207 /// made (no input consumed and no output produced by next.code).
208 bool allow_buf_error;
213 extern void *lzma_alloc(size_t size, lzma_allocator *allocator)
214 lzma_attribute((malloc));
217 extern void lzma_free(void *ptr, lzma_allocator *allocator);
220 /// Allocates strm->internal if it is NULL, and initializes *strm and
221 /// strm->internal. This function is only called via lzma_next_strm_init macro.
222 extern lzma_ret lzma_strm_init(lzma_stream *strm);
224 /// Initializes the next filter in the chain, if any. This takes care of
225 /// freeing the memory of previously initialized filter if it is different
226 /// than the filter being initialized now. This way the actual filter
227 /// initialization functions don't need to use lzma_next_coder_init macro.
228 extern lzma_ret lzma_next_filter_init(lzma_next_coder *next,
229 lzma_allocator *allocator, const lzma_filter_info *filters);
231 /// Update the next filter in the chain, if any. This checks that
232 /// the application is not trying to change the Filter IDs.
233 extern lzma_ret lzma_next_filter_update(
234 lzma_next_coder *next, lzma_allocator *allocator,
235 const lzma_filter *reversed_filters);
237 /// Frees the memory allocated for next->coder either using next->end or,
238 /// if next->end is NULL, using lzma_free.
239 extern void lzma_next_end(lzma_next_coder *next, lzma_allocator *allocator);
242 /// Copy as much data as possible from in[] to out[] and update *in_pos
243 /// and *out_pos accordingly. Returns the number of bytes copied.
244 extern size_t lzma_bufcpy(const uint8_t *restrict in, size_t *restrict in_pos,
245 size_t in_size, uint8_t *restrict out,
246 size_t *restrict out_pos, size_t out_size);
249 /// \brief Return if expression doesn't evaluate to LZMA_OK
251 /// There are several situations where we want to return immediately
252 /// with the value of expr if it isn't LZMA_OK. This macro shortens
253 /// the code a little.
254 #define return_if_error(expr) \
256 const lzma_ret ret_ = (expr); \
257 if (ret_ != LZMA_OK) \
262 /// If next isn't already initialized, free the previous coder. Then mark
263 /// that next is _possibly_ initialized for the coder using this macro.
264 /// "Possibly" means that if e.g. allocation of next->coder fails, the
265 /// structure isn't actually initialized for this coder, but leaving
266 /// next->init to func is still OK.
267 #define lzma_next_coder_init(func, next, allocator) \
269 if ((uintptr_t)(func) != (next)->init) \
270 lzma_next_end(next, allocator); \
271 (next)->init = (uintptr_t)(func); \
275 /// Initializes lzma_strm and calls func() to initialize strm->internal->next.
276 /// (The function being called will use lzma_next_coder_init()). If
277 /// initialization fails, memory that wasn't freed by func() is freed
278 /// along strm->internal.
279 #define lzma_next_strm_init(func, strm, ...) \
281 return_if_error(lzma_strm_init(strm)); \
282 const lzma_ret ret_ = func(&(strm)->internal->next, \
283 (strm)->allocator, __VA_ARGS__); \
284 if (ret_ != LZMA_OK) { \