Skip to content
charmOS docs

Ext2

include/fs/ext2.h View source View on GitHub

Structs

Section titled “Structs”

ext2_sblock

Section titled “ext2_sblock”
struct ext2_sblock {
    uint32_t  inodes_count;
    uint32_t  blocks_count;
    uint32_t  r_blocks_count;
    uint32_t  free_blocks_count;
    uint32_t  free_inodes_count;
    uint32_t  first_data_block;
    uint32_t  log_block_size;
    uint32_t  log_frag_size;
    uint32_t  blocks_per_group;
    uint32_t  frags_per_group;
    uint32_t  inodes_per_group;
    uint32_t  mtime;
    uint32_t  wtime;
    uint16_t  mnt_count;
    uint16_t  max_mnt_count;
    uint16_t  magic;
    uint16_t  state;
    uint16_t  errors;
    uint16_t  minor_rev_level;
    uint32_t  lastcheck;
    uint32_t  checkinterval;
    uint32_t  creator_os;
    uint32_t  rev_level;
    uint16_t  def_resuid;
    uint16_t  def_resgid;
    uint32_t  first_ino;
    uint16_t  inode_size;
    uint16_t  block_group_nr;
    uint32_t  feature_compat;
    uint32_t  feature_incompat;
    uint32_t  feature_ro_compat;
    uint8_t   uuid[16];
    char      volume_name[16];
    char      last_mounted[64];
    uint32_t  algorithm_usage_bitmap;
    uint8_t   prealloc_blocks;
    uint8_t   prealloc_dir_blocks;
    uint16_t  padding;
    union {
        struct {
            uint32_t  journal_uuid[4];
            uint32_t  journal_inum;
            uint32_t  journal_dev;
            uint32_t  last_orphan;
            uint32_t  hash_seed[4];
            uint8_t   def_hash_version;
            uint8_t   journal_backup_type;
            uint16_t  desc_size;
            uint32_t  default_mount_opts;
            uint32_t  first_meta_bg;
            uint32_t  mkfs_time;
            uint32_t  journal_blocks[17];
            uint32_t  quota_group_inode;
            uint32_t  quota_project_inode;
        };
        uint32_t  reserved[204];
    };
};

ext2_group_desc

Section titled “ext2_group_desc”
struct ext2_group_desc {
    uint32_t  block_bitmap;
    uint32_t  inode_bitmap;
    uint32_t  inode_table;
    uint16_t  free_blocks_count;
    uint16_t  free_inodes_count;
    uint16_t  used_dirs_count;
    uint16_t  pad;
    uint32_t  reserved[3];
};

ext2_inode

Section titled “ext2_inode”
struct ext2_inode {
    mode_t    mode;
    uint16_t  uid;
    uint32_t  size;
    uint32_t  atime;
    uint32_t  ctime;
    uint32_t  mtime;
    uint32_t  dtime;
    uint16_t  gid;
    uint16_t  links_count;
    uint32_t  blocks;
    uint32_t  flags;
    uint32_t  osd1;
    uint32_t  block[EXT2_NBLOCKS];
    uint32_t  generation;
    uint32_t  file_acl;
    uint32_t  dir_acl;
    uint32_t  faddr;
    uint8_t   frag[16];
    uint8_t   osd2[12];
};

ext2_full_inode

Section titled “ext2_full_inode”
struct ext2_full_inode {
    struct ext2_inode    node;
    inode_t              inode_num;
    struct bcache_entry  *ent;
};

ext2_dir_entry

Section titled “ext2_dir_entry”
struct ext2_dir_entry {
    inode_t   inode;
    uint16_t  rec_len;
    uint8_t   name_len;
    uint8_t   file_type;
    char      name[EXT2_NAME_LEN + 1];
};

ext2_fs

Section titled “ext2_fs”
struct ext2_fs {
    struct partition        *partition;
    struct block_device     *drive;
    struct ext2_sblock      *sblock;
    struct ext2_group_desc  *group_desc;
    struct bcache_entry     *sbcache_ent;
    struct bcache_entry     *gdesc_cache_ent;
    uint32_t                num_groups;
    uint32_t                inodes_count;
    uint32_t                inodes_per_group;
    uint32_t                blocks_per_group;
    uint32_t                block_size;
    uint32_t                sectors_per_block;
    uint16_t                inode_size;
    struct spinlock         lock;
};

Type Aliases

Section titled “Type Aliases”

dir_entry_callback

Section titled “dir_entry_callback”
typedef bool (*dir_entry_callback)(struct ext2_fs * fs, struct ext2_dir_entry * entry, void * ctx, uint32_t block_num, uint32_t entry_num, uint32_t entry_offset);

ext2_block_visitor

Section titled “ext2_block_visitor”
typedef void (*ext2_block_visitor)(struct ext2_fs * fs, struct ext2_inode * inode, uint32_t depth, uint32_t * block_ptr, void * user_data);

Functions

Section titled “Functions”

ext2_block_read

Section titled “ext2_block_read”
uint8_t * ext2_block_read(struct ext2_fs *fs, uint32_t block_num, struct bcache_entry **out);

ext2_block_write

Section titled “ext2_block_write”
bool ext2_block_write(struct ext2_fs *fs, struct bcache_entry *ent, enum bio_request_priority prio);

ext2_read_superblock

Section titled “ext2_read_superblock”
bool ext2_read_superblock(struct partition * *, struct ext2_sblock *sblock);

ext2_write_superblock

Section titled “ext2_write_superblock”
bool ext2_write_superblock(struct ext2_fs *fs);

ext2_write_group_desc

Section titled “ext2_write_group_desc”
bool ext2_write_group_desc(struct ext2_fs *fs);

ext2_mount

Section titled “ext2_mount”
enum errno ext2_mount(struct partition * *, struct ext2_fs *fs, struct ext2_sblock *sblock, struct vfs_node *out_node);

ext2_g_mount

Section titled “ext2_g_mount”
struct vfs_node * ext2_g_mount(struct partition * *);

ext2_inode_read

Section titled “ext2_inode_read”
struct ext2_inode * ext2_inode_read(struct ext2_fs *fs, inode_t inode_idx, struct bcache_entry **out_ent);

ext2_inode_write

Section titled “ext2_inode_write”
bool ext2_inode_write(struct ext2_fs *fs, inode_t inode_num, const struct ext2_inode *inode);

ext2_get_or_set_block

Section titled “ext2_get_or_set_block”
uint32_t ext2_get_or_set_block(struct ext2_fs *fs, struct ext2_inode *inode, uint32_t block_index, uint32_t new_block_num, bool allocate, bool *was_allocated);

ext2_block_to_lba

Section titled “ext2_block_to_lba”
uint32_t ext2_block_to_lba(struct ext2_fs *fs, uint32_t block_num);

ext2_dirent_valid

Section titled “ext2_dirent_valid”
bool ext2_dirent_valid(struct ext2_dir_entry *entry);

ext2_init_inode

Section titled “ext2_init_inode”
void ext2_init_inode(struct ext2_inode *new_inode, mode_t mode);

ext2_init_dirent

Section titled “ext2_init_dirent”
void ext2_init_dirent(struct ext2_fs *fs, struct ext2_dir_entry *new_entry, inode_t inode_num, const char *name, uint8_t type);

ext2_extract_ftype

Section titled “ext2_extract_ftype”
uint8_t ext2_extract_ftype(mode_t mode);

ext2_walk_dir

Section titled “ext2_walk_dir”
bool ext2_walk_dir(struct ext2_fs *fs, struct ext2_full_inode *dir, dir_entry_callback cb, void *ctx);

ext2_dealloc_inode

Section titled “ext2_dealloc_inode”
void ext2_dealloc_inode(struct ext2_full_inode *ino);

ext2_get_block_group

Section titled “ext2_get_block_group”
uint32_t ext2_get_block_group(struct ext2_fs *fs, uint32_t block);

ext2_get_inode_group

Section titled “ext2_get_inode_group”
uint32_t ext2_get_inode_group(struct ext2_fs *fs, inode_t inode);

ext2_fs_lock

Section titled “ext2_fs_lock”
enum irql ext2_fs_lock(struct ext2_fs *fs);

ext2_fs_unlock

Section titled “ext2_fs_unlock”
void ext2_fs_unlock(struct ext2_fs *fs, enum irql i);

ext2_prefetch_block

Section titled “ext2_prefetch_block”
void ext2_prefetch_block(struct ext2_fs *fs, uint32_t block);

ext2_inode_lock

Section titled “ext2_inode_lock”
void ext2_inode_lock(struct ext2_full_inode *ino);

ext2_inode_unlock

Section titled “ext2_inode_unlock”
void ext2_inode_unlock(struct ext2_full_inode *ino);

ext2_create_bcache_ent

Section titled “ext2_create_bcache_ent”
uint8_t ext2_create_bcache_ent(struct ext2_fs *fs, uint32_t block, struct bcache_entry **out);
Section titled “ext2_link_file”
enum errno ext2_link_file(struct ext2_fs *fs, struct ext2_full_inode *dir_inode, struct ext2_full_inode *inode, const char *name, uint8_t type, bool increment_links);
Section titled “ext2_unlink_file”
enum errno ext2_unlink_file(struct ext2_fs *fs, struct ext2_full_inode *dir_inode, const char *name, bool free_blocks, bool decrement_links);

ext2_create_file

Section titled “ext2_create_file”
enum errno ext2_create_file(struct ext2_fs *fs, struct ext2_full_inode *parent_dir, const char *name, mode_t mode, bool increment_links);
Section titled “ext2_symlink_file”
enum errno ext2_symlink_file(struct ext2_fs *fs, struct ext2_full_inode *dir_inode, const char *name, const char *target);

ext2_write_file

Section titled “ext2_write_file”
enum errno ext2_write_file(struct ext2_fs *fs, struct ext2_full_inode *inode, uint32_t offset, const uint8_t *src, uint32_t size);

ext2_read_file

Section titled “ext2_read_file”
enum errno ext2_read_file(struct ext2_fs *fs, struct ext2_full_inode *inode, uint32_t offset, uint8_t *buffer, uint64_t length);

ext2_truncate_file

Section titled “ext2_truncate_file”
enum errno ext2_truncate_file(struct ext2_fs *fs, struct ext2_full_inode *inode, uint32_t new_size);

ext2_chmod

Section titled “ext2_chmod”
enum errno ext2_chmod(struct ext2_fs *fs, struct ext2_full_inode *node, mode_t new_mode);

ext2_chown

Section titled “ext2_chown”
enum errno ext2_chown(struct ext2_fs *fs, struct ext2_full_inode *node, uid_t new_uid, gid_t new_gid);
Section titled “ext2_readlink”
enum errno ext2_readlink(struct ext2_fs *fs, struct ext2_full_inode *node, char *buf, uint64_t size);

ext2_find_file_in_dir

Section titled “ext2_find_file_in_dir”
struct ext2_full_inode * ext2_find_file_in_dir(struct ext2_fs *fs, struct ext2_full_inode *dir_inode, const char *fname, uint8_t *type_out);

ext2_dir_contains_file

Section titled “ext2_dir_contains_file”
bool ext2_dir_contains_file(struct ext2_fs *fs, struct ext2_full_inode *dir_inode, const char *fname);

ext2_mkdir

Section titled “ext2_mkdir”
enum errno ext2_mkdir(struct ext2_fs *fs, struct ext2_full_inode *parent_dir, const char *name, mode_t mode);

ext2_rmdir

Section titled “ext2_rmdir”
enum errno ext2_rmdir(struct ext2_fs *fs, struct ext2_full_inode *parent_dir, const char *name);

ext2_readdir

Section titled “ext2_readdir”
enum errno ext2_readdir(struct ext2_fs *fs, struct ext2_full_inode *dir_inode, struct ext2_dir_entry *out, uint32_t entry_offset);

ext2_alloc_block

Section titled “ext2_alloc_block”
uint32_t ext2_alloc_block(struct ext2_fs *fs);

ext2_free_block

Section titled “ext2_free_block”
bool ext2_free_block(struct ext2_fs *fs, uint32_t block_num);

ext2_alloc_inode

Section titled “ext2_alloc_inode”
inode_t ext2_alloc_inode(struct ext2_fs *fs);

ext2_free_inode

Section titled “ext2_free_inode”
bool ext2_free_inode(struct ext2_fs *fs, inode_t inode_num);

ext2_find_first_available

Section titled “ext2_find_first_available”
bool ext2_find_first_available(struct ext2_fs *fs, struct ext2_full_inode *dir, uint32_t *new_block);

ext2_traverse_inode_blocks

Section titled “ext2_traverse_inode_blocks”
void ext2_traverse_inode_blocks(struct ext2_fs *fs, struct ext2_inode *inode, ext2_block_visitor visitor, void *user_data, bool readahead);

ext2_g_print

Section titled “ext2_g_print”
void ext2_g_print(struct partition * *);

ext2_dump_file_data

Section titled “ext2_dump_file_data”
void ext2_dump_file_data(struct ext2_fs *fs, const struct ext2_inode *inode, uint32_t start_block_index, uint32_t length);

Variables

Section titled “Variables”

PTRS_PER_BLOCK

Section titled “PTRS_PER_BLOCK”
extern uint64_t PTRS_PER_BLOCK;

Macros

Section titled “Macros”

EXT2_PRIO_DIRENT

Section titled “EXT2_PRIO_DIRENT”
#define EXT2_PRIO_DIRENT BIO_RQ_MEDIUM

EXT2_PRIO_INODE

Section titled “EXT2_PRIO_INODE”
#define EXT2_PRIO_INODE BIO_RQ_MEDIUM

EXT2_PRIO_DATA

Section titled “EXT2_PRIO_DATA”
#define EXT2_PRIO_DATA BIO_RQ_HIGH

EXT2_PRIO_BITMAPS

Section titled “EXT2_PRIO_BITMAPS”
#define EXT2_PRIO_BITMAPS BIO_RQ_BACKGROUND

EXT2_PRIO_SBLOCK

Section titled “EXT2_PRIO_SBLOCK”
#define EXT2_PRIO_SBLOCK BIO_RQ_LOW

EXT2_NBLOCKS

Section titled “EXT2_NBLOCKS”
#define EXT2_NBLOCKS 15

EXT2_SUPERBLOCK_OFFSET

Section titled “EXT2_SUPERBLOCK_OFFSET”
#define EXT2_SUPERBLOCK_OFFSET 1024

EXT2_SIGNATURE_OFFSET

Section titled “EXT2_SIGNATURE_OFFSET”
#define EXT2_SIGNATURE_OFFSET 0x38

EXT2_SIGNATURE

Section titled “EXT2_SIGNATURE”
#define EXT2_SIGNATURE 0xEF53

EXT2_NAME_LEN

Section titled “EXT2_NAME_LEN”
#define EXT2_NAME_LEN 255

EXT2_ROOT_INODE

Section titled “EXT2_ROOT_INODE”
#define EXT2_ROOT_INODE 2

EXT2_S_IFSOCK

Section titled “EXT2_S_IFSOCK”
#define EXT2_S_IFSOCK 0xC000     // socket

EXT2_S_IFLNK

Section titled “EXT2_S_IFLNK”
#define EXT2_S_IFLNK 0xA000      // symbolic link

EXT2_S_IFREG

Section titled “EXT2_S_IFREG”
#define EXT2_S_IFREG 0x8000      // regular file

EXT2_S_IFBLK

Section titled “EXT2_S_IFBLK”
#define EXT2_S_IFBLK 0x6000      // block device

EXT2_S_IFDIR

Section titled “EXT2_S_IFDIR”
#define EXT2_S_IFDIR 0x4000      // directory

EXT2_S_IFCHR

Section titled “EXT2_S_IFCHR”
#define EXT2_S_IFCHR 0x2000      // character device

EXT2_S_IFIFO

Section titled “EXT2_S_IFIFO”
#define EXT2_S_IFIFO 0x1000      // FIFO

EXT2_S_IFMT

Section titled “EXT2_S_IFMT”
#define EXT2_S_IFMT 0xF000       // mask to extract file type from i_mode

EXT2_S_PERMS

Section titled “EXT2_S_PERMS”
#define EXT2_S_PERMS 0x0FFF      // lower 12 bits: special + rwx bits

EXT2_S_IRWXU

Section titled “EXT2_S_IRWXU”
#define EXT2_S_IRWXU 0x01C0      // owner permissions - ALL

EXT2_S_IRWXG

Section titled “EXT2_S_IRWXG”
#define EXT2_S_IRWXG 0x0038      // group permissions - ALL

EXT2_S_IRWXO

Section titled “EXT2_S_IRWXO”
#define EXT2_S_IRWXO 0x0007      // others permissions - ALL

EXT2_S_PERMS_ONLY

Section titled “EXT2_S_PERMS_ONLY”
#define EXT2_S_PERMS_ONLY 0x01FF // rwx bits only

EXT2_S_IRUSR

Section titled “EXT2_S_IRUSR”
#define EXT2_S_IRUSR 0x0100 // Owner can read

EXT2_S_IWUSR

Section titled “EXT2_S_IWUSR”
#define EXT2_S_IWUSR 0x0080 // Owner can write

EXT2_S_IXUSR

Section titled “EXT2_S_IXUSR”
#define EXT2_S_IXUSR 0x0040 // Owner can execute

EXT2_S_IRGRP

Section titled “EXT2_S_IRGRP”
#define EXT2_S_IRGRP 0x0020 // Group can read

EXT2_S_IWGRP

Section titled “EXT2_S_IWGRP”
#define EXT2_S_IWGRP 0x0010 // Group can write

EXT2_S_IXGRP

Section titled “EXT2_S_IXGRP”
#define EXT2_S_IXGRP 0x0008 // Group can execute

EXT2_S_IROTH

Section titled “EXT2_S_IROTH”
#define EXT2_S_IROTH 0x0004 // Others can read

EXT2_S_IWOTH

Section titled “EXT2_S_IWOTH”
#define EXT2_S_IWOTH 0x0002 // Others can write

EXT2_S_IXOTH

Section titled “EXT2_S_IXOTH”
#define EXT2_S_IXOTH 0x0001 // Others can execute

EXT2_FT_UNKNOWN

Section titled “EXT2_FT_UNKNOWN”
#define EXT2_FT_UNKNOWN 0  // Unknown file type

EXT2_FT_REG_FILE

Section titled “EXT2_FT_REG_FILE”
#define EXT2_FT_REG_FILE 1 // Regular file

EXT2_FT_DIR

Section titled “EXT2_FT_DIR”
#define EXT2_FT_DIR 2      // Directory

EXT2_FT_CHRDEV

Section titled “EXT2_FT_CHRDEV”
#define EXT2_FT_CHRDEV 3   // Character device

EXT2_FT_BLKDEV

Section titled “EXT2_FT_BLKDEV”
#define EXT2_FT_BLKDEV 4   // Block device

EXT2_FT_FIFO

Section titled “EXT2_FT_FIFO”
#define EXT2_FT_FIFO 5     // FIFO (named pipe)

EXT2_FT_SOCK

Section titled “EXT2_FT_SOCK”
#define EXT2_FT_SOCK 6     // Unix domain socket
Section titled “EXT2_FT_SYMLINK”
#define EXT2_FT_SYMLINK 7  // Symbolic link

EXT2_FT_MAX

Section titled “EXT2_FT_MAX”
#define EXT2_FT_MAX 8      // Number of defined file types

EXT2_SECRM_FL

Section titled “EXT2_SECRM_FL”
#define EXT2_SECRM_FL 0x00000001     // Secure deletion

EXT2_UNRM_FL

Section titled “EXT2_UNRM_FL”
#define EXT2_UNRM_FL 0x00000002      // Undelete

EXT2_COMPR_FL

Section titled “EXT2_COMPR_FL”
#define EXT2_COMPR_FL 0x00000004     // Compress file

EXT2_SYNC_FL

Section titled “EXT2_SYNC_FL”
#define EXT2_SYNC_FL 0x00000008      // Synchronous updates

EXT2_IMMUTABLE_FL

Section titled “EXT2_IMMUTABLE_FL”
#define EXT2_IMMUTABLE_FL 0x00000010 // Immutable file

EXT2_APPEND_FL

Section titled “EXT2_APPEND_FL”
#define EXT2_APPEND_FL 0x00000020    // Writes only append

EXT2_NODUMP_FL

Section titled “EXT2_NODUMP_FL”
#define EXT2_NODUMP_FL 0x00000040    // Don't include in backups

EXT2_NOATIME_FL

Section titled “EXT2_NOATIME_FL”
#define EXT2_NOATIME_FL 0x00000080   // Don't update access time

EXT2_DIRTY_FL

Section titled “EXT2_DIRTY_FL”
#define EXT2_DIRTY_FL 0x00000100        // Dirty (compress support)

EXT2_COMPRBLK_FL

Section titled “EXT2_COMPRBLK_FL”
#define EXT2_COMPRBLK_FL 0x00000200     // One or more compressed clusters

EXT2_NOCOMPR_FL

Section titled “EXT2_NOCOMPR_FL”
#define EXT2_NOCOMPR_FL 0x00000400      // Don't compress

EXT2_ECOMPR_FL

Section titled “EXT2_ECOMPR_FL”
#define EXT2_ECOMPR_FL 0x00000800       // Compression error

EXT2_IMAGIC_FL

Section titled “EXT2_IMAGIC_FL”
#define EXT2_IMAGIC_FL 0x00002000       // AFS directory

EXT2_JOURNAL_DATA_FL

Section titled “EXT2_JOURNAL_DATA_FL”
#define EXT2_JOURNAL_DATA_FL 0x00004000 // Write data to journal (data=journal)

EXT2_NOTAIL_FL

Section titled “EXT2_NOTAIL_FL”
#define EXT2_NOTAIL_FL 0x00008000    // File tail not merged (reiserfs)

EXT2_DIRSYNC_FL

Section titled “EXT2_DIRSYNC_FL”
#define EXT2_DIRSYNC_FL 0x00010000   // Directory sync updates

EXT2_TOPDIR_FL

Section titled “EXT2_TOPDIR_FL”
#define EXT2_TOPDIR_FL 0x00020000    // Top of directory hierarchy

EXT2_HUGE_FILE_FL

Section titled “EXT2_HUGE_FILE_FL”
#define EXT2_HUGE_FILE_FL 0x00040000 // Set to each huge file

EXT2_EXTENTS_FL

Section titled “EXT2_EXTENTS_FL”
#define EXT2_EXTENTS_FL 0x00080000   // Inode uses extents

EXT2_EA_INODE_FL

Section titled “EXT2_EA_INODE_FL”
#define EXT2_EA_INODE_FL 0x00200000    // Inode stores extended attributes

EXT2_INLINE_DATA_FL

Section titled “EXT2_INLINE_DATA_FL”
#define EXT2_INLINE_DATA_FL 0x10000000 // Data is stored inline in inode

EXT2_PROJINHERIT_FL

Section titled “EXT2_PROJINHERIT_FL”
#define EXT2_PROJINHERIT_FL 0x20000000 // Project ID inheritance

EXT2_RESERVED_FL

Section titled “EXT2_RESERVED_FL”
#define EXT2_RESERVED_FL 0x80000000 // Reserved for ext3/4

EXT2_FL_USER_VISIBLE

Section titled “EXT2_FL_USER_VISIBLE”
#define EXT2_FL_USER_VISIBLE 0x000BDFFF // User-visible flags

EXT2_FL_USER_MODIFIABLE

Section titled “EXT2_FL_USER_MODIFIABLE”
#define EXT2_FL_USER_MODIFIABLE \
    (EXT2_FL_USER_VISIBLE & ~(EXT2_SECRM_FL | EXT2_UNRM_FL))

MIN

Section titled “MIN”
#define MIN(x, y) ((x > y) ? y : x)

MAKE_NOP_CALLBACK

Section titled “MAKE_NOP_CALLBACK”
#define MAKE_NOP_CALLBACK \
    static bool nop_callback(struct ext2_fs *fs, struct ext2_dir_entry *entry, \
                             void *ctx_ptr, uint32_t block_num, \
                             uint32_t entry_num, uint32_t entry_offset) { \
        (void) fs; \
        (void) entry_offset; \
        (void) entry; \
        (void) ctx_ptr; \
        (void) block_num; \
        (void) entry_num; \
        return false; \
    }