3 * \brief Exported VFS Definitions
4 * \author John Hodge (thePowersGang)
10 typedef Uint64 tInode;
12 //! Mountpoint identifier type
13 typedef Uint32 tMount;
16 //! Maximum size of a Memory Path generated by VFS_GetMemPath
17 #define VFS_MEMPATH_SIZE (3 + (BITS/4)*2)
19 * \name Flags for VFS_Open
22 //! Open for execution
23 #define VFS_OPENFLAG_EXEC 0x01
25 #define VFS_OPENFLAG_READ 0x02
27 #define VFS_OPENFLAG_WRITE 0x04
28 //! Do not resolve the final symbolic link
29 #define VFS_OPENFLAG_NOLINK 0x40
31 #define VFS_OPENFLAG_USER 0x80
35 //! Marks a VFS handle as belonging to the kernel
36 #define VFS_KERNEL_FLAG 0x40000000
38 //! Architectual maximum number of file descriptors
39 #define MAX_FILE_DESCS 128
42 * \brief VFS_Seek directions
46 SEEK_SET = 1, //!< Set the current file offset
47 SEEK_CUR = 0, //!< Seek relative to the current position
48 SEEK_END = -1 //!< Seek from the end of the file backwards
52 * \name ACL Permissions
58 #define VFS_PERM_READ 0x00000001
62 #define VFS_PERM_WRITE 0x00000002
64 * \brief Append allowed
66 #define VFS_PERM_APPEND 0x00000004
70 #define VFS_PERM_EXECUTE 0x00000008
72 * \brief All permissions granted
74 #define VFS_PERM_ALL 0x7FFFFFFF // Mask for permissions
76 * \brief Denies instead of granting permissions
77 * \note Denials take precedence
79 #define VFS_PERM_DENY 0x80000000 // Inverts permissions
85 * \brief MMap protection flags
88 #define MMAP_PROT_READ 0x001 //!< Readable memory
89 #define MMAP_PROT_WRITE 0x002 //!< Writable memory
90 #define MMAP_PROT_EXEC 0x004 //!< Executable memory
96 * \brief MMap mapping flags
99 #define MMAP_MAP_SHARED 0x001 //!< Shared with all other users of the FD
100 #define MMAP_MAP_PRIVATE 0x002 //!< Local (COW) copy
101 #define MMAP_MAP_FIXED 0x004 //!< Load to a fixed address
102 #define MMAP_MAP_ANONYMOUS 0x008 //!< Not associated with a FD
107 // -- System Call Structures ---
109 * \brief ACL Defintion Structure
111 typedef struct sVFS_ACL
114 unsigned Group: 1; //!< Group (as opposed to user) flag
115 unsigned ID: 31; //!< ID of Group/User (-1 for nobody/world)
118 unsigned Inv: 1; //!< Invert Permissions
119 unsigned Perms: 31; //!< Permission Flags
124 * \brief SYS_FINFO structure
126 typedef struct sFInfo
128 tMount mount; //!< Mountpoint ID
129 tInode inode; //!< Inode
130 Uint32 uid; //!< Owning User ID
131 Uint32 gid; //!< Owning Group ID
132 Uint32 flags; //!< File flags
133 Uint64 size; //!< File Size
134 Sint64 atime; //!< Last Accessed time
135 Sint64 mtime; //!< Last modified time
136 Sint64 ctime; //!< Creation time
137 Sint32 numacls; //!< Total number of ACL entries
138 tVFS_ACL acls[]; //!< ACL buffer (size is passed in the \a MaxACLs argument to VFS_FInfo)
142 * \brief fd_set for select()
146 //! Bitmap of set file descriptors
147 Uint16 flags[MAX_FILE_DESCS/16];
151 * \brief Clear a descriptor flag in a fd_set
152 * \param fd File descriptor to clear
153 * \param fdsetp Set to modify
155 #define FD_CLR(fd, fdsetp) ((fdsetp)->flags[(fd)/16]&=~(1<<((fd)%16)))
157 * \brief Set a descriptor flag in a fd_set
158 * \param fd File descriptor to set
159 * \param fdsetp Set to modify
161 #define FD_SET(fd, fdsetp) ((fdsetp)->flags[(fd)/16]|=~(1<<((fd)%16)))
163 * \brief Test a descriptor flag in a fd_set
164 * \param fd File descriptor to test
165 * \param fdsetp Set to modify
167 #define FD_ISSET(fd, fdsetp) ((fdsetp)->flags[(fd)/16]&(1<<((fd)%16)))
171 * \brief Initialise the VFS (called by system.c)
172 * \return Boolean Success
174 extern int VFS_Init(void);
178 * \param Path Absolute or relative path to the file
179 * \param Mode Flags defining how to open the file
180 * \return VFS Handle (an integer) or -1 if an error occured
182 extern int VFS_Open(const char *Path, Uint Mode);
184 * \brief Opens a file via an open directory
185 * \note The file to open must be a direct child of the parent
186 * \param FD Parent Directory
187 * \param Name Child name
188 * \param Mode Open mode
189 * \return File handle (same as returned from VFS_Open)
191 extern int VFS_OpenChild(int FD, const char *Name, Uint Mode);
193 * \brief Opens a file given a mount ID and an inode number
194 * \param Mount Mount ID returned by FInfo
195 * \param Inode Inode number from FInfo
196 * \param Mode Open mode (see VFS_Open)
197 * \return File handle (same as VFS_Open)
199 extern int VFS_OpenInode(Uint32 Mount, Uint64 Inode, int Mode);
202 * \brief Close a currently open file
203 * \param FD Handle returned by ::VFS_Open
205 extern void VFS_Close(int FD);
208 * \brief Get file information from an open file
209 * \param FD File handle returned by ::VFS_Open
210 * \param Dest Destination for the read information
211 * \param MaxACLs Number of ACL slots allocated in the \a Dest structure
212 * \return Boolean Success
214 * If the \a NumACLs is smaller than the number of ACLs the node has, only
215 * \a NumACLs will be copied into \a Dest, but the tFInfo.numacls field
216 * will be set to the true ammount of ACLs. It is up to the user to do with
217 * this information how they like.
219 extern int VFS_FInfo(int FD, tFInfo *Dest, int MaxACLs);
221 * \brief Gets the permissions appling to a user/group.
222 * \param FD File handle returned by ::VFS_Open
223 * \param Dest ACL information structure to edit
224 * \return Boolean success
226 * This function sets the tVFS_ACL.Inv and tVFS_ACL.Perms fields to what
227 * permissions the user/group specied in tVFS_ACL.ID has on the file.
229 extern int VFS_GetACL(int FD, tVFS_ACL *Dest);
231 * \brief Changes the user's current working directory
232 * \param Dest New working directory (either absolute or relative to the current)
233 * \return Boolean Success
235 extern int VFS_ChDir(const char *Dest);
237 * \brief Change the current virtual root for the user
238 * \param New New virtual root (same as ::VFS_ChDir but cannot go
239 * above the current virtual root)
240 * \return Boolean success
242 extern int VFS_ChRoot(const char *New);
245 * \brief Change the location of the current file pointer
246 * \param FD File handle returned by ::VFS_Open
247 * \param Offset Offset within the file to go to
248 * \param Whence A direction from ::eVFS_SeekDirs
249 * \return Boolean success
251 extern int VFS_Seek(int FD, Sint64 Offset, int Whence);
253 * \brief Returns the current file pointer
254 * \param FD File handle returned by ::VFS_Open
255 * \return Current file position
257 extern Uint64 VFS_Tell(int FD);
260 * \brief Reads data from a file
261 * \param FD File handle returned by ::VFS_Open
262 * \param Length Number of bytes to read from the file
263 * \param Buffer Destination of read data
264 * \return Number of read bytes
266 extern Uint64 VFS_Read(int FD, Uint64 Length, void *Buffer);
268 * \brief Writes data to a file
269 * \param FD File handle returned by ::VFS_Open
270 * \param Length Number of bytes to write to the file
271 * \param Buffer Source of written data
272 * \return Number of bytes written
274 extern Uint64 VFS_Write(int FD, Uint64 Length, const void *Buffer);
277 * \brief Reads from a specific offset in the file
278 * \param FD File handle returned by ::VFS_Open
279 * \param Offset Byte offset in the file
280 * \param Length Number of bytes to read from the file
281 * \param Buffer Source of read data
282 * \return Number of bytes read
284 extern Uint64 VFS_ReadAt(int FD, Uint64 Offset, Uint64 Length, void *Buffer);
286 * \brief Writes to a specific offset in the file
287 * \param FD File handle returned by ::VFS_Open
288 * \param Offset Byte offset in the file
289 * \param Length Number of bytes to write to the file
290 * \param Buffer Source of written data
291 * \return Number of bytes written
293 extern Uint64 VFS_WriteAt(int FD, Uint64 Offset, Uint64 Length, const void *Buffer);
296 * \brief Sends an IOCtl request to the driver
297 * \param FD File handle returned by ::VFS_Open
298 * \param ID IOCtl call ID (driver specific)
299 * \param Buffer Data pointer to send to the driver
300 * \return Driver specific response
302 extern int VFS_IOCtl(int FD, int ID, void *Buffer);
305 * \brief Creates a VFS Memory path from a pointer and size
306 * \param Dest Destination for the created path
307 * \param Base Base of the memory file
308 * \param Length Length of the memory buffer
309 * \note A maximum of VFS_MEMPATH_SIZE bytes will be required in \a Dest
311 extern void VFS_GetMemPath(char *Dest, void *Base, Uint Length);
313 * \brief Gets the canoical (true) path of a file
314 * \param Path File path (may contain symlinks, relative elements etc.)
315 * \return Absolute path with no symlinks
317 extern char *VFS_GetTruePath(const char *Path);
320 * \brief Mounts a filesystem
321 * \param Device Device to mount
322 * \param MountPoint Location to mount
323 * \param Filesystem Filesystem to use
324 * \param Options Options string to pass the driver
325 * \return 1 on succes, -1 on error
327 extern int VFS_Mount(const char *Device, const char *MountPoint, const char *Filesystem, const char *Options);
329 * \brief Create a new directory
330 * \param Path Path to new directory (absolute or relative)
331 * \return Boolean success
332 * \note The parent of the directory must exist
334 extern int VFS_MkDir(const char *Path);
336 * \brief Create a symbolic link
337 * \param Name Name of the symbolic link
338 * \param Link File the symlink points to
339 * \return Boolean success (\a Link is not tested for existence)
341 extern int VFS_Symlink(const char *Name, const char *Link);
343 * \brief Read from a directory
344 * \param FD File handle returned by ::VFS_Open
345 * \param Dest Destination array for the file name (max 255 bytes)
346 * \return Boolean Success
348 extern int VFS_ReadDir(int FD, char *Dest);
350 * \brief Wait for an aciton on a file descriptor
351 * \param MaxHandle Maximum set handle in \a *Handles
352 * \param ReadHandles Handles to wait for data on
353 * \param WriteHandles Handles to wait to write to
354 * \param ErrHandles Handle to wait for errors on
355 * \param Timeout Timeout for select() (if null, there is no timeout), if zero select() is non blocking
356 * \param IsKernel Use kernel handles as opposed to user handles
357 * \return Number of handles that actioned
359 extern int VFS_Select(int MaxHandle, fd_set *ReadHandles, fd_set *WriteHandles, fd_set *ErrHandles, tTime *Timeout, BOOL IsKernel);
362 * \brief Map a file into memory
363 * \param DestHint Suggested place for read data
364 * \param Length Size of area to map
365 * \param Protection Protection type (see `man mmap`)
366 * \param Flags Mapping flags
367 * \param FD File descriptor to load from
368 * \param Offset Start of region
370 extern void *VFS_MMap(void *DestHint, size_t Length, int Protection, int Flags, int FD, Uint64 Offset);
373 * \brief Unmap memory allocated by VFS_MMap
374 * \param Addr Address of data to unmap
375 * \param Length Length of data
377 extern int VFS_MUnmap(void *Addr, size_t Length);