DeepSeek/3FS
1
0
Fork 0
mirror of https://github.com/deepseek-ai/3FS synced 2025-06-26 18:16:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update UsrbIo.md (#94)

Browse Source
This commit is contained in:
Yuheng Zou 2025-03-05 14:56:13 +08:00 committed by GitHub
parent 8307bce16e
commit a3f0380a30
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/lib/api/UsrbIo.md
View File

@ -63,19 +63,18 @@ void hf3fs_destroy(struct hf3fs_ior *ior);
#### Parameters #### Parameters
- **ior**: Address for Ior. - **ior**: Address for Ior.
### hf3fs_iovcreate2 ### hf3fs_iovcreate
#### Summary #### Summary
Create an Iov instance and allocate shared memory for that Iov. All `hf3fs_iovcreate*` functions create Iov instances, but include various configurable parameters due to compatibility considerations. Create an Iov instance and allocate shared memory for that Iov.
#### Syntax #### Syntax
```c ```c
int hf3fs_iovcreate2(struct hf3fs_iov *iov, int hf3fs_iovcreate(struct hf3fs_iov *iov,
const char *hf3fs_mount_point, const char *hf3fs_mount_point,
size_t size, size_t size,
size_t block_size, size_t block_size,
int numa, int numa);
const char *shm_path);
``` ```
#### Parameters #### Parameters
@ -84,7 +83,6 @@ int hf3fs_iovcreate2(struct hf3fs_iov *iov,
- **size**: Shared memory size for this Iov. - **size**: Shared memory size for this Iov.
- **block_size**: If not `0`, this function will allocate multiple shared memory blocks, each sized no larger than `block_size`. `0` for allocate a single large shared memory. All IOs on this Iov should not span across the block margin. This parameter is for optimization on IB register time. - **block_size**: If not `0`, this function will allocate multiple shared memory blocks, each sized no larger than `block_size`. `0` for allocate a single large shared memory. All IOs on this Iov should not span across the block margin. This parameter is for optimization on IB register time.
- **numa**: Numa ID for Ior shared memory. `-1` for current process numa ID. - **numa**: Numa ID for Ior shared memory. `-1` for current process numa ID.
- **shm_path**: Path of `tmpfs` mount point for shared memory allocation. If `nullptr`, use the default `/dev/shm`.
#### Return Value #### Return Value
- If success, return 0. - If success, return 0.
@ -93,7 +91,7 @@ int hf3fs_iovcreate2(struct hf3fs_iov *iov,
#### Example #### Example
```c ```c
struct hf3fs_iov iov; struct hf3fs_iov iov;
hf3fs_iovcreate2(&iov, "/hf3fs/mount/point", 1 << 30, 0, -1, nullptr); hf3fs_iovcreate(&iov, "/hf3fs/mount/point", 1 << 30, 0, -1);
hf3fs_iovdestroy(&iov); hf3fs_iovdestroy(&iov);
``` ```
@ -254,7 +252,7 @@ int main() {
hf3fs_iorcreate4(&ior, "/hf3fs/mount/point", NUM_IOS, true, 0, 0, -1, 0); hf3fs_iorcreate4(&ior, "/hf3fs/mount/point", NUM_IOS, true, 0, 0, -1, 0);
struct hf3fs_iov iov; struct hf3fs_iov iov;
hf3fs_iovcreate2(&iov, "/hf3fs/mount/point", NUM_IOS * BLOCK_SIZE, 0, -1, nullptr); hf3fs_iovcreate(&iov, "/hf3fs/mount/point", NUM_IOS * BLOCK_SIZE, 0, -1);
int fd = open("/hf3fs/mount/point/example.bin", O_RDONLY); int fd = open("/hf3fs/mount/point/example.bin", O_RDONLY);
hf3fs_reg_fd(fd, 0); hf3fs_reg_fd(fd, 0);
@ -274,4 +272,4 @@ int main() {
return 0; return 0;
} }
``` ```