super.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
 * super.h - This file is part of libsquashfs
 *
 * Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#ifndef SQFS_SUPER_H
#define SQFS_SUPER_H
 
#include "sqfs/predef.h"
 
#define SQFS_MAGIC 0x73717368
#define SQFS_VERSION_MAJOR 4
#define SQFS_VERSION_MINOR 0
#define SQFS_DEVBLK_SIZE 4096
 
#define SQFS_MIN_BLOCK_SIZE (4 * 1024)
#define SQFS_MAX_BLOCK_SIZE (1024 * 1024)
#define SQFS_DEFAULT_BLOCK_SIZE (128 * 1024)
 
struct sqfs_super_t {
    sqfs_u32 magic;
 
    sqfs_u32 inode_count;
 
    sqfs_u32 modification_time;
 
    sqfs_u32 block_size;
 
    sqfs_u32 fragment_entry_count;
 
    sqfs_u16 compression_id;
 
    sqfs_u16 block_log;
 
    sqfs_u16 flags;
 
    sqfs_u16 id_count;
 
    sqfs_u16 version_major;
 
    sqfs_u16 version_minor;
 
    sqfs_u64 root_inode_ref;
 
    sqfs_u64 bytes_used;
 
    sqfs_u64 id_table_start;
 
    sqfs_u64 xattr_id_table_start;
 
    sqfs_u64 inode_table_start;
 
    sqfs_u64 directory_table_start;
 
    sqfs_u64 fragment_table_start;
 
    sqfs_u64 export_table_start;
};
 
typedef enum {
    SQFS_COMP_GZIP = 1,
    SQFS_COMP_LZMA = 2,
    SQFS_COMP_LZO = 3,
    SQFS_COMP_XZ = 4,
    SQFS_COMP_LZ4 = 5,
    SQFS_COMP_ZSTD = 6,
 
    SQFS_COMP_MIN = 1,
    SQFS_COMP_MAX = 6,
} SQFS_COMPRESSOR;
 
typedef enum {
    SQFS_FLAG_UNCOMPRESSED_INODES = 0x0001,
 
    SQFS_FLAG_UNCOMPRESSED_DATA = 0x0002,
 
    SQFS_FLAG_UNCOMPRESSED_FRAGMENTS = 0x0008,
 
    SQFS_FLAG_NO_FRAGMENTS = 0x0010,
 
    SQFS_FLAG_ALWAYS_FRAGMENTS = 0x0020,
 
    SQFS_FLAG_NO_DUPLICATES = 0x0040,
 
    SQFS_FLAG_EXPORTABLE = 0x0080,
 
    SQFS_FLAG_UNCOMPRESSED_XATTRS = 0x0100,
 
    SQFS_FLAG_NO_XATTRS = 0x0200,
 
    SQFS_FLAG_COMPRESSOR_OPTIONS = 0x0400,
 
    SQFS_FLAG_UNCOMPRESSED_IDS = 0x0800,
} SQFS_SUPER_FLAGS;
 
#ifdef __cplusplus
extern "C" {
#endif
 
SQFS_API int sqfs_super_init(sqfs_super_t *super, size_t block_size,
                 sqfs_u32 mtime,
                 SQFS_COMPRESSOR compressor);
 
SQFS_API int sqfs_super_write(const sqfs_super_t *super, sqfs_file_t *file);
 
SQFS_API int sqfs_super_read(sqfs_super_t *super, sqfs_file_t *file);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SQFS_SUPER_H */