The SqshConfig struct contains all the configuration options for a sqsh session. More...

#include <sqsh_archive.h>

Collaboration diagram for SqshConfig:

Data Fields
uint64_t	archive_offset
	represents the offset in bytes where the sqsh_archive will start.

uint64_t	source_size
	represents the addressable size of the source in bytes.

const struct SqshMemoryMapperImpl *	source_mapper
	source_mapper is the memory mapper implementation that will be used to map the archive.

int	mapper_block_size
	the block size used to retrieve chunks of data from the mapper. If unset or 0, the block size will be determined by the mapper.

int	mapper_lru_size
	the size of the LRU cache used to cache chunks of data from the mapper. If unset or 0, the LRU defaults to 32. if set to -1, the LRU will be disabled.

int	compression_lru_size
	the size of the LRU cache used to cache chunks of data from the compression algorithm. If unset or 0, the LRU defaults to 128. if set to -1, the LRU will be disabled.

size_t	max_symlink_depth
	the maximum depth of symlinks that will be followed. If unset or 0, the max symlink depth will be 100.

int	data_lru_size
	the size of the LRU cache used to cache chunks of data from the data blocks. If unset or 0, the LRU defaults to 128. if set to -1, the LRU will be disabled.

int	metablock_lru_size
	the size of the LRU cache used to cache chunks of data from the metablocks. If unset or 0, the LRU defaults to 128. if set to -1, the LRU will be disabled.

Detailed Description

The SqshConfig struct contains all the configuration options for a sqsh session.

Definition at line 375 of file sqsh_archive.h.

Field Documentation

◆ archive_offset

uint64_t SqshConfig::archive_offset

represents the offset in bytes where the sqsh_archive will start.

Definition at line 380 of file sqsh_archive.h.

◆ compression_lru_size

int SqshConfig::compression_lru_size

the size of the LRU cache used to cache chunks of data from the compression algorithm. If unset or 0, the LRU defaults to 128. if set to -1, the LRU will be disabled.

Deprecated: Since 1.5.0. data_lru_size or metablock_lru_size instead.

Definition at line 433 of file sqsh_archive.h.

◆ data_lru_size

int SqshConfig::data_lru_size

the size of the LRU cache used to cache chunks of data from the data blocks. If unset or 0, the LRU defaults to 128. if set to -1, the LRU will be disabled.

Definition at line 446 of file sqsh_archive.h.

◆ mapper_block_size

int SqshConfig::mapper_block_size

the block size used to retrieve chunks of data from the mapper. If unset or 0, the block size will be determined by the mapper.

Definition at line 413 of file sqsh_archive.h.

◆ mapper_lru_size

int SqshConfig::mapper_lru_size

the size of the LRU cache used to cache chunks of data from the mapper. If unset or 0, the LRU defaults to 32. if set to -1, the LRU will be disabled.

Definition at line 420 of file sqsh_archive.h.

◆ max_symlink_depth

size_t SqshConfig::max_symlink_depth

the maximum depth of symlinks that will be followed. If unset or 0, the max symlink depth will be 100.

Definition at line 439 of file sqsh_archive.h.

◆ metablock_lru_size

int SqshConfig::metablock_lru_size

the size of the LRU cache used to cache chunks of data from the metablocks. If unset or 0, the LRU defaults to 128. if set to -1, the LRU will be disabled.

Definition at line 453 of file sqsh_archive.h.

◆ source_mapper

const struct SqshMemoryMapperImpl* SqshConfig::source_mapper

source_mapper is the memory mapper implementation that will be used to map the archive.

sqsh_mapper_impl_mmap: the archive will be loaded from a file. The source will be interpreted as a file path. this is the default.
sqsh_mapper_impl_static: the archive will be interpreted from a static buffer.
sqsh_mapper_impl_curl: the archive will be loaded from a remote location. The source will be interpreted as a URL.

Definition at line 407 of file sqsh_archive.h.

◆ source_size

uint64_t SqshConfig::source_size

represents the addressable size of the source in bytes.

Please note that this is not the size of the archive, but the size of the source. So that the maximal size of the archive is source_size - archive_offset.

This field is only used when the source_mapper is unable to determine the size of the source itself. This is the case for the following mappers:

sqsh_mapper_impl_static

Definition at line 394 of file sqsh_archive.h.

The documentation for this struct was generated from the following file:

include/sqsh_archive.h

Data Fields