X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=KernelLand%2FKernel%2Finclude%2Fvfs.h;h=4be24c383655cb3856b740f081e8204f1802b025;hb=2015e19b71476d1fee2480aef4de60d22ed5438d;hp=1aa073b26c76f9b306812fdf359ba865a118dd1d;hpb=51ab5f489bc356940c95cc936fd0508e8f07ea97;p=tpg%2Facess2.git

diff --git a/KernelLand/Kernel/include/vfs.h b/KernelLand/Kernel/include/vfs.h
index 1aa073b2..4be24c38 100644
--- a/KernelLand/Kernel/include/vfs.h
+++ b/KernelLand/Kernel/include/vfs.h
@@ -20,6 +20,7 @@
 #define _VFS_H
 
 #include <acess.h>
+#include <mutex.h>
 
 /**
  * \brief Thread list datatype for VFS_Select
@@ -77,7 +78,15 @@ typedef struct sVFS_NodeType	tVFS_NodeType;
  * is unmapped. Nice for read-only files and memory-only files (or 
  * pseudo-readonly filesystems)
  */
-#define VFS_FFLAG_NOWRITEBACK
+#define VFS_FFLAG_NOWRITEBACK	0x1000
+
+/**
+ * \brief "Dirty Metadata" Flag
+ *
+ * Indicates that the node's metadata has been altered since the flag was last
+ * cleared. Tells the driver that it should update the inode at the next flush.
+ */
+#define VFS_FFLAG_DIRTY 	0x8000
 /**
  * \}
  */
@@ -90,6 +99,11 @@ typedef struct sVFS_NodeType	tVFS_NodeType;
  */
 typedef struct sVFS_Node
 {
+	/**
+	 * \brief Functions associated with the node
+	 */
+	tVFS_NodeType	*Type;
+	
 	/**
 	 * \name Identifiers
 	 * \brief Fields used by the driver to identify what data this node
@@ -135,9 +149,9 @@ typedef struct sVFS_Node
 	 * \name Times
 	 * \{
 	 */
-	Sint64	ATime;	//!< Last Accessed Time
-	Sint64	MTime;	//!< Last Modified Time
-	Sint64	CTime;	//!< Creation Time
+	tTime	ATime;	//!< Last Accessed Time
+	tTime	MTime;	//!< Last Modified Time
+	tTime	CTime;	//!< Creation Time
 	/**
 	 * \}
 	 */
@@ -178,13 +192,30 @@ typedef struct sVFS_Node
 	/**
 	 * \}
 	 */
-	
-	/**
-	 * \brief Functions associated with the node
-	 */
-	tVFS_NodeType	*Type;
 } tVFS_Node;
 
+/**
+ * \name tVFS_NodeType.FindDir Flags
+ * \brief 
+ * \{
+ */
+//\! Attempt non-blocking IO
+#define VFS_IOFLAG_NOBLOCK	0x001
+/**
+ * \}
+ */
+
+/**
+ * \name tVFS_NodeType.FindDir Flags
+ * \brief 
+ * \{
+ */
+//\! Call was triggered by VFS_Stat (as opposed to open)
+#define VFS_FDIRFLAG_STAT	0x001
+/**
+ * \}
+ */
+
 /**
  * \brief Functions for a specific node type
  */
@@ -242,7 +273,7 @@ struct sVFS_NodeType
 	 * \param Buffer	Destination for read data
 	 * \return Number of bytes read
 	 */
-	Uint64	(*Read)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
+	size_t	(*Read)(struct sVFS_Node *Node, off_t Offset, size_t Length, void *Buffer, Uint Flags);
 	/**
 	 * \brief Write to the file
 	 * \param Node	Pointer to this node
@@ -251,7 +282,7 @@ struct sVFS_NodeType
 	 * \param Buffer	Source of written data
 	 * \return Number of bytes read
 	 */
-	Uint64	(*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, const void *Buffer);
+	size_t	(*Write)(struct sVFS_Node *Node, off_t Offset, size_t Length, const void *Buffer, Uint Flags);
 
 	/**
 	 * \brief Map a region of a file into memory
@@ -262,7 +293,7 @@ struct sVFS_NodeType
 	 * \return Boolean Failure
 	 * \note If NULL, the VFS implements it using .Read
 	 */
-	 int	(*MMap)(struct sVFS_Node *Node, Uint64 Offset, int Length, void *Dest);
+	 int	(*MMap)(struct sVFS_Node *Node, off_t Offset, int Length, void *Dest);
 	
 	/**
 	 * \}
@@ -277,49 +308,45 @@ struct sVFS_NodeType
 	 * \param Node	Pointer to this node
 	 * \param Name	Name of the file wanted
 	 * \return Pointer to the requested node or NULL if it cannot be found
-	 * \note The node returned must be accessable until ::tVFS_Node.Close
+	 * \note The node returned must be accessable until tVFS_NodeType::Close
 	 *       is called and ReferenceCount reaches zero.
 	 */
-	struct sVFS_Node	*(*FindDir)(struct sVFS_Node *Node, const char *Name);
+	struct sVFS_Node	*(*FindDir)(struct sVFS_Node *Node, const char *Name, Uint Flags);
 	
 	/**
 	 * \brief Read from a directory
 	 * \param Node	Pointer to this node
 	 * \param Pos	Offset in the directory
-	 * \return Pointer to the name of the item on the heap (will be freed
-	 *         by the caller). If the directory end has been reached, NULL
-	 *         will be returned.
-	 *         If an item is required to be skipped either &::NULLNode,
-	 *         ::VFS_SKIP or ::VFS_SKIPN(0...1023) will be returned.
+	 * \param Dest	Destination for filename
+	 * \return Zero on success, negative on error or +ve for ignore entry
 	 */
-	char	*(*ReadDir)(struct sVFS_Node *Node, int Pos);
+	 int	(*ReadDir)(struct sVFS_Node *Node, int Pos, char Dest[FILENAME_MAX]);
 	
 	/**
 	 * \brief Create a node in a directory
 	 * \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 Zero on Success, non-zero on error (see errno.h)
+	 * \return Created node or NULL on error
 	 */
-	 int	(*MkNod)(struct sVFS_Node *Node, const char *Name, Uint Flags);
+	tVFS_Node	*(*MkNod)(struct sVFS_Node *Node, const char *Name, Uint Mode);
 	
 	/**
 	 * \brief Relink (Rename/Remove) a file/directory
 	 * \param Node	Pointer to this node
 	 * \param OldName	Name of the item to move/delete
-	 * \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, const char *OldName, const char *NewName);
+	 int	(*Unlink)(struct sVFS_Node *Node, const char *OldName);
 	
 	/**
 	 * \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
-	 * \retur Zeron on success, non-zero on error (see errno.h)
+	 * \param Child	Node to create a new link to
+	 * \return Zero on success, non-zero on error (see errno.h)
 	 */
-	 int	(*Link)(struct sVFS_Node *Node, struct sVFS_Node *Child, const char *NewName);
+	 int	(*Link)(struct sVFS_Node *Node, const char *NewName, struct sVFS_Node *Child);
 	 
 	 /**
 	  * \}
@@ -340,6 +367,15 @@ typedef struct sVFS_Driver
 	 */
 	Uint	Flags;
 	
+	/**
+	 * \brief Detect if a volume is accessible using this driver
+	 * \return Boolean success (with higher numbers being higher priority)
+	 *
+	 * E.g. FAT would return 1 as it's the lowest common denominator while ext2 might return 2,
+	 * because it can be embedded in a FAT volume (and is a more fully featured filesystem).
+	 */
+	 int	(*Detect)(int FD);
+
 	/**
 	 * \brief Callback to mount a device
 	 */
@@ -433,7 +469,7 @@ extern tVFS_ACL	*VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group);
  * \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)
+ * \return Bitset of Type flags that applied
  */
 extern int	VFS_SelectNode(tVFS_Node *Node, int Type, tTime *Timeout, const char *Name);
 
@@ -460,12 +496,17 @@ extern int	VFS_MarkError(tVFS_Node *Node, BOOL IsErrorState);
  * fast cleanup when a filesystem is unmounted.
  * \{
  */
+
+typedef struct sInodeCache	tInodeCache;
+
+typedef void	(*tInode_CleanUpNode)(tVFS_Node *Node);
+
 /**
  * \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(void);
+extern tInodeCache	*Inode_GetHandle(tInode_CleanUpNode CleanUpNode);
 /**
  * \fn tVFS_Node *Inode_GetCache(int Handle, Uint64 Inode)
  * \brief Gets an inode from the node cache
@@ -473,7 +514,7 @@ extern int	Inode_GetHandle(void);
  * \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);
+extern tVFS_Node	*Inode_GetCache(tInodeCache *Handle, Uint64 Inode);
 /**
  * \fn tVFS_Node *Inode_CacheNode(int Handle, tVFS_Node *Node)
  * \brief Caches a node in the Node Cache
@@ -481,20 +522,22 @@ extern tVFS_Node	*Inode_GetCache(int Handle, Uint64 Inode);
  * \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);
+extern tVFS_Node	*Inode_CacheNode(tInodeCache *Handle, tVFS_Node *Node);
+extern tVFS_Node	*Inode_CacheNodeEx(tInodeCache *Handle, tVFS_Node *Node, size_t Size);
 /**
  * \fn int 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
+ * \return -1: Error (not present), 0: Not freed, 1: Freed
  */
-extern void	Inode_UncacheNode(int Handle, Uint64 Inode);
+extern int	Inode_UncacheNode(tInodeCache *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);
+extern void	Inode_ClearCache(tInodeCache *Handle);
 
 /**
  * \}