X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Finclude%2Fvfs.h;h=248a1ac901d65d60c3fa5e2d345a026b86c5fd72;hb=59b806f4193cbda2da7aa6a1c004cd19de5e33bd;hp=f6659430c6070596e4ceafbb6886b8f085e823bb;hpb=dea6bcf35a3f52396724d74e47f71cb3afade37c;p=tpg%2Facess2.git diff --git a/Kernel/include/vfs.h b/Kernel/include/vfs.h index f6659430..248a1ac9 100644 --- a/Kernel/include/vfs.h +++ b/Kernel/include/vfs.h @@ -21,6 +21,11 @@ #include +/** + * \brief Thread list datatype for VFS_Select + */ +typedef struct sVFS_SelectList tVFS_SelectList; + /** * \name tVFS_Node Flags * \brief Flag values for tVFS_Node.Flags @@ -62,6 +67,15 @@ * inherit the GID of the parent. */ #define VFS_FFLAG_SETGID 0x10 + +/** + * \brief "Don't do Write-Back" Flag + * + * Stops the VFS from calling tVFS_Node.Write on dirty pages when a region + * is unmapped. Nice for read-only files and memory-only files (or + * pseudo-readonly filesystems) + */ +#define VFS_FFLAG_NOWRITEBACK /** * \} */ @@ -104,6 +118,13 @@ typedef struct sVFS_Node * this if needed */ void *Data; + + /** + * \brief Node mutex + * \note Provided for the Filesystem driver's use + */ + tMutex Lock; + /** * \} */ @@ -120,7 +141,7 @@ typedef struct sVFS_Node */ /** - * \name Access controll + * \name Access control * \{ */ tUID UID; //!< ID of Owning User @@ -132,6 +153,20 @@ typedef struct sVFS_Node * \} */ + /** + * \name VFS_Select() fields + * \{ + */ + int DataAvaliable; + tVFS_SelectList *ReadThreads; //!< Threads waiting to read + int BufferFull; + tVFS_SelectList *WriteThreads; //!< Threads waiting to write + int ErrorOccurred; + tVFS_SelectList *ErrorThreads; //!< Threads waiting for an error + /** + * \} + */ + /** * \name Common Functions * \brief Functions that are used no matter the value of .Flags @@ -189,6 +224,17 @@ typedef struct sVFS_Node * \return Number of bytes read */ Uint64 (*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer); + + /** + * \brief Map a region of a file into memory + * \param Node Pointer to this node + * \param Offset Start of the region (page aligned) + * \param Length Length of the region (page aligned) + * \param Dest Location to which to map + * \return Boolean Failure + * \note If NULL, the VFS implements it using .Read + */ + int (*MMap)(struct sVFS_Node *Node, Uint64 Offset, int Length, void *Dest); /** * \} @@ -206,7 +252,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 @@ -227,7 +273,7 @@ typedef struct sVFS_Node * \param Flags Flags to apply to the new child (directory or symlink) * \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 @@ -236,7 +282,7 @@ 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 @@ -245,7 +291,7 @@ typedef struct sVFS_Node * \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, char *NewName); + int (*Link)(struct sVFS_Node *Node, struct sVFS_Node *Child, const char *NewName); /** * \} @@ -258,12 +304,12 @@ typedef struct sVFS_Node typedef struct sVFS_Driver { //! \brief Unique Identifier for this filesystem type - char *Name; + const char *Name; //! \brief Flags applying to this driver Uint Flags; //! \brief Callback to mount a device - tVFS_Node *(*InitDevice)(char *Device, char **Options); + tVFS_Node *(*InitDevice)(const char *Device, const char **Options); //! \brief Callback to unmount a device void (*Unmount)(tVFS_Node *Node); //! \brief Used internally (next driver in the chain) @@ -304,7 +350,21 @@ extern int VFS_AddDriver(tVFS_Driver *Info); * \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); +extern tVFS_Driver *VFS_GetFSByName(const char *Name); + + +/** + * \brief Prepare a node for use + */ +extern void VFS_InitNode(tVFS_Node *Node); + +/** + * \brief Clean up a node, ready for deletion + * \note This should ALWAYS be called before a node is freed, as it + * cleans up VFS internal structures. + */ +extern void VFS_CleanupNode(tVFS_Node *Node); + /** * \fn tVFS_ACL *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group) * \brief Transforms Unix Permssions into Acess ACLs @@ -315,6 +375,34 @@ extern tVFS_Driver *VFS_GetFSByName(char *Name); */ extern tVFS_ACL *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group); +/** + * \brief Flags fro \a TypeFlag of VFS_SelectNode + * \{ + */ +#define VFS_SELECT_READ 0x01 +#define VFS_SELECT_WRITE 0x02 +#define VFS_SELECT_ERROR 0x04 +/** + * \} + */ + +/** + * \brief Wait for an event on a node + * \param Node Node to wait on + * \param Type Type of wait + * \param Timeout Time to wait (NULL for infinite wait) + * \param Name Name to show in debug output + * \return Number of nodes that actioned (0 or 1) + */ +extern int VFS_SelectNode(tVFS_Node *Node, int Type, tTime *Timeout, const char *Name); + +/** + * \brief Change the full flag on a node + */ +extern int VFS_MarkFull(tVFS_Node *Node, BOOL IsBufferFull); +extern int VFS_MarkAvaliable(tVFS_Node *Node, BOOL IsDataAvaliable); +extern int VFS_MarkError(tVFS_Node *Node, BOOL IsErrorState); + // --- Node Cache -- /** * \name Node Cache