ref: 958b570b8fe80913ed607a15a3548cadac8a1195
parent: f6bfcc1073939f1ee99d53853ae34c72fb6177c2
author: gkostka <[email protected]>
date: Sun Feb 19 17:03:23 EST 2017
ext4: improve dox documentation style
--- a/include/ext4.h
+++ b/include/ext4.h
@@ -58,22 +58,22 @@
/**@brief OS dependent lock interface.*/
struct ext4_lock {- /**@brief Lock access to mount point*/
+ /**@brief Lock access to mount point.*/
void (*lock)(void);
- /**@brief Unlock access to mount point*/
+ /**@brief Unlock access to mount point.*/
void (*unlock)(void);
};
/********************************FILE DESCRIPTOR*****************************/
-/**@brief File descriptor*/
+/**@brief File descriptor. */
typedef struct ext4_file {/**@brief Mount point handle.*/
struct ext4_mountpoint *mp;
- /**@brief File inode id*/
+ /**@brief File inode id.*/
uint32_t inode;
/**@brief Open flags.*/
@@ -82,13 +82,13 @@
/**@brief File size.*/
uint64_t fsize;
- /**@brief File position*/
+ /**@brief Actual file position.*/
uint64_t fpos;
} ext4_file;
/*****************************DIRECTORY DESCRIPTOR***************************/
-/**@brief Directory entry descriptor. Copy from ext4_types.h*/
+/**@brief Directory entry descriptor. */
typedef struct ext4_direntry {uint32_t inode;
uint16_t entry_length;
@@ -97,12 +97,13 @@
uint8_t name[255];
} ext4_direntry;
+/**@brief Directory descriptor. */
typedef struct ext4_dir {- /**@brief File descriptor*/
+ /**@brief File descriptor.*/
ext4_file f;
/**@brief Current directory entry.*/
ext4_direntry de;
- /**@brief Next entry offset*/
+ /**@brief Next entry offset.*/
uint64_t next_off;
} ext4_dir;
@@ -131,7 +132,7 @@
/**@brief Mount a block device with EXT4 partition to the mount point.
*
- * @param dev_name block Device name (@ref ext4_device_register).
+ * @param dev_name Block device name (@ref ext4_device_register).
* @param mount_point Mount point, for example:
* - /
* - /my_partition/
@@ -144,11 +145,13 @@
bool read_only);
/**@brief Umount operation.
- * @param mount_point mount name
- * @return standard error code */
+ *
+ * @param mount_pount Mount point.
+ *
+ * @return Standard error code */
int ext4_umount(const char *mount_point);
-/**@brief Start journaling. Journaling start/stop functions are transparent
+/**@brief Starts journaling. Journaling start/stop functions are transparent
* and might be used on filesystems without journaling support.
* @warning Usage:
* ext4_mount("sda1", "/");@@ -158,23 +161,28 @@
*
* ext4_journal_stop("/"); * ext4_umount("/");- * @param mount_point mount name
- * @return standard error code */
+ * @param mount_pount Mount point.
+ *
+ * @return Standard error code. */
int ext4_journal_start(const char *mount_point);
-/**@brief Stop journaling. Journaling start/stop functions are transparent
+/**@brief Stops journaling. Journaling start/stop functions are transparent
* and might be used on filesystems without journaling support.
- * @param mount_point mount name
- * @return standard error code */
+ *
+ * @param mount_pount Mount point name.
+ *
+ * @return Standard error code. */
int ext4_journal_stop(const char *mount_point);
/**@brief Journal recovery.
- * @param mount_point mount point
- * @warning Must be called after @ref ext4_mount
- * @return standard error code */
+ * @warning Must be called after @ref ext4_mount.
+ *
+ * @param mount_pount Mount point.
+ *
+ * @return Standard error code. */
int ext4_recover(const char *mount_point);
-/**@brief Some of the filesystem stats.*/
+/**@brief Some of the filesystem stats. */
struct ext4_mount_stats {uint32_t inodes_count;
uint32_t free_inodes_count;
@@ -189,24 +197,30 @@
char volume_name[16];
};
-/**@brief Get file system params.
- * @param mount_point mount path
- * @param stats ext fs stats
- * @return standard error code */
+/**@brief Get file mount point stats.
+ *
+ * @param mount_pount Mount point.
+ * @param stats Filesystem stats.
+ *
+ * @return Standard error code. */
int ext4_mount_point_stats(const char *mount_point,
struct ext4_mount_stats *stats);
/**@brief Setup OS lock routines.
- * @param mount_point mount path
- * @param locks - lock and unlock functions
- * @return standard error code */
+ *
+ * @param mount_pount Mount point.
+ * @param locks Lock and unlock functions
+ *
+ * @return Standard error code. */
int ext4_mount_setup_locks(const char *mount_point,
const struct ext4_lock *locks);
/**@brief Acquire the filesystem superblock pointer of a mp.
- * @param mount_point mount path
- * @param superblock pointer
- * @return standard error code */
+ *
+ * @param mount_pount Mount point.
+ * @param sb Superblock handle
+ *
+ * @return Standard error code. */
int ext4_get_sblock(const char *mount_point, struct ext4_sblock **sb);
/**@brief Enable/disable write back cache mode.
@@ -240,43 +254,48 @@
* Write back mode is useful when you want to create a lot of empty
* files/directories.
*
- * @param path mount point path
- * @param on enable/disable
+ * @param mount_pount Mount point.
+ * @param on Enable/disable cache writeback mode.
*
- * @return standard error code */
+ * @return Standard error code. */
int ext4_cache_write_back(const char *path, bool on);
/**@brief Force cache flush.
*
- * @param path mount point path
+ * @param mount_pount Mount point.
*
- * @return standard error code */
+ * @return Standard error code. */
int ext4_cache_flush(const char *path);
/********************************FILE OPERATIONS*****************************/
/**@brief Remove file by path.
- * @param path path to file
- * @return standard error code */
+ *
+ * @param path Path to file.
+ *
+ * @return Standard error code. */
int ext4_fremove(const char *path);
-/**@brief create a hardlink for a file.
- * @param path path to file
- * @param hardlink_path path of hardlink
- * @return standard error code */
+/**@brief Create a hardlink for a file.
+ *
+ * @param path Path to file.
+ * @param hardlink_path Path of hardlink.
+ *
+ * @return Standard error code. */
int ext4_flink(const char *path, const char *hardlink_path);
-/**@brief Rename file
- * @param path source
- * @param new_path destination
- * @return standard error code */
+/**@brief Rename file.
+ * @param path Source.
+ * @param new_path Destination.
+ * @return Standard error code. */
int ext4_frename(const char *path, const char *new_path);
/**@brief File open function.
- * @param path filename (has to start from mount point)
- * /my_partition/my_file
- * @param flags open file flags
+ *
+ * @param file File handle.
+ * @param path File path, has to start from mount point:/my_partition/file.
+ * @param flags File open flags.
* |---------------------------------------------------------------|
* | r or rb O_RDONLY |
* |---------------------------------------------------------------|
@@ -291,191 +310,242 @@
* | a+ or ab+ or a+b O_RDWR|O_CREAT|O_APPEND |
* |---------------------------------------------------------------|
*
- * @return standard error code*/
-int ext4_fopen(ext4_file *f, const char *path, const char *flags);
+ * @return Standard error code.*/
+int ext4_fopen(ext4_file *file, const char *path, const char *flags);
/**@brief Alternate file open function.
- * @param filename, (has to start from mount point)
- * /my_partition/my_file
- * @param flags open file flags
- * @return standard error code*/
-int ext4_fopen2(ext4_file *f, const char *path, int flags);
+ *
+ * @param file File handle.
+ * @param path File path, has to start from mount point:/my_partition/file.
+ * @param flags File open flags.
+ *
+ * @return Standard error code.*/
+int ext4_fopen2(ext4_file *file, const char *path, int flags);
/**@brief File close function.
- * @param f file handle
- * @return standard error code*/
-int ext4_fclose(ext4_file *f);
+ *
+ * @param file File handle.
+ *
+ * @return Standard error code.*/
+int ext4_fclose(ext4_file *file);
-/**@brief Fill in the ext4_inode buffer.
- * @param path fetch inode data of the path
- * @param ret_ino the inode id of the path
- * @param ext4_inode buffer
- * @return standard error code*/
-int ext4_fill_raw_inode(const char *path, uint32_t *ret_ino,
- struct ext4_inode *inode);
/**@brief File truncate function.
- * @param f file handle
- * @param new file size
- * @return standard error code*/
-int ext4_ftruncate(ext4_file *f, uint64_t size);
+ *
+ * @param file File handle.
+ * @param size New file size.
+ *
+ * @return Standard error code.*/
+int ext4_ftruncate(ext4_file *file, uint64_t size);
/**@brief Read data from file.
- * @param f file handle
- * @param buf output buffer
- * @param size bytes to read
- * @param rcnt bytes read (may be NULL)
- * @return standard error code*/
-int ext4_fread(ext4_file *f, void *buf, size_t size, size_t *rcnt);
+ *
+ * @param file File handle.
+ * @param buf Output buffer.
+ * @param size Bytes to read.
+ * @param rcnt Bytes read (NULL allowed).
+ *
+ * @return Standard error code.*/
+int ext4_fread(ext4_file *file, void *buf, size_t size, size_t *rcnt);
/**@brief Write data to file.
- * @param f file handle
- * @param buf data to write
- * @param size write length
- * @param wcnt bytes written (may be NULL)
- * @return standard error code*/
-int ext4_fwrite(ext4_file *f, const void *buf, size_t size, size_t *wcnt);
+ *
+ * @param file File handle.
+ * @param buf Data to write
+ * @param size Write length..
+ * @param wcnt Bytes written (NULL allowed).
+ *
+ * @return Standard error code.*/
+int ext4_fwrite(ext4_file *file, const void *buf, size_t size, size_t *wcnt);
/**@brief File seek operation.
- * @param f file handle
- * @param offset offset to seek
- * @param origin seek type:
+ *
+ * @param file File handle.
+ * @param offset Offset to seek.
+ * @param origin Seek type:
* @ref SEEK_SET
* @ref SEEK_CUR
* @ref SEEK_END
- * @return standard error code*/
-int ext4_fseek(ext4_file *f, uint64_t offset, uint32_t origin);
+ *
+ * @return Standard error code.*/
+int ext4_fseek(ext4_file *file, uint64_t offset, uint32_t origin);
/**@brief Get file position.
- * @param f file handle
- * @return actual file position */
-uint64_t ext4_ftell(ext4_file *f);
+ *
+ * @param file File handle.
+ *
+ * @return Actual file position */
+uint64_t ext4_ftell(ext4_file *file);
/**@brief Get file size.
- * @param f file handle
- * @return file size */
-uint64_t ext4_fsize(ext4_file *f);
+ *
+ * @param file File handle.
+ *
+ * @return File size. */
+uint64_t ext4_fsize(ext4_file *file);
-/**@brief Change file/directory/link mode bits
- * @param path to file/dir/link
- * @param mode new mode bits (for example 0777)
- * @return standard error code*/
+
+/**@brief Get inode of file/directory/link.
+ *
+ * @param path Parh to file/dir/link.
+ * @param ret_ino Inode number.
+ * @param inode Inode internals.
+ *
+ * @return Standard error code.*/
+int ext4_raw_inode_fill(const char *path, uint32_t *ret_ino,
+ struct ext4_inode *inode);
+
+/**@brief Change file/directory/link mode bits.
+ *
+ * @param path Path to file/dir/link.
+ * @param mode New mode bits (for example 0777).
+ *
+ * @return Standard error code.*/
int ext4_mode_set(const char *path, uint32_t mode);
-/**@brief Get file/directory/link mode bits
- * @param path to file/dir/link
- * @param mode new mode bits (for example 0777)
- * @return standard error code*/
+/**@brief Get file/directory/link mode bits.
+ *
+ * @param path Path to file/dir/link.
+ * @param mode New mode bits (for example 0777).
+ *
+ * @return Standard error code.*/
int ext4_mode_get(const char *path, uint32_t *mode);
-/**@brief Change file owner and group
- * @param path to file/dir/link
- * @param uid user id
- * @param gid group id
- * @return standard error code*/
+/**@brief Change file owner and group.
+ *
+ * @param path Path to file/dir/link.
+ * @param uid User id.
+ * @param gid Group id.
+ *
+ * @return Standard error code.*/
int ext4_owner_set(const char *path, uint32_t uid, uint32_t gid);
-/**@brief Get file/directory/link owner and group
- * @param path to file/dir/link
- * @param uid user id
- * @param gid group id
- * @return standard error code*/
+/**@brief Get file/directory/link owner and group.
+ *
+ * @param path Path to file/dir/link.
+ * @param uid User id.
+ * @param gid Group id.
+ *
+ * @return Standard error code.*/
int ext4_owner_get(const char *path, uint32_t *uid, uint32_t *gid);
-/**@brief Set file/directory/link access time
- * @param path to file/dir/link
- * @param atime access timestamp
- * @return standard error code*/
+/**@brief Set file/directory/link access time.
+ *
+ * @param path Path to file/dir/link.
+ * @param atime Access timestamp.
+ *
+ * @return Standard error code.*/
int ext4_atime_set(const char *path, uint32_t atime);
-/**@brief Set file/directory/link modify time
- * @param path to file/dir/link
- * @param mtime modify timestamp
- * @return standard error code*/
+/**@brief Set file/directory/link modify time.
+ *
+ * @param path Path to file/dir/link.
+ * @param mtime Modify timestamp.
+ *
+ * @return Standard error code.*/
int ext4_mtime_set(const char *path, uint32_t mtime);
-/**@brief Set file/directory/link change time
- * @param path to file/dir/link
- * @param ctime change timestamp
- * @return standard error code*/
+/**@brief Set file/directory/link change time.
+ *
+ * @param path Path to file/dir/link.
+ * @param ctime Change timestamp.
+ *
+ * @return Standard error code.*/
int ext4_ctime_set(const char *path, uint32_t ctime);
-/**@brief Get file/directory/link access time
- * @param path to file/dir/link
- * @param atime access timestamp
- * @return standard error code*/
+/**@brief Get file/directory/link access time.
+ *
+ * @param path Path to file/dir/link.
+ * @param atime Access timestamp.
+ *
+ * @return Standard error code.*/
int ext4_atime_get(const char *path, uint32_t *atime);
-/**@brief Get file/directory/link modify time
- * @param path to file/dir/link
- * @param mtime modify timestamp
- * @return standard error code*/
+/**@brief Get file/directory/link modify time.
+ *
+ * @param path Path to file/dir/link.
+ * @param mtime Modify timestamp.
+ *
+ * @return Standard error code.*/
int ext4_mtime_get(const char *path, uint32_t *mtime);
-/**@brief Get file/directory/link change time
- * @param path to file/dir/link
- * @param ctime change timestamp
+/**@brief Get file/directory/link change time.
+ *
+ * @param path Pathto file/dir/link.
+ * @param ctime Change timestamp.
+ *
* @return standard error code*/
int ext4_ctime_get(const char *path, uint32_t *ctime);
-/**@brief Create symbolic link
- * @param target destination path
- * @param path source entry
- * @return standard error code*/
+/**@brief Create symbolic link.
+ *
+ * @param target Destination entry path.
+ * @param path Source entry path.
+ *
+ * @return Standard error code.*/
int ext4_fsymlink(const char *target, const char *path);
-/**@brief Create special file
- * @param path path to new file
- * @param filetype The filetype of the new special file
- * (that must not be regular file, directory, or unknown type)
- * @param dev if filetype is char device or block device,
- * the device number will become the payload in the inode
- * @return standard error code*/
+/**@brief Create special file.
+ * @param path Path to new special file.
+ * @param filetype Filetype of the new special file.
+ * (that must not be regular file, directory, or unknown type)
+ * @param dev If filetype is char device or block device,
+ * the device number will become the payload in the inode.
+ * @return Standard error code.*/
int ext4_mknod(const char *path, int filetype, uint32_t dev);
-/**@brief Read symbolic link payload
- * @param path to symlink
- * @param buf output buffer
- * @param bufsize output buffer max size
- * @param rcnt bytes read
- * @return standard error code*/
+/**@brief Read symbolic link payload.
+ *
+ * @param path Path to symlink.
+ * @param buf Output buffer.
+ * @param bufsize Output buffer max size.
+ * @param rcnt Bytes read.
+ *
+ * @return Standard error code.*/
int ext4_readlink(const char *path, char *buf, size_t bufsize, size_t *rcnt);
-/**@brief Set extended attribute
- * @param path to file/directory
- * @param name name of the entry to add
- * @param name_len length of @name in bytes
- * @param data data of the entry to add
- * @param data_size size of data to add
- * @param replace this boolean is deprecated.
- * @return standard error code*/
+/**@brief Set extended attribute.
+ *
+ * @param path Path to file/directory
+ * @param name Name of the entry to add.
+ * @param name_len Length of @name in bytes.
+ * @param data Data of the entry to add.
+ * @param data_size Size of data to add.
+ *
+ * @return Standard error code.*/
int ext4_setxattr(const char *path, const char *name, size_t name_len,
- const void *data, size_t data_size, bool replace);
+ const void *data, size_t data_size);
-/**@brief Get extended attribute
- * @param path to file/directory
- * @param name name of the entry to get
- * @param name_len length of @name in bytes
- * @param data data of the entry to get
- * @param data_size size of data to get
- * @return standard error code*/
+/**@brief Get extended attribute.
+ *
+ * @param path Path to file/directory.
+ * @param name Name of the entry to get.
+ * @param name_len Length of @name in bytes.
+ * @param data Data of the entry to get.
+ * @param data_size Size of data to get.
+ *
+ * @return Standard error code.*/
int ext4_getxattr(const char *path, const char *name, size_t name_len,
void *buf, size_t buf_size, size_t *data_size);
-/**@brief List extended attributes
- * @param path to file/directory
- * @param list list to hold the name of entries
- * @param size size of @list in bytes
- * @param ret_size used bytes of @list
- * @return standard error code*/
+/**@brief List extended attributes.
+ *
+ * @param path Path to file/directory.
+ * @param list List to hold the name of entries.
+ * @param size Size of @list in bytes.
+ * @param ret_size Used bytes of @list.
+ *
+ * @return Standard error code.*/
int ext4_listxattr(const char *path, char *list, size_t size, size_t *ret_size);
-/**@brief Remove extended attribute
- * @param path to file/directory
- * @param name name of the entry to remove
- * @param name_len length of @name in bytes
- * @return standard error code*/
+/**@brief Remove extended attribute.
+ *
+ * @param path Path to file/directory.
+ * @param name Name of the entry to remove.
+ * @param name_len Length of @name in bytes.
+ *
+ * @return Standard error code.*/
int ext4_removexattr(const char *path, const char *name, size_t name_len);
@@ -482,41 +552,53 @@
/*********************************DIRECTORY OPERATION***********************/
/**@brief Recursive directory remove.
- * @param path directory path to remove
- * @return standard error code*/
+ *
+ * @param path Directory path to remove
+ *
+ * @return Standard error code.*/
int ext4_dir_rm(const char *path);
-/**@brief Rename/move directory
- * @param path source
- * @param new_path destination
- * @return standard error code */
+/**@brief Rename/move directory.
+ *
+ * @param path Source path.
+ * @param new_path Destination path.
+ *
+ * @return Standard error code. */
int ext4_dir_mv(const char *path, const char *new_path);
/**@brief Create new directory.
- * @param name new directory name
- * @return standard error code*/
+ *
+ * @param path Directory name.
+ *
+ * @return Standard error code.*/
int ext4_dir_mk(const char *path);
/**@brief Directory open.
- * @param d directory handle
- * @param path directory path
- * @return standard error code*/
-int ext4_dir_open(ext4_dir *d, const char *path);
+ *
+ * @param dir Directory handle.
+ * @param path Directory path.
+ *
+ * @return Standard error code.*/
+int ext4_dir_open(ext4_dir *dir, const char *path);
/**@brief Directory close.
- * @param d directory handle
- * @return standard error code*/
-int ext4_dir_close(ext4_dir *d);
+ *
+ * @param dir directory handle.
+ *
+ * @return Standard error code.*/
+int ext4_dir_close(ext4_dir *dir);
/**@brief Return next directory entry.
- * @param d directory handle
- * @param id entry id
- * @return directory entry id (NULL if no entry)*/
-const ext4_direntry *ext4_dir_entry_next(ext4_dir *d);
+ *
+ * @param dir Directory handle.
+ *
+ * @return Directory entry id (NULL if no entry)*/
+const ext4_direntry *ext4_dir_entry_next(ext4_dir *dir);
/**@brief Rewine directory entry offset.
- * @param d directory handle*/
-void ext4_dir_entry_rewind(ext4_dir *d);
+ *
+ * @param dir Directory handle.*/
+void ext4_dir_entry_rewind(ext4_dir *dir);
#ifdef __cplusplus
--- a/src/ext4.c
+++ b/src/ext4.c
@@ -1531,49 +1531,9 @@
return r;
}
-int ext4_fill_raw_inode(const char *path, uint32_t *ret_ino,
- struct ext4_inode *inode)
+int ext4_fopen(ext4_file *file, const char *path, const char *flags)
{- int r;
- ext4_file f;
- struct ext4_inode_ref inode_ref;
struct ext4_mountpoint *mp = ext4_get_mount(path);
- uint32_t ino;
-
- if (!mp)
- return ENOENT;
-
- EXT4_MP_LOCK(mp);
-
- r = ext4_generic_open2(&f, path, O_RDONLY, EXT4_DE_UNKNOWN, NULL, NULL);
- if (r != EOK) {- EXT4_MP_UNLOCK(mp);
- return r;
- }
-
- ino = f.inode;
- ext4_fclose(&f);
-
- /*Load parent*/
- r = ext4_fs_get_inode_ref(&mp->fs, ino, &inode_ref);
- if (r != EOK) {- EXT4_MP_UNLOCK(mp);
- return r;
- }
-
- memcpy(inode, inode_ref.inode, sizeof(struct ext4_inode));
- ext4_fs_put_inode_ref(&inode_ref);
- EXT4_MP_UNLOCK(mp);
-
- if (ret_ino)
- *ret_ino = ino;
-
- return r;
-}
-
-int ext4_fopen(ext4_file *f, const char *path, const char *flags)
-{- struct ext4_mountpoint *mp = ext4_get_mount(path);
int r;
if (!mp)
@@ -1582,7 +1542,7 @@
EXT4_MP_LOCK(mp);
ext4_block_cache_write_back(mp->fs.bdev, 1);
- r = ext4_generic_open(f, path, flags, true, 0, 0);
+ r = ext4_generic_open(file, path, flags, true, 0, 0);
ext4_block_cache_write_back(mp->fs.bdev, 0);
EXT4_MP_UNLOCK(mp);
@@ -1589,7 +1549,7 @@
return r;
}
-int ext4_fopen2(ext4_file *f, const char *path, int flags)
+int ext4_fopen2(ext4_file *file, const char *path, int flags)
{struct ext4_mountpoint *mp = ext4_get_mount(path);
int r;
@@ -1603,7 +1563,7 @@
EXT4_MP_LOCK(mp);
ext4_block_cache_write_back(mp->fs.bdev, 1);
- r = ext4_generic_open2(f, path, flags, filetype, NULL, NULL);
+ r = ext4_generic_open2(file, path, flags, filetype, NULL, NULL);
ext4_block_cache_write_back(mp->fs.bdev, 0);
EXT4_MP_UNLOCK(mp);
@@ -1610,52 +1570,52 @@
return r;
}
-int ext4_fclose(ext4_file *f)
+int ext4_fclose(ext4_file *file)
{- ext4_assert(f && f->mp);
+ ext4_assert(file && file->mp);
- f->mp = 0;
- f->flags = 0;
- f->inode = 0;
- f->fpos = f->fsize = 0;
+ file->mp = 0;
+ file->flags = 0;
+ file->inode = 0;
+ file->fpos = file->fsize = 0;
return EOK;
}
-static int ext4_ftruncate_no_lock(ext4_file *f, uint64_t size)
+static int ext4_ftruncate_no_lock(ext4_file *file, uint64_t size)
{struct ext4_inode_ref ref;
int r;
- r = ext4_fs_get_inode_ref(&f->mp->fs, f->inode, &ref);
+ r = ext4_fs_get_inode_ref(&file->mp->fs, file->inode, &ref);
if (r != EOK) {- EXT4_MP_UNLOCK(f->mp);
+ EXT4_MP_UNLOCK(file->mp);
return r;
}
/*Sync file size*/
- f->fsize = ext4_inode_get_size(&f->mp->fs.sb, ref.inode);
- if (f->fsize <= size) {+ file->fsize = ext4_inode_get_size(&file->mp->fs.sb, ref.inode);
+ if (file->fsize <= size) {r = EOK;
goto Finish;
}
/*Start write back cache mode.*/
- r = ext4_block_cache_write_back(f->mp->fs.bdev, 1);
+ r = ext4_block_cache_write_back(file->mp->fs.bdev, 1);
if (r != EOK)
goto Finish;
- r = ext4_trunc_inode(f->mp, ref.index, size);
+ r = ext4_trunc_inode(file->mp, ref.index, size);
if (r != EOK)
goto Finish;
- f->fsize = size;
- if (f->fpos > size)
- f->fpos = size;
+ file->fsize = size;
+ if (file->fpos > size)
+ file->fpos = size;
/*Stop write back cache mode*/
- ext4_block_cache_write_back(f->mp->fs.bdev, 0);
+ ext4_block_cache_write_back(file->mp->fs.bdev, 0);
if (r != EOK)
goto Finish;
@@ -1690,7 +1650,7 @@
return r;
}
-int ext4_fread(ext4_file *f, void *buf, size_t size, size_t *rcnt)
+int ext4_fread(ext4_file *file, void *buf, size_t size, size_t *rcnt)
{uint32_t unalg;
uint32_t iblock_idx;
@@ -1705,50 +1665,50 @@
int r;
struct ext4_inode_ref ref;
- ext4_assert(f && f->mp);
+ ext4_assert(file && file->mp);
- if (f->flags & O_WRONLY)
+ if (file->flags & O_WRONLY)
return EPERM;
if (!size)
return EOK;
- EXT4_MP_LOCK(f->mp);
+ EXT4_MP_LOCK(file->mp);
- struct ext4_fs *const fs = &f->mp->fs;
- struct ext4_sblock *const sb = &f->mp->fs.sb;
+ struct ext4_fs *const fs = &file->mp->fs;
+ struct ext4_sblock *const sb = &file->mp->fs.sb;
if (rcnt)
*rcnt = 0;
- r = ext4_fs_get_inode_ref(fs, f->inode, &ref);
+ r = ext4_fs_get_inode_ref(fs, file->inode, &ref);
if (r != EOK) {- EXT4_MP_UNLOCK(f->mp);
+ EXT4_MP_UNLOCK(file->mp);
return r;
}
/*Sync file size*/
- f->fsize = ext4_inode_get_size(sb, ref.inode);
+ file->fsize = ext4_inode_get_size(sb, ref.inode);
block_size = ext4_sb_get_block_size(sb);
- size = ((uint64_t)size > (f->fsize - f->fpos))
- ? ((size_t)(f->fsize - f->fpos)) : size;
+ size = ((uint64_t)size > (file->fsize - file->fpos))
+ ? ((size_t)(file->fsize - file->fpos)) : size;
- iblock_idx = (uint32_t)((f->fpos) / block_size);
- iblock_last = (uint32_t)((f->fpos + size) / block_size);
- unalg = (f->fpos) % block_size;
+ iblock_idx = (uint32_t)((file->fpos) / block_size);
+ iblock_last = (uint32_t)((file->fpos + size) / block_size);
+ unalg = (file->fpos) % block_size;
/*If the size of symlink is smaller than 60 bytes*/
bool softlink;
softlink = ext4_inode_is_type(sb, ref.inode, EXT4_INODE_MODE_SOFTLINK);
- if (softlink && f->fsize < sizeof(ref.inode->blocks)
+ if (softlink && file->fsize < sizeof(ref.inode->blocks)
&& !ext4_inode_get_blocks_count(sb, ref.inode)) {char *content = (char *)ref.inode->blocks;
- if (f->fpos < f->fsize) {+ if (file->fpos < file->fsize) {size_t len = size;
- if (unalg + size > (uint32_t)f->fsize)
- len = (uint32_t)f->fsize - unalg;
+ if (unalg + size > (uint32_t)file->fsize)
+ len = (uint32_t)file->fsize - unalg;
memcpy(buf, content + unalg, len);
if (rcnt)
*rcnt = len;
@@ -1771,7 +1731,7 @@
/* Do we get an unwritten range? */
if (fblock != 0) {uint64_t off = fblock * block_size + unalg;
- r = ext4_block_readbytes(f->mp->fs.bdev, off, u8_buf, len);
+ r = ext4_block_readbytes(file->mp->fs.bdev, off, u8_buf, len);
if (r != EOK)
goto Finish;
@@ -1782,7 +1742,7 @@
u8_buf += len;
size -= len;
- f->fpos += len;
+ file->fpos += len;
if (rcnt)
*rcnt += len;
@@ -1810,7 +1770,7 @@
fblock_count++;
}
- r = ext4_blocks_get_direct(f->mp->fs.bdev, u8_buf, fblock_start,
+ r = ext4_blocks_get_direct(file->mp->fs.bdev, u8_buf, fblock_start,
fblock_count);
if (r != EOK)
goto Finish;
@@ -1817,7 +1777,7 @@
size -= block_size * fblock_count;
u8_buf += block_size * fblock_count;
- f->fpos += block_size * fblock_count;
+ file->fpos += block_size * fblock_count;
if (rcnt)
*rcnt += block_size * fblock_count;
@@ -1833,11 +1793,11 @@
goto Finish;
off = fblock * block_size;
- r = ext4_block_readbytes(f->mp->fs.bdev, off, u8_buf, size);
+ r = ext4_block_readbytes(file->mp->fs.bdev, off, u8_buf, size);
if (r != EOK)
goto Finish;
- f->fpos += size;
+ file->fpos += size;
if (rcnt)
*rcnt += size;
@@ -1845,11 +1805,11 @@
Finish:
ext4_fs_put_inode_ref(&ref);
- EXT4_MP_UNLOCK(f->mp);
+ EXT4_MP_UNLOCK(file->mp);
return r;
}
-int ext4_fwrite(ext4_file *f, const void *buf, size_t size, size_t *wcnt)
+int ext4_fwrite(ext4_file *file, const void *buf, size_t size, size_t *wcnt)
{uint32_t unalg;
uint32_t iblk_idx;
@@ -1865,42 +1825,42 @@
const uint8_t *u8_buf = buf;
int r, rr = EOK;
- ext4_assert(f && f->mp);
+ ext4_assert(file && file->mp);
- if (f->mp->fs.read_only)
+ if (file->mp->fs.read_only)
return EROFS;
- if (f->flags & O_RDONLY)
+ if (file->flags & O_RDONLY)
return EPERM;
if (!size)
return EOK;
- EXT4_MP_LOCK(f->mp);
- ext4_trans_start(f->mp);
+ EXT4_MP_LOCK(file->mp);
+ ext4_trans_start(file->mp);
- struct ext4_fs *const fs = &f->mp->fs;
- struct ext4_sblock *const sb = &f->mp->fs.sb;
+ struct ext4_fs *const fs = &file->mp->fs;
+ struct ext4_sblock *const sb = &file->mp->fs.sb;
if (wcnt)
*wcnt = 0;
- r = ext4_fs_get_inode_ref(fs, f->inode, &ref);
+ r = ext4_fs_get_inode_ref(fs, file->inode, &ref);
if (r != EOK) {- ext4_trans_abort(f->mp);
- EXT4_MP_UNLOCK(f->mp);
+ ext4_trans_abort(file->mp);
+ EXT4_MP_UNLOCK(file->mp);
return r;
}
/*Sync file size*/
- f->fsize = ext4_inode_get_size(sb, ref.inode);
+ file->fsize = ext4_inode_get_size(sb, ref.inode);
block_size = ext4_sb_get_block_size(sb);
- iblock_last = (uint32_t)((f->fpos + size) / block_size);
- iblk_idx = (uint32_t)(f->fpos / block_size);
- ifile_blocks = (uint32_t)((f->fsize + block_size - 1) / block_size);
+ iblock_last = (uint32_t)((file->fpos + size) / block_size);
+ iblk_idx = (uint32_t)(file->fpos / block_size);
+ ifile_blocks = (uint32_t)((file->fsize + block_size - 1) / block_size);
- unalg = (f->fpos) % block_size;
+ unalg = (file->fpos) % block_size;
if (unalg) {size_t len = size;
@@ -1913,13 +1873,13 @@
goto Finish;
off = fblk * block_size + unalg;
- r = ext4_block_writebytes(f->mp->fs.bdev, off, u8_buf, len);
+ r = ext4_block_writebytes(file->mp->fs.bdev, off, u8_buf, len);
if (r != EOK)
goto Finish;
u8_buf += len;
size -= len;
- f->fpos += len;
+ file->fpos += len;
if (wcnt)
*wcnt += len;
@@ -1928,7 +1888,7 @@
}
/*Start write back cache mode.*/
- r = ext4_block_cache_write_back(f->mp->fs.bdev, 1);
+ r = ext4_block_cache_write_back(file->mp->fs.bdev, 1);
if (r != EOK)
goto Finish;
@@ -1965,7 +1925,7 @@
fblock_count++;
}
- r = ext4_blocks_set_direct(f->mp->fs.bdev, u8_buf, fblock_start,
+ r = ext4_blocks_set_direct(file->mp->fs.bdev, u8_buf, fblock_start,
fblock_count);
if (r != EOK)
break;
@@ -1972,7 +1932,7 @@
size -= block_size * fblock_count;
u8_buf += block_size * fblock_count;
- f->fpos += block_size * fblock_count;
+ file->fpos += block_size * fblock_count;
if (wcnt)
*wcnt += block_size * fblock_count;
@@ -1990,7 +1950,7 @@
}
/*Stop write back cache mode*/
- ext4_block_cache_write_back(f->mp->fs.bdev, 0);
+ ext4_block_cache_write_back(file->mp->fs.bdev, 0);
if (r != EOK)
goto Finish;
@@ -2009,11 +1969,11 @@
}
off = fblk * block_size;
- r = ext4_block_writebytes(f->mp->fs.bdev, off, u8_buf, size);
+ r = ext4_block_writebytes(file->mp->fs.bdev, off, u8_buf, size);
if (r != EOK)
goto Finish;
- f->fpos += size;
+ file->fpos += size;
if (wcnt)
*wcnt += size;
@@ -2020,9 +1980,9 @@
}
out_fsize:
- if (f->fpos > f->fsize) {- f->fsize = f->fpos;
- ext4_inode_set_size(ref.inode, f->fsize);
+ if (file->fpos > file->fsize) {+ file->fsize = file->fpos;
+ ext4_inode_set_size(ref.inode, file->fsize);
ref.dirty = true;
}
@@ -2030,47 +1990,47 @@
r = ext4_fs_put_inode_ref(&ref);
if (r != EOK)
- ext4_trans_abort(f->mp);
+ ext4_trans_abort(file->mp);
else
- ext4_trans_stop(f->mp);
+ ext4_trans_stop(file->mp);
- EXT4_MP_UNLOCK(f->mp);
+ EXT4_MP_UNLOCK(file->mp);
return r;
}
-int ext4_fseek(ext4_file *f, uint64_t offset, uint32_t origin)
+int ext4_fseek(ext4_file *file, uint64_t offset, uint32_t origin)
{ switch (origin) {case SEEK_SET:
- if (offset > f->fsize)
+ if (offset > file->fsize)
return EINVAL;
- f->fpos = offset;
+ file->fpos = offset;
return EOK;
case SEEK_CUR:
- if ((offset + f->fpos) > f->fsize)
+ if ((offset + file->fpos) > file->fsize)
return EINVAL;
- f->fpos += offset;
+ file->fpos += offset;
return EOK;
case SEEK_END:
- if (offset > f->fsize)
+ if (offset > file->fsize)
return EINVAL;
- f->fpos = f->fsize - offset;
+ file->fpos = file->fsize - offset;
return EOK;
}
return EINVAL;
}
-uint64_t ext4_ftell(ext4_file *f)
+uint64_t ext4_ftell(ext4_file *file)
{- return f->fpos;
+ return file->fpos;
}
-uint64_t ext4_fsize(ext4_file *f)
+uint64_t ext4_fsize(ext4_file *file)
{- return f->fsize;
+ return file->fsize;
}
@@ -2111,6 +2071,43 @@
return r;
}
+
+int ext4_raw_inode_fill(const char *path, uint32_t *ret_ino,
+ struct ext4_inode *inode)
+{+ int r;
+ ext4_file f;
+ struct ext4_inode_ref inode_ref;
+ struct ext4_mountpoint *mp = ext4_get_mount(path);
+
+ if (!mp)
+ return ENOENT;
+
+ EXT4_MP_LOCK(mp);
+
+ r = ext4_generic_open2(&f, path, O_RDONLY, EXT4_DE_UNKNOWN, NULL, NULL);
+ if (r != EOK) {+ EXT4_MP_UNLOCK(mp);
+ return r;
+ }
+
+ /*Load parent*/
+ r = ext4_fs_get_inode_ref(&mp->fs, f.inode, &inode_ref);
+ if (r != EOK) {+ EXT4_MP_UNLOCK(mp);
+ return r;
+ }
+
+ if (ret_ino)
+ *ret_ino = f.inode;
+
+ memcpy(inode, inode_ref.inode, sizeof(struct ext4_inode));
+ ext4_fs_put_inode_ref(&inode_ref);
+ EXT4_MP_UNLOCK(mp);
+
+ return r;
+}
+
int ext4_mode_set(const char *path, uint32_t mode)
{int r;
@@ -2627,7 +2624,7 @@
}
int ext4_setxattr(const char *path, const char *name, size_t name_len,
- const void *data, size_t data_size, bool replace __unused)
+ const void *data, size_t data_size)
{bool found;
int r = EOK;
@@ -3137,7 +3134,7 @@
return r;
}
-int ext4_dir_open(ext4_dir *d, const char *path)
+int ext4_dir_open(ext4_dir *dir, const char *path)
{struct ext4_mountpoint *mp = ext4_get_mount(path);
int r;
@@ -3146,18 +3143,18 @@
return ENOENT;
EXT4_MP_LOCK(mp);
- r = ext4_generic_open(&d->f, path, "r", false, 0, 0);
- d->next_off = 0;
+ r = ext4_generic_open(&dir->f, path, "r", false, 0, 0);
+ dir->next_off = 0;
EXT4_MP_UNLOCK(mp);
return r;
}
-int ext4_dir_close(ext4_dir *d)
+int ext4_dir_close(ext4_dir *dir)
{- return ext4_fclose(&d->f);
+ return ext4_fclose(&dir->f);
}
-const ext4_direntry *ext4_dir_entry_next(ext4_dir *d)
+const ext4_direntry *ext4_dir_entry_next(ext4_dir *dir)
{#define EXT4_DIR_ENTRY_OFFSET_TERM (uint64_t)(-1)
@@ -3164,56 +3161,56 @@
int r;
uint16_t name_length;
ext4_direntry *de = 0;
- struct ext4_inode_ref dir;
+ struct ext4_inode_ref dir_inode;
struct ext4_dir_iter it;
- EXT4_MP_LOCK(d->f.mp);
+ EXT4_MP_LOCK(dir->f.mp);
- if (d->next_off == EXT4_DIR_ENTRY_OFFSET_TERM) {- EXT4_MP_UNLOCK(d->f.mp);
+ if (dir->next_off == EXT4_DIR_ENTRY_OFFSET_TERM) {+ EXT4_MP_UNLOCK(dir->f.mp);
return 0;
}
- r = ext4_fs_get_inode_ref(&d->f.mp->fs, d->f.inode, &dir);
+ r = ext4_fs_get_inode_ref(&dir->f.mp->fs, dir->f.inode, &dir_inode);
if (r != EOK) {goto Finish;
}
- r = ext4_dir_iterator_init(&it, &dir, d->next_off);
+ r = ext4_dir_iterator_init(&it, &dir_inode, dir->next_off);
if (r != EOK) {- ext4_fs_put_inode_ref(&dir);
+ ext4_fs_put_inode_ref(&dir_inode);
goto Finish;
}
- memset(&d->de.name, 0, sizeof(d->de.name));
- name_length = ext4_dir_en_get_name_len(&d->f.mp->fs.sb,
+ memset(&dir->de.name, 0, sizeof(dir->de.name));
+ name_length = ext4_dir_en_get_name_len(&dir->f.mp->fs.sb,
it.curr);
- memcpy(&d->de.name, it.curr->name, name_length);
+ memcpy(&dir->de.name, it.curr->name, name_length);
/* Directly copying the content isn't safe for Big-endian targets*/
- d->de.inode = ext4_dir_en_get_inode(it.curr);
- d->de.entry_length = ext4_dir_en_get_entry_len(it.curr);
- d->de.name_length = name_length;
- d->de.inode_type = ext4_dir_en_get_inode_type(&d->f.mp->fs.sb,
+ dir->de.inode = ext4_dir_en_get_inode(it.curr);
+ dir->de.entry_length = ext4_dir_en_get_entry_len(it.curr);
+ dir->de.name_length = name_length;
+ dir->de.inode_type = ext4_dir_en_get_inode_type(&dir->f.mp->fs.sb,
it.curr);
- de = &d->de;
+ de = &dir->de;
ext4_dir_iterator_next(&it);
- d->next_off = it.curr ? it.curr_off : EXT4_DIR_ENTRY_OFFSET_TERM;
+ dir->next_off = it.curr ? it.curr_off : EXT4_DIR_ENTRY_OFFSET_TERM;
ext4_dir_iterator_fini(&it);
- ext4_fs_put_inode_ref(&dir);
+ ext4_fs_put_inode_ref(&dir_inode);
Finish:
- EXT4_MP_UNLOCK(d->f.mp);
+ EXT4_MP_UNLOCK(dir->f.mp);
return de;
}
-void ext4_dir_entry_rewind(ext4_dir *d)
+void ext4_dir_entry_rewind(ext4_dir *dir)
{- d->next_off = 0;
+ dir->next_off = 0;
}
/**