XZ Utils  5.2.2
Enumerations | Functions | Variables
coder.c File Reference

Compresses or uncompresses a file. More...

#include "private.h"

Enumerations

enum  coder_init_ret { CODER_INIT_NORMAL, CODER_INIT_PASSTHRU, CODER_INIT_ERROR }
 Return value type for coder_init(). More...
 

Functions

void coder_set_check (lzma_check new_check)
 Set the integrity check type used when compressing. More...
 
static void forget_filter_chain (void)
 
void coder_set_preset (uint32_t new_preset)
 Set preset number. More...
 
void coder_set_extreme (void)
 Enable extreme mode. More...
 
void coder_add_filter (lzma_vli id, void *options)
 Add a filter to the custom filter chain. More...
 
static void lzma_attribute ((__noreturn__))
 
void coder_set_compression_settings (void)
 
static bool is_format_xz (void)
 Return true if the data in in_buf seems to be in the .xz format. More...
 
static bool is_format_lzma (void)
 Return true if the data in in_buf seems to be in the .lzma format. More...
 
static enum coder_init_ret coder_init (file_pair *pair)
 
static void split_block (uint64_t *block_remaining, uint64_t *next_block_remaining, size_t *list_pos)
 
static bool coder_normal (file_pair *pair)
 Compress or decompress using liblzma. More...
 
static bool coder_passthru (file_pair *pair)
 
void coder_run (const char *filename)
 Compress or decompress the given file. More...
 
void coder_free (void)
 Free the memory allocated for the coder and kill the worker threads. More...
 

Variables

enum operation_mode opt_mode = MODE_COMPRESS
 
enum format_type opt_format = FORMAT_AUTO
 
bool opt_auto_adjust = true
 
bool opt_single_stream = false
 If true, stop after decoding the first stream. More...
 
uint64_t opt_block_size = 0
 
uint64_t * opt_block_list = NULL
 
static lzma_stream strm = LZMA_STREAM_INIT
 Stream used to communicate with liblzma. More...
 
static lzma_filter filters [LZMA_FILTERS_MAX+1]
 Filters needed for all encoding all formats, and also decoding in raw data. More...
 
static io_buf in_buf
 Input and output buffers. More...
 
static io_buf out_buf
 
static uint32_t filters_count = 0
 Number of filters. Zero indicates that we are using a preset. More...
 
static uint32_t preset_number = LZMA_PRESET_DEFAULT
 Number of the preset (0-9) More...
 
static lzma_check check
 Integrity check type. More...
 
static bool check_default = true
 This becomes false if the –check=CHECK option is used. More...
 

Detailed Description

Compresses or uncompresses a file.

Enumeration Type Documentation

Return value type for coder_init().

Function Documentation

void coder_set_check ( lzma_check  new_check)

Set the integrity check type used when compressing.

References check, check_default, filters_count, and lzma_filter::options.

Referenced by parse_memlimit().

void coder_set_preset ( uint32_t  new_preset)

Set preset number.

References LZMA_PRESET_LEVEL_MASK, and preset_number.

Referenced by parse_memlimit().

void coder_set_extreme ( void  )

Enable extreme mode.

References LZMA_PRESET_EXTREME, and preset_number.

Referenced by parse_memlimit().

void coder_add_filter ( lzma_vli  id,
void *  options 
)
static bool is_format_xz ( void  )
static

Return true if the data in in_buf seems to be in the .xz format.

References lzma_stream::avail_in.

Referenced by coder_init().

static bool is_format_lzma ( void  )
static

Return true if the data in in_buf seems to be in the .lzma format.

References lzma_stream::avail_in, lzma_options_lzma::dict_size, lzma_filter::id, LZMA_FILTER_LZMA1, LZMA_OK, lzma_properties_decode(), and lzma_filter::options.

Referenced by coder_init().

static enum coder_init_ret coder_init ( file_pair pair)
static

Detect the input file type (for now, this done only when decompressing), and initialize an appropriate coder. Return value indicates if a normal liblzma-based coder was initialized (CODER_INIT_NORMAL), if passthru mode should be used (CODER_INIT_PASSTHRU), or if an error occurred (CODER_INIT_ERROR).

References lzma_stream::avail_out, check, hardware_memlimit_get(), hardware_threads_get(), is_format_lzma(), is_format_xz(), lzma_alone_decoder(), lzma_alone_encoder(), lzma_code(), LZMA_CONCATENATED, LZMA_FORMAT_ERROR, LZMA_IGNORE_CHECK, lzma_memusage(), LZMA_OK, LZMA_PROG_ERROR, lzma_raw_decoder(), lzma_raw_encoder(), LZMA_RUN, lzma_stream_decoder(), lzma_stream_encoder(), lzma_stream_encoder_mt(), LZMA_TELL_UNSUPPORTED_CHECK, message_error(), message_mem_needed(), message_strm(), lzma_stream::next_out, opt_format, opt_mode, opt_single_stream, file_pair::src_name, and V_ERROR.

Referenced by coder_run().

static void split_block ( uint64_t *  block_remaining,
uint64_t *  next_block_remaining,
size_t *  list_pos 
)
static

Resolve conflicts between opt_block_size and opt_block_list in single threaded mode. We want to default to opt_block_list, except when it is larger than opt_block_size. If this is the case for the current Block at *list_pos, then we break into smaller Blocks. Otherwise advance to the next Block in opt_block_list, and break apart if needed.

References hardware_threads_get(), opt_block_list, and opt_block_size.

Referenced by coder_normal().

static bool coder_normal ( file_pair pair)
static
static bool coder_passthru ( file_pair pair)
static

Copy from input file to output file without processing the data in any way. This is used only when trying to decompress unrecognized files with –decompress –stdout –force, so the output is always stdout.

References lzma_stream::avail_in, io_read(), io_write(), message_progress_update(), lzma_stream::total_in, lzma_stream::total_out, and user_abort.

Referenced by coder_run().

void coder_run ( const char *  filename)
void coder_free ( void  )

Free the memory allocated for the coder and kill the worker threads.

References lzma_end().

Referenced by set_exit_no_warn().

Variable Documentation

enum operation_mode opt_mode = MODE_COMPRESS
enum format_type opt_format = FORMAT_AUTO

File format to use when encoding or what format(s) to accept when decoding. This is a global because it's needed also in suffix.c. This is set in args.c.

Referenced by coder_add_filter(), coder_init(), coder_normal(), compressed_name(), list_file(), parse_memlimit(), and uncompressed_name().

bool opt_auto_adjust = true

If true, the compression settings are automatically adjusted down if they exceed the memory usage limit.

Referenced by coder_add_filter(), and parse_memlimit().

bool opt_single_stream = false

If true, stop after decoding the first stream.

Referenced by coder_init(), coder_normal(), and parse_memlimit().

uint64_t opt_block_size = 0

If non-zero, start a new .xz Block after every opt_block_size bytes of input. This has an effect only when compressing to the .xz format.

Referenced by coder_add_filter(), coder_normal(), parse_memlimit(), and split_block().

uint64_t* opt_block_list = NULL

This is non-NULL if –block-list was used. This contains the Block sizes as an array that is terminated with 0.

Referenced by coder_normal(), parse_memlimit(), and split_block().

lzma_filter filters[LZMA_FILTERS_MAX+1]
static
io_buf in_buf
static

Input and output buffers.

Referenced by parse_options().

uint32_t filters_count = 0
static

Number of filters. Zero indicates that we are using a preset.

Referenced by coder_add_filter(), and coder_set_check().

uint32_t preset_number = LZMA_PRESET_DEFAULT
static

Number of the preset (0-9)

Referenced by coder_add_filter(), coder_set_extreme(), and coder_set_preset().

lzma_check check
static
bool check_default = true
static

This becomes false if the –check=CHECK option is used.

Referenced by coder_add_filter(), and coder_set_check().