Added some very pedantic warning flags
[tpg/acess2.git] / Kernel / include / vfs.h
index ab0bd35..8618a04 100644 (file)
@@ -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
@@ -226,7 +234,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
@@ -235,7 +243,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
@@ -244,10 +252,10 @@ 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);
         
         /**
-         * }
+         * \}
          */
 } tVFS_Node;
 
@@ -257,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)
@@ -303,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
@@ -325,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

UCC git Repository :: git.ucc.asn.au