common.h File Reference

Definitions common to the whole liblzma library. More...

#include "sysdefs.h"
#include "mythread.h"
#include "tuklib_integer.h"
#include "lzma.h"

Go to the source code of this file.

Classes
struct	lzma_filter_info_s
struct	lzma_next_coder_s
	Hold data and function pointers of the next filter in the chain. More...
struct	lzma_internal_s

Macros
#define	LZMA_API_EXPORT
#define	LZMA_API(type)   LZMA_API_EXPORT type LZMA_API_CALL
#define	likely(expr)   (expr)
#define	unlikely(expr)   (expr)
#define	LZMA_BUFFER_SIZE   4096
	Size of temporary buffers needed in some filters. More...
#define	LZMA_THREADS_MAX   16384
#define	LZMA_MEMUSAGE_BASE   (UINT64_C(1) << 15)
#define	LZMA_FILTER_RESERVED_START   (LZMA_VLI_C(1) << 62)
#define	LZMA_SUPPORTED_FLAGS
#define	LZMA_ACTION_MAX   ((unsigned int)(LZMA_FULL_BARRIER))
	Largest valid lzma_action value as unsigned integer. More...
#define	LZMA_TIMED_OUT   32
#define	LZMA_NEXT_CODER_INIT
	Macro to initialize lzma_next_coder structure. More...
#define	return_if_error(expr)
	Return if expression doesn't evaluate to LZMA_OK. More...
#define	lzma_next_coder_init(func, next, allocator)
#define	lzma_next_strm_init(func, strm, ...)

Typedefs
typedef struct lzma_next_coder_s	lzma_next_coder
typedef struct lzma_filter_info_s	lzma_filter_info
typedef lzma_ret(*	lzma_init_function) (lzma_next_coder *next, const lzma_allocator *allocator, const lzma_filter_info *filters)
	Type of a function used to initialize a filter encoder or decoder. More...
typedef lzma_ret(*	lzma_code_function) (void *coder, const lzma_allocator *allocator, const uint8_t *restrict in, size_t *restrict in_pos, size_t in_size, uint8_t *restrict out, size_t *restrict out_pos, size_t out_size, lzma_action action)
typedef void(*	lzma_end_function) (void *coder, const lzma_allocator *allocator)
	Type of a function to free the memory allocated for the coder. More...

Functions
void *	lzma_alloc (size_t size, const lzma_allocator *allocator) lzma_attribute((__malloc__)) lzma_attr_alloc_size(1)
	Allocates memory. More...
void *	lzma_attribute ((__malloc__)) lzma_attr_alloc_size(1) lzma_alloc_zero(size_t size
void	lzma_free (void *ptr, const lzma_allocator *allocator)
	Frees memory. More...
lzma_ret	lzma_strm_init (lzma_stream *strm)
lzma_ret	lzma_next_filter_init (lzma_next_coder *next, const lzma_allocator *allocator, const lzma_filter_info *filters)
lzma_ret	lzma_next_filter_update (lzma_next_coder *next, const lzma_allocator *allocator, const lzma_filter *reversed_filters)
void	lzma_next_end (lzma_next_coder *next, const lzma_allocator *allocator)
size_t	lzma_bufcpy (const uint8_t *restrict in, size_t *restrict in_pos, size_t in_size, uint8_t *restrict out, size_t *restrict out_pos, size_t out_size)

Variables
void const lzma_allocator *	allocator

Detailed Description

Definitions common to the whole liblzma library.

Definition in file common.h.

Macro Definition Documentation

likely

#define likely

(

expr

)

(expr)

Definition at line 43 of file common.h.

LZMA_ACTION_MAX

#define LZMA_ACTION_MAX   ((unsigned int)(LZMA_FULL_BARRIER))

Largest valid lzma_action value as unsigned integer.

Definition at line 81 of file common.h.

LZMA_API

#define LZMA_API

(

type

)

LZMA_API_EXPORT type LZMA_API_CALL

Definition at line 33 of file common.h.

LZMA_API_EXPORT

#define LZMA_API_EXPORT

Definition at line 30 of file common.h.

LZMA_BUFFER_SIZE

#define LZMA_BUFFER_SIZE   4096

Size of temporary buffers needed in some filters.

Definition at line 49 of file common.h.

LZMA_FILTER_RESERVED_START

#define LZMA_FILTER_RESERVED_START   (LZMA_VLI_C(1) << 62)

Start of internal Filter ID space. These IDs must never be used in Streams.

Definition at line 67 of file common.h.

LZMA_MEMUSAGE_BASE

#define LZMA_MEMUSAGE_BASE   (UINT64_C(1) << 15)

Starting value for memory usage estimates. Instead of calculating size of every structure and taking into account malloc() overhead etc., we add a base size to all memory usage estimates. It's not very accurate but should be easily good enough.

Definition at line 63 of file common.h.

LZMA_NEXT_CODER_INIT

#define LZMA_NEXT_CODER_INIT

Value:

    (lzma_next_coder){ \
        .coder = NULL, \
        .init = (uintptr_t)(NULL), \
        .id = LZMA_VLI_UNKNOWN, \
        .code = NULL, \
        .end = NULL, \
        .get_progress = NULL, \
        .get_check = NULL, \
        .memconfig = NULL, \
        .update = NULL, \
    }

Macro to initialize lzma_next_coder structure.

Definition at line 180 of file common.h.

lzma_next_coder_init

#define lzma_next_coder_init	(		func,
			next,
			allocator
	)

Value:

do { \
    if ((uintptr_t)(func) != (next)->init) \
        lzma_next_end(next, allocator); \
    (next)->init = (uintptr_t)(func); \
} while (0)

If next isn't already initialized, free the previous coder. Then mark that next is possibly initialized for the coder using this macro. "Possibly" means that if e.g. allocation of next->coder fails, the structure isn't actually initialized for this coder, but leaving next->init to func is still OK.

Definition at line 291 of file common.h.

lzma_next_strm_init

#define lzma_next_strm_init	(		func,
			strm,
			...
	)

Value:

do { \
    return_if_error(lzma_strm_init(strm)); \
    const lzma_ret ret_ = func(&(strm)->internal->next, \
            (strm)->allocator, __VA_ARGS__); \
    if (ret_ != LZMA_OK) { \
        lzma_end(strm); \
        return ret_; \
    } \
} while (0)

Initializes lzma_strm and calls func() to initialize strm->internal->next. (The function being called will use lzma_next_coder_init()). If initialization fails, memory that wasn't freed by func() is freed along strm->internal.

Definition at line 303 of file common.h.

LZMA_SUPPORTED_FLAGS

#define LZMA_SUPPORTED_FLAGS

Value:

    ( LZMA_TELL_NO_CHECK \
    | LZMA_TELL_UNSUPPORTED_CHECK \
    | LZMA_TELL_ANY_CHECK \
    | LZMA_IGNORE_CHECK \
    | LZMA_CONCATENATED )

Supported flags that can be passed to lzma_stream_decoder() or lzma_auto_decoder().

Definition at line 72 of file common.h.

LZMA_THREADS_MAX

#define LZMA_THREADS_MAX   16384

Maximum number of worker threads within one multithreaded component. The limit exists solely to make it simpler to prevent integer overflows when allocating structures etc. This should be big enough for now... the code won't scale anywhere close to this number anyway.

Definition at line 56 of file common.h.

LZMA_TIMED_OUT

#define LZMA_TIMED_OUT   32

Special return value (lzma_ret) to indicate that a timeout was reached and lzma_code() must not return LZMA_BUF_ERROR. This is converted to LZMA_OK in lzma_code(). This is not in the lzma_ret enumeration because there's no need to have it in the public API.

Definition at line 88 of file common.h.

return_if_error

#define return_if_error

(

expr

)

Value:

do { \
    const lzma_ret ret_ = (expr); \
    if (ret_ != LZMA_OK) \
        return ret_; \
} while (0)

Return if expression doesn't evaluate to LZMA_OK.

There are several situations where we want to return immediately with the value of expr if it isn't LZMA_OK. This macro shortens the code a little.

Definition at line 278 of file common.h.

unlikely

#define unlikely

(

expr

)

(expr)

Definition at line 44 of file common.h.

Typedef Documentation

lzma_code_function

typedef lzma_ret(* lzma_code_function) (void *coder, const lzma_allocator *allocator, const uint8_t *restrict in, size_t *restrict in_pos, size_t in_size, uint8_t *restrict out, size_t *restrict out_pos, size_t out_size, lzma_action action)

Type of a function to do some kind of coding work (filters, Stream, Block encoders/decoders etc.). Some special coders use don't use both input and output buffers, but for simplicity they still use this same function prototype.

Definition at line 105 of file common.h.

lzma_end_function

typedef void(* lzma_end_function) (void *coder, const lzma_allocator *allocator)

Type of a function to free the memory allocated for the coder.

Definition at line 113 of file common.h.

lzma_filter_info

typedef struct lzma_filter_info_s lzma_filter_info

Definition at line 1 of file common.h.

lzma_init_function

typedef lzma_ret(* lzma_init_function) (lzma_next_coder *next, const lzma_allocator *allocator, const lzma_filter_info *filters)

Type of a function used to initialize a filter encoder or decoder.

Definition at line 97 of file common.h.

lzma_next_coder

typedef struct lzma_next_coder_s lzma_next_coder

Definition at line 1 of file common.h.

Function Documentation

lzma_alloc()

void* lzma_alloc	(	size_t	size,
		const lzma_allocator *	allocator
	)

Allocates memory.

Referenced by alone_encoder_init(), auto_decoder_init(), index_decoder_init(), index_dup_stream(), index_init_plain(), index_stream_init(), initialize_new_thread(), lz_encoder_init(), lzma2_decoder_init(), lzma2_encoder_init(), lzma_alone_decoder_init(), LZMA_API(), lzma_block_decoder_init(), lzma_block_encoder_init(), lzma_delta_coder_init(), lzma_delta_props_decode(), lzma_index_encoder_init(), lzma_lz_decoder_init(), lzma_lz_encoder_init(), lzma_lzma_decoder_create(), lzma_lzma_encoder_create(), lzma_lzma_props_decode(), lzma_outq_init(), lzma_simple_coder_init(), lzma_simple_props_decode(), lzma_stream_decoder_init(), lzma_strm_init(), stream_encoder_init(), and stream_encoder_mt_init().

lzma_attribute()

void* lzma_attribute

(

(__malloc__)

)

Allocates memory and zeroes it (like calloc()). This can be faster than lzma_alloc() + memzero() while being backward compatible with custom allocators.

lzma_bufcpy()

size_t lzma_bufcpy	(	const uint8_t *restrict	in,
		size_t *restrict	in_pos,
		size_t	in_size,
		uint8_t *restrict	out,
		size_t *restrict	out_pos,
		size_t	out_size
	)

Copy as much data as possible from in[] to out[] and update *in_pos and *out_pos accordingly. Returns the number of bytes copied.

Definition at line 94 of file common.c.

{
    const size_t in_avail = in_size - *in_pos;
    const size_t out_avail = out_size - *out_pos;
    const size_t copy_size = my_min(in_avail, out_avail);
 
    // Call memcpy() only if there is something to copy. If there is
    // nothing to copy, in or out might be NULL and then the memcpy()
    // call would trigger undefined behavior.
    if (copy_size > 0)
        memcpy(out + *out_pos, in + *in_pos, copy_size);
 
    *in_pos += copy_size;
    *out_pos += copy_size;
 
    return copy_size;
}

References in, in_pos, in_size, memcpy(), my_min, out, and out_pos.

Referenced by alone_encode(), block_decode(), block_encode(), copy_or_code(), dict_write(), fill_window(), lzma2_encode(), lzma_outq_read(), simple_code(), stream_decode(), stream_encode(), stream_encode_in(), and stream_encode_mt().

lzma_free()

void lzma_free	(	void *	ptr,
		const lzma_allocator *	allocator
	)

Frees memory.

Definition at line 78 of file common.c.

{
    if (allocator != NULL && allocator->free != NULL)
        allocator->free(allocator->opaque, ptr);
    else
        free(ptr);
 
    return;
}

References allocator, free(), NULL, and lzma_allocator::opaque.

Referenced by alone_decoder_end(), alone_encoder_end(), auto_decoder_end(), block_decoder_end(), block_encoder_end(), delta_coder_end(), free_properties(), index_decoder_end(), index_encoder_end(), index_stream_end(), initialize_new_thread(), lz_decoder_end(), lz_encoder_end(), lz_encoder_init(), lz_encoder_prepare(), lzma2_decoder_end(), lzma2_encoder_end(), LZMA_API(), lzma_lz_decoder_init(), lzma_lzma_props_decode(), lzma_next_end(), lzma_outq_end(), lzma_simple_props_decode(), simple_coder_end(), stream_decode(), stream_decoder_end(), stream_encoder_end(), stream_encoder_mt_end(), stream_encoder_mt_init(), stream_encoder_update(), threads_end(), and worker_start().

lzma_next_end()

void lzma_next_end	(	lzma_next_coder *	next,
		const lzma_allocator *	allocator
	)

Frees the memory allocated for next->coder either using next->end or, if next->end is NULL, using lzma_free.

Definition at line 145 of file common.c.

{
    if (next->init != (uintptr_t)(NULL)) {
        // To avoid tiny end functions that simply call
        // lzma_free(coder, allocator), we allow leaving next->end
        // NULL and call lzma_free() here.
        if (next->end != NULL)
            next->end(next->coder, allocator);
        else
            lzma_free(next->coder, allocator);
 
        // Reset the variables so the we don't accidentally think
        // that it is an already initialized coder.
        *next = LZMA_NEXT_CODER_INIT;
    }
 
    return;
}

References allocator, lzma_next_coder_s::coder, lzma_next_coder_s::end, lzma_next_coder_s::init, lzma_free(), LZMA_NEXT_CODER_INIT, and NULL.

Referenced by alone_decoder_end(), alone_encoder_end(), auto_decoder_end(), block_decoder_end(), block_encode_normal(), block_encoder_end(), delta_coder_end(), lz_decoder_end(), lz_encoder_end(), LZMA_API(), lzma_raw_coder_init(), simple_coder_end(), stream_decoder_end(), stream_encoder_end(), stream_encoder_mt_end(), and worker_start().

lzma_next_filter_init()

lzma_ret lzma_next_filter_init	(	lzma_next_coder *	next,
		const lzma_allocator *	allocator,
		const lzma_filter_info *	filters
	)

Initializes the next filter in the chain, if any. This takes care of freeing the memory of previously initialized filter if it is different than the filter being initialized now. This way the actual filter initialization functions don't need to use lzma_next_coder_init macro.

Definition at line 116 of file common.c.

{
    lzma_next_coder_init(filters[0].init, next, allocator);
    next->id = filters[0].id;
    return filters[0].init == NULL
            ? LZMA_OK : filters[0].init(next, allocator, filters);
}

References allocator, filters, lzma_filter::id, lzma_next_coder_s::id, init, lzma_next_coder_init, LZMA_OK, and NULL.

Referenced by alone_decode(), alone_encoder_init(), lzma_delta_coder_init(), lzma_lz_decoder_init(), lzma_lz_encoder_init(), lzma_raw_coder_init(), and lzma_simple_coder_init().

lzma_next_filter_update()

lzma_ret lzma_next_filter_update	(	lzma_next_coder *	next,
		const lzma_allocator *	allocator,
		const lzma_filter *	reversed_filters
	)

Update the next filter in the chain, if any. This checks that the application is not trying to change the Filter IDs.

Definition at line 127 of file common.c.

{
    // Check that the application isn't trying to change the Filter ID.
    // End of filters is indicated with LZMA_VLI_UNKNOWN in both
    // reversed_filters[0].id and next->id.
    if (reversed_filters[0].id != next->id)
        return LZMA_PROG_ERROR;
 
    if (reversed_filters[0].id == LZMA_VLI_UNKNOWN)
        return LZMA_OK;
 
    assert(next->update != NULL);
    return next->update(next->coder, allocator, NULL, reversed_filters);
}

References allocator, assert(), lzma_next_coder_s::coder, lzma_next_coder_s::id, LZMA_OK, LZMA_PROG_ERROR, LZMA_VLI_UNKNOWN, NULL, and lzma_next_coder_s::update.

Referenced by block_encoder_update(), delta_encoder_update(), lz_encoder_update(), and simple_coder_update().

lzma_strm_init()

lzma_ret lzma_strm_init

(

lzma_stream *

strm

)

Allocates strm->internal if it is NULL, and initializes *strm and strm->internal. This function is only called via lzma_next_strm_init macro.

Definition at line 170 of file common.c.

{
    if (strm == NULL)
        return LZMA_PROG_ERROR;
 
    if (strm->internal == NULL) {
        strm->internal = lzma_alloc(sizeof(lzma_internal),
                strm->allocator);
        if (strm->internal == NULL)
            return LZMA_MEM_ERROR;
 
        strm->internal->next = LZMA_NEXT_CODER_INIT;
    }
 
    memzero(strm->internal->supported_actions,
            sizeof(strm->internal->supported_actions));
    strm->internal->sequence = ISEQ_RUN;
    strm->internal->allow_buf_error = false;
 
    strm->total_in = 0;
    strm->total_out = 0;
 
    return LZMA_OK;
}

References lzma_stream::allocator, lzma_internal_s::allow_buf_error, lzma_stream::internal, lzma_alloc(), LZMA_MEM_ERROR, LZMA_NEXT_CODER_INIT, LZMA_OK, LZMA_PROG_ERROR, memzero, lzma_internal_s::next, NULL, lzma_internal_s::sequence, strm, lzma_internal_s::supported_actions, lzma_stream::total_in, and lzma_stream::total_out.

Variable Documentation

allocator

void const lzma_allocator* allocator

Definition at line 236 of file common.h.