vfsobj.h

Go to the documentation of this file.

 
 
#pragma once
// This header file is auto-generated!
// Do not make changes to this file or they will be overwritten.
// clang-format off
#include <cx/obj.h>
#include <cx/struct.h>
#include <cx/thread/atomic.h>
#include <cx/thread/rwlock.h>
 
CX_C_BEGIN
 
typedef struct VFSDir VFSDir;
typedef struct VFS VFS;
typedef struct VFS_WeakRef VFS_WeakRef;
typedef struct VFSMount VFSMount;
typedef struct VFSMount_WeakRef VFSMount_WeakRef;
saDeclarePtr(VFS);
saDeclarePtr(VFS_WeakRef);
#define _sti_VFS _sti_object
#define SType_VFS VFS*
#define STStorageType_VFS VFS*
#define STypeArg_VFS(type, val) stgeneric(object, (ObjInst*)objInstCheckClass(VFS, val))
#define STypeArgPtr_VFS(type, val) (stgeneric*)objInstCheckClassPtr(VFS, val)
#define STypeCheckedArg_VFS(type, val)    stType(type), stArg(type, val)
#define STypeCheckedPtrArg_VFS(type, val) stType(type), stArgPtr(type, val)
saDeclarePtr(VFSMount);
saDeclarePtr(VFSMount_WeakRef);
#define _sti_VFSMount _sti_object
#define SType_VFSMount VFSMount*
#define STStorageType_VFSMount VFSMount*
#define STypeArg_VFSMount(type, val) stgeneric(object, (ObjInst*)objInstCheckClass(VFSMount, val))
#define STypeArgPtr_VFSMount(type, val) (stgeneric*)objInstCheckClassPtr(VFSMount, val)
#define STypeCheckedArg_VFSMount(type, val)    stType(type), stArg(type, val)
#define STypeCheckedPtrArg_VFSMount(type, val) stType(type), stArgPtr(type, val)
 
typedef struct VFSDirCache {
    atomic(int64) lastprune;   
    atomic(uint32) dircount;   
    uint32 maxdirs;            
    int64 ttl;                 
} VFSDirCache;
 
typedef struct VFS {
    union {
        ObjIface* _;
        void* _is_VFS;
        void* _is_ObjInst;
    };
    ObjClassInfo* _clsinfo;
    atomic(uintptr) _ref;
    atomic(ptr) _weakref;
 
    VFSDir* root;        
    hashtable namespaces;        
    string curdir;        
    // Two locks, and vfsdlock is always the outer one: a thread may take vfsdlock and then
    // vfslock, never the reverse.
    //     // vfslock guards additions to the directory cache and the curdir string. vfsdlock guards
    // operations that destroy VFSDir entries or remove mounts. The invariant that makes that
    // split work is stronger than it looks and is not enforced anywhere: every reader that
    // walks the directory tree takes vfsdlock for read first, so holding vfsdlock for write is
    // by itself exclusive against all of them. That is why the mount and unmount paths mutate
    // the subdirs and files hashtables with vfslock never taken at all. A new code path that
    // takes only vfslock and then touches the tree breaks this.
    RWLock vfslock;
    RWLock vfsdlock;
    uint32 mountgen;
    uint32 flags;
    VFSDirCache dcache;        
} VFS;
extern ObjClassInfo VFS_clsinfo;
#define VFS(inst) objInstCheckClass(VFS, inst)
#define VFSNone ((VFS*)NULL)
 
typedef struct VFS_WeakRef {
    union {
        ObjInst* _inst;
        void* _is_VFS_WeakRef;
        void* _is_ObjInst_WeakRef;
    };
    atomic(uintptr) _ref;
    RWLock _lock;
} VFS_WeakRef;
#define VFS_WeakRef(inst) objWeakRefCheckClass(VFS, inst)
 
_objfactory_guaranteed VFS* VFS_create(uint32 flags);
#define vfsCreate(flags) VFS_create(flags)
 
_objfactory_check VFS* VFS_createFromFS();
#define vfsCreateFromFS() VFS_createFromFS()
 
 
typedef struct VFSMount {
    union {
        ObjIface* _;
        void* _is_VFSMount;
        void* _is_ObjInst;
    };
    ObjClassInfo* _clsinfo;
    atomic(uintptr) _ref;
    atomic(ptr) _weakref;
 
    ObjInst* provider;
    uint32 flags;
} VFSMount;
extern ObjClassInfo VFSMount_clsinfo;
#define VFSMount(inst) objInstCheckClass(VFSMount, inst)
#define VFSMountNone ((VFSMount*)NULL)
 
typedef struct VFSMount_WeakRef {
    union {
        ObjInst* _inst;
        void* _is_VFSMount_WeakRef;
        void* _is_ObjInst_WeakRef;
    };
    atomic(uintptr) _ref;
    RWLock _lock;
} VFSMount_WeakRef;
#define VFSMount_WeakRef(inst) objWeakRefCheckClass(VFSMount, inst)
 
_objfactory_guaranteed VFSMount* VFSMount_create(ObjInst* provider, uint32 flags);
// VFSMount* vfsmountCreate(ObjInst* provider, uint32 flags);
#define vfsmountCreate(provider, flags) VFSMount_create(ObjInst(provider), flags)
 
 
CX_C_END