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

Change __ARM_NEON_SVE_BRIDGE to refer to the availability of the header #362

Merged
merged 2 commits into from
Nov 29, 2024

Conversation

SpencerAbson
Copy link
Contributor

@SpencerAbson SpencerAbson commented Nov 13, 2024

Afterthought: Another way of looking at this is that the user should not expect to be able to use intrinsics after specifying the relevant target features via anything other than the command line, it's unclear to me if this is the case.

The ACLE suggests the use of the predefined __ARM_NEON_SVE_BRIDGE macro to gaurd the inclusion of arm_neon_sve_bridge.h.

<arm_neon_sve_bridge.h> defines intrinsics for moving data between Neon and SVE vector types; see NEON-SVE Bridge for details. Before including the header, you should test the __ARM_NEON_SVE_BRIDGE macro.

The current definition of this macro is

__ARM_NEON_SVE_BRIDGE is defined to 1 if NEON-SVE Bridge
intrinsics are available. This implies that the following macros are nonzero

  • __ARM_NEON
  • __ARM_NEON_FP
  • __ARM_FEATURE_SVE

The intrinsics described here are not preprocessor guarded (See change for LLVM). We should expect to be able to use them in any function with the necessary features, whether they are supplied globally on the command line or via a target attribute.

However, since we cannot make assumptions about the order in which the predefined feature macros are evaluated (see relevant ACLE), we cannot use the __ARM_NEON_SVE_BRIDGE macro to guard the inclusion of arm_neon_sve_bridge.h and expect to use it's builtins in unless the required features are supplied globally on the command line.

See an example of this issue (in LLVM Vs. GCC) from @georges-arm - https://godbolt.org/z/6YPvqdjTv.

The proposal of this PR is to change the meaning of __ARM_NEON_SVE_BRIDGE to refer to the availability of the arm_neon_sve_bridge.h header file only, such that it can be unconditionally defined in supporting compilers and it's builtins can be safely used in the context of the example above.


name: Pull request
about: Technical issues, document format problems, bugs in scripts or feature proposal.


Thank you for submitting a pull request!

If this PR is about a bugfix:

Please use the bugfix label and make sure to go through the checklist below.

If this PR is about a proposal:

We are looking forward to evaluate your proposal, and if possible to
make it part of the Arm C Language Extension (ACLE) specifications.

We would like to encourage you reading through the contribution
guidelines
, in particular the section on submitting
a proposal
.

Please use the proposal label.

As for any pull request, please make sure to go through the below
checklist.

Checklist: (mark with X those which apply)

  • If an issue reporting the bug exists, I have mentioned it in the
    PR (do not bother creating the issue if all you want to do is
    fixing the bug yourself).
  • I have added/updated the SPDX-FileCopyrightText lines on top
    of any file I have edited. Format is SPDX-FileCopyrightText: Copyright {year} {entity or name} <{contact informations}>
    (Please update existing copyright lines if applicable. You can
    specify year ranges with hyphen , as in 2017-2019, and use
    commas to separate gaps, as in 2018-2020, 2022).
  • I have updated the Copyright section of the sources of the
    specification I have edited (this will show up in the text
    rendered in the PDF and other output format supported). The
    format is the same described in the previous item.
  • I have run the CI scripts (if applicable, as they might be
    tricky to set up on non-*nix machines). The sequence can be
    found in the contribution
    guidelines
    . Don't
    worry if you cannot run these scripts on your machine, your
    patch will be automatically checked in the Actions of the pull
    request.
  • I have added an item that describes the changes I have
    introduced in this PR in the section Changes for next
    release
    of the section Change Control/Document history
    of the document. Create Changes for next release if it does
    not exist. Notice that changes that are not modifying the
    content and rendering of the specifications (both HTML and PDF)
    do not need to be listed.
  • When modifying content and/or its rendering, I have checked the
    correctness of the result in the PDF output (please refer to the
    instructions on how to build the PDFs
    locally
    ).
  • The variable draftversion is set to true in the YAML header
    of the sources of the specifications I have modified.
  • Please DO NOT add my GitHub profile to the list of contributors
    in the README page of the project.

Copy link
Contributor

@rsandifo-arm rsandifo-arm left a comment

Choose a reason for hiding this comment

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

LGTM!

@vhscampos vhscampos merged commit e9cb1e4 into ARM-software:main Nov 29, 2024
4 checks passed
@vhscampos
Copy link
Member

@all-contributors please add @SpencerAbson for content

Copy link
Contributor

@vhscampos

I've put up a pull request to add @SpencerAbson! 🎉

vhscampos pushed a commit that referenced this pull request Nov 29, 2024
Adds @SpencerAbson as a contributor for content.

This was requested by vhscampos [in this
comment](#362 (comment))

[skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
SpencerAbson added a commit to llvm/llvm-project that referenced this pull request Dec 4, 2024
The meaning of `__ARM_NEON_SVE_BRIDGE` was changed here:
ARM-software/acle#362

Such that it should be defined to `1` if the `arm_neon_sve_bridge.h`
header file is available, which is the case for Clang.
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.

3 participants