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

完善Tty的RawMode #577

Merged
merged 6 commits into from
Mar 11, 2024
Merged

Conversation

GnoCiYeH
Copy link
Member

@GnoCiYeH GnoCiYeH commented Mar 10, 2024

User description

  • 完善原模式部分的代码逻辑
  • 优化滚动底层fb的区域拷贝算法
  • 解决tty隐藏bug

Type

Bug fix, Enhancement


Description

此PR包含两个主要更改:

  1. termios模块中,修正了InputModeOutputMode中的标志位定义,以及ControlModeLocalMode中的波特率和字符大小掩码定义,以解决潜在的错误。
  2. vesafb模块中,对fb_copyarea函数进行了优化,以避免无效的内存访问,并改进了区域拷贝的逻辑,以提高效率和准确性。

Changes walkthrough

Relevant files
Bug fix
termios.rs
Termios模块的标志位和波特率定义修正                                                                                       

kernel/src/driver/tty/termios.rs

  • 修改了InputModeOutputMode中的标志位定义,以修正错误。
  • 更新了ControlModeLocalMode中的波特率和字符大小掩码定义。
+68/-69 
Enhancement
vesafb.rs
FBDev VesaFb的fb_copyarea函数优化                                                                         

kernel/src/driver/video/fbdev/vesafb.rs

  • 优化了fb_copyarea函数的实现,以避免无效的内存访问。
  • 改进了区域拷贝的逻辑,以提高效率和准确性。
+111/-60

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

@GnoCiYeH GnoCiYeH requested review from Chiichen and fslongjin March 10, 2024 20:08
@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 10, 2024
@dragonos-community-ai-pr-reviewer

PR Description updated to latest commit (64e7639)

@dragonos-community-ai-pr-reviewer

PR Analysis

  • 🎯 Main theme: 完善和优化TTY的raw模式和底层fb的区域拷贝算法,解决潜在的bug。
  • 📝 PR summary: 此PR主要包含两个部分:一是修正termios模块中的标志位和波特率定义,二是优化vesafb模块中的fb_copyarea函数,以提高效率和准确性。
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: True
  • ⏱️ Estimated effort to review [1-5]: 3, 因为涉及多个文件和模块的修改,需要仔细检查以确保所有更改都是正确的,并且没有引入新的bug。
  • 🔒 Security concerns: No security concerns found

PR Feedback

  • 💡 General suggestions:

    • 在修改标志位和波特率定义时,建议在文档中添加相应的注释,以解释为什么进行这些更改,以及它们如何解决潜在的问题。
    • 在优化fb_copyarea函数时,建议添加一些性能测试,以确保优化后的代码确实提高了效率和准确性。

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

@fslongjin
Copy link
Member

syscall64那里的汇编需要改一下。目前这种写法导致系统调用过程中,中断是禁止的。

@@ -376,6 +377,8 @@ ENTRY(syscall_64)

// 将原本要返回的栈帧的栈指针传入do_signal的第一个参数
movq %rsp, %rdi

sti
Copy link
Member

Choose a reason for hiding this comment

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

sti应当移动到进入系统调用服务程序之前

image

@@ -46,7 +46,7 @@ impl AppBackend {
})
};

*r.main_thread.write().unwrap() = Some(main_thread);
*r.main_thread.write_irqsave().unwrap() = Some(main_thread);
Copy link
Member

Choose a reason for hiding this comment

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

这里改错了,它不应该有write_irqsave。因为这个应用程序是跑在Linux的

Copy link
Member Author

Choose a reason for hiding this comment

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

怪不得报黄

@fslongjin fslongjin merged commit 52bcb59 into DragonOS-Community:master Mar 11, 2024
7 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants