inode.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later */
/*
 * inode.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_INODE_H
#define SQFS_INODE_H
 
#include "sqfs/predef.h"
 
typedef enum {
    SQFS_INODE_DIR = 1,
    SQFS_INODE_FILE = 2,
    SQFS_INODE_SLINK = 3,
    SQFS_INODE_BDEV = 4,
    SQFS_INODE_CDEV = 5,
    SQFS_INODE_FIFO = 6,
    SQFS_INODE_SOCKET = 7,
    SQFS_INODE_EXT_DIR = 8,
    SQFS_INODE_EXT_FILE = 9,
    SQFS_INODE_EXT_SLINK = 10,
    SQFS_INODE_EXT_BDEV = 11,
    SQFS_INODE_EXT_CDEV = 12,
    SQFS_INODE_EXT_FIFO = 13,
    SQFS_INODE_EXT_SOCKET = 14,
} SQFS_INODE_TYPE;
 
typedef enum {
    SQFS_INODE_OTHERS_X = 00001,
    SQFS_INODE_OTHERS_W = 00002,
    SQFS_INODE_OTHERS_R = 00004,
    SQFS_INODE_OTHERS_MASK = 00007,
 
    SQFS_INODE_GROUP_X = 00010,
    SQFS_INODE_GROUP_W = 00020,
    SQFS_INODE_GROUP_R = 00040,
    SQFS_INODE_GROUP_MASK = 00070,
 
    SQFS_INODE_OWNER_X = 00100,
    SQFS_INODE_OWNER_W = 00200,
    SQFS_INODE_OWNER_R = 00400,
    SQFS_INODE_OWNER_MASK = 00700,
 
    SQFS_INODE_STICKY = 01000,
    SQFS_INODE_SET_GID = 02000,
    SQFS_INODE_SET_UID = 04000,
 
    SQFS_INODE_MODE_FIFO = 0010000,
    SQFS_INODE_MODE_CHR = 0020000,
    SQFS_INODE_MODE_DIR = 0040000,
    SQFS_INODE_MODE_BLK = 0060000,
    SQFS_INODE_MODE_REG = 0100000,
    SQFS_INODE_MODE_LNK = 0120000,
    SQFS_INODE_MODE_SOCK = 0140000,
    SQFS_INODE_MODE_MASK = 0170000,
} SQFS_INODE_MODE;
 
struct sqfs_inode_t {
    sqfs_u16 type;
 
    sqfs_u16 mode;
 
    sqfs_u16 uid_idx;
 
    sqfs_u16 gid_idx;
 
    sqfs_u32 mod_time;
 
    sqfs_u32 inode_number;
};
 
struct sqfs_inode_dev_t {
    sqfs_u32 nlink;
 
    sqfs_u32 devno;
};
 
struct sqfs_inode_dev_ext_t {
    sqfs_u32 nlink;
 
    sqfs_u32 devno;
 
    sqfs_u32 xattr_idx;
};
 
struct sqfs_inode_ipc_t {
    sqfs_u32 nlink;
};
 
struct sqfs_inode_ipc_ext_t {
    sqfs_u32 nlink;
 
    sqfs_u32 xattr_idx;
};
 
struct sqfs_inode_slink_t {
    sqfs_u32 nlink;
 
    sqfs_u32 target_size;
 
    /*sqfs_u8 target[];*/
};
 
struct sqfs_inode_slink_ext_t {
    sqfs_u32 nlink;
 
    sqfs_u32 target_size;
 
    /*sqfs_u8 target[];*/
 
    sqfs_u32 xattr_idx;
};
 
struct sqfs_inode_file_t {
    sqfs_u32 blocks_start;
 
    sqfs_u32 fragment_index;
 
    sqfs_u32 fragment_offset;
 
    sqfs_u32 file_size;
 
    /*sqfs_u32 block_sizes[];*/
};
 
struct sqfs_inode_file_ext_t {
    sqfs_u64 blocks_start;
 
    sqfs_u64 file_size;
 
    sqfs_u64 sparse;
 
    sqfs_u32 nlink;
 
    sqfs_u32 fragment_idx;
 
    sqfs_u32 fragment_offset;
 
    sqfs_u32 xattr_idx;
 
    /*sqfs_u32 block_sizes[];*/
};
 
struct sqfs_inode_dir_t {
    sqfs_u32 start_block;
 
    sqfs_u32 nlink;
 
    sqfs_u16 size;
 
    sqfs_u16 offset;
 
    sqfs_u32 parent_inode;
};
 
struct sqfs_inode_dir_ext_t {
    sqfs_u32 nlink;
 
    sqfs_u32 size;
 
    sqfs_u32 start_block;
 
    sqfs_u32 parent_inode;
 
    sqfs_u16 inodex_count;
 
    sqfs_u16 offset;
 
    sqfs_u32 xattr_idx;
};
 
struct sqfs_inode_generic_t {
    sqfs_inode_t base;
 
    sqfs_u32 payload_bytes_available;
 
    sqfs_u32 payload_bytes_used;
 
    union {
        sqfs_inode_dev_t dev;
        sqfs_inode_dev_ext_t dev_ext;
        sqfs_inode_ipc_t ipc;
        sqfs_inode_ipc_ext_t ipc_ext;
        sqfs_inode_slink_t slink;
        sqfs_inode_slink_ext_t slink_ext;
        sqfs_inode_file_t file;
        sqfs_inode_file_ext_t file_ext;
        sqfs_inode_dir_t dir;
        sqfs_inode_dir_ext_t dir_ext;
    } data;
 
    sqfs_u32 extra[];
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
static SQFS_INLINE
size_t sqfs_inode_get_file_block_count(const sqfs_inode_generic_t *inode)
{
    return inode->payload_bytes_used / sizeof(sqfs_u32);
}
 
SQFS_API int sqfs_inode_get_xattr_index(const sqfs_inode_generic_t *inode,
                    sqfs_u32 *out);
 
SQFS_API int sqfs_inode_set_xattr_index(sqfs_inode_generic_t *inode,
                    sqfs_u32 index);
 
SQFS_API int sqfs_inode_make_extended(sqfs_inode_generic_t *inode);
 
SQFS_API int sqfs_inode_make_basic(sqfs_inode_generic_t *inode);
 
SQFS_API int sqfs_inode_set_file_size(sqfs_inode_generic_t *inode,
                      sqfs_u64 size);
 
SQFS_API int sqfs_inode_set_file_block_start(sqfs_inode_generic_t *inode,
                         sqfs_u64 location);
 
SQFS_API int sqfs_inode_set_frag_location(sqfs_inode_generic_t *inode,
                      sqfs_u32 index, sqfs_u32 offset);
 
SQFS_API int sqfs_inode_get_file_size(const sqfs_inode_generic_t *inode,
                      sqfs_u64 *size);
 
SQFS_API int sqfs_inode_get_frag_location(const sqfs_inode_generic_t *inode,
                      sqfs_u32 *index, sqfs_u32 *offset);
 
SQFS_API int sqfs_inode_get_file_block_start(const sqfs_inode_generic_t *inode,
                         sqfs_u64 *location);
 
SQFS_API
int sqfs_inode_unpack_dir_index_entry(const sqfs_inode_generic_t *inode,
                      sqfs_dir_index_t **out,
                      size_t index);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SQFS_INODE_H */