Skip to content

manual: document must have CPU features for x86#569

Merged
midnightveil merged 1 commit into
seL4:mainfrom
au-ts:x86_features
Jul 21, 2026
Merged

manual: document must have CPU features for x86#569
midnightveil merged 1 commit into
seL4:mainfrom
au-ts:x86_features

Conversation

@dreamliner787-9

Copy link
Copy Markdown
Collaborator

This is useful for users of Microkit to check that their environment support all the required features by the kernel. Rather than getting a nasty error at boot time.

Closes #507.

One thing I'm a bit sketchy on is that the VT-x features table is not rendered very nicely in the PDF:
image

One thing I could do is that I could refactor the table to be grouped by MSR, but I don't know which is better,

@midnightveil

Copy link
Copy Markdown
Collaborator

I don't think it's necessary to give either the kernel reference nor the exact way to check this, just the list of necessary features. To make it easier you could probably specify the specific microarch (e.g. nehalam or zen2, I made those up) for is the minimum for which it works.

@Indanz

Indanz commented Jul 20, 2026

Copy link
Copy Markdown

The most user friendly way of listing the required features would be to list the matching /proc/cpuinfo flags.

@dreamliner787-9

Copy link
Copy Markdown
Collaborator Author

The most user friendly way of listing the required features would be to list the matching /proc/cpuinfo flags.

I thought about this but most of the VT-x features doesn't correspond to a proc/cpuinfo flags.

Comment thread docs/manual.md Outdated

The `x86_64_generic` platform's kernel configuration requires these features from your CPU:

| Name | /proc/cpuid flag |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

/proc/cpuinfo? I'd also mention in the text (not the table) that you can check with e.g. cat /proc/cpuinfo | grep xsave; and just make the table header the "cpuinfo feature flag" or something

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

/proc/cpuinfo?

Oops

Comment thread docs/manual.md Outdated

| Name | /proc/cpuid flag |
|----------------------------------|-------------------|
| Enable VMX outside SMX operation | (Checked via MSR) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I would at least keep the name of the MSR or a reference to the Intel manual here so that people can check this, even if manually.

This is useful for users of Microkit to check that their environment
support all the required features by the kernel. Rather than getting
a nasty error at boot time.

Signed-off-by: Bill Nguyen <bill.nguyen@unsw.edu.au>
@midnightveil
midnightveil merged commit f344d90 into seL4:main Jul 21, 2026
8 of 12 checks passed
@midnightveil
midnightveil deleted the x86_features branch July 21, 2026 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document x86 assumed features

3 participants