inode.h

Go to the documentation of this file.

/*
 * TARFS - Immutable (read-only) filesystem for embedded systems.
 *
 * Copyright (c) 2026 Viacheslav Logunov
 * SPDX-License-Identifier: MMIT
 *
 * Author:
 *   Viacheslav Logunov <vvb333007@gmail.com>
 *
 * Project:
 *   https://github.com/vvb333007/tarfs
 *
 * @file inode.h
 * @brief Public inode API
 *
 */
 
 
#pragma once
 
#include <stdint.h>
#include <time.h>
#include "tar.h"
 
typedef struct tarfs_inode  {
 
  uint32_t   in_hash;    
  uintptr_t  in_path;    
  uintptr_t  in_vaddr;   
  uintptr_t  in_dvaddr;  
  struct tarfs_inode *in_next;   
} tarfs_inode_t;
 
 
 
struct tarfs_fs;
 
 
#ifdef __cplusplus
extern "C" {
#endif
tart_t inode_getinfo(struct tarfs_inode const * const *index,
                     int idx,
                     size_t *size,
                     time_t *mtime);
 
/* 
 * variant of inode_getinfo() which works with raw pointers to inodes 
 * Not MT-Safe. Must be called under addref protocol only
 */
tart_t inode_type(struct tarfs_inode const *ino);
 
/* 
 * variant of inode_type() which returns raw type (i.e. it can be TART_SYMLINK and TART_HARDLINK)
 * Not MT-Safe. Must be called under addref protocol only
 */
tart_t inode_rawtype(struct tarfs_inode const *ino);
 
 
/* Check if inode (raw inode pointer) is one of two link-type inodes
 * Not MT-Safe. Must be called under addref protocol only
 *
 */
bool inode_islink(struct tarfs_inode const *ino);
 
 

int inode_lookup(struct tarfs_inode const * const *index,
                 size_t num_inodes,
                 const char *path);
 
 
 
 

struct tarfs_inode **inode_alloc(size_t count);
 

void inode_free(struct tarfs_inode **index,
                size_t count,
                uintptr_t tar_start,
                size_t tar_length);
 

void inode_unmount(struct tarfs_fs *fs,
                   const void *tar_start,
                   size_t tar_size);
 
 

int inode_mount(struct tarfs_fs *fs,
                const unsigned char *buf,
                size_t size,
                const char *rebase_link,
                const char *path_rebase);
 

void inode_dumphash_sorted(struct tarfs_inode const * const *index,
                           size_t count);

void inode_dumppath_sorted(struct tarfs_inode const *root);
#ifdef __cplusplus
};
#endif