/*
- * Acess Micro - VFS Server Ver 1
+ * Acess2
+ * VFS Common Header
+ */
+/**
+ * \file vfs.h
+ * \brief Acess VFS Layer
*/
#ifndef _VFS_H
#define _VFS_H
#include <common.h>
+//! \name ACL Permissions
+//! \{
+/**
+ * \brief Readable
+ */
#define VFS_PERM_READ 0x00000001
+/**
+ * \brief Writeable
+ */
#define VFS_PERM_WRITE 0x00000002
+/**
+ * \brief Append allowed
+ */
#define VFS_PERM_APPEND 0x00000004
+/**
+ * \brief Executable
+ */
#define VFS_PERM_EXECUTE 0x00000008
+/**
+ * \brief All permissions granted
+ */
#define VFS_PERM_ALL 0x7FFFFFFF // Mask for permissions
+/**
+ * \brief Denies instead of granting permissions
+ * \note Denials take precedence
+ */
#define VFS_PERM_DENY 0x80000000 // Inverts permissions
+//! \}
-typedef struct sVFS_ACL {
+/**
+ * \brief ACL Defintion Structure
+ */
+typedef struct sVFS_ACL
+{
struct {
- unsigned Group: 1; // Group (as opposed to user) flag
- unsigned ID: 31; // ID of Group/User (-1 for nobody/world)
+ unsigned Group: 1; //!< Group (as opposed to user) flag
+ unsigned ID: 31; //!< ID of Group/User (-1 for nobody/world)
};
struct {
- unsigned Inv: 1; // Invert Permissions
- unsigned Perms: 31; // Permission Flags
+ unsigned Inv: 1; //!< Invert Permissions
+ unsigned Perms: 31; //!< Permission Flags
};
} tVFS_ACL;
-#define VFS_FFLAG_READONLY 0x01
-#define VFS_FFLAG_DIRECTORY 0x02
-#define VFS_FFLAG_SYMLINK 0x04
+/**
+ * \name VFS Node Flags
+ * \{
+ */
+#define VFS_FFLAG_READONLY 0x01 //!< Read-only file
+#define VFS_FFLAG_DIRECTORY 0x02 //!< Directory
+#define VFS_FFLAG_SYMLINK 0x04 //!< Symbolic Link
+/**
+ * \}
+ */
-typedef struct sVFS_Node {
- //char *Name; //!< Node's Name (UTF-8)
-
+/**
+ * \brief VFS Node
+ */
+typedef struct sVFS_Node {
Uint64 Inode; //!< Inode ID
Uint ImplInt; //!< Implementation Usable Integer
void *ImplPtr; //!< Implementation Usable Pointer
//! Send an IO Control
int (*IOCtl)(struct sVFS_Node *Node, int Id, void *Data);
+ //! \brief Read from the file
Uint64 (*Read)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
+ //! \brief Write to the file
Uint64 (*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
- //! Find an directory entry by name
+ //! \brief Find an directory entry by name
+ //! \note The node returned must be accessable until ::tVFS_Node.Close is called
struct sVFS_Node *(*FindDir)(struct sVFS_Node *Node, char *Name);
- //! Read from a directory - MUST return a heap address
+
+ //! \brief Read from a directory
+ //! \note MUST return a heap address
char *(*ReadDir)(struct sVFS_Node *Node, int Pos);
- //! Create a node in a directory
+
+ //! \brief Create a node in a directory
int (*MkNod)(struct sVFS_Node *Node, char *Name, Uint Flags);
- //! Relink (Rename/Remove) a file/directory
+
+ //! \brief Relink (Rename/Remove) a file/directory
int (*Relink)(struct sVFS_Node *Node, char *OldName, char *NewName);
//!< \todo Complete
/**
* \brief VFS Driver (Filesystem) Definition
*/
-typedef struct sVFS_Driver {
+typedef struct sVFS_Driver
+{
+ //! \brief Unique Identifier for this filesystem type
char *Name;
+ //! \brief Flags applying to this driver
Uint Flags;
+
+ //! \brief Callback to mount a device
tVFS_Node *(*InitDevice)(char *Device, char **Options);
+ //! \brief Callback to unmount a device
void (*Unmount)(tVFS_Node *Node);
+ //! \brief Used internally (next driver in the chain)
struct sVFS_Driver *Next;
} tVFS_Driver;
// === GLOBALS ===
+//! \brief Maximum number of elements that can be skipped in one return
#define VFS_MAXSKIP ((void*)1024)
+//! \brief Skip a single entry in readdir
#define VFS_SKIP ((void*)1)
+//! \brief Skip \a n entries in readdir
#define VFS_SKIPN(n) ((void*)(n))
-extern tVFS_Node NULLNode;
-extern tVFS_ACL gVFS_ACL_EveryoneRWX;
-extern tVFS_ACL gVFS_ACL_EveryoneRW;
-extern tVFS_ACL gVFS_ACL_EveryoneRX;
-extern tVFS_ACL gVFS_ACL_EveryoneRO;
+
+extern tVFS_Node NULLNode; //!< NULL VFS Node (Ignored/Skipped)
+/**
+ * \name Simple ACLs to aid writing drivers
+ * \{
+ */
+extern tVFS_ACL gVFS_ACL_EveryoneRWX; //!< Everyone Read/Write/Execute
+extern tVFS_ACL gVFS_ACL_EveryoneRW; //!< Everyone Read/Write
+extern tVFS_ACL gVFS_ACL_EveryoneRX; //!< Everyone Read/Execute
+extern tVFS_ACL gVFS_ACL_EveryoneRO; //!< Everyone Read only
+/**
+ * \}
+ */
// === FUNCTIONS ===
+/**
+ * \fn int VFS_AddDriver(tVFS_Driver *Info)
+ * \brief Registers the driver with the DevFS layer
+ * \param Info Driver information structure
+ */
extern int VFS_AddDriver(tVFS_Driver *Info);
+/**
+ * \fn tVFS_Driver *VFS_GetFSByName(char *Name)
+ * \brief Get the information structure of a driver given its name
+ * \param Name Name of filesystem driver to find
+ */
extern tVFS_Driver *VFS_GetFSByName(char *Name);
+/**
+ * \fn tVFS_ACL *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group)
+ * \brief Transforms Unix Permssions into Acess ACLs
+ * \param Mode Unix RWXrwxRWX mask
+ * \param Owner UID of the file's owner
+ * \param Group GID of the file's owning group
+ * \return An array of 3 Acess ACLs
+ */
extern tVFS_ACL *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group);
// --- Node Cache --
+//! \name Node Cache
+//! \{
+/**
+ * \fn int Inode_GetHandle()
+ * \brief Gets a unique handle to the Node Cache
+ * \return A unique handle for use for the rest of the Inode_* functions
+ */
extern int Inode_GetHandle();
+/**
+ * \fn tVFS_Node *Inode_GetCache(int Handle, Uint64 Inode)
+ * \brief Gets an inode from the node cache
+ * \param Handle A handle returned by Inode_GetHandle()
+ * \param Inode Value of the Inode field of the ::tVFS_Node you want
+ * \return A pointer to the cached node
+ */
extern tVFS_Node *Inode_GetCache(int Handle, Uint64 Inode);
+/**
+ * \fn tVFS_Node *Inode_CacheNode(int Handle, tVFS_Node *Node)
+ * \brief Caches a node in the Node Cache
+ * \param Handle A handle returned by Inode_GetHandle()
+ * \param Node A pointer to the node to be cached (a copy is taken)
+ * \return A pointer to the node in the node cache
+ */
extern tVFS_Node *Inode_CacheNode(int Handle, tVFS_Node *Node);
+/**
+ * \fn void Inode_UncacheNode(int Handle, Uint64 Inode)
+ * \brief Dereferences (and removes if needed) a node from the cache
+ * \param Handle A handle returned by Inode_GetHandle()
+ * \param Inode Value of the Inode field of the ::tVFS_Node you want to remove
+ */
extern void Inode_UncacheNode(int Handle, Uint64 Inode);
+/**
+ * \fn void Inode_ClearCache(int Handle)
+ * \brief Clears the cache for a handle
+ * \param Handle A handle returned by Inode_GetHandle()
+ */
extern void Inode_ClearCache(int Handle);
+//! \}
+
#endif
git.ucc.asn.au / tpg / acess2.git / blobdiff
UCC git Repository :: git.ucc.asn.au