Eliminate Interface Directory/Reorganize necessary files #45
Assignees
Comments
|
Removing commented lines under |
This was referenced Oct 15, 2024
|
@Yaxuan-w, I have updated the draft for the functions along with a short description of what they did. Please let me know if I missed anything. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Removed Functions Documentation
Index of Removed Functions
File:
file.rs: PR #53File:
misc.rs: PR #54File:
pipe.rs: PR #55File:
types.rs: PR #56File:
file.rsremovefile
Deletes a file from the filesystem.
Takes a filename as input, checks if the file exists, and removes it.
openfile
Opens a file and creates an
EmulatedFileobject with a specified filesize.Used to open files for reading and writing, with options for file creation.
openmetadata
Opens a file to access its metadata and returns an
EmulatedFileobject.Retrieves the file size and relevant metadata upon opening.
pathexists
Checks if a given file path exists.
Returns a boolean indicating whether the file path is valid.
EmulatedFile Struct
new
Creates a new
EmulatedFileinstance, opening a file and initializing its size.Opens the file with read/write permissions and stores a
Mutex<File>.new_metadata
Creates an
EmulatedFileinstance by reading the file's metadata.Retrieves file size and other metadata.
close
Closes the
EmulatedFile.Ensures resources are released after file operations.
shrink
Shrinks the file size to the specified length.
Reduces the file length and updates the
filesizefield.fdatasync
Syncs data to disk without syncing file metadata.
Uses
sync_data()to ensure file data is written to disk.fsync
Syncs both file data and metadata to disk.
Ensures full synchronization of file contents.
sync_file_range
Syncs a specified file range to disk.
Allows syncing a portion of the file's data based on offset, bytes, and flags.
readat
Reads data from a file at a specified offset.
Populates a C-buffer with data read from the file.
writeat
Writes data to a file at a specified offset.
Takes data from a C-buffer and writes it to the file.
readfile_to_new_bytes
Reads the entire file into a byte vector.
Useful for reading a file's full content into memory.
writefile_from_bytes
Writes an entire byte vector to the file.
Replaces the file's content with new data from the byte buffer.
zerofill_at
Writes zeroes to the file starting at a specified offset.
Useful for initializing or overwriting portions of the file with zeros.
as_fd_handle_raw_int
Retrieves the file descriptor as an integer.
Returns the raw file descriptor from the file object.
EmulatedFileMap Struct
new
Creates a new
EmulatedFileMapinstance and maps a file into memory.Maps 1MB of file space and reserves 8 bytes for tracking written data.
write_to_map
Writes data to the mapped region of the file.
Automatically extends the mapped memory if the data exceeds the current map size.
extend_map
Extends the memory-mapped region of the file by 1MB.
Resizes the map when more space is needed for logging or writing.
close_emulatedfilemap
Closes the memory-mapped file, unmaps the file, and releases resources.
Ensures the file is properly unmapped before closing.
mapfilenew
Creates a new memory-mapped file.
Opens the file and maps 1MB of space, preparing the file for logging or other operations.
Test Module
test_path_exists_true
Tests whether
pathexistsreturnstruefor an existing file.Uses a temporary file to verify the functionality of
pathexists.test_path_exists_false
Tests whether
pathexistsreturnsfalsefor a non-existent file.Verifies that the function behaves as expected when the file does not exist.
File:
misc.rsAdvisoryLock Struct
new
Initializes a new
AdvisoryLockinstance.Creates a new mutex with a guard value of
0(unlocked state) and a condition variable for managing locks.lock_ex
Acquires an exclusive lock on the mutex.
Waits until the guard value is
0(unlocked) before setting it to-1to indicate that an exclusive lock is held.lock_sh
Acquires a shared lock on the mutex.
Waits until no exclusive lock is held (guard value
>= 0) and increments the guard value to indicate a shared lock is held.try_lock_ex
Attempts to acquire an exclusive lock without blocking.
If the guard value is
0(unlocked), it sets it to-1and returnstrue. Otherwise, it returnsfalse.try_lock_sh
Attempts to acquire a shared lock without blocking.
If no exclusive lock is held (guard value
>= 0), it increments the guard value and returnstrue. Otherwise, it returnsfalse.unlock
Releases the lock, whether shared or exclusive.
> 0), it decrements the guard value by 1. If no more shared locks are held (guard value becomes0), it notifies a waiting writer.-1), it sets the guard value to0and notifies all waiting readers and writers.File:
pipe.rsnew_pipe
Creates a new pipe with the specified buffer size.
Calls
EmulatedPipe::new_with_capacityto initialize the pipe.EmulatedPipe Struct
new_with_capacity
Initializes a new
EmulatedPipewith a specified buffer size.Uses a
RingBufferto split the buffer into a producer (write end) and consumer (read end).set_eof
Marks the pipe as having reached the end-of-file (EOF).
Sets the
eofflag totrue, indicating no more data will be written to the pipe.get_write_ref
Retrieves the current write reference count.
Returns the number of active write references on the pipe.
get_read_ref
Retrieves the current read reference count.
Returns the number of active read references on the pipe.
incr_ref
Increments the reference count for either read or write, based on flags.
Increases the reference count depending on whether the pipe is opened for reading (
O_RDONLY) or writing (O_WRONLY).decr_ref
Decrements the reference count for either read or write, based on flags.
Decreases the reference count depending on whether the pipe is closed for reading (
O_RDONLY) or writing (O_WRONLY).check_select_read
Checks whether the pipe is ready for reading.
Returns
trueif the pipe has data to be read or has reached EOF. Otherwise, it returnsfalse.check_select_write
Checks whether the pipe is ready for writing.
Returns
trueif there is available space in the pipe's write buffer.write_to_pipe
Writes data to the pipe from a provided memory buffer.
Attempts to write
lengthbytes into the pipe. If the pipe is full and non-blocking mode is enabled, it returnsEAGAIN. If all read ends are closed, it returnsEPIPE.read_from_pipe
Reads data from the pipe into a provided memory buffer.
Reads up to
lengthbytes. If non-blocking mode is enabled and no data is available, it returnsEAGAIN. If EOF is reached, it returns0.Debug Implementation for EmulatedPipe
Provides a custom
Debugimplementation for theEmulatedPipestruct.Displays the read/write reference counts and the EOF status.
File:
types.rsFSData Struct
Represents filesystem data, including information such as block size, total blocks, and free blocks.
This struct includes fields like
f_bsize(block size) andf_blocks(total number of blocks), among others. It is designed to maintain compatibility with thestatandfstatsystem calls.get_fdset
Retrieves a file descriptor set from the union argument.
Converts a raw pointer to an internal
FdSetand returns a reference to it if valid. Otherwise, returnsNone.get_statdatastruct
Retrieves a
statstructure from the union argument.Returns a mutable reference to a
statstructure if the pointer is valid. Otherwise, returns an error indicating an invalid data pointer.get_fsdatastruct
Retrieves a
statfsstructure from the union argument.Returns a mutable reference to a
statfsstructure if the pointer is valid. Otherwise, returns an error indicating an invalid data pointer.get_ioctlptrunion
Retrieves an
IoctlPtrUnionfrom the union argument.Returns the
IoctlPtrUnionwithout any additional validation.get_ioctl_int
Retrieves an integer from an
IoctlPtrUnion.Returns the integer value if the pointer is valid. Otherwise, returns an error indicating an invalid pointer.
get_ioctl_char
Retrieves a character (u8) from an
IoctlPtrUnion.Returns the character value if the pointer is valid. Otherwise, returns an error indicating an invalid pointer.
pack_dirents
Packs directory entries into a buffer.
Takes a vector of directory entries (
ClippedDirentstructs) and their associated names, and packs them into a buffer pointed to bybaseptr. It assumes the names are null-terminated and padded to the next 8-byte boundary.get_sockaddr
Retrieves a
SockaddrDummystructure from the union argument.Returns a mutable reference to a
SockaddrDummystructure if the pointer is valid. Otherwise, returns an error indicating an invalid data pointer.get_epollevent
Retrieves an
epoll_eventstructure from the union argument.Returns a mutable reference to an
epoll_eventstructure if the pointer is valid. Otherwise, returns an error indicating an invalid data pointer.get_itimerval
Retrieves an
itimervalstructure from the union argument.Returns a mutable reference to an
itimervalstructure if the pointer is valid. Otherwise, returns an error indicating an invalid data pointer.get_constitimerval
Retrieves a constant
itimervalstructure from the union argument.Returns a reference to an
itimervalstructure if the pointer is valid. Otherwise, returns an error indicating an invalid data pointer.get_sem
Retrieves a
sem_tstructure (semaphore) from the union argument.Returns a mutable reference to a
sem_tstructure if the pointer is valid. Otherwise, returns an error indicating an invalid data pointer.get_ifaddrs
Retrieves an
ifaddrsstructure (network interface address) from the union argument.Returns a mutable reference to an
ifaddrsstructure if the pointer is valid. Otherwise, returns an error indicating an invalid data pointer.The text was updated successfully, but these errors were encountered: