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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
//! Functions and types for enumerating CUDA devices and retrieving information about them. use crate::error::{CudaResult, ToResult}; use cuda_sys::cuda::*; use std::ffi::CStr; use std::ops::Range; /// All supported device attributes for [Device::get_attribute](struct.Device.html#method.get_attribute) #[repr(u32)] #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] pub enum DeviceAttribute { /// Maximum number of threads per block MaxThreadsPerBlock = 1, /// Maximum x-dimension of a block MaxBlockDimX = 2, /// Maximum y-dimension of a block MaxBlockDimY = 3, /// Maximum z-dimension of a block MaxBlockDimZ = 4, /// Maximum x-dimension of a grid MaxGridDimX = 5, /// Maximum y-dimension of a grid MaxGridDimY = 6, /// Maximum z-dimension of a grid MaxGridDimZ = 7, /// Maximum amount of shared memory available to a thread block in bytes MaxSharedMemoryPerBlock = 8, /// Memory available on device for constant variables in a kernel in bytes TotalConstantMemory = 9, /// Warp size in threads WarpSize = 10, /// Maximum pitch in bytes allowed by the memory copy functions that involve memory regions /// allocated through cuMemAllocPitch() MaxPitch = 11, /// Maximum number of 32-bit registers available to a thread block MaxRegistersPerBlock = 12, /// Typical clock frequency in kilohertz ClockRate = 13, /// Alignment requirement for textures TextureAlignment = 14, //GpuOverlap = 15, - Deprecated. /// Number of multiprocessors on device. MultiprocessorCount = 16, /// Specifies whether there is a run time limit on kernels KernelExecTimeout = 17, /// Device is integrated with host memory Integrated = 18, /// Device can map host memory into CUDA address space CanMapHostMemory = 19, /// Compute Mode ComputeMode = 20, /// Maximum 1D texture width MaximumTexture1DWidth = 21, /// Maximum 2D texture width MaximumTexture2DWidth = 22, /// Maximum 2D texture height MaximumTexture2DHeight = 23, /// Maximum 3D texture width MaximumTexture3DWidth = 24, /// Maximum 3D texture height MaximumTexture3DHeight = 25, /// Maximum 3D texture depth MaximumTexture3DDepth = 26, /// Maximum 2D layered texture width MaximumTexture2DLayeredWidth = 27, /// Maximum 2D layered texture height MaximumTexture2DLayeredHeight = 28, /// Maximum layers in a 2D layered texture MaximumTexture2DLayeredLayers = 29, /// Alignment requirement for surfaces SurfaceAlignment = 30, /// Device can possibly execute multiple kernels concurrently ConcurrentKernels = 31, /// Device has ECC support enabled EccEnabled = 32, /// PCI bus ID of the device PciBusId = 33, /// PCI device ID of the device PciDeviceId = 34, /// Device is using TCC driver model TccDriver = 35, /// Peak memory clock frequency in kilohertz MemoryClockRate = 36, /// Global memory bus width in bits GlobalMemoryBusWidth = 37, /// Size of L2 cache in bytes. L2CacheSize = 38, /// Maximum resident threads per multiprocessor MaxThreadsPerMultiprocessor = 39, /// Number of asynchronous engines AsyncEngineCount = 40, /// Device shares a unified address space with the host UnifiedAddressing = 41, /// Maximum 1D layered texture width MaximumTexture1DLayeredWidth = 42, /// Maximum layers in a 1D layered texture MaximumTexture1DLayeredLayers = 43, //CanTex2DGather = 44, deprecated /// Maximum 2D texture width if CUDA_ARRAY3D_TEXTURE_GATHER is set MaximumTexture2DGatherWidth = 45, /// Maximum 2D texture height if CUDA_ARRAY3D_TEXTURE_GATHER is set MaximumTexture2DGatherHeight = 46, /// Alternate maximum 3D texture width MaximumTexture3DWidthAlternate = 47, /// Alternate maximum 3D texture height MaximumTexture3DHeightAlternate = 48, /// Alternate maximum 3D texture depth MaximumTexture3DDepthAlternate = 49, /// PCI domain ID of the device PciDomainId = 50, /// Pitch alignment requirement for textures TexturePitchAlignment = 51, /// Maximum cubemap texture width/height MaximumTextureCubemapWidth = 52, /// Maximum cubemap layered texture width/height MaximumTextureCubemapLayeredWidth = 53, /// Maximum layers in a cubemap layered texture MaximumTextureCubemapLayeredLayers = 54, /// Maximum 1D surface width MaximumSurface1DWidth = 55, /// Maximum 2D surface width MaximumSurface2DWidth = 56, /// Maximum 2D surface height MaximumSurface2DHeight = 57, /// Maximum 3D surface width MaximumSurface3DWidth = 58, /// Maximum 3D surface height MaximumSurface3DHeight = 59, /// Maximum 3D surface depth MaximumSurface3DDepth = 60, /// Maximum 1D layered surface width MaximumSurface1DLayeredWidth = 61, /// Maximum layers in a 1D layered surface MaximumSurface1DLayeredLayers = 62, /// Maximum 2D layered surface width MaximumSurface2DLayeredWidth = 63, /// Maximum 2D layered surface height MaximumSurface2DLayeredHeight = 64, /// Maximum layers in a 2D layered surface MaximumSurface2DLayeredLayers = 65, /// Maximum cubemap surface width MaximumSurfacecubemapWidth = 66, /// Maximum cubemap layered surface width MaximumSurfacecubemapLayeredWidth = 67, /// Maximum layers in a cubemap layered surface MaximumSurfacecubemapLayeredLayers = 68, /// Maximum 1D linear texture width MaximumTexture1DLinearWidth = 69, /// Maximum 2D linear texture width MaximumTexture2DLinearWidth = 70, /// Maximum 2D linear texture height MaximumTexture2DLinearHeight = 71, /// Maximum 2D linear texture pitch in bytes MaximumTexture2DLinearPitch = 72, /// Maximum mipmapped 2D texture height MaximumTexture2DMipmappedWidth = 73, /// Maximum mipmapped 2D texture width MaximumTexture2DMipmappedHeight = 74, /// Major compute capability version number ComputeCapabilityMajor = 75, /// Minor compute capability version number ComputeCapabilityMinor = 76, /// Maximum mipammed 1D texture width MaximumTexture1DMipmappedWidth = 77, /// Device supports stream priorities StreamPrioritiesSupported = 78, /// Device supports caching globals in L1 GlobalL1CacheSupported = 79, /// Device supports caching locals in L1 LocalL1CacheSupported = 80, /// Maximum shared memory available per multiprocessor in bytes MaxSharedMemoryPerMultiprocessor = 81, /// Maximum number of 32-bit registers available per multiprocessor MaxRegistersPerMultiprocessor = 82, /// Device can allocate managed memory on this system ManagedMemory = 83, /// Device is on a multi-GPU board MultiGpuBoard = 84, /// Unique ID for a group of devices on the same multi-GPU board MultiGpuBoardGroupId = 85, /// Link between the device and the host supports native atomic operations (this is a /// placeholder attribute and is not supported on any current hardware) HostNativeAtomicSupported = 86, /// Ratio of single precision performance (in floating-point operations per second) to double /// precision performance SingleToDoublePrecisionPerfRatio = 87, /// Device supports coherently accessing pageable memory without calling cudaHostRegister on it. PageableMemoryAccess = 88, /// Device can coherently access managed memory concurrently with the CPU ConcurrentManagedAccess = 89, /// Device supports compute preemption ComputePreemptionSupported = 90, /// Device can access host registered memory at the same virtual address as the CPU CanUseHostPointerForRegisteredMem = 91, #[doc(hidden)] __NonExhaustive = 92, } /// Opaque handle to a CUDA device. #[derive(Debug, Clone, Copy, Hash, Eq, PartialEq)] pub struct Device { pub(crate) device: CUdevice, } impl Device { /// Get the number of CUDA-capable devices. /// /// Returns the number of devices with compute-capability 2.0 or greater which are available /// for execution. /// /// # Example /// ``` /// # use rustacuda::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box<dyn Error>> { /// # init(CudaFlags::empty())?; /// use rustacuda::device::Device; /// let num_devices = Device::num_devices()?; /// println!("Number of devices: {}", num_devices); /// # Ok(()) /// # } /// ``` pub fn num_devices() -> CudaResult<u32> { unsafe { let mut num_devices = 0i32; cuDeviceGetCount(&mut num_devices as *mut i32).to_result()?; Ok(num_devices as u32) } } /// Get a handle to the `ordinal`'th CUDA device. /// /// Ordinal must be in the range `0..num_devices()`. If not, an error will be returned. /// /// # Example /// ``` /// # use rustacuda::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box<dyn Error>> { /// # init(CudaFlags::empty())?; /// use rustacuda::device::Device; /// let device = Device::get_device(0)?; /// println!("Device Name: {}", device.name()?); /// # Ok(()) /// # } /// ``` pub fn get_device(ordinal: u32) -> CudaResult<Device> { unsafe { let mut device = Device { device: 0 }; cuDeviceGet(&mut device.device as *mut CUdevice, ordinal as i32).to_result()?; Ok(device) } } /// Return an iterator over all CUDA devices. /// /// # Example /// ``` /// # use rustacuda::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box<dyn Error>> { /// # init(CudaFlags::empty())?; /// use rustacuda::device::Device; /// for device in Device::devices()? { /// let device = device?; /// println!("Device Name: {}", device.name()?); /// } /// # Ok(()) /// # } /// ``` pub fn devices() -> CudaResult<Devices> { Device::num_devices().map(|num_devices| Devices { range: 0..num_devices, }) } /// Returns the total amount of memory available on the device in bytes. /// /// # Example /// ``` /// # use rustacuda::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box<dyn Error>> { /// # init(CudaFlags::empty())?; /// use rustacuda::device::Device; /// let device = Device::get_device(0)?; /// println!("Device Memory: {}", device.total_memory()?); /// # Ok(()) /// # } /// ``` pub fn total_memory(self) -> CudaResult<usize> { unsafe { let mut memory = 0; cuDeviceTotalMem_v2(&mut memory as *mut usize, self.device).to_result()?; Ok(memory) } } /// Returns the name of this device. /// /// # Example /// ``` /// # use rustacuda::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box<dyn Error>> { /// # init(CudaFlags::empty())?; /// use rustacuda::device::Device; /// let device = Device::get_device(0)?; /// println!("Device Name: {}", device.name()?); /// # Ok(()) /// # } /// ``` pub fn name(self) -> CudaResult<String> { unsafe { let mut name = [0u8; 128]; // Hopefully this is big enough... cuDeviceGetName( &mut name[0] as *mut u8 as *mut ::std::os::raw::c_char, 128, self.device, ) .to_result()?; let nul_index = name .iter() .cloned() .position(|byte| byte == 0) .expect("Expected device name to fit in 128 bytes and be nul-terminated."); let cstr = CStr::from_bytes_with_nul_unchecked(&name[0..=nul_index]); Ok(cstr.to_string_lossy().into_owned()) } } /// Returns information about this device. /// /// # Example /// ``` /// # use rustacuda::*; /// # use std::error::Error; /// # fn main() -> Result<(), Box<dyn Error>> { /// # init(CudaFlags::empty())?; /// use rustacuda::device::{Device, DeviceAttribute}; /// let device = Device::get_device(0)?; /// println!("Max Threads Per Block: {}", /// device.get_attribute(DeviceAttribute::MaxThreadsPerBlock).unwrap()); /// # Ok(()) /// # } /// ``` pub fn get_attribute(self, attr: DeviceAttribute) -> CudaResult<i32> { unsafe { let mut val = 0i32; cuDeviceGetAttribute( &mut val as *mut i32, // This should be safe, as the repr and values of DeviceAttribute should match. ::std::mem::transmute(attr), self.device, ) .to_result()?; Ok(val) } } pub(crate) fn into_inner(self) -> CUdevice { self.device } } /// Iterator over all available CUDA devices. See /// [the Device::devices function](./struct.Device.html#method.devices) for more information. #[derive(Debug, Clone)] pub struct Devices { range: Range<u32>, } impl Iterator for Devices { type Item = CudaResult<Device>; fn next(&mut self) -> Option<CudaResult<Device>> { self.range.next().map(Device::get_device) } } #[cfg(test)] mod test { use super::*; use std::error::Error; fn test_init() -> Result<(), Box<dyn Error>> { crate::init(crate::CudaFlags::empty())?; Ok(()) } #[test] fn test_num_devices() -> Result<(), Box<dyn Error>> { test_init()?; let num_devices = Device::num_devices()?; assert!(num_devices > 0); Ok(()) } #[test] fn test_devices() -> Result<(), Box<dyn Error>> { test_init()?; let num_devices = Device::num_devices()?; let all_devices: CudaResult<Vec<_>> = Device::devices()?.collect(); let all_devices = all_devices?; assert_eq!(num_devices as usize, all_devices.len()); Ok(()) } #[test] fn test_get_name() -> Result<(), Box<dyn Error>> { test_init()?; let device_name = Device::get_device(0)?.name()?; println!("{}", device_name); assert!(device_name.len() < 127); Ok(()) } #[test] fn test_get_memory() -> Result<(), Box<dyn Error>> { test_init()?; let memory = Device::get_device(0)?.total_memory()?; println!("{}", memory); Ok(()) } // Ensure that the two enums always stay aligned. #[test] fn test_enums_align() { assert_eq!( DeviceAttribute::__NonExhaustive as u32, CUdevice_attribute_enum::CU_DEVICE_ATTRIBUTE_MAX as u32 ); } }