SqshSuperblock Struct Reference

The superblock context is used to access the superblock of the archive. More...

#include <sqsh_archive_private.h>

Public Member Functions
enum SqshSuperblockCompressionId	sqsh_superblock_compression_id (const struct SqshSuperblock *context)
	Retrieves the compression id of a superblock context.
uint64_t	sqsh_superblock_directory_table_start (const struct SqshSuperblock *context)
	Retrieves the start offset of the directory table in a superblock context.
uint64_t	sqsh_superblock_fragment_table_start (const struct SqshSuperblock *context)
	Retrieves the start offset of the fragment table in a superblock context.
uint32_t	sqsh_superblock_inode_count (const struct SqshSuperblock *context)
	Retrieves the number of inodes in an archive.
uint16_t	sqsh_superblock_version_major (const struct SqshSuperblock *superblock)
	Retrieves the major version of an archive.
uint16_t	sqsh_superblock_version_minor (const struct SqshSuperblock *superblock)
	Retrieves the minor version of an archive.
uint64_t	sqsh_superblock_inode_table_start (const struct SqshSuperblock *context)
	Retrieves the start offset of the inode table in an archive.
uint64_t	sqsh_superblock_id_table_start (const struct SqshSuperblock *context)
	Retrieves the start offset of the id table in an archive.
uint16_t	sqsh_superblock_id_count (const struct SqshSuperblock *context)
	Retrieves the number of ids in an archive.
uint64_t	sqsh_superblock_export_table_start (const struct SqshSuperblock *context)
	Retrieves the start offset of the export table in an archive.
uint64_t	sqsh_superblock_xattr_id_table_start (const struct SqshSuperblock *context)
	Retrieves the start offset of the xattr id table in an archive.
uint64_t	sqsh_superblock_inode_root_ref (const struct SqshSuperblock *context)
	Retrieves the reference of the root inode in a superblock context.
bool	sqsh_superblock_has_fragments (const struct SqshSuperblock *context)
	Checks if a superblock context has fragment table.
bool	sqsh_superblock_has_export_table (const struct SqshSuperblock *context)
	Checks if a superblock context has an export table.
bool	sqsh_superblock_has_xattr_table (const struct SqshSuperblock *context)
	Checks if a superblock context has an xattr table.
bool	sqsh_superblock_has_compression_options (const struct SqshSuperblock *context)
	Checks if a superblock context has compression options.
uint32_t	sqsh_superblock_block_size (const struct SqshSuperblock *context)
	Retrieves the block size of a superblock context.
uint32_t	sqsh_superblock_modification_time (const struct SqshSuperblock *context)
	Retrieves the modification time of a superblock context.
uint32_t	sqsh_superblock_fragment_entry_count (const struct SqshSuperblock *context)
	Retrieves the number of fragment entries in a superblock context.
uint64_t	sqsh_superblock_bytes_used (const struct SqshSuperblock *context)
	Retrieves the number of bytes used in a superblock context.

Detailed Description

The superblock context is used to access the superblock of the archive.

Definition at line 150 of file sqsh_archive_private.h.

Member Function Documentation

sqsh_superblock_block_size()

uint32_t sqsh_superblock_block_size

(

const struct SqshSuperblock *

context

)

Retrieves the block size of a superblock context.

Parameters

[in]

context

The superblock context to retrieve the block size from.

Returns

The block size of the superblock context.

sqsh_superblock_bytes_used()

uint64_t sqsh_superblock_bytes_used

(

const struct SqshSuperblock *

context

)

Retrieves the number of bytes used in a superblock context.

Parameters

[in]

context

The superblock context to retrieve the bytes used from.

Returns

The number of bytes used in the superblock context.

sqsh_superblock_compression_id()

enum SqshSuperblockCompressionId sqsh_superblock_compression_id

(

const struct SqshSuperblock *

context

)

Retrieves the compression id of a superblock context.

Parameters

[in]

context

The superblock context to retrieve the compression id from.

Returns

The compression id of the superblock context.

sqsh_superblock_directory_table_start()

uint64_t sqsh_superblock_directory_table_start

(

const struct SqshSuperblock *

context

)

Retrieves the start offset of the directory table in a superblock context.

Parameters

[in]

context

The superblock context to retrieve the directory table start offset from.

Returns

The start offset of the directory table in the superblock context.

sqsh_superblock_export_table_start()

uint64_t sqsh_superblock_export_table_start

(

const struct SqshSuperblock *

context

)

Retrieves the start offset of the export table in an archive.

Parameters

[in]

context

The superblock context to retrieve the export table start offset from.

Returns

The start offset of the export table in the superblock context.

sqsh_superblock_fragment_entry_count()

uint32_t sqsh_superblock_fragment_entry_count

(

const struct SqshSuperblock *

context

)

Retrieves the number of fragment entries in a superblock context.

Parameters

[in]

context

The superblock context to retrieve the fragment entry count from.

Returns

The number of fragment entries in the superblock context.

sqsh_superblock_fragment_table_start()

uint64_t sqsh_superblock_fragment_table_start

(

const struct SqshSuperblock *

context

)

Retrieves the start offset of the fragment table in a superblock context.

Parameters

[in]

context

The superblock context to retrieve the fragment table start offset from.

Returns

The start offset of the fragment table in the superblock context.

sqsh_superblock_has_compression_options()

bool sqsh_superblock_has_compression_options

(

const struct SqshSuperblock *

context

)

Checks if a superblock context has compression options.

Parameters

[in]

context

The superblock context to check.

Returns

True if the superblock context has compression options, false otherwise.

sqsh_superblock_has_export_table()

bool sqsh_superblock_has_export_table

(

const struct SqshSuperblock *

context

)

Checks if a superblock context has an export table.

Parameters

[in]

context

The superblock context to check.

Returns

True if the superblock context has an export table, false otherwise.

sqsh_superblock_has_fragments()

bool sqsh_superblock_has_fragments

(

const struct SqshSuperblock *

context

)

Checks if a superblock context has fragment table.

Parameters

[in]

context

The superblock context to check.

Returns

True if the superblock context has a fragment table, false otherwise.

sqsh_superblock_has_xattr_table()

bool sqsh_superblock_has_xattr_table

(

const struct SqshSuperblock *

context

)

Checks if a superblock context has an xattr table.

Parameters

[in]

context

The superblock context to check.

Returns

True if the superblock context has an xattr table, false otherwise.

sqsh_superblock_id_count()

uint16_t sqsh_superblock_id_count

(

const struct SqshSuperblock *

context

)

Retrieves the number of ids in an archive.

Parameters

[in]

context

The superblock context to retrieve the ids count from.

Returns

The number of inodes in the superblock context.

sqsh_superblock_id_table_start()

uint64_t sqsh_superblock_id_table_start

(

const struct SqshSuperblock *

context

)

Retrieves the start offset of the id table in an archive.

Parameters

[in]

context

The superblock context to retrieve the id table start offset from.

Returns

The start offset of the id table in the superblock context.

sqsh_superblock_inode_count()

uint32_t sqsh_superblock_inode_count

(

const struct SqshSuperblock *

context

)

Retrieves the number of inodes in an archive.

Parameters

[in]

context

The superblock context to retrieve the inode count from.

Returns

The number of inodes in the superblock context.

sqsh_superblock_inode_root_ref()

uint64_t sqsh_superblock_inode_root_ref

(

const struct SqshSuperblock *

context

)

Retrieves the reference of the root inode in a superblock context.

Parameters

[in]

context

The superblock context to retrieve the root inode reference from.

Returns

The reference of the root inode in the superblock context.

sqsh_superblock_inode_table_start()

uint64_t sqsh_superblock_inode_table_start

(

const struct SqshSuperblock *

context

)

Retrieves the start offset of the inode table in an archive.

Parameters

[in]

context

The superblock context to retrieve the inode table start offset from.

Returns

The start offset of the inode table in the superblock context.

sqsh_superblock_modification_time()

uint32_t sqsh_superblock_modification_time

(

const struct SqshSuperblock *

context

)

Retrieves the modification time of a superblock context.

Parameters

[in]

context

The superblock context to retrieve the modification time from.

Returns

The modification time of the superblock context.

sqsh_superblock_version_major()

uint16_t sqsh_superblock_version_major

(

const struct SqshSuperblock *

superblock

)

Retrieves the major version of an archive.

Parameters

[in]

superblock

The superblock context to retrieve the major version from.

Returns

The major version of this archive.

sqsh_superblock_version_minor()

uint16_t sqsh_superblock_version_minor

(

const struct SqshSuperblock *

superblock

)

Retrieves the minor version of an archive.

Parameters

[in]

superblock

The superblock context to retrieve the minor version from.

Returns

The minor version of this archive.

sqsh_superblock_xattr_id_table_start()

uint64_t sqsh_superblock_xattr_id_table_start

(

const struct SqshSuperblock *

context

)

Retrieves the start offset of the xattr id table in an archive.

Parameters

[in]

context

The superblock context to retrieve the xattr id table start offset from.

Returns

The start offset of the xattr id table in the superblock context.

---

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

• libsqsh/include/sqsh_archive_private.h
• include/sqsh_archive.h