Rework of x86 intrinsics support #3

andreittr · 2023-07-25T15:21:16Z

Massive rework of the x86 intrinsics library, featuring:

update baseline to upstream LLVM 14
proper support of all x86 intrinsics (depending on build flags), not only a minimal subset
delegate -march= compile flags to main build system; do not interfere
split off llvm & gcc trees; keeping a single compatible set of files turned out unmaintainable
gcc headers based off GCC 13
compatibility patches for other clang & gcc versions
tested w/ clang 11, 12, 13, 14, 15, 16; gcc 11, 12, 13

Signed-off-by: Andrei Tatar <andrei@unikraft.io>

This change removes the Kconfig options selecting CPU feature set (i.e., `-march=` compiler flag) from the configuration of this library. CPU feature flags are set elsewhere in the build configuration and the intrinsics library can already seamlessly pick up these features via preprocessor defines. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

This change removes code changes meant for compatibility with GCC, reverting the headers to ones released with LLVM 7.0.1. This is in anticipation of an update of upstream code, as well as a rework of compiler compatibility. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

In addition, this change greatly expands the available feature headers. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Implementations based off headers in LLVM 15.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Implementations based off headers in LLVM 16.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Implementations based off headers in LLVM 13.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

This change makes explicit that this library only supports clang by renaming the include directory and only adding it to the include path if compiling with clang. A future change may thus explicitly add GCC-compatible headers. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

This change adds on-par support for GCC by providing the native x86 intrinsics headers from gcc release 13.1.0. The file `mm_malloc.h` is taken from upstream `pmm_malloc.h`. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Implementations based off headers in GCC release 12.3.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Implementations based off headers in GCC release 11.4.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Implementations based off headers in LLVM 12.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Implementations based off headers in LLVM 11.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

mariasfiraiala

Works well, thanks @andreittr! Tested the changes with gcc-11 and clang-14 and it performed just fine.

Reviewed-by: Maria Sfiraiala maria.sfiraiala@gmail.com

Reformat to Markdown. CONTRIBUTING: remove obsolete references, point users at website README: add a short description Signed-off-by: Andrei Tatar <andrei@unikraft.io>

RaduNichita

I tried running samples from here, but for some reason, they don't compile for Unikraft, the issue being

cc1: error: attribute ‘mwait’ argument ‘target’ is unknown` .

Do you know what may be the issue for that?

RaduNichita · 2023-08-09T19:32:35Z

Config.uk

-menuconfig LIBINTEL_INTRINSICS
-    bool "Intel Intrinsics - C style functions that provide access Intel instructions"
+config LIBINTEL_INTRINSICS
+    bool "Intel Intrinsics - C style functions that provide access to x86 instructions"


Suggested change

bool "Intel Intrinsics - C style functions that provide access to x86 instructions"

bool "Intel Intrinsics: C style functions that provide access to x86 instructions"

I also think the string before : should start with a lowercase letter, for example musl.

Re: - vs :, there's not really any consistency between libs; musl and builtins are :, while libcxx*, libunwind, compiler-rt, newlib, bzip, lwip, and others are -. I'm not in favour of picking a particular side here unless we agree for a style project-wide, and until then I err on the side of least change.

Re: capitalization, I'd rather use the project's preferred style, caps & all, since that will be the most familiar for a user, e.g., musl, Python, Intel Intrinsics; they spell it like this too (modulo the registered trademark).

RaduNichita · 2023-08-10T09:25:26Z

README.md

+A list of these intrinsics can be browsed at [Intel Intrinsics](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html).
+Normally you would receive these headers together with your compiler, however, due to Unikraft's isolated build environment, we provide them explicitly.
+
+Please refer to `README.md` in the main unikraft repository as well as the [Unikraft Homepage](https://unikraft.org/) for further information.


Suggested change

Please refer to `README.md` in the main unikraft repository as well as the [Unikraft Homepage](https://unikraft.org/) for further information.

Please refer to `README.md` in the main unikraft repository as well as the [Unikraft Homepage](https://unikraft.org/) for further information.

Please provide a link to the README.md file

I don't think that's necessary @RaduNichita. Check the other libs, neither of them links the core Unikraft README which is also easily available. Consistency between repos is key.

OK, fair point here

mariasfiraiala · 2023-08-10T14:04:05Z

@RaduNichita @andreittr I'd leave the discussion regarding capitalization and so on for a later time. If the functionality is fine, I'd say we should aim to merge this as part of the 0.14 release.

RaduNichita

OK, so I think we can approve this as it is (as it is necessarily for the Numpy Library) and work in the future in integrating those samples.

I will open an issue on that after this PR is merged.

Reviewed-by: Radu Nichita radunichita99@gmail.com

razvand

Approved-by: Razvan Deaconescu razvand@unikraft.io

This change removes the Kconfig options selecting CPU feature set (i.e., `-march=` compiler flag) from the configuration of this library. CPU feature flags are set elsewhere in the build configuration and the intrinsics library can already seamlessly pick up these features via preprocessor defines. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

This change removes code changes meant for compatibility with GCC, reverting the headers to ones released with LLVM 7.0.1. This is in anticipation of an update of upstream code, as well as a rework of compiler compatibility. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

In addition, this change greatly expands the available feature headers. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

Implementations based off headers in LLVM 15.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

Implementations based off headers in LLVM 16.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

Implementations based off headers in LLVM 13.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

This change makes explicit that this library only supports clang by renaming the include directory and only adding it to the include path if compiling with clang. A future change may thus explicitly add GCC-compatible headers. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

This change adds on-par support for GCC by providing the native x86 intrinsics headers from gcc release 13.1.0. The file `mm_malloc.h` is taken from upstream `pmm_malloc.h`. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

Implementations based off headers in GCC release 12.3.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

Implementations based off headers in GCC release 11.4.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

Implementations based off headers in LLVM 12.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

Implementations based off headers in LLVM 11.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

Reformat to Markdown. CONTRIBUTING: remove obsolete references, point users at website README: add a short description Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com> Reviewed-by: Radu Nichita <radunichita99@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: #3

andreittr added 13 commits July 17, 2023 13:54

Remove obsolete metadata files

da02185

Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Update to LLVM 14.0.6

1db8f86

In addition, this change greatly expands the available feature headers. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Add compatibility with clang >= 15

8cb368c

Implementations based off headers in LLVM 15.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Add compatibility with clang >= 16

ecbcb38

Implementations based off headers in LLVM 16.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Add compatibility with clang <= 13

467ef8e

Implementations based off headers in LLVM 13.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Implement support for GCC

fa76122

This change adds on-par support for GCC by providing the native x86 intrinsics headers from gcc release 13.1.0. The file `mm_malloc.h` is taken from upstream `pmm_malloc.h`. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Add compatibility with gcc <= 12

de83f4f

Implementations based off headers in GCC release 12.3.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Add compatibility with gcc <= 11

ab97ac3

Implementations based off headers in GCC release 11.4.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Add compatibility with clang <= 12

eb2baee

Implementations based off headers in LLVM 12.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

Add compatibility with clang <= 11

84207f3

Implementations based off headers in LLVM 11.0.0. Signed-off-by: Andrei Tatar <andrei@unikraft.io>

andreittr mentioned this pull request Jul 25, 2023

Port upstream NumPy 1.25.0 unikraft/lib-python-numpy#1

Merged

razvand requested review from RaduNichita and mariasfiraiala August 5, 2023 06:35

razvand self-assigned this Aug 5, 2023

razvand added the enhancement New feature or request label Aug 5, 2023

mariasfiraiala approved these changes Aug 6, 2023

View reviewed changes

Update README & CONTRIBUTING

77985c4

Reformat to Markdown. CONTRIBUTING: remove obsolete references, point users at website README: add a short description Signed-off-by: Andrei Tatar <andrei@unikraft.io>

RaduNichita reviewed Aug 10, 2023

View reviewed changes

RaduNichita approved these changes Aug 10, 2023

View reviewed changes

razvand approved these changes Aug 10, 2023

View reviewed changes

unikraft-bot closed this in c524714 Aug 10, 2023

unikraft-bot added the ci/merged label Aug 10, 2023

andreittr deleted the ttr/llvm14gcc13 branch August 10, 2023 23:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework of x86 intrinsics support #3

Rework of x86 intrinsics support #3

andreittr commented Jul 25, 2023

mariasfiraiala left a comment

RaduNichita left a comment •

edited

Loading

RaduNichita Aug 9, 2023

RaduNichita Aug 9, 2023

andreittr Aug 10, 2023

RaduNichita Aug 10, 2023

mariasfiraiala Aug 10, 2023

RaduNichita Aug 10, 2023

mariasfiraiala commented Aug 10, 2023

RaduNichita left a comment

razvand left a comment

	bool "Intel Intrinsics - C style functions that provide access to x86 instructions"
	bool "Intel Intrinsics: C style functions that provide access to x86 instructions"

	Please refer to `README.md` in the main unikraft repository as well as the [Unikraft Homepage](https://unikraft.org/) for further information.
	Please refer to `README.md` in the main unikraft repository as well as the [Unikraft Homepage](https://unikraft.org/) for further information.

Rework of x86 intrinsics support #3

Rework of x86 intrinsics support #3

Conversation

andreittr commented Jul 25, 2023

mariasfiraiala left a comment

Choose a reason for hiding this comment

RaduNichita left a comment • edited Loading

Choose a reason for hiding this comment

RaduNichita Aug 9, 2023

Choose a reason for hiding this comment

RaduNichita Aug 9, 2023

Choose a reason for hiding this comment

andreittr Aug 10, 2023

Choose a reason for hiding this comment

RaduNichita Aug 10, 2023

Choose a reason for hiding this comment

mariasfiraiala Aug 10, 2023

Choose a reason for hiding this comment

RaduNichita Aug 10, 2023

Choose a reason for hiding this comment

mariasfiraiala commented Aug 10, 2023

RaduNichita left a comment

Choose a reason for hiding this comment

razvand left a comment

Choose a reason for hiding this comment

RaduNichita left a comment •

edited

Loading