[General]: Notes on urdmsr instruction

オープン
  • 何か問題がありますか？
#7 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
活発
技術スタック
html
領域
documentation

調査の方向性

issueでリンクされているURDMSRドキュメントページから始め、一覧にあるプレゼンテーション、リンク、ラベリングに関する各提案を確認してください。ファイルやテストは指定されていないため、最初の作業は、どの提案がスコープに含まれるかを判断し、対応するドキュメント生成またはWebサイトのエントリーポイントを見つけることです。完了条件は、選択した改善が明確なセクションラベルとリンク付きで実装され、ページが引き続き理解しやすいことです。

索引モデルが issue の本文から書いたものです。

説明

enhancement Missing content
Feedback or Inquiry

First, and emphatically, I'm delighted this project exists and am looking forward to the official release.

I've recently spent some time implementing a kernel module to support urdmsr; what follows is impressions from the new documentation format of that instruction here.

  • I don't recall seeing the Intrinsics listed in the current SDM. Their inclusion here is most welcome. Having intrinsic version information here would be even more helpful, particularly for new instructions like this one.

  • I love the categories at the top of the page, and also love that it's a link to the category description and catalog. Hoping that features makes it into the MSR documentation.

  • The doubling up of columns in the first table (e.g., Opcode/Instruction) is an unfortunate holdover from the limitations of the dead-tree version. I think screens are wide enough now that the doubling up can be eliminated.

  • The parameter subscripting solves a problem that's been so endemic I didn't realize until now how annoying it was. The existing SDM forced me to puzzle out which parameter was input and which was output. The subscripting solves that. Wonderful! I'm a little concerned about how that interacts with cutting and pasting. r64_1 or r64_a (underscores, not subscripts) have their own problems. I'll take the win for now.

  • Making "Results" and "Inputs" explicit: also wonderful.

  • The CPUID column highlights the information I'm most likely to be looking for, but as an occasional user I'm still going to need to trek over to the cpuid instruction documentation to find out what USER_MSR means. Perhaps make USER_MSR a link (much like the "misc" category)? An even more convenient answer for occasional users would be provided the cpuid intrinsic code that tests for USER_MSR, but I can see where that might be annoying to more experienced users. Definitely keep the cpuid category in the first table, though.

  • I would personally like the "V" and "N.E." and "ModRM:r/m" to be links as well, but I can see an argument where that's getting too busy.

  • There are two sections labelled "Operation (URDMSR, Standard variant)", which I assume refer to the version that stores the MSR value in memory and the version that stores the MSR value in another register. I'd need to dig into the code to figure out which is the case. Could the section title reproduce the instruction parameters?

  • Appreciating the tool tips in the operation sections, and the fact that the variables and calls are linked underneath, and that fact that the the pages for the calls list what else uses those calls. It's annoying that "MSRBITMAPADDR" doesn't occur in the volume 4 MSR documentation, but I can see why you're not trying to solve every problem at once.

  • I'd welcome link to the exception definitions.

Overall, much easier to read, much greater levels of discoverability. Great work!

主要言語
HTML
スター
66
フォーク
5
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

intel/SDM のほかの issue

intel/SDM の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。