X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Finclude%2Fvfs.h;h=c2f2e35b3f4b8244a8d61e709f704c69b6f3e879;hb=05a77640b59762adb12a71927ea4e003fd033102;hp=e3a61d4359394773a110b150f0fa15d0d4503008;hpb=775bf8013abe9fe4ef3d4883ea2e43bba2a84da1;p=tpg%2Facess2.git diff --git a/Kernel/include/vfs.h b/Kernel/include/vfs.h index e3a61d43..c2f2e35b 100644 --- a/Kernel/include/vfs.h +++ b/Kernel/include/vfs.h @@ -67,7 +67,7 @@ */ /** - * \brief VFS Node + * \brief Represents a node (file or directory) in the VFS tree * * This structure provides the VFS with the functions required to read/write * the file (or directory) that it represents. @@ -99,10 +99,18 @@ typedef struct sVFS_Node Uint32 Flags; //!< File Flags /** - * Pointer to cached data (FS Specific) - * \note Inode_* will free when the node is uncached this if needed + * \brief Pointer to cached data (FS Specific) + * \note The Inode_* functions will free when the node is uncached + * this if needed */ void *Data; + + /** + * \brief Node mutex + * \note Provided for the Filesystem driver's use + */ + tMutex Lock; + /** * \} */ @@ -160,7 +168,7 @@ typedef struct sVFS_Node int (*IOCtl)(struct sVFS_Node *Node, int Id, void *Data); /** - * } + * \} */ /** @@ -190,7 +198,7 @@ typedef struct sVFS_Node Uint64 (*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer); /** - * } + * \} */ /** @@ -205,7 +213,7 @@ typedef struct sVFS_Node * \note The node returned must be accessable until ::tVFS_Node.Close * is called and ReferenceCount reaches zero. */ - struct sVFS_Node *(*FindDir)(struct sVFS_Node *Node, char *Name); + struct sVFS_Node *(*FindDir)(struct sVFS_Node *Node, const char *Name); /** * \brief Read from a directory @@ -224,9 +232,9 @@ typedef struct sVFS_Node * \param Node Pointer to this node * \param Name Name of the new child * \param Flags Flags to apply to the new child (directory or symlink) - * \return Boolean success + * \return Zero on Success, non-zero on error (see errno.h) */ - int (*MkNod)(struct sVFS_Node *Node, char *Name, Uint Flags); + int (*MkNod)(struct sVFS_Node *Node, const char *Name, Uint Flags); /** * \brief Relink (Rename/Remove) a file/directory @@ -235,10 +243,19 @@ typedef struct sVFS_Node * \param NewName New name (or NULL if unlinking is wanted) * \return Zero on Success, non-zero on error (see errno.h) */ - int (*Relink)(struct sVFS_Node *Node, char *OldName, char *NewName); + int (*Relink)(struct sVFS_Node *Node, const char *OldName, const char *NewName); + + /** + * \brief Link a node to a name + * \param Node Pointer to this node (directory) + * \param Child Node to create a new link to + * \param NewName Name for the new link + * \return Zeron on success, non-zero on error (see errno.h) + */ + int (*Link)(struct sVFS_Node *Node, struct sVFS_Node *Child, const char *NewName); /** - * } + * \} */ } tVFS_Node; @@ -316,11 +333,11 @@ extern tVFS_ACL *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group); * \{ */ /** - * \fn int Inode_GetHandle() + * \fn int Inode_GetHandle(void) * \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(); +extern int Inode_GetHandle(void); /** * \fn tVFS_Node *Inode_GetCache(int Handle, Uint64 Inode) * \brief Gets an inode from the node cache