KernelLand/Kernel/include/vfs_ext.h

   1 /**
   2  * \file vfs_ext.h
   3  * \brief Exported VFS Definitions
   4  * \author John Hodge (thePowersGang)
   5  */
   6 #ifndef _VFS_EXT_H
   7 #define _VFS_EXT_H
   8
   9 //! Inode number type
  10 typedef Uint64  tInode;
  11
  12 //! Mountpoint identifier type
  13 typedef Uint32  tMount;
  14
  15 // === CONSTANTS ===
  16 #define FILENAME_MAX    256
  17 //! Maximum size of a Memory Path generated by VFS_GetMemPath
  18 #define VFS_MEMPATH_SIZE        (3 + (BITS/4)*2)
  19 /**
  20  * \name Flags for VFS_Open
  21  * \{
  22  */
  23 //! Open for execution
  24 #define VFS_OPENFLAG_EXEC       0x01
  25 //! Open for reading
  26 #define VFS_OPENFLAG_READ       0x02
  27 //! Open for writing
  28 #define VFS_OPENFLAG_WRITE      0x04
  29 //! Do not resolve the final symbolic link
  30 #define VFS_OPENFLAG_NOLINK     0x40
  31 //! Create the file if it doesn't exist
  32 #define VFS_OPENFLAG_CREATE     0x80
  33 //! Treat as a directory
  34 #define VFS_OPENFLAG_DIRECTORY  0x100
  35 //! Open as a user
  36 #define VFS_OPENFLAG_USER       0x8000
  37 /**
  38  * \}
  39  */
  40 //! Marks a VFS handle as belonging to the kernel
  41 #define VFS_KERNEL_FLAG 0x40000000
  42
  43 //! Architectual maximum number of file descriptors
  44 #define MAX_FILE_DESCS  128
  45
  46 /**
  47  * \brief VFS_Seek directions
  48  */
  49 enum eVFS_SeekDirs
  50 {
  51         SEEK_SET = 1,   //!< Set the current file offset
  52         SEEK_CUR = 0,   //!< Seek relative to the current position
  53         SEEK_END = -1   //!< Seek from the end of the file backwards
  54 };
  55
  56 /**
  57  * \name ACL Permissions
  58  * \{
  59  */
  60 /**
  61  * \brief Readable
  62  */
  63 #define VFS_PERM_READ   0x00000001
  64 /**
  65  * \brief Writeable
  66  */
  67 #define VFS_PERM_WRITE  0x00000002
  68 /**
  69  * \brief Append allowed
  70  */
  71 #define VFS_PERM_APPEND 0x00000004
  72 /**
  73  * \brief Executable
  74  */
  75 #define VFS_PERM_EXECUTE        0x00000008
  76 /**
  77  * \brief All permissions granted
  78  */
  79 #define VFS_PERM_ALL    0x7FFFFFFF      // Mask for permissions
  80 /**
  81  * \brief Denies instead of granting permissions
  82  * \note Denials take precedence
  83  */
  84 #define VFS_PERM_DENY   0x80000000      // Inverts permissions
  85 /**
  86  * \}
  87  */
  88
  89 /**
  90  * \brief MMap protection flags
  91  * \{
  92  */
  93 #define MMAP_PROT_READ  0x001   //!< Readable memory
  94 #define MMAP_PROT_WRITE 0x002   //!< Writable memory
  95 #define MMAP_PROT_EXEC  0x004   //!< Executable memory
  96 /**
  97  * \}
  98  */
  99
 100 /**
 101  * \brief MMap mapping flags
 102  * \{
 103  */
 104 #define MMAP_MAP_SHARED         0x001   //!< Shared with all other users of the FD
 105 #define MMAP_MAP_PRIVATE        0x002   //!< Local (COW) copy
 106 #define MMAP_MAP_FIXED          0x004   //!< Load to a fixed address
 107 #define MMAP_MAP_ANONYMOUS      0x008   //!< Not associated with a FD
 108 /**
 109  * \}
 110  */
 111
 112 // -- System Call Structures ---
 113 /**
 114  * \brief ACL Defintion Structure
 115  */
 116 typedef struct sVFS_ACL
 117 {
 118         struct {
 119                 unsigned Group: 1;      //!< Group (as opposed to user) flag
 120                 unsigned ID:    31;     //!< ID of Group/User (-1 for nobody/world)
 121         };
 122         struct {
 123                 unsigned Inv:   1;      //!< Invert Permissions
 124                 unsigned Perms: 31;     //!< Permission Flags
 125         };
 126 } tVFS_ACL;
 127
 128 /**
 129  * \brief SYS_FINFO structure
 130  */
 131 typedef struct sFInfo
 132 {
 133         tMount  mount;  //!< Mountpoint ID
 134         tInode  inode;  //!< Inode
 135         Uint32  uid;    //!< Owning User ID
 136         Uint32  gid;    //!< Owning Group ID
 137         Uint32  flags;  //!< File flags
 138         Uint64  size;   //!< File Size
 139         Sint64  atime;  //!< Last Accessed time
 140         Sint64  mtime;  //!< Last modified time
 141         Sint64  ctime;  //!< Creation time
 142         Sint32  numacls;        //!< Total number of ACL entries
 143         tVFS_ACL        acls[]; //!< ACL buffer (size is passed in the \a MaxACLs argument to VFS_FInfo)
 144 } PACKED tFInfo;
 145
 146 /**
 147  * \brief fd_set for select()
 148  */
 149 typedef struct
 150 {
 151         //! Bitmap of set file descriptors
 152         Uint16  flags[MAX_FILE_DESCS/16];
 153 }       fd_set;
 154
 155 /**
 156  * \brief Clear a descriptor flag in a fd_set
 157  * \param fd    File descriptor to clear
 158  * \param fdsetp        Set to modify
 159  */
 160 #define FD_CLR(fd, fdsetp) ((fdsetp)->flags[(fd)/16]&=~(1<<((fd)%16)))
 161 /**
 162  * \brief Set a descriptor flag in a fd_set
 163  * \param fd    File descriptor to set
 164  * \param fdsetp        Set to modify
 165  */
 166 #define FD_SET(fd, fdsetp) ((fdsetp)->flags[(fd)/16]|=~(1<<((fd)%16)))
 167 /**
 168  * \brief Test a descriptor flag in a fd_set
 169  * \param fd    File descriptor to test
 170  * \param fdsetp        Set to modify
 171  */
 172 #define FD_ISSET(fd, fdsetp) ((fdsetp)->flags[(fd)/16]&(1<<((fd)%16)))
 173
 174 // === FUNCTIONS ===
 175 /**
 176  * \brief Initialise the VFS (called by system.c)
 177  * \return Boolean Success
 178  */
 179 extern int      VFS_Init(void);
 180
 181 /**
 182  * \brief Open a file
 183  * \param Path  Absolute or relative path to the file
 184  * \param Flags Flags defining how to open the file
 185  * \return VFS Handle (an integer) or -1 if an error occured
 186  * \note Calls VFS_OpenEx(Path, Flags, 0)
 187  */
 188 extern int      VFS_Open(const char *Path, Uint Flags);
 189 /**
 190  * \brief Open a file
 191  * \param Path  Absolute or relative path to the file
 192  * \param Flags Flags defining how to open the file
 193  * \param Mode  Mode for newly created file (POSIX compatability)
 194  * \return VFS Handle (an integer) or -1 if an error occured
 195  */
 196 extern int      VFS_OpenEx(const char *Path, Uint Flags, Uint Mode);
 197 /**
 198  * \brief Opens a file via an open directory
 199  * \note The file to open must be a direct child of the parent
 200  * \param FD    Parent Directory
 201  * \param Name  Child name
 202  * \param Mode  Open mode
 203  * \return File handle (same as returned from VFS_Open)
 204  */
 205 extern int      VFS_OpenChild(int FD, const char *Name, Uint Mode);
 206 /**
 207  * \brief Opens a file given a mount ID and an inode number
 208  * \param Mount Mount ID returned by FInfo
 209  * \param Inode Inode number from FInfo
 210  * \param Mode  Open mode (see VFS_Open)
 211  * \return File handle (same as VFS_Open)
 212  */
 213 extern int      VFS_OpenInode(Uint32 Mount, Uint64 Inode, int Mode);
 214
 215 /**
 216  * \brief Close a currently open file
 217  * \param FD    Handle returned by ::VFS_Open
 218  */
 219 extern void     VFS_Close(int FD);
 220
 221 /**
 222  * \brief Get file information from an open file
 223  * \param FD    File handle returned by ::VFS_Open
 224  * \param Dest  Destination for the read information
 225  * \param MaxACLs       Number of ACL slots allocated in the \a Dest structure
 226  * \return Boolean Success
 227  *
 228  * If the \a NumACLs is smaller than the number of ACLs the node has, only
 229  * \a NumACLs will be copied into \a Dest, but the tFInfo.numacls field
 230  * will be set to the true ammount of ACLs. It is up to the user to do with
 231  * this information how they like.
 232  */
 233 extern int      VFS_FInfo(int FD, tFInfo *Dest, int MaxACLs);
 234 /**
 235  * \brief Gets the permissions appling to a user/group.
 236  * \param FD    File handle returned by ::VFS_Open
 237  * \param Dest  ACL information structure to edit
 238  * \return Boolean success
 239  *
 240  * This function sets the tVFS_ACL.Inv and tVFS_ACL.Perms fields to what
 241  * permissions the user/group specied in tVFS_ACL.ID has on the file.
 242  */
 243 extern int      VFS_GetACL(int FD, tVFS_ACL *Dest);
 244 /**
 245  * \brief Changes the user's current working directory
 246  * \param Dest  New working directory (either absolute or relative to the current)
 247  * \return Boolean Success
 248  */
 249 extern int      VFS_ChDir(const char *Dest);
 250 /**
 251  * \brief Change the current virtual root for the user
 252  * \param New New virtual root (same as ::VFS_ChDir but cannot go
 253  *            above the current virtual root)
 254  * \return Boolean success
 255  */
 256 extern int      VFS_ChRoot(const char *New);
 257
 258 /**
 259  * \brief Change the location of the current file pointer
 260  * \param FD    File handle returned by ::VFS_Open
 261  * \param Offset        Offset within the file to go to
 262  * \param Whence        A direction from ::eVFS_SeekDirs
 263  * \return Boolean success
 264  */
 265 extern int      VFS_Seek(int FD, Sint64 Offset, int Whence);
 266 /**
 267  * \brief Returns the current file pointer
 268  * \param FD    File handle returned by ::VFS_Open
 269  * \return Current file position
 270  */
 271 extern Uint64   VFS_Tell(int FD);
 272
 273 /**
 274  * \brief Reads data from a file
 275  * \param FD    File handle returned by ::VFS_Open
 276  * \param Length        Number of bytes to read from the file
 277  * \param Buffer        Destination of read data
 278  * \return Number of read bytes
 279  */
 280 extern size_t   VFS_Read(int FD, size_t Length, void *Buffer);
 281 /**
 282  * \brief Writes data to a file
 283  * \param FD    File handle returned by ::VFS_Open
 284  * \param Length        Number of bytes to write to the file
 285  * \param Buffer        Source of written data
 286  * \return Number of bytes written
 287  */
 288 extern size_t   VFS_Write(int FD, size_t Length, const void *Buffer);
 289
 290 /**
 291  * \brief Reads from a specific offset in the file
 292  * \param FD    File handle returned by ::VFS_Open
 293  * \param Offset        Byte offset in the file
 294  * \param Length        Number of bytes to read from the file
 295  * \param Buffer        Source of read data
 296  * \return Number of bytes read
 297  */
 298 extern size_t   VFS_ReadAt(int FD, Uint64 Offset, size_t Length, void *Buffer);
 299 /**
 300  * \brief Writes to a specific offset in the file
 301  * \param FD    File handle returned by ::VFS_Open
 302  * \param Offset        Byte offset in the file
 303  * \param Length        Number of bytes to write to the file
 304  * \param Buffer        Source of written data
 305  * \return Number of bytes written
 306  */
 307 extern size_t   VFS_WriteAt(int FD, Uint64 Offset, size_t Length, const void *Buffer);
 308
 309 /**
 310  * \brief Sends an IOCtl request to the driver
 311  * \param FD    File handle returned by ::VFS_Open
 312  * \param ID    IOCtl call ID (driver specific)
 313  * \param Buffer        Data pointer to send to the driver
 314  * \return Driver specific response
 315  */
 316 extern int      VFS_IOCtl(int FD, int ID, void *Buffer);
 317
 318 /**
 319  * \brief Creates a VFS Memory path from a pointer and size
 320  * \param Dest  Destination for the created path
 321  * \param Base  Base of the memory file
 322  * \param Length        Length of the memory buffer
 323  * \note A maximum of VFS_MEMPATH_SIZE bytes will be required in \a Dest
 324  */
 325 extern void     VFS_GetMemPath(char *Dest, void *Base, Uint Length);
 326 /**
 327  * \brief Gets the canoical (true) path of a file
 328  * \param Path  File path (may contain symlinks, relative elements etc.)
 329  * \return Absolute path with no symlinks
 330  */
 331 extern char     *VFS_GetTruePath(const char *Path);
 332
 333 /**
 334  * \brief Mounts a filesystem
 335  * \param Device        Device to mount
 336  * \param MountPoint    Location to mount
 337  * \param Filesystem    Filesystem to use
 338  * \param Options       Options string to pass the driver
 339  * \return 1 on succes, -1 on error
 340  */
 341 extern int      VFS_Mount(const char *Device, const char *MountPoint, const char *Filesystem, const char *Options);
 342 /**
 343  * \brief Unmount a mounted filesystem
 344  * \param Mountpoint    Location of the mount
 345  * \return 0 on success, errno on error
 346  */
 347 extern int      VFS_Unmount(const char *Mountpoint);
 348 /**
 349  * \brief Attemt to unmount all fileystems
 350  * \return Number of unmounted filesytems, -1 if none left to unmount
 351  * \note Can return 0 when there are stil volumes mounted if there are open handles
 352  */
 353 extern int      VFS_UnmountAll(void);
 354
 355 /**
 356  * \brief Create a new directory
 357  * \param Path  Path to new directory (absolute or relative)
 358  * \return Boolean success
 359  * \note The parent of the directory must exist
 360  */
 361 extern int      VFS_MkDir(const char *Path);
 362 /**
 363  * \brief Create a symbolic link
 364  * \param Name  Name of the symbolic link
 365  * \param Link  File the symlink points to
 366  * \return Boolean success (\a Link is not tested for existence)
 367  */
 368 extern int      VFS_Symlink(const char *Name, const char *Link);
 369 /**
 370  * \brief Read from a directory
 371  * \param FD    File handle returned by ::VFS_Open
 372  * \param Dest  Destination array for the file name (max FILENAME_MAX bytes)
 373  * \return Boolean Success
 374  */
 375 extern int      VFS_ReadDir(int FD, char Dest[FILENAME_MAX]);
 376 /**
 377  * \brief Wait for an aciton on a file descriptor
 378  * \param MaxHandle     Maximum set handle in \a *Handles
 379  * \param ReadHandles   Handles to wait for data on
 380  * \param WriteHandles  Handles to wait to write to
 381  * \param ErrHandles    Handle to wait for errors on
 382  * \param Timeout       Timeout for select() (if null, there is no timeout), if zero select() is non blocking
 383  * \param ExtraEvents   Extra event set to wait on
 384  * \param IsKernel      Use kernel handles as opposed to user handles
 385  * \return Number of handles that actioned
 386  */
 387 extern int VFS_Select(int MaxHandle, fd_set *ReadHandles, fd_set *WriteHandles, fd_set *ErrHandles, tTime *Timeout, Uint32 ExtraEvents, BOOL IsKernel);
 388
 389 /**
 390  * \brief Map a file into memory
 391  * \param DestHint      Suggested place for read data
 392  * \param Length        Size of area to map
 393  * \param Protection    Protection type (see `man mmap`)
 394  * \param Flags Mapping flags
 395  * \param FD    File descriptor to load from
 396  * \param Offset        Start of region
 397  */
 398 extern void     *VFS_MMap(void *DestHint, size_t Length, int Protection, int Flags, int FD, Uint64 Offset);
 399
 400 /**
 401  * \brief Unmap memory allocated by VFS_MMap
 402  * \param Addr  Address of data to unmap
 403  * \param Length        Length of data
 404  */
 405 extern int      VFS_MUnmap(void *Addr, size_t Length);
 406 #endif