Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

实现SYS_LINK和SYS_LINKAT #611

Merged
merged 5 commits into from
Mar 22, 2024

Conversation

schulice
Copy link
Contributor

@schulice schulice commented Mar 16, 2024

User description

目的

希望提供一个方便在用户态测试文件系统link的接口。
实现了才想起来应当先提个issue,索性测完交个pr。

实现方法

实现do_linkat(),在link()及linkat()中直接调用。
do_linkat()调用inode的link()

可能不合规范的行为

  1. do_linkat()写在vfs/syscall.rs中
  2. 在syscall/mod.rs中import了AtFlags

功能测试

在/ramte上挂载了ramfs,并使用shell的echo向文件写入内容进行测试。
屏幕截图_20240316_162732

其他杂项

#596 在SYS_RMDIR上加了个判空。


Type

Bug fix, Enhancement


Description

此PR实现了SYS_LINK和SYS_LINKAT系统调用,允许用户在文件系统中创建硬链接。同时,对SYS_RMDIR函数进行了增强,现在可以正确处理空路径的情况。


Changes walkthrough

Relevant files
- enhancement - bug fix
syscall.rs
- 实现SYS_LINK和SYS_LINKAT系统调用 - 完善SYS_RMDIR功能                                           

kernel/src/filesystem/vfs/syscall.rs

  • 新增了do_linkat()link()函数,实现了创建硬链接的系统调用。
  • rmdir()函数进行了完善,增加了对空路径的处理。

✨ Usage guide:

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...
Enabling\disabling automation
  • When you first install the app, the default mode for the describe tool is:
pr_commands = ["/describe --pr_description.add_original_user_description=true" 
                         "--pr_description.keep_original_user_title=true", ...]

meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.

  • Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
pr_commands = ["/describe --pr_description.use_description_markers=true", ...]

the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following:

  • type: the PR type.
  • summary: the PR summary.
  • walkthrough: the PR walkthrough.

Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels

The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other].

If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:

  • Main topic:performance - pr_agent:The main topic of this PR is performance
  • New endpoint - pr_agent:A new endpoint was added in this PR
  • SQL query - pr_agent:A new SQL query was added in this PR
  • Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile
  • ...

The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎

For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page.
This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).

To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are:

  • 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
  • true: A collapsable file comment with changes title and a changes summary for each file in the PR.
  • false (default): File changes walkthrough will be added only to the "Conversation" tab.
Utilizing extra instructions

The describe tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.

Examples for extra instructions:

[pr_description] 
extra_instructions="""
- The PR title should be in the format: '<PR type>: <title>'
- The title should be short and concise (up to 10 words)
- ...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

@dragonosbot
Copy link

@schulice: no appropriate reviewer found, use r? to override

@dragonosbot dragonosbot added the S-等待审查 Status: 等待assignee以及相关方的审查。 label Mar 16, 2024
@dragonos-community-ai-pr-reviewer dragonos-community-ai-pr-reviewer bot added enhancement New feature or request Bug fix A bug is fixed in this pull request and removed S-等待审查 Status: 等待assignee以及相关方的审查。 labels Mar 16, 2024
@dragonos-community-ai-pr-reviewer

PR Description updated to latest commit (04a8ab0)

@dragonos-community-ai-pr-reviewer

PR Analysis

  • 🎯 Main theme: Enhancement
  • 📝 PR summary: This PR implements the SYS_LINK and SYS_LINKAT system calls, allowing users to create hard links in the file system. Additionally, it enhances the SYS_RMDIR function to handle empty paths correctly.
  • 📌 Type of PR: Bug fix, Enhancement
  • 🧪 Relevant tests added: False
  • Estimated effort to review [3]: 3, because the PR includes the implementation of two new system calls and enhancements to an existing function, which requires careful review to ensure correctness and adherence to best practices.
  • 🔒 Security concerns: No security concerns found

PR Feedback

  • 💡 General suggestions:

    • Ensure that the new system calls and enhancements are thoroughly tested, including edge cases.
    • Verify that the code follows the best practices of the project, such as proper error handling and documentation.
    • Consider adding tests to confirm the functionality of the new system calls and to ensure that the enhancements to SYS_RMDIR behave as expected.

✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the 'general suggestions' section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_ticket, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

@dragonos-community-ai-pr-reviewer

PR Code Suggestions

Suggestions                                                                                                                                                         
enhancement
do_linkat函数中增加对文件描述符的校验和目标文件存在性的检查。                            

**- 建议在do_linkat函数中添加对oldfdnewfd的校验,确保它们指向有效的文件描述符。

  • 考虑在创建硬链接时检查目标文件是否已经存在,以避免创建无效的链接。
  • 对于AT_EMPTY_PATH标志的处理,建议在文档中说明该标志的作用和行为。**

kernel/src/filesystem/vfs/syscall.rs [538-606]

 def do_linkat(
     oldfd: i32,
     old: &str,
     newfd: i32,
     new: &str,
     flags: i32,
 ) -> Result<usize, SystemError> {
+    // 校验oldfd和newfd是否有效
+    let old_file = pcb.fd_table().get_file_by_fd(oldfd).ok_or(SystemError::EBADF)?;
+    let new_file = pcb.fd_table().get_file_by_fd(newfd).ok_or(SystemError::EBADF)?;
 
+    // 检查新文件是否已存在
+    if fs.path_exists(new).is_ok() {
+        return Err(SystemError::EEXIST);
+    }
+
+    // 处理AT_EMPTY_PATH标志
+    if flags & AtFlags::AT_EMPTY_PATH.bits() != 0 {
+        // 实现标志位对应的逻辑
+    }
+
+    // 剩余代码...
+

✨ Usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...
Enabling\disabling automation

When you first install the app, the default mode for the improve tool is:

pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]

meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions

Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

Examples for extra instructions:

[pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality
  • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
  • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
  • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
  • With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

@schulice
Copy link
Contributor Author

PR Code Suggestions

Suggestions                                                                                                                                                         
enhancement
do_linkat函数中增加对文件描述符的校验和目标文件存在性的检查。                            
**- 建议在do_linkat函数中添加对oldfdnewfd的校验,确保它们指向有效的文件描述符。

  • 考虑在创建硬链接时检查目标文件是否已经存在,以避免创建无效的链接。
  • 对于AT_EMPTY_PATH标志的处理,建议在文档中说明该标志的作用和行为。**

kernel/src/filesystem/vfs/syscall.rs [538-606]

 def do_linkat(
     oldfd: i32,
     old: &str,
     newfd: i32,
     new: &str,
     flags: i32,
 ) -> Result<usize, SystemError> {
+    // 校验oldfd和newfd是否有效
+    let old_file = pcb.fd_table().get_file_by_fd(oldfd).ok_or(SystemError::EBADF)?;
+    let new_file = pcb.fd_table().get_file_by_fd(newfd).ok_or(SystemError::EBADF)?;
 
+    // 检查新文件是否已存在
+    if fs.path_exists(new).is_ok() {
+        return Err(SystemError::EEXIST);
+    }
+
+    // 处理AT_EMPTY_PATH标志
+    if flags & AtFlags::AT_EMPTY_PATH.bits() != 0 {
+        // 实现标志位对应的逻辑
+    }
+
+    // 剩余代码...
+

✨ Usage guide:

对于这两个建议。1. fd是否有效在user_path_at中会检查(AT_EMPTY直接使用oldfd时也有)。2. 新文件是否存在在inode的link中有检查,虽然我个人认为在do_linkat中用find检查会更合适。

@fslongjin
Copy link
Member

@dragonosbot assign @chiichen

@fslongjin
Copy link
Member

@dragonosbot label S-等待审查

@dragonosbot dragonosbot added the S-等待审查 Status: 等待assignee以及相关方的审查。 label Mar 16, 2024
}
// TODO AT_EMPTY_PATH标志启用时,进行调用者CAP_DAC_READ_SEARCH或相似的检查
let symlink_times = match flags & AtFlags::AT_SYMLINK_FOLLOW.bits() {
0 => 0,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里应当使用flags.contains或者if 来判断它是否等于0,而不是match。下面那个代码也一样。

.ok_or(SystemError::EBADF)?;
let old_inode = file.lock().inode();
if old_inode.metadata().unwrap().file_type == FileType::Dir {
return Err(SystemError::EPERM);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

返回值是eperm吗?有无linux man7的文档。看看这种情况应当返回什么内容。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

是参考的man page
image

old: &str,
newfd: i32,
new: &str,
flags: i32,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个作为内部的函数,flags应当是Atflags类型,而不是i32

let old_cstr = args[0] as *const u8;
let new_cstr = args[1] as *const u8;

let old = check_and_clone_cstr(old_cstr, Some(MAX_PATHLEN))?;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

把这些校验的操作放到vfs的syscall里面去。不要写在这里。

}

#[cfg(target_arch = "x86_64")]
SYS_LINKAT => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个系统调用riscv也有,因此不需要加条件编译。


let old = check_and_clone_cstr(old_cstr, Some(MAX_PATHLEN))?;
let new = check_and_clone_cstr(new_cstr, Some(MAX_PATHLEN))?;
if old.len() >= MAX_PATHLEN || new.len() >= MAX_PATHLEN {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这两个系统调用在校验这块的逻辑类似,应当封装成函数。

return Err(SystemError::ENAMETOOLONG);
}
// old.len() 根据flags & AtFlags::AT_EMPTY_PATH判空
if new.len() <= 0 || (old.len() <= 0 && flags & AtFlags::AT_EMPTY_PATH.bits() == 0)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这些逻辑不应该放在这里。应到放在do_link_at

@fslongjin
Copy link
Member

@dragonosbot label +S-等待作者修改

@dragonosbot dragonosbot added the S-等待作者修改 Status: 这正在等待作者的一些操作(例如代码更改或更多信息)。 label Mar 16, 2024
@fslongjin fslongjin removed the S-等待审查 Status: 等待assignee以及相关方的审查。 label Mar 16, 2024
@dragonosbot dragonosbot added the A-fs Area: 文件系统 label Mar 17, 2024
pub fn link(old: *const u8, new: *const u8) -> Result<usize, SystemError> {
let get_path = |cstr: *const u8| -> Result<String, SystemError> {
let res = check_and_clone_cstr(cstr, Some(MAX_PATHLEN))?;
if res.len() >= MAX_PATHLEN {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这两个if是不必要的。

let old = check_and_clone_cstr(old, Some(MAX_PATHLEN))?;
let new = check_and_clone_cstr(new, Some(MAX_PATHLEN))?;
if old.len() >= MAX_PATHLEN || new.len() >= MAX_PATHLEN {
return Err(SystemError::ENAMETOOLONG);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

同理,因为check_and_clone_str会自动截断。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

我个人认为这个只检查是否等于MAX_PATHLEN,写成>=的形式是参考了unlink的写法。

@schulice
Copy link
Contributor Author

有些小疑问。
在check_and_clone_cstr()中,user.is_null()时是否应当看作EFAULT(现在的代码是返回空串)。
一方面,在man page中有
屏幕截图_20240317_150213
另一方面,我写了点c测了下行为
image
image

@fslongjin
Copy link
Member

有些小疑问。 在check_and_clone_cstr()中,user.is_null()时是否应当看作EFAULT(现在的代码是返回空串)。 一方面,在man page中有 屏幕截图_20240317_150213 另一方面,我写了点c测了下行为 image image

也许这个确实需要改改。

@fslongjin
Copy link
Member

在check_and_clone_cstr()中,user.is_null()时是否应当看作EFAULT(现在的代码是返回空串)。

这个我在主线刚才改好了,返回EFAULT

然后合并一下主线代码进来,这个PR感觉无问题

let new_parent = new_begin_inode
.lookup_follow_symlink(&new_parent_path.unwrap_or("/"), symlink_times)?;

// 在下层检查是否处于同一文件系统
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个注释貌似不太对。

@fslongjin fslongjin added this to the DragonOS 0.1.10 milestone Mar 21, 2024
@fslongjin fslongjin merged commit 4695947 into DragonOS-Community:master Mar 22, 2024
7 checks passed
@schulice schulice deleted the do_sys_link branch April 3, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-fs Area: 文件系统 Bug fix A bug is fixed in this pull request enhancement New feature or request S-等待作者修改 Status: 这正在等待作者的一些操作(例如代码更改或更多信息)。
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants