*/
/**
- * \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.
* \}
*/
+ /**
+ * \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;
+ /**
+ * \}
+ */
+
/**
* \name Times
* \{
int (*IOCtl)(struct sVFS_Node *Node, int Id, void *Data);
/**
- * }
+ * \}
*/
/**
Uint64 (*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
/**
- * }
+ * \}
*/
/**
* \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);
* \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, char *OldName, 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, char *NewName);
/**
- * }
+ * \}
*/
} tVFS_Node;
* \{
*/
/**
- * \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
*/
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