[General]: Notes on urdmsr instruction

未关闭
  • 哪里不对？
#7 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
活跃
技术栈
html
领域
documentation

调研方向

从 issue 中链接的 URDMSR 文档页面开始，逐一审查列出的展示、链接和标记建议。由于没有指定文件或测试，首要任务是确定哪些提案在范围内，并找到相应的文档生成或网站入口点。完成的标准是，选定的改进已通过清晰的章节标签和链接实现，并且页面仍然易于理解。

由索引模型根据 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

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

intel/SDM 的其他 Issue

查看 intel/SDM 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。