NVIDIA CUDA Compute Unified Device Architecture

Reference Manual

Version 2.0
June 2008

Contents
1 RuntimeApiReference 1.1 DeviceManagement RT 1.1.1 1.1.2 1.1.3 1.1.4 1.1.5 1.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 3 4 5 6 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

cudaGetDeviceCount

cudaSetDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaGetDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaGetDeviceProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaChooseDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ThreadManagement RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.1 1.2.2 cudaThreadSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaThreadExit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.3

StreamManagement RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3.1 1.3.2 1.3.3 1.3.4 cudaStreamCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaStreamQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaStreamSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaStreamDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.4

EventManagement RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.4.1 1.4.2 1.4.3 1.4.4 1.4.5 1.4.6 cudaEventCreate cudaEventRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaEventQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaEventSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaEventDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaEventElapsedTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5

MemoryManagement RT 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.5.6 1.5.7 1.5.8 1.5.9

cudaMalloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaMallocPitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaFree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaMallocArray

cudaFreeArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaMallocHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaFreeHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaMemset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaMemset2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

i

1.5.10 cudaMemcpy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.11 cudaMemcpy2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34 35 36 37 38 39 40 41 42 43 44 45 46 48 50 52 54 55 63 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

1.5.12 cudaMemcpyToArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.13 cudaMemcpy2DToArray 1.5.14 cudaMemcpyFromArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5.15 cudaMemcpy2DFromArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.16 cudaMemcpyArrayToArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.17 cudaMemcpy2DArrayToArray 1.5.18 cudaMemcpyToSymbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5.19 cudaMemcpyFromSymbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.20 cudaGetSymbolAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.21 cudaGetSymbolSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.22 cudaMalloc3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.23 cudaMalloc3DArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.5.24 cudaMemset3D 1.5.25 cudaMemcpy3D 1.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

TextureReferenceManagement RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.6.1 1.6.2 LowLevelApi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HighLevelApi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.7

ExecutionControl RT 1.7.1 1.7.2 1.7.3

cudaConfigureCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaLaunch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaSetupArgument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.8

OpenGlInteroperability RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.8.1 1.8.2 1.8.3 1.8.4 1.8.5 cudaGLSetGLDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaGLRegisterBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaGLMapBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaGLUnmapBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaGLUnregisterBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.9

Direct3dInteroperability RT 1.9.1 1.9.2 1.9.3 1.9.4 cudaD3D9GetDevice

cudaD3D9SetDirect3DDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaD3D9GetDirect3DDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaD3D9RegisterResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii

1.9.5 1.9.6 1.9.7 1.9.8 1.9.9

cudaD3D9UnregisterResource cudaD3D9MapResources

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84 85 86 87 89 90 91 92 94 95 97 98 99

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

cudaD3D9UnmapResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaD3D9ResourceSetMapFlags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cudaD3D9ResourceGetSurfaceDimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.9.10 cudaD3D9ResourceGetMappedPointer 1.9.11 cudaD3D9ResourceGetMappedSize

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.9.12 cudaD3D9ResourceGetMappedPitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.10 ErrorHandling RT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.10.1 cudaGetLastError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.10.2 cudaGetErrorString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 DriverApiReference 2.1 Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.1 2.2

cuInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

DeviceManagement 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7

cuDeviceComputeCapability

cuDeviceGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 cuDeviceGetAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 cuDeviceGetCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 cuDeviceGetName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 cuDeviceGetProperties cuDeviceTotalMem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

2.3

ContextManagement 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

cuCtxAttach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 cuCtxCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 cuCtxDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

cuCtxDetach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 cuCtxGetDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 cuCtxPopCurrent cuCtxPushCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

cuCtxSynchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

2.4

ModuleManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 2.4.1 cuModuleGetFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

iii

. . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 2. . . . . . . . . . . . . . . . .7. . . . . .7 2. . . . .4 2. . . . . . . . . . . . . . . . 154 . . . . . . . . . . . .6 EventManagement . . .8. . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . .3 2. . 143 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8. . . . . . .7. . . . . . . 150 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 2. . . . . . . . . . . . . .1 2. . . . . . . . . . . . . . . 129 2. . . . . . . . . .5 2. . . . . . . 125 cuModuleLoadData . . .7. . . . . .9 cuLaunch . . . . . . . . . . . . 138 cuEventRecord .6. . . . . .4 cuStreamCreate cuStreamDestroy cuStreamQuery . . . . .1 2. .5 . . . . . . . . . . . . 147 cuParamSetv . . . . . . . . .3 2. . . . . . . . . . . . . . . . . . .7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 2. . .8 MemoryManagement 2. . . . . . . . . . .5 2. . . . . . . . . . . . . .3 2. . .5. . . . . . . . . . . .5. . . . . . . . . . 142 cuLaunchGrid cuParamSetSize . . . . 149 cuFuncSetSharedSize . . . . . . . . . . . . . . . . . . 137 cuEventElapsedTime cuEventQuery . . . . . . . .5 cuModuleGetGlobal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . .7. . . . . . . . . . . . . . .4 2.5. . . . . . . . . . . . . .4 2. . . .7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6. . . . . . . . . . . . .8. . . . . . . . . . . . . .6 2. . . . . . . . . . . . . . . . 136 . .6. . . . . . . . . .2 2. . . .7 2. . . . . 124 cuModuleLoad . . . . . . . 135 cuEventDestroy . . . . . . . . 133 cuStreamSynchronize 2. . .4. . . . . . . . . . . . . . . . . . . . .6 2. . . . . 156 cuArrayGetDescriptor . . . . . . . . . . . . . 128 StreamManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 . . . . 139 cuEventSynchronize . . . .5 2. . . . . .3 2. . 130 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 cuParamSetTexRef cuParamSetf . . . . . . . . . . . . . . . . . . . . . .4.2. . . . . . . . . . . . . . . .1 2.6. .6. . .7. . . 148 cuFuncSetBlockShape . . 158 iv . . . . . .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 . . . . . . . . . .7. . . . . . . . . . . 141 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 2. . . . . . . . . . . . . . . . . . . . . . . . . . . .1 2. . . . . . . .2 2. . . . . . . . . . . . . .7. 152 cuArray3DCreate cuArrayDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 cuParamSeti . . . . . . . . . 123 cuModuleGetTexRef . . . . . . 151 cuArrayCreate . . . . . . . . . . .6 cuEventCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5. . . . . . .8 2. . . . . 131 . . . . . . . . . . . . . . . . . . . . . . . . .2 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 . . . . . . . . . . . . 157 cuArray3DGetDescriptor . . . . . . . . . . . . . . . . . . .4 2. .6. . . . . . . . . . . . 127 cuModuleUnload . . . .8. .7 ExecutionControl 2. . . . . . . . . . .8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 cuModuleLoadFatBinary . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 2. . . . . . . . 177 2. . . . . . . . . . . .9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 . . . . . . . . . . . . . . 165 2. . . . . . . .11 cuMemGetAddressRange . 163 2. . . . . .2. . . . . 159 . . . 192 . . . . . . . . . .8. . . . . . . . . . . . . .10 cuMemFreeHost . . . . . . . . . .9 cuMemAlloc . . . . .20 cuMemcpyDtoH . . . . . . . . . . . . . . . . . . . . . .9 TextureReferenceManagement 2. . . . . . . . . . .14 cuMemcpy3D .9.19 cuMemcpyDtoD . . . . . . . . . . . . . . . . . . . 185 . .8. . . . 161 cuMemAllocHost cuMemAllocPitch cuMemFree . . . .8 2. . . . . . . . . . . .4 2. . . .8. . 193 2. . . . . . . . . . . . . . . . . . . . . . .9. . . . . . . . . . . . .10 cuTexRefSetAddressMode 2. . . . . . . .8. 189 cuTexRefGetFilterMode cuTexRefGetFlags . . . . . . . . . . . . . . . . . . .9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 . . . . . . . . . . . . . . . . . . . . . . . . .8. .8. . . . . . 190 cuTexRefGetFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8. . . . . . . . . . .8. . . . . . . . . . .6 2. . . . . . . . . . . . . . . . . . . 187 cuTexRefGetAddress cuTexRefGetAddressMode cuTexRefGetArray . . . . . . . . . . . . . . . . . . . . . . . . .11 cuTexRefSetArray . . . . . . . . . . . . . .9. . 179 2. . . . . . . . 181 2. . . . . . . .9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 2. . . . . 160 . . .8 2. . . . . . . . . . . . . . . . . . . . . . . . . . . .13 cuTexRefSetFlags . . . . . . . . . . . . . . . . . . . . . . . 184 . . . . . . . . . . . . . . 164 2.24 cuMemset2D . . . . . . . . . . . 178 2.5 2. . . . . . . . . . . . . . . . . . .16 cuMemcpyAtoD . . . . .17 cuMemcpyAtoH . . . . . . . . . . . . . . . . . .9. . . . . . . . . . . . . . . .3 2. . . . . . . . . . . . . . . . . . . . . . . . . 196 2. 174 2. . . . . . . . . . . 183 . . . . .21 cuMemcpyHtoA . . . . . . . . . . . . . . . . . . . . . . . . . . .9. . . . . . . . . . . . . . . . . . . . . .18 cuMemcpyDtoA . .8. . .9. . . . . . .14 cuTexRefSetFormat . 194 2.15 cuMemcpyAtoA . . . . . . . . . . . . . . . . .7 2. . . . . . . . . . . . . . . . . . . . . . . . .8. . . . . . . . . . . .13 cuMemcpy2D 2. . . . . . . . . . . . . . . . . . . . . . . .8. . . . . . . . . . . . . .7 2. . . . . . . . . . . . . .8.8. . . . . . . . . . . . . . . . . . .6 2. . . . . . . . . . . . . . . . . . . . . . . . 176 2. . . . .9. . . .9 cuTexRefCreate cuTexRefDestroy . . . . . . . . . 197 v . . . . . . . . . . . . . . . . .9. . . . . . . . .12 cuMemGetInfo . . . . 170 2. . . . . . . . .9. . . . . . . . . 166 2. . .12 cuTexRefSetFilterMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8. . . .8. . 182 2. . . . . .22 cuMemcpyHtoD . . 191 cuTexRefSetAddress . . . . . . . . . . . . . . . . . . . .8. . 195 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 2.23 cuMemset . . . . .8. . . .8. . . . .8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 . . . . . . . . . .9. . . . . . . . . . . . . . .9. . . . . . . . . . . . . . . . .2 2. . .

234 vi . . . . . . . . . . . . . 217 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 cuD3D9MapResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . .1. .11. . . . . 232 3. . . . . . 216 2.4 cuGLRegisterBufferObject 2. . . . . . . . . . .5 3. . . . . . . . . . . . . . . .2 atomicAnd . . . . . . . . . . . . . . . . .1 cuD3D9GetDevice . . . . . . . . . .10. .9 cuD3D9ResourceGetSurfaceDimensions . . . . . . 214 2. . . . . . . . . . . . . . . . . . . 209 2. . . . 219 2. . . . . . . 228 atomicInc . . . . 200 2. . . . . . .6 3. . . . . . . . . . . . . . . .12 cuD3D9ResourceGetMappedPitch .11. . . 230 atomicCAS . .4 cuD3D9RegisterResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1. . . . . . . . . . . 233 atomicOr . . . . . . . . . .1 cuGLCtxCreate . . . . . 202 2. . . . . . . . . . . . . . . . . . . . . . 207 2. . . . . . . . . . . . . . . .11 Direct3dInteroperability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 2. . . . . . .11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 cuD3D9ResourceGetMappedPointer . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 2. . . . . . . . . . . .1. . . . . . . . . . . . . .7 3. . . . . . . . . . . .2 BitwiseFunctions . . . . . .1 3.11 cuD3D9ResourceGetMappedSize . .1. . . . .11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1. . . . . . . . . . . 224 atomicSub atomicExch atomicMin . . . . . . . . . . . . . . . . . . . . . . . .8 atomicAdd . . . . . . . .2 cuD3D9CtxCreate . . . . . .8 cuD3D9ResourceSetMapFlags . . . . . . . . . . .11. . . . .3 cuD3D9GetDirect3DDevice . . . . . .1. . . . . . . . . 226 . . . . . . . . .6 cuGLUnregisterBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 2. . . . .11. . . . . . . . . . . . . . 213 2. . . . . . . . 225 .10. . . . . . . . . . . . . . . . . .10. . . . . . . . . . . . . . . . . . . . . . . . . . . 223 3. . . . . . . . . . . . . . .11. . . . . . . . . . . . . 205 2. . . . . . . . . . . . . . . . . . . . . . .5 cuD3D9UnregisterResource . .3 cuGLMapBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 2. . . .2 3. . . . . . . 227 atomicMax . . . . . . . . . . . . . . . . . . . . . . . . .1 222 ArithmeticFunctions . . . . . . . . . . . . . . . . . . . . . . . .10 OpenGlInteroperability . . . . . . .4 3. . . . . . . . . . 220 3 AtomicFunctions 3. . . . . . . . . . . . . . . . . . . . . .11. . . . . . . . . . . . . . . . 199 2. . . . . . . . . . . . 206 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1. . . . . . . . . . . . .7 cuD3D9UnmapResources . . . . . . . . .10. . . .10. 208 2. . . . . . . . . . . . . 231 3. . . .10. . . . . . . . .3 3. . . .11. . . . . .2. . . 204 2. . . . . . . . . . . . . . . . . . . . . . . . . . . .11. . . . . . . . 201 . . . . .5 cuGLUnmapBufferObject . . . . . . . . . . . . . . . . . . . . . . . . . .2 cuGLInit . 229 atomicDec . . . . . . . . .1. . . . .1 3. . . . . . .11. . . . . . .

. . . 235 vii . . . . . . . . . . . . . . . . . . . . . . . . . . .2. .3 atomicXor .3. . . . . . . . . . . .

SEE ALSO Device Management. The high-level API (cuda_runtime. using overloading. Texture Reference Management. and device functions. The low-level API (cuda_runtime_api. These wrappers require the use of nvcc because they depend on code being generated by the compiler. Error Handling 1 .h) is a C-style interface that does not require compiling with nvcc. Event Management. It wraps some of the low level API routines. Stream Management. Execution Management. These wrappers can be used from C++ code and can be compiled with any C++ compiler.h) is a C++-style interface built on top of the low-level API. Thread Management. For example. Direct3D Interoperability. references and default arguments. OpenGL Interoperability. Memory Management. The high-level API also has some CUDA-specific wrappers that wrap low-level routines that deal with symbols.1 RuntimeApiReference NAME Runtime API Reference DESCRIPTION There are two levels for the runtime API. textures. the execution configuration syntax to invoke kernels is only available in source code compiled with nvcc.

Execution Management. Stream Management. Thread Management. Texture Reference Management. Memory Management. Direct3D Interoperability. Error Handling 2 . OpenGL Interoperability. Event Management. cudaGetDeviceCount cudaSetDevice cudaGetDevice cudaGetDeviceProperties cudaChooseDevice SEE ALSO Device Management.1 DeviceManagement RT NAME Device Management DESCRIPTION This section describes the CUDA runtime application programming interface.1.

cudaGetDeviceCount() returns 1 and device 0 only supports device emulation mode. asynchronous launches. this device will report major and minor compute capability versions of 9999.1 cudaGetDeviceCount NAME cudaGetDeviceCount . Since this device will be able to emulate all hardware features.1. cudaSetDevice.returns the number of compute-capable devices SYNOPSIS cudaError_t cudaGetDeviceCount( int* count ) DESCRIPTION Returns in *count the number of devices with compute capability greater or equal to 1.1. cudaChooseDevice 3 . RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous.0 that are available for execution. cudaGetDeviceProperties. If there is no such device. SEE ALSO cudaGetDevice.

sets device to be used for GPU executions SYNOPSIS cudaError_t cudaSetDevice( int dev ) DESCRIPTION Records dev as the device on which the active host thread executes the device code.1. cudaChooseDevice 4 .1. cudaGetDeviceProperties. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous. cudaGetDevice. SEE ALSO cudaGetDeviceCount.2 cudaSetDevice NAME cudaSetDevice . asynchronous launches.

returns which device is currently being used SYNOPSIS cudaError_t cudaGetDevice( int* dev ) DESCRIPTION Returns in *dev the device on which the active host thread executes the device code. cudaGetDeviceProperties. SEE ALSO cudaGetDeviceCount. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous.1. cudaChooseDevice 5 . asynchronous launches.1. cudaSetDevice.3 cudaGetDevice NAME cudaGetDevice .

int multiProcessorCount.4 cudaGetDeviceProperties NAME cudaGetDeviceProperties . int maxThreadsDim[3].returns information on the compute-device SYNOPSIS cudaError_t cudaGetDeviceProperties( struct cudaDeviceProp* prop. this number is shared by all thread blocks simultaneously resident on a multiprocessor. int clockRate. int maxThreadsPerBlock. size_t totalConstMem. this amount is shared by all thread blocks simultaneously resident on a multiprocessor. int dev ) DESCRIPTION Returns in *prop the properties of device dev.1. size_t sharedMemPerBlock. regsPerBlock is the maximum number of 32-bit registers available to a thread block. sharedMemPerBlock is the maximum amount of shared memory available to a thread block in bytes. size_t totalGlobalMem. The cudaDeviceProp structure is defined as: struct cudaDeviceProp { char name[256].1. int major. } where: name is an ASCII string identifying the device. int warpSize. int maxGridSize[3]. int regsPerBlock. int deviceOverlap. size_t memPitch. int minor. totalGlobalMem is the total amount of global memory available on the device in bytes. 6 . warpSize is the warp size in threads. size_t textureAlignment.

texture base addresses that are aligned to textureAlignment bytes do not need an offset applied to texture fetches. cudaSetDevice. textureAlignment is the alignment requirement. deviceOverlap is 1 if the device can concurrently copy memory between host and device while executing a kernel. maxThreadsPerBlock is the maximum number of threads per block. maxGridSize[3] is the maximum sizes of each dimension of a grid. cudaGetDevice. clockRate is the clock frequency in kilohertz. SEE ALSO cudaGetDeviceCount. multiProcessorCount is the number of multiprocessors on the device. totalConstMem is the total amount of constant memory available on the device in bytes. minor are the major and minor revision numbers defining the device’s compute capability. major.memPitch is the maximum pitch in bytes allowed by the memory copy functions that involve memory regions allocated through cudaMallocPitch(). maxThreadsDim[3] is the maximum sizes of each dimension of a block. asynchronous launches. cudaChooseDevice 7 . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous. or 0 if not.

const struct cudaDeviceProp* prop ) DESCRIPTION Returns in *dev the device which properties best match *prop. asynchronous launches. cudaGetDevice. cudaSetDevice.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue Note that this function may also return error codes from previous.5 cudaChooseDevice NAME cudaChooseDevice .select compute-device which best matches criteria SYNOPSIS cudaError_t cudaChooseDevice( int* dev.1. SEE ALSO cudaGetDeviceCount. cudaGetDeviceProperties 8 .

OpenGL Interoperability. Error Handling 9 . Direct3D Interoperability. cudaThreadSynchronize cudaThreadExit SEE ALSO Device Management. Stream Management. Thread Management.2 ThreadManagement RT NAME Thread Management DESCRIPTION This section describes the CUDA runtime application programming interface. Memory Management. Execution Management. Event Management.1. Texture Reference Management.

SEE ALSO cudaThreadExit 10 .wait for compute-device to finish SYNOPSIS cudaError_t cudaThreadSynchronize(void) DESCRIPTION Blocks until the device has completed all preceding requested tasks.1.1 cudaThreadSynchronize NAME cudaThreadSynchronize .2. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. cudaThreadSynchronize() returns an error if one of the preceding tasks failed. asynchronous launches.

2.1.2 cudaThreadExit NAME cudaThreadExit . SEE ALSO cudaThreadSynchronize 11 . asynchronous launches. cudaThreadExit() is implicitly called on host thread exit. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous.exit and clean-up from CUDA launches SYNOPSIS cudaError_t cudaThreadExit(void) DESCRIPTION Explicitly cleans up all runtime-related resources associated with the calling host thread. Any subsequent API call reinitializes the runtime.

Stream Management. Error Handling 12 . Execution Management. Direct3D Interoperability. OpenGL Interoperability. Texture Reference Management. cudaStreamCreate cudaStreamQuery cudaStreamSynchronize cudaStreamDestroy SEE ALSO Device Management.3 StreamManagement RT NAME Stream Management DESCRIPTION This section describes the CUDA runtime application programming interface. Thread Management. Event Management. Memory Management.1.

asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue Note that this function may also return error codes from previous. cudaStreamSynchronize. SEE ALSO cudaStreamQuery.1 cudaStreamCreate NAME cudaStreamCreate .3.1. cudaStreamDestroy 13 .create an async stream SYNOPSIS cudaError_t cudaStreamCreate( cudaStream_t* stream ) DESCRIPTION Creates a stream.

cudaStreamSynchronize 14 . asynchronous launches.3.queries a stream for completion-status SYNOPSIS cudaError_t cudaStreamQuery(cudaStream_t stream) DESCRIPTION Returns cudaSuccess if all operations in the stream have completed.1. or cudaErrorNotReady if not.2 cudaStreamQuery NAME cudaStreamQuery . RETURN VALUE Relevant return values: cudaSuccess cudaErrorNotReady cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous. cudaStreamDestroy. SEE ALSO cudaStreamCreate.

1. SEE ALSO cudaStreamCreate. asynchronous launches.waits for stream tasks to complete SYNOPSIS cudaError_t cudaStreamSynchronize( cudaStream_t stream ) DESCRIPTION Blocks until the device has completed all operations in the stream. cudaStreamQuery 15 .3.3 cudaStreamSynchronize NAME cudaStreamSynchronize . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous. cudaStreamDestroy.

asynchronous launches. cudaStreamDestroy 16 . cudaStreamSychronize.1.4 cudaStreamDestroy NAME cudaStreamDestroy .destroys and cleans-up a stream object SYNOPSIS cudaError_t cudaStreamDestroy( cudaStream_t stream ) DESCRIPTION Destroys a stream object. SEE ALSO cudaStreamCreate.3. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.

Error Handling 17 .4 EventManagement RT NAME Event Management DESCRIPTION This section describes the CUDA runtime application programming interface. Event Management. Execution Management. Stream Management. Texture Reference Management. OpenGL Interoperability.1. Direct3D Interoperability. Memory Management. Thread Management. cudaEventCreate cudaEventRecord cudaEventQuery cudaEventSynchronize cudaEventDestroy cudaEventElapsedTime SEE ALSO Device Management.

cudaEventSynchronzie. cudaEventDestroy.1 cudaEventCreate NAME cudaEventCreate . asynchronous launches. SEE ALSO cudaEventRecord. cudaEventElapsedTime 18 . cudaEventQuery.4. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue cudaErrorMemoryAllocation Note that this function may also return error codes from previous.creates an event-object SYNOPSIS cudaError_t cudaEventCreate( cudaEvent_t* event ) DESCRIPTION Creates an event object.1.

SEE ALSO cudaEventCreate. this function returns cudaErrorInvalidValue. Since this operation is asynchronous. If cudaEventRecord() has previously been called and the event has not been recorded yet. cudaEventSynchronize. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous. asynchronous launches. it is recorded after all preceding operations in the CUDA context have been completed.records an event SYNOPSIS cudaError_t cudaEventRecord( cudaEvent_t event. If stream is non-zero. cudaEventQuery() and/or cudaEventSynchronize() must be used to determine when the event has actually been recorded. cudaEventDestroy.2 cudaEventRecord NAME cudaEventRecord . cudaEventQuery.1. CUstream stream ) DESCRIPTION Records an event.4. cudaEventElapsedTime 19 . otherwise. the event is recorded after all preceding operations in the stream have been completed.

the function returns cudaErrorInvalidValue.3 cudaEventQuery NAME cudaEventQuery . cudaEventRecord. cudaEventElapsedTime 20 .query if an event has been recorded SYNOPSIS cudaError_t cudaEventQuery( cudaEvent_t event ) DESCRIPTION Returns cudaSuccess if the event has actually been recorded. asynchronous launches. If cudaEventRecord() has not been called on this event.1. cudaEventDestroy.4. cudaEventSynchronize. SEE ALSO cudaEventCreate. RETURN VALUE Relevant return values: cudaSuccess cudaErrorNotReady cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous. or cudaErrorNotReady if not.

RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous. If cudaEventRecord() has not been called on this event. the function returns cudaErrorInvalidValue. asynchronous launches.4 cudaEventSynchronize NAME cudaEventSynchronize . cudaEventQuery.wait for an event to be recorded SYNOPSIS cudaError_t cudaEventSynchronize( cudaEvent_t event ) DESCRIPTION Blocks until the event has actually been recorded.1. SEE ALSO cudaEventCreate.4. cudaEventRecord. cudaEventElapsedTime 21 . cudaEventDestroy.

1.4. asynchronous launches.5 cudaEventDestroy NAME cudaEventDestroy . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue Note that this function may also return error codes from previous. cudaEventQuery. cudaEventSynchronize. SEE ALSO cudaEventCreate.destroys an event-object SYNOPSIS cudaError_t cudaEventDestroy( cudaEvent_t event ) DESCRIPTION Destroys the event-object. cudaEventElapsedTime 22 . cudaEventRecord.

cudaEventSynchronize. DESCRIPTION Computes the elapsed time between two events (in milliseconds with a resolution of around 0.6 cudaEventElapsedTime NAME cudaEventElapsedTime .4. cudaEventQuery.computes the elapsed time between events SYNOPSIS cudaError_t cudaEventElapsedTime( float* time. asynchronous launches. If either event has been recorded with a non-zero stream. cudaEventRecord 23 . the result is undefined. cudaEventDestroy. If either event has not been recorded yet. cudaEvent_t start. this function returns cudaErrorInvalidValue. SEE ALSO cudaEventCreate.1. cudaEvent_t end ). RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInitializationError cudaErrorPriorLaunchFailure cudaErrorInvalidValue cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.5 microseconds).

Memory Management.5 MemoryManagement RT NAME Memory Management DESCRIPTION This section describes the CUDA runtime application programming interface.1. cudaMalloc cudaMallocPitch cudaFree cudaMallocArray cudaFreeArray cudaMallocHost cudaFreeHost cudaMemset cudaMemset2D cudaMemcpy cudaMemcpy2D cudaMemcpyToArray cudaMemcpy2DToArray cudaMemcpyFromArray cudaMemcpy2DFromArray cudaMemcpyArrayToArray cudaMemcpy2DArrayToArray cudaMemcpyToSymbol cudaMemcpyFromSymbol cudaGetSymbolAddress cudaGetSymbolSize SEE ALSO Device Management. Thread Management. Error Handling 24 . Texture Reference Management. Execution Management. Event Management. Stream Management. OpenGL Interoperability. Direct3D Interoperability.

1 cudaMalloc NAME cudaMalloc .allocate memory on the GPU SYNOPSIS cudaError_t cudaMalloc( void** devPtr. The memory is not cleared. size_t count ) DESCRIPTION Allocates count bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. cudaFree. SEE ALSO cudaMallocPitch. cudaFreeArray.1.5. cudaFreeHost 25 . asynchronous launches. cudaMalloc() returns cudaErrorMemoryAllocation in case of failure. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. cudaMallocHost. cudaMallocArray. The allocated memory is suitably aligned for any kind of variable.

the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column. size_t widthInBytes.1. this is especially true if the application will be performing 2D memory copies between different regions of device memory (whether linear memory or CUDA arrays). The intended usage of pitch is as a separate parameter of the allocation. size_t height ) DESCRIPTION Allocates at least widthInBytes*height bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory.2 cudaMallocPitch NAME cudaMallocPitch . cudaFreeArray.5. For allocations of 2D arrays. used to compute addresses within the 2D array. Due to pitch alignment restrictions in the hardware. cudaMallocHost.allocates memory on the GPU SYNOPSIS cudaError_t cudaMallocPitch( void** devPtr. Given the row and column of an array element of type T. cudaFreeHost 26 . asynchronous launches. cudaMallocArray. The function may pad the allocation to ensure that corresponding pointers in any given row will continue to meet the alignment requirements for coalescing as the address is updated from row to row. The pitch returned in *pitch by cudaMallocPitch() is the width in bytes of the allocation. size_t* pitch. cudaFree. SEE ALSO cudaMalloc. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. it is recommended that programmers consider performing pitch allocations using cudaMallocPitch().

cudaFreeArray. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevicePointer cudaErrorInitializationError Note that this function may also return error codes from previous. If devPtr is 0. an error is returned. which must have been returned by a previous call to cudaMalloc() or cudaMallocPitch().5.3 cudaFree NAME cudaFree . Otherwise. or if cudaFree(devPtr) has already been called before. cudaMallocArray. cudaFree() returns cudaErrorInvalidDevicePointer in case of failure. cudaMallocHost. cudaFreeHost 27 .frees memory on the GPU SYNOPSIS cudaError_t cudaFree(void* devPtr) DESCRIPTION Frees the memory space pointed to by devPtr. cudaMallocPitch. asynchronous launches. no operation is performed.1. SEE ALSO cudaMalloc.

5. cudaChannelFormatKindFloat.allocate an array on the GPU SYNOPSIS cudaError_t cudaMallocArray( struct cudaArray** array.1.4 cudaMallocArray NAME cudaMallocArray . cudaFree. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. size_t width. z. cudaFreeHost 28 . }. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. cudaMallocPitch. asynchronous launches. y. cudaFreeArray. cudaChannelFormatKindUnsigned. enum cudaChannelFormatKind f. cudaMallocHost. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. const struct cudaChannelFormatDesc* desc. size_t height ) DESCRIPTION Allocates a CUDA array according to the cudaChannelFormatDesc structure desc and returns a handle to the new CUDA array in *array. SEE ALSO cudaMalloc. w.

RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError Note that this function may also return error codes from previous. If array is 0. SEE ALSO cudaMalloc. cudaMallocPitch. no operation is performed.5. cudaMallocHost. cudaFree.1. cudaFreeHost 29 . asynchronous launches.5 cudaFreeArray NAME cudaFreeArray .frees an array on the GPU SYNOPSIS cudaError_t cudaFreeArray( struct cudaArray* array ) DESCRIPTION Frees the CUDA array array. cudaMallocArray.

6 cudaMallocHost NAME cudaMallocHost . since it reduces the amount of memory available to the system for paging.1.allocates page-locked memory on the host SYNOPSIS cudaError_t cudaMallocHost( void** hostPtr. this function is best used sparingly to allocate staging areas for data exchange between host and device. cudaFreeHost 30 . The driver tracks the virtual memory ranges allocated with this function and automatically accelerates calls to functions such as cudaMemcpy*(). size_t size ) DESCRIPTION Allocates size bytes of host memory that is page-locked and accessible to the device. cudaMallocPitch. cudaFree. Allocating excessive amounts of memory with cudaMallocHost() may degrade system performance. cudaMallocArray. asynchronous launches. Since the memory can be accessed directly by the device.5. As a result. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. cudaFreeArray. it can be read or written with much higher bandwidth than pageable memory obtained with functions such as malloc(). SEE ALSO cudaMalloc.

7 cudaFreeHost NAME cudaFreeHost . which must have been returned by a previous call to cudaMallocHost(). cudaMallocArray. cudaFree. SEE ALSO cudaMalloc. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError Note that this function may also return error codes from previous. cudaMallocHost 31 . cudaFreeArray.frees page-locked memory SYNOPSIS cudaError_t cudaFreeHost( void* hostPtr ) DESCRIPTION Frees the memory space pointed to by hostPtr.1. asynchronous launches.5. cudaMallocPitch.

8 cudaMemset NAME cudaMemset . int value.initializes or sets GPU memory to a value SYNOPSIS cudaError_t cudaMemset( void* devPtr.5. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer Note that this function may also return error codes from previous. SEE ALSO cudaMemset2D. cudaMemset3D 32 . asynchronous launches.1. size_t count ) DESCRIPTION Fills the first count bytes of the memory area pointed to by devPtr with the constant byte value value.

including any padding added to the end of each row.initializes or sets GPU memory to a value SYNOPSIS cudaError_t cudaMemset2D( void* dstPtr. SEE ALSO cudaMemset. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer Note that this function may also return error codes from previous. pitch is the width in memory in bytes of the 2D array pointed to by dstPtr. This function performs fastest when the pitch is one that has been passed back by cudaMallocPitch().9 cudaMemset2D NAME cudaMemset2D . int value. size_t width. asynchronous launches. size_t height ) DESCRIPTION Sets to the specified value value a matrix (height rows of width bytes each) pointed to by dstPtr.1. cudaMemset3D 33 . size_t pitch.5.

enum cudaMemcpyKind kind. where kind is one of cudaMemcpyHostToHost. or cudaMemcpyDeviceToDevice. const void* src. cudaMemcpyDeviceToHost.5. cudaMemcpy2DFromArray. asynchronous launches. cudaMemcpyArrayToArray.1. cudaMemcpyHostToDevice. The memory areas may not overlap. cudaMemcpyToSymbol.copies data between GPU and host SYNOPSIS cudaError_t cudaMemcpy( void* dst. and specifies the direction of the copy. cudaStream_t stream ) DESCRIPTION Copies count bytes from the memory area pointed to by src to the memory area pointed to by dst. cudaMemcpy2DToArray. const void* src. cudaMemcpyAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. size_t count. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. Calling cudaMemcpy() with dst and src pointers that do not match the direction of the copy results in an undefined behavior.10 cudaMemcpy NAME cudaMemcpy . enum cudaMemcpyKind kind ) cudaError_t cudaMemcpyAsync( void* dst. size_t count. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. cudaMemcpyFromArray. cudaMemcpyFromSymbol 34 . cudaMemcpyToArray. SEE ALSO cudaMemcpy2D. cudaMemcpy2DArrayToArray.

size_t width.11 cudaMemcpy2D NAME cudaMemcpy2D . size_t width. cudaMemcpyFromArray. cudaMemcpyToArray. cudaMemcpy2D() returns an error if dpitch or spitch is greater than the maximum allowed. or cudaMemcpyDeviceToDevice. cudaMemcpy2DToArray. cudaMemcpyFromSymbol 35 . cudaMemcpy2DAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. size_t spitch. enum cudaMemcpyKind kind. enum cudaMemcpyKind kind ) cudaError_t cudaMemcpy2DAsync( void* dst. cudaMemcpyDeviceToHost. cudaStream_t stream ) DESCRIPTION Copies a matrix (height rows of width bytes each) from the memory area pointed to by src to the memory area pointed to by dst. size_t dpitch. cudaMemcpyToSymbol. where kind is one of cudaMemcpyHostToHost.1. size_t height. const void* src. size_t dpitch. asynchronous launches. size_t spitch. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. cudaMemcpyArrayToArray. dpitch and spitch are the widths in memory in bytes of the 2D arrays pointed to by dst and src. size_t height. cudaMemcpyHostToDevice. The memory areas may not overlap. cudaMemcpy2DFromArray. including any padding added to the end of each row. Calling cudaMemcpy2D() with dst and src pointers that do not match the direction of the copy results in an undefined behavior.5. const void* src. cudaMemcpy2DArrayToArray. SEE ALSO cudaMemcpy.copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2D( void* dst. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidPitchValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. and specifies the direction of the copy.

size_t dstX. cudaMemcpyDeviceToHost. cudaMemcpyFromSymbol 36 . cudaStream_t stream) DESCRIPTION Copies count bytes from the memory area pointed to by src to the CUDA array dstArray starting at the upper left corner (dstX. size_t dstX. size_t count. cudaMemcpy2DToArray. or cudaMemcpyDeviceToDevice. where kind is one of cudaMemcpyHostToHost.5. cudaMemcpyToSymbol. cudaMemcpy2D. const void* src. cudaMemcpy2DFromArray. size_t count. asynchronous launches. enum cudaMemcpyKind kind) cudaError_t cudaMemcpyToArrayAsync(struct cudaArray* dstArray.12 cudaMemcpyToArray NAME cudaMemcpyToArray . enum cudaMemcpyKind kind. dstY). and specifies the direction of the copy. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. size_t dstY. size_t dstY. cudaMemcpyFromArray.1. cudaMemcpyArrayToArray. cudaMemcpyToArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. cudaMemcpy2DArrayToArray.copies data between host and device SYNOPSIS cudaError_t cudaMemcpyToArray(struct cudaArray* dstArray. SEE ALSO cudaMemcpy. cudaMemcpyHostToDevice. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. const void* src.

const void* src. cudaMemcpy2D() returns an error if spitch is greater than the maximum allowed. cudaError_t cudaMemcpy2DToArrayAsync(struct cudaArray* dstArray.copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2DToArray(struct cudaArray* dstArray. cudaMemcpyToArray. size_t spitch. or cudaMemcpyDeviceToDevice. cudaMemcpy2DFromArray. size_t height. enum cudaMemcpyKind kind). RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidPitchValue cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. size_t dstY. cudaStream_t stream). and specifies the direction of the copy. size_t dstY. cudaMemcpyArrayToArray. enum cudaMemcpyKind kind. size_t width. cudaMemcpyFromSymbol 37 . dstY). SEE ALSO cudaMemcpy. cudaMemcpy2DToArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. size_t dstX.13 cudaMemcpy2DToArray NAME cudaMemcpy2DToArray . spitch is the width in memory in bytes of the 2D array pointed to by src.5. cudaMemcpy2D. cudaMemcpyDeviceToHost. DESCRIPTION Copies a matrix (height rows of width bytes each) from the memory area pointed to by src to the CUDA array dstArray starting at the upper left corner (dstX. const void* src. cudaMemcpyHostToDevice. size_t width. size_t spitch.1. including any padding added to the end of each row. cudaMemcpy2DArrayToArray. size_t height. asynchronous launches. size_t dstX. cudaMemcpyToSymbol. where kind is one of cudaMemcpyHostToHost. cudaMemcpyFromArray.

cudaMemcpy2DToArray. cudaStream_t stream) DESCRIPTION Copies count bytes from the CUDA array srcArray starting at the upper left corner (srcX. asynchronous launches. cudaMemcpyToSymbol. cudaMemcpyFromSymbol 38 .5. size_t srcX. size_t count. cudaMemcpyToArray. size_t srcY. cudaMemcpy2DFromArray. enum cudaMemcpyKind kind. cudaMemcpyHostToDevice. cudaMemcpy2D. cudaMemcpyDeviceToHost. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. where kind is one of cudaMemcpyHostToHost. srcY) to the memory area pointed to by dst.1. size_t count. size_t srcY.14 cudaMemcpyFromArray NAME cudaMemcpyFromArray . or cudaMemcpyDeviceToDevice. SEE ALSO cudaMemcpy. and specifies the direction of the copy. cudaMemcpyArrayToArray. size_t srcX. cudaMemcpyFromArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input.copies data between host and device SYNOPSIS cudaError_t cudaMemcpyFromArray(void* dst. enum cudaMemcpyKind kind) cudaError_t cudaMemcpyFromArrayAsync(void* dst. const struct cudaArray* srcArray. const struct cudaArray* srcArray. cudaMemcpy2DArrayToArray.

size_t height. cudaMemcpyToSymbol. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. size_t srcY. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidPitchValue cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. cudaMemcpy2DFromArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. SEE ALSO cudaMemcpy. size_t srcX. cudaMemcpyHostToDevice. cudaMemcpyArrayToArray. cudaMemcpy2DToArray. cudaStream_t stream) DESCRIPTION Copies a matrix (height rows of width bytes each) from the CUDA array srcArray starting at the upper left corner (srcX. size_t width.1. enum cudaMemcpyKind kind.15 cudaMemcpy2DFromArray NAME cudaMemcpy2DFromArray . cudaMemcpyToArray. size_t dpitch. const struct cudaArray* srcArray. asynchronous launches. size_t srcX. const struct cudaArray* srcArray. cudaMemcpyDeviceToHost. and specifies the direction of the copy. cudaMemcpyFromArray. size_t width. cudaMemcpy2D. srcY) to the memory area pointed to by dst. or cudaMemcpyDeviceToDevice. cudaMemcpy2DArrayToArray.copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2DFromArray(void* dst. dpitch is the width in memory in bytes of the 2D array pointed to by dst. cudaMemcpyFromSymbol 39 . where kind is one of cudaMemcpyHostToHost. size_t dpitch. size_t height. including any padding added to the end of each row. enum cudaMemcpyKind kind) cudaError_t cudaMemcpy2DFromArrayAsync(void* dst. cudaMemcpy2D() returns an error if dpitch is greater than the maximum allowed.5. size_t srcY.

dstY). size_t srcY. enum cudaMemcpyKind kind) DESCRIPTION Copies count bytes from the CUDA array srcArray starting at the upper left corner (srcX. cudaMemcpy2DFromArray. cudaMemcpy2D. cudaMemcpy2DArrayToArray. or cudaMemcpyDeviceToDevice. size_t count. size_t srcX. cudaMemcpyToArray. cudaMemcpyFromSymbol 40 . cudaMemcpyDeviceToHost. size_t dstY. SEE ALSO cudaMemcpy. and specifies the direction of the copy.16 cudaMemcpyArrayToArray NAME cudaMemcpyArrayToArray . cudaMemcpyToSymbol.1. cudaMemcpy2DToArray.5. asynchronous launches. const struct cudaArray* srcArray. cudaMemcpyFromArray. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. srcY) to the CUDA array dstArray starting at the upper left corner (dstX. cudaMemcpyHostToDevice. size_t dstX. where kind is one of cudaMemcpyHostToHost.copies data between host and device SYNOPSIS cudaError_t cudaMemcpyArrayToArray(struct cudaArray* dstArray.

cudaMemcpy2DFromArray.1. cudaMemcpyHostToDevice. size_t dstY. cudaMemcpyFromSymbol 41 . size_t srcX.5.17 cudaMemcpy2DArrayToArray NAME cudaMemcpy2DArrayToArray . cudaMemcpyDeviceToHost. enum cudaMemcpyKind kind) DESCRIPTION Copies a matrix (height rows of width bytes each) from the CUDA array srcArray starting at the upper left corner (srcX. cudaMemcpyArrayToArray. where kind is one of cudaMemcpyHostToHost.copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2DArrayToArray(struct cudaArray* dstArray. size_t height. asynchronous launches. dstY). size_t width. cudaMemcpy2DToArray. or cudaMemcpyDeviceToDevice. const struct cudaArray* srcArray. SEE ALSO cudaMemcpy. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. cudaMemcpyToArray. cudaMemcpyToSymbol. cudaMemcpy2D. size_t srcY. and specifies the direction of the copy. size_t dstX. srcY) to the CUDA array dstArray starting at the upper left corner (dstX. cudaMemcpyFromArray.

5. SEE ALSO cudaMemcpy. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidSymbol cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. cudaMemcpy2D. const void* src. cudaMemcpy2DToArray. cudaMemcpy2DFromArray. or it can be a character string.1.18 cudaMemcpyToSymbol NAME cudaMemcpyToSymbol . cudaMemcpyArrayToArray. cudaMemcpy2DArrayToArray. enum cudaMemcpyKind kind) DESCRIPTION Copies count bytes from the memory area pointed to by src to the memory area pointed to by offset bytes from the start of symbol symbol. size_t count. kind can be either cudaMemcpyHostToDevice or cudaMemcpyDeviceToDevice. symbol can either be a variable that resides in global or constant memory space. cudaMemcpyToArray. size_t offset. The memory areas may not overlap. cudaMemcpyFromArray. naming a variable that resides in global or constant memory space.copies data from host memory to GPU SYNOPSIS template < class T > cudaError_t cudaMemcpyToSymbol( const T& symbol. asynchronous launches. cudaMemcpyFromSymbol 42 .

copies data from GPU to host memory SYNOPSIS template < class T > cudaError_t cudaMemcpyFromSymbol( void *dst. size_t count. symbol can either be a variable that resides in global or constant memory space. enum cudaMemcpyKind kind) DESCRIPTION Copies count bytes from the memory area pointed to by offset bytes from the start of symbol symbol to the memory area pointed to by dst.19 cudaMemcpyFromSymbol NAME cudaMemcpyFromSymbol . The memory areas may not overlap. cudaMemcpyFromArray. cudaMemcpyToArray. or it can be a character string. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidSymbol cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. kind can be either cudaMemcpyDeviceToHost or cudaMemcpyDeviceToDevice. asynchronous launches. const T& symbol. cudaMemcpyArrayToArray. SEE ALSO cudaMemcpy. cudaMemcpy2DFromArray. cudaMemcpyToSymbol 43 . size_t offset. cudaMemcpy2DArrayToArray.5. cudaMemcpy2D. naming a variable that resides in global or constant memory space. cudaMemcpy2DToArray.1.

SEE ALSO cudaGetSymbolSize 44 .finds the address associated with a CUDA symbol SYNOPSIS template < class T > cudaError_t cudaGetSymbolAddress(void** devPtr. or if symbol is not declared in global memory space.5. or it can be a character string. asynchronous launches.1.20 cudaGetSymbolAddress NAME cudaGetSymbolAddress . *devPtr is unchanged and an error is returned. If symbol cannot be found. naming a variable that resides in global memory space. const T& symbol) DESCRIPTION Returns in *devPtr the address of symbol symbol on the device. symbol can either be a variable that resides in global memory space. cudaGetSymbolAddress() returns cudaErrorInvalidSymbol in case of failure RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidSymbol cudaErrorAddressOfConstant Note that this function may also return error codes from previous.

If symbol cannot be found.1. SEE ALSO cudaGetSymbolAddress 45 . *size is unchanged and an error is returned. naming a variable that resides in global or constant memory space. const T& symbol) DESCRIPTION Returns in *size the size of symbol symbol. or if symbol is not declared in global or constant memory space. symbol can either be a variable that resides in global or constant memory space.5. or it can be a character string. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidSymbol Note that this function may also return error codes from previous. asynchronous launches.21 cudaGetSymbolSize NAME cudaGetSymbolSize . cudaGetSymbolSize() returns cudaErrorInvalidSymbol in case of failure.finds the size of the object associated with a CUDA symbol SYNOPSIS template < class T > cudaError_t cudaGetSymbolSize(size_t* size.

For allocations of 2D. size_t depth. this is especially true if the application will be performing memory copies involving 2D or 3D objects (whether linear memory or CUDA arrays). }. The returned cudaPitchedPtr contains additional fields xsize and ysize. }. struct cudaExtent { size_t width. cudaError_t cudaMalloc3D( struct cudaPitchedPtr* pitchDevPtr. struct cudaExtent extent ) DESCRIPTION Allocates at least width*height*depth bytes of linear memory on the device and returns a pitchedDevPtr in which ptr is a pointer to the allocated memory. it is highly recommended that programmers perform allocations using cudaMalloc3D() or cudaMallocPitch(). asynchronous launches. size_t ysize. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. size_t xsize.5. 2D. Due to alignment restrictions in the hardware.22 cudaMalloc3D NAME cudaMalloc3D .1. size_t height.allocates logical 1D. The pitch returned in the pitch field of the pitchedDevPtr is the width in bytes of the allocation. 3D objects. 46 . or 3D memory objects on the GPU SYNOPSIS struct cudaPitchedPtr { void *ptr. The function may pad the allocation to ensure hardware alignment requirements are met. the logical width and height of the allocation. which are equivalent to the width and height extent parameters provided by the programmer during allocation. size_t pitch.

cudaMalloc3DArray. cudaMallocArray. cudaFreeHost 47 . cudaMemset3D. cudaMemcpy3D.SEE ALSO cudaMallocPitch. cudaMallocHost. cudaFreeArray. cudaFree.

size_t depth. (1. 2048)}. • A 1D array is allocated if the height and depth extent are both zero. or 3D arrays. cudaMalloc3DArray is able to allocate 1D. 0}. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. For 1D arrays valid extents are {(1. For instance. }. 48 . z. 2048). 8192).allocate an array on the GPU SYNOPSIS struct cudaExtent { size_t width. a degenerate 2D array allows for significantly more linear storage than a 1D array. For 3D arrays valid extents are {(1. asynchronous launches. w. cudaChannelFormatKindUnsigned. 0. 65536). struct cudaExtent extent ) DESCRIPTION Allocates a CUDA array according to the cudaChannelFormatDesc structure desc and returns a handle to the new CUDA array in *arrayPtr. cudaError_t cudaMalloc3DArray( struct cudaArray** arrayPtr. 32768). size_t height. cudaChannelFormatKindFloat. Note: That because of the differing extent limits it may be advantageous to use a degenerate array (with unused dimensions set to one) of higher dimensionality.23 cudaMalloc3DArray NAME cudaMalloc3DArray . const struct cudaChannelFormatDesc* desc. (1.1. • A 2D array is allocated if only the depth extent is zero.5. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. 0} . (1. For 2D arrays valid extents are {(1. • A 3D array is allocate if all three extents are non-zero. 2048). }. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. y. enum cudaChannelFormatKind f. 2D.

SEE ALSO cudaMalloc3D. cudaFreeArray. cudaMalloc. cudaMallocPitch. cudaFreeHost 49 . cudaMallocHost. cudaFree.

The extents of the initialized region are specified as a width in bytes. cudaError_t cudaMemset3D( struct cudaPitchedPtr dstPitchPtr. asynchronous launches. size_t ysize. 50 .1. extents with height equal to the ysize of dstPitchPtr will perform faster than when the hieght is shorter than the ysize. size_t pitch. Secondarily. The object to initialize is defined by dstPitchPtr. including any padding added to the end of each row. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer Note that this function may also return error codes from previous. a height in rows. The xsize field specifies the logical width of each row in bytes. int value. and a depth in slices. struct cudaExtent { size_t width. }. This function performs fastest when the dstPitchPtr has been allocated by cudaMalloc3D(). The pitch field of dstPitchPtr is the width in memory in bytes of the 3D array pointed to by dstPitchPtr.24 cudaMemset3D NAME cudaMemset3D . }. while the ysize field specifies the height of each 2D slice in rows. size_t xsize. struct cudaExtent extent ) DESCRIPTION Initializes each element of a 3D array to the specified value value. Extents with width greater than or equal to the xsize of dstPitchPtr may perform significantly faster than extents narrower than the xsize.5.initializes or sets GPU memory to a value SYNOPSIS struct cudaPitchedPtr { void *ptr. size_t depth. size_t height.

SEE ALSO cudaMemset. cudaMalloc3D 51 . cudaMemset2D.

struct cudaMemcpy3DParms { struct cudaArray *srcArray. struct cudaPos { size_t x. The kind field defines the direction of the copy. extent. struct cudaExtent extent. depth. The srcPos and dstPos fields are optional offsets into the source and destination objects and are defined in units of each object’s elements. }.copies data between between 3D objects SYNOPSIS struct cudaExtent { size_t width. positions must be in the range [0. The struct passed to cudaMemcpy3D() must specify one of srcArray or srcPtr and one of dstArray or dstPtr.25 cudaMemcpy3D NAME cudaMemcpy3D . struct cudaPos srcPos. enum cudaMemcpyKind kind. or cudaMemcpyDeviceToDevice. cudaStream_t stream ) DESCRIPTION cudaMemcpy3D() copies data betwen two 3D objects. It must be one of cudaMemcpyHostToHost. y. z. 2048) for any dimension. struct cudaPitchedPtr dstPtr.5. If no CUDA array is participating in the copy then the extents are defined in elements of unsigned char. The source. For CUDA arrays. struct cudaPitchedPtr srcPtr. The element for a host or device pointer is assumed to be unsigned char. The source and destination objects may be in either host memory. Passing more than one non-zero source or destination will cause cudaMemcpy3D() to return an error.1. 52 . }. }. device memory. The extent field defines the dimensions of the transferred area in elements. height. or a CUDA array. destination. and kind of copy performed is specified by the cudaMemcpy3DParms struct which should be initialized to zero before use: cudaMemcpy3DParms myParms = {0}. cudaMemcpyHostToDevice. cudaMemcpyDeviceToHost. cudaError_t cudaMemcpy3D( const struct cudaMemcpy3DParms *p ) cudaError_t cudaMemcpy3DAsync( const struct cudaMemcpy3DParms *p. struct cudaPos dstPos. struct cudaArray *dstArray. If a CUDA array is participating in the copy the extent is defined in terms of that array’s elements.

cudaMemcpy2DArrayToArray. It will return an error if a pointer to memory not allocated with cudaMallocHost() is passed as input. The pitch of a cudaPitchedPtr allocated with cudaMalloc3D() will always be valid. cudaMemcpy2DFromArray.If the source and destination are both arrays cudaMemcpy3D() will return an error if they do not have the same element size. cudaMemcpy. The source and destination object may not overlap. cudaMemcpy3DAsync() is an asynchronous copy operation and can optionally be associated to a stream by passing a non-zero stream argument. cudaMemcpyToSymbol. If overlapping source and destination objects are specified undefined behavior will result. cudaMemcpyToArray. If either the source or destination is a host object it must be allocated in page-locked memory returned from cudaMallocHost(). cudaMemcpy2DToArray. cudaMemcpyArrayToArray. cudaMemset3D. cudaMemcpyFromArray. cudaMemcpyFromSymbol 53 . cudaMemcpy3D() returns an error if the pitch of srcPtr or dstPtr is greater than the maximum allowed. RETURN VALUE cudaSuccess SEE ALSO cudaMalloc3D. cudaMalloc3DArray.

Thread Management. Error Handling 54 . Direct3D Interoperability. Stream Management. Low-Level API High-Level API SEE ALSO Device Management. Execution Management. OpenGL Interoperability.1.6 TextureReferenceManagement RT NAME Texture Reference Management DESCRIPTION This section describes the CUDA runtime application programming interface. Event Management. Texture Reference Management. Memory Management.

6.1.1 LowLevelApi NAME Low-Level Texture API DESCRIPTION This section describes the low-level CUDA run-time application programming interface for textures cudaCreateChannelDesc cudaGetChannelDesc cudaGetTextureReference cudaBindTexture cudaBindTextureToArray cudaUnbindTexture cudaGetTextureAlignmentOffset SEE ALSO High-Level API 55 .

and w. cudaGetTextureReference. int z. cudaGetTextureAlignmentOffset 56 . SEE ALSO cudaGetChannelDesc. z. cudaUnbindTexture. y. asynchronous launches. z. cudaBindTextureToArray. DESCRIPTION Returns a channel descriptor with format f and number of bits of each component x.cudaCreateChannelDesc NAME cudaCreateChannelDesc . }. y. cudaChannelFormatKindFloat.Low-level texture API SYNOPSIS struct cudaChannelFormatDesc cudaCreateChannelDesc(int x. cudaChannelFormatKindUnsigned. int w. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. int y. w. enum cudaChannelFormatKind f. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. cudaBindTexture. enum cudaChannelFormatKin f).

asynchronous launches. SEE ALSO cudaCreateChannelDesc. DESCRIPTION Returns in *desc the channel descriptor of the CUDA array array.Low-level texture API SYNOPSIS cudaError_t cudaGetChannelDesc(struct cudaChannelFormatDesc* desc. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue Note that this function may also return error codes from previous. cudaBindTextureToArray. cudaGetTextureAlignmentOffset 57 . cudaGetTextureReference. const struct cudaArray* array). cudaUnbindTexture.cudaGetChannelDesc NAME cudaGetChannelDesc . cudaBindTexture.

RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidTexture Note that this function may also return error codes from previous.cudaGetTextureReference NAME cudaGetTextureReference . asynchronous launches. cudaGetTextureAlignmentOffset 58 . const char* symbol) DESCRIPTION Returns in *texRef the structure associated to the texture reference defined by symbol symbol. SEE ALSO cudaCreateChannelDesc. cudaUnbindTexture. cudaBindTextureToArray.Low-level texture API SYNOPSIS cudaError_t cudaGetTextureReference( struct textureReference** texRef. cudaGetChannelDesc. cudaBindTexture.

cudaBindTexture() returns in *offset a byte offset that must be applied to texture fetches in order to read from the desired memory. the offset is guaranteed to be 0 and NULL may be passed as the offset parameter. Since the hardware enforces an alignment requirement on texture base addresses. const void* devPtr. cudaUnbindTexture. This offset must be divided by the texel size and passed to kernels that read from the texture so they can be applied to the tex1Dfetch() function. cudaGetTextureAlignmentOffset 59 . SEE ALSO cudaCreateChannelDesc. cudaGetChannelDesc. If the device memory pointer was returned from cudaMalloc(). asynchronous launches. DESCRIPTION Binds size bytes of the memory area pointed to by devPtr to the texture reference texRef.cudaBindTexture NAME cudaBindTexture . const struct cudaChannelFormatDesc* desc. size_t size = UINT_MAX). Any memory previously bound to texRef is unbound. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous. desc describes how the memory is interpreted when fetching values from the texture. cudaGetTextureReference. cudaBindTextureToArray. const struct textureReference* texRef.Low-level texture API SYNOPSIS cudaError_t cudaBindTexture(size_t* offset.

cudaBindTexture.Low-level texture API SYNOPSIS cudaError_t cudaBindTextureToArray( const struct textureReference* texRef. desc describes how the memory is interpreted when fetching values from the texture.cudaBindTextureToArray NAME cudaBindTextureToArray . DESCRIPTION Binds the CUDA array array to the texture reference texRef. const struct cudaArray* array. const struct cudaChannelFormatDesc* desc). cudaGetTextureAlignmentOffset 60 . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous. asynchronous launches. cudaGetChannelDesc. cudaUnbindTexture. Any CUDA array previously bound to texRef is unbound. SEE ALSO cudaCreateChannelDesc. cudaGetTextureReference.

SEE ALSO cudaCreateChannelDesc. cudaGetChannelDesc. cudaGetTextureReference. asynchronous launches. cudaBindTextureToArray. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. DESCRIPTION Unbinds the texture bound to texture reference texRef. cudaBindTexture.cudaUnbindTexture NAME cudaUnbindTexture . cudaGetTextureAlignmentOffset 61 .Low-level texture API SYNOPSIS cudaError_t cudaUnbindTexture( const struct textureReference* texRef).

cudaBindTexture. cudaUnbindTexture 62 . DESCRIPTION Returns in *offset the offset that was returned when texture reference texRef was bound. asynchronous launches.Low-level texture API SYNOPSIS cudaError_t cudaGetTextureAlignmentOffset(size_t* offset. cudaGetTextureReference. SEE ALSO cudaCreateChannelDesc.cudaGetTextureAlignmentOffset NAME cudaGetTextureAlignmentOffset . cudaGetChannelDesc. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidTexture cudaErrorInvalidTextureBinding Note that this function may also return error codes from previous. const struct textureReference* texRef). cudaBindTextureToArray.

2 HighLevelApi NAME High-Level Texture API DESCRIPTION This section describes the high-level CUDA run-time application programming interface for textures cudaCreateChannelDesc cudaBindTexture cudaBindTextureToArray cudaUnbindTexture SEE ALSO Low-Level API 63 .6.1.

cudaChannelFormatKindFloat. }. asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. SEE ALSO 64 . w. DESCRIPTION Returns a channel descriptor with format f and number of bits of each component x.High-level texture API SYNOPSIS template < class T > struct cudaChannelFormatDesc cudaCreateChannelDesc <T >(). The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. enum cudaChannelFormatKind f. y.cudaCreateChannelDesc HL NAME cudaCreateChannelDesc . z. cudaChannelFormatKindUnsigned. z. y. and w.

int dim. Any memory previously bound to texRef is unbound. readMode E<gt>& texRef. SEE ALSO 65 .cudaBindTexture HL NAME cudaBindTexture . const void* devPtr. const struct cudaChannelFormatDesc& desc. The offset parameter is an optional byte offset as with the low-level cudaBindTexture() function. const void* devPtr. asynchronous launches. readMode >& texRef. size_t size = UINT_MAX) DESCRIPTION Binds size bytes of the memory area pointed to by devPtr to texture reference texRef. desc describes how the memory is interpreted when fetching values from the texture. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaBindTexture(size_t* offset. The offset parameter is an optional byte offset as with the lowlevel cudaBindTexture() function described RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous.High-level texture API SYNOPSIS template < class T. The channel descriptor is inherited from the texture reference type. binds size bytes of the memory area pointed to by devPtr to texture reference texRef. int dim. const struct texture < T. dim. enum cudaTextureReadMode readMode E<gt> static __inline__ __host__ cudaError_t cudaBindTexture( size_t* offset. size_t size = UINT_MAX). dim. template E<lt> class T. const struct texture E<lt> T.

readMode >& texRef. int dim. desc describes how the memory is interpreted when fetching values from the texture. asynchronous launches. Any CUDA array previously bound to texRef is unbound.cudaBindTextureToArray HL NAME cudaBindTextureToArray . SEE ALSO cudaCreateChannelDesc_HL 66 . Any CUDA array previously bound to texRef is unbound. template E<lt> class T. binds the CUDA array array to texture reference texRef. The channel descriptor is inherited from the CUDA array. enum cudaTextureReadMode readMode E<gt> static __inline__ __host__ cudaError_t cudaBindTextureToArray( const struct texture E<lt> T. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture Note that this function may also return error codes from previous. dim.High-level texture API SYNOPSIS template < class T. dim. const struct cudaArray* cuArray. const struct cudaArray* cuArray). readMode E<gt>& texRef. const struct cudaChannelFormatDesc& desc) DESCRIPTION Binds the CUDA array array to texture reference texRef. int dim. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaBindTextureToArray( const struct texture < T.

int dim. asynchronous launches. dim. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. readMode >& texRef) DESCRIPTION Unbinds the texture bound to texture reference texRef.cudaUnbindTexture HL NAME cudaUnbindTexture . SEE ALSO 67 .High-level texture API SYNOPSIS template < class T. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaUnbindTexture(const struct texture < T.

Direct3D Interoperability.7 ExecutionControl RT NAME Execution Control DESCRIPTION This section describes the CUDA runtime application programming interface. Event Management. Stream Management. OpenGL Interoperability. Memory Management. cudaConfigureCall cudaLaunch cudaSetupArgument SEE ALSO Device Management. Texture Reference Management.1. Thread Management. Error Handling 68 . Execution Management.

asynchronous launches.7.1. int tokens = 0) DESCRIPTION Specifies the grid and block dimensions for the device call to be executed similar to the execution configuration syntax. Each call pushes data on top of an execution stack. size_t sharedMem = 0.configure a device-launch SYNOPSIS cudaError_t cudaConfigureCall(dim3 gridDim.1 cudaConfigureCall NAME cudaConfigureCall . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidConfiguration Note that this function may also return error codes from previous. cudaConfigureCall() is stack based. dim3 blockDim. This data contains the dimension for the grid and thread blocks. cudaSetupArgument 69 . together with any arguments for the call. SEE ALSO cudaLaunch.

entry can either be a function that executes on the device.1.7. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration Note that this function may also return error codes from previous.2 cudaLaunch NAME cudaLaunch . asynchronous launches.launches a device function SYNOPSIS template < class T > cudaError_t cudaLaunch(T entry) DESCRIPTION Launches the function entry on the device. or it can be a character string. entry must be declared as a __global__ function. naming a function that executes on the device. SEE ALSO cudaConfigureCall. cudaSetupArgument 70 . cudaLaunch() must be preceded by a call to cudaConfigureCall() since it pops the data that was pushed by cudaConfigureCall() from the execution stack.

which starts at offset 0. size_t offset) template < class T > cudaError_t cudaSetupArgument(T arg. cudaSetupArgument() must be preceded by a call to cudaConfigureCall().7.3 cudaSetupArgument NAME cudaSetupArgument . The arguments are stored in the top of the execution stack. size_t offset) DESCRIPTION Pushes count bytes of the argument pointed to by arg at offset bytes from the start of the parameter passing area.1. size_t count.configure a device-launch SYNOPSIS cudaError_t cudaSetupArgument(void* arg. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. SEE ALSO cudaConfigureCall. asynchronous launches. cudaLaunch 71 .

cudaGLSetGLDevice cudaGLRegisterBufferObject cudaGLMapBufferObject cudaGLUnmapBufferObject cudaGLUnregisterBufferObject SEE ALSO Device Management. Stream Management. Execution Management. OpenGL Interoperability.1. Event Management.8 OpenGlInteroperability RT NAME OpenGL Interoperability DESCRIPTION This section describes the CUDA runtime application programming interface. Error Handling 72 . Memory Management. Thread Management. Texture Reference Management. Direct3D Interoperability.

cudaGLUnmapBufferObject. DESCRIPTION Records dev as the device on which the active host thread executes the device code. cudaGLMapBufferObject. cudaGLUnregisterBufferObject 73 . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous.1 cudaGLSetGLDevice NAME cudaGLSetGLDevice . asynchronous launches. Records the thread as using GL Interopability.8.1.sets the CUDA device for use with GL Interopability SYNOPSIS cudaError_t cudaGLSetGLDevice(int device). SEE ALSO cudaGLRegisterBufferObject.

asynchronous launches.1. While it is registered. SEE ALSO cudaGLSetGLDevice. cudaGLMapBufferObject. This function must be called before CUDA can map the buffer object.8. RETURN VALUE Relevant return values: cudaSuccess cudaErrorNotInitialized Note that this function may also return error codes from previous. the buffer object cannot be used by any OpenGL commands except as a data source for OpenGL drawing commands. cudaGLUnregisterBufferObject 74 .OpenGL interoperability SYNOPSIS cudaError_t cudaGLRegisterBufferObject(GLuint bufferObj) DESCRIPTION Registers the buffer object of ID bufferObj for access by CUDA. cudaGLUnmapBufferObject.2 cudaGLRegisterBufferObject NAME cudaGLRegisterBufferObject .

RETURN VALUE Relevant return values: cudaSuccess cudaErrorMapBufferObjectFailed Note that this function may also return error codes from previous.1. SEE ALSO cudaGLSetGLDevice.OpenGL interoperability SYNOPSIS cudaError_t cudaGLMapBufferObject(void** devPtr. DESCRIPTION Maps the buffer object of ID bufferObj into the address space of CUDA and returns in *devPtr the base pointer of the resulting mapping. cudaGLUnregisterBufferObject 75 .8. asynchronous launches. cudaGLUnmapBufferObject.3 cudaGLMapBufferObject NAME cudaGLMapBufferObject . cudaGLRegisterBufferObject. GLuint bufferObj).

RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevicePointer cudaErrorUnmapBufferObjectFailed Note that this function may also return error codes from previous.1. cudaGLRegisterBufferObject. SEE ALSO cudaGLSetGLDevice.8. asynchronous launches. cudaGLMapBufferObject.4 cudaGLUnmapBufferObject NAME cudaGLUnmapBufferObject . DESCRIPTION Unmaps the buffer object of ID bufferObj for access by CUDA. cudaGLUnregisterBufferObject 76 .OpenGL interoperability SYNOPSIS cudaError_t cudaGLUnmapBufferObject(GLuint bufferObj).

asynchronous launches.1. cudaGLRegisterBufferObject. DESCRIPTION Unregisters the buffer object of ID bufferObj for access by CUDA. cudaGLUnmapBufferObject 77 . RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous.OpenGL interoperability SYNOPSIS cudaError_t cudaGLUnregisterBufferObject(GLuint bufferObj).8.5 cudaGLUnregisterBufferObject NAME cudaGLUnregisterBufferObject . cudaGLMapBufferObject. SEE ALSO cudaGLSetGLDevice.

1.9

Direct3dInteroperability RT

NAME
Direct3D Interoperability

DESCRIPTION
This section describes the CUDA runtime application programming interface. cudaD3D9GetDevice cudaD3D9SetDirect3DDevice cudaD3D9GetDirect3DDevice cudaD3D9RegisterResource cudaD3D9UnregisterResource cudaD3D9MapResources cudaD3D9UnmapResources cudaD3D9ResourceGetSurfaceDimensions cudaD3D9ResourceSetMapFlags cudaD3D9ResourceGetMappedPointer cudaD3D9ResourceGetMappedSize cudaD3D9ResourceGetMappedPitch As of CUDA 2.0 the following functions are deprecated. They should not be used in new development. cudaD3D9Begin cudaD3D9End cudaD3D9RegisterVertexBuffer cudaD3D9MapVertexBuffer cudaD3D9UnmapVertexBuffer cudaD3D9UnregisterVertexBuffer

SEE ALSO
Device Management, Thread Management, Stream Management, Event Management, Execution Management, Memory Management, Texture Reference Management, OpenGL Interoperability, Direct3D Interoperability, Error Handling

78

1.9.1

cudaD3D9GetDevice

NAME
cudaD3D9GetDevice - gets the device number for an adapter

SYNOPSIS
cudaError_t cudaD3D9GetDevice(int* dev, const char* adapterName);

DESCRIPTION
Returns in *dev the CUDA-compatible device corresponding to the adapter name adapterName obtained from EnumDisplayDevices or IDirect3D9::GetAdapterIdentifier(). If no device on the adapter with name adapterName is CUDA-compatible then the call will fail.

RETURN VALUE
Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorUnknown Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO

cudaD3D9SetDirect3DDevice, cudaD3D9GetDirect3DDevice, cudaD3D9RegisterResource, cudaD3D9UnregisterResource, cudaD3D9MapResources, cudaD3D9UnmapResources, cudaD3D9ResourceGetSurfaceDimensions, cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer, cudaD3D9ResourceGetMappedSize, cudaD3D9ResourceGetMappedPitch

79

1.9.2

cudaD3D9SetDirect3DDevice

NAME
cudaD3D9SetDirect3DDevice - sets the Direct3D device to use for interoperability in this thread

SYNOPSIS
cudaError_t cudaD3D9SetDirect3DDevice(IDirect3DDevice9* pDxDevice);

DESCRIPTION
Records pDxDevice as the Direct3D device to use for Direct3D interoperability on this host thread. In order to use Direct3D interoperability, this call must be made before any other CUDA runtime calls on this thread. Successful context creation on pDxDevice will increase the internal reference count on pDxDevice. This reference count will be decremented upon destruction of this context through cudaThreadExit.

RETURN VALUE
Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorInvalidValue Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO

cudaD3D9GetDevice, cudaD3D9GetDirect3DDevice, cudaD3D9RegisterResource, cudaD3D9UnregisterResource, cudaD3D9MapResources, cudaD3D9UnmapResources, cudaD3D9ResourceGetSurfaceDimensions, cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer, cudaD3D9ResourceGetMappedSize, cudaD3D9ResourceGetMappedPitch

80

1.9.3

cudaD3D9GetDirect3DDevice

NAME
cudaD3D9GetDirect3DDevice - get the Direct3D device against which the current CUDA context was created

SYNOPSIS
cudaError_t cudaD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice);

DESCRIPTION
Returns in *ppDxDevice the Direct3D device against which this CUDA context was created in cudaD3D9SetDirect3DDevice.

RETURN VALUE
Relevant return values: cudaSuccess cudaErrorUnknown Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO

cudaD3D9GetDevice, cudaD3D9SetDirect3DDevice, cudaD3D9RegisterResource, cudaD3D9UnregisterResource, cudaD3D9MapResources, cudaD3D9UnmapResources, cudaD3D9ResourceGetSurfaceDimensions, cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer, cudaD3D9ResourceGetMappedSize, cudaD3D9ResourceGetMappedPitch

81

and cudaD3D9ResourceGetMappedPitch respectively.9. • cudaD3D9RegisterFlagsNone: Specifies that CUDA will access this resource through a void*. unsigned int Flags). DESCRIPTION Registers the Direct3D resource pResource for access by CUDA. size. The following are some limitations. Not all Direct3D resources of the above types may be used for interoperability with CUDA. To access individual surfaces associated with a texture. • IDirect3DVertexBuffer9: No notes. This call is potentially high-overhead and should not be called every frame in interactive applications. The pointer. or 32-bit integer or floating-point data cannot be shared. • Resources allocated as shared may not be registered with CUDA. • Textures which are not of a format which is 1. The Flags argument specifies the mechanism through which CUDA will access the Direct3D resource. this call will increase the internal reference count on pResource. 16. Also on success. 2. • The primary rendertarget may not be registered with CUDA. In particular. The following value is allowed. • IDirect3DSurface9: Only stand-alone objects of type IDirect3DSurface9 may be explicitly shared.register a Direct3D resource for access by CUDA SYNOPSIS cudaError_t cudaD3D9RegisterResource(IDirect3DResource9* pResource. • IDirect3DIndexBuffer9: No notes. one must register the base texture object. • Any resources allocated in D3DPOOL_SYSTEMMEM may not be registered with CUDA. individual mipmap levels and faces of cube maps may not be registered directly. This option is valid for all resource types.1. If this call is successful then the application will be able to map and unmap this resource until it is unregistered through cudaD3D9UnregisterResource.4 cudaD3D9RegisterResource NAME cudaD3D9RegisterResource . 82 . The type of pResource must be one of the following. This reference count will be decremented when this resource is unregistered through cudaD3D9UnregisterResource. • IDirect3DBaseTexture9: When a texture is registered all surfaces associated with the all mipmap levels of all faces of the texture will be accessible to CUDA. and pitch for each subresource of this resource may be queried through cudaD3D9ResourceGetMappedPointe cudaD3D9ResourceGetMappedSize. or 4 channels of 8.

cudaD3D9MapResources. If pResource is of incorrect type (e. SEE ALSO cudaD3D9GetDevice. If pResource cannot be registered then cudaErrorUnknown is returned. cudaD3D9ResourceGetMappedPitch 83 . cudaD3D9SetDirect3DDevice. cudaD3D9UnregisterResource. cudaD3D9UnmapResources. cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer.g. cudaD3D9GetDirect3DDevice. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. asynchronous launches. cudaD3D9ResourceGetSurfaceDimensions. If Direct3D interoperability is not initialized on this context then is returned. cudaD3D9ResourceGetMappedSize. is a non-stand-alone IDirect3DSurface9) or is already registered then cudaErrorInvalidHandle is returned.• Surfaces of depth or stencil formats cannot be shared.

asynchronous launches. cudaD3D9GetDirect3DDevice.5 cudaD3D9UnregisterResource NAME cudaD3D9UnregisterResource . cudaD3D9UnmapResources. cudaD3D9ResourceGetMappedSize. cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer. cudaD3D9ResourceGetMappedPitch 84 . If pResource is not registered then cudaErrorInvalidHandle is returned. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. cudaD3D9RegisterResource. cudaD3D9MapResources. cudaD3D9SetDirect3DDevice. DESCRIPTION Unregisters the Direct3D resource pResource so it is not accessable by CUDA unless registered again. cudaD3D9ResourceGetSurfaceDimensions.1. SEE ALSO cudaD3D9GetDevice.9.unregister a Direct3D resource SYNOPSIS cudaError_t cudaD3D9UnregisterResource(IDirect3DResource9* pResource).

cudaD3D9ResourceGetMappedPointer. cudaD3D9UnmapResources. asynchronous launches.map Direct3D resources for access by CUDA SYNOPSIS cudaError_t cudaD3D9MapResources(unsigned int count. cudaD3D9ResourceGetSurfaceDimensions. cudaD3D9GetDirect3DDevice. Direct3D should not access any resources while they are mapped by CUDA.1. If an application does so the results are undefined. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then cudaErrorInvalidHandle is returned. If any of ppResources are presently mapped for access by CUDA then cudaErrorUnknown is returned. cudaD3D9SetDirect3DDevice.9. cudaD3D9RegisterResource. This function provides the synchronization guarantee that any Direct3D calls issued before cudaD3D9MapResources will complete before any CUDA kernels issued after cudaD3D9MapResources begin. cudaD3D9ResourceGetMappedSize. cudaD3D9UnregisterResource. The resources in ppResources may be accessed in CUDA kernels until they are unmapped. IDirect3DResource9 **ppResources). cudaD3D9ResourceGetMappedPitch 85 . cudaD3D9ResourceSetMapFlags.6 cudaD3D9MapResources NAME cudaD3D9MapResources . SEE ALSO cudaD3D9GetDevice. DESCRIPTION Maps the count Direct3D resources in ppResources for access by CUDA.

IDirect3DResource9** ppResources). If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then cudaErrorInvalidHandle is returned. If any of ppResources are not presently mapped for access by CUDA then cudaErrorUnknown is returned. cudaD3D9UnregisterResource. cudaD3D9ResourceGetMappedSize. asynchronous launches. cudaD3D9SetDirect3DDevice.unmap Direct3D resources SYNOPSIS cudaError_t cudaD3D9UnmapResources(unsigned int count. cudaD3D9ResourceSetMa cudaD3D9ResourceGetMappedPointer. This function provides the synchronization guarantee that any CUDA kernels issued before cudaD3D9UnmapResources will complete before any Direct3D calls issued after cudaD3D9UnmapResources begin. cudaD3D9RegisterResource. cudaD3D9ResourceGetSurfaceDimensions. cudaD3D9GetDirect3DDevice.9. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. SEE ALSO cudaD3D9GetDevice.1.7 cudaD3D9UnmapResources NAME cudaD3D9UnmapResources . cudaD3D9MapResources. DESCRIPTION Unmaps the count Direct3D resources in ppResources. cudaD3D9ResourceGetMappedPitch 86 .

unsigned int Flags). If pResource is presently mapped for access by CUDA then cudaErrorUnknown is returned. This is the default value. 87 . • cudaD3D9MapFlagsWriteDiscard: Specifies that CUDA kernels which access this resource will not read from this resource and will write over the entire contents of the resource. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. If pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned.8 cudaD3D9ResourceSetMapFlags NAME cudaD3D9ResourceSetMapFlags .9. DESCRIPTION Set flags for mapping the Direct3D resource pResource. • cudaD3D9MapFlagsReadOnly: Specifies that CUDA kernels which access this resource will not write to this resource. Changes to flags will take effect the next time pResource is mapped. so none of the data previously stored in the resource will be preserved. asynchronous launches. The Flags argument may be any of the following.set usage flags for mapping a Direct3D resource SYNOPSIS cudaError_t cudaD3D9ResourceSetMapFlags(IDirect3DResource9 *pResource.1. It is therefore assumed that this resource will be read from and written to by CUDA kernels. • cudaD3D9MapFlagsNone: Specifies no hints about how this resource will be used.

cudaD3D9MapResources. cudaD3D9ResourceGetMappedPitch 88 . cudaD3D9UnmapResources. cudaD3D9GetDirect3DDevice. cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceGetMappedPointer.SEE ALSO cudaD3D9GetDevice. cudaD3D9SetDirect3DDevice. cudaD3D9UnregisterResource. cudaD3D9ResourceGetMappedSize. cudaD3D9RegisterResource.

cudaD3D9GetDirect3DDevice. size_t *pDepth. and *pDepth the dimensions of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. the value returned in *pDepth will be 0.9. size_t* pHeight.1. cudaD3D9UnmapResources. For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer. asynchronous launches. cudaD3D9UnregisterResource. cudaD3D9ResourceGetMappedPitch 89 . cudaD3D9RegisterResource. For 2D surfaces.9 cudaD3D9ResourceGetSurfaceDimensions NAME cudaD3D9ResourceGetSurfaceDimensions .get the dimensions of a registered surface SYNOPSIS cudaError_t cudaD3D9ResourceGetSurfaceDimensions(size_t* pWidth. *pHeight. unsigned int Face. and pDepth are optional. pHeight. Because anti-aliased surfaces may have multiple samples per pixel it is possible that the dimensions of a resource will be an integer factor larger than the dimensions reported by the Direct3D runtime. If pResource is not of type IDirect3DBaseTexture9 or IDirect3DSurface9 or if pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. DESCRIPTION Returns in *pWidth. cudaD3D9ResourceGetMappedSize. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle Note that this function may also return error codes from previous. IDirect3DResource9* pResource. cudaD3D9ResourceGetMappedPointer. cudaD3D9ResourceSetMapFlags. unsigned int Level). The parameters pWidth. cudaD3D9MapResources. SEE ALSO cudaD3D9GetDevice. cudaD3D9SetDirect3DDevice.

If Face is invalid then cudaErrorInvalidValue is returned. Only mipmap level 0 is supported for now. The value set in pPointer may change every time that pResource is mapped. cudaD3D9ResourceGetMappedPitch 90 . cudaD3D9UnregisterResource. IDirect3DResource9* pResource.9. cudaD3D9RegisterResource. For all other types Face must be 0. DESCRIPTION Returns in *pPointer the base pointer of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. cudaD3D9GetDirect3DDevice. asynchronous launches.10 cudaD3D9ResourceGetMappedPointer NAME cudaD3D9ResourceGetMappedPointer . cudaD3D9UnmapResources. If pResource is not mapped then cudaErrorUnknown is returned. cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceSetMapFlags. cudaD3D9SetDirect3DDevice. cudaD3D9ResourceGetMappedSize. SEE ALSO cudaD3D9GetDevice. cudaD3D9MapResources. If pResource is of type IDirect3DBaseTexture9 then Level must correspond to a valid mipmap level. unsigned int Level). If pResource is of type IDirect3DCubeTexture9 then Face must one of the values enumerated by type D3DCUBEMAP_FACES. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned. If Level is invalid then cudaErrorInvalidValue is returned. If pResource is not registered then cudaErrorInvalidHandle is returned. unsigned int Face. For all other types Level must be 0.get a pointer through which to access a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS cudaError_t cudaD3D9ResourceGetMappedPointer(void** pPointer.

The value set in pSize may change every time that pResource is mapped. cudaD3D9UnregisterResource. If pResource is not mapped for access by CUDA then cudaErrorUnknown is returned.11 cudaD3D9ResourceGetMappedSize NAME cudaD3D9ResourceGetMappedSize . For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer. asynchronous launches. unsigned int Face. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned. If pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous.9. cudaD3D9MapResources. cudaD3D9UnmapResources. cudaD3D9RegisterResource. cudaD3D9ResourceGetMappedPointer. cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceSetMapFlags. cudaD3D9ResourceGetMappedPitch 91 .get the size of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS cudaError_t cudaD3D9ResourceGetMappedSize(size_t* pSize. IDirect3DResource9* pResource. cudaD3D9SetDirect3DDevice.1. cudaD3D9GetDirect3DDevice. SEE ALSO cudaD3D9GetDevice. DESCRIPTION Returns in *pSize the size of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. unsigned int Level).

y. DESCRIPTION Returns in *pPitch and *pPitchSlice the pitch and Z-slice pitch of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level.y from the base pointer of the surface is If pResource is not of type IDirect3DBaseTexture9 or one of its sub-types or if pResource has not been registered for use with CUDA then cudaErrorInvalidHandle is returned. unsigned int Level). The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows. unsigned int Face. For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer. If pResource is not mapped for access by CUDA then cudaErrorUnknown is returned. IDirect3DResource9* pResource.9. For a 2D surface the byte offset of the sample of at position x.1.z from the base pointer of the surface is z*slicePitch + y*pitch + (bytes per pixel)*x Both parameters pPitch and pPitchSlice are optional and may be set to NULL. 92 . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous.12 cudaD3D9ResourceGetMappedPitch NAME cudaD3D9ResourceGetMappedPitch . y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x. The values set in pPitch and pPitchSlice may change every time that pResource is mapped.get the pitch of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS cudaError_t cudaD3D9ResourceGetMappedPitch(size_t* pPitch. asynchronous launches. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned. size_t* pPitchSlice.

cudaD3D9GetDirect3DDevice. cudaD3D9RegisterResource. cudaD3D9UnmapResources. cudaD3D9ResourceGetSurfaceDimensio cudaD3D9ResourceSetMapFlags. cudaD3D9ResourceGetMappedPointer. cudaD3D9MapResources. cudaD3D9UnregisterResource.SEE ALSO cudaD3D9GetDevice. cudaD3D9SetDirect3DDevice. cudaD3D9ResourceGetMappedSize 93 .

Direct3D Interoperability.1.10 ErrorHandling RT NAME Error Handling DESCRIPTION This section describes the CUDA runtime application programming interface. Event Management. Execution Management. Error Handling 94 . Stream Management. Thread Management. OpenGL Interoperability. cudaGetLastError cudaGetErrorString SEE ALSO Device Management. Memory Management. Texture Reference Management.

returns the last error from a run-time call SYNOPSIS cudaError_t cudaGetLastError( void ) DESCRIPTION Returns the last error that was returned from any of the runtime calls in the same host thread and resets it to cudaSuccess. 95 .10.1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorLaunchFailure cudaErrorPriorLaunchFailure cudaErrorLaunchTimeout cudaErrorLaunchOutOfResources cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration cudaErrorInvalidDevice cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture cudaErrorInvalidTextureBinding cudaErrorInvalidChannelDescriptor cudaErrorTextureFetchFailed cudaErrorTextureNotBound cudaErrorSynchronizationError cudaErrorUnknown cudaErrorInvalidResourceHandle cudaErrorNotReady Note that this function may also return error codes from previous asynchronous launches.1 cudaGetLastError NAME cudaGetLastError .

SEE ALSO cudaGetErrorString. cudaError 96 .

2 cudaGetErrorString NAME cudaGetErrorString .10. RETURN VALUE char* pointer to a NULL-terminated string SEE ALSO cudaGetLastError 97 . DESCRIPTION Returns a message string from an error code.1.returns the message string from an error SYNOPSIS const char* cudaGetErrorString(cudaError_t error).

EventManagement. DeviceManagement. ExecutionControl. TextureReferenceManagement.2 DriverApiReference NAME Driver API Reference DESCRIPTION This section describes the low-level CUDA driver application programming interface. Direct3dInteroperability 98 . OpenGlInteroperability. MemoryManagement. ContextManagement. SEE ALSO Initialization. StreamManagement. ModuleManagement.

cuInit SEE ALSO Initialization. EventManagement. OpenGlInteroperability. TextureReferenceManagement.1 Initialization NAME Driver Initialization DESCRIPTION This section describes the low-level CUDA driver application programming interface. ContextManagement.2. ExecutionControl. MemoryManagement. ModuleManagement. Direct3dInteroperability 99 . DeviceManagement. StreamManagement.

1 cuInit NAME cuInit .1.2. Currently. asynchronous launches. DESCRIPTION Initializes the driver API and must be called before any other function from the driver API.initialize the CUDA driver API SYNOPSIS CUresult cuInit( unsigned int Flags ). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NO_DEVICE Note that this function may also return error codes from previous. any function from the driver API will return CUDA_ERROR_NOT_INITIALIZED. If cuInit() has not been called. the Flags parameters must be 0. SEE ALSO 100 .

ContextManagement. ExecutionControl. TextureReferenceManagement. MemoryManagement.2 DeviceManagement NAME Device Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. cuDeviceComputeCapability cuDeviceGet cuDeviceGetAttribute cuDeviceGetCount cuDeviceGetName cuDeviceGetProperties cuDeviceTotalMem SEE ALSO Initialization. DeviceManagement. ModuleManagement. Direct3dInteroperability 101 . EventManagement. OpenGlInteroperability. StreamManagement.2.

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. cuDeviceGetProperties. cuDeviceGetName. CUdevice dev). DESCRIPTION Returns in *major and *minor the major and minor revision numbers that define the compute capability of device dev.2. cuDeviceGetCount. cuDeviceTotalMem 102 . int* minor. cuDeviceGet. asynchronous launches.returns the compute capability of the device SYNOPSIS CUresult cuDeviceComputeCapability(int* major.1 cuDeviceComputeCapability NAME cuDeviceComputeCapability .2. SEE ALSO cuDeviceGetAttribute.

cuDeviceGetCount()-1]. DESCRIPTION Returns in *dev a device handle given an ordinal in the range [0.2. cuDeviceGetName. cuDeviceGetProperties.returns a device-handle SYNOPSIS CUresult cuDeviceGet(CUdevice* dev. asynchronous launches.2 cuDeviceGet NAME cuDeviceGet . int ordinal). cuDeviceTotalMem 103 . SEE ALSO cuDeviceComputeCapability.2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. cuDeviceGetAttribute. cuDeviceGetCount.

• CU_DEVICE_ATTRIBUTE_MAX_REGISTERS_PER_BLOCK: maximum number of 32-bit registers available to a thread block. texture base addresses aligned to textureAlign bytes do not need an offset applied to texture fetches. 104 . • CU_DEVICE_ATTRIBUTE_TOTAL_CONSTANT_MEMORY: total amount of constant memory available on the device in bytes. The supported attributes are: • CU_DEVICE_ATTRIBUTE_MAX_THREADS_PER_BLOCK: maximum number of threads per block. • CU_DEVICE_ATTRIBUTE_MULTIPROCESSOR_COUNT: number of multiprocessors on the device. • CU_DEVICE_ATTRIBUTE_MAX_SHARED_MEMORY_PER_BLOCK: maximum amount of shared memory available to a thread block in bytes. • CU_DEVICE_ATTRIBUTE_MAX_GRID_DIM_Y: maximum y-dimension of a grid. DESCRIPTION Returns in *value the integer value of the attribute attrib on device dev. • CU_DEVICE_ATTRIBUTE_CLOCK_RATE: clock frequency in kilohertz. • CU_DEVICE_ATTRIBUTE_MAX_GRID_DIM_X: maximum x-dimension of a grid. • CU_DEVICE_ATTRIBUTE_GPU_OVERLAP: 1 if the device can concurrently copy memory between host and device while executing a kernel. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_Z: maximum z-dimension of a block. • CU_DEVICE_ATTRIBUTE_WARP_SIZE: warp size in threads. this number is shared by all thread blocks simultaneously resident on a multiprocessor. this amount is shared by all thread blocks simultaneously resident on a multiprocessor. • CU_DEVICE_ATTRIBUTE_MAX_GRID_DIM_Z: maximum z-dimension of a grid. CUdevice_attribute attrib. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_X: maximum x-dimension of a block. • CU_DEVICE_ATTRIBUTE_MAX_BLOCK_DIM_Y: maximum y-dimension of a block. or 0 if not. • CU_DEVICE_ATTRIBUTE_TEXTURE_ALIGNMENT: alignment requirement. CUdevice dev). • CU_DEVICE_ATTRIBUTE_MAX_PITCH: maximum pitch in bytes allowed by the memory copy functions that involve memory regions allocated through cuMemAllocPitch().2.3 cuDeviceGetAttribute NAME cuDeviceGetAttribute .returns information about the device SYNOPSIS CUresult cuDeviceGetAttribute(int* value.2.

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. asynchronous launches. cuDeviceTotalMem 105 . cuDeviceGet. cuDeviceGetProperties. cuDeviceGetCount. SEE ALSO cuDeviceComputeCapability. cuDeviceGetName.

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.2. cuDeviceGetName. cuDeviceGetProperties. If there is no such device. asynchronous launches.returns the number of compute-capable devices SYNOPSIS CUresult cuDeviceGetCount(int* count). cuDeviceGetCount() returns 0.4 cuDeviceGetCount NAME cuDeviceGetCount .0 that are available for execution. SEE ALSO cuDeviceComputeCapability. cuDeviceGet. cuDeviceGetAttribute. DESCRIPTION Returns in *count the number of devices with compute capability greater or equal to 1. cuDeviceTotalMem 106 .2.

cuDeviceTotalMem 107 .returns an identifier string SYNOPSIS CUresult cuDeviceGetName(char* name. int len. cuDeviceGetCount. DESCRIPTION Returns an ASCII string identifying the device dev in the NULL-terminated string pointed to by name.2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous.2. cuDeviceGetProperties. cuDeviceGetAttribute. asynchronous launches. cuDeviceGet. len specifies the maximum length of the string that may be returned. SEE ALSO cuDeviceComputeCapability.5 cuDeviceGetName NAME cuDeviceGetName . CUdevice dev).

• textureAlign is the alignment requirement. int textureAlign } CUdevprop. The CUdevprop structure is defined as: typedef struct CUdevprop_st { int maxThreadsPerBlock. • totalConstantMemory is the total amount of constant memory available on the device in bytes. • regsPerBlock is the total number of registers available per block. int SIMDWidth.2. texture base addresses that are aligned to textureAlign bytes do not need an offset applied to texture fetches. • memPitch is the maximum pitch allowed by the memory copy functions that involve memory regions allocated through cuMemAllocPitch(). int sharedMemPerBlock. int memPitch. • maxThreadsDim[3] is the maximum sizes of each dimension of a block. • sharedMemPerBlock is the total amount of shared memory available per block in bytes. int clockRate. where: • maxThreadsPerBlock is the maximum number of threads per block. int maxGridSize[3].2. • clockRate is the clock frequency in kilohertz. DESCRIPTION Returns in *prop the properties of device dev. • maxGridSize[3] is the maximum sizes of each dimension of a grid.get device properties SYNOPSIS CUresult cuDeviceGetProperties(CUdevprop* prop. int totalConstantMemory. • SIMDWidth is the warp size. CUdevice dev). int maxThreadsDim[3].6 cuDeviceGetProperties NAME cuDeviceGetProperties . int regsPerBlock. 108 .

cuDeviceGetAttribute. cuDeviceGet. cuDeviceGetName. asynchronous launches. cuDeviceTotalMem 109 . cuDeviceGetCount. SEE ALSO cuDeviceComputeCapability.RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous.

SEE ALSO cuDeviceComputeCapability.2. cuDeviceGet. asynchronous launches.7 cuDeviceTotalMem NAME cuDeviceTotalMem .returns the total amount of memory on the device SYNOPSIS CUresult cuDeviceTotalMem( unsigned int* bytes.2. cuDeviceGetAttribute. DESCRIPTION Returns in *bytes the total amount of memory available on the device dev in bytes. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_DEVICE Note that this function may also return error codes from previous. cuDeviceGetName. CUdevice dev ). cuDeviceGetCount. cuDeviceGetProperties 110 .

cuCtxAttach cuCtxCreate cuCtxDestroy cuCtxDetach cuCtxGetDevice cuCtxPopCurrent cuCtxPushCurrent cuCtxSynchronize SEE ALSO Initialization.3 ContextManagement NAME Context Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. ModuleManagement. Direct3dInteroperability 111 . OpenGlInteroperability. MemoryManagement. StreamManagement. EventManagement.2. ExecutionControl. ContextManagement. DeviceManagement. TextureReferenceManagement.

increment context usage-count SYNOPSIS CUresult cuCtxAttach(CUcontext* pCtx. unsigned int Flags).1 cuCtxAttach NAME cuCtxAttach . the Flags parameter must be 0. cuCtxGetDevice. SEE ALSO cuCtxCreate. cuCtxAttach() fails if there is no context current to the thread.3. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. asynchronous launches. cuCtxDetach.2. cuCtxSynchronize 112 . Currently. DESCRIPTION Increments the usage count of the context and passes back a context handle in *pCtx that must be passed to cuCtxDetach() when the application is done with the context.

create a CUDA context SYNOPSIS CUresult cuCtxCreate(CUcontext* pCtx. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_DEVICE CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. The Flags parameter is described below. • CU_CTX_SCHED_SPIN: Instruct CUDA to actively spin when waiting for results from the GPU. unsigned int Flags. If C > P then CUDA will yield to other OS threads when waiting for the GPU. If a context is already current to the thread. uses a heuristic based on the number of active CUDA contexts in the process C and the number of logical processors in the system P.2. asynchronous launches. The context is created with a usage count of 1 and the caller of cuCtxCreate() must call cuCtxDestroy() or cuCtxDetach() when done using the context. but can increase the performance of CPU threads performing work in parallel with the GPU. This can increase latency when waiting for the GPU. but may lower the performance of CPU threads if they are performing work in parallel with the CUDA thread.3. The two LSBs of the Flags parameter can be used to control how the OS thread which owns the CUDA context at the time of an API call interacts with the OS scheduler when waiting for results from the GPU. This can decrease latency when waiting for the GPU. it is supplanted by the newly created context and may be restored by a subsequent call to cuCtxPopCurrent().2 cuCtxCreate NAME cuCtxCreate . • CU_CTX_SCHED_AUTO: The default value if the Flags parameter is zero. otherwise CUDA will not yield while waiting for results and actively spin on the processor. • CU_CTX_SCHED_YIELD: Instruct CUDA to yield its thread when waiting for results from the GPU. CUdevice dev). DESCRIPTION Creates a new CUDA context and associates it with the calling thread. 113 .

cuCtxDetach.SEE ALSO cuCtxAttach. cuCtxPushCurrent. cuCtxDestroy. cuCtxPopCurrent 114 .

cuCtxAttach. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. this function fails. cuCtxDetach. If the context usage count is not equal to 1. DESCRIPTION Destroys the given CUDA context.3 cuCtxDestroy NAME cuCtxDestroy . asynchronous launches. or the context is current to any CPU thread other than the current one.2. cuCtxPopCurrent 115 .destroy the current context context or a floating CuDA context SYNOPSIS CUresult cuCtxDestroy(CUcontext ctx). cuCtxPushCurrent. Floating contexts (detached from a CPU thread via cuCtxPopCurrent()) may be destroyed by this function.3. SEE ALSO cuCtxCreate.

SEE ALSO cuCtxCreate. cuCtxDestroy.3. asynchronous launches. cuCtxAttach. DESCRIPTION Decrements the usage count of the context. and destroys the context if the usage count goes to 0.2. cuCtxPushCurrent. cuCtxPopCurrent 116 . The context must be a handle that was passed back by cuCtxCreate() or cuCtxAttach(). and must be current to the calling thread. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous.decrement a context’s usage-count SYNOPSIS CUresult cuCtxDetach(CUcontext ctx).4 cuCtxDetach NAME cuCtxDetach .

SEE ALSO cuCtxCreate.2.5 cuCtxGetDevice NAME cuCtxGetDevice .return device-ID for current context SYNOPSIS CUresult cuCtxGetDevice(CUdevice* device). cuCtxDetach. asynchronous launches. DESCRIPTION Returns in *device the ordinal of the current context’s device. cuCtxSynchronize 117 . cuCtxAttach.3. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

If a context was current to the CPU thread before cuCtxCreate or cuCtxPushCurrent was called. cuCtxDestroy.6 cuCtxPopCurrent NAME cuCtxPopCurrent .3. the usage count may be incremented with cuCtxAttach() and decremented with cuCtxDetach(). The context may then be made current to a different CPU thread by calling cuCtxPushCurrent(). The CUDA context must have a usage count of 1. cuCtxDetach. Floating contexts may be destroyed by calling cuCtxDestroy(). cuCtxPushCurrent 118 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous.pops the current CUDA context from the current CPU thread SYNOPSIS CUresult cuCtxPopCurrent(CUcontext *pctx). CUDA contexts have a usage count of 1 upon creation. cuCtxAttach. SEE ALSO cuCtxCreate. cuCtxPopCurrent() passes back the context handle in *pctx. this function makes that context current to the CPU thread again. If successful. asynchronous launches.2. DESCRIPTION Pops the current CUDA context from the CPU thread.

asynchronous launches. not attached to any thread. The specified context becomes the CPU thread’s current context. cuCtxDetach. cuCtxDestroy. The previous current context may be made current again by calling cuCtxDestroy() or cuCtxPopCurrent().3. SEE ALSO cuCtxCreate. cuCtxPopCurrent 119 .2." i. so all CUDA functions that operate on the current context are affected. The context must be "floating.e. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. Contexts are made to float by calling cuCtxPopCurrent().attach floating context to CPU thread SYNOPSIS CUresult cuCtxPushCurrent(CUcontext ctx). cuCtxAttach. DESCRIPTION Pushes the given context onto the CPU thread’s stack of current contexts.7 cuCtxPushCurrent NAME cuCtxPushCurrent .

cuCtxSynchronize() returns an error if one of the preceding tasks failed. cuCtxGetDevice 120 .block for a context’s tasks to complete SYNOPSIS CUresult cuCtxSynchronize(void). cuCtxDetach.2. DESCRIPTION Blocks until the device has completed all preceding requested tasks.8 cuCtxSynchronize NAME cuCtxSynchronize . cuCtxAttach. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous. asynchronous launches.3. SEE ALSO cuCtxCreate.

MemoryManagement. EventManagement. ExecutionControl. TextureReferenceManagement. OpenGlInteroperability. Direct3dInteroperability 121 . StreamManagement. ContextManagement.4 ModuleManagement NAME Module Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. DeviceManagement. ModuleManagement. cuModuleGetFunction cuModuleGetGlobal cuModuleGetTexRef cuModuleLoad cuModuleLoadData cuModuleLoadFatBinary cuModuleUnload SEE ALSO Initialization.2.

CUmodule mod. cuModuleLoadData. cuModuleGetFunction() returns CUDA_ERROR_NOT_FOUND. const char* funcname). If no function of that name exists. cuModuleGetGlobal. cuModuleUnload. SEE ALSO cuModuleLoad. DESCRIPTION Returns in *func the handle of the function of name funcname located in module mod. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND Note that this function may also return error codes from previous. cuModuleGetTexRef 122 .2.returns a function handle SYNOPSIS CUresult cuModuleGetFunction(CUfunction* func.4. cuModuleLoadFatBinary.1 cuModuleGetFunction NAME cuModuleGetFunction . asynchronous launches.

cuModuleGetTexRef 123 . If one of them is null. cuModuleUnload. cuModuleGetGlobal() returns CUDA_ERROR_NOT_FOUND.2 cuModuleGetGlobal NAME cuModuleGetGlobal . CUmodule mod. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND Note that this function may also return error codes from previous. it is ignored. If no variable of that name exists. asynchronous launches. Both parameters devPtr and bytes are optional.4.2. unsigned int* bytes. DESCRIPTION Returns in *devPtr and *bytes the base pointer and size of the global of name globalname located in module mod. cuModuleGetFunction. cuModuleLoadData. SEE ALSO cuModuleLoad. cuModuleLoadFatBinary.returns a global pointer from a module SYNOPSIS CUresult cuModuleGetGlobal(CUdeviceptr* devPtr. const char* globalname).

2.4.3

cuModuleGetTexRef

NAME
cuModuleGetTexRef - gets a handle to a texture-reference

SYNOPSIS
CUresult cuModuleGetTexRef(CUtexref* texRef, CUmodule hmod, const char* texrefname);

DESCRIPTION
Returns in *texref the handle of the texture reference of name texrefname in the module mod. If no texture reference of that name exists, cuModuleGetTexRef() returns CUDA_ERROR_NOT_FOUND. This texture reference handle should not be destroyed, since it will be destroyed when the module is unloaded.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuModuleLoad, cuModuleLoadData, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal

124

2.4.4

cuModuleLoad

NAME
cuModuleLoad - loads a compute module

SYNOPSIS
CUresult cuModuleLoad(CUmodule* mod, const char* filename);

DESCRIPTION
Takes a file name filename and loads the corresponding module mod into the current context. The CUDA driver API does not attempt to lazily allocate the resources needed by a module; if the memory for functions and data (constant and global) needed by the module cannot be allocated, cuModuleLoad() fails. The file should be a cubin file as output by nvcc.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_FILE_NOT_FOUND Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuModuleLoadData, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

125

2.4.5

cuModuleLoadData

NAME
cuModuleLoadData - loads a module’s data

SYNOPSIS
CUresult cuModuleLoadData(CUmodule* mod, const void* image);

DESCRIPTION
Takes a pointer image and loads the corresponding module mod into the current context. The pointer may be obtained by mapping a cubin file, passing a cubin file as a text string, or incorporating a cubin object into the executable resources and using operation system calls such as WindowsâĂŹ FindResource() to obtain the pointer.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuModuleLoad, cuModuleLoadFatBinary, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

126

2.4.6

cuModuleLoadFatBinary

NAME
cuModuleLoadFatBinary - loads a fat-binary object

SYNOPSIS
CUresult cuModuleLoadFatBinary(CUmodule* mod, const void* fatBin);

DESCRIPTION
Takes a pointer fatBin and loads the corresponding module mod into the current context. The pointer represents a fat binary object, which is a collection of different cubin files, all representing the same device code but compiled and optimized for different architectures. There is currently no documented API for constructing and using fat binary objects by programmers, and therefore this function is an internal function in this version of CUDA. More information can be found in the nvcc document.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_NOT_FOUND CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_NO_BINARY_FOR_GPU Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuModuleLoad, cuModuleLoadData, cuModuleUnload, cuModuleGetFunction, cuModuleGetGlobal, cuModuleGetTexRef

127

4. cuModuleGetGlobal. cuModuleGetTexRef 128 . cuModuleLoadFatBinary. SEE ALSO cuModuleLoad. cuModuleGetFunction.7 cuModuleUnload NAME cuModuleUnload .unloads a module SYNOPSIS CUresult cuModuleUnload(CUmodule mod). asynchronous launches.2. DESCRIPTION Unloads a module mod from the current context. cuModuleLoadData. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

ModuleManagement. ContextManagement. MemoryManagement.5 StreamManagement NAME Stream Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. cuStreamCreate cuStreamDestroy cuStreamQuery cuStreamSynchronize SEE ALSO Initialization. OpenGlInteroperability. TextureReferenceManagement. Direct3dInteroperability 129 . ExecutionControl. DeviceManagement. EventManagement. StreamManagement.2.

flags is required to be 0.5. DESCRIPTION Creates a stream. At present. asynchronous launches. cuStreamDestroy 130 .2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. unsigned int flags). SEE ALSO cuStreamQuery. cuStreamSynchronize.1 cuStreamCreate NAME cuStreamCreate .create a stream SYNOPSIS CUresult cuStreamCreate(CUstream* stream.

DESCRIPTION Destroys the stream.2.5.destroys a stream SYNOPSIS CUresult cuStreamDestroy(CUstream stream). cuStreamSynchronize 131 . cuStreamQuery. asynchronous launches. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous.2 cuStreamDestroy NAME cuStreamDestroy . SEE ALSO cuStreamCreate.

5.2.determine status of a compute stream SYNOPSIS CUresult cuStreamQuery(CUstream stream). asynchronous launches. cuStreamDestroy 132 . DESCRIPTION Returns CUDA_SUCCESS if all operations in the stream have completed. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_READY Note that this function may also return error codes from previous. or CUDA_ERROR_NOT_READY if not. SEE ALSO cuStreamCreate.3 cuStreamQuery NAME cuStreamQuery . cuStreamSynchronize.

DESCRIPTION Blocks until the device has completed all operations in the stream. SEE ALSO cuStreamCreate. asynchronous launches. cuStreamQuery.4 cuStreamSynchronize NAME cuStreamSynchronize . cuStreamDestroy 133 .2.5.block until a stream’s tasks are completed SYNOPSIS CUresult cuStreamSynchronize(CUstream stream). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous.

ExecutionControl. DeviceManagement. Direct3dInteroperability 134 . ModuleManagement. MemoryManagement. StreamManagement.6 EventManagement NAME Event Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. EventManagement.2. cuEventCreate cuEventDestroy cuEventElapsedTime cuEventQuery cuEventRecord cuEventSynchronize SEE ALSO Initialization. ContextManagement. TextureReferenceManagement. OpenGlInteroperability.

2. cuEventDestroy. cuEventSynchronize.6. SEE ALSO cuEventRecord. DESCRIPTION Creates an event. cuEventElapsedTime 135 . asynchronous launches. unsigned int flags). flags is required to be 0.creates an event SYNOPSIS CUresult cuEventCreate(CUevent* event. cuEventQuery. At present.1 cuEventCreate NAME cuEventCreate . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous.

SEE ALSO cuEventCreate.6. cuEventSynchronize. cuEventQuery.2.destroys an event SYNOPSIS CUresult cuEventDestroy(CUevent event). asynchronous launches. DESCRIPTION Destroys the event. cuEventElapsedTime 136 .2 cuEventDestroy NAME cuEventDestroy . cuEventRecord. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous.

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. SEE ALSO cuEventCreate. CUevent end). If either event has been recorded with a non-zero stream. asynchronous launches.6. this function returns CUDA_ERROR_INVALID_VALUE. DESCRIPTION Computes the elapsed time between two events (in milliseconds with a resolution of around 0. cuEventRecord.2. the result is undefined.3 cuEventElapsedTime NAME cuEventElapsedTime . cuEventSynchronize. cuEventDestroy 137 .5 microseconds). CUevent start. If either event has not been recorded yet.computes the elapsed time between two events SYNOPSIS CUresult cuEventDestroy(float* time. cuEventQuery.

cuEventDestroy. If cuEventRecord() has not been called on this event. SEE ALSO cuEventCreate.6. asynchronous launches.2. or CUDA_ERROR_NOT_READY if not. cuEventElapsedTime 138 . DESCRIPTION Returns CUDA_SUCCESS if the event has actually been recorded. cuEventRecord. cuEventSynchronize.4 cuEventQuery NAME cuEventQuery . the function returns CUDA_ERROR_INVALID_VALUE RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_READY Note that this function may also return error codes from previous.queries an event’s status SYNOPSIS CUresult cuEventQuery(CUevent event).

If cuEventRecord() has previously been called and the event has not been recorded yet. SEE ALSO cuEventCreate. DESCRIPTION Records an event. it is recorded after all preceding operations in the CUDA context have been completed.6. CUstream stream).2. Since this operation is asynchronous. cuEventSynchronize. asynchronous launches.records an event SYNOPSIS CUresult cuEventRecord(CUevent event. cuEventElapsedTime 139 . the event is recorded after all preceding operations in the stream have been completed. this function returns CUDA_ERROR_INVALID_VALUE. cuEventQuery. cuEventQuery() and/or cuEventSynchronize() must be used to determine when the event has actually been recorded. cuEventDestroy. If stream is non-zero.5 cuEventRecord NAME cuEventRecord . otherwise. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

cuEventRecord. cuEventDestroy. If cuEventRecord() has not been called on this event.6 cuEventSynchronize NAME cuEventSynchronize .waits for an event to complete SYNOPSIS CUresult cuEventSynchronize(CUevent event). SEE ALSO cuEventCreate.2. cuEventElapsedTime 140 . the function returns CUDA_ERROR_INVALID_VALUE.6. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous. DESCRIPTION Blocks until the event has actually been recorded. asynchronous launches. cuEventQuery.

Direct3dInteroperability 141 .7 ExecutionControl NAME Execution Control DESCRIPTION This section describes the low-level CUDA driver application programming interface. TextureReferenceManagement. StreamManagement. ContextManagement. EventManagement. ModuleManagement. cuLaunch cuLaunchGrid cuParamSetSize cuParamSetTexRef cuParamSetf cuParamSeti cuParamSetv cuFuncSetBlockShape cuFuncSetSharedSize SEE ALSO Initialization.2. MemoryManagement. ExecutionControl. OpenGlInteroperability. DeviceManagement.

The block contains the number of threads specified by a previous call to cuFuncSetBlockShape().2. cuParamSetf. cuParamSeti. cuParamSetv.1 cuLaunch NAME cuLaunch . DESCRIPTION Invokes the kernel func on a 1ÃŮ1 grid of blocks. cuParamSetTexRef.launches a CUDA function SYNOPSIS CUresult cuLaunch(CUfunction func). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_LAUNCH_INCOMPATIBLE_TEXTURING Note that this function may also return error codes from previous. SEE ALSO cuFuncSetBlockShape. asynchronous launches. cuParamSetSize.7. cuLaunchGrid 142 . cuFuncSetSharedSize.

cuParamSetTexRef. cuParamSetf. CUstream stream). cuLaunchGridAsync() can optionally be associated to a stream by passing a non-zero stream argument.launches a CUDA function SYNOPSIS CUresult cuLaunchGrid(CUfunction func. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_LAUNCH_INCOMPATIBLE_TEXTURING Note that this function may also return error codes from previous. cuLaunch 143 . DESCRIPTION Invokes the kernel on a grid_width x grid_height grid of blocks. asynchronous launches. int grid_width. cuParamSetv. cuFuncSetSharedSize. cuParamSeti.7.2.2 cuLaunchGrid NAME cuLaunchGrid . SEE ALSO cuFuncSetBlockShape. int grid_width. CUresult cuLaunchGridAsync(CUfunction func. int grid_height). int grid_height. Each block contains the number of threads specified by a previous call to cuFuncSetBlockShape(). cuParamSetSize.

cuLaunchGrid 144 . cuFuncSetSharedSize. cuParamSetf.3 cuParamSetSize NAME cuParamSetSize . cuLaunch. DESCRIPTION Sets through numbytes the total size in bytes needed by the function parameters of function func. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. asynchronous launches.sets the parameter-size for the function SYNOPSIS CUresult cuParamSetSize(CUfunction func. cuParamSeti.7. SEE ALSO cuFuncSetBlockShape. cuParamSetv. unsigned int numbytes). cuParamSetTexRef.2.

2.adds a texture-reference to the function’s argument list SYNOPSIS CUresult cuParamSetTexRef(CUfunction func. cuLaunch. SEE ALSO cuFuncSetBlockShape. cuParamSetSize.7.4 cuParamSetTexRef NAME cuParamSetTexRef . the texture reference must be obtained via cuModuleGetTexRef() and the texunit parameter must be set to CU_PARAM_TR_DEFAULT. CUtexref texRef). cuParamSeti. cuLaunchGrid 145 . int texunit. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuParamSetv. asynchronous launches. In this version of CUDA. DESCRIPTION Makes the CUDA array or linear memory bound to the texture reference texRef available to a device program as a texture. cuFuncSetSharedSize. cuParamSetf.

cuParamSetv.adds a floating-point parameter to the function’s argument list SYNOPSIS CUresult cuParamSetf(CUfunction func.2. asynchronous launches. cuParamSetSize.5 cuParamSetf NAME cuParamSetf . offset is a byte offset. cuLaunchGrid 146 . cuParamSetTexRef. cuParamSeti. cuFuncSetSharedSize. DESCRIPTION Sets a floating point parameter that will be specified the next time the kernel corresponding to func will be invoked. float value). cuLaunch. int offset.7. SEE ALSO cuFuncSetBlockShape. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

cuFuncSetSharedSize. cuParamSetSize. DESCRIPTION Sets an integer parameter that will be specified the next time the kernel corresponding to func will be invoked. int offset. cuLaunchGrid 147 . unsigned int value). cuParamSetTexRef.2. SEE ALSO cuFuncSetBlockShape. cuParamSetv. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuLaunch. cuParamSetf. asynchronous launches.adds an integer parameter to the function’s argument list SYNOPSIS CUresult cuParamSeti(CUfunction func. offset is a byte offset.7.6 cuParamSeti NAME cuParamSeti .

asynchronous launches.adds arbitrary data to the function’s argument list SYNOPSIS CUresult cuParamSetv(CUfunction func.2. cuParamSetSize.7. cuParamSetf. unsigned int numbytes). cuLaunchGrid 148 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. offset is a byte offset. void* ptr. cuFuncSetSharedSize. cuParamSetTexRef. SEE ALSO cuFuncSetBlockShape. cuParamSeti. cuLaunch. int offset. DESCRIPTION Copies an arbitrary amount of data into the parameter space of the kernel corresponding to func.7 cuParamSetv NAME cuParamSetv .

RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. Y and Z dimensions of the thread blocks that are created when the kernel given by func is launched. int z). int y. cuParamSetSize. cuParamSetf.2. cuLaunch. SEE ALSO cuFuncSetSharedSize. asynchronous launches.7. cuParamSeti.sets the block-dimensions for the function SYNOPSIS CUresult cuFuncSetBlockShape(CUfunction func.8 cuFuncSetBlockShape NAME cuFuncSetBlockShape . int x. DESCRIPTION Specifies the X. cuLaunchGrid 149 . cuParamSetTexRef. cuParamSetv.

cuParamSeti. unsigned int bytes). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.9 cuFuncSetSharedSize NAME cuFuncSetSharedSize . cuLaunch.7. SEE ALSO cuFuncSetBlockShape. cuParamSetTexRef. cuParamSetf.sets the shared-memory size for the function SYNOPSIS CUresult cuFuncSetSharedSize(CUfunction func. cuParamSetSize. DESCRIPTION Sets through bytes the amount of shared memory that will be available to each thread block when the kernel given by func is launched.2. asynchronous launches. cuLaunchGrid 150 . cuParamSetv.

8 MemoryManagement NAME Memory Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. ContextManagement. Direct3dInteroperability 151 . StreamManagement. TextureReferenceManagement. EventManagement. MemoryManagement. OpenGlInteroperability. cuArrayCreate cuArray3DCreate cuArrayDestroy cuArrayGetDescriptor cuArray3DGetDescriptor cuMemAlloc cuMemAllocHost cuMemAllocPitch cuMemFree cuMemFreeHost cuMemGetAddressRange cuMemGetInfo cuMemcpy2D cuMemcpy3D cuMemcpyAtoA cuMemcpyAtoD cuMemcpyAtoH cuMemcpyDtoA cuMemcpyDtoD cuMemcpyDtoH cuMemcpyHtoA cuMemcpyHtoD cuMemset cuMemset2D SEE ALSO Initialization. ModuleManagement. ExecutionControl. DeviceManagement.2.

desc.. CU_AD_FORMAT_SIGNED_INT32 = 0x0a.Format = CU_AD_FORMAT_FLOAT. CU_AD_FORMAT_UNSIGNED_INT32 = 0x03. • NumChannels specifies the number of packed components per CUDA array element. CU_AD_FORMAT_HALF = 0x10.creates a 1D or 2D CUDA array SYNOPSIS CUresult cuArrayCreate(CUarray* array. 2 or 4. CU_AD_FORMAT_SIGNED_INT8 = 0x08. the CUDA array is one-dimensional if height is 0. 152 .2. otherwise. • Format specifies the format of the elements.8. CUarray_format is defined as such: typedef enum CUarray_format_enum { CU_AD_FORMAT_UNSIGNED_INT8 = 0x01. const CUDA_ARRAY_DESCRIPTOR* desc). it may be 1. CU_AD_FORMAT_SIGNED_INT16 = 0x09. CU_AD_FORMAT_FLOAT = 0x20 } CUarray_format. Here are examples of CUDA array descriptions: • Description for a CUDA array of 2048 floats: CUDA_ARRAY_DESCRIPTOR desc. two-dimensional.1 cuArrayCreate NAME cuArrayCreate . CU_AD_FORMAT_UNSIGNED_INT16 = 0x02. } CUDA_ARRAY_DESCRIPTOR. where: • Width and Height are the width and height of the CUDA array (in elements). unsigned int Height. DESCRIPTION Creates a CUDA array according to the CUDA_ARRAY_DESCRIPTOR structure desc and returns a handle to the new CUDA array in *array. CUarray_format Format. The CUDA_ARRAY_DESCRIPTOR structure is defined as such: typedef struct { unsigned int Width. unsigned int NumChannels.

NumChannels = 4. desc. desc.Height = 64.Width = 64.desc.NumChannels = 1. • Description for a width x height CUDA array of 64-bit. cuMemAllocHost. cuMemset2D 153 .Height = 1. each of which is two 8-bit unsigned chars: CUDA_ARRAY_DESCRIPTOR arrayDesc. desc. desc. desc. cuMemAlloc. cuMemFreeHost. desc. desc.Height = height. desc.FormatFlags = CU_AD_FORMAT_UNSIGNED_INTS. 4x16-bit float16’s: CUDA_ARRAY_DESCRIPTOR desc. desc. • Description for a width x height CUDA array of 16-bit elements. desc.Format = CU_AD_FORMAT_FLOAT. desc.FormatFlags = CU_AD_FORMAT_HALF.NumChannels = 1. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. desc. cuMemset.NumChannels = 2. desc. desc.Height = height. • Description for a 64 x 64 CUDA array of floats: CUDA_ARRAY_DESCRIPTOR desc.Width = width.Width = 2048. asynchronous launches. cuArrayDestroy. cuMemAllocPitch.Width = width. cuArrayGetDescriptor. cuMemGetAddressRange. cuMemFree. SEE ALSO cuMemGetInfo.

Here are examples of CUDA array descriptions: 154 . unsigned int NumChannels. where: • Width. CU_AD_FORMAT_UNSIGNED_INT32 = 0x03. CUarray_format is defined as such: typedef enum CUarray_format_enum { CU_AD_FORMAT_UNSIGNED_INT8 = 0x01.. • Format specifies the format of the elements. CU_AD_FORMAT_SIGNED_INT8 = 0x08. the CUDA array is one-dimensional if height and depth are 0.2.2 cuArray3DCreate NAME cuArray3DCreate . CUarray_format Format. unsigned int Height. const CUDA_ARRAY3D_DESCRIPTOR* desc).creates a CUDA array SYNOPSIS CUresult cuArray3DCreate(CUarray* array. } CUDA_ARRAY3D_DESCRIPTOR. • NumChannels specifies the number of packed components per CUDA array element. CU_AD_FORMAT_FLOAT = 0x20 } CUarray_format. For now. The CUDA_ARRAY3D_DESCRIPTOR structure is defined as such: typedef struct { unsigned int Width. Height and Depth are the width. CU_AD_FORMAT_HALF = 0x10. two-dimensional if depth is 0. • Flags provides for future features.8. it may be 1. CU_AD_FORMAT_UNSIGNED_INT16 = 0x02. DESCRIPTION Creates a CUDA array according to the CUDA_ARRAY3D_DESCRIPTOR structure desc and returns a handle to the new CUDA array in *array. it must be set to 0. unsigned int Flags. CU_AD_FORMAT_SIGNED_INT16 = 0x09. height and depth of the CUDA array (in elements). unsigned int Depth. 2 or 4. CU_AD_FORMAT_SIGNED_INT32 = 0x0a. and threedimensional otherwise.

NumChannels = 4. SEE ALSO cuMemGetInfo.Height = height. • Description for a 64 x 64 CUDA array of floats: CUDA_ARRAY3D_DESCRIPTOR desc.NumChannels = 1.Format = CU_AD_FORMAT_FLOAT. desc. desc. cuMemFreeHost. cuMemAllocPitch. cuMemAllocHost. desc. 4x16-bit float16’s: CUDA_ARRAY_DESCRIPTOR desc. desc. cuMemAlloc.NumChannels = 1. asynchronous launches.Width = 2048. desc.Depth = depth. desc.Depth = 0. cuMemFree. desc. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous.Height = 64.Depth = 0.• Description for a CUDA array of 2048 floats: CUDA_ARRAY3D_DESCRIPTOR desc. cuArrayDestroy 155 . desc. cuMemGetAddressRange. desc. cuArray3DGetDescriptor. desc. desc.FormatFlags = CU_AD_FORMAT_HALF.Height = 0. desc. • Description for a width x height x depth CUDA array of 64-bit. desc.Width = width. desc. desc.Width = 64.Format = CU_AD_FORMAT_FLOAT.

3 cuArrayDestroy NAME cuArrayDestroy . cuMemset. cuMemFreeHost. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_ARRAY_IS_MAPPED Note that this function may also return error codes from previous. cuMemAllocHost. DESCRIPTION Destroys the CUDA array array. cuMemset2D 156 . asynchronous launches. cuMemFree. SEE ALSO cuMemGetInfo. cuMemAllocPitch. cuArrayGetDescriptor.8.2.destroys a CUDA array SYNOPSIS CUresult cuArrayDestroy(CUarray array). cuMemAlloc. cuArrayCreate. cuMemGetAddressRange.

cuArrayDestroy 157 .get a 1D or 2D CUDA array descriptor SYNOPSIS CUresult cuArrayGetDescriptor(CUDA_ARRAY_DESCRIPTOR* arrayDesc. but need to know the CUDA array parameters for validation or other purposes. SEE ALSO cuArrayCreate.4 cuArrayGetDescriptor NAME cuArrayGetDescriptor . cuArray3DGetDescriptor. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous. cuArray3DCreate.8. It is useful for subroutines that have been passed a CUDA array. asynchronous launches. CUarray array) DESCRIPTION Returns in *arrayDesc a descriptor of the format and dimensions of the 1D or 2D CUDA array array.2.

SEE ALSO cuArrayCreate. asynchronous launches. DESCRIPTION Returns in *arrayDesc a descriptor containing information on the format and dimensions of the CUDA array array.2.5 cuArray3DGetDescriptor NAME cuArray3DGetDescriptor .8. cuArray3DCreate. cuArrayDestroy 158 .get a 3D CUDA array descriptor SYNOPSIS CUresult cuArray3DGetDescriptor(CUDA_ARRAY3D_DESC *arrayDesc. but need to know the CUDA array parameters for validation or other purposes. CUarray array). cuArrayGetDescriptor. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous. It is useful for subroutines that have been passed a CUDA array.

asynchronous launches. cuMemAlloc() returns CUDA_ERROR_INVALID_VALUE. cuArrayGetDescriptor. The memory is not cleared. cuMemGetAddressRange. The allocated memory is suitably aligned for any kind of variable.6 cuMemAlloc NAME cuMemAlloc . cuMemset2D 159 . cuArrayDestroy.allocates device memory SYNOPSIS CUresult cuMemAlloc(CUdeviceptr* devPtr. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. cuMemset. SEE ALSO cuMemGetInfo.8. cuMemAllocPitch. cuMemFree. cuArrayCreate.2. unsigned int count). If count is 0. cuMemAllocHost. DESCRIPTION Allocates count bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. cuMemFreeHost.

cuArrayCreate. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous.8. As a result.2. cuMemset. cuMemAllocPitch. cuMemFreeHost. this function is best used sparingly to allocate staging areas for data exchange between host and device. asynchronous launches. SEE ALSO cuMemGetInfo. cuMemFree.7 cuMemAllocHost NAME cuMemAllocHost . cuArrayDestroy. unsigned int count). cuMemset2D 160 . it can be read or written with much higher bandwidth than pageable memory obtained with functions such as malloc().allocates page-locked host memory SYNOPSIS CUresult cuMemAllocHost(void** hostPtr. The driver tracks the virtual memory ranges allocated with this function and automatically accelerates calls to functions such as cuMemcpy(). cuArrayGetDescriptor. cuMemAlloc. cuMemGetAddressRange. DESCRIPTION Allocates count bytes of host memory that is page-locked and accessible to the device. Allocating excessive amounts of memory with cuMemAllocHost() may degrade system performance. since it reduces the amount of memory available to the system for paging. Since the memory can be accessed directly by the device.

the kernel will run correctly. this is especially true if the application will be performing 2D memory copies between different regions of device memory (whether linear memory or CUDA arrays). The intended usage of pitch is as a separate parameter of the allocation. 8 or 16 (since coalesced memory transactions are not possible on other data sizes).2. Due to alignment restrictions in the hardware. For allocations of 2D arrays. but possibly at reduced speed. 161 . unsigned int elementSizeBytes). it is recommended that programmers consider performing pitch allocations using cuMemAllocPitch(). DESCRIPTION Allocates at least widthInBytes*height bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. If elementSizeBytes is smaller than the actual read/write size of a kernel. Given the row and column of an array element of type T. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. asynchronous launches. the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * Pitch) + Column.8. The pitch returned in *pitch by cuMemAllocPitch() is the width in bytes of the allocation. used to compute addresses within the 2D array. The pitch returned by cuMemAllocPitch() is guaranteed to work with cuMemcpy2D() under all circumstances. elementSizeBytes may be 4. unsigned int* pitch. elementSizeBytes specifies the size of the largest reads and writes that will be performed on the memory range.allocates device memory SYNOPSIS CUresult cuMemAllocPitch(CUdeviceptr* devPtr.8 cuMemAllocPitch NAME cuMemAllocPitch . The function may pad the allocation to ensure that corresponding pointers in any given row will continue to meet the alignment requirements for coalescing as the address is updated from row to row. unsigned int widthInBytes. unsigned int height.

cuArrayCreate. cuArrayGetDescriptor. cuMemset. cuMemAlloc.SEE ALSO cuMemGetInfo. cuMemGetAddressRange. cuMemFreeHost. cuMemFree. cuMemset2D 162 . cuMemAllocHost. cuArrayDestroy.

cuMemAlloc. cuMemset. SEE ALSO cuMemGetInfo. cuMemAllocHost. cuMemGetAddressRange. cuMemFreeHost.8. cuMemAllocPitch. which must have been returned by a previous call to cuMemMalloc() or cuMemMallocPitch(). cuArrayGetDescriptor.9 cuMemFree NAME cuMemFree . asynchronous launches. DESCRIPTION Frees the memory space pointed to by devPtr. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.2. cuArrayCreate. cuArrayDestroy. cuMemset2D 163 .frees device memory SYNOPSIS CUresult cuMemFree(CUdeviceptr devPtr).

cuArrayGetDescriptor.frees page-locked host memory SYNOPSIS CUresult cuMemFreeHost(void* hostPtr). cuMemset2D 164 . asynchronous launches. cuMemGetAddressRange.10 cuMemFreeHost NAME cuMemFreeHost . SEE ALSO cuMemGetInfo. cuMemset.8. cuArrayDestroy. cuMemFree. DESCRIPTION Frees the memory space pointed to by hostPtr. cuArrayCreate.2. which must have been returned by a previous call to cuMemAllocHost(). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemAllocPitch. cuMemAlloc. cuMemAllocHost.

get information on memory allocations SYNOPSIS CUresult cuMemGetAddressRange(CUdeviceptr* basePtr. cuMemFree. cuMemAllocHost. SEE ALSO cuMemGetInfo. cuMemAllocPitch. cuMemAlloc. cuArrayCreate.11 cuMemGetAddressRange NAME cuMemGetAddressRange . cuArrayGetDescriptor. Both parameters basePtr and size are optional.8. cuMemset. cuMemset2D 165 . CUdeviceptr devPtr). DESCRIPTION Returns the base address in *basePtr and size and *size of the allocation by cuMemAlloc() or cuMemAllocPitch() that contains the input pointer devPtr. asynchronous launches. it is ignored. If one of them is null. unsigned int* size. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuArrayDestroy.2. cuMemFreeHost.

in bytes. cuMemFree. cuMemGetAddressRange. cuArrayGetDescriptor. cuArrayDestroy.gets free and total memory SYNOPSIS CUresult cuMemGetInfo(unsigned int* free.8. cuMemset. SEE ALSO cuMemAlloc.12 cuMemGetInfo NAME cuMemGetInfo . cuMemAllocHost. cuArrayCreate. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. asynchronous launches. DESCRIPTION Returns in *free and *total respectively.2. cuMemFreeHost. the free and total amount of memory available for allocation by the CUDA context. unsigned int* total). cuMemAllocPitch. cuMemset2D 166 .

CUresult cuMemcpy2DAsync(const CUDA_MEMCPY2D* copyParam. unsigned int dstXInBytes. CUdeviceptr srcDevice. unsigned int Height. CUdeviceptr dstDevice. 167 . If srcMemoryType is CU_MEMORYTYPE_DEVICE. CUmemorytype dstMemoryType. DESCRIPTION Perform a 2D memory copy according to the parameters specified in copyParam. void *dstHost. srcY. CUresult cuMemcpy2DUnaligned(const CUDA_MEMCPY2D* copyParam). unsigned int dstPitch. CU_MEMORYTYPE_ARRAY = 0x03 } CUmemorytype. dstY. } CUDA_MEMCPY2D. const void *srcHost.2. where: • srcMemoryType and dstMemoryType specify the type of memory of the source and destination. If srcMemoryType is CU_MEMORYTYPE_HOST.8. CUarray dstArray. respectively. srcHost and srcPitch specify the (host) base address of the source data and the bytes per row to apply. srcArray is ignored. CUarray srcArray. The CUDA_MEMCPY2D structure is defined as such: typedef struct CUDA_MEMCPY2D_st { unsigned int srcXInBytes. CUmemorytype_enum is defined as such: typedef enum CUmemorytype_enum { CU_MEMORYTYPE_HOST = 0x01. unsigned int srcPitch.copies memory for 2D arrays SYNOPSIS CUresult cuMemcpy2D(const CUDA_MEMCPY2D* copyParam).13 cuMemcpy2D NAME cuMemcpy2D . srcArray is ignored. unsigned int WidthInBytes. CU_MEMORYTYPE_DEVICE = 0x02. srcDevice and srcPitch specify the (device) base address of the source data and the bytes per row to apply. CUstream stream). CUmemorytype srcMemoryType.

If dstMemoryType is CU_MEMORYTYPE_ARRAY. dstHost and dstPitch specify the (host) base address of the destination data and the bytes per row to apply. On intra-device memory copies (device ? device. For host pointers. For device pointers. srcArray specifies the handle of the source data. but may run significantly slower in the cases where cuMemcpy2D() would have returned an error code. srcHost. CUDA array ? CUDA array). • dstXInBytes and dstY specify the base address of the destination data for the copy. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. For CUDA arrays. the base address is void* dstStart = (void*)((char*)dstHost+dstY*dstPitch + dstXInBytes). the starting address is void* Start = (void*)((char*)srcHost+srcY*srcPitch + srcXInBytes). If dstMemoryType is CU_MEMORYTYPE_HOST. cuMemcpy2DUnaligned() does not have this restriction. Any pitches must be greater than or equal to WidthInBytes. For host pointers. dstHost. cuMemcpy2D() may fail for pitches not computed by cuMemAllocPitch(). CUDA array ? device. srcXInBytes must be evenly divisible by the array element size.If srcMemoryType is CU_MEMORYTYPE_ARRAY. the starting address is CUdeviceptr dstStart = dstDevice+dstY*dstPitch+dstXInBytes. dstArray specifies the handle of the destination data. For CUDA arrays. dstDevice and dstPitch specify the (device) base address of the destination data and the bytes per row to apply. dstArray is ignored. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED 168 . dstDevice and dstPitch are ignored. cuMemcpy2DAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. srcDevice and srcPitch are ignored. • WidthInBytes and Height specify the width (in bytes) and height of the 2D copy being performed. the starting address is CUdeviceptr Start = srcDevice+srcY*srcPitch+srcXInBytes. For device pointers. dstArray is ignored. cuMemcpy2D() returns an error if any pitch is greater than the maximum allowed (CU_DEVICE_ATTRIBUTE_ cuMemAllocPitch() passes back pitches that always work with cuMemcpy2D(). If dstMemoryType is CU_MEMORYTYPE_DEVICE. • srcXInBytes and srcY specify the base address of the source data for the copy. dstXInBytes must be evenly divisible by the array element size.

asynchronous launches. cuMemcpyAtoA. cuMemcpyAtoH. cuMemcpyDtoA.CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemcpyDtoD. cuMemcpy3D 169 . cuMemcpyHtoA. SEE ALSO cuMemcpyHtoD. cuMemcpyDtoH. cuMemcpyAtoD.

srcY. unsigned int Height. unsigned int srcLOD. where: • srcMemoryType and dstMemoryType specify the type of memory of the source and destination. CUdeviceptr dstDevice. const void *srcHost. The CUDA_MEMCPY3D structure is defined as such: typedef struct CUDA_MEMCPY3D_st { unsigned int srcXInBytes. CUdeviceptr srcDevice. dstZ. CUresult cuMemcpy3DAsync(const CUDA_MEMCPY3D* copyParam. // ignored when src is array unsigned int srcHeight. CUmemorytype dstMemoryType. CUarray dstArray. unsigned int srcPitch. DESCRIPTION Perform a 3D memory copy according to the parameters specified in copyParam. dstY. // ignored when src is array.copies memory for 3D arrays SYNOPSIS CUresult cuMemcpy3D(const CUDA_MEMCPY3D* copyParam). may be 0 if Depth==1 unsigned int dstXInBytes. unsigned int dstLOD. unsigned int dstPitch.14 cuMemcpy3D NAME cuMemcpy3D . // ignored when dst is array. // ignored when dst is array unsigned int dstHeight. may be 0 if Depth==1 unsigned int WidthInBytes. CUmemorytype srcMemoryType. CUarray srcArray. srcZ. } CUDA_MEMCPY3D. CUresult CUDAAPI cuMemcpy3D( const CUDA_MEMCPY3D *pCopy ). unsigned int Depth. CUmemorytype_enum is defined as such: typedef enum CUmemorytype_enum { 170 . respectively.8.2. void *dstHost. CUstream stream).

171 cuMemcpy3D() returns an error if any pitch is greater than the maximum allowed (CU_DEVICE_ATTRIBUTE_ . the bytes per row. If srcMemoryType is CU_MEMORYTYPE_HOST. dstArray is ignored. the bytes per row. dstHost and dstPitch specify the (host) base address of the destination data. If dstMemoryType is CU_MEMORYTYPE_HOST. For CUDA arrays. dstHost. srcY and srcZ specify the base address of the source data for the copy. srcPitch and srcHeight specify the (device) base address of the source data. the bytes per row. and the height of each 2D slice of the 3D array. dstDevice. For host pointers. Height and Depth specify the width (in bytes). srcPitch and srcHeight are ignored. the starting address is void* Start = (void*)((char*)srcHost+(srcZ*srcHeight+srcY)*srcPitch + srcXInBytes). For device pointers. For device pointers. srcDevice. dstPitch and dstHeight are ignored. • dstXInBytes. srcArray specifies the handle of the source data. height and depth of the 3D copy being performed. srcHost. and the height of each 2D slice of the 3D array. If dstMemoryType is CU_MEMORYTYPE_ARRAY. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. cuMemcpy3DAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument.CU_MEMORYTYPE_HOST = 0x01. For CUDA arrays. the starting address is CUdeviceptr dstStart = dstDevice+(dstZ*dstHeight+dstY)*dstPitch+dstXInBytes. and the height of each 2D slice of the 3D array. For host pointers. If dstMemoryType is CU_MEMORYTYPE_DEVICE. srcPitch and srcHeight specify the (host) base address of the source data. dstArray is ignored. the bytes per row. srcArray is ignored. the base address is void* dstStart = (void*)((char*)dstHost+(dstZ*dstHeight+dstY)*dstPitch + dstXInBytes). dstXInBytes must be evenly divisible by the array element size. If srcMemoryType is CU_MEMORYTYPE_DEVICE. srcXInBytes must be evenly divisible by the array element size. srcArray is ignored. • srcXInBytes. If srcMemoryType is CU_MEMORYTYPE_ARRAY. and the height of each 2D slice of the 3D array. CU_MEMORYTYPE_ARRAY = 0x03 } CUmemorytype. srcDevice. Any pitches must be greater than or equal to WidthInBytes. the starting address is CUdeviceptr Start = srcDevice+(srcZ*srcHeight+srcY)*srcPitch+srcXInBytes. • WidthInBytes. dstDevice and dstPitch specify the (device) base address of the destination data. dstY and dstZ specify the base address of the destination data for the copy. dstArray specifies the handle of the destination data. srcHost. The srcLOD and dstLOD members of the CUDA_MEMCPY3D structure must be set to 0. CU_MEMORYTYPE_DEVICE = 0x02.

cuMemcpyDtoA. cuMemcpy2D. cuMemcpyAtoD. cuMemcpyDtoH. cuMemcpyAtoH.RETURN VALUE CUDA_SUCCESS SEE ALSO cuMemcpyHtoD. cuMemcpyAtoA. cuMemcpyDtoD. cuMemcpyHtoA. cuMemcpy2DAsync 172 .

SEE ALSO cuMemcpyHtoD. dstArray and srcArray specify the handles of the destination and source CUDA arrays for the copy. cuMemcpyDtoA.8. and count must be evenly divisible by that size. dstIndex and srcIndex specify the destination and source indices into the CUDA array. cuMemcpyDtoD. cuMemcpyHtoA. but the elements must be the same size. The size of the elements in the CUDA arrays need not be the same format.2. CUarray srcArray. unsigned int count). unsigned int dstIndex. asynchronous launches. cuMemcpyDtoH. unsigned int srcIndex. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.15 cuMemcpyAtoA NAME cuMemcpyAtoA . cuMemcpyAtoH.copies memory from Array to Array SYNOPSIS CUresult cuMemcpyAtoA(CUarray dstArray. cuMemcpy2D 173 . Width-1] for the CUDA array. These values are in the range [0. respectively. DESCRIPTION Copies from one 1D CUDA array to another. they are not byte offsets. count is the number of bytes to be copied. cuMemcpyAtoD.

SEE ALSO cuMemcpyHtoD. dstDevPtr specifies the base pointer of the destination and must be naturally aligned with the CUDA array elements. unsigned int srcIndex.8. unsigned int count). cuMemcpyHtoA. count specifies the number of bytes to copy and must be evenly divisible by the array element size. cuMemcpyDtoA.copies memory from Array to Device SYNOPSIS CUresult cuMemcpyAtoD(CUdeviceptr dstDevPtr.16 cuMemcpyAtoD NAME cuMemcpyAtoD . asynchronous launches.2. cuMemcpyDtoH. cuMemcpy2D 174 . cuMemcpyDtoD. cuMemcpyAtoA. srcArray and srcIndex specify the CUDA array handle and the index (in array elements) of the array element where the copy is to begin. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. DESCRIPTION Copies from a 1D CUDA array to device memory. CUarray srcArray. cuMemcpyAtoH.

CUresult cuMemcpyAtoHAsync(void* dstHostPtr.8. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemcpyHtoA. count specifies the number of bytes to copy. cuMemcpyAtoHAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. CUarray srcArray.2. srcArray and srcIndex specify the CUDA array handle and starting index of the source data. unsigned int count. unsigned int srcIndex. SEE ALSO cuMemcpyHtoD. cuMemcpyAtoA. cuMemcpyDtoD. DESCRIPTION Copies from a 1D CUDA array to host memory. cuMemcpyDtoH. cuMemcpyAtoD. CUstream stream).copies memory from Array to Host SYNOPSIS CUresult cuMemcpyAtoH(void* dstHostPtr. asynchronous launches.17 cuMemcpyAtoH NAME cuMempcyAtoH . CUarray srcArray. dstHostPtr specifies the base pointer of the destination. unsigned int count). cuMemcpy2D 175 . It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. cuMemcpyDtoA. unsigned int srcIndex.

CUdeviceptr srcDevPtr.18 cuMemcpyDtoA NAME cuMemcpyDtoA .8. asynchronous launches. DESCRIPTION Copies from device memory to a 1D CUDA array. cuMemcpyDtoH. unsigned int count). cuMemcpyAtoA. cuMemcpy2D 176 . dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. srcDevPtr specifies the base pointer of the source. cuMemcpyDtoD. cuMemcpyHtoA.copies memory from Device to Array SYNOPSIS CUresult cuMemcpyDtoA(CUarray dstArray. cuMemcpyAtoH.2. count specifies the number of bytes to copy. SEE ALSO cuMemcpyHtoD. unsigned int dstIndex. cuMemcpyAtoD. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

asynchronous launches. DESCRIPTION Copies from device memory to device memory.19 cuMemcpyDtoD NAME cuMemcpyDtoD .2. cuMemcpyDtoH. cuMemcpyDtoA. count specifies the number of bytes to copy. CUdeviceptr srcDevPtr. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.8. unsigned int count). SEE ALSO cuMemcpyHtoD. cuMemcpyAtoD. cuMemcpy2D 177 .copies memory from Device to Device SYNOPSIS CUresult cuMemcpyDtoD(CUdeviceptr dstDevPtr. cuMemcpyAtoA. respectively. cuMemcpyAtoH. dstDevice and srcDevPtr are the base pointers of the destination and source. cuMemcpyHtoA.

unsigned int count). countspecifies the number of bytes to copy. asynchronous launches. CUstream stream). cuMemcpy2D 178 . CUdeviceptr srcDevPtr. unsigned int count. cuMemcpyAtoD. cuMemcpyHtoA. dstHostPtr and srcDevPtrspecify the base addresses of the source and destination. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. cuMemcpyDtoA. cuMemcpyAtoA. CUdeviceptr srcDevPtr. MemcpyDtoHAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. cuMemcpyAtoH.8. CUresult cuMemcpyDtoHAsync(void* dstHostPtr.20 cuMemcpyDtoH NAME cuMemcpyDtoH . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemcpyDtoD.copies memory from Device to Host SYNOPSIS CUresult cuMemcpyDtoH(void* dstHostPtr.2. SEE ALSO cuMemcpyHtoD. DESCRIPTION Copies from device to host memory. respectively.

cuMemcpyDtoD. cuMemcpyAtoH. const void *srcHostPtr.8. count specifies the number of bytes to copy. cuMemcpyAtoD. unsigned int count).21 cuMemcpyHtoA NAME cuMemcpyHtoA .copies memory from Host to Array SYNOPSIS CUresult cuMemcpyHtoA(CUarray dstArray. SEE ALSO cuMemcpyHtoD. unsigned int count. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. asynchronous launches. unsigned int dstIndex. dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. cuMemcpyAtoA. const void *srcHostPtr. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. srcHostPtr specify the base addresse of the source. CUstream stream). cuMemcpyDtoH. cuMemcpy2D 179 . DESCRIPTION Copies from host memory to a 1D CUDA array. cuMemcpyHtoAAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. unsigned int dstIndex. CUresult cuMemcpyHtoAAsync(CUarray dstArray.2. cuMemcpyDtoA.

cuMemcpyAtoD.22 cuMemcpyHtoD NAME cuMemcpyHtoD . dstDevPtr and srcHostPtr specify the base addresses of the destination and source. unsigned int count). DESCRIPTION Copies from host memory to device memory.copy memory from Host to Device SYNOPSIS CUresult cuMemcpyHtoD(CUdeviceptr dstDevPtr. unsigned int count. SEE ALSO cuMemcpyDtoH. cuMemcpyDtoA. cuMemcpyHtoA. const void *srcHostPtr. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. CUresult cuMemcpyHtoDAsync(CUdeviceptr dstDevPtr. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemcpyHtoDAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. cuMemcpyAtoA. CUstream stream).2. respectively. cuMemcpy2D 180 . const void *srcHostPtr. asynchronous launches. count specifies the number of bytes to copy. cuMemcpyAtoH.8. cuMemcpyDtoD.

CUresult cuMemsetD32(CUdeviceptr dstDevPtr. DESCRIPTION Sets the memory range of count 8-. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuMemGetAddressRange. cuArrayCreate. unsigned int value. unsigned int count ). cuMemAllocPitch. cuMemAlloc.23 cuMemset NAME cuMemset . CUresult cuMemsetD16(CUdeviceptr dstDevPtr. unsigned int count ). cuMemFreeHost. cuMemAllocHost. asynchronous launches. cuArrayGetDescriptor. unsigned short value. unsigned char value. or 32-bit values to the specified value value.initializes device memory SYNOPSIS CUresult cuMemsetD8(CUdeviceptr dstDevPtr. 16-. cuMemset2D 181 . SEE ALSO cuMemGetInfo. cuMemFree. cuArrayDestroy.2. unsigned int count ).8.

unsigned int height ). unsigned int dstPitch. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. unsigned int dstPitch. asynchronous launches. cuArrayCreate. unsigned short value. unsigned int width.8. or 32-bit values to the specified value value. CUresult cuMemsetD2D16(CUdeviceptr dstDevPtr.2.initializes device memory SYNOPSIS CUresult cuMemsetD2D8(CUdeviceptr dstDevPtr. unsigned int dstPitch.24 cuMemset2D NAME cuMemset2D . cuMemFree. unsigned char value. cuMemAllocHost. DESCRIPTION Sets the 2D memory range of width 8-. These functions perform fastest when the pitch is one that has been passed back by cuMemAllocPitch(). CUresult cuMemsetD2D32(CUdeviceptr dstDevPtr. unsigned int height ). height specifies the number of rows to set. unsigned int height ). cuMemAllocPitch. and dstPitch specifies the number of bytes between each row. cuArrayGetDescriptor. cuArrayDestroy. cuMemFreeHost. cuMemGetAddressRange. SEE ALSO cuMemGetInfo. unsigned int width. cuMemAlloc. 16-. unsigned int width. unsigned int value. cuMemset 182 .

EventManagement. MemoryManagement. OpenGlInteroperability. StreamManagement. ContextManagement.9 TextureReferenceManagement NAME Texture Reference Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. DeviceManagement. ExecutionControl. cuTexRefCreate cuTexRefDestroy cuTexRefGetAddress cuTexRefGetAddressMode cuTexRefGetArray cuTexRefGetFilterMode cuTexRefGetFlags cuTexRefGetFormat cuTexRefSetAddress cuTexRefSetAddressMode cuTexRefSetArray cuTexRefSetFilterMode cuTexRefSetFlags cuTexRefSetFormat SEE ALSO Initialization. ModuleManagement. TextureReferenceManagement.2. Direct3dInteroperability 183 .

1 cuTexRefCreate NAME cuTexRefCreate .2. cuTexRefSetFlags. etc. cuTexRefSetAddressMode. DESCRIPTION Creates a texture reference and returns its handle in *texRef. To associate the texture reference with a texture ordinal for a given function. the application should call cuParamSetTexRef().) to be used when the memory is read through this texture reference. cuTexRefGetAddress. cuTexRefSetAddress. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.creates a texture-reference SYNOPSIS CUresult cuTexRefCreate(CUtexref* texRef). SEE ALSO cuTexRefDestroy. cuTexRefGetArray. cuTexRefGetFlags 184 . cuTexRefGetFilterMode. filtering. cuTexRefSetFormat. cuTexRefSetArray. cuTexRefGetFormat. Once created. the application must call cuTexRefSetArray() or cuTexRefSetAddress() to associate the reference with allocated memory. cuTexRefGetAddressMode. cuTexRefSetFilterMode. asynchronous launches. Other texture reference functions are used to specify the format and interpretation (addressing.9.

cuTexRefGetFilterMode.2. cuTexRefSetAddress.2 cuTexRefDestroy NAME cuTexRefDestroy . cuTexRefGetAddress.9. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. DESCRIPTION Destroys the texture reference. cuTexRefGetFlags 185 . cuTexRefSetFilterMode. SEE ALSO cuTexRefCreate. cuTexRefGetArray.destroys a texture-reference SYNOPSIS CUresult cuTexRefDestroy(CUtexref texRef). cuTexRefSetArray. cuTexRefGetAddressMode. cuTexRefSetAddressMode. cuTexRefGetFormat. cuTexRefSetFlags. asynchronous launches. cuTexRefSetFormat.

cuTexRefSetAddressMode. cuTexRefSetFlags.2. cuTexRefGetFlags 186 . cuTexRefGetArray. DESCRIPTION Returns in *devPtr the base address bound to the texture reference texRef. cuTexRefSetArray.9. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefGetAddressMode. cuTexRefGetFilterMode. cuTexRefSetAddress. SEE ALSO cuTexRefCreate. cuTexRefGetFormat. CUtexref texRef). asynchronous launches.3 cuTexRefGetAddress NAME cuTexRefGetAddress . cuTexRefSetFilterMode. or returns CUDA_ERROR_INVALID_VA if the texture reference is not bound to any device memory range.gets the address associated with a texture-reference SYNOPSIS CUresult cuTexRefGetAddress(CUdeviceptr* devPtr. cuTexRefSetFormat. cuTexRefDestroy.

9. int dim). cuTexRefGetArray. cuTexRefGetFlags 187 . Currently the only valid values for dim are 0 and 1. cuTexRefSetFlags. cuTexRefSetAddress. cuTexRefGetAddress.4 cuTexRefGetAddressMode NAME cuTexRefGetAddressMode . cuTexRefSetFilterMode. cuTexRefSetAddressMode. CUtexref texRef. cuTexRefDestroy. cuTexRefGetFormat. cuTexRefSetFormat. cuTexRefGetFilterMode. DESCRIPTION Returns in *mode the addressing mode corresponding to the dimension dim of the texture reference texRef. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetArray. SEE ALSO cuTexRefCreate.2. asynchronous launches.gets the addressing mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetAddressMode(CUaddress_mode* mode.

cuTexRefSetAddress. cuTexRefSetArray. or returns CUDA_ERROR_INVALID_VAL if the texture reference is not bound to any CUDA array. cuTexRefGetFormat.9. cuTexRefGetFlags 188 .gets the array bound to a texture-reference SYNOPSIS CUresult cuTexRefGetArray(CUarray* array. cuTexRefGetAddressMode. cuTexRefSetFlags. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefGetFilterMode. SEE ALSO cuTexRefCreate. cuTexRefGetAddress. cuTexRefSetAddressMode.2. DESCRIPTION Returns in *array the CUDA array bound by the texture reference texRef. cuTexRefSetFormat. asynchronous launches. CUtexref texRef).5 cuTexRefGetArray NAME cuTexRefGetArray . cuTexRefSetFilterMode. cuTexRefDestroy.

2. cuTexRefSetArray. cuTexRefGetFormat. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefGetAddress.gets the filter-mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetFilterMode(CUfilter_mode* mode. cuTexRefSetFlags. cuTexRefSetFilterMode. SEE ALSO cuTexRefCreate. cuTexRefGetAddressMode. cuTexRefSetAddressMode. CUtexref texRef). cuTexRefSetFormat. cuTexRefGetArray.6 cuTexRefGetFilterMode NAME cuTexRefGetFilterMode .9. asynchronous launches. cuTexRefSetAddress. DESCRIPTION Returns in *mode the filtering mode of the texture reference texRef. cuTexRefDestroy. cuTexRefGetFlags 189 .

cuTexRefGetArray.gets the flags used by a texture-reference SYNOPSIS CUresult cuTexRefGetFlags(unsigned int* flags. CUtexref texRef). cuTexRefSetFilterMode.2. cuTexRefSetAddressMode. cuTexRefSetFormat. cuTexRefGetAddress. cuTexRefSetArray. asynchronous launches. cuTexRefGetFilterMode.9. DESCRIPTION Returns in *flags the flags of the texture reference texRef. cuTexRefGetAddressMode. cuTexRefGetFormat 190 . cuTexRefDestroy.7 cuTexRefGetFlags NAME cuTexRefGetFlags . SEE ALSO cuTexRefCreate. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetFlags. cuTexRefSetAddress.

gets the format used by a texture-reference SYNOPSIS CUresult cuTexRefGetFormat(CUarray_format* format. cuTexRefGetAddress. cuTexRefDestroy. cuTexRefSetFormat. int* numPackedComponents. cuTexRefSetFilterMode.8 cuTexRefGetFormat NAME cuTexRefGetFormat . cuTexRefSetFlags. cuTexRefSetAddressMode. CUtexref texRef). DESCRIPTION Returns in *format and *numPackedComponents the format and number of components of the CUDA array bound to the texture reference texRef. it will be ignored. cuTexRefSetAddress. cuTexRefGetFilterMode. cuTexRefGetArray. asynchronous launches. cuTexRefSetArray. If format or numPackedComponents is null. cuTexRefGetAddressMode.9. cuTexRefGetFlags 191 . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. SEE ALSO cuTexRefCreate.2.

Any memory previously bound to texRef is unbound. cuTexRefGetFormat. cuTexRefSetFilterMode. asynchronous launches. cuTexRefSetArray. DESCRIPTION Binds a linear address range to the texture reference texRef. cuTexRefSetFormat.9 cuTexRefSetAddress NAME cuTexRefSetAddress . Any previous address or CUDA array state associated with the texture reference is superseded by this function.2.9. Since the hardware enforces an alignment requirement on texture base addresses. cuTexRefGetArray. cuTexRefDestroy. CUtexref texRef. cuTexRefSetAddressMode. cuTexRefGetFilterMode. int bytes). cuTexRefGetAddressMode. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. CUdeviceptr devPtr. cuTexRefGetAddress. cuTexRefSetAddress() passes back a byte offset in *byteOffset that must be applied to texture fetches in order to read from the desired memory.binds an address as a texture-reference SYNOPSIS CUresult cuTexRefSetAddress(unsigned int* byteOffset. SEE ALSO cuTexRefCreate. cuTexRefGetFlags 192 . cuTexRefSetFlags. the offset is guaranteed to be 0 and NULL may be passed as the ByteOffset parameter. If the device memory pointer was returned from cuMemAlloc(). This offset must be divided by the texel size and passed to kernels that read from the texture so they can be applied to the tex1Dfetch() function.

cuTexRefGetAddressMode. cuTexRefSetFlags. asynchronous launches. CU_TR_ADDRESS_MODE_MIRROR = 2. DESCRIPTION Specifies the addressing mode mode for the given dimension of the texture reference texRef. cuTexRefGetArray. cuTexRefSetFormat.10 cuTexRefSetAddressMode NAME cuTexRefSetAddressMode .2. int dim. cuTexRefGetFormat. the addressing mode is applied to the first parameter of the functions used to fetch from the texture. If dim is zero. SEE ALSO cuTexRefCreate. CUaddress_mode mode). and so on. CUaddress_mode is defined as such: typedef enum CUaddress_mode_enum { CU_TR_ADDRESS_MODE_WRAP = 0. CU_TR_ADDRESS_MODE_CLAMP = 1. cuTexRefSetFilterMode.set the addressing mode for a texture-reference SYNOPSIS CUresult cuTexRefSetAddressMode(CUtexref texRef. cuTexRefSetAddress. if dim is 1. cuTexRefGetAddress. } CUaddress_mode. cuTexRefGetFlags 193 . cuTexRefDestroy. cuTexRefGetFilterMode. cuTexRefSetArray.9. Note that this call has no effect if texRef is bound to linear memory. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. the second.

CUarray array. cuTexRefGetFlags 194 . flags must be set to CU_TRSA_OVERRIDE_FORMAT. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. SEE ALSO cuTexRefCreate. cuTexRefGetAddress. cuTexRefSetFlags. cuTexRefGetAddressMode. cuTexRefDestroy. cuTexRefGetArray.binds an array to a texture-reference SYNOPSIS CUresult cuTexRefSetArray(CUtexref texRef. cuTexRefSetAddressMode. cuTexRefSetFilterMode. cuTexRefGetFormat. Any previous address or CUDA array state associated with the texture reference is superseded by this function. cuTexRefGetFilterMode. cuTexRefSetAddress.2. DESCRIPTION Binds the CUDA array array to the texture reference texRef. unsigned int flags). Any CUDA array previously bound to texRef is unbound. asynchronous launches. cuTexRefSetFormat.9.11 cuTexRefSetArray NAME cuTexRefSetArray .

cuTexRefSetFormat. cuTexRefDestroy.sets the mode for a texture-reference SYNOPSIS CUresult cuTexRefSetFilterMode(CUtexref texRef.12 cuTexRefSetFilterMode NAME cuTexRefSetFilterMode . cuTexRefGetFormat. cuTexRefSetAddressMode.9. cuTexRefGetAddressMode. cuTexRefGetFlags 195 . cuTexRefSetFlags. CUfilter_mode_enum is defined as such: typedef enum CUfilter_mode_enum { CU_TR_FILTER_MODE_POINT = 0. cuTexRefGetAddress. SEE ALSO cuTexRefCreate. Note that this call has no effect if texRef is bound to linear memory. cuTexRefGetFilterMode. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetArray. cuTexRefSetAddress. cuTexRefGetArray. asynchronous launches. CUfilter_mode mode).2. CU_TR_FILTER_MODE_LINEAR = 1 } CUfilter_mode. DESCRIPTION Specifies the filtering mode mode to be used when reading memory through the texture reference texRef.

cuTexRefSetAddress. cuTexRefDestroy. asynchronous launches. cuTexRefGetAddressMode.0) reference the entire breadth of the array dimension RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. the texture coordinates [0. Instead. cuTexRefSetAddressMode. 1. cuTexRefGetFlags 196 . 1]. cuTexRefGetFormat. cuTexRefGetAddress. The valid flags are: • CU_TRSF_READ_AS_INTEGER. Dim) where Dim is the width or height of the CUDA array. • CU_TRSF_NORMALIZED_COORDINATES.13 cuTexRefSetFlags NAME cuTexRefSetFlags . cuTexRefGetFilterMode.sets flags for a texture-reference SYNOPSIS CUresult cuTexRefSetFlags(CUtexref texRef. cuTexRefSetFilterMode. cuTexRefSetFormat.2.9. DESCRIPTION Specifies optional flags to control the behavior of data returned through the texture reference. unsigned int Flags). cuTexRefSetArray. SEE ALSO cuTexRefCreate. cuTexRefGetArray. which suppresses the default behavior of having the texture promote integer data to floating point data in the range [0. which suppresses the default behavior of having the texture coordinates range from [0.

CUarray_format format. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. cuTexRefSetAddress. asynchronous launches. cuTexRefGetFormat. cuTexRefGetAddressMode. cuTexRefGetFlags 197 . int numPackedComponents) DESCRIPTION Specifies the format of the data to be read by the texture reference texRef.14 cuTexRefSetFormat NAME cuTexRefSetFormat . cuTexRefSetFlags.sets the format for a texture-reference SYNOPSIS CUresult cuTexRefSetFormat(CUtexref texRef. cuTexRefGetAddress. format and numPackedComponents are exactly analogous to the Format and NumChannels members of the CUDA_ARRAY_DESCRIPTOR structure: They specify the format of each component and the number of components per array element. cuTexRefGetFilterMode. SEE ALSO cuTexRefCreate. cuTexRefSetArray. cuTexRefGetArray. cuTexRefSetFilterMode. cuTexRefDestroy.9.2. cuTexRefSetAddressMode.

2. MemoryManagement. cuGLCtxCreate cuGLInit cuGLMapBufferObject cuGLRegisterBufferObject cuGLUnmapBufferObject cuGLUnregisterBufferObject SEE ALSO Initialization. TextureReferenceManagement. OpenGLInteroperability. EventManagement. DeviceManagement. ExecutionControl. ModuleManagement. StreamManagement. Direct3dInteroperability 198 .10 OpenGlInteroperability NAME OpenGL Interoperability DESCRIPTION This section describes the low-level CUDA driver application programming interface. ContextManagement.

see cuCtxCreate.create a CUDA context for interoperability with OpenGL SYNOPSIS CUresult cuGLCtxCreate(CUcontext *pCtx. cuGLUnregisterBufferObject 199 . cuGLMapBufferObject.10. asynchronous launches. initializes OpenGL interoperability. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY Note that this function may also return error codes from previous. It may fail if the needed OpenGL driver facilities are not available.2. DESCRIPTION Creates a new CUDA context. It must be called before performing any other OpenGL interoperability operations. cuGLUnmapBufferObject. and associates the CUDA context with the calling thread. For usage of the Flags parameter.1 cuGLCtxCreate NAME cuGLCtxCreate . unsigned int Flags. CUdevice device). cuGLInit cuGLRegisterBufferObject. SEE ALSO cuCtxCreate.

cuGLRegisterBufferObject. It must be called before performing any other OpenGL interoperability operations. cuGLUnregisterBufferObject 200 . DESCRIPTION Initializes OpenGL interoperability.2 cuGLInit NAME cuGLInit . asynchronous launches.10.2. cuGLMapBufferObject. cuGLUnmapBufferObject.initializes GL interoperability SYNOPSIS CUresult cuGLInit(void). RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. SEE ALSO cuGLCtxCreate. It may fail if the needed OpenGL driver facilities are not available.

cuGLRegisterBufferObject.10. cuGLUnmapBufferObject. SEE ALSO cuGLCtxCreate. DESCRIPTION Maps the buffer object of ID bufferObj into the address space of the current CUDA context and returns in *devPtr and *size the base pointer and size of the resulting mapping. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_MAP_FAILED Note that this function may also return error codes from previous.maps a GL buffer object SYNOPSIS CUresult cuGLMapBufferObject(CUdeviceptr* devPtr.3 cuGLMapBufferObject NAME cuGLMapBufferObject . GLuint bufferObj). unsigned int* size.2. cuGLInit. asynchronous launches. cuGLUnregisterBufferObject 201 .

cuGLInit.4 cuGLRegisterBufferObject NAME cuGLRegisterBufferObject . This function must be called before CUDA can map the buffer object.2.registers a GL buffer object SYNOPSIS CUresult cuGLRegisterBufferObject(GLuint bufferObj). While it is registered. cuGLUnmapBufferObject.10. the buffer object cannot be used by any OpenGL commands except as a data source for OpenGL drawing commands. cuGLMapBufferObject. DESCRIPTION Registers the buffer object of ID bufferObj for access by CUDA. cuGLUnregisterBufferObject 202 . SEE ALSO cuGLCtxCreate. asynchronous launches. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_ALREADY_MAPPED Note that this function may also return error codes from previous.

SEE ALSO cuGLCtxCreate. asynchronous launches. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous. DESCRIPTION Unmaps the buffer object of ID bufferObj for access by CUDA. cuGLMapBufferObject.2. cuGLInit. cuGLRegisterBufferObject.10.5 cuGLUnmapBufferObject NAME cuGLUnmapBufferObject . cuGLUnregisterBufferObject 203 .unmaps a GL buffer object SYNOPSIS CUresult cuGLUnmapBufferObject(GLuint bufferObj).

unregister a GL buffer object SYNOPSIS CUresult cuGLUnregisterBufferObject(GLuint bufferObj).6 cuGLUnregisterBufferObject NAME cuGLUnregisterBufferObject . SEE ALSO cuGLCtxCreate. DESCRIPTION Unregisters the buffer object of ID bufferObj for access by CUDA. cuGLMapBufferObject. cuGLRegisterBufferObject.10. asynchronous launches. cuGLInit. cuGLUnmapBufferObject 204 .2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE Note that this function may also return error codes from previous.

Direct3dInteroperability 205 . StreamManagement. DeviceManagement. EventManagement. ExecutionControl. TextureReferenceManagement. OpenGLInteroperability. MemoryManagement.0 the following functions are deprecated. cuD3D9Begin cuD3D9End cuD3D9MapVertexBuffer cuD3D9RegisterVertexBuffer cuD3D9UnmapVertexBuffer cuD3D9UnregisterVertexBuffer SEE ALSO Initialization.11 Direct3dInteroperability NAME Direct3D Interoperability DESCRIPTION This section describes Direct3D interoperability in the the low-level CUDA driver application programming interface. They should not be used in new development.2. ModuleManagement. cuD3D9GetDevice cuD3D9CtxCreate cuD3D9GetDirect3DDevice cuD3D9RegisterResource cuD3D9UnregisterResource cuD3D9MapResources cuD3D9UnmapResources cuD3D9ResourceGetSurfaceDimensions cuD3D9ResourceSetMapFlags cuD3D9ResourceGetMappedPointer cuD3D9ResourceGetMappedSize cuD3D9ResourceGetMappedPitch As of CUDA 2. ContextManagement.

1 cuD3D9GetDevice NAME cuD3D9GetDevice . cuD3D9UnregisterResource. cuD3D9RegisterResource. const char* adapterName).2. SEE ALSO cuD3D9CtxCreate. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_VALUE CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. cuD3D9ResourceSetMapFlags.gets the device number for an adapter SYNOPSIS CUresult cuD3D9GetDevice(CUdevice* dev. cuD3D9UnmapResources. DESCRIPTION Returns in *dev the CUDA-compatible device corresponding to the adapter name adapterName obtained from EnumDisplayDevices or IDirect3D9::GetAdapterIdentifier(). asynchronous launches. If no device on the adapter with name adapterName is CUDA-compatible then the call will fail. cuD3D9MapResources.11. cuD3D9GetDirect3DDevice. cuD3D9ResourceGetMappedPitch 206 . cuD3D9ResourceGetSurfaceDimensions.

cuD3D9MapResources cuD3D9UnmapResources. On success. asynchronous launches. IDirect3DDevice9* pDxDevice). unsigned int Flags. SEE ALSO cuD3D9GetDevice. The CUcontext created will be returned in *pCtx. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_VALUE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous.create a CUDA context for interoperability with Direct3D SYNOPSIS CUresult cuD3D9CtxCreate(CUcontext* pCtx. DESCRIPTION Creates a new CUDA context. cuD3D9RegisterResource. cuD3D9UnregisterResource. Direct3D resources from this device may be registered and mapped through the lifetime of this CUDA context. this call will increase the internal reference count on pDxDevice.11. CUdevice* pCuDevice.2 cuD3D9CtxCreate NAME cuD3D9CtxCreate . For usage of the Flags parameter. This reference count will be decremented upon destruction of this context through cuCtxDestroy. cuD3D9ResourceGetSurfaceDimensions. enables interoperability for that context with the Direct3D device pDxDevice. If pCuDevice is non-NULL then the CUdevice on which this CUDA context was created will be returned in *pCuDevice. This context will function only until its Direct3D device is destroyed. cuD3D9ResourceSetMapFlags. and associates the created CUDA context with the calling thread. cuD3D9GetDirect3DDevice.2. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. see cuCtxCreate. cuD3D9ResourceGetMappedPitch 207 .

cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize.11. cuD3D9UnmapResources. asynchronous launches. cuD3D9MapResources. cuD3D9RegisterResource. DESCRIPTION Returns in *ppDxDevice the Direct3D device against which this CUDA context was created in cuD3D9CtxCreate. cuD3D9UnregisterResource. cuD3D9ResourceGetSurfaceDimensions.3 cuD3D9GetDirect3DDevice NAME cuD3D9GetDirect3DDevice . cuD3D9ResourceSetMapFlags. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT Note that this function may also return error codes from previous.2. cuD3D9CtxCreate. SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetMappedPitch 208 .get the Direct3D device against which the current CUDA context was created SYNOPSIS CUresult cuD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice).

The following value is allowed. one must register the base texture object. or 32-bit integer or floating-point data cannot be shared. • Any resources allocated in D3DPOOL_SYSTEMMEM may not be registered with CUDA. and cuD3D9ResourceGetMappedPitch respectively. To access individual surfaces associated with a texture.2. The pointer. • IDirect3DVertexBuffer9: No notes. The following are some limitations. unsigned int Flags). cuD3D9ResourceGetMappedSize. The type of pResource must be one of the following. The Flags argument specifies the mechanism through which CUDA will access the Direct3D resource.4 cuD3D9RegisterResource NAME cuD3D9RegisterResource . Not all Direct3D resources of the above types may be used for interoperability with CUDA. If this call is successful then the application will be able to map and unmap this resource until it is unregistered through cuD3D9UnregisterResource. • IDirect3DSurface9: Only stand-alone objects of type IDirect3DSurface9 may be explicitly shared. • CU_D3D9_REGISTER_FLAGS_NONE: Specifies that CUDA will access this resource through a CUdeviceptr. • The primary rendertarget may not be registered with CUDA. individual mipmap levels and faces of cube maps may not be registered directly. • IDirect3DBaseTexture9: When a texture is registered all surfaces associated with the all mipmap levels of all faces of the texture will be accessible to CUDA.register a Direct3D resource for access by CUDA SYNOPSIS CUresult cuD3D9RegisterResource(IDirect3DResource9* pResource. and pitch for each subresource of this resource may be queried through cuD3D9ResourceGetMappedPointer. In particular. 16. Also on success. 2. or 4 channels of 8. size. This option is valid for all resource types. This call is potentially high-overhead and should not be called every frame in interactive applications. DESCRIPTION Registers the Direct3D resource pResource for access by CUDA.11. • IDirect3DIndexBuffer9: No notes. 209 . this call will increase the internal reference count on pResource. • Textures which are not of a format which is 1. • Resources allocated as shared may not be registered with CUDA. This reference count will be decremented when this resource is unregistered through cuD3D9UnregisterResource.

cuD3D9ResourceSetMapFlags. asynchronous launches.• Surfaces of depth or stencil formats cannot be shared. If pResource cannot be registered then CUDA_ERROR_UNKNOWN is returned. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. cuD3D9UnregisterResource. cuD3D9MapResources. cuD3D9GetDirect3DDevice. If Direct3D interoperability is not initialized on this context then CUDA_ERROR_INVALID_CONTEXT is returned. cuD3D9CtxCreate. cuD3D9ResourceGetSurfaceDimensions. cuD3D9UnmapResources. is a non-stand-alone IDirect3DSurface9) or is already registered then CUDA_ERROR_INVALID_HANDLE is returned. If pResource is of incorrect type (e. cuD3D9ResourceGetMappedPitch 210 . SEE ALSO cuD3D9GetDevice.g. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_OUT_OF_MEMORY CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous.

cuD3D9UnmapResources.5 cuD3D9UnregisterResource NAME cuD3D9UnregisterResource .11. cuD3D9GetDirect3DDevice. cuD3D9MapResources.unregister a Direct3D resource SYNOPSIS CUresult cuD3D9UnregisterResource(IDirect3DResource9* pResource). cuD3D9ResourceGetMappedPitch 211 . DESCRIPTION Unregisters the Direct3D resource pResource so it is not accessable by CUDA unless registered again. cuD3D9ResourceSetMapFlags. If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned. asynchronous launches.2. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. SEE ALSO cuD3D9GetDevice. cuD3D9CtxCreate. cuD3D9ResourceGetSurfaceDimensions. cuD3D9RegisterResource.

asynchronous launches.map Direct3D resources for access by CUDA SYNOPSIS CUresult cuD3D9MapResources(unsigned int count. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize.6 cuD3D9MapResources NAME cuD3D9MapResources . RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_ALREADY_MAPPED CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous.11. DESCRIPTION Maps the count Direct3D resources in ppResources for access by CUDA. cuD3D9UnmapResources. cuD3D9CtxCreate. The resources in ppResources may be accessed in CUDA kernels until they are unmapped. If an application does so the results are undefined. cuD3D9UnregisterResource. cuD3D9ResourceGetMappedPitch 212 . cuD3D9GetDirect3DDevice. cuD3D9ResourceSetMapFlags. cuD3D9ResourceGetSurfaceDimensions.2. This function provides the synchronization guarantee that any Direct3D calls issued before cuD3D9MapResources will complete before any CUDA kernels issued after cuD3D9MapResources begin. Direct3D should not access any resources while they are mapped by CUDA. SEE ALSO cuD3D9GetDevice. cuD3D9RegisterResource. If any of ppResources are presently mapped for access by CUDA then CUDA_ERROR_ALREADY_MAPPED is returned. If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then CUDA_ERROR_INVALID_HANDLE is returned. IDirect3DResource9 **ppResources).

2.11.7

cuD3D9UnmapResources

NAME
cuD3D9UnmapResources - unmap Direct3D resources

SYNOPSIS
CUresult cuD3D9UnmapResources(unsigned int count, IDirect3DResource9** ppResources);

DESCRIPTION
Unmaps the count Direct3D resources in ppResources. This function provides the synchronization guarantee that any CUDA kernels issued before cuD3D9UnmapResources will complete before any Direct3D calls issued after cuD3D9UnmapResources begin. If any of ppResources have not been registered for use with CUDA or if ppResources contains any duplicate entries then CUDA_ERROR_INVALID_HANDLE is returned. If any of ppResources are not presently mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO

cuD3D9GetDevice, cuD3D9CtxCreate, cuD3D9GetDirect3DDevice, cuD3D9RegisterResource, cuD3D9UnregisterResource, cuD3D9MapResources, cuD3D9ResourceGetSurfaceDimensions, cuD3D9ResourceSetMapFlags, cuD3D9ResourceGetMappedP cuD3D9ResourceGetMappedSize, cuD3D9ResourceGetMappedPitch

213

2.11.8

cuD3D9ResourceSetMapFlags

NAME
cuD3D9ResourceSetMapFlags - set usage flags for mapping a Direct3D resource

SYNOPSIS
CUresult cuD3D9ResourceSetMapFlags(IDirect3DResource9 *pResource, unsigned int Flags);

DESCRIPTION
Set flags for mapping the Direct3D resource pResource. Changes to flags will take effect the next time pResource is mapped. The Flags argument may be any of the following. • CU_D3D9_MAPRESOURCE_FLAGS_NONE: Specifies no hints about how this resource will be used. It is therefore assumed that this resource will be read from and written to by CUDA kernels. This is the default value. • CU_D3D9_MAPRESOURCE_FLAGS_READONLY: Specifies that CUDA kernels which access this resource will not write to this resource. • CU_D3D9_MAPRESOURCE_FLAGS_WRITEDISCARD: Specifies that CUDA kernels which access this resource will not read from this resource and will write over the entire contents of the resource, so none of the data previously stored in the resource will be preserved. If pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. If pResource is presently mapped for access by CUDA then CUDA_ERROR_ALREADY_MAPPED is returned.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_ALREADY_MAPPED Note that this function may also return error codes from previous, asynchronous launches.

214

SEE ALSO

cuD3D9GetDevice, cuD3D9CtxCreate, cuD3D9GetDirect3DDevice, cuD3D9RegisterResource, cuD3D9UnregisterResource, cuD3D9MapResources, cuD3D9UnmapResources, cuD3D9ResourceGetSurfaceDimensions, cuD3D9ResourceGetMappedPointe cuD3D9ResourceGetMappedSize, cuD3D9ResourceGetMappedPitch

215

2.11.9

cuD3D9ResourceGetSurfaceDimensions

NAME
cuD3D9ResourceGetSurfaceDimensions - get the dimensions of a registered surface

SYNOPSIS
CUresult cuD3D9ResourceGetSurfaceDimensions(unsigned int* pWidth, unsigned int* pHeight, unsigned int *pDepth, IDirect3DResource9* pResource, unsigned int Face, unsigned int Level);

DESCRIPTION
Returns in *pWidth, *pHeight, and *pDepth the dimensions of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. Because anti-aliased surfaces may have multiple samples per pixel it is possible that the dimensions of a resource will be an integer factor larger than the dimensions reported by the Direct3D runtime. The parameters pWidth, pHeight, and pDepth are optional. For 2D surfaces, the value returned in *pDepth will be 0. If pResource is not of type IDirect3DBaseTexture9 or IDirect3DSurface9 or if pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer.

RETURN VALUE
Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE Note that this function may also return error codes from previous, asynchronous launches.

SEE ALSO
cuD3D9GetDevice, cuD3D9CtxCreate, cuD3D9GetDirect3DDevice, cuD3D9RegisterResource, cuD3D9UnregisterResource, cuD3D9MapResources, cuD3D9UnmapResources, cuD3D9ResourceSetMapFlags, cuD3D9ResourceGetMappedPointer, cuD3D9ResourceGetMappedSize, cuD3D9ResourceGetMappedPitch

216

2. If pResource is not mapped then CUDA_ERROR_NOT_MAPPED is returned. unsigned int Face. unsigned int Level).10 cuD3D9ResourceGetMappedPointer NAME cuD3D9ResourceGetMappedPointer . asynchronous launches. If Face is invalid then CUDA_ERROR_INVALID_V is returned. 217 . For all other types Face must be 0. IDirect3DResource9* pResource. At present only mipmap level 0 is supported.11. For all other types Level must be 0.get a pointer through which to access a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedPointer(CUdeviceptr* pDevPtr. If Level is invalid then CUDA_ERROR_INVALID_VALUE is returned. If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned. If pResource is of type IDirect3DCubeTexture9 then Face must one of the values enumerated by type D3DCUBEMAP_FACES. If pResource is of type IDirect3DBaseTexture9 then Level must correspond to a valid mipmap level. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVA is returned. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED Note that this function may also return error codes from previous. DESCRIPTION Returns in *pDevPtr the base pointer of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. The value set in pDevPtr may change every time that pResource is mapped.

cuD3D9RegisterResource. cuD3D9UnmapResources. cuD3D9MapResources. cuD3D9ResourceSetMapFlags.SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetSurfaceDimensions. cuD3D9CtxCreate. cuD3D9ResourceGetMappedSize. cuD3D9UnregisterResource. cuD3D9ResourceGetMappedPitch 218 . cuD3D9GetDirect3DDevice.

cuD3D9ResourceSetMapFlags. IDirect3DResource9* pResource. cuD3D9GetDirect3DDevice. unsigned int Level). If pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. asynchronous launches. unsigned int Face. cuD3D9ResourceGetMappedPitch 219 . cuD3D9ResourceGetMappedPointer. SEE ALSO cuD3D9GetDevice. cuD3D9MapResources. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED Note that this function may also return error codes from previous. cuD3D9UnmapResources. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE is returned. DESCRIPTION Returns in *pSize the size of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level.11 cuD3D9ResourceGetMappedSize NAME cuD3D9ResourceGetMappedSize .2. cuD3D9RegisterResource. cuD3D9CtxCreate.get the size of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedSize(unsigned int* pSize. The value set in pSize may change every time that pResource is mapped. cuD3D9ResourceGetSurfaceDimensions. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned.11. cuD3D9UnregisterResource.

unsigned int* pPitchSlice. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned. IDirect3DResource pResource. DESCRIPTION Returns in *pPitch and *pPitchSlice the pitch and Z-slice pitch of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. asynchronous launches.11.y. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE is returned. The values set in pPitch and pPitchSlice may change every time that pResource is mapped. For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer. unsigned int Face. 220 . y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x. The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows. RETURN VALUE Relevant return values: CUDA_SUCCESS CUDA_ERROR_DEINITIALIZED CUDA_ERROR_NOT_INITIALIZED CUDA_ERROR_INVALID_CONTEXT CUDA_ERROR_INVALID_VALUE CUDA_ERROR_INVALID_HANDLE CUDA_ERROR_NOT_MAPPED Note that this function may also return error codes from previous.y from the base pointer of the surface is If pResource is not of type IDirect3DBaseTexture9 or one of its sub-types or if pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. unsigned int Level).2.z from the base pointer of the surface is z*slicePitch + y*pitch + (bytes per pixel)*x Both parameters pPitch and pPitchSlice are optional and may be set to NULL.12 cuD3D9ResourceGetMappedPitch NAME cuD3D9ResourceGetMappedPitch .get the pitch of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedPitch(unsigned int* pPitch. For a 2D surface the byte offset of the sample of at position x.

cuD3D9ResourceGetMappedSize 221 . cuD3D9MapResources. cuD3D9UnmapResources. cuD3D9ResourceGetMappedPointer. cuD3D9CtxCreate. cuD3D9ResourceSetMapFlags. cuD3D9GetDirect3DDevice.SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetSurfaceDimensions. cuD3D9UnregisterResource. cuD3D9RegisterResource.

SEE ALSO ArithmeticFunctions.3 AtomicFunctions NAME Atomic Functions DESCRIPTION Atomic functions can only be used in device functions.1 and higher.2 and higher. BitwiseFunctions 222 . 64-bit atomic operations are only supported on devices of compute capability 1. NOTES 32-bit atomic operations are only supported on devices of compute capability 1.

3. atomicAdd atomicSub atomicExch atomicMin atomicMax atomicInc atomicDec atomicCAS SEE ALSO BitwiseFunctions 223 .1 ArithmeticFunctions NAME Arithmetic Functions DESCRIPTION This section describes the atomic arithmetic functions.

or 64-bit word old located at the address address in global memory.1. atomicDec. unsigned long long int atomicAdd(unsigned long long int* address.1 and higher. unsigned int atomicAdd(unsigned int* address. and stores the result back to global memory at the same address.1 atomicAdd NAME atomicAdd . unsigned int val). atomicMax. These three operations are performed in one atomic transaction. atomicCAS 224 . SEE ALSO atomicSub.atomic addition SYNOPSIS int atomicAdd(int* address.3. atomicExch. computes (old + val). DESCRIPTION Reads the 32. atomicInc. int val). 64-bit atomic operations are only supported on devices of compute capability 1. NOTES 32-bit atomic operations are only supported on devices of compute capability 1. The function returns old.2 and higher. unsigned long long int val). atomicMin.

atomicMin. The function returns old. atomicMax. and stores the result back to global memory at the same address.atomic subtraction SYNOPSIS int atomicSub(int* address. unsigned int atomicSub(unsigned int* address. computes (old . int val).3. atomicExch. unsigned int val). atomicCAS 225 . DESCRIPTION Reads the 32-bit word old located at the address address in global memory. NOTES Atomic operations are only supported on devices of compute capability 1.2 atomicSub NAME atomicSub . SEE ALSO atomicAdd.val). atomicInc.1. atomicDec.1 and higher. These three operations are performed in one atomic transaction.

3. atomicMin. atomicInc. unsigned long long int atomicExch(unsigned long long int* address.3 atomicExch NAME atomicExch . 64-bit atomic operations are only supported on devices of compute capability 1. DESCRIPTION Reads the 32.1 and higher. SEE ALSO atomicAdd. atomicMax.1. NOTES 32-bit atomic operations are only supported on devices of compute capability 1. unsigned int val). The function returns old. atomicCAS 226 .2 and higher. atomicSub. unsigned int atomicExch(unsigned int* address. int val).atomic exchange SYNOPSIS int atomicExch(int* address. atomicDec.or 64-bit word old located at the address address in global memory and stores val back to global memory at the same address. These two operations are performed in one atomic transaction. unsigned long long int val).

atomic minimum SYNOPSIS int atomicMin(int* address. int val). unsigned int val). atomicExch.1. SEE ALSO atomicAdd. atomicCAS 227 . These three operations are performed in one atomic transaction. computes the minimum of old and val. NOTES Atomic operations are only supported on devices of compute capability 1.3. unsigned int atomicMin(unsigned int* address. atomicInc.4 atomicMin NAME atomicMin . The function returns b<old>. DESCRIPTION Reads the 32-bit word old located at the address address in global memory.1 and higher. atomicSub. atomicDec. and stores the result back to global memory at the same address. atomicMax.

These three operations are performed in one atomic transaction. atomicDec.atomic maximum SYNOPSIS int atomicMax(int* address.1 and higher. int val).3. atomicCAS 228 . computes the maximum of old and val. and stores the result back to global memory at the same address. SEE ALSO atomicAdd. unsigned int atomicMax(unsigned int* address. atomicInc.1. The function returns old.5 atomicMax NAME atomicMax . unsigned int val). atomicMin. NOTES Atomic operations are only supported on devices of compute capability 1. atomicSub. atomicExch. DESCRIPTION Reads the 32-bit word old located at the address address in global memory.

SEE ALSO atomicAdd. atomicExch. and stores the result back to global memory at the same address.3.atomic increment SYNOPSIS unsigned int atomicInc(unsigned int* address. atomicMin.1 and higher. atomicSub. unsigned int val). NOTES Atomic operations are only supported on devices of compute capability 1. These three operations are performed in one atomic transaction. atomicMax. The function returns old. DESCRIPTION Reads the 32-bit word old located at the address address in global memory. atomicCAS 229 . atomicDec.1. computes ((old >= val) ? 0 : (old+1)).6 atomicInc NAME atomicInc .

The function returns old. and stores the result back to global memory at the same address. NOTES Atomic operations are only supported on devices of compute capability 1. DESCRIPTION Reads the 32-bit word old located at the address address in global memory. atomicMax.1. These three operations are performed in one atomic transaction.atomic decrement SYNOPSIS unsigned int atomicDec(unsigned int* address.1 and higher. unsigned int val).7 atomicDec NAME atomicDec . atomicInc. SEE ALSO atomicAdd.3. computes (((old == 0) . atomicExch. atomicCAS 230 . atomicMin. atomicSub.

int val).or 64-bit word old located at the address address in global memory. These three operations are performed in one atomic transaction.atomic compare-and-swap SYNOPSIS int atomicCAS(int* address. atomicSub. SEE ALSO atomicAdd. int compare.8 atomicCAS NAME atomicCAS .2 and higher. atomicExch. unsigned long long int val).1. The function returns old (Compare And Swap). atomicMin. unsigned int compare. and stores the result back to global memory at the same address. atomicDec 231 .1 and higher.3. unsigned int atomicCAS(unsigned int* address. unsigned long long int compare. computes (old == compare ? val : old). DESCRIPTION Reads the 32. NOTES 32-bit atomic operations are only supported on devices of compute capability 1. unsigned int val). unsigned long long int atomicCAS(unsigned long long int* address. 64-bit atomic operations are only supported on devices of compute capability 1. atomicMax. atomicInc.

3.2

BitwiseFunctions

NAME
Bitwise Functions

DESCRIPTION
This section describes the atomic bitwise functions. atomicAnd atomicOr atomicXor

SEE ALSO
ArithmeticFunctions

232

3.2.1

atomicAnd

NAME
atomicAnd - atomic bitwise-and

SYNOPSIS
int atomicAnd(int* address, int val); unsigned int atomicAnd(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old & val), and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicOr, atomicXor

233

3.2.2

atomicOr

NAME
atomicOr - atomic bitwise-or

SYNOPSIS
int atomicOr(int* address, int val); unsigned int atomicOr(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old , and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicAnd, atomicXor

234

3.2.3

atomicXor

NAME
atomicXor - atomic bitwise-xor

SYNOPSIS
int atomicXor(int* address, int val); unsigned int atomicXor(unsigned int* address, unsigned int val);

DESCRIPTION
Reads the 32-bit word old located at the address address in global memory, computes (old ˆ val), and stores the result back to global memory at the same address. These three operations are performed in one atomic transaction. The function returns old.

NOTES
Atomic operations are only supported on devices of compute capability 1.1 and higher.

SEE ALSO
atomicAnd, atomicOr

235

21 cudaFree. 229 atomicMax. 90 cudaD3D9ResourceGetMappedSize. 30 cudaMallocPitch. 97 cudaGetLastError. 208 cuD3D9MapResources. 38 cudaMemcpyFromSymbol. 25 cudaMalloc3D. 27 cudaFreeArray. 60 cudaBindTextureToArray HL. 69 cudaCreateChannelDesc. 59 cudaBindTexture HL. 112 cuCtxCreate. 73 cudaGLUnmapBufferObject. 18 cudaEventDestroy. 76 cudaGLUnregisterBufferObject. 28 cudaMallocHost. 226 AtomicFunctions. 26 cudaMemcpy. 43 236 . 89 cudaD3D9ResourceSetMapFlags. 231 atomicDec. 37 cudaMemcpy3D. 62 cudaGetTextureReference. 213 cuD3D9UnregisterResource. 56 cudaCreateChannelDesc HL. 207 cuD3D9GetDevice. 158 cuArrayCreate. 157 cuCtxAttach. 217 cuD3D9ResourceGetMappedSize. 211 cudaBindTexture. 65 cudaBindTextureToArray. 227 atomicOr. 113 cuCtxDestroy. 81 cudaD3D9MapResources. 86 cudaD3D9UnregisterResource.Index ArithmeticFunctions. 95 cudaGetSymbolAddress. 232 ContextManagement. 19 cudaEventSynchronize. 79 cudaD3D9GetDirect3DDevice. 57 cudaGetDevice. 92 cudaD3D9ResourceGetMappedPointer. 206 cuD3D9GetDirect3DDevice. 156 cuArrayGetDescriptor. 235 BitwiseFunctions. 212 cuD3D9RegisterResource. 40 cudaMemcpyFromArray. 29 cudaFreeHost. 234 atomicSub. 75 cudaGLRegisterBufferObject. 58 cudaGLMapBufferObject. 6 cudaGetErrorString. 44 cudaGetSymbolSize. 225 atomicXor. 119 cuCtxSynchronize. 39 cudaMemcpy2DToArray. 5 cudaGetDeviceCount. 111 cuArray3DCreate. 220 cuD3D9ResourceGetMappedPointer. 219 cuD3D9ResourceGetSurfaceDimensions. 3 cudaGetDeviceProperties. 70 cudaMalloc. 41 cudaMemcpy2DFromArray. 84 cudaEventCreate. 91 cudaD3D9ResourceGetSurfaceDimensions. 46 cudaMalloc3DArray. 118 cuCtxPushCurrent. 23 cudaEventQuery. 233 atomicCAS. 35 cudaMemcpy2DArrayToArray. 85 cudaD3D9RegisterResource. 117 cuCtxPopCurrent. 222 atomicInc. 22 cudaEventElapsedTime. 77 cudaLaunch. 216 cuD3D9ResourceSetMapFlags. 152 cuArrayDestroy. 154 cuArray3DGetDescriptor. 230 atomicExch. 8 cudaConfigureCall. 87 cudaD3D9SetDirect3DDevice. 120 cuD3D9CtxCreate. 82 cudaD3D9ResourceGetMappedPitch. 116 cuCtxGetDevice. 223 atomicAdd. 115 cuCtxDetach. 31 cudaGetChannelDesc. 74 cudaGLSetGLDevice. 209 cuD3D9ResourceGetMappedPitch. 52 cudaMemcpyArrayToArray. 45 cudaGetTextureAlignmentOffset. 66 cudaChooseDevice. 48 cudaMallocArray. 20 cudaEventRecord. 228 atomicMin. 64 cudaD3D9GetDevice. 224 atomicAnd. 80 cudaD3D9UnmapResources. 214 cuD3D9UnmapResources. 34 cudaMemcpy2D.

148 cuStreamCreate. 193 cuTexRefSetArray. 174 cuMemcpyAtoH. 136 cuEventElapsedTime. 100 cuLaunch. 2 Direct3dInteroperability. 161 cuMemcpy2D. 122 cuModuleGetGlobal. 150 cuGLCtxCreate. 4 cudaSetupArgument. 94 EventManagement. 188 cuTexRefGetFilterMode. 142 cuLaunchGrid. 10 cudaUnbindTexture. 67 cuDeviceComputeCapability. 32 cudaMemset2D. 182 cuModuleGetFunction. 178 cuMemcpyHtoA. 103 cuDeviceGetAttribute. 106 cuDeviceGetName. 13 cudaStreamDestroy. 135 cuEventDestroy. 196 cuTexRefSetFormat. 141 ExecutionControl RT. 61 cudaUnbindTexture HL. 149 cuFuncSetSharedSize. 102 cuDeviceGet. 163 cuMemFreeHost. 33 cudaMemset3D. 143 cuMemAlloc. 146 cuParamSeti. 107 cuDeviceGetProperties. 179 cuMemcpyHtoD. 181 cuMemset2D. 98 ErrorHandling RT. 108 cuDeviceTotalMem. 63 Initialization. 195 cuTexRefSetFlags. 130 cuStreamDestroy. 132 cuStreamSynchronize. 160 cuMemAllocPitch. 194 cuTexRefSetFilterMode. 16 cudaStreamQuery. 24 237 . 99 LowLevelApi. 164 cuMemGetAddressRange. 139 cuEventSynchronize. 42 cudaMemset. 170 cuMemcpyAtoA. 71 cudaStreamCreate. 15 cudaThreadExit. 128 cuParamSetf. 124 cuModuleLoad. 104 cuDeviceGetCount. 159 cuMemAllocHost. 133 cuTexRefCreate. 144 cuParamSetTexRef. 180 cuMemFree. 184 cuTexRefDestroy. 204 cuInit. 173 cuMemcpyAtoD. 203 cuGLUnregisterBufferObject. 202 cuGLUnmapBufferObject. 165 cuMemGetInfo. 131 cuStreamQuery. 126 cuModuleLoadFatBinary. 186 cuTexRefGetAddressMode. 17 ExecutionControl. 147 cuParamSetSize. 201 cuGLRegisterBufferObject. 55 MemoryManagement. 68 HighLevelApi. 176 cuMemcpyDtoD. 137 cuEventQuery. 177 cuMemcpyDtoH. 140 cuFuncSetBlockShape. 151 MemoryManagement RT. 36 cudaMemcpyToSymbol. 14 cudaStreamSynchronize. 78 DriverApiReference. 197 DeviceManagement. 50 cudaSetDevice. 125 cuModuleLoadData. 166 cuMemset. 11 cudaThreadSynchronize. 200 cuGLMapBufferObject. 145 cuParamSetv. 185 cuTexRefGetAddress. 192 cuTexRefSetAddressMode. 167 cuMemcpy3D. 190 cuTexRefGetFormat. 187 cuTexRefGetArray.cudaMemcpyToArray. 123 cuModuleGetTexRef. 199 cuGLInit. 191 cuTexRefSetAddress. 101 DeviceManagement RT. 189 cuTexRefGetFlags. 127 cuModuleUnload. 134 EventManagement RT. 110 cuEventCreate. 138 cuEventRecord. 205 Direct3dInteroperability RT. 175 cuMemcpyDtoA.

121 OpenGlInteroperability. 54 ThreadManagement RT.ModuleManagement. 183 TextureReferenceManagement RT. 12 TextureReferenceManagement. 9 238 . 129 StreamManagement RT. 1 StreamManagement. 72 RuntimeApiReference. 198 OpenGlInteroperability RT.

Sign up to vote on this title
UsefulNot useful