dentry.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <mos/filesystem/fs_types.h>
#include <mos/filesystem/vfs_types.hpp>
#include <mos/lib/structures/list.hpp>
#include <mos/mos_global.h>

 
typedef enum
{
    // bit 0, 1: the operation only succeeds if the inode is a...
    RESOLVE_EXPECT_FILE = 1 << 0,
    RESOLVE_EXPECT_DIR = 1 << 1,
    RESOLVE_EXPECT_ANY_TYPE = RESOLVE_EXPECT_FILE | RESOLVE_EXPECT_DIR,
 
    // bit 2: follow symlinks?
    // only for the last segment, (if it is a symlink)
    RESOLVE_SYMLINK_NOFOLLOW = 1 << 2,
 
    // bit 3, 4: the operation only succeeds if...
    RESOLVE_EXPECT_EXIST = 1 << 3,
    RESOLVE_EXPECT_NONEXIST = 1 << 4,
    RESOLVE_EXPECT_ANY_EXIST = RESOLVE_EXPECT_EXIST | RESOLVE_EXPECT_NONEXIST,
} lastseg_resolve_flags_t;
 
MOS_ENUM_OPERATORS(lastseg_resolve_flags_t)
 

should_inline bool path_is_absolute(const char *path)
{
    return path[0] == '/';
}
 
should_inline dentry_t *dentry_parent(const dentry_t &dentry)
{
    return tree_parent(&dentry, dentry_t);
}

void dentry_check_refstat(const dentry_t *dentry);
typedef void(dump_refstat_receiver_t)(int depth, const dentry_t *dentry, bool mountroot, void *data);
void dentry_dump_refstat(const dentry_t *dentry, dump_refstat_receiver_t receiver, void *data);

dentry_t *dentry_ref(dentry_t *dentry);

dentry_t *dentry_ref_up_to(dentry_t *dentry, dentry_t *root);

void dentry_unref(dentry_t *dentry);
__nodiscard bool dentry_unref_one_norelease(dentry_t *dentry);
void dentry_try_release(dentry_t *dentry);

void dentry_attach(dentry_t *d, inode_t *inode);

void dentry_detach(dentry_t *dentry);

PtrResult<dentry_t> dentry_from_fd(fd_t fd);

PtrResult<dentry_t> dentry_lookup_child(dentry_t *parent, const char *name);

PtrResult<dentry_t> dentry_resolve(dentry_t *starting_dir, dentry_t *root_dir, const char *path, lastseg_resolve_flags_t flags);

__nodiscard bool dentry_mount(dentry_t *mountpoint, dentry_t *root, filesystem_t *fs);

__nodiscard dentry_t *dentry_unmount(dentry_t *root);

void vfs_populate_listdir_buf(dentry_t *dir, vfs_listdir_state_t *state);

ssize_t dentry_path(dentry_t *dentry, dentry_t *root, char *buf, size_t size);