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

Add overview of supported hardware acceleration #3849

Merged
merged 1 commit into from
Dec 22, 2023

Conversation

securitykernel
Copy link
Collaborator

@securitykernel securitykernel commented Dec 19, 2023

Adds an overview of supported hardware acceleration by platform to the handbook.

Includes:

  • Algorithm
  • CPU instruction/extension
  • Botan module
  • Added in Botan version

Also adds information on how to configure hardware support at build time via configure.py and at runtime using environment variables.

One thing that came out during documentation of the configure.py options, which Sphinx can automatically highlight via forwarding to docutils: --disable-sse4.1 is not a POSIX-compliant command line option, as it only allows letters, numbers, and hyphens (not dots). I changed configure.py accordingly, so this means that:

  • configure.py --disable-sse4.1 is now configure.py --disable-sse41
  • configure.py --disable-sse4.2 is now configure.py --disable-sse42

Decided to postpone this change to 4.0, if ever.

Closes #3824

@securitykernel securitykernel self-assigned this Dec 19, 2023
@coveralls
Copy link

coveralls commented Dec 19, 2023

Coverage Status

coverage: 92.062% (+0.003%) from 92.059%
when pulling 6c56e63 on sk/hw-accel-docs
into ca992bd on master.

Copy link
Collaborator

@reneme reneme left a comment

Choose a reason for hiding this comment

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

configure.py Outdated Show resolved Hide resolved
Copy link
Owner

@randombit randombit left a comment

Choose a reason for hiding this comment

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

LGTM left a couple of comments

doc/hardware_acceleration.rst Outdated Show resolved Hide resolved
doc/hardware_acceleration.rst Outdated Show resolved Hide resolved
@securitykernel securitykernel merged commit a14b090 into master Dec 22, 2023
33 checks passed
@securitykernel securitykernel deleted the sk/hw-accel-docs branch January 1, 2024 17:49
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.

Overview of hardware acceleration support
4 participants