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

实现uname系统调用 #614

Merged
merged 3 commits into from
Mar 19, 2024
Merged

实现uname系统调用 #614

merged 3 commits into from
Mar 19, 2024

Conversation

sspphh
Copy link
Contributor

@sspphh sspphh commented Mar 16, 2024

Type

Bug fix, Enhancement


Description

此拉取请求实现并注册了一个新的uname系统调用,该调用用于获取系统的名称和版本信息。
同时,添加了一个测试程序来验证系统调用的功能。


Changes walkthrough

Relevant files
Enhancement
syscall.rs
实现uname系统调用                                                                                                           

kernel/src/process/syscall.rs
['新增了uname系统调用的实现。']

+49/-0   
mod.rs
注册uname系统调用                                                                                                           

kernel/src/syscall/mod.rs
['注册了uname系统调用。']

+6/-2     
syscall_num.h
新增系统调用常量                                                                                                                 

kernel/src/syscall/syscall_num.h
['新增了SYS_UNAME常量。']

+1/-0     
main.c
实现uname函数调用                                                                                                           

user/apps/test_uname/main.c
['实现了uname函数的调用,用于获取系统信息并打印。']

+19/-0   
Makefile
添加交叉编译指令                                                                                                                 

user/apps/test_uname/Makefile
['添加了针对不同架构的交叉编译指令。']

+20/-0   
test_uname_0_1_0.dadk
新增配置文件                                                                                                                     

user/dadk/config/test_uname_0_1_0.dadk
['新增了一个测试uname程序的配置文件。']

+22/-0   

✨ 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 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 labels Mar 16, 2024
@dragonos-community-ai-pr-reviewer

PR Description updated to latest commit (fdacb1e)

@dragonos-community-ai-pr-reviewer

PR Analysis

  • 🎯 Main theme: 此拉取请求实现并注册了一个新的uname系统调用,该调用用于获取系统的名称和版本信息,同时添加了一个测试程序来验证系统调用的功能。
  • 📝 PR summary: 此PR实现了一个新的uname系统调用,该调用返回系统的名称和版本信息,并通过添加一个测试程序来验证其功能。
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: True
  • ⏱️ Estimated effort to review [1-5]: 3, because the PR includes implementation of a new syscall and associated test code, which requires careful review to ensure correctness and adherence to best practices.
  • 🔒 Security concerns: No, there are no apparent security concerns with the implementation of the uname system call as described.

PR Feedback

  • 💡 General suggestions:

    • Ensure that the uname system call follows the Linux syscall convention and that it is consistent across different architectures.
    • Add documentation to the kernel code comments explaining the purpose and usage of the new uname system call.
    • Consider adding more comprehensive tests to cover edge cases and potential security concerns.

✨ 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                                                                                                                                                         
memory alignment
调整PosixOldUtsName结构体的内存对齐。                                      

确保PosixOldUtsName结构体的内存对齐正确。

kernel/src/process/syscall.rs [29-34]

 #[repr(C)]
 #[derive(Debug, Clone, Copy)]
 pub struct PosixOldUtsName {
-  ...
+  pub sysname: [u8; 65],
+  pub nodename: [u8; 65],
+  pub release: [u8; 65],
+  pub version: [u8; 65],
+  pub machine: [u8; 65],
 }
 
error handling
uname系统调用添加错误处理。                                               

添加对uname系统调用的错误处理。

kernel/src/syscall/mod.rs [1032-1037]

-Self::uname(name)
+match Self::uname(name) {
+  Ok(0) => {},
+  Err(e) => return Err(e),
+}
 
use libc function
使用libc中的uname函数。                                   

使用libc中的uname函数,而不是直接调用系统调用。

user/apps/test_uname/main.c [9]

-uname(&system_info);
+if (libc_uname(&system_info) == 0) {
+  ...
+} else {
+  ...
+}
 

✨ 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.

Copy link
Member

@fslongjin fslongjin left a comment

Choose a reason for hiding this comment

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

请运行make fmt进行格式化之后再提交一次,然后push上来哈

@fslongjin fslongjin self-assigned this Mar 16, 2024
@fslongjin
Copy link
Member

fslongjin commented Mar 16, 2024

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

@dragonosbot dragonosbot added S-等待作者修改 Status: 这正在等待作者的一些操作(例如代码更改或更多信息)。 and removed S-等待审查 Status: 等待assignee以及相关方的审查。 labels Mar 16, 2024
@fslongjin
Copy link
Member

#559

@fslongjin
Copy link
Member

@dragonosbot assign @Jomocool

@dragonosbot dragonosbot assigned Jomocool and unassigned fslongjin Mar 16, 2024

impl PosixOldUtsName {
pub fn new() -> Self {
const SYS_NAME: &[u8] = b"Dragon.OS";
Copy link
Collaborator

Choose a reason for hiding this comment

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

这里改成DragonOS比较好

@Jomocool
Copy link
Collaborator

Jomocool commented Mar 17, 2024

  1. 用户程序名改成uname比较合适

  2. uname后面应该可以添加一些选项来自定义输出,比如:

  • -a 或--all  显示全部的信息,包括内核名称、主机名、操作系统版本、处理器类型和硬件架构等。。
  • -m 或--machine  显示处理器类型。
  • -n 或--nodename  显示主机名。
  • -r 或--release  显示内核版本号。
  • -s 或--sysname  显示操作系统名称。
  • -v  显示操作系统的版本。
  • --help  显示帮助。
  • --version  显示版本信息。
  • -p 显示处理器类型(与 -m 选项相同)。
  1. 运行make fmt格式化代码后再提交

@fslongjin
Copy link
Member

  1. 用户程序名改成uname比较合适
  2. uname后面应该可以添加一些选项来自定义输出,比如:
  • -a 或--all  显示全部的信息,包括内核名称、主机名、操作系统版本、处理器类型和硬件架构等。。
  • -m 或--machine  显示处理器类型。
  • -n 或--nodename  显示主机名。
  • -r 或--release  显示内核版本号。
  • -s 或--sysname  显示操作系统名称。
  • -v  显示操作系统的版本。
  • --help  显示帮助。
  • --version  显示版本信息。
  • -p 显示处理器类型(与 -m 选项相同)。
  1. 运行make fmt格式化代码后再提交

我待会编译一个coreutils到系统里面去。

@fslongjin fslongjin merged commit 8c6f218 into DragonOS-Community:master Mar 19, 2024
7 checks passed
@fslongjin fslongjin added this to the DragonOS 0.1.10 milestone Mar 21, 2024
@sspphh sspphh deleted the temp branch April 6, 2024 07:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug fix A bug is fixed in this pull request enhancement New feature or request Review effort [1-5]: 3 S-等待作者修改 Status: 这正在等待作者的一些操作(例如代码更改或更多信息)。
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants