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 more s390x target features #135630

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

folkertdev
Copy link
Contributor

Closes #88937

tracking issue: #130869

The target feature names are, right now, just the llvm target feature names. These mostly line up well with the names of Facility Indications names. The linux kernel (and /proc/cpuinfo) uses shorter, more cryptic names. (e.g. "vector" is vx). We can deviate from the llvm names, but the CPU vendor (IBM) does not appear to use e.g. vx for what they call vector.

There are a number of implied target features between the vector facilities (based on the Facility Indications table):

  • 129 The vector facility for z/Architecture is installed in the z/Architecture architectural mode.
  • 134 The vector packed decimal facility is installed in the z/Architecture architectural mode. When bit 134 is one, bit 129 is also one.
  • 135 The vector enhancements facility 1 is installed in the z/Architecture architectural mode. When bit 135 is one, bit 129 is also one.
  • 148 The vector-enhancements facility 2 is installed in the z/Architecture architectural mode. When bit 148 is one, bits 129 and 135 are also one.
  • 152 The vector-packed-decimal-enhancement facility 1 is installed in the z/Architecture architectural mode. When bit 152 is one, bits 129 and 134 are also one.
  • 165 The neural-network-processing-assist facility is installed in the z/Architecture architectural mode. When bit 165 is one, bit 129 is also one.
  • 192 The vector-packed-decimal-enhancement facility 2 is installed in the z/Architecture architectural mode. When bit 192 is one, bits 129, 134, and 152 are also one.

The remaining facilities do not have any implied target features (that we provide):

  • 45 The distinct-operands, fast-BCR-serialization, high-word, and population-count facilities, the interlocked-access facility 1, and the load/store-oncondition facility 1 are installed in the z/Architecture architectural mode.
  • 73 The transactional-execution facility is installed in the z/Architecture architectural mode. Bit 49 is one when bit 73 is one.
  • 133 The guarded-storage facility is installed in the z/Architecture architectural mode.
  • 150 The enhanced-sort facility is installed in the z/Architecture architectural mode.
  • 151 The DEFLATE-conversion facility is installed in the z/Architecture architectural mode.

The added target features are those that have ISA implications, can be queried at runtime, and have LLVM support. LLVM defines more target features, but I'm not sure those are useful. They can always be added later, and can already be set globally using -Ctarget-feature.

I'll also update the is_s390x_feature_supported macro (added in rust-lang/stdarch#1699, not yet on nightly, that needs an stdarch sync) to include these target features.

@Amanieu you had some reservations about the "vector" target feature name. It does appear to be the most "official" name we have. On the one hand the name is very generic, and some of the other names are rather long. For the neural-network-processing-assist even LLVM thought that was a bit much and shortened it to nnp-assist. Also for vector-packed-decimal-enhancement facility 1 the llvm naming is inconsistent. On the other hand, the cpuinfo names are very cryptic, and aren't found in the IBM documentation.

r? @Amanieu

cc @uweigand @taiki-e

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Jan 17, 2025
@rust-log-analyzer

This comment has been minimized.

The target feature names are, right now, based on the llvm target feature names. These mostly line up well with the names of [Facility Inidications](https://publibfp.dhe.ibm.com/epubs/pdf/a227832d.pdf#page=301) names. The linux kernel uses shorter, more cryptic names. (e.g. "vector" is `vx`). We can deviate from the llvm names, but the CPU vendor (IBM) does not appear to use e.g. `vx` for what they call `vector`.

There are a number of implied target features between the vector facilities (based on the [Facility Inidications](https://publibfp.dhe.ibm.com/epubs/pdf/a227832d.pdf#page=301) table):

- 129 The vector facility for z/Architecture is installed in the z/Architecture architectural mode.
- 134 The vector packed decimal facility is installed in the z/Architecture architectural mode. When bit 134 is one, bit 129 is also one.
- 135 The vector enhancements facility 1 is installed in the z/Architecture architectural mode. When bit 135 is one, bit 129 is also one.
- 148 The vector-enhancements facility 2 is installed in the z/Architecture architectural mode. When bit 148 is one, bits 129 and 135 are also one.
- 152 The vector-packed-decimal-enhancement facility 1 is installed in the z/Architecture architectural mode. When bit 152 is one, bits 129 and 134 are also one.
- 165 The neural-network-processing-assist facility is installed in the z/Architecture architectural mode. When bit 165 is one, bit 129 is also one.
- 192 The vector-packed-decimal-enhancement facility 2 is installed in the z/Architecture architectural mode. When bit 192 is one, bits 129, 134, and 152 are also one.

And then there are a number of facilities without any implied target features

- 45 The distinct-operands, fast-BCR-serialization, high-word, and population-count facilities, the interlocked-access facility 1, and the load/store-oncondition facility 1 are installed in the z/Architecture architectural mode.
- 73 The transactional-execution facility is installed in the z/Architecture architectural mode. Bit 49 is one when bit 73 is one.
- 133 The guarded-storage facility is installed in the z/Architecture architectural mode.
- 150 The enhanced-sort facility is installed in the z/Architecture architectural mode.
- 151 The DEFLATE-conversion facility is installed in the z/Architecture architectural mode.

The added target features are those that have ISA implications, can be queried at runtime, and have LLVM support. LLVM [defines more target features](https://github.com/llvm/llvm-project/blob/d49a2d2bc9c65c787bfa04ac8ece614da48a8cd5/llvm/lib/Target/SystemZ/SystemZFeatures.td), but I'm not sure those are useful. They can always be added later, and can already be set globally using `-Ctarget-feature`.
@folkertdev folkertdev force-pushed the s390x-target-features branch from 23273b3 to 8a5bb28 Compare January 17, 2025 15:45
@uweigand
Copy link
Contributor

The added target features are those that have ISA implications, can be queried at runtime, and have LLVM support. LLVM defines more target features, but I'm not sure those are useful. They can always be added later, and can already be set globally using -Ctarget-feature.

The list you've added corresponds to the list provided by /proc/cpuinfo, so I agree that's a good start. [It would be possible to check for the other features at runtime as well, but using a different mechanism (the STFLE instruction).]

Also for vector-packed-decimal-enhancement facility 1 the llvm naming is inconsistent.

Yes, unfortunately sometimes a facility gets added in one generation, and then the next generation adds a version 2 of the facility, and then the original facility is renamed as version 1 retroactively ... I didn't follow those renames in the LLVM facility names to avoid accidentally breaking existing scripts.

@folkertdev
Copy link
Contributor Author

It would be possible to check for the other features at runtime as well

I was thinking of some of the special ones, e.g. backchain is not really a facility as far as I can tell? Similarly soft-float and unaligned-symbols. Anyway if the need comes up it's quite easy to add more.

but using a different mechanism (the STFLE instruction)

Yes, rust-lang/stdarch#1699 has some prototype code for that, but as you say for now that is not needed (plus you'd need the existing approach anyway to make sure that the STFLE instruction is supported).

Yes, unfortunately sometimes a facility gets added in one generation, and then the next generation adds a version 2 of the facility, and then the original facility is renamed as version 1 retroactively ... I didn't follow those renames in the LLVM facility names to avoid accidentally breaking existing scripts.

That is unfortunate and makes sense

@uweigand
Copy link
Contributor

It would be possible to check for the other features at runtime as well

I was thinking of some of the special ones, e.g. backchain is not really a facility as far as I can tell? Similarly soft-float and unaligned-symbols. Anyway if the need comes up it's quite easy to add more.

I see. Yes, those are not ISA facilities, but rather compiler options. These were implemented as LLVM facilities to allow setting them per-function (via attribute, or implicitly via LTO).

but using a different mechanism (the STFLE instruction)

Yes, rust-lang/stdarch#1699 has some prototype code for that, but as you say for now that is not needed (plus you'd need the existing approach anyway to make sure that the STFLE instruction is supported).

That test shouldn't really be necessary - LLVM anyway requires the Eighth Edition of the PoP as minimum level (i.e. z10 processors, which were introduced in 2010), and STFLE has been supported since the Fifth Edition.

@taiki-e taiki-e mentioned this pull request Jan 18, 2025
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing support for target features on s390x
5 participants