[General]: Notes on urdmsr instruction

Đang mở
  • Có gì không ổn?
#7 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
html
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với trang tài liệu URDMSR được liên kết trong issue và xem xét từng đề xuất về cách trình bày, liên kết và gắn nhãn được liệt kê. Vì không có tệp hoặc bài kiểm thử nào được nêu, nhiệm vụ đầu tiên là xác định những đề xuất nào nằm trong phạm vi và tìm các entry point tương ứng để tạo tài liệu hoặc cho website. Được xem là hoàn tất khi các cải tiến được chọn đã được triển khai với nhãn phần và liên kết rõ ràng, đồng thời trang vẫn dễ hiểu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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!

Ngôn ngữ chính
HTML
Star
66
Fork
5
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của intel/SDM

Tất cả issue của intel/SDM

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.