X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Finclude%2Fvfs.h;h=8618a048993e5471ad8f59e050000035d68cf26c;hb=9d85201216cb35e1b1e051b1d7cdc38eaa5befa4;hp=47cbe190f983c4ef03a2cc778120d756010d4d50;hpb=cf4418f1fcdd441e639d6b95afda42dd74db5f7c;p=tpg%2Facess2.git

diff --git a/Kernel/include/vfs.h b/Kernel/include/vfs.h
index 47cbe190..8618a048 100644
--- a/Kernel/include/vfs.h
+++ b/Kernel/include/vfs.h
@@ -44,17 +44,36 @@
  * Marks a file as a symbolic link
  */
 #define VFS_FFLAG_SYMLINK	0x04
+/**
+ * \brief Set User ID Flag
+ * 
+ * Allows an executable file to change it's executing user to the file's
+ * owner.
+ * In the case of a directory, it means that all immediate children will
+ * inherit the UID of the parent.
+ */
+#define VFS_FFLAG_SETUID	0x08
+/**
+ * \brief Set Group ID Flag
+ * 
+ * Allows an executable file to change it's executing group to the file's
+ * owning group.
+ * In the case of a directory, it means that all immediate children will
+ * inherit the GID of the parent.
+ */
+#define VFS_FFLAG_SETGID	0x10
 /**
  * \}
  */
 
 /**
- * \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.
  */
-typedef struct sVFS_Node {
+typedef struct sVFS_Node
+{
 	/**
 	 * \name Identifiers
 	 * \brief Fields used by the driver to identify what data this node
@@ -68,12 +87,34 @@ typedef struct sVFS_Node {
 	 * \}
 	 */
 	
+	/**
+	 * \name Node State
+	 * \brief Stores the misc information about the node
+	 * \{
+	 */
 	 int	ReferenceCount;	//!< Number of times the node is used
 	
 	Uint64	Size;	//!< File Size
 	
 	Uint32	Flags;	//!< File Flags
 	
+	/**
+	 * \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;
+	
+	/**
+	 * \}
+	 */
+	
 	/**
 	 * \name Times
 	 * \{
@@ -127,7 +168,7 @@ typedef struct sVFS_Node {
 	 int	(*IOCtl)(struct sVFS_Node *Node, int Id, void *Data);
 	
 	/**
-	 * }
+	 * \}
 	 */
 	
 	/**
@@ -157,7 +198,7 @@ typedef struct sVFS_Node {
 	Uint64	(*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
 	
 	/**
-	 * }
+	 * \}
 	 */
 	
 	/**
@@ -172,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
@@ -191,21 +232,30 @@ 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
 	 * \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 Boolean Success
+	 * \return Zero on Success, non-zero on error (see errno.h)
+	 */
+	 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	(*Relink)(struct sVFS_Node *Node, char *OldName, char *NewName);
+	 int	(*Link)(struct sVFS_Node *Node, struct sVFS_Node *Child, const char *NewName);
 	 
 	 /**
-	  * }
+	  * \}
 	  */
 } tVFS_Node;
 
@@ -215,12 +265,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)
@@ -261,7 +311,7 @@ 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);
 /**
  * \fn tVFS_ACL *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group)
  * \brief Transforms Unix Permssions into Acess ACLs
@@ -283,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
@@ -305,7 +355,7 @@ extern tVFS_Node	*Inode_GetCache(int Handle, Uint64 Inode);
  */
 extern tVFS_Node	*Inode_CacheNode(int Handle, tVFS_Node *Node);
 /**
- * \fn void Inode_UncacheNode(int Handle, Uint64 Inode)
+ * \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