Kernel/include/vfs.h

   1 /*
   2  * Acess2
   3  * VFS Common Header
   4  */
   5 /**
   6  * \file vfs.h
   7  * \brief Acess VFS Layer
   8  *
   9  * The Acess Virtual File System (VFS) provides abstraction of multiple
  10  * physical filesystems, network storage and devices (both hardware and
  11  * virtual) to the user.
  12  *
  13  * The core of the VFS is the concept of a \ref tVFS_Node "VFS Node".
  14  * A VFS Node represents a "file" in the VFS tree, this can be any sort
  15  * of file (an ordinary file, a directory, a symbolic link or a device)
  16  * depending on the bits set in the \ref tVFS_Node.Flags Flags field.
  17  * - For more information see "VFS Node Flags"
  18  */
  19 #ifndef _VFS_H
  20 #define _VFS_H
  21
  22 #include <acess.h>
  23
  24 /**
  25  * \name tVFS_Node Flags
  26  * \brief Flag values for tVFS_Node.Flags
  27  * \{
  28  */
  29 //! \todo Is this still needed
  30 #define VFS_FFLAG_READONLY      0x01    //!< Readonly File
  31 /**
  32  * \brief Directory Flag
  33  *
  34  * This flag marks the tVFS_Node as describing a directory, and says
  35  * that the tVFS_Node.FindDir, tVFS_Node.ReadDir, tVFS_Node.MkNod and
  36  * tVFS_Node.Relink function pointers are valid.
  37  * For a directory the tVFS_Node.Size field contains the number of files
  38  * within the directory, or -1 for undetermined.
  39  */
  40 #define VFS_FFLAG_DIRECTORY     0x02
  41 /**
  42  * \brief Symbolic Link Flag
  43  *
  44  * Marks a file as a symbolic link
  45  */
  46 #define VFS_FFLAG_SYMLINK       0x04
  47 /**
  48  * \brief Set User ID Flag
  49  *
  50  * Allows an executable file to change it's executing user to the file's
  51  * owner.
  52  * In the case of a directory, it means that all immediate children will
  53  * inherit the UID of the parent.
  54  */
  55 #define VFS_FFLAG_SETUID        0x08
  56 /**
  57  * \brief Set Group ID Flag
  58  *
  59  * Allows an executable file to change it's executing group to the file's
  60  * owning group.
  61  * In the case of a directory, it means that all immediate children will
  62  * inherit the GID of the parent.
  63  */
  64 #define VFS_FFLAG_SETGID        0x10
  65 /**
  66  * \}
  67  */
  68
  69 /**
  70  * \brief VFS Node
  71  *
  72  * This structure provides the VFS with the functions required to read/write
  73  * the file (or directory) that it represents.
  74  */
  75 typedef struct sVFS_Node
  76 {
  77         /**
  78          * \name Identifiers
  79          * \brief Fields used by the driver to identify what data this node
  80          *        corresponds to.
  81          * \{
  82          */
  83         Uint64  Inode;  //!< Inode ID (Essentially another ImplInt)
  84         Uint    ImplInt;        //!< Implementation Usable Integer
  85         void    *ImplPtr;       //!< Implementation Usable Pointer
  86         /**
  87          * \}
  88          */
  89
  90         /**
  91          * \name Node State
  92          * \brief Stores the misc information about the node
  93          * \{
  94          */
  95          int    ReferenceCount; //!< Number of times the node is used
  96
  97         Uint64  Size;   //!< File Size
  98
  99         Uint32  Flags;  //!< File Flags
 100
 101         /**
 102          * Pointer to cached data (FS Specific)
 103          * \note Inode_* will free when the node is uncached this if needed
 104          */
 105         void    *Data;
 106         /**
 107          * \}
 108          */
 109
 110         /**
 111          * \name Times
 112          * \{
 113          */
 114         Sint64  ATime;  //!< Last Accessed Time
 115         Sint64  MTime;  //!< Last Modified Time
 116         Sint64  CTime;  //!< Creation Time
 117         /**
 118          * \}
 119          */
 120
 121         /**
 122          * \name Access controll
 123          * \{
 124          */
 125         tUID    UID;    //!< ID of Owning User
 126         tGID    GID;    //!< ID of Owning Group
 127
 128          int    NumACLs;        //!< Number of ACL entries
 129         tVFS_ACL        *ACLs;  //!< Access Controll List pointer
 130         /**
 131          * \}
 132          */
 133
 134         /**
 135          * \name Common Functions
 136          * \brief Functions that are used no matter the value of .Flags
 137          * \{
 138          */
 139         /**
 140          * \brief Reference the node
 141          * \param Node Pointer to this node
 142          */
 143         void    (*Reference)(struct sVFS_Node *Node);
 144         /**
 145          * \brief Close (dereference) the node
 146          * \param Node  Pointer to this node
 147          *
 148          * Usually .Close is used to write any changes to the node back to
 149          * the persistent storage.
 150          */
 151         void    (*Close)(struct sVFS_Node *Node);
 152
 153         /**
 154          * \brief Send an IO Control
 155          * \param Node  Pointer to this node
 156          * \param Id    IOCtl call number
 157          * \param Data  Pointer to data to pass to the driver
 158          * \return Implementation defined
 159          */
 160          int    (*IOCtl)(struct sVFS_Node *Node, int Id, void *Data);
 161
 162         /**
 163          * }
 164          */
 165
 166         /**
 167          * \name Buffer Functions
 168          * \brief Functions for accessing a buffer-type file (normal file or
 169          *        symbolic link)
 170          * \{
 171          */
 172
 173         /**
 174          * \brief Read from the file
 175          * \param Node  Pointer to this node
 176          * \param Offset        Byte offset in the file
 177          * \param Length        Number of bytes to read
 178          * \param Buffer        Destination for read data
 179          * \return Number of bytes read
 180          */
 181         Uint64  (*Read)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
 182         /**
 183          * \brief Write to the file
 184          * \param Node  Pointer to this node
 185          * \param Offset        Byte offser in the file
 186          * \param Length        Number of bytes to write
 187          * \param Buffer        Source of written data
 188          * \return Number of bytes read
 189          */
 190         Uint64  (*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
 191
 192         /**
 193          * }
 194          */
 195
 196         /**
 197          * \name Directory Functions
 198          * \{
 199          */
 200         /**
 201          * \brief Find an directory entry by name
 202          * \param Node  Pointer to this node
 203          * \param Name  Name of the file wanted
 204          * \return Pointer to the requested node or NULL if it cannot be found
 205          * \note The node returned must be accessable until ::tVFS_Node.Close
 206          *       is called and ReferenceCount reaches zero.
 207          */
 208         struct sVFS_Node        *(*FindDir)(struct sVFS_Node *Node, char *Name);
 209
 210         /**
 211          * \brief Read from a directory
 212          * \param Node  Pointer to this node
 213          * \param Pos   Offset in the directory
 214          * \return Pointer to the name of the item on the heap (will be freed
 215          *         by the caller). If the directory end has been reached, NULL
 216          *         will be returned.
 217          *         If an item is required to be skipped either &::NULLNode,
 218          *         ::VFS_SKIP or ::VFS_SKIPN(0...1023) will be returned.
 219          */
 220         char    *(*ReadDir)(struct sVFS_Node *Node, int Pos);
 221
 222         /**
 223          * \brief Create a node in a directory
 224          * \param Node  Pointer to this node
 225          * \param Name  Name of the new child
 226          * \param Flags Flags to apply to the new child (directory or symlink)
 227          * \return Boolean success
 228          */
 229          int    (*MkNod)(struct sVFS_Node *Node, char *Name, Uint Flags);
 230
 231         /**
 232          * \brief Relink (Rename/Remove) a file/directory
 233          * \param Node  Pointer to this node
 234          * \param OldName       Name of the item to move/delete
 235          * \param NewName       New name (or NULL if unlinking is wanted)
 236          * \return Zero on Success, non-zero on error (see errno.h)
 237          */
 238          int    (*Relink)(struct sVFS_Node *Node, char *OldName, char *NewName);
 239
 240          /**
 241           * }
 242           */
 243 } tVFS_Node;
 244
 245 /**
 246  * \brief VFS Driver (Filesystem) Definition
 247  */
 248 typedef struct sVFS_Driver
 249 {
 250         //! \brief Unique Identifier for this filesystem type
 251         char    *Name;
 252         //! \brief Flags applying to this driver
 253         Uint    Flags;
 254
 255         //! \brief Callback to mount a device
 256         tVFS_Node       *(*InitDevice)(char *Device, char **Options);
 257         //! \brief Callback to unmount a device
 258         void    (*Unmount)(tVFS_Node *Node);
 259         //! \brief Used internally (next driver in the chain)
 260         struct sVFS_Driver      *Next;
 261 } tVFS_Driver;
 262
 263 // === GLOBALS ===
 264 //! \brief Maximum number of elements that can be skipped in one return
 265 #define VFS_MAXSKIP     ((void*)1024)
 266 //! \brief Skip a single entry in readdir
 267 #define VFS_SKIP        ((void*)1)
 268 //! \brief Skip \a n entries in readdir
 269 #define VFS_SKIPN(n)    ((void*)(n))
 270
 271 extern tVFS_Node        NULLNode;       //!< NULL VFS Node (Ignored/Skipped)
 272 /**
 273  * \name Static ACLs
 274  * \brief Simple ACLs to aid writing drivers
 275  * \{
 276  */
 277 extern tVFS_ACL gVFS_ACL_EveryoneRWX;   //!< Everyone Read/Write/Execute
 278 extern tVFS_ACL gVFS_ACL_EveryoneRW;    //!< Everyone Read/Write
 279 extern tVFS_ACL gVFS_ACL_EveryoneRX;    //!< Everyone Read/Execute
 280 extern tVFS_ACL gVFS_ACL_EveryoneRO;    //!< Everyone Read only
 281 /**
 282  * \}
 283  */
 284
 285 // === FUNCTIONS ===
 286 /**
 287  * \fn int VFS_AddDriver(tVFS_Driver *Info)
 288  * \brief Registers the driver with the DevFS layer
 289  * \param Info  Driver information structure
 290  */
 291 extern int      VFS_AddDriver(tVFS_Driver *Info);
 292 /**
 293  * \fn tVFS_Driver *VFS_GetFSByName(char *Name)
 294  * \brief Get the information structure of a driver given its name
 295  * \param Name  Name of filesystem driver to find
 296  */
 297 extern tVFS_Driver      *VFS_GetFSByName(char *Name);
 298 /**
 299  * \fn tVFS_ACL *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group)
 300  * \brief Transforms Unix Permssions into Acess ACLs
 301  * \param Mode  Unix RWXrwxRWX mask
 302  * \param Owner UID of the file's owner
 303  * \param Group GID of the file's owning group
 304  * \return An array of 3 Acess ACLs
 305  */
 306 extern tVFS_ACL *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group);
 307
 308 // --- Node Cache --
 309 /**
 310  * \name Node Cache
 311  * \brief Functions to allow a node to be cached in memory by the VFS
 312  *
 313  * These functions store a node for the driver, to prevent it from having
 314  * to re-generate the node on each call to FindDir. It also allows for
 315  * fast cleanup when a filesystem is unmounted.
 316  * \{
 317  */
 318 /**
 319  * \fn int Inode_GetHandle()
 320  * \brief Gets a unique handle to the Node Cache
 321  * \return A unique handle for use for the rest of the Inode_* functions
 322  */
 323 extern int      Inode_GetHandle();
 324 /**
 325  * \fn tVFS_Node *Inode_GetCache(int Handle, Uint64 Inode)
 326  * \brief Gets an inode from the node cache
 327  * \param Handle        A handle returned by Inode_GetHandle()
 328  * \param Inode Value of the Inode field of the ::tVFS_Node you want
 329  * \return A pointer to the cached node
 330  */
 331 extern tVFS_Node        *Inode_GetCache(int Handle, Uint64 Inode);
 332 /**
 333  * \fn tVFS_Node *Inode_CacheNode(int Handle, tVFS_Node *Node)
 334  * \brief Caches a node in the Node Cache
 335  * \param Handle        A handle returned by Inode_GetHandle()
 336  * \param Node  A pointer to the node to be cached (a copy is taken)
 337  * \return A pointer to the node in the node cache
 338  */
 339 extern tVFS_Node        *Inode_CacheNode(int Handle, tVFS_Node *Node);
 340 /**
 341  * \fn int Inode_UncacheNode(int Handle, Uint64 Inode)
 342  * \brief Dereferences (and removes if needed) a node from the cache
 343  * \param Handle        A handle returned by Inode_GetHandle()
 344  * \param Inode Value of the Inode field of the ::tVFS_Node you want to remove
 345  */
 346 extern void     Inode_UncacheNode(int Handle, Uint64 Inode);
 347 /**
 348  * \fn void Inode_ClearCache(int Handle)
 349  * \brief Clears the cache for a handle
 350  * \param Handle        A handle returned by Inode_GetHandle()
 351  */
 352 extern void     Inode_ClearCache(int Handle);
 353
 354 /**
 355  * \}
 356  */
 357
 358 #endif