File size: 5,569 Bytes
9c6594c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# cython: profile=False
# distutils: language = c++
# cython: embedsignature = True
cpdef enum DeviceAllocationType:
CPU = <char> CDeviceAllocationType_kCPU
CUDA = <char> CDeviceAllocationType_kCUDA
CUDA_HOST = <char> CDeviceAllocationType_kCUDA_HOST
OPENCL = <char> CDeviceAllocationType_kOPENCL
VULKAN = <char> CDeviceAllocationType_kVULKAN
METAL = <char> CDeviceAllocationType_kMETAL
VPI = <char> CDeviceAllocationType_kVPI
ROCM = <char> CDeviceAllocationType_kROCM
ROCM_HOST = <char> CDeviceAllocationType_kROCM_HOST
EXT_DEV = <char> CDeviceAllocationType_kEXT_DEV
CUDA_MANAGED = <char> CDeviceAllocationType_kCUDA_MANAGED
ONEAPI = <char> CDeviceAllocationType_kONEAPI
WEBGPU = <char> CDeviceAllocationType_kWEBGPU
HEXAGON = <char> CDeviceAllocationType_kHEXAGON
cdef object _wrap_device_allocation_type(CDeviceAllocationType device_type):
return DeviceAllocationType(<char> device_type)
cdef class Device(_Weakrefable):
"""
Abstract interface for hardware devices
This object represents a device with access to some memory spaces.
When handling a Buffer or raw memory address, it allows deciding in which
context the raw memory address should be interpreted
(e.g. CPU-accessible memory, or embedded memory on some particular GPU).
"""
def __init__(self):
raise TypeError("Do not call Device's constructor directly, "
"use the device attribute of the MemoryManager instead.")
cdef void init(self, const shared_ptr[CDevice]& device):
self.device = device
@staticmethod
cdef wrap(const shared_ptr[CDevice]& device):
cdef Device self = Device.__new__(Device)
self.init(device)
return self
cdef inline shared_ptr[CDevice] unwrap(self) nogil:
return self.device
def __eq__(self, other):
if not isinstance(other, Device):
return False
return self.device.get().Equals(deref((<Device>other).device.get()))
def __repr__(self):
return "<pyarrow.Device: {}>".format(frombytes(self.device.get().ToString()))
@property
def type_name(self):
"""
A shorthand for this device's type.
"""
return frombytes(self.device.get().type_name())
@property
def device_id(self):
"""
A device ID to identify this device if there are multiple of this type.
If there is no "device_id" equivalent (such as for the main CPU device on
non-numa systems) returns -1.
"""
return self.device.get().device_id()
@property
def is_cpu(self):
"""
Whether this device is the main CPU device.
This shorthand method is very useful when deciding whether a memory address
is CPU-accessible.
"""
return self.device.get().is_cpu()
@property
def device_type(self):
"""
Return the DeviceAllocationType of this device.
"""
return _wrap_device_allocation_type(self.device.get().device_type())
cdef class MemoryManager(_Weakrefable):
"""
An object that provides memory management primitives.
A MemoryManager is always tied to a particular Device instance.
It can also have additional parameters (such as a MemoryPool to
allocate CPU memory).
"""
def __init__(self):
raise TypeError("Do not call MemoryManager's constructor directly, "
"use pyarrow.default_cpu_memory_manager() instead.")
cdef void init(self, const shared_ptr[CMemoryManager]& mm):
self.memory_manager = mm
@staticmethod
cdef wrap(const shared_ptr[CMemoryManager]& mm):
cdef MemoryManager self = MemoryManager.__new__(MemoryManager)
self.init(mm)
return self
cdef inline shared_ptr[CMemoryManager] unwrap(self) nogil:
return self.memory_manager
def __repr__(self):
return "<pyarrow.MemoryManager device: {}>".format(
frombytes(self.memory_manager.get().device().get().ToString())
)
@property
def device(self):
"""
The device this MemoryManager is tied to.
"""
return Device.wrap(self.memory_manager.get().device())
@property
def is_cpu(self):
"""
Whether this MemoryManager is tied to the main CPU device.
This shorthand method is very useful when deciding whether a memory
address is CPU-accessible.
"""
return self.memory_manager.get().is_cpu()
def default_cpu_memory_manager():
"""
Return the default CPU MemoryManager instance.
The returned singleton instance uses the default MemoryPool.
"""
return MemoryManager.wrap(c_default_cpu_memory_manager())
|