diff --git a/.github/AGENTS.md b/.github/AGENTS.md index a318f75..a1041aa 100644 --- a/.github/AGENTS.md +++ b/.github/AGENTS.md @@ -4,7 +4,10 @@ CI/CD workflows, automation, security scanning, and package distribution. ## Workflows - **conda-package.yml** — main build/test pipeline (Linux/Windows, Python 3.10-3.14) +- **conda-package-cf.yml** — build/test using only conda-forge channel (Linux/Windows, Python 3.10-3.14) - **build-with-clang.yml** — Linux Clang compiler compatibility validation +- **build-with-standard-clang.yml** — standard Clang compiler compatibility validation +- **build_pip.yml** — validates editable build - **pre-commit.yml** — code quality checks (flake8, etc.) - **openssf-scorecard.yml** — security posture scanning diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index b87b389..53df9cf 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -37,7 +37,7 @@ Higher-precedence file overrides; lower must not restate overridden guidance. - Build/config: `pyproject.toml`, `setup.py` - Recipe/deps: `conda-recipe/meta.yaml`, `conda-recipe/conda_build_config.yaml` - CI: `.github/workflows/*.{yml,yaml}` -- API contracts: `mkl/__init__.py`, `mkl/_mkl_service.pyx` +- API contracts: `mkl/__init__.py`, `mkl/_py_mkl_service.pyx` - Tests: `mkl/tests/test_mkl_service.py` ## MKL-specific constraints diff --git a/.github/workflows/build-with-clang.yml b/.github/workflows/build-with-clang.yml index 2c115d6..2b3729c 100644 --- a/.github/workflows/build-with-clang.yml +++ b/.github/workflows/build-with-clang.yml @@ -14,7 +14,7 @@ jobs: strategy: matrix: - python: ["3.10", "3.11", "3.12", "3.13"] + python: ["3.10", "3.11", "3.12", "3.13", "3.14"] env: ONEAPI_ROOT: /opt/intel/oneapi @@ -40,7 +40,6 @@ jobs: - name: Install Intel OneAPI run: | sudo apt-get install intel-oneapi-compiler-dpcpp-cpp - sudo apt-get install intel-oneapi-tbb sudo apt-get install intel-oneapi-mkl-devel - name: Setup Python @@ -55,12 +54,8 @@ jobs: fetch-depth: 0 - name: Install mkl-service dependencies - uses: BSFishy/pip-action@8f2d471d809dc20b6ada98c91910b6ae6243f318 # v1 - with: - packages: | - cython - setuptools>=77 - pytest + run: | + pip install meson-python cython cmake ninja - name: List oneAPI folder content run: ls ${{ env.ONEAPI_ROOT }}/compiler @@ -71,9 +66,10 @@ jobs: echo "$CMPLR_ROOT" export CC="$CMPLR_ROOT/bin/icx" export CFLAGS="${CFLAGS} -fno-fast-math" - python setup.py develop + pip install . --no-build-isolation --no-deps --verbose - name: Run mkl-service tests run: | source ${{ env.ONEAPI_ROOT }}/setvars.sh + pip install pytest pytest -s -v --pyargs mkl diff --git a/.github/workflows/build-with-standard-clang.yml b/.github/workflows/build-with-standard-clang.yml new file mode 100644 index 0000000..4652f89 --- /dev/null +++ b/.github/workflows/build-with-standard-clang.yml @@ -0,0 +1,62 @@ +name: Build project with standard clang compiler + +on: + pull_request: + push: + branches: [master] + +permissions: read-all + +jobs: + build-with-standard-clang: + runs-on: ubuntu-latest + + strategy: + matrix: + python: ["3.10", "3.11", "3.12", "3.13", "3.14"] + + env: + COMPILER_ROOT: /usr/bin + + defaults: + run: + shell: bash -el {0} + + steps: + - name: Cancel Previous Runs + uses: styfle/cancel-workflow-action@3155a141048f8f89c06b4cdae32e7853e97536bc # 0.13.0 + with: + access_token: ${{ github.token }} + + - name: Install Dependencies + run: | + sudo apt-get update + sudo apt-get install -y clang + + - name: Setup Python + uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 + with: + python-version: ${{ matrix.python }} + architecture: x64 + + - name: Checkout repo + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + fetch-depth: 0 + + - name: Install mkl-service dependencies + run: | + pip install meson-python cython cmake ninja mkl-devel + + - name: Build mkl-service + run: | + export CC=${{ env.COMPILER_ROOT }}/clang + pip install . --no-build-isolation --no-deps --verbose + + - name: Run mkl-service tests + run: | + pip install pytest + # mkl-service cannot be installed in editable mode, we need + # to change directory before importing it and running tests + cd .. + pytest -s -v --pyargs mkl diff --git a/.github/workflows/build_pip.yml b/.github/workflows/build_pip.yml new file mode 100644 index 0000000..1a21d61 --- /dev/null +++ b/.github/workflows/build_pip.yml @@ -0,0 +1,48 @@ +name: Editable build using pip + +on: + push: + branches: + - master + pull_request: + +permissions: read-all + +env: + PACKAGE_NAME: mkl-service + MODULE_NAME: mkl-service + TEST_ENV_NAME: test_mkl_service + +jobs: + build: + runs-on: ubuntu-latest + defaults: + run: + shell: bash -el {0} + + strategy: + matrix: + python: ["3.10", "3.11", "3.12", "3.13", "3.14"] + + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + fetch-depth: 0 + + - uses: conda-incubator/setup-miniconda@fc2d68f6413eb2d87b895e92f8584b5b94a10167 # v3.3.0 + with: + miniforge-version: latest + channels: conda-forge + activate-environment: test + python-version: ${{ matrix.python }} + + - name: Install MKL + run: | + conda install mkl-devel mkl + + - name: Build conda package + run: | + pip install --no-cache-dir meson-python ninja cmake cython + pip install -e ".[test]" --no-build-isolation --verbose + pip list + python -m pytest -v mkl/tests diff --git a/AGENTS.md b/AGENTS.md index 5d422ef..f4d15bd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -15,21 +15,24 @@ Originally part of Intel® Distribution for Python*, now a standalone package av ## Key components - **Python interface:** `mkl/__init__.py` — public API surface -- **Cython wrapper:** `mkl/_mkl_service.pyx` — wraps MKL support functions +- **Cython wrapper:** `mkl/_py_mkl_service.pyx` — wraps MKL support functions - **C init module:** `mkl/_mklinitmodule.c` — Linux-side MKL runtime preloading / initialization - **Helper:** `mkl/_init_helper.py` — Windows venv DLL loading helper -- **Build system:** setuptools + Cython +- **Build system:** meson-python + Cython ## Build dependencies **Required:** - Intel® oneMKL +- meson-python +- CMake +- Ninja - Cython - Python 3.10+ **Conda environment:** ```bash -conda install -c conda-forge mkl-devel cython -python setup.py install +conda install -c conda-forge mkl-devel cython meson-python cmake ninja +python -m pip install --no-deps --no-build-isolation . ``` ## CI/CD @@ -37,7 +40,10 @@ python setup.py install - **Python versions:** 3.10, 3.11, 3.12, 3.13, 3.14 - **Workflows:** `.github/workflows/` - `conda-package.yml` — main conda build/test pipeline + - `conda-package-cf.yml — conda build/test using only conda-forge channel - `build-with-clang.yml` — Linux Clang compatibility + - `build-with-standard-clang.yml` — standard Clang compiler compatibility validation + - `build_pip` — validates editable build - `pre-commit.yml` — code quality checks - `openssf-scorecard.yml` — security scanning @@ -85,4 +91,6 @@ Below directories have local `AGENTS.md` for deeper context: For broader IntelPython ecosystem context, see: - `mkl_umath` (MKL-backed NumPy ufuncs) - `mkl_random` (MKL-based random number generation) +- `mkl_fft` (MKL-based fast fourier transform functions) - `dpnp` (Data Parallel NumPy) +- `dpctl` (Data Parallel Control) diff --git a/README.md b/README.md index c397d0f..d1c603e 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,28 @@ A short example, illustrating its use: ``` For more information about the usage of support functions see [Developer Reference for Intel® oneAPI Math Kernel Library for C](https://www.intel.com/content/www/us/en/docs/onemkl/developer-reference-c/2025-2/support-functions.html). + +--- + +## Building + +A C compiler and Intel(R) OneAPI Math Kernel Library (OneMKL) are required to build mkl-service from source. + +Executing +```sh +python -m pip install . +``` + +will pull in the required build and runtime dependencies, including `mkl`, and build `mkl-service`. + +With an existing system or Conda `mkl` installation, build dependencies +- `mkl-devel` +- `meson-python` +- `cmake` +- `ninja` +- `cython` + +then, simply execute +``` +python -m pip install --no-build-isolation --no-deps . +``` diff --git a/conda-recipe-cf/bld.bat b/conda-recipe-cf/bld.bat index cc55004..498077f 100644 --- a/conda-recipe-cf/bld.bat +++ b/conda-recipe-cf/bld.bat @@ -1,5 +1,4 @@ @rem Remember to activate Intel Compiler, or remove these two lines to use Microsoft Visual Studio compiler -set MKLROOT=%PREFIX% -%PYTHON% setup.py build --force install --old-and-unmanageable +%PYTHON% -m pip install --no-deps --no-build-isolation . if errorlevel 1 exit 1 diff --git a/conda-recipe-cf/build.sh b/conda-recipe-cf/build.sh index 5d36203..40c3b81 100644 --- a/conda-recipe-cf/build.sh +++ b/conda-recipe-cf/build.sh @@ -1,2 +1,2 @@ #!/bin/bash -x -MKLROOT=$PREFIX $PYTHON setup.py build --force install --old-and-unmanageable +$PYTHON -m pip install --no-deps --no-build-isolation . diff --git a/conda-recipe-cf/meta.yaml b/conda-recipe-cf/meta.yaml index d1f237d..2ce871e 100644 --- a/conda-recipe-cf/meta.yaml +++ b/conda-recipe-cf/meta.yaml @@ -19,15 +19,17 @@ requirements: - {{ compiler('c') }} - {{ stdlib('c') }} host: + - meson-python >=0.13.0 + - meson + - cmake + - ninja - python - python-gil # [py>=314] - pip >=25.0 - - setuptools >=77 - mkl-devel # [not osx] - mkl-devel <2024 # [osx] - cython - wheel >=0.45.1 - - python-build >=1.2.2 run: - python - python-gil # [py>=314] diff --git a/conda-recipe/bld.bat b/conda-recipe/bld.bat index 90a55f4..554e8f2 100644 --- a/conda-recipe/bld.bat +++ b/conda-recipe/bld.bat @@ -2,13 +2,6 @@ echo on rem set CFLAGS=-I%PREFIX%\Library\include %CFLAGS% rem set LDFLAGS=/LIBPATH:%PREFIX% %LDFLAGS% -set MKLROOT=%CONDA_PREFIX% - -"%PYTHON%" setup.py clean --all - -:: Make CMake verbose -set "VERBOSE=1" - :: -wnx flags mean: --wheel --no-isolation --skip-dependency-check %PYTHON% -m build -w -n -x if %ERRORLEVEL% neq 0 exit 1 diff --git a/conda-recipe/build.sh b/conda-recipe/build.sh index 6bfa533..a18f7a9 100644 --- a/conda-recipe/build.sh +++ b/conda-recipe/build.sh @@ -1,15 +1,12 @@ #!/bin/bash set -ex -export MKLROOT=$CONDA_PREFIX - read -r GLIBC_MAJOR GLIBC_MINOR <<<"$(conda list '^sysroot_linux-64$' \ | tail -n 1 | awk '{print $2}' | grep -oP '\d+' | head -n 2 | tr '\n' ' ')" -${PYTHON} setup.py clean --all - -# Make CMake verbose -export VERBOSE=1 +if [ -d "build" ]; then + rm -rf build +fi # -wnx flags mean: --wheel --no-isolation --skip-dependency-check ${PYTHON} -m build -w -n -x diff --git a/conda-recipe/meta.yaml b/conda-recipe/meta.yaml index 1ccfc05..577c792 100644 --- a/conda-recipe/meta.yaml +++ b/conda-recipe/meta.yaml @@ -18,14 +18,17 @@ requirements: - {{ compiler('c') }} - {{ stdlib('c') }} host: + - meson-python >=0.13.0 + - meson + - cmake + - ninja - python - python-gil # [py>=314] + - python-build - pip >=25.0 - - setuptools >=77 - mkl-devel - cython - wheel >=0.45.1 - - python-build >=1.2.2 run: - python - python-gil # [py>=314] diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..638a0c3 --- /dev/null +++ b/meson.build @@ -0,0 +1,89 @@ +project( + 'mkl-service', + ['c', 'cython'], + version: run_command( + 'python', '-c', + 'import os; exec(open("mkl/_version.py").read()); print(__version__)', + check: true + ).stdout().strip(), + default_options: [ + 'c_std=c11', + 'buildtype=release', + ] +) + +py = import('python').find_installation(pure: false) + +c_args = ['-DNDEBUG'] + +thread_dep = dependency('threads') + +cc = meson.get_compiler('c') +if cc.get_id() == 'msvc' + add_project_arguments( + '/experimental:c11atomics', + language: 'c' + ) +endif + +mkl_dep = dependency('MKL', method: 'cmake', + modules: ['MKL::MKL'], + cmake_args: [ + '-DMKL_ARCH=intel64', + '-DMKL_LINK=sdl', + ], + required: true +) + +rpath = '' +if host_machine.system() == 'linux' + rpath = '$ORIGIN/../..:$ORIGIN/../../..' +endif + +# C extension +py.extension_module( + '_mklinit', + sources: ['mkl/_mklinitmodule.c'], + dependencies: [mkl_dep, thread_dep], + c_args: c_args + ['-DUSING_MKL_RT'], + install_rpath: rpath, + install: true, + subdir: 'mkl' +) + +# Cython extensions +py.extension_module( + '_py_mkl_service', + sources: ['mkl/_py_mkl_service.pyx'], + dependencies: [mkl_dep], + c_args: c_args, + install_rpath: rpath, + install: true, + subdir: 'mkl' +) + +py.extension_module( + '_mkl_memory', + sources: ['mkl/_mkl_memory.pyx'], + dependencies: [mkl_dep], + c_args: c_args, + install_rpath: rpath, + install: true, + subdir: 'mkl' +) + + +# Python sources +py.install_sources( + [ + 'mkl/__init__.py', + 'mkl/_init_helper.py', + 'mkl/_version.py', + ], + subdir: 'mkl' +) + +install_subdir( + 'mkl/tests', + install_dir: py.get_install_dir() / 'mkl' +) diff --git a/mkl/AGENTS.md b/mkl/AGENTS.md index 9710b83..f72405d 100644 --- a/mkl/AGENTS.md +++ b/mkl/AGENTS.md @@ -4,8 +4,8 @@ Core Python/Cython implementation: MKL support function wrappers and runtime con ## Structure - `__init__.py` — public API, RTLD_GLOBAL context manager, module initialization -- `_mkl_service.pyx` — Cython wrappers for MKL support functions -- `_mkl_service.pxd` — Cython declarations (C function signatures) +- `_py_mkl_service.pyx` — Cython wrappers for MKL support functions +- `_py_mkl_service.pxd` — Cython declarations (C function signatures) - `_mklinitmodule.c` — C extension for Linux-side MKL runtime preloading/init - `_init_helper.py` — Windows loading helper (DLL path setup in venv) - `_version.py` — version string (dynamic via setuptools) @@ -41,7 +41,7 @@ Core Python/Cython implementation: MKL support function wrappers and runtime con - **RTLD_GLOBAL preload path:** Linux preload is handled in `_mklinitmodule.c`; Windows DLL setup is in `_init_helper.py` ## Cython details -- `_mkl_service.pyx` → generates `_py_mkl_service` extension module +- `_py_mkl_service.pyx` → generates `_py_mkl_service` extension module - `.pxd` file declares external C functions from MKL headers - Cython build requires MKL headers (`mkl-devel`) diff --git a/mkl/__init__.py b/mkl/__init__.py index c0eb2ae..beadbfc 100644 --- a/mkl/__init__.py +++ b/mkl/__init__.py @@ -57,6 +57,7 @@ def __exit__(self, *args): del RTLD_for_MKL +from ._mkl_memory import MKLMemory from ._py_mkl_service import ( cbwr_get, cbwr_get_auto_branch, diff --git a/mkl/_mkl_memory.pyx b/mkl/_mkl_memory.pyx new file mode 100644 index 0000000..77b6d78 --- /dev/null +++ b/mkl/_mkl_memory.pyx @@ -0,0 +1,231 @@ +# Copyright (c) 2018, Intel Corporation +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of Intel Corporation nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +# distutils: language = c +# cython: language_level=3 + +import numbers + +from cpython cimport Py_buffer +from libc.string cimport memcpy + +from mkl._mkl_service cimport mkl_calloc, mkl_free, mkl_malloc, mkl_realloc + + +cdef extern from "stdatomic.h" nogil: + ctypedef int atomic_int "_Atomic int" + void atomic_init(atomic_int *obj, int value) + int atomic_fetch_add(atomic_int *obj, int value) + int atomic_fetch_sub(atomic_int *obj, int value) + int atomic_load(atomic_int *obj) + + +def _mkl_memory_from_bytes(bytes data, Py_ssize_t alignment): + cdef Py_ssize_t nbytes = len(data) + cdef MKLMemory mem = MKLMemory(nbytes, alignment=alignment) + + cdef void *dst = mem._memory_ptr + cdef char *src = data + + with nogil: + memcpy(dst, src, nbytes) + + return mem + + +cdef class MKLMemory: + cdef void *_memory_ptr + cdef Py_ssize_t nbytes + cdef Py_ssize_t alignment + cdef atomic_int exported_buffers + + cdef _cinit_empty(self): + self._memory_ptr = NULL + self.nbytes = 0 + self.alignment = 0 + atomic_init(&self.exported_buffers, 0) + + cdef _cinit_malloc(self, Py_ssize_t nbytes, Py_ssize_t alignment): + self._cinit_empty() + + if (nbytes > 0): + with nogil: + p = mkl_malloc(nbytes, alignment) + + if (p): + self._memory_ptr = p + self.nbytes = nbytes + self.alignment = alignment + else: + raise MemoryError( + "MKL memory allocation failed." + ) + else: + raise ValueError( + "Number of bytes of requested allocation must be positive." + ) + + cdef _cinit_calloc(self, Py_ssize_t num, Py_ssize_t size, Py_ssize_t alignment): + self._cinit_empty() + + if (num > 0 and size > 0): + with nogil: + p = mkl_calloc(num, size, alignment) + + if (p): + self._memory_ptr = p + self.nbytes = num * size + self.alignment = alignment + else: + raise MemoryError( + "MKL memory allocation failed." + ) + else: + raise ValueError( + "Number of elements and size of requested allocation must be " + "positive." + ) + + cdef _cinit_mklmemory(self, object other, Py_ssize_t alignment): + other_mem = other + + self._cinit_malloc(other_mem.nbytes, alignment) + with nogil: + memcpy(self._memory_ptr, other_mem._memory_ptr, self.nbytes) + + def __cinit__(self, *args, **kwargs): + cdef Py_ssize_t alignment + + n_args = len(args) + if not (0 < n_args < 3): + raise TypeError( + "MKLMemory constructor takes 1 or 2 arguments, but " + f"{n_args} were given" + ) + if n_args == 1: + arg = args[0] + if isinstance(arg, numbers.Integral): + alignment = kwargs.get("alignment", 64) + self._cinit_malloc(arg, alignment) + elif isinstance(arg, MKLMemory): + alignment = kwargs.get("alignment", arg.alignment) + self._cinit_mklmemory(arg, alignment) + else: + raise TypeError( + "MKLMemory single argument constructor expects an integer " + f"or MKLMemory instance, but got {type(arg)}" + ) + + elif n_args == 2: + arg0, arg1 = args[0], args[1] + alignment = kwargs.get("alignment", 64) + if not isinstance(arg0, numbers.Integral): + raise TypeError( + "MKLMemory constructor expects first argument " + f"to be an integer, but got {type(arg0)}" + ) + if not isinstance(arg1, numbers.Integral): + raise TypeError( + "MKLMemory constructor expects second argument " + f"to be an integer, but got {type(arg1)}" + ) + self._cinit_calloc(arg0, arg1, alignment) + + def __dealloc__(self): + if not (self._memory_ptr is NULL): + mkl_free(self._memory_ptr) + self._cinit_empty() + + cdef void *get_data_ptr(self): + return self._memory_ptr + + def __getbuffer__(self, Py_buffer *buffer, int flags): + buffer.buf = self._memory_ptr + buffer.format = "B" # byte + buffer.internal = NULL # see References + buffer.itemsize = 1 + buffer.len = self.nbytes + buffer.ndim = 1 + buffer.obj = self + buffer.readonly = 0 + buffer.shape = &self.nbytes + buffer.strides = &buffer.itemsize + buffer.suboffsets = NULL # for pointer arrays only + + atomic_fetch_add(&self.exported_buffers, 1) + + def __releasebuffer__(self, Py_buffer *buffer): + atomic_fetch_sub(&self.exported_buffers, 1) + + def realloc(self, Py_ssize_t new_nbytes): + if atomic_load(&self.exported_buffers) > 0: + raise BufferError("Cannot realloc memory while there are exported buffers.") + if new_nbytes <= 0: + raise ValueError("New number of bytes must be positive.") + + cdef void *p + with nogil: + p = mkl_realloc(self._memory_ptr, new_nbytes) + + if not p: + raise MemoryError("MKL memory reallocation failed.") + + self._memory_ptr = p + self.nbytes = new_nbytes + + def tobytes(self): + cdef char* data_ptr = self._memory_ptr + return data_ptr[:self.nbytes] + + @property + def nbytes(self): + return self.nbytes + + @property + def size(self): + return self.nbytes + + @property + def alignment(self): + return self.alignment + + @property + def _pointer(self): + return (self._memory_ptr) + + def __repr__(self): + return ( + f"(self._memory_ptr))}>" + ) + + def __len__(self): + return self.nbytes + + def __sizeof__(self): + return self.nbytes + + def __reduce__(self): + return (_mkl_memory_from_bytes, (self.tobytes(), self.alignment)) diff --git a/mkl/_mkl_service.pxd b/mkl/_mkl_service.pxd index 4cba157..3e07630 100644 --- a/mkl/_mkl_service.pxd +++ b/mkl/_mkl_service.pxd @@ -29,7 +29,7 @@ ctypedef unsigned long long MKL_UINT64 ctypedef int MKL_INT -cdef extern from "mkl.h": +cdef extern from "mkl.h" nogil: # MKL Function Domains Constants int MKL_DOMAIN_BLAS int MKL_DOMAIN_FFT @@ -148,6 +148,10 @@ cdef extern from "mkl.h": MKL_INT64 mkl_mem_stat(int* buf) MKL_INT64 mkl_peak_mem_usage(int mode) int mkl_set_memory_limit(int mem_type, size_t limit) + void *mkl_malloc(size_t size, int alignment) + void *mkl_realloc(void *ptr, size_t size) + void *mkl_calloc(size_t num, size_t size, int alignment) + void mkl_free(void *ptr) # Conditional Numerical Reproducibility int mkl_cbwr_set(int settings) diff --git a/mkl/_mkl_service.pyx b/mkl/_py_mkl_service.pyx similarity index 99% rename from mkl/_mkl_service.pyx rename to mkl/_py_mkl_service.pyx index 975a454..69c2f52 100644 --- a/mkl/_mkl_service.pyx +++ b/mkl/_py_mkl_service.pyx @@ -601,7 +601,8 @@ cdef inline void __free_buffers() noexcept: """ Frees unused memory allocated by the Intel(R) MKL Memory Allocator. """ - mkl.mkl_free_buffers() + with nogil: + mkl.mkl_free_buffers() return @@ -610,7 +611,8 @@ cdef inline void __thread_free_buffers() noexcept: Frees unused memory allocated by the Intel(R) MKL Memory Allocator in the current thread. """ - mkl.mkl_thread_free_buffers() + with nogil: + mkl.mkl_thread_free_buffers() return diff --git a/mkl/tests/test_mkl_memory.py b/mkl/tests/test_mkl_memory.py new file mode 100644 index 0000000..96f6f6f --- /dev/null +++ b/mkl/tests/test_mkl_memory.py @@ -0,0 +1,139 @@ +# Copyright (c) 2018, Intel Corporation +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of Intel Corporation nor the names of its contributors +# may be used to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +import sys + +import mkl + + +def test_mkl_memory_create_malloc(): + nbytes = 1024 + mem = mkl.MKLMemory(nbytes) + assert mem.nbytes == nbytes + # default alignment is 64 bytes + assert mem.alignment == 64 + + +def test_mkl_memory_create_calloc(): + size = 32 + num = 32 + nbytes = num * size + # test creating with mkl_calloc + mem = mkl.MKLMemory(num, size) + assert mem.nbytes == nbytes + # default alignment is 64 bytes + assert mem.alignment == 64 + + +def test_mkl_memory_create_with_malloc_and_alignment(): + size = 32 + num = 32 + nbytes = num * size + alignment = 128 + mem = mkl.MKLMemory(nbytes, alignment=alignment) + assert mem.nbytes == nbytes + assert mem.alignment == alignment + + +def test_mkl_memory_create_with_calloc_and_alignment(): + size = 32 + num = 32 + nbytes = num * size + alignment = 128 + mem = mkl.MKLMemory(num, size, alignment=alignment) + assert mem.nbytes == nbytes + + +def test_mkl_memory_create_from_mkl_memory(): + mem1 = mkl.MKLMemory(1024) + mem2 = mkl.MKLMemory(mem1) + assert mem2.nbytes == mem1.nbytes + + +def test_mkl_memory_create_from_mkl_memory_with_alignment(): + mem1 = mkl.MKLMemory(1024) + alignment = 128 + mem2 = mkl.MKLMemory(mem1, alignment=alignment) + assert mem2.nbytes == mem1.nbytes + assert mem2.alignment == alignment + + +def test_mkl_memory_propagates_alignment(): + mem1 = mkl.MKLMemory(1024, alignment=128) + mem2 = mkl.MKLMemory(mem1) + assert mem2.nbytes == mem1.nbytes + assert mem2.alignment == mem1.alignment + + +def test_mkl_memory_properties(): + nbytes = 1024 + mem = mkl.MKLMemory(nbytes) + assert len(mem) == nbytes + assert type(repr(mem)) is str + assert type(bytes(mem)) is bytes + assert sys.getsizeof(mem) >= nbytes + + +def test_buffer_protocol(): + mem = mkl.MKLMemory(1024) + mv1 = memoryview(mem) + assert mv1.nbytes == mem.nbytes + mv2 = memoryview(mem) + assert mv1 == mv2 + + +def test_pickling(): + import pickle + + mem = mkl.MKLMemory(1024) + mv = memoryview(mem) + for i in range(len(mem)): + mv[i] = (i % 32) + ord("a") + + mem_reconstructed = pickle.loads(pickle.dumps(mem)) + assert type(mem) is type(mem_reconstructed), "Pickling should preserve type" + assert ( + mem.tobytes() == mem_reconstructed.tobytes() + ), "Pickling should preserve buffer content" + assert ( + mem._pointer != mem_reconstructed._pointer + ), "Pickling/unpickling should be changing pointer" + + +def test_pickling_with_alignment(): + import pickle + + mem = mkl.MKLMemory(1024, alignment=128) + mem_reconstructed = pickle.loads(pickle.dumps(mem)) + assert type(mem) is type(mem_reconstructed), "Pickling should preserve type" + assert ( + mem.tobytes() == mem_reconstructed.tobytes() + ), "Pickling should preserve buffer content" + assert ( + mem._pointer != mem_reconstructed._pointer + ), "Pickling/unpickling should be changing pointer" + assert ( + mem.alignment == mem_reconstructed.alignment + ), "Pickling should preserve alignment" diff --git a/pyproject.toml b/pyproject.toml index 4f2a1b4..b153f74 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,19 +24,17 @@ # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. [build-system] -build-backend = "setuptools.build_meta" +build-backend = "mesonpy" requires = [ - "setuptools>=77", + "meson-python>=0.13.0", + "ninja", "Cython", - "wheel>=0.45.1", - "build>=1.2.2", - "mkl-devel" + "mkl-devel", + "cmake" ] [project] -authors = [ - {name = "Intel Corporation", email = "scripting@intel.com"} -] +authors = [{name = "Intel Corporation"}] classifiers = [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Science/Research", diff --git a/setup.py b/setup.py deleted file mode 100644 index 0362197..0000000 --- a/setup.py +++ /dev/null @@ -1,102 +0,0 @@ -# Copyright (c) 2018, Intel Corporation -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# * Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in the -# documentation and/or other materials provided with the distribution. -# * Neither the name of Intel Corporation nor the names of its contributors -# may be used to endorse or promote products derived from this software -# without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - - -import os -import sys -from os.path import join - -import Cython.Build -from setuptools import Extension, setup - - -def extensions(): - mkl_root = os.environ.get("MKLROOT", None) - if mkl_root: - mkl_info = { - "include_dirs": [join(mkl_root, "include")], - "library_dirs": [ - join(mkl_root, "lib"), - join(mkl_root, "lib", "intel64"), - ], - "libraries": ["mkl_rt"], - } - else: - raise ValueError("MKLROOT environment variable not set.") - - if sys.platform != "win32": - mkl_info["rpaths"] = ["$ORIGIN/../..", "$ORIGIN/../../.."] - - mkl_include_dirs = mkl_info.get("include_dirs", []) - mkl_library_dirs = mkl_info.get("library_dirs", []) - mkl_libraries = mkl_info.get("libraries", ["mkl_rt"]) - mkl_rpaths = mkl_info.get("rpaths", []) - - defs = [] - if any(["mkl_rt" in li for li in mkl_libraries]): - # libs += ["dl"] - by default on Linux - defs += [("USING_MKL_RT", None)] - - extensions = [] - extensions.append( - Extension( - "mkl._mklinit", - sources=[join("mkl", "_mklinitmodule.c")], - include_dirs=mkl_include_dirs, - libraries=mkl_libraries - + (["pthread"] if os.name == "posix" else []), - library_dirs=mkl_library_dirs, - runtime_library_dirs=mkl_rpaths, - extra_compile_args=[ - "-DNDEBUG" - # "-g", "-O2", "-Wall", - ], - define_macros=defs, - ) - ) - - extensions.append( - Extension( - "mkl._py_mkl_service", - sources=[join("mkl", "_mkl_service.pyx")], - include_dirs=mkl_include_dirs, - library_dirs=mkl_library_dirs, - libraries=mkl_libraries, - runtime_library_dirs=mkl_rpaths, - extra_compile_args=[ - "-DNDEBUG" - # "-g", "-O2", "-Wall", - ], - ) - ) - - return extensions - - -setup( - cmdclass={"build_ext": Cython.Build.build_ext}, - ext_modules=extensions(), - zip_safe=False, -)