document (and require?) offline spir-v compilation

Open
#2,403 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale

Research direction

Start with the existing documentation for --compilation-mode spir-v and the linked conformance process document. Compare the setup with the referenced Mesa/rusticl cl_offline_compiler script and review related issues 696, 697, and 1340. Done requires an agreed documentation scope and a decision on whether to provide a script or clarify offline SPIR-V test requirements.

Written by the indexing model from the issue text.

Description

Found while investigating https://github.com/KhronosGroup/OpenCL-CTS/issues/2142.

Although there is some documentation describing how offline compilation through SPIR-V can be used (via --compilation-mode spir-v), the documentation is rather sparse, and the setup is nontrivial. We should improve documentation, and perhaps even provide a script for common usage, such as this script from Mesa / rusticl.

We should also consider whether we should require running tests with offline compilation through SPIR-V when an implementation supports SPIR-V, especially for tests that do not require an excessive amount of execution time. Specifically, regarding this paragraph from the conformance process document:

Platforms must run math brute force and conversion tests in normal mode using both OpenCL C and SPIR-V (if supported) unless the platform uses the materially equivalent underlying implementation, including built-in functions, for OpenCL C and SPIR-V, in which case those tests may be run in wimpy mode.

Is offline compilation through SPIR-V required for any other tests (such as the aforementioned float atomics tests), or is this only required for math brute force and conversions?

Related issues:

Dominant language
C++
Stars
234
Forks
240
Avg merge
6d 12h
Merged PRs (30d)
15

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from KhronosGroup/OpenCL-CTS

All issues in KhronosGroup/OpenCL-CTS

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.