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.

Sign up for GitHub

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

Jump to bottom

[C++] CMake option description for SIMD options incorrect #36663

Closed
pitrou opened this issue Jul 13, 2023 · 1 comment · Fixed by #36684
Closed

[C++] CMake option description for SIMD options incorrect #36663

pitrou opened this issue Jul 13, 2023 · 1 comment · Fixed by #36684
Assignees
@kou
Labels
Component: C++ Type: bug
Milestone
14.0.0

Comments

@pitrou
Copy link
Member

pitrou commented Jul 13, 2023

Describe the bug, including details regarding any error messages, version, and platform.

The default for ARROW_SIMD_LEVEL is described as NONE but it's actually DEFAULT.
The default for ARROW_RUNTIME_SIMD_LEVEL is described as NONE but it's actually MAX.

--   ARROW_SIMD_LEVEL=SSE4_2 [default=NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512|DEFAULT]
--       Compile-time SIMD optimization level
--   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=NONE|SSE4_2|AVX2|AVX512|MAX]
--       Max runtime SIMD optimization level

See example at https://github.com/apache/arrow/actions/runs/5542062500/jobs/10116261017#step:6:1314

Component(s)

C++
@pitrou
Copy link
Member Author

pitrou commented Jul 13, 2023

@kou

kou added a commit to kou/arrow that referenced this issue Jul 14, 2023
@kou
apacheGH-36663: [C++] Fix the default value information for enum options
8f80757 
Before:

    --   ARROW_SIMD_LEVEL=SSE4_2 [default=NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512|DEFAULT]
    --   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=NONE|SSE4_2|AVX2|AVX512|MAX]

After:

    --   ARROW_SIMD_LEVEL=SSE4_2 [default=DEFAULT|NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512]
    --   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=MAX|NONE|SSE4_2|AVX2|AVX512]
@github-actions github-actions bot mentioned this issue Jul 14, 2023
Merged
pitrou pushed a commit that referenced this issue Jul 19, 2023
@kou
GH-36663: [C++] Fix the default value information for enum options (#…
c3c20ce 
…36684)

### Rationale for this change

The default for `ARROW_SIMD_LEVEL` is described as `NONE` but it's actually `DEFAULT`.
The default for `ARROW_RUNTIME_SIMD_LEVEL` is described as `NONE` but it's actually `MAX`.

### What changes are included in this PR?

Reorder possible values to put the default value as the first element.

Before:

    --   ARROW_SIMD_LEVEL=SSE4_2 [default=NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512|DEFAULT]
    --   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=NONE|SSE4_2|AVX2|AVX512|MAX]

After:

    --   ARROW_SIMD_LEVEL=SSE4_2 [default=DEFAULT|NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512]
    --   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=MAX|NONE|SSE4_2|AVX2|AVX512]

### Are these changes tested?

Yes.

### Are there any user-facing changes?

Yes.
* Closes: #36663

Authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Antoine Pitrou <antoine@python.org>
@pitrou pitrou added this to the 14.0.0 milestone Jul 19, 2023
chelseajonesr pushed a commit to chelseajonesr/arrow that referenced this issue Jul 20, 2023
@kou @chelseajonesr
apacheGH-36663: [C++] Fix the default value information for enum opti…
ed24af6 
…ons (apache#36684)

### Rationale for this change

The default for `ARROW_SIMD_LEVEL` is described as `NONE` but it's actually `DEFAULT`.
The default for `ARROW_RUNTIME_SIMD_LEVEL` is described as `NONE` but it's actually `MAX`.

### What changes are included in this PR?

Reorder possible values to put the default value as the first element.

Before:

    --   ARROW_SIMD_LEVEL=SSE4_2 [default=NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512|DEFAULT]
    --   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=NONE|SSE4_2|AVX2|AVX512|MAX]

After:

    --   ARROW_SIMD_LEVEL=SSE4_2 [default=DEFAULT|NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512]
    --   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=MAX|NONE|SSE4_2|AVX2|AVX512]

### Are these changes tested?

Yes.

### Are there any user-facing changes?

Yes.
* Closes: apache#36663

Authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Antoine Pitrou <antoine@python.org>
R-JunmingChen pushed a commit to R-JunmingChen/arrow that referenced this issue Aug 20, 2023
@kou @R-JunmingChen
apacheGH-36663: [C++] Fix the default value information for enum opti…
48cc27b 
…ons (apache#36684)

### Rationale for this change

The default for `ARROW_SIMD_LEVEL` is described as `NONE` but it's actually `DEFAULT`.
The default for `ARROW_RUNTIME_SIMD_LEVEL` is described as `NONE` but it's actually `MAX`.

### What changes are included in this PR?

Reorder possible values to put the default value as the first element.

Before:

    --   ARROW_SIMD_LEVEL=SSE4_2 [default=NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512|DEFAULT]
    --   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=NONE|SSE4_2|AVX2|AVX512|MAX]

After:

    --   ARROW_SIMD_LEVEL=SSE4_2 [default=DEFAULT|NONE|SSE4_2|AVX2|AVX512|NEON|SVE|SVE128|SVE256|SVE512]
    --   ARROW_RUNTIME_SIMD_LEVEL=MAX [default=MAX|NONE|SSE4_2|AVX2|AVX512]

### Are these changes tested?

Yes.

### Are there any user-facing changes?

Yes.
* Closes: apache#36663

Authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Antoine Pitrou <antoine@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kou kou

Labels
Component: C++ Type: bug
Projects
None yet
Milestone
14.0.0
Development

Successfully merging a pull request may close this issue.

GH-36663: [C++] Fix the default value information for enum options kou/arrow
2 participants
@kou @pitrou