Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Bug report
description: Report incorrect behavior, a crash, or a build failure
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: Description
description: What happened, and what did you expect?
validations:
required: true
- type: textarea
id: reproducer
attributes:
label: Reproducer
description: Minimal code or commands that trigger the problem.
render: python
validations:
required: true
- type: textarea
id: output
attributes:
label: Output
description: Full traceback or error output. Run with `DPCTL_VERBOSITY=warning` for C API diagnostics.
render: shell
- type: input
id: version
attributes:
label: dpctl version
description: Output of `python -c "import dpctl; print(dpctl.__version__)"`
validations:
required: true
- type: textarea
id: devices
attributes:
label: Devices
description: Output of `python -m dpctl -f`
render: shell
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: OS, Python version (and whether free-threaded), how dpctl was installed (conda/pip/source), DPC++ compiler version if built from source.
validations:
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Questions and discussions
url: https://github.com/IntelPython/dpctl/discussions
about: Ask usage questions here.
- name: Security vulnerabilities
url: https://github.com/IntelPython/dpctl/blob/master/SECURITY.md
about: Report security issues privately, not as public issues.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Feature request
description: Propose new SYCL functionality or an API change
labels: ["enhancement"]
body:
- type: textarea
id: motivation
attributes:
label: Motivation
description: What do you need to do that dpctl does not support today?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed API
description: Python, Cython, or C API you would like, and the SYCL feature it maps to.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,13 @@ dpctl/resources/cmake

# asv artifacts
*.asv*

# agent-related
.claude/settings.local.json
.claude/worktrees/

# virtual environments, test caches, local env files
.venv/
venv/
.pytest_cache/
.env
125 changes: 125 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# AGENTS.md

dpctl is a Python/Cython wrapper over a subset of SYCL, built on a C API
library (`libsyclinterface`). It is compiled with Intel oneAPI DPC++ (`icx`/`icpx`).

## Environment

- Activate the compiler before building or testing: `source /opt/intel/oneapi/setvars.sh`
(or use a conda env with `dpcpp_linux-64`). The environment does not persist
between shell invocations; source it in the same command:
`source /opt/intel/oneapi/setvars.sh && python -m pytest dpctl/tests/...`.
- Check visible devices: `sycl-ls`. Tests skip on missing devices/aspects; a CPU
OpenCL device is enough for most of the suite.
- Python build deps: `pip install numpy cython scikit-build cmake ninja pytest "versioneer[toml]==0.29"`.

## Commands

- Build in place + editable install: `python scripts/build_locally.py --verbose`
- defaults to `icx`/`icpx` on `PATH`; other compilers need `--compiler-root`
- `--debug`, `--clean`, `--target-cuda[=sm_XX]`, `--target-hip=<arch>`,
`--cmake-opts="-D..."`
- Python tests: `python -m pytest dpctl/tests`
- one file: `python -m pytest dpctl/tests/test_sycl_queue.py`
- one test: `python -m pytest dpctl/tests/test_sycl_queue_memset.py::test_memset_partial_count`
- without a C compiler/Cython: add `-k "not test_cython_api and not test_c_headers"`
- C API tests (GoogleTest, needs `GTEST_ROOT`): `(cd libsyclinterface && bash dbg_build.sh)`
- Coverage (C + Python, rebuilds with `-DDPCTL_BUILD_CAPI_TESTS=ON`):
`python scripts/gen_coverage.py --oneapi`
- Docs (needs doxyrest): `python scripts/gen_docs.py --doxyrest-root=<path>`
- Lint/format one file (no build needed): `pre-commit run --files <path>`
- Lint/format everything: `pre-commit run --all-files`
(black, isort, flake8, cython-lint, clang-format, codespell, bandit, shellcheck,
gitleaks, actionlint). Config: `pyproject.toml`, `.flake8`, `.clang-format`.

## Structure

- `libsyclinterface/` — C API over SYCL (C++ implementation)
- `include/syclinterface/*.h` — public C headers, `DPCTL<Type>_<Op>` functions
- `source/*.cpp` — implementations
- `tests/*.cpp` — GoogleTest suite; `*.spv` are prebuilt kernel fixtures
- `dpctl/` — Python package
- `_backend.pxd` — Cython `extern` declarations of the C API
- `_sycl_*.pyx/.pxd` — `SyclDevice`, `SyclQueue`, `SyclContext`, `SyclEvent`, ...
- `memory/` — USM memory objects (`MemoryUSMDevice`, ...), IPC memory
- `compiler/` — `SyclKernelBundle` creation (SPIR-V, SYCL source)
- `program/` — deprecated alias of `dpctl.compiler`
- `utils/` — order manager, device queries, Intel device info
- `apis/include/` — Python C-API headers for extensions (`dpctl_capi.h`, `dpctl4pybind11.hpp`)
- `tests/` — pytest suite; `tests/helper/` has `get_queue_or_skip` and friends
- `examples/` — python, cython, pybind11, c extension examples (each with README)
- `docs/doc_sources/` — Sphinx sources
- `conda-recipe/`, `conda-recipe-cf/` — conda packaging used by CI
- `scripts/` — build, coverage, docs drivers

## Adding a SYCL feature (typical PR shape)

1. Declare in `libsyclinterface/include/syclinterface/dpctl_sycl_<x>_interface.h`
with a Doxygen comment and ownership attributes.
2. Implement in `libsyclinterface/source/dpctl_sycl_<x>_interface.cpp`.
3. Add GoogleTest cases in `libsyclinterface/tests/test_sycl_<x>_interface.cpp`.
4. Declare in `dpctl/_backend.pxd`; wrap in `dpctl/_sycl_<x>.pyx` (and `.pxd` if
the method is `cdef`).
5. Add pytest coverage in `dpctl/tests/`.
6. Add a `CHANGELOG.md` entry with the PR link.

Reference PRs to copy from:
- New queue operation: gh-2361 (`DPCTLQueue_Memset` → `SyclQueue.memset`,
`dpctl/tests/test_sycl_queue_memset.py`).
- New device info query: gh-2324 (`dpctl_sycl_device_interface.h` →
`dpctl/_sycl_device.pyx`; register the check in
`dpctl/tests/_device_attributes_checks.py`). New enums go through
`dpctl_sycl_enum_types.h`, `libsyclinterface/helper/`, and `dpctl/enum_types.py`.

## Conventions

### C API
Comment thread
ndgrigorian marked this conversation as resolved.
- Opaque refs (`DPCTLSyclQueueRef`, ...) via `wrap<T>`/`unwrap<T>`
(`dpctl_sycl_type_casters.hpp`).
- Annotate ownership: `__dpctl_give` (caller must delete), `__dpctl_take`
(callee consumes), `__dpctl_keep` (borrowed). See `Support/MemOwnershipAttrs.h`.
- Never let a C++ exception cross the C boundary: catch, call
`error_handler(e, __FILE__, __func__, __LINE__)`, return `nullptr`/error value.
- Null-check every incoming ref and report via `error_handler`.
- Errors are silent unless `DPCTL_VERBOSITY=warning` (or `error`) is set; set it
when debugging a `nullptr` return.

### Cython / Python
- Release the GIL (`with nogil:`) around calls that may block on the device.
- Python-visible errors: raise specific exceptions (`TypeError`, `ValueError`,
`SyclQueueCreationError`, ...) when the C API returns `NULL`.
- Free-threaded CPython (3.14t) is supported; do not rely on the GIL for
thread safety of shared state.
- Line length 80 (black, isort, cython-lint, clang-format).

### Tests
- Get devices with `get_queue_or_skip()` / skip on missing aspects; never assume
a GPU or fp64 support.
- Test both sync and `*_async` variants when adding queue operations.

### Files
- New files need the Apache-2.0 license header from `CONTRIBUTING.md`
(C/C++ headers also need the `\file` Doxygen block).
- Comments and docstrings: short, describe what the code does.

## Git

- Branch off `master`; pre-commit blocks commits directly to `master` and
`maintenance/*`.
- One concern per PR; fill in `.github/pull_request_template.md`.
- Update `CHANGELOG.md` (Keep a Changelog sections: Added, Changed, Deprecated,
Removed, Fixed, Maintenance) for user-visible changes, citing `gh-NNNN`.

## Boundaries

- Generated, do not edit: `dpctl/*.cxx`, `dpctl/**/*.cxx`, `dpctl/include/`
(headers copied/generated at build time), `dpctl/_version.py` (versioneer),
`_skbuild/`, `build/`.
- Edit C headers in `libsyclinterface/include/`, not their copies under `dpctl/include/`.
- In-place `.so` files survive branch switches; rebuild (`--clean`) before
trusting test results after checking out another branch.
- Changing an existing C API signature or enum value is a breaking change:
call it out in the PR and the CHANGELOG `NOTE` list.
- `.github/workflows/` actions are pinned to commit SHAs (checked by zizmor);
keep that when adding steps.
- `conda-recipe*/`, release versions, and doc version lists need maintainer review.
Loading