3 * \brief Exported VFS Definitions
4 * \author John Hodge (thePowersGang)
10 typedef Uint64 tInode;
12 //! Mountpoint identifier type
13 typedef Uint32 tMount;
16 //! Maximum length of a filename (including NULL byte)
17 #define FILENAME_MAX 256
18 //! Maximum size of a Memory Path generated by VFS_GetMemPath
19 #define VFS_MEMPATH_SIZE (3 + (BITS/4)*2)
21 * \name Flags for VFS_Open
24 //! Open for execution
25 #define VFS_OPENFLAG_EXEC 0x001
27 #define VFS_OPENFLAG_READ 0x002
29 #define VFS_OPENFLAG_WRITE 0x004
30 //! Do not resolve the final symbolic link
31 #define VFS_OPENFLAG_NOLINK 0x040
32 //! Create the file if it doesn't exist
33 #define VFS_OPENFLAG_CREATE 0x080
34 //! Open file as non-blocking
35 #define VFS_OPENFLAG_NONBLOCK 0x100
36 //! Treat as a directory
37 #define VFS_OPENFLAG_DIRECTORY 0x1000
39 #define VFS_OPENFLAG_USER 0x8000
43 //! Marks a VFS handle as belonging to the kernel
44 #define VFS_KERNEL_FLAG 0x40000000
46 //! Architectual maximum number of file descriptors
47 #define MAX_FILE_DESCS 128
50 * \brief VFS_Seek directions
54 SEEK_SET = 1, //!< Set the current file offset
55 SEEK_CUR = 0, //!< Seek relative to the current position
56 SEEK_END = -1 //!< Seek from the end of the file backwards
60 * \name ACL Permissions
63 #define VFS_PERM_READ 0x00000001 //!< Readable
64 #define VFS_PERM_WRITE 0x00000002 //!< Writable
65 #define VFS_PERM_APPEND 0x00000004 //!< Appendable (/create file)
66 #define VFS_PERM_EXEC 0x00000008 //!< Executable (/Traversable)
67 #define VFS_PERM_ALL 0x7FFFFFFF //!< All permission bits
68 #define VFS_PERM_DENY 0x80000000 //!< Flag for denying a permission set (higher precedence)
74 * \brief MMap protection flags
77 #define MMAP_PROT_READ 0x001 //!< Readable memory
78 #define MMAP_PROT_WRITE 0x002 //!< Writable memory
79 #define MMAP_PROT_EXEC 0x004 //!< Executable memory
85 * \brief MMap mapping flags
88 #define MMAP_MAP_SHARED 0x001 //!< Shared with all other users of the FD
89 #define MMAP_MAP_PRIVATE 0x002 //!< Local (COW) copy
90 #define MMAP_MAP_FIXED 0x004 //!< Load to a fixed address
91 #define MMAP_MAP_ANONYMOUS 0x008 //!< Not associated with a FD
96 // -- System Call Structures ---
98 * \brief ACL Defintion Structure
100 typedef struct sVFS_ACL
102 //! ACL entity selection
104 unsigned Group: 1; //!< Group (as opposed to user) flag
105 unsigned ID: 31; //!< ID of Group/User (-1 for nobody/world)
107 //! ACL Permissions mask
109 unsigned Inv: 1; //!< Invert Permissions
110 unsigned Perms: 31; //!< Permission Flags
115 * \brief SYS_FINFO structure
117 typedef struct sFInfo
119 tMount mount; //!< Mountpoint ID
120 tInode inode; //!< Inode
121 Uint32 uid; //!< Owning User ID
122 Uint32 gid; //!< Owning Group ID
123 Uint32 flags; //!< File flags
124 Uint64 size; //!< File Size
125 Sint64 atime; //!< Last Accessed time
126 Sint64 mtime; //!< Last modified time
127 Sint64 ctime; //!< Creation time
128 Sint32 numacls; //!< Total number of ACL entries
129 tVFS_ACL acls[]; //!< ACL buffer (size is passed in the \a MaxACLs argument to VFS_FInfo)
133 #include "../../../Usermode/Libraries/ld-acess.so_src/include_exp/acess/fd_set.h"
137 * \brief fd_set for select()
141 //! Bitmap of set file descriptors
142 Uint16 flags[MAX_FILE_DESCS/16];
146 * \brief Clear a descriptor flag in a fd_set
147 * \param fd File descriptor to clear
148 * \param fdsetp Set to modify
150 #define FD_CLR(fd, fdsetp) ((fdsetp)->flags[(fd)/16]&=~(1<<((fd)%16)))
152 * \brief Set a descriptor flag in a fd_set
153 * \param fd File descriptor to set
154 * \param fdsetp Set to modify
156 #define FD_SET(fd, fdsetp) ((fdsetp)->flags[(fd)/16]|=~(1<<((fd)%16)))
158 * \brief Test a descriptor flag in a fd_set
159 * \param fd File descriptor to test
160 * \param fdsetp Set to modify
162 #define FD_ISSET(fd, fdsetp) ((fdsetp)->flags[(fd)/16]&(1<<((fd)%16)))
167 * \brief Initialise the VFS (called by system.c)
168 * \return Boolean Success
170 extern int VFS_Init(void);
174 * \param Path Absolute or relative path to the file
175 * \param Flags Flags defining how to open the file
176 * \return VFS Handle (an integer) or -1 if an error occured
177 * \note Calls VFS_OpenEx(Path, Flags, 0)
179 extern int VFS_Open(const char *Path, Uint Flags);
182 * \param Path Absolute or relative path to the file
183 * \param Flags Flags defining how to open the file
184 * \param Mode Mode for newly created file (POSIX compatability)
185 * \return VFS Handle (an integer) or -1 if an error occured
187 extern int VFS_OpenEx(const char *Path, Uint Flags, Uint Mode);
189 * \brief Opens a file via an open directory
190 * \note The file to open must be a direct child of the parent
191 * \param FD Parent Directory
192 * \param Name Child name
193 * \param Mode Open mode
194 * \return File handle (same as returned from VFS_Open)
196 extern int VFS_OpenChild(int FD, const char *Name, Uint Mode);
198 * \brief Opens a file given a mount ID and an inode number
199 * \param Mount Mount ID returned by FInfo
200 * \param Inode Inode number from FInfo
201 * \param Mode Open mode (see VFS_Open)
202 * \return File handle (same as VFS_Open)
204 extern int VFS_OpenInode(Uint32 Mount, Uint64 Inode, int Mode);
207 * \brief Open a file reusing an old FD
209 extern int VFS_Reopen(int FD, const char *Path, int Flags);
212 * \brief Close a currently open file
213 * \param FD Handle returned by ::VFS_Open
215 extern void VFS_Close(int FD);
218 * \brief Copy one FD to another
219 * \param SrcFD Source file descriptor
220 * \param DstFD Destination file descriptor (-1 means allocate new)
222 extern int VFS_DuplicateFD(int SrcFD, int DstFD);
225 * \brief Update the flags on a FD
227 extern int VFS_SetFDFlags(int FD, int Mask, int Value);
230 * \brief Save specified file handle such that it can be passed between processes
231 * \param FD File descriptor to save
232 * \return Marshalled handle, or (uint64_t)-1 on error
234 extern Uint64 VFS_MarshalHandle(int FD);
237 * \brief Restore a marshalled handle into the current process
238 * \param Handle returned by VFS_MarshalHandle
239 * \return File descriptor, or -1 on error
241 extern int VFS_UnmarshalHandle(Uint64 Handle);
244 * \brief Get file information from an open file
245 * \param FD File handle returned by ::VFS_Open
246 * \param Dest Destination for the read information
247 * \param MaxACLs Number of ACL slots allocated in the \a Dest structure
248 * \return Boolean Success
250 * If the \a NumACLs is smaller than the number of ACLs the node has, only
251 * \a NumACLs will be copied into \a Dest, but the tFInfo.numacls field
252 * will be set to the true ammount of ACLs. It is up to the user to do with
253 * this information how they like.
255 extern int VFS_FInfo(int FD, tFInfo *Dest, int MaxACLs);
257 * \brief Gets the permissions appling to a user/group.
258 * \param FD File handle returned by ::VFS_Open
259 * \param Dest ACL information structure to edit
260 * \return Boolean success
262 * This function sets the tVFS_ACL.Inv and tVFS_ACL.Perms fields to what
263 * permissions the user/group specied in tVFS_ACL.ID has on the file.
265 extern int VFS_GetACL(int FD, tVFS_ACL *Dest);
267 * \brief Changes the user's current working directory
268 * \param Dest New working directory (either absolute or relative to the current)
269 * \return Boolean Success
271 extern int VFS_ChDir(const char *Dest);
273 * \brief Change the current virtual root for the user
274 * \param New New virtual root (same as ::VFS_ChDir but cannot go
275 * above the current virtual root)
276 * \return Boolean success
278 extern int VFS_ChRoot(const char *New);
281 * \brief Change the location of the current file pointer
282 * \param FD File handle returned by ::VFS_Open
283 * \param Offset Offset within the file to go to
284 * \param Whence A direction from ::eVFS_SeekDirs
285 * \return Boolean success
287 extern int VFS_Seek(int FD, Sint64 Offset, int Whence);
289 * \brief Returns the current file pointer
290 * \param FD File handle returned by ::VFS_Open
291 * \return Current file position
293 extern Uint64 VFS_Tell(int FD);
296 * \brief Reads data from a file
297 * \param FD File handle returned by ::VFS_Open
298 * \param Length Number of bytes to read from the file
299 * \param Buffer Destination of read data
300 * \return Number of read bytes
302 extern size_t VFS_Read(int FD, size_t Length, void *Buffer);
304 * \brief Writes data to a file
305 * \param FD File handle returned by ::VFS_Open
306 * \param Length Number of bytes to write to the file
307 * \param Buffer Source of written data
308 * \return Number of bytes written
310 extern size_t VFS_Write(int FD, size_t Length, const void *Buffer);
313 * \brief Reads from a specific offset in the file
314 * \param FD File handle returned by ::VFS_Open
315 * \param Offset Byte offset in the file
316 * \param Length Number of bytes to read from the file
317 * \param Buffer Source of read data
318 * \return Number of bytes read
320 extern size_t VFS_ReadAt(int FD, Uint64 Offset, size_t Length, void *Buffer);
322 * \brief Writes to a specific offset in the file
323 * \param FD File handle returned by ::VFS_Open
324 * \param Offset Byte offset in the file
325 * \param Length Number of bytes to write to the file
326 * \param Buffer Source of written data
327 * \return Number of bytes written
329 extern size_t VFS_WriteAt(int FD, Uint64 Offset, size_t Length, const void *Buffer);
332 * \brief Set the valid size of a file
333 * \param FD File descriptor
334 * \param Size New file size
335 * \return Actual new file size (-1 if error occurred)
337 * \note Not all files support this call (will return ENOTIMPL)
339 extern off_t VFS_Truncate(int FD, off_t Size);
342 * \brief Sends an IOCtl request to the driver
343 * \param FD File handle returned by ::VFS_Open
344 * \param ID IOCtl call ID (driver specific)
345 * \param Buffer Data pointer to send to the driver
346 * \return Driver specific response
348 extern int VFS_IOCtl(int FD, int ID, void *Buffer);
351 * \brief Creates a VFS Memory path from a pointer and size
352 * \param Dest Destination for the created path
353 * \param Base Base of the memory file
354 * \param Length Length of the memory buffer
355 * \note A maximum of VFS_MEMPATH_SIZE bytes will be required in \a Dest
357 extern void VFS_GetMemPath(char *Dest, void *Base, Uint Length);
359 * \brief Gets the canoical (true) path of a file
360 * \param Path File path (may contain symlinks, relative elements etc.)
361 * \return Absolute path with no symlinks
363 extern char *VFS_GetTruePath(const char *Path);
366 * \brief Mounts a filesystem
367 * \param Device Device to mount
368 * \param MountPoint Location to mount
369 * \param Filesystem Filesystem to use
370 * \param Options Options string to pass the driver
371 * \return 1 on succes, -1 on error
373 extern int VFS_Mount(const char *Device, const char *MountPoint, const char *Filesystem, const char *Options);
375 * \brief Unmount a mounted filesystem
376 * \param Mountpoint Location of the mount
377 * \return 0 on success, errno on error
379 extern int VFS_Unmount(const char *Mountpoint);
381 * \brief Attemt to unmount all fileystems
382 * \return Number of unmounted filesytems, -1 if none left to unmount
383 * \note Can return 0 when there are stil volumes mounted if there are open handles
385 extern int VFS_UnmountAll(void);
388 * \brief Create a new directory
389 * \param Path Path to new directory (absolute or relative)
390 * \return Boolean success
391 * \note The parent of the directory must exist
393 extern int VFS_MkDir(const char *Path);
395 * \brief Create a symbolic link
396 * \param Name Name of the symbolic link
397 * \param Link File the symlink points to
398 * \return Boolean success (\a Link is not tested for existence)
400 extern int VFS_Symlink(const char *Name, const char *Link);
402 * \brief Read from a directory
403 * \param FD File handle returned by ::VFS_Open
404 * \param Dest Destination array for the file name (max FILENAME_MAX bytes)
405 * \return Boolean Success
407 extern int VFS_ReadDir(int FD, char Dest[FILENAME_MAX]);
409 * \brief Wait for an aciton on a file descriptor
410 * \param MaxHandle Maximum set handle in \a *Handles
411 * \param ReadHandles Handles to wait for data on
412 * \param WriteHandles Handles to wait to write to
413 * \param ErrHandles Handle to wait for errors on
414 * \param Timeout Timeout for select() (if null, there is no timeout), if zero select() is non blocking
415 * \param ExtraEvents Extra event set to wait on
416 * \param IsKernel Use kernel handles as opposed to user handles
417 * \return Number of handles that actioned
419 extern int VFS_Select(int MaxHandle, fd_set *ReadHandles, fd_set *WriteHandles, fd_set *ErrHandles, tTime *Timeout, Uint32 ExtraEvents, BOOL IsKernel);
422 * \brief Map a file into memory
423 * \param DestHint Suggested place for read data
424 * \param Length Size of area to map
425 * \param Protection Protection type (see `man mmap`)
426 * \param Flags Mapping flags
427 * \param FD File descriptor to load from
428 * \param Offset Start of region
430 extern void *VFS_MMap(void *DestHint, size_t Length, int Protection, int Flags, int FD, Uint64 Offset);
433 * \brief Unmap memory allocated by VFS_MMap
434 * \param Addr Address of data to unmap
435 * \param Length Length of data
437 extern int VFS_MUnmap(void *Addr, size_t Length);