[14de349] | 1 | """ |
---|
[eafc9fa] | 2 | GPU driver for C kernels |
---|
[14de349] | 3 | |
---|
[b0de252] | 4 | TODO: docs are out of date |
---|
| 5 | |
---|
[14de349] | 6 | There should be a single GPU environment running on the system. This |
---|
| 7 | environment is constructed on the first call to :func:`env`, and the |
---|
| 8 | same environment is returned on each call. |
---|
| 9 | |
---|
| 10 | After retrieving the environment, the next step is to create the kernel. |
---|
| 11 | This is done with a call to :meth:`GpuEnvironment.make_kernel`, which |
---|
| 12 | returns the type of data used by the kernel. |
---|
| 13 | |
---|
| 14 | Next a :class:`GpuData` object should be created with the correct kind |
---|
| 15 | of data. This data object can be used by multiple kernels, for example, |
---|
| 16 | if the target model is a weighted sum of multiple kernels. The data |
---|
| 17 | should include any extra evaluation points required to compute the proper |
---|
| 18 | data smearing. This need not match the square grid for 2D data if there |
---|
| 19 | is an index saying which q points are active. |
---|
| 20 | |
---|
| 21 | Together the GpuData, the program, and a device form a :class:`GpuKernel`. |
---|
| 22 | This kernel is used during fitting, receiving new sets of parameters and |
---|
| 23 | evaluating them. The output value is stored in an output buffer on the |
---|
| 24 | devices, where it can be combined with other structure factors and form |
---|
| 25 | factors and have instrumental resolution effects applied. |
---|
[92da231] | 26 | |
---|
| 27 | In order to use OpenCL for your models, you will need OpenCL drivers for |
---|
| 28 | your machine. These should be available from your graphics card vendor. |
---|
| 29 | Intel provides OpenCL drivers for CPUs as well as their integrated HD |
---|
| 30 | graphics chipsets. AMD also provides drivers for Intel CPUs, but as of |
---|
| 31 | this writing the performance is lacking compared to the Intel drivers. |
---|
| 32 | NVidia combines drivers for CUDA and OpenCL in one package. The result |
---|
| 33 | is a bit messy if you have multiple drivers installed. You can see which |
---|
| 34 | drivers are available by starting python and running: |
---|
| 35 | |
---|
| 36 | import pyopencl as cl |
---|
| 37 | cl.create_some_context(interactive=True) |
---|
| 38 | |
---|
| 39 | Once you have done that, it will show the available drivers which you |
---|
| 40 | can select. It will then tell you that you can use these drivers |
---|
[880a2ed] | 41 | automatically by setting the SAS_OPENCL environment variable, which is |
---|
| 42 | PYOPENCL_CTX equivalent but not conflicting with other pyopnecl programs. |
---|
[92da231] | 43 | |
---|
| 44 | Some graphics cards have multiple devices on the same card. You cannot |
---|
| 45 | yet use both of them concurrently to evaluate models, but you can run |
---|
| 46 | the program twice using a different device for each session. |
---|
| 47 | |
---|
| 48 | OpenCL kernels are compiled when needed by the device driver. Some |
---|
| 49 | drivers produce compiler output even when there is no error. You |
---|
| 50 | can see the output by setting PYOPENCL_COMPILER_OUTPUT=1. It should be |
---|
| 51 | harmless, albeit annoying. |
---|
[14de349] | 52 | """ |
---|
[ba32cdd] | 53 | from __future__ import print_function |
---|
[a5b8477] | 54 | |
---|
[250fa25] | 55 | import os |
---|
| 56 | import warnings |
---|
[821a9c6] | 57 | import logging |
---|
[6e5b2a7] | 58 | import time |
---|
[250fa25] | 59 | |
---|
[7ae2b7f] | 60 | import numpy as np # type: ignore |
---|
[b3f6bc3] | 61 | |
---|
[3221de0] | 62 | |
---|
[3199b17] | 63 | # Attempt to setup OpenCL. This may fail if the pyopencl package is not |
---|
[3221de0] | 64 | # installed or if it is installed but there are no devices available. |
---|
[250fa25] | 65 | try: |
---|
[3221de0] | 66 | import pyopencl as cl # type: ignore |
---|
| 67 | from pyopencl import mem_flags as mf |
---|
| 68 | from pyopencl.characterize import get_fast_inaccurate_build_options |
---|
[3199b17] | 69 | # Ask OpenCL for the default context so that we know that one exists. |
---|
[3221de0] | 70 | cl.create_some_context(interactive=False) |
---|
| 71 | HAVE_OPENCL = True |
---|
| 72 | OPENCL_ERROR = "" |
---|
[9404dd3] | 73 | except Exception as exc: |
---|
[6dba2f0] | 74 | HAVE_OPENCL = False |
---|
[3221de0] | 75 | OPENCL_ERROR = str(exc) |
---|
[14de349] | 76 | |
---|
[cb6ecf4] | 77 | from . import generate |
---|
[95f62aa] | 78 | from .generate import F32, F64 |
---|
[f619de7] | 79 | from .kernel import KernelModel, Kernel |
---|
[14de349] | 80 | |
---|
[2d81cfe] | 81 | # pylint: disable=unused-import |
---|
[a5b8477] | 82 | try: |
---|
| 83 | from typing import Tuple, Callable, Any |
---|
| 84 | from .modelinfo import ModelInfo |
---|
| 85 | from .details import CallDetails |
---|
| 86 | except ImportError: |
---|
| 87 | pass |
---|
[2d81cfe] | 88 | # pylint: enable=unused-import |
---|
[a5b8477] | 89 | |
---|
[3199b17] | 90 | |
---|
| 91 | # CRUFT: pyopencl < 2017.1 (as of June 2016 needs quotes around include path). |
---|
[20317b3] | 92 | def quote_path(v): |
---|
| 93 | """ |
---|
| 94 | Quote the path if it is not already quoted. |
---|
| 95 | |
---|
| 96 | If v starts with '-', then assume that it is a -I option or similar |
---|
| 97 | and do not quote it. This is fragile: -Ipath with space needs to |
---|
| 98 | be quoted. |
---|
| 99 | """ |
---|
| 100 | return '"'+v+'"' if v and ' ' in v and not v[0] in "\"'-" else v |
---|
| 101 | |
---|
[3199b17] | 102 | |
---|
[20317b3] | 103 | def fix_pyopencl_include(): |
---|
[40a87fa] | 104 | """ |
---|
| 105 | Monkey patch pyopencl to allow spaces in include file path. |
---|
| 106 | """ |
---|
[20317b3] | 107 | import pyopencl as cl |
---|
| 108 | if hasattr(cl, '_DEFAULT_INCLUDE_OPTIONS'): |
---|
[3199b17] | 109 | cl._DEFAULT_INCLUDE_OPTIONS = [ |
---|
| 110 | quote_path(v) for v in cl._DEFAULT_INCLUDE_OPTIONS |
---|
| 111 | ] |
---|
| 112 | |
---|
[20317b3] | 113 | |
---|
[6dba2f0] | 114 | if HAVE_OPENCL: |
---|
| 115 | fix_pyopencl_include() |
---|
[20317b3] | 116 | |
---|
[ce27e21] | 117 | # The max loops number is limited by the amount of local memory available |
---|
| 118 | # on the device. You don't want to make this value too big because it will |
---|
| 119 | # waste resources, nor too small because it may interfere with users trying |
---|
| 120 | # to do their polydispersity calculations. A value of 1024 should be much |
---|
| 121 | # larger than necessary given that cost grows as npts^k where k is the number |
---|
| 122 | # of polydisperse parameters. |
---|
[5d4777d] | 123 | MAX_LOOPS = 2048 |
---|
| 124 | |
---|
[5464d68] | 125 | # Pragmas for enable OpenCL features. Be sure to protect them so that they |
---|
| 126 | # still compile even if OpenCL is not present. |
---|
| 127 | _F16_PRAGMA = """\ |
---|
| 128 | #if defined(__OPENCL_VERSION__) // && !defined(cl_khr_fp16) |
---|
| 129 | # pragma OPENCL EXTENSION cl_khr_fp16: enable |
---|
| 130 | #endif |
---|
| 131 | """ |
---|
| 132 | |
---|
| 133 | _F64_PRAGMA = """\ |
---|
| 134 | #if defined(__OPENCL_VERSION__) // && !defined(cl_khr_fp64) |
---|
| 135 | # pragma OPENCL EXTENSION cl_khr_fp64: enable |
---|
| 136 | #endif |
---|
| 137 | """ |
---|
| 138 | |
---|
[3199b17] | 139 | |
---|
[3221de0] | 140 | def use_opencl(): |
---|
[07646b6] | 141 | sas_opencl = os.environ.get("SAS_OPENCL", "OpenCL").lower() |
---|
| 142 | return HAVE_OPENCL and sas_opencl != "none" and not sas_opencl.startswith("cuda") |
---|
[5464d68] | 143 | |
---|
[3199b17] | 144 | |
---|
[14de349] | 145 | ENV = None |
---|
[3221de0] | 146 | def reset_environment(): |
---|
| 147 | """ |
---|
| 148 | Call to create a new OpenCL context, such as after a change to SAS_OPENCL. |
---|
| 149 | """ |
---|
| 150 | global ENV |
---|
| 151 | ENV = GpuEnvironment() if use_opencl() else None |
---|
| 152 | |
---|
[3199b17] | 153 | |
---|
[14de349] | 154 | def environment(): |
---|
[dd7fc12] | 155 | # type: () -> "GpuEnvironment" |
---|
[14de349] | 156 | """ |
---|
| 157 | Returns a singleton :class:`GpuEnvironment`. |
---|
| 158 | |
---|
| 159 | This provides an OpenCL context and one queue per device. |
---|
| 160 | """ |
---|
[b4272a2] | 161 | if ENV is None: |
---|
| 162 | if not HAVE_OPENCL: |
---|
| 163 | raise RuntimeError("OpenCL startup failed with ***" |
---|
[d86f0fc] | 164 | + OPENCL_ERROR + "***; using C compiler instead") |
---|
[3221de0] | 165 | reset_environment() |
---|
[b4272a2] | 166 | if ENV is None: |
---|
| 167 | raise RuntimeError("SAS_OPENCL=None in environment") |
---|
[14de349] | 168 | return ENV |
---|
| 169 | |
---|
[3199b17] | 170 | |
---|
[5d316e9] | 171 | def has_type(device, dtype): |
---|
[dd7fc12] | 172 | # type: (cl.Device, np.dtype) -> bool |
---|
[14de349] | 173 | """ |
---|
[5d316e9] | 174 | Return true if device supports the requested precision. |
---|
[14de349] | 175 | """ |
---|
[95f62aa] | 176 | if dtype == F32: |
---|
[5d316e9] | 177 | return True |
---|
[f872fd1] | 178 | elif dtype == F64: |
---|
[5d316e9] | 179 | return "cl_khr_fp64" in device.extensions |
---|
| 180 | else: |
---|
[3199b17] | 181 | # Not supporting F16 type since it isn't accurate enough. |
---|
[5d316e9] | 182 | return False |
---|
[14de349] | 183 | |
---|
[3199b17] | 184 | |
---|
[f5b9a6b] | 185 | def get_warp(kernel, queue): |
---|
[dd7fc12] | 186 | # type: (cl.Kernel, cl.CommandQueue) -> int |
---|
[f5b9a6b] | 187 | """ |
---|
| 188 | Return the size of an execution batch for *kernel* running on *queue*. |
---|
| 189 | """ |
---|
[750ffa5] | 190 | return kernel.get_work_group_info( |
---|
[63b32bb] | 191 | cl.kernel_work_group_info.PREFERRED_WORK_GROUP_SIZE_MULTIPLE, |
---|
| 192 | queue.device) |
---|
[14de349] | 193 | |
---|
[3199b17] | 194 | |
---|
[5d316e9] | 195 | def compile_model(context, source, dtype, fast=False): |
---|
[dd7fc12] | 196 | # type: (cl.Context, str, np.dtype, bool) -> cl.Program |
---|
[14de349] | 197 | """ |
---|
| 198 | Build a model to run on the gpu. |
---|
| 199 | |
---|
[6cbdcd4] | 200 | Returns the compiled program and its type. |
---|
| 201 | |
---|
| 202 | Raises an error if the desired precision is not available. |
---|
[14de349] | 203 | """ |
---|
| 204 | dtype = np.dtype(dtype) |
---|
[5d316e9] | 205 | if not all(has_type(d, dtype) for d in context.devices): |
---|
| 206 | raise RuntimeError("%s not supported for devices"%dtype) |
---|
[14de349] | 207 | |
---|
[5464d68] | 208 | source_list = [generate.convert_type(source, dtype)] |
---|
| 209 | |
---|
| 210 | if dtype == generate.F16: |
---|
| 211 | source_list.insert(0, _F16_PRAGMA) |
---|
| 212 | elif dtype == generate.F64: |
---|
| 213 | source_list.insert(0, _F64_PRAGMA) |
---|
| 214 | |
---|
[3199b17] | 215 | # Note: USE_SINCOS makes the Intel CPU slower under OpenCL. |
---|
[14de349] | 216 | if context.devices[0].type == cl.device_type.GPU: |
---|
[5464d68] | 217 | source_list.insert(0, "#define USE_SINCOS\n") |
---|
[5d316e9] | 218 | options = (get_fast_inaccurate_build_options(context.devices[0]) |
---|
| 219 | if fast else []) |
---|
[ba32cdd] | 220 | source = "\n".join(source_list) |
---|
[5d316e9] | 221 | program = cl.Program(context, source).build(options=options) |
---|
[3199b17] | 222 | |
---|
[821a9c6] | 223 | #print("done with "+program) |
---|
[ce27e21] | 224 | return program |
---|
[14de349] | 225 | |
---|
| 226 | |
---|
[3199b17] | 227 | # For now, this returns one device in the context. |
---|
| 228 | # TODO: Create a context that contains all devices on all platforms. |
---|
[14de349] | 229 | class GpuEnvironment(object): |
---|
| 230 | """ |
---|
[3199b17] | 231 | GPU context for OpenCL, with possibly many devices and one queue per device. |
---|
[14de349] | 232 | """ |
---|
| 233 | def __init__(self): |
---|
[dd7fc12] | 234 | # type: () -> None |
---|
[3199b17] | 235 | # Find gpu context. |
---|
[95f62aa] | 236 | context_list = _create_some_context() |
---|
| 237 | |
---|
| 238 | # Find a context for F32 and for F64 (maybe the same one). |
---|
| 239 | # F16 isn't good enough. |
---|
| 240 | self.context = {} |
---|
| 241 | for dtype in (F32, F64): |
---|
| 242 | for context in context_list: |
---|
| 243 | if has_type(context.devices[0], dtype): |
---|
| 244 | self.context[dtype] = context |
---|
| 245 | break |
---|
| 246 | else: |
---|
| 247 | self.context[dtype] = None |
---|
| 248 | |
---|
[3199b17] | 249 | # Build a queue for each context. |
---|
[95f62aa] | 250 | self.queue = {} |
---|
| 251 | context = self.context[F32] |
---|
| 252 | self.queue[F32] = cl.CommandQueue(context, context.devices[0]) |
---|
| 253 | if self.context[F64] == self.context[F32]: |
---|
| 254 | self.queue[F64] = self.queue[F32] |
---|
| 255 | else: |
---|
| 256 | context = self.context[F64] |
---|
| 257 | self.queue[F64] = cl.CommandQueue(context, context.devices[0]) |
---|
[250fa25] | 258 | |
---|
[3199b17] | 259 | ## Byte boundary for data alignment. |
---|
[95f62aa] | 260 | #self.data_boundary = max(context.devices[0].min_data_type_align_size |
---|
| 261 | # for context in self.context.values()) |
---|
| 262 | |
---|
[3199b17] | 263 | # Cache for compiled programs, and for items in context. |
---|
[ce27e21] | 264 | self.compiled = {} |
---|
| 265 | |
---|
[5d316e9] | 266 | def has_type(self, dtype): |
---|
[dd7fc12] | 267 | # type: (np.dtype) -> bool |
---|
[eafc9fa] | 268 | """ |
---|
| 269 | Return True if all devices support a given type. |
---|
| 270 | """ |
---|
[95f62aa] | 271 | return self.context.get(dtype, None) is not None |
---|
[250fa25] | 272 | |
---|
[300a2f7] | 273 | def compile_program(self, name, source, dtype, fast, timestamp): |
---|
| 274 | # type: (str, str, np.dtype, bool, float) -> cl.Program |
---|
[eafc9fa] | 275 | """ |
---|
| 276 | Compile the program for the device in the given context. |
---|
| 277 | """ |
---|
[300a2f7] | 278 | # Note: PyOpenCL caches based on md5 hash of source, options and device |
---|
[3199b17] | 279 | # but I'll do so as well just to save some data munging time. |
---|
[7fcdc9f] | 280 | tag = generate.tag_source(source) |
---|
| 281 | key = "%s-%s-%s%s"%(name, dtype, tag, ("-fast" if fast else "")) |
---|
[3199b17] | 282 | # Check timestamp on program. |
---|
[300a2f7] | 283 | program, program_timestamp = self.compiled.get(key, (None, np.inf)) |
---|
| 284 | if program_timestamp < timestamp: |
---|
| 285 | del self.compiled[key] |
---|
[cde11f0f] | 286 | if key not in self.compiled: |
---|
[95f62aa] | 287 | context = self.context[dtype] |
---|
[20317b3] | 288 | logging.info("building %s for OpenCL %s", key, |
---|
| 289 | context.devices[0].name.strip()) |
---|
[95f62aa] | 290 | program = compile_model(self.context[dtype], |
---|
[fec69dd] | 291 | str(source), dtype, fast) |
---|
[300a2f7] | 292 | self.compiled[key] = (program, timestamp) |
---|
| 293 | return program |
---|
[14de349] | 294 | |
---|
[3199b17] | 295 | |
---|
[95f62aa] | 296 | def _create_some_context(): |
---|
| 297 | # type: () -> cl.Context |
---|
| 298 | """ |
---|
| 299 | Protected call to cl.create_some_context without interactivity. |
---|
| 300 | |
---|
| 301 | Uses SAS_OPENCL or PYOPENCL_CTX if they are set in the environment, |
---|
| 302 | otherwise scans for the most appropriate device using |
---|
[d5ce7fa] | 303 | :func:`_get_default_context`. Ignore *SAS_OPENCL=OpenCL*, which |
---|
| 304 | indicates that an OpenCL device should be used without specifying |
---|
| 305 | which one (and not a CUDA device, or no GPU). |
---|
[95f62aa] | 306 | """ |
---|
[3199b17] | 307 | # Assume we do not get here if SAS_OPENCL is None or CUDA. |
---|
[07646b6] | 308 | sas_opencl = os.environ.get('SAS_OPENCL', 'opencl') |
---|
| 309 | if sas_opencl.lower() != 'opencl': |
---|
[3199b17] | 310 | # Setting PYOPENCL_CTX as a SAS_OPENCL to create cl context. |
---|
[07646b6] | 311 | os.environ["PYOPENCL_CTX"] = sas_opencl |
---|
[95f62aa] | 312 | |
---|
| 313 | if 'PYOPENCL_CTX' in os.environ: |
---|
| 314 | try: |
---|
| 315 | return [cl.create_some_context(interactive=False)] |
---|
| 316 | except Exception as exc: |
---|
| 317 | warnings.warn(str(exc)) |
---|
[3199b17] | 318 | warnings.warn("pyopencl.create_some_context() failed. The " |
---|
| 319 | "environment variable 'SAS_OPENCL' or 'PYOPENCL_CTX' might " |
---|
| 320 | "not be set correctly") |
---|
[95f62aa] | 321 | |
---|
| 322 | return _get_default_context() |
---|
| 323 | |
---|
[3199b17] | 324 | |
---|
[3c56da87] | 325 | def _get_default_context(): |
---|
[20317b3] | 326 | # type: () -> List[cl.Context] |
---|
[eafc9fa] | 327 | """ |
---|
[d18582e] | 328 | Get an OpenCL context, preferring GPU over CPU, and preferring Intel |
---|
| 329 | drivers over AMD drivers. |
---|
[eafc9fa] | 330 | """ |
---|
[d18582e] | 331 | # Note: on mobile devices there is automatic clock scaling if either the |
---|
| 332 | # CPU or the GPU is underutilized; probably doesn't affect us, but we if |
---|
| 333 | # it did, it would mean that putting a busy loop on the CPU while the GPU |
---|
| 334 | # is running may increase throughput. |
---|
| 335 | # |
---|
[3199b17] | 336 | # MacBook Pro, base install: |
---|
[d18582e] | 337 | # {'Apple': [Intel CPU, NVIDIA GPU]} |
---|
[3199b17] | 338 | # MacBook Pro, base install: |
---|
[d18582e] | 339 | # {'Apple': [Intel CPU, Intel GPU]} |
---|
[3199b17] | 340 | # 2 x NVIDIA 295 with Intel and NVIDIA opencl drivers install: |
---|
[d18582e] | 341 | # {'Intel': [CPU], 'NVIDIA': [GPU, GPU, GPU, GPU]} |
---|
| 342 | gpu, cpu = None, None |
---|
[3c56da87] | 343 | for platform in cl.get_platforms(): |
---|
[e6a5556] | 344 | # AMD provides a much weaker CPU driver than Intel/Apple, so avoid it. |
---|
[20317b3] | 345 | # If someone has bothered to install the AMD/NVIDIA drivers, prefer |
---|
| 346 | # them over the integrated graphics driver that may have been supplied |
---|
| 347 | # with the CPU chipset. |
---|
| 348 | preferred_cpu = (platform.vendor.startswith('Intel') |
---|
| 349 | or platform.vendor.startswith('Apple')) |
---|
| 350 | preferred_gpu = (platform.vendor.startswith('Advanced') |
---|
| 351 | or platform.vendor.startswith('NVIDIA')) |
---|
[3c56da87] | 352 | for device in platform.get_devices(): |
---|
| 353 | if device.type == cl.device_type.GPU: |
---|
[20317b3] | 354 | # If the existing type is not GPU then it will be CUSTOM |
---|
| 355 | # or ACCELERATOR so don't override it. |
---|
[e6a5556] | 356 | if gpu is None or (preferred_gpu and gpu.type == cl.device_type.GPU): |
---|
| 357 | gpu = device |
---|
| 358 | elif device.type == cl.device_type.CPU: |
---|
| 359 | if cpu is None or preferred_cpu: |
---|
| 360 | cpu = device |
---|
[d18582e] | 361 | else: |
---|
[e6a5556] | 362 | # System has cl.device_type.ACCELERATOR or cl.device_type.CUSTOM |
---|
[3199b17] | 363 | # Intel Phi for example registers as an accelerator. |
---|
[20317b3] | 364 | # Since the user installed a custom device on their system |
---|
| 365 | # and went through the pain of sorting out OpenCL drivers for |
---|
| 366 | # it, lets assume they really do want to use it as their |
---|
| 367 | # primary compute device. |
---|
[e6a5556] | 368 | gpu = device |
---|
[199d40d] | 369 | |
---|
[3199b17] | 370 | # Order the devices by gpu then by cpu; when searching for an available |
---|
[20317b3] | 371 | # device by data type they will be checked in this order, which means |
---|
| 372 | # that if the gpu supports double then the cpu will never be used (though |
---|
| 373 | # we may make it possible to explicitly request the cpu at some point). |
---|
[e6a5556] | 374 | devices = [] |
---|
| 375 | if gpu is not None: |
---|
| 376 | devices.append(gpu) |
---|
| 377 | if cpu is not None: |
---|
| 378 | devices.append(cpu) |
---|
| 379 | return [cl.Context([d]) for d in devices] |
---|
[3c56da87] | 380 | |
---|
[250fa25] | 381 | |
---|
[f619de7] | 382 | class GpuModel(KernelModel): |
---|
[14de349] | 383 | """ |
---|
| 384 | GPU wrapper for a single model. |
---|
| 385 | |
---|
[17bbadd] | 386 | *source* and *model_info* are the model source and interface as returned |
---|
| 387 | from :func:`generate.make_source` and :func:`generate.make_model_info`. |
---|
[14de349] | 388 | |
---|
| 389 | *dtype* is the desired model precision. Any numpy dtype for single |
---|
| 390 | or double precision floats will do, such as 'f', 'float32' or 'single' |
---|
| 391 | for single and 'd', 'float64' or 'double' for double. Double precision |
---|
| 392 | is an optional extension which may not be available on all devices. |
---|
[cde11f0f] | 393 | Half precision ('float16','half') may be available on some devices. |
---|
| 394 | Fast precision ('fast') is a loose version of single precision, indicating |
---|
| 395 | that the compiler is allowed to take shortcuts. |
---|
[14de349] | 396 | """ |
---|
[3199b17] | 397 | info = None # type: ModelInfo |
---|
| 398 | source = "" # type: str |
---|
| 399 | dtype = None # type: np.dtype |
---|
| 400 | fast = False # type: bool |
---|
| 401 | _program = None # type: cl.Program |
---|
| 402 | _kernels = None # type: Dict[str, cl.Kernel] |
---|
[7126c04] | 403 | |
---|
[dd7fc12] | 404 | def __init__(self, source, model_info, dtype=generate.F32, fast=False): |
---|
[a4280bd] | 405 | # type: (Dict[str,str], ModelInfo, np.dtype, bool) -> None |
---|
[17bbadd] | 406 | self.info = model_info |
---|
[ce27e21] | 407 | self.source = source |
---|
[dd7fc12] | 408 | self.dtype = dtype |
---|
| 409 | self.fast = fast |
---|
[14de349] | 410 | |
---|
[ce27e21] | 411 | def __getstate__(self): |
---|
[dd7fc12] | 412 | # type: () -> Tuple[ModelInfo, str, np.dtype, bool] |
---|
[eafc9fa] | 413 | return self.info, self.source, self.dtype, self.fast |
---|
[14de349] | 414 | |
---|
[ce27e21] | 415 | def __setstate__(self, state): |
---|
[dd7fc12] | 416 | # type: (Tuple[ModelInfo, str, np.dtype, bool]) -> None |
---|
[eafc9fa] | 417 | self.info, self.source, self.dtype, self.fast = state |
---|
[7126c04] | 418 | self._program = self._kernels = None |
---|
[ce27e21] | 419 | |
---|
[9eb3632] | 420 | def make_kernel(self, q_vectors): |
---|
[dd7fc12] | 421 | # type: (List[np.ndarray]) -> "GpuKernel" |
---|
[95f62aa] | 422 | return GpuKernel(self, q_vectors) |
---|
| 423 | |
---|
[7126c04] | 424 | def get_function(self, name): |
---|
[95f62aa] | 425 | # type: (str) -> cl.Kernel |
---|
| 426 | """ |
---|
| 427 | Fetch the kernel from the environment by name, compiling it if it |
---|
| 428 | does not already exist. |
---|
| 429 | """ |
---|
[7126c04] | 430 | if self._program is None: |
---|
| 431 | self._prepare_program() |
---|
| 432 | return self._kernels[name] |
---|
| 433 | |
---|
| 434 | def _prepare_program(self): |
---|
| 435 | # type: (str) -> None |
---|
| 436 | env = environment() |
---|
| 437 | timestamp = generate.ocl_timestamp(self.info) |
---|
| 438 | program = env.compile_program( |
---|
| 439 | self.info.name, |
---|
| 440 | self.source['opencl'], |
---|
| 441 | self.dtype, |
---|
| 442 | self.fast, |
---|
| 443 | timestamp) |
---|
| 444 | variants = ['Iq', 'Iqxy', 'Imagnetic'] |
---|
| 445 | names = [generate.kernel_name(self.info, k) for k in variants] |
---|
[00afc15] | 446 | functions = [getattr(program, k) for k in names] |
---|
| 447 | self._kernels = {k: v for k, v in zip(variants, functions)} |
---|
[3199b17] | 448 | # Keep a handle to program so GC doesn't collect. |
---|
[7126c04] | 449 | self._program = program |
---|
[14de349] | 450 | |
---|
[3199b17] | 451 | |
---|
| 452 | # TODO: Check that we don't need a destructor for buffers which go out of scope. |
---|
[14de349] | 453 | class GpuInput(object): |
---|
| 454 | """ |
---|
| 455 | Make q data available to the gpu. |
---|
| 456 | |
---|
| 457 | *q_vectors* is a list of q vectors, which will be *[q]* for 1-D data, |
---|
| 458 | and *[qx, qy]* for 2-D data. Internally, the vectors will be reallocated |
---|
| 459 | to get the best performance on OpenCL, which may involve shifting and |
---|
| 460 | stretching the array to better match the memory architecture. Additional |
---|
| 461 | points will be evaluated with *q=1e-3*. |
---|
| 462 | |
---|
| 463 | *dtype* is the data type for the q vectors. The data type should be |
---|
| 464 | set to match that of the kernel, which is an attribute of |
---|
| 465 | :class:`GpuProgram`. Note that not all kernels support double |
---|
| 466 | precision, so even if the program was created for double precision, |
---|
| 467 | the *GpuProgram.dtype* may be single precision. |
---|
| 468 | |
---|
| 469 | Call :meth:`release` when complete. Even if not called directly, the |
---|
| 470 | buffer will be released when the data object is freed. |
---|
| 471 | """ |
---|
[cb6ecf4] | 472 | def __init__(self, q_vectors, dtype=generate.F32): |
---|
[dd7fc12] | 473 | # type: (List[np.ndarray], np.dtype) -> None |
---|
[3199b17] | 474 | # TODO: Do we ever need double precision q? |
---|
[14de349] | 475 | self.nq = q_vectors[0].size |
---|
| 476 | self.dtype = np.dtype(dtype) |
---|
[eafc9fa] | 477 | self.is_2d = (len(q_vectors) == 2) |
---|
[3199b17] | 478 | # TODO: Stretch input based on get_warp(). |
---|
| 479 | # Not doing it now since warp depends on kernel, which is not known |
---|
[f5b9a6b] | 480 | # at this point, so instead using 32, which is good on the set of |
---|
| 481 | # architectures tested so far. |
---|
[c072f83] | 482 | if self.is_2d: |
---|
[07646b6] | 483 | width = ((self.nq+15)//16)*16 |
---|
[c072f83] | 484 | self.q = np.empty((width, 2), dtype=dtype) |
---|
| 485 | self.q[:self.nq, 0] = q_vectors[0] |
---|
| 486 | self.q[:self.nq, 1] = q_vectors[1] |
---|
| 487 | else: |
---|
[07646b6] | 488 | width = ((self.nq+31)//32)*32 |
---|
[c072f83] | 489 | self.q = np.empty(width, dtype=dtype) |
---|
| 490 | self.q[:self.nq] = q_vectors[0] |
---|
| 491 | self.global_size = [self.q.shape[0]] |
---|
[7126c04] | 492 | #print("creating inputs of size", self.global_size) |
---|
[95f62aa] | 493 | |
---|
[3199b17] | 494 | # Transfer input value to GPU. |
---|
[95f62aa] | 495 | env = environment() |
---|
[7126c04] | 496 | context = env.context[self.dtype] |
---|
| 497 | self.q_b = cl.Buffer(context, mf.READ_ONLY | mf.COPY_HOST_PTR, |
---|
| 498 | hostbuf=self.q) |
---|
[14de349] | 499 | |
---|
| 500 | def release(self): |
---|
[dd7fc12] | 501 | # type: () -> None |
---|
[eafc9fa] | 502 | """ |
---|
[3199b17] | 503 | Free the buffer associated with the q value. |
---|
[eafc9fa] | 504 | """ |
---|
[7126c04] | 505 | if self.q_b is not None: |
---|
| 506 | self.q_b.release() |
---|
| 507 | self.q_b = None |
---|
[14de349] | 508 | |
---|
[eafc9fa] | 509 | def __del__(self): |
---|
[dd7fc12] | 510 | # type: () -> None |
---|
[eafc9fa] | 511 | self.release() |
---|
| 512 | |
---|
[3199b17] | 513 | |
---|
[f619de7] | 514 | class GpuKernel(Kernel): |
---|
[ff7119b] | 515 | """ |
---|
| 516 | Callable SAS kernel. |
---|
| 517 | |
---|
[95f62aa] | 518 | *model* is the GpuModel object to call |
---|
[ff7119b] | 519 | |
---|
[7126c04] | 520 | The kernel is derived from :class:`Kernel`, providing the |
---|
| 521 | :meth:`call_kernel` method to evaluate the kernel for a given set of |
---|
| 522 | parameters. Because of the need to move the q values to the GPU before |
---|
| 523 | evaluation, the kernel is instantiated for a particular set of q vectors, |
---|
| 524 | and can be called many times without transfering q each time. |
---|
[ff7119b] | 525 | |
---|
| 526 | Call :meth:`release` when done with the kernel instance. |
---|
| 527 | """ |
---|
[3199b17] | 528 | #: SAS model information structure. |
---|
| 529 | info = None # type: ModelInfo |
---|
| 530 | #: Kernel precision. |
---|
| 531 | dtype = None # type: np.dtype |
---|
| 532 | #: Kernel dimensions (1d or 2d). |
---|
| 533 | dim = "" # type: str |
---|
| 534 | #: Calculation results, updated after each call to :meth:`_call_kernel`. |
---|
| 535 | result = None # type: np.ndarray |
---|
[7126c04] | 536 | |
---|
[95f62aa] | 537 | def __init__(self, model, q_vectors): |
---|
[7126c04] | 538 | # type: (GpuModel, List[np.ndarray]) -> None |
---|
[95f62aa] | 539 | dtype = model.dtype |
---|
| 540 | self.q_input = GpuInput(q_vectors, dtype) |
---|
| 541 | self._model = model |
---|
| 542 | |
---|
[3199b17] | 543 | # Attributes accessed from the outside. |
---|
[95f62aa] | 544 | self.dim = '2d' if self.q_input.is_2d else '1d' |
---|
| 545 | self.info = model.info |
---|
[3199b17] | 546 | self.dtype = dtype |
---|
[95f62aa] | 547 | |
---|
[3199b17] | 548 | # Converter to translate input to target type. |
---|
| 549 | self._as_dtype = np.float64 if dtype == generate.F64 else np.float32 |
---|
| 550 | |
---|
| 551 | # Holding place for the returned value. |
---|
[5399809] | 552 | nout = 2 if self.info.have_Fq and self.dim == '1d' else 1 |
---|
[3199b17] | 553 | extra_q = 4 # Total weight, form volume, shell volume and R_eff. |
---|
| 554 | self.result = np.empty(self.q_input.nq*nout + extra_q, dtype) |
---|
[14de349] | 555 | |
---|
[3199b17] | 556 | # Allocate result value on GPU. |
---|
[ce27e21] | 557 | env = environment() |
---|
[7126c04] | 558 | context = env.context[self.dtype] |
---|
| 559 | width = ((self.result.size+31)//32)*32 * self.dtype.itemsize |
---|
| 560 | self._result_b = cl.Buffer(context, mf.READ_WRITE, width) |
---|
[d18582e] | 561 | |
---|
[3199b17] | 562 | def _call_kernel(self, call_details, values, cutoff, magnetic, |
---|
| 563 | effective_radius_type): |
---|
| 564 | # type: (CallDetails, np.ndarray, float, bool, int) -> np.ndarray |
---|
[95f62aa] | 565 | env = environment() |
---|
| 566 | queue = env.queue[self._model.dtype] |
---|
| 567 | context = queue.context |
---|
| 568 | |
---|
[3199b17] | 569 | # Arrange data transfer to card. |
---|
[48fbd50] | 570 | details_b = cl.Buffer(context, mf.READ_ONLY | mf.COPY_HOST_PTR, |
---|
[8d62008] | 571 | hostbuf=call_details.buffer) |
---|
[48fbd50] | 572 | values_b = cl.Buffer(context, mf.READ_ONLY | mf.COPY_HOST_PTR, |
---|
| 573 | hostbuf=values) |
---|
| 574 | |
---|
[3199b17] | 575 | # Setup kernel function and arguments. |
---|
[95f62aa] | 576 | name = 'Iq' if self.dim == '1d' else 'Imagnetic' if magnetic else 'Iqxy' |
---|
[7126c04] | 577 | kernel = self._model.get_function(name) |
---|
[95f62aa] | 578 | kernel_args = [ |
---|
[3199b17] | 579 | np.uint32(self.q_input.nq), # Number of inputs. |
---|
| 580 | None, # Placeholder for pd_start. |
---|
| 581 | None, # Placeholder for pd_stop. |
---|
| 582 | details_b, # Problem definition. |
---|
| 583 | values_b, # Parameter values. |
---|
| 584 | self.q_input.q_b, # Q values. |
---|
| 585 | self._result_b, # Result storage. |
---|
| 586 | self._as_dtype(cutoff), # Probability cutoff. |
---|
| 587 | np.uint32(effective_radius_type), # R_eff mode. |
---|
[9eb3632] | 588 | ] |
---|
[3199b17] | 589 | |
---|
| 590 | # Call kernel and retrieve results. |
---|
[9eb3632] | 591 | #print("Calling OpenCL") |
---|
[c036ddb] | 592 | #call_details.show(values) |
---|
[6e5b2a7] | 593 | wait_for = None |
---|
| 594 | last_nap = time.clock() |
---|
| 595 | step = 1000000//self.q_input.nq + 1 |
---|
[bde38b5] | 596 | for start in range(0, call_details.num_eval, step): |
---|
| 597 | stop = min(start + step, call_details.num_eval) |
---|
[9eb3632] | 598 | #print("queuing",start,stop) |
---|
[95f62aa] | 599 | kernel_args[1:3] = [np.int32(start), np.int32(stop)] |
---|
| 600 | wait_for = [kernel(queue, self.q_input.global_size, None, |
---|
| 601 | *kernel_args, wait_for=wait_for)] |
---|
[6e5b2a7] | 602 | if stop < call_details.num_eval: |
---|
[3199b17] | 603 | # Allow other processes to run. |
---|
[6e5b2a7] | 604 | wait_for[0].wait() |
---|
| 605 | current_time = time.clock() |
---|
| 606 | if current_time - last_nap > 0.5: |
---|
[8b31efa] | 607 | time.sleep(0.001) |
---|
[6e5b2a7] | 608 | last_nap = current_time |
---|
[7126c04] | 609 | cl.enqueue_copy(queue, self.result, self._result_b, wait_for=wait_for) |
---|
[bde38b5] | 610 | #print("result", self.result) |
---|
[ae2b6b5] | 611 | |
---|
[3199b17] | 612 | # Free buffers. |
---|
[7126c04] | 613 | details_b.release() |
---|
| 614 | values_b.release() |
---|
[14de349] | 615 | |
---|
| 616 | def release(self): |
---|
[dd7fc12] | 617 | # type: () -> None |
---|
[eafc9fa] | 618 | """ |
---|
| 619 | Release resources associated with the kernel. |
---|
| 620 | """ |
---|
[95f62aa] | 621 | self.q_input.release() |
---|
[7126c04] | 622 | if self._result_b is not None: |
---|
| 623 | self._result_b.release() |
---|
| 624 | self._result_b = None |
---|
[14de349] | 625 | |
---|
| 626 | def __del__(self): |
---|
[dd7fc12] | 627 | # type: () -> None |
---|
[14de349] | 628 | self.release() |
---|