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

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

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

. . . . .3 atomicXor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 vii . . . . .3.2. . . . . .

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

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

1 cudaGetDeviceCount NAME cudaGetDeviceCount . cudaChooseDevice 3 . If there is no such device. cudaGetDeviceProperties. asynchronous launches. cudaGetDeviceCount() returns 1 and device 0 only supports device emulation mode. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. Since this device will be able to emulate all hardware features.1.0 that are available for execution. this device will report major and minor compute capability versions of 9999.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. 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. asynchronous launches.1. cudaChooseDevice 4 . cudaGetDeviceProperties.2 cudaSetDevice NAME cudaSetDevice . RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidDevice Note that this function may also return error codes from previous. cudaGetDevice. SEE ALSO cudaGetDeviceCount.1.

1.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. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. cudaChooseDevice 5 .1. SEE ALSO cudaGetDeviceCount. asynchronous launches. cudaSetDevice.3 cudaGetDevice NAME cudaGetDevice .

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

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

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

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

RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. 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.2.1 cudaThreadSynchronize NAME cudaThreadSynchronize . cudaThreadSynchronize() returns an error if one of the preceding tasks failed.1. asynchronous launches.

RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. Any subsequent API call reinitializes the runtime. asynchronous launches.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. SEE ALSO cudaThreadSynchronize 11 . cudaThreadExit() is implicitly called on host thread exit.2.2 cudaThreadExit NAME cudaThreadExit .1.

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

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

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

1.3 cudaStreamSynchronize NAME cudaStreamSynchronize . cudaStreamDestroy. cudaStreamQuery 15 . SEE ALSO cudaStreamCreate. asynchronous launches.3. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidResourceHandle Note that this function may also return error codes from previous.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.

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

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

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

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

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

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

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

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

Texture Reference Management. Memory Management.1. Stream Management. Error Handling 24 .5 MemoryManagement RT NAME Memory Management DESCRIPTION This section describes the CUDA runtime application programming interface. Execution Management. Direct3D Interoperability. 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. OpenGL Interoperability. Event Management. Thread Management.

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

Due to pitch alignment restrictions in the hardware. The intended usage of pitch is as a separate parameter of the allocation. the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column.1. Given the row and column of an array element of type T. The pitch returned in *pitch by cudaMallocPitch() is the width in bytes of the allocation. 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. cudaMallocArray. cudaMallocHost. cudaFreeHost 26 . asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. used to compute addresses within the 2D array.5. cudaFreeArray. 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. size_t widthInBytes. 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). SEE ALSO cudaMalloc. For allocations of 2D arrays. cudaFree. it is recommended that programmers consider performing pitch allocations using cudaMallocPitch().allocates memory on the GPU SYNOPSIS cudaError_t cudaMallocPitch( void** devPtr.2 cudaMallocPitch NAME cudaMallocPitch . size_t* pitch.

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

RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. y. const struct cudaChannelFormatDesc* desc. cudaChannelFormatKindFloat. }.allocate an array on the GPU SYNOPSIS cudaError_t cudaMallocArray( struct cudaArray** array. asynchronous launches. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned.1. z.5. cudaFreeHost 28 . cudaFreeArray. cudaChannelFormatKindUnsigned. 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.4 cudaMallocArray NAME cudaMallocArray . enum cudaChannelFormatKind f. SEE ALSO cudaMalloc. cudaMallocHost. size_t width. cudaFree. w. cudaMallocPitch.

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

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

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

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

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

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

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

cudaMemcpyDeviceToHost.copies data between host and device SYNOPSIS cudaError_t cudaMemcpyToArray(struct cudaArray* dstArray. cudaMemcpyArrayToArray. cudaMemcpyHostToDevice. size_t count. enum cudaMemcpyKind kind. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidMemcpyDirection Note that this function may also return error codes from previous. const void* src. size_t dstX. 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. cudaMemcpy2DToArray. or cudaMemcpyDeviceToDevice. enum cudaMemcpyKind kind) cudaError_t cudaMemcpyToArrayAsync(struct cudaArray* dstArray.1. cudaMemcpy2DFromArray. cudaMemcpy2D.12 cudaMemcpyToArray NAME cudaMemcpyToArray . const void* src. SEE ALSO cudaMemcpy. size_t dstX. cudaMemcpyToSymbol. dstY). cudaMemcpyFromSymbol 36 . and specifies the direction of the copy.5. cudaMemcpy2DArrayToArray. cudaMemcpyToArrayAsync() 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. cudaMemcpyFromArray. asynchronous launches. size_t dstY. size_t dstY. where kind is one of cudaMemcpyHostToHost. size_t count.

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

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

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

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

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

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

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

5. If symbol cannot be found. 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. *devPtr is unchanged and an error is returned. naming a variable that resides in global memory space. or if symbol is not declared in global memory space.1.20 cudaGetSymbolAddress NAME cudaGetSymbolAddress . asynchronous launches. or it can be a character string.finds the address associated with a CUDA symbol SYNOPSIS template < class T > cudaError_t cudaGetSymbolAddress(void** devPtr. 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. SEE ALSO cudaGetSymbolSize 44 .

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

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

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

5. For 2D arrays valid extents are {(1. The cudaChannelFormatDesc is defined as: struct cudaChannelFormatDesc { int x. w. enum cudaChannelFormatKind f. a degenerate 2D array allows for significantly more linear storage than a 1D array. asynchronous launches. 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. }. 48 . y. 32768). • A 2D array is allocated if only the depth extent is zero. }.23 cudaMalloc3DArray NAME cudaMalloc3DArray .1. 2048). 2048)}. 0. For 3D arrays valid extents are {(1. 65536). cudaChannelFormatKindFloat. 0} . 8192). 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. where cudaChannelFormatKind is one of cudaChannelFormatKindSigned. (1. const struct cudaChannelFormatDesc* desc. • A 3D array is allocate if all three extents are non-zero. (1. (1. cudaError_t cudaMalloc3DArray( struct cudaArray** arrayPtr. size_t depth.allocate an array on the GPU SYNOPSIS struct cudaExtent { size_t width. or 3D arrays. For 1D arrays valid extents are {(1. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMemoryAllocation Note that this function may also return error codes from previous. cudaMalloc3DArray is able to allocate 1D. • A 1D array is allocated if the height and depth extent are both zero. size_t height. 2D. cudaChannelFormatKindUnsigned. 2048). 0}. For instance. z.

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

while the ysize field specifies the height of each 2D slice in rows. struct cudaExtent { size_t width. The object to initialize is defined by dstPitchPtr. size_t ysize. The pitch field of dstPitchPtr is the width in memory in bytes of the 3D array pointed to by dstPitchPtr. asynchronous launches. This function performs fastest when the dstPitchPtr has been allocated by cudaMalloc3D(). int value. Extents with width greater than or equal to the xsize of dstPitchPtr may perform significantly faster than extents narrower than the xsize. size_t depth.24 cudaMemset3D NAME cudaMemset3D . 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. The xsize field specifies the logical width of each row in bytes. }. cudaError_t cudaMemset3D( struct cudaPitchedPtr dstPitchPtr. }.5. and a depth in slices. The extents of the initialized region are specified as a width in bytes. 50 .1. size_t pitch.initializes or sets GPU memory to a value SYNOPSIS struct cudaPitchedPtr { void *ptr. size_t xsize. struct cudaExtent extent ) DESCRIPTION Initializes each element of a 3D array to the specified value value. extents with height equal to the ysize of dstPitchPtr will perform faster than when the hieght is shorter than the ysize. size_t height. Secondarily. a height in rows.

SEE ALSO cudaMemset. cudaMemset2D. cudaMalloc3D 51 .

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

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

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

6.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 .1.

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

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

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

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

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

cudaGetTextureAlignmentOffset 61 .cudaUnbindTexture NAME cudaUnbindTexture . cudaGetTextureReference. 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. cudaGetChannelDesc. asynchronous launches. cudaBindTexture.Low-level texture API SYNOPSIS cudaError_t cudaUnbindTexture( const struct textureReference* texRef). SEE ALSO cudaCreateChannelDesc.

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

1.6.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 .

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

The channel descriptor is inherited from the texture reference type. enum cudaTextureReadMode readMode E<gt> static __inline__ __host__ cudaError_t cudaBindTexture( size_t* offset.cudaBindTexture HL NAME cudaBindTexture . 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. template E<lt> class T. int dim. dim. binds size bytes of the memory area pointed to by devPtr to texture reference texRef. readMode >& texRef. const struct texture < T.High-level texture API SYNOPSIS template < class T. dim. const void* devPtr. const struct texture E<lt> T. asynchronous launches. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaBindTexture(size_t* offset. readMode E<gt>& texRef. Any memory previously bound to texRef is unbound. SEE ALSO 65 . desc describes how the memory is interpreted when fetching values from the texture. size_t size = UINT_MAX) DESCRIPTION Binds size bytes of the memory area pointed to by devPtr to texture reference texRef. size_t size = UINT_MAX). const void* devPtr. The offset parameter is an optional byte offset as with the low-level cudaBindTexture() function. int dim. const struct cudaChannelFormatDesc& desc.

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

SEE ALSO 67 . asynchronous launches. dim. int dim. enum cudaTextureReadMode readMode > static __inline__ __host__ cudaError_t cudaUnbindTexture(const struct texture < T.cudaUnbindTexture HL NAME cudaUnbindTexture . 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.High-level texture API SYNOPSIS template < class T.

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

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

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

7. asynchronous launches. RETURN VALUE Relevant return values: cudaSuccess Note that this function may also return error codes from previous. 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. The arguments are stored in the top of the execution stack. which starts at offset 0. cudaSetupArgument() must be preceded by a call to cudaConfigureCall(). SEE ALSO cudaConfigureCall.configure a device-launch SYNOPSIS cudaError_t cudaSetupArgument(void* arg. size_t offset) template < class T > cudaError_t cudaSetupArgument(T arg.3 cudaSetupArgument NAME cudaSetupArgument . cudaLaunch 71 .

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

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

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

1. GLuint bufferObj).OpenGL interoperability SYNOPSIS cudaError_t cudaGLMapBufferObject(void** devPtr. SEE ALSO cudaGLSetGLDevice. RETURN VALUE Relevant return values: cudaSuccess cudaErrorMapBufferObjectFailed Note that this function may also return error codes from previous. cudaGLRegisterBufferObject.3 cudaGLMapBufferObject NAME cudaGLMapBufferObject .8. cudaGLUnregisterBufferObject 75 . cudaGLUnmapBufferObject. asynchronous launches. 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.

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

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

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

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

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

cudaD3D9RegisterResource. cudaD3D9ResourceGetMappedPitch 84 .9.5 cudaD3D9UnregisterResource NAME cudaD3D9UnregisterResource . cudaD3D9MapResources. SEE ALSO cudaD3D9GetDevice. DESCRIPTION Unregisters the Direct3D resource pResource so it is not accessable by CUDA unless registered again.1. cudaD3D9SetDirect3DDevice. cudaD3D9ResourceGetMappedSize. cudaD3D9GetDirect3DDevice. cudaD3D9ResourceSetMapF cudaD3D9ResourceGetMappedPointer. 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. asynchronous launches.unregister a Direct3D resource SYNOPSIS cudaError_t cudaD3D9UnregisterResource(IDirect3DResource9* pResource). cudaD3D9ResourceGetSurfaceDimensions. cudaD3D9UnmapResources.

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

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

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

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

cudaD3D9UnregisterResource. DESCRIPTION Returns in *pWidth. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle Note that this function may also return error codes from previous. 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. and pDepth are optional. *pHeight. SEE ALSO cudaD3D9GetDevice. The parameters pWidth. cudaD3D9UnmapResources.1. asynchronous launches.9.9 cudaD3D9ResourceGetSurfaceDimensions NAME cudaD3D9ResourceGetSurfaceDimensions . cudaD3D9GetDirect3DDevice. and *pDepth the dimensions of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. size_t* pHeight.get the dimensions of a registered surface SYNOPSIS cudaError_t cudaD3D9ResourceGetSurfaceDimensions(size_t* pWidth. For 2D surfaces. cudaD3D9ResourceGetMappedPitch 89 . cudaD3D9ResourceGetMappedSize. unsigned int Face. cudaD3D9ResourceGetMappedPointer. cudaD3D9SetDirect3DDevice. For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer. unsigned int Level). cudaD3D9ResourceSetMapFlags. pHeight. cudaD3D9RegisterResource. 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 cudaErrorInvalidHandle is returned. IDirect3DResource9* pResource. cudaD3D9MapResources. size_t *pDepth.

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

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

RETURN VALUE Relevant return values: cudaSuccess cudaErrorInvalidValue cudaErrorInvalidHandle cudaErrorUnknown Note that this function may also return error codes from previous. 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.y. unsigned int Face. 92 . 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. If pResource was not registered with usage flags cudaD3D9RegisterFlagsNone then cudaErrorInvalidHandle is returned.12 cudaD3D9ResourceGetMappedPitch NAME cudaD3D9ResourceGetMappedPitch . For usage requirements of Face and Level parameters see cudaD3D9ResourceGetMappedPointer.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.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. The pitch and Z-slice pitch values may be used to compute the location of a sample on a surface as follows. unsigned int Level). For a 2D surface the byte offset of the sample of at position x.9. IDirect3DResource9* pResource. y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x. size_t* pPitchSlice.1. If pResource is not mapped for access by CUDA then cudaErrorUnknown is returned. asynchronous launches.

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

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

1 cudaGetLastError NAME cudaGetLastError .1.10. 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.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 .

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

DESCRIPTION Initializes the driver API and must be called before any other function from the driver API. any function from the driver API will return CUDA_ERROR_NOT_INITIALIZED.initialize the CUDA driver API SYNOPSIS CUresult cuInit( unsigned int Flags ).2. SEE ALSO 100 .1 cuInit NAME cuInit .1. If cuInit() has not been called. 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. asynchronous launches. the Flags parameters must be 0. Currently.

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

cuDeviceGetName. DESCRIPTION Returns in *major and *minor the major and minor revision numbers that define the compute capability of device dev. 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. SEE ALSO cuDeviceGetAttribute. cuDeviceGet.returns the compute capability of the device SYNOPSIS CUresult cuDeviceComputeCapability(int* major. int* minor.2. CUdevice dev). cuDeviceGetCount. cuDeviceTotalMem 102 .1 cuDeviceComputeCapability NAME cuDeviceComputeCapability .2. asynchronous launches.

SEE ALSO cuDeviceComputeCapability. cuDeviceGetProperties.2. cuDeviceGetAttribute. asynchronous launches.returns a device-handle SYNOPSIS CUresult cuDeviceGet(CUdevice* dev.2 cuDeviceGet NAME cuDeviceGet . cuDeviceGetCount. cuDeviceGetName. DESCRIPTION Returns in *dev a device handle given an ordinal in the range [0. cuDeviceGetCount()-1].2. cuDeviceTotalMem 103 . int ordinal). 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.

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

cuDeviceGetName. cuDeviceGet. cuDeviceGetCount. cuDeviceTotalMem 105 . asynchronous launches.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. cuDeviceGetProperties.

cuDeviceGetProperties.returns the number of compute-capable devices SYNOPSIS CUresult cuDeviceGetCount(int* count).0 that are available for execution.4 cuDeviceGetCount NAME cuDeviceGetCount . cuDeviceGetCount() returns 0. SEE ALSO cuDeviceComputeCapability. DESCRIPTION Returns in *count the number of devices with compute capability greater or equal to 1. cuDeviceGetAttribute. If there is no such device.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.2. cuDeviceGet. cuDeviceGetName. asynchronous launches. cuDeviceTotalMem 106 .

5 cuDeviceGetName NAME cuDeviceGetName . cuDeviceTotalMem 107 . cuDeviceGetAttribute. SEE ALSO cuDeviceComputeCapability.2. cuDeviceGetCount. cuDeviceGet. DESCRIPTION Returns an ASCII string identifying the device dev in the NULL-terminated string pointed to by name. CUdevice dev). asynchronous launches.2.returns an identifier string SYNOPSIS CUresult cuDeviceGetName(char* name. cuDeviceGetProperties. len specifies the maximum length of the string that may be 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_DEVICE Note that this function may also return error codes from previous. int len.

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

cuDeviceGet. SEE ALSO cuDeviceComputeCapability. cuDeviceGetAttribute.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. cuDeviceGetCount. cuDeviceTotalMem 109 . asynchronous launches. cuDeviceGetName.

cuDeviceGetAttribute. asynchronous launches.2. SEE ALSO cuDeviceComputeCapability. cuDeviceGetProperties 110 .returns the total amount of memory on the device SYNOPSIS CUresult cuDeviceTotalMem( unsigned int* bytes. CUdevice dev ). 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. DESCRIPTION Returns in *bytes the total amount of memory available on the device dev in bytes.7 cuDeviceTotalMem NAME cuDeviceTotalMem . cuDeviceGetCount. cuDeviceGet. cuDeviceGetName.2.

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

increment context usage-count SYNOPSIS CUresult cuCtxAttach(CUcontext* pCtx. cuCtxGetDevice. cuCtxDetach. asynchronous launches. Currently. SEE ALSO cuCtxCreate.2. cuCtxAttach() fails if there is no context current to the thread. 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. unsigned int Flags). the Flags parameter must be 0.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.1 cuCtxAttach NAME cuCtxAttach . cuCtxSynchronize 112 .

it is supplanted by the newly created context and may be restored by a subsequent call to cuCtxPopCurrent(). If a context is already current to the thread. The Flags parameter is described below.2. CUdevice dev). 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. asynchronous launches. 113 . • CU_CTX_SCHED_AUTO: The default value if the Flags parameter is zero.create a CUDA context SYNOPSIS CUresult cuCtxCreate(CUcontext* pCtx. but can increase the performance of CPU threads performing work in parallel with the GPU. • CU_CTX_SCHED_YIELD: Instruct CUDA to yield its thread when waiting for results from the GPU. but may lower the performance of CPU threads if they are performing work in parallel with the CUDA thread. unsigned int Flags. • CU_CTX_SCHED_SPIN: Instruct CUDA to actively spin when waiting for results from the GPU. If C > P then CUDA will yield to other OS threads when waiting for the GPU. This can decrease latency when waiting for the GPU. 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.3. This can increase latency when waiting for the GPU. otherwise CUDA will not yield while waiting for results and actively spin on the processor. 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.2 cuCtxCreate NAME cuCtxCreate . 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. DESCRIPTION Creates a new CUDA context and associates it with the calling thread.

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

cuCtxAttach. cuCtxPushCurrent. Floating contexts (detached from a CPU thread via cuCtxPopCurrent()) may be destroyed by this function. If the context usage count is not equal to 1.3 cuCtxDestroy NAME cuCtxDestroy . cuCtxPopCurrent 115 . SEE ALSO cuCtxCreate. DESCRIPTION Destroys the given CUDA context.3. or the context is current to any CPU thread other than the current one. 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. this function fails.2.destroy the current context context or a floating CuDA context SYNOPSIS CUresult cuCtxDestroy(CUcontext ctx). cuCtxDetach.

The context must be a handle that was passed back by cuCtxCreate() or cuCtxAttach(). cuCtxPushCurrent. and destroys the context if the usage count goes to 0. DESCRIPTION Decrements the usage count of the context.3.2. asynchronous launches. 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. SEE ALSO cuCtxCreate.4 cuCtxDetach NAME cuCtxDetach . cuCtxPopCurrent 116 .decrement a context’s usage-count SYNOPSIS CUresult cuCtxDetach(CUcontext ctx). cuCtxDestroy. cuCtxAttach.

SEE ALSO cuCtxCreate. DESCRIPTION Returns in *device the ordinal of the current context’s device.5 cuCtxGetDevice NAME cuCtxGetDevice .return device-ID for current context SYNOPSIS CUresult cuCtxGetDevice(CUdevice* device). cuCtxDetach.2.3. 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. cuCtxAttach. cuCtxSynchronize 117 .

The CUDA context must have a usage count of 1. DESCRIPTION Pops the current CUDA context from the CPU 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. CUDA contexts have a usage count of 1 upon creation. cuCtxAttach. asynchronous launches. Floating contexts may be destroyed by calling cuCtxDestroy(). cuCtxDestroy. If successful. The context may then be made current to a different CPU thread by calling cuCtxPushCurrent(). this function makes that context current to the CPU thread again.3.pops the current CUDA context from the current CPU thread SYNOPSIS CUresult cuCtxPopCurrent(CUcontext *pctx). cuCtxPopCurrent() passes back the context handle in *pctx. cuCtxPushCurrent 118 . the usage count may be incremented with cuCtxAttach() and decremented with cuCtxDetach(). SEE ALSO cuCtxCreate. If a context was current to the CPU thread before cuCtxCreate or cuCtxPushCurrent was called.6 cuCtxPopCurrent NAME cuCtxPopCurrent .2. cuCtxDetach.

cuCtxPopCurrent 119 . The specified context becomes the CPU thread’s current context. Contexts are made to float by calling cuCtxPopCurrent().3. The context must be "floating. cuCtxDestroy. not attached to any thread. asynchronous launches. The previous current context may be made current again by calling cuCtxDestroy() or cuCtxPopCurrent(). SEE ALSO cuCtxCreate. cuCtxDetach. DESCRIPTION Pushes the given context onto the CPU thread’s stack of current contexts. so all CUDA functions that operate on the current context are affected. cuCtxAttach." i.7 cuCtxPushCurrent NAME cuCtxPushCurrent .2.attach floating context to CPU thread SYNOPSIS CUresult cuCtxPushCurrent(CUcontext ctx).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.

2.8 cuCtxSynchronize NAME cuCtxSynchronize . cuCtxAttach. DESCRIPTION Blocks until the device has completed all preceding requested tasks. 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. cuCtxSynchronize() returns an error if one of the preceding tasks failed. asynchronous launches. SEE ALSO cuCtxCreate. cuCtxDetach.3. cuCtxGetDevice 120 .block for a context’s tasks to complete SYNOPSIS CUresult cuCtxSynchronize(void).

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

cuModuleLoadData. cuModuleGetFunction() returns CUDA_ERROR_NOT_FOUND.4. 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. CUmodule mod. cuModuleLoadFatBinary.2. If no function of that name exists. cuModuleGetGlobal.1 cuModuleGetFunction NAME cuModuleGetFunction . SEE ALSO cuModuleLoad.returns a function handle SYNOPSIS CUresult cuModuleGetFunction(CUfunction* func. cuModuleUnload. DESCRIPTION Returns in *func the handle of the function of name funcname located in module mod. asynchronous launches. const char* funcname). cuModuleGetTexRef 122 .

cuModuleUnload. cuModuleGetFunction. 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.4. If no variable of that name exists. const char* globalname).2 cuModuleGetGlobal NAME cuModuleGetGlobal . DESCRIPTION Returns in *devPtr and *bytes the base pointer and size of the global of name globalname located in module mod. cuModuleLoadData. asynchronous launches. unsigned int* bytes. If one of them is null. it is ignored.2. cuModuleLoadFatBinary. SEE ALSO cuModuleLoad. Both parameters devPtr and bytes are optional. cuModuleGetGlobal() returns CUDA_ERROR_NOT_FOUND.returns a global pointer from a module SYNOPSIS CUresult cuModuleGetGlobal(CUdeviceptr* devPtr. cuModuleGetTexRef 123 .

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

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 Unloads a module mod from the current context. cuModuleGetFunction. asynchronous launches.2. cuModuleLoadData.unloads a module SYNOPSIS CUresult cuModuleUnload(CUmodule mod).4. SEE ALSO cuModuleLoad.7 cuModuleUnload NAME cuModuleUnload . cuModuleLoadFatBinary. cuModuleGetGlobal. cuModuleGetTexRef 128 .

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

2. DESCRIPTION Creates a stream. cuStreamDestroy 130 .1 cuStreamCreate NAME cuStreamCreate .create a stream SYNOPSIS CUresult cuStreamCreate(CUstream* stream. cuStreamSynchronize. SEE ALSO cuStreamQuery. flags is required to be 0.5. unsigned int flags). At present. 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.

DESCRIPTION Destroys the stream.2 cuStreamDestroy NAME cuStreamDestroy . SEE ALSO cuStreamCreate.destroys a stream SYNOPSIS CUresult cuStreamDestroy(CUstream stream). cuStreamQuery. cuStreamSynchronize 131 .2. 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.5.

2.3 cuStreamQuery NAME cuStreamQuery . DESCRIPTION Returns CUDA_SUCCESS if all operations in the stream have completed. SEE ALSO cuStreamCreate.determine status of a compute stream SYNOPSIS CUresult cuStreamQuery(CUstream stream).5. 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. asynchronous launches. or CUDA_ERROR_NOT_READY if not. cuStreamDestroy 132 . cuStreamSynchronize.

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. cuStreamQuery. cuStreamDestroy 133 .block until a stream’s tasks are completed SYNOPSIS CUresult cuStreamSynchronize(CUstream stream). SEE ALSO cuStreamCreate.2.4 cuStreamSynchronize NAME cuStreamSynchronize . DESCRIPTION Blocks until the device has completed all operations in the stream.5. asynchronous launches.

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

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. DESCRIPTION Creates an event.1 cuEventCreate NAME cuEventCreate . unsigned int flags). At present. cuEventElapsedTime 135 . cuEventDestroy. flags is required to be 0.creates an event SYNOPSIS CUresult cuEventCreate(CUevent* event. SEE ALSO cuEventRecord.6.2. cuEventSynchronize. cuEventQuery. asynchronous launches.

6. DESCRIPTION Destroys the event. SEE ALSO cuEventCreate. cuEventElapsedTime 136 . 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. asynchronous launches. cuEventQuery.2.destroys an event SYNOPSIS CUresult cuEventDestroy(CUevent event). cuEventSynchronize.2 cuEventDestroy NAME cuEventDestroy .

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. asynchronous launches. cuEventSynchronize. DESCRIPTION Computes the elapsed time between two events (in milliseconds with a resolution of around 0. this function returns CUDA_ERROR_INVALID_VALUE. CUevent end). cuEventRecord. CUevent start. If either event has not been recorded yet. cuEventQuery. SEE ALSO cuEventCreate.computes the elapsed time between two events SYNOPSIS CUresult cuEventDestroy(float* time.2. cuEventDestroy 137 .3 cuEventElapsedTime NAME cuEventElapsedTime .6. the result is undefined. If either event has been recorded with a non-zero stream.5 microseconds).

cuEventRecord. DESCRIPTION Returns CUDA_SUCCESS if the event has actually been recorded. SEE ALSO cuEventCreate.4 cuEventQuery NAME cuEventQuery . or CUDA_ERROR_NOT_READY if not. cuEventDestroy. cuEventElapsedTime 138 .2. If cuEventRecord() has not been called on this event. 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. cuEventSynchronize.6.queries an event’s status SYNOPSIS CUresult cuEventQuery(CUevent event). asynchronous launches.

asynchronous launches. otherwise. the event is recorded after all preceding operations in the stream have been completed.5 cuEventRecord NAME cuEventRecord . 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. Since this operation is asynchronous. cuEventSynchronize.records an event SYNOPSIS CUresult cuEventRecord(CUevent event. SEE ALSO cuEventCreate. If cuEventRecord() has previously been called and the event has not been recorded yet. it is recorded after all preceding operations in the CUDA context have been completed. CUstream stream).6. DESCRIPTION Records an event.2. If stream is non-zero. cuEventQuery() and/or cuEventSynchronize() must be used to determine when the event has actually been recorded. cuEventQuery. cuEventElapsedTime 139 . cuEventDestroy. this function returns CUDA_ERROR_INVALID_VALUE.

6 cuEventSynchronize NAME cuEventSynchronize .6. cuEventElapsedTime 140 . 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. cuEventRecord. If cuEventRecord() has not been called on this event. SEE ALSO cuEventCreate. cuEventDestroy.2. asynchronous launches. DESCRIPTION Blocks until the event has actually been recorded. the function returns CUDA_ERROR_INVALID_VALUE.waits for an event to complete SYNOPSIS CUresult cuEventSynchronize(CUevent event). cuEventQuery.

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

The block contains the number of threads specified by a previous call to cuFuncSetBlockShape().1 cuLaunch NAME cuLaunch . cuParamSetv. cuLaunchGrid 142 . cuParamSetTexRef. cuParamSetSize.launches a CUDA function SYNOPSIS CUresult cuLaunch(CUfunction func). cuFuncSetSharedSize. asynchronous launches. cuParamSeti.2. cuParamSetf. DESCRIPTION Invokes the kernel func on a 1ÃŮ1 grid of blocks. 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.7. SEE ALSO cuFuncSetBlockShape.

int grid_height. CUstream stream).2 cuLaunchGrid NAME cuLaunchGrid . cuParamSetv. 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. int grid_width. SEE ALSO cuFuncSetBlockShape. cuFuncSetSharedSize.2. cuParamSetSize. cuParamSetf. cuParamSetTexRef. Each block contains the number of threads specified by a previous call to cuFuncSetBlockShape(). cuLaunchGridAsync() can optionally be associated to a stream by passing a non-zero stream argument.7. asynchronous launches.launches a CUDA function SYNOPSIS CUresult cuLaunchGrid(CUfunction func. CUresult cuLaunchGridAsync(CUfunction func. int grid_height). int grid_width. cuParamSeti.

cuParamSetf. cuParamSetv. unsigned int numbytes). 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.3 cuParamSetSize NAME cuParamSetSize . cuLaunch.sets the parameter-size for the function SYNOPSIS CUresult cuParamSetSize(CUfunction func. asynchronous launches. DESCRIPTION Sets through numbytes the total size in bytes needed by the function parameters of function func. cuParamSeti. cuLaunchGrid 144 . cuFuncSetSharedSize. cuParamSetTexRef. SEE ALSO cuFuncSetBlockShape.2.7.

cuFuncSetSharedSize. SEE ALSO cuFuncSetBlockShape. cuParamSeti. CUtexref texRef). cuLaunchGrid 145 . cuParamSetSize.adds a texture-reference to the function’s argument list SYNOPSIS CUresult cuParamSetTexRef(CUfunction func. cuParamSetv. In this version of CUDA.2. the texture reference must be obtained via cuModuleGetTexRef() and the texunit parameter must be set to CU_PARAM_TR_DEFAULT. cuLaunch. DESCRIPTION Makes the CUDA array or linear memory bound to the texture reference texRef available to a device program as a texture. cuParamSetf. 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. int texunit. asynchronous launches.7.4 cuParamSetTexRef NAME cuParamSetTexRef .

cuParamSeti. asynchronous launches. cuFuncSetSharedSize.7. int offset. cuLaunchGrid 146 . float value). 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. cuParamSetSize. cuParamSetTexRef.adds a floating-point parameter to the function’s argument list SYNOPSIS CUresult cuParamSetf(CUfunction func. cuLaunch. DESCRIPTION Sets a floating point parameter that will be specified the next time the kernel corresponding to func will be invoked. offset is a byte offset.5 cuParamSetf NAME cuParamSetf . SEE ALSO cuFuncSetBlockShape.2. cuParamSetv.

cuLaunchGrid 147 . SEE ALSO cuFuncSetBlockShape. asynchronous launches. offset is a byte offset. unsigned int value). 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. cuParamSetSize. cuLaunch. cuParamSetTexRef. int offset. cuFuncSetSharedSize. cuParamSetf.6 cuParamSeti NAME cuParamSeti .7. cuParamSetv. DESCRIPTION Sets an integer parameter that will be specified the next time the kernel corresponding to func will be invoked.2.adds an integer parameter to the function’s argument list SYNOPSIS CUresult cuParamSeti(CUfunction func.

cuParamSeti. offset is a byte offset.7 cuParamSetv NAME cuParamSetv . asynchronous launches. cuParamSetTexRef. cuFuncSetSharedSize. 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. SEE ALSO cuFuncSetBlockShape. cuParamSetf.adds arbitrary data to the function’s argument list SYNOPSIS CUresult cuParamSetv(CUfunction func.7.2. unsigned int numbytes). void* ptr. DESCRIPTION Copies an arbitrary amount of data into the parameter space of the kernel corresponding to func. int offset. cuLaunchGrid 148 . cuParamSetSize.

int x. cuLaunchGrid 149 . DESCRIPTION Specifies the X. cuParamSeti. cuLaunch. cuParamSetf.2. SEE ALSO cuFuncSetSharedSize. cuParamSetSize. int z).8 cuFuncSetBlockShape NAME cuFuncSetBlockShape . asynchronous launches.sets the block-dimensions for the function SYNOPSIS CUresult cuFuncSetBlockShape(CUfunction func.7. 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. int y. Y and Z dimensions of the thread blocks that are created when the kernel given by func is launched. cuParamSetTexRef. cuParamSetv.

9 cuFuncSetSharedSize NAME cuFuncSetSharedSize .2. SEE ALSO cuFuncSetBlockShape. asynchronous launches.sets the shared-memory size for the function SYNOPSIS CUresult cuFuncSetSharedSize(CUfunction func. cuParamSetv. cuLaunchGrid 150 . cuParamSeti. cuParamSetTexRef.7. 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. 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. cuLaunch. cuParamSetf. cuParamSetSize.

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. Direct3dInteroperability 151 . OpenGlInteroperability. MemoryManagement. TextureReferenceManagement. ContextManagement. ExecutionControl.2. StreamManagement.8 MemoryManagement NAME Memory Management DESCRIPTION This section describes the low-level CUDA driver application programming interface. ModuleManagement. DeviceManagement. EventManagement.

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

• Description for a width x height CUDA array of 64-bit. cuMemFree. cuMemAlloc.Width = 64. desc.NumChannels = 1.FormatFlags = CU_AD_FORMAT_HALF. desc. asynchronous launches. desc. cuMemset2D 153 . desc. cuMemset. desc.NumChannels = 2.Height = height.Width = width. cuMemGetAddressRange. 4x16-bit float16’s: CUDA_ARRAY_DESCRIPTOR desc. each of which is two 8-bit unsigned chars: CUDA_ARRAY_DESCRIPTOR arrayDesc. desc. desc. desc.Height = height. desc.NumChannels = 4. cuArrayDestroy. desc. desc.FormatFlags = CU_AD_FORMAT_UNSIGNED_INTS. • Description for a width x height CUDA array of 16-bit elements.Width = 2048.Height = 64. desc.NumChannels = 1. desc.Format = CU_AD_FORMAT_FLOAT. cuArrayGetDescriptor. • Description for a 64 x 64 CUDA array of floats: CUDA_ARRAY_DESCRIPTOR desc.Width = width. cuMemFreeHost.Height = 1. cuMemAllocPitch. 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. cuMemAllocHost. SEE ALSO cuMemGetInfo.desc.

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

cuMemFreeHost. desc. asynchronous launches. 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. • Description for a 64 x 64 CUDA array of floats: CUDA_ARRAY3D_DESCRIPTOR desc. cuMemAlloc.• Description for a CUDA array of 2048 floats: CUDA_ARRAY3D_DESCRIPTOR desc.Format = CU_AD_FORMAT_FLOAT. desc.Width = 64.NumChannels = 4. 4x16-bit float16’s: CUDA_ARRAY_DESCRIPTOR desc. cuMemAllocPitch. desc. desc. cuMemAllocHost.NumChannels = 1.Format = CU_AD_FORMAT_FLOAT. cuMemGetAddressRange. desc. desc.Width = width. desc.Depth = depth. desc.Width = 2048. desc. desc.Depth = 0. cuMemFree. cuArrayDestroy 155 . SEE ALSO cuMemGetInfo.NumChannels = 1. desc. desc.FormatFlags = CU_AD_FORMAT_HALF. desc.Height = height. desc.Height = 0. desc.Depth = 0. cuArray3DGetDescriptor. • Description for a width x height x depth CUDA array of 64-bit.

8. SEE ALSO cuMemGetInfo. cuMemFree.destroys a CUDA array SYNOPSIS CUresult cuArrayDestroy(CUarray array). cuMemGetAddressRange.3 cuArrayDestroy NAME cuArrayDestroy . cuArrayGetDescriptor. cuMemAlloc. cuMemset. cuMemAllocHost. DESCRIPTION Destroys the CUDA array array. cuMemFreeHost. cuMemAllocPitch. cuArrayCreate. cuMemset2D 156 . 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_ARRAY_IS_MAPPED Note that this function may also return error codes from previous.

cuArrayDestroy 157 .8.4 cuArrayGetDescriptor NAME 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. cuArray3DGetDescriptor. SEE ALSO cuArrayCreate. but need to know the CUDA array parameters for validation or other purposes. asynchronous launches.2. CUarray array) DESCRIPTION Returns in *arrayDesc a descriptor of the format and dimensions of the 1D or 2D CUDA array array. cuArray3DCreate.get a 1D or 2D CUDA array descriptor SYNOPSIS CUresult cuArrayGetDescriptor(CUDA_ARRAY_DESCRIPTOR* arrayDesc. It is useful for subroutines that have been passed a CUDA array.

8. SEE ALSO cuArrayCreate. cuArrayGetDescriptor. It is useful for subroutines that have been passed a CUDA array.2. cuArray3DCreate. cuArrayDestroy 158 . CUarray array). 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. but need to know the CUDA array parameters for validation or other purposes. asynchronous launches.5 cuArray3DGetDescriptor NAME cuArray3DGetDescriptor .get a 3D CUDA array descriptor SYNOPSIS CUresult cuArray3DGetDescriptor(CUDA_ARRAY3D_DESC *arrayDesc. DESCRIPTION Returns in *arrayDesc a descriptor containing information on the format and dimensions of the CUDA array array.

asynchronous launches. cuMemset2D 159 . cuMemAllocHost. cuArrayDestroy. SEE ALSO cuMemGetInfo.8.6 cuMemAlloc NAME cuMemAlloc .2. cuMemAllocPitch. If count is 0. unsigned int count). cuArrayCreate. cuMemset. cuMemFreeHost. DESCRIPTION Allocates count bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. 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. cuMemFree. The allocated memory is suitably aligned for any kind of variable. cuMemGetAddressRange.allocates device memory SYNOPSIS CUresult cuMemAlloc(CUdeviceptr* devPtr. cuMemAlloc() returns CUDA_ERROR_INVALID_VALUE. The memory is not cleared. cuArrayGetDescriptor.

this function is best used sparingly to allocate staging areas for data exchange between host and device.allocates page-locked host memory SYNOPSIS CUresult cuMemAllocHost(void** hostPtr. cuMemset2D 160 . cuMemFreeHost. cuMemset. it can be read or written with much higher bandwidth than pageable memory obtained with functions such as malloc(). SEE ALSO cuMemGetInfo. Since the memory can be accessed directly by the device. cuArrayGetDescriptor. Allocating excessive amounts of memory with cuMemAllocHost() may degrade system performance. cuMemGetAddressRange. asynchronous launches. DESCRIPTION Allocates count bytes of host memory that is page-locked and accessible to the device. cuMemAllocPitch. since it reduces the amount of memory available to the system for paging. 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.7 cuMemAllocHost NAME cuMemAllocHost . As a result. cuArrayDestroy. cuMemAlloc. The driver tracks the virtual memory ranges allocated with this function and automatically accelerates calls to functions such as cuMemcpy(). cuMemFree.8.2. cuArrayCreate. unsigned int count).

unsigned int elementSizeBytes).2. elementSizeBytes may be 4. For allocations of 2D arrays. 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).allocates device memory SYNOPSIS CUresult cuMemAllocPitch(CUdeviceptr* devPtr.8 cuMemAllocPitch NAME cuMemAllocPitch . DESCRIPTION Allocates at least widthInBytes*height bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory. The intended usage of pitch is as a separate parameter of the allocation. Due to alignment restrictions in the hardware. but possibly at reduced speed. the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * Pitch) + Column. The pitch returned by cuMemAllocPitch() is guaranteed to work with cuMemcpy2D() under all circumstances. 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. unsigned int* pitch. If elementSizeBytes is smaller than the actual read/write size of a kernel. used to compute addresses within the 2D array. 161 . asynchronous launches. 8 or 16 (since coalesced memory transactions are not possible on other data sizes). 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 height.8. The pitch returned in *pitch by cuMemAllocPitch() is the width in bytes of the allocation. it is recommended that programmers consider performing pitch allocations using cuMemAllocPitch(). the kernel will run correctly. unsigned int widthInBytes. elementSizeBytes specifies the size of the largest reads and writes that will be performed on the memory range.

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

cuMemAlloc. cuArrayDestroy. SEE ALSO cuMemGetInfo. cuArrayCreate. cuMemGetAddressRange. cuArrayGetDescriptor. DESCRIPTION Frees the memory space pointed to by devPtr.8. 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.frees device memory SYNOPSIS CUresult cuMemFree(CUdeviceptr devPtr).9 cuMemFree NAME cuMemFree . cuMemFreeHost. cuMemset. cuMemAllocPitch. cuMemAllocHost. cuMemset2D 163 . which must have been returned by a previous call to cuMemMalloc() or cuMemMallocPitch().2.

cuMemGetAddressRange. cuMemAlloc. 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. cuMemset. cuArrayCreate.frees page-locked host memory SYNOPSIS CUresult cuMemFreeHost(void* hostPtr). cuMemset2D 164 . SEE ALSO cuMemGetInfo. asynchronous launches.8.2. cuMemFree. cuMemAllocHost. DESCRIPTION Frees the memory space pointed to by hostPtr. cuArrayDestroy. which must have been returned by a previous call to cuMemAllocHost(). cuMemAllocPitch.10 cuMemFreeHost NAME cuMemFreeHost . cuArrayGetDescriptor.

cuMemset2D 165 . cuMemAllocPitch. cuMemset. cuArrayDestroy. 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* size. cuMemFree.2. it is ignored.get information on memory allocations SYNOPSIS CUresult cuMemGetAddressRange(CUdeviceptr* basePtr. asynchronous launches. DESCRIPTION Returns the base address in *basePtr and size and *size of the allocation by cuMemAlloc() or cuMemAllocPitch() that contains the input pointer devPtr. cuMemAlloc. cuMemAllocHost. cuArrayGetDescriptor. cuArrayCreate. SEE ALSO cuMemGetInfo.11 cuMemGetAddressRange NAME cuMemGetAddressRange . If one of them is null. CUdeviceptr devPtr). Both parameters basePtr and size are optional.8. cuMemFreeHost.

cuMemset. asynchronous launches. cuArrayCreate. in bytes.2. the free and total amount of memory available for allocation by the CUDA context. cuMemFreeHost. cuMemFree. 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. cuArrayGetDescriptor. cuArrayDestroy. unsigned int* total). cuMemAllocHost. cuMemAllocPitch.12 cuMemGetInfo NAME cuMemGetInfo . cuMemset2D 166 . cuMemGetAddressRange. SEE ALSO cuMemAlloc. DESCRIPTION Returns in *free and *total respectively.gets free and total memory SYNOPSIS CUresult cuMemGetInfo(unsigned int* free.8.

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

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

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

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

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

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

dstArray and srcArray specify the handles of the destination and source CUDA arrays for the copy. cuMemcpyDtoD. cuMemcpyHtoA. SEE ALSO cuMemcpyHtoD. These values are in the range [0. they are not byte offsets. cuMemcpyDtoA. cuMemcpyAtoH. but the elements must be the same size. cuMemcpy2D 173 . The size of the elements in the CUDA arrays need not be the same format. count is the number of bytes to be copied. respectively.8. dstIndex and srcIndex specify the destination and source indices into the CUDA array. asynchronous launches. unsigned int count). cuMemcpyDtoH. CUarray srcArray.copies memory from Array to Array SYNOPSIS CUresult cuMemcpyAtoA(CUarray dstArray. DESCRIPTION Copies from one 1D CUDA array to another.15 cuMemcpyAtoA NAME cuMemcpyAtoA . and count must be evenly divisible by that size. 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. Width-1] for the CUDA array.2. unsigned int srcIndex. unsigned int dstIndex.

cuMemcpyDtoA. cuMemcpy2D 174 . unsigned int count). srcArray and srcIndex specify the CUDA array handle and the index (in array elements) of the array element where the copy is to begin.8.copies memory from Array to Device SYNOPSIS CUresult cuMemcpyAtoD(CUdeviceptr dstDevPtr. unsigned int srcIndex. cuMemcpyDtoH. asynchronous launches. dstDevPtr specifies the base pointer of the destination and must be naturally aligned with the CUDA array elements. cuMemcpyHtoA. SEE ALSO cuMemcpyHtoD. cuMemcpyDtoD. cuMemcpyAtoH. count specifies the number of bytes to copy and must be evenly divisible by the array element 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.2. CUarray srcArray. cuMemcpyAtoA.16 cuMemcpyAtoD NAME cuMemcpyAtoD . DESCRIPTION Copies from a 1D CUDA array to device memory.

copies memory from Array to Host SYNOPSIS CUresult cuMemcpyAtoH(void* dstHostPtr.2. asynchronous launches. cuMemcpy2D 175 . count specifies the number of bytes to copy. CUresult cuMemcpyAtoHAsync(void* dstHostPtr. cuMemcpyAtoA. SEE ALSO cuMemcpyHtoD. cuMemcpyDtoA. CUarray srcArray. unsigned int srcIndex.8. unsigned int count). unsigned int count. dstHostPtr specifies the base pointer of the destination. unsigned int srcIndex. cuMemcpyAtoD. srcArray and srcIndex specify the CUDA array handle and starting index of the source data. cuMemcpyDtoH. DESCRIPTION Copies from a 1D CUDA array to host memory. cuMemcpyDtoD. cuMemcpyAtoHAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. CUstream stream). CUarray srcArray. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input.17 cuMemcpyAtoH NAME cuMempcyAtoH . 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.

unsigned int count). count specifies the number of bytes to copy. cuMemcpyDtoH. asynchronous launches. unsigned int dstIndex. SEE ALSO cuMemcpyHtoD.8. dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. cuMemcpyAtoD. cuMemcpyAtoA. cuMemcpyHtoA. cuMemcpy2D 176 . CUdeviceptr srcDevPtr.copies memory from Device to Array SYNOPSIS CUresult cuMemcpyDtoA(CUarray dstArray. cuMemcpyDtoD. 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. srcDevPtr specifies the base pointer of the source. DESCRIPTION Copies from device memory to a 1D CUDA array.18 cuMemcpyDtoA NAME cuMemcpyDtoA . cuMemcpyAtoH.

respectively. CUdeviceptr srcDevPtr. cuMemcpyAtoH. DESCRIPTION Copies from device memory to device memory. cuMemcpyAtoA.2. cuMemcpyDtoA.8. cuMemcpy2D 177 . cuMemcpyAtoD. dstDevice and srcDevPtr are the base pointers of the destination and source. cuMemcpyHtoA. asynchronous launches. count specifies the number of bytes to copy. 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.19 cuMemcpyDtoD NAME cuMemcpyDtoD . cuMemcpyDtoH. SEE ALSO cuMemcpyHtoD.copies memory from Device to Device SYNOPSIS CUresult cuMemcpyDtoD(CUdeviceptr dstDevPtr.

unsigned int count). asynchronous launches. cuMemcpyHtoA. cuMemcpyAtoA. CUresult cuMemcpyDtoHAsync(void* dstHostPtr. cuMemcpyDtoA. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input.20 cuMemcpyDtoH NAME cuMemcpyDtoH . 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. dstHostPtr and srcDevPtrspecify the base addresses of the source and destination.2. MemcpyDtoHAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. SEE ALSO cuMemcpyHtoD. CUstream stream). respectively. cuMemcpyAtoD.8. countspecifies the number of bytes to copy. CUdeviceptr srcDevPtr. cuMemcpyAtoH. DESCRIPTION Copies from device to host memory. unsigned int count. cuMemcpy2D 178 . cuMemcpyDtoD.copies memory from Device to Host SYNOPSIS CUresult cuMemcpyDtoH(void* dstHostPtr.

2. unsigned int count. cuMemcpyAtoH. DESCRIPTION Copies from host memory to a 1D CUDA array. cuMemcpyAtoD. cuMemcpyDtoD. SEE ALSO cuMemcpyHtoD.21 cuMemcpyHtoA NAME cuMemcpyHtoA . cuMemcpyDtoA. asynchronous launches. CUresult cuMemcpyHtoAAsync(CUarray dstArray. cuMemcpyHtoAAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. cuMemcpy2D 179 . count specifies the number of bytes to copy. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. const void *srcHostPtr. cuMemcpyAtoA. unsigned int count).copies memory from Host to Array SYNOPSIS CUresult cuMemcpyHtoA(CUarray dstArray. unsigned int dstIndex. 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. CUstream stream).8. srcHostPtr specify the base addresse of the source. const void *srcHostPtr. dstArray and dstIndex specify the CUDA array handle and starting index of the destination data. unsigned int dstIndex. cuMemcpyDtoH.

copy memory from Host to Device SYNOPSIS CUresult cuMemcpyHtoD(CUdeviceptr dstDevPtr. asynchronous launches. CUstream stream). cuMemcpyHtoA. 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. unsigned int count. cuMemcpyDtoA.22 cuMemcpyHtoD NAME cuMemcpyHtoD . cuMemcpy2D 180 . 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. respectively. CUresult cuMemcpyHtoDAsync(CUdeviceptr dstDevPtr. cuMemcpyAtoA. cuMemcpyAtoD. cuMemcpyDtoD. dstDevPtr and srcHostPtr specify the base addresses of the destination and source. unsigned int count).2. const void *srcHostPtr. SEE ALSO cuMemcpyDtoH. cuMemcpyAtoH.8. count specifies the number of bytes to copy. DESCRIPTION Copies from host memory to device memory.

cuArrayCreate. unsigned int count ). unsigned char value. unsigned int value.8. unsigned int count ). CUresult cuMemsetD16(CUdeviceptr dstDevPtr. DESCRIPTION Sets the memory range of count 8-. cuMemAlloc. cuMemAllocHost. unsigned short value. cuArrayGetDescriptor. CUresult cuMemsetD32(CUdeviceptr dstDevPtr.initializes device memory SYNOPSIS CUresult cuMemsetD8(CUdeviceptr dstDevPtr. asynchronous launches. SEE ALSO cuMemGetInfo. unsigned int count ). cuMemset2D 181 . cuMemFreeHost. cuArrayDestroy. or 32-bit values to the specified value value.23 cuMemset NAME cuMemset . 16-. 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. cuMemFree. cuMemGetAddressRange.2. cuMemAllocPitch.

cuArrayGetDescriptor. unsigned short value. unsigned char value.2. unsigned int dstPitch. These functions perform fastest when the pitch is one that has been passed back by cuMemAllocPitch(). cuMemFreeHost. cuArrayCreate. SEE ALSO cuMemGetInfo.24 cuMemset2D NAME cuMemset2D . DESCRIPTION Sets the 2D memory range of width 8-. height specifies the number of rows to set. unsigned int width. 16-. cuMemAlloc. cuArrayDestroy. unsigned int height ). unsigned int width. unsigned int width.initializes device memory SYNOPSIS CUresult cuMemsetD2D8(CUdeviceptr dstDevPtr. or 32-bit values to the specified value value. CUresult cuMemsetD2D32(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. unsigned int value. cuMemAllocPitch. asynchronous launches. cuMemFree. cuMemset 182 . unsigned int dstPitch. unsigned int height ). cuMemAllocHost. cuMemGetAddressRange. unsigned int dstPitch.8. and dstPitch specifies the number of bytes between each row. unsigned int height ). CUresult cuMemsetD2D16(CUdeviceptr dstDevPtr.

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

9. cuTexRefSetArray. the application should call cuParamSetTexRef().) to be used when the memory is read through this texture reference. cuTexRefGetFlags 184 . SEE ALSO cuTexRefDestroy. cuTexRefSetAddress. cuTexRefGetArray. cuTexRefGetFilterMode. cuTexRefSetAddressMode. cuTexRefSetFormat. 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. filtering. cuTexRefSetFilterMode. the application must call cuTexRefSetArray() or cuTexRefSetAddress() to associate the reference with allocated memory. cuTexRefGetAddress. cuTexRefGetFormat. DESCRIPTION Creates a texture reference and returns its handle in *texRef. cuTexRefSetFlags.2.1 cuTexRefCreate NAME cuTexRefCreate . Once created. To associate the texture reference with a texture ordinal for a given function. etc. cuTexRefGetAddressMode. asynchronous launches. Other texture reference functions are used to specify the format and interpretation (addressing.creates a texture-reference SYNOPSIS CUresult cuTexRefCreate(CUtexref* 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. cuTexRefGetAddress. cuTexRefGetFormat. asynchronous launches. cuTexRefGetFilterMode. cuTexRefSetFormat.destroys a texture-reference SYNOPSIS CUresult cuTexRefDestroy(CUtexref texRef). cuTexRefGetAddressMode. DESCRIPTION Destroys the texture reference. cuTexRefGetFlags 185 . cuTexRefGetArray. cuTexRefSetArray.2.2 cuTexRefDestroy NAME cuTexRefDestroy . cuTexRefSetAddress. cuTexRefSetFlags. cuTexRefSetFilterMode. SEE ALSO cuTexRefCreate. cuTexRefSetAddressMode.9.

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.gets the address associated with a texture-reference SYNOPSIS CUresult cuTexRefGetAddress(CUdeviceptr* devPtr. cuTexRefSetArray.3 cuTexRefGetAddress NAME cuTexRefGetAddress . CUtexref texRef). or returns CUDA_ERROR_INVALID_VA if the texture reference is not bound to any device memory range. DESCRIPTION Returns in *devPtr the base address bound to the texture reference texRef. cuTexRefSetFormat. SEE ALSO cuTexRefCreate. cuTexRefGetAddressMode. cuTexRefDestroy. cuTexRefGetArray. cuTexRefGetFormat. cuTexRefGetFlags 186 .9. cuTexRefSetAddressMode. cuTexRefSetAddress. cuTexRefSetFilterMode.2. asynchronous launches. cuTexRefSetFlags.

cuTexRefDestroy. cuTexRefSetAddress. cuTexRefSetFilterMode. CUtexref texRef. SEE ALSO cuTexRefCreate.4 cuTexRefGetAddressMode NAME cuTexRefGetAddressMode . Currently the only valid values for dim are 0 and 1. cuTexRefSetArray. int dim).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 Returns in *mode the addressing mode corresponding to the dimension dim of the texture reference texRef. asynchronous launches.2. cuTexRefSetAddressMode.gets the addressing mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetAddressMode(CUaddress_mode* mode. cuTexRefGetFlags 187 . cuTexRefSetFormat. cuTexRefGetAddress. cuTexRefSetFlags. cuTexRefGetFormat. cuTexRefGetFilterMode. cuTexRefGetArray.

cuTexRefGetAddress.9. CUtexref 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.gets the array bound to a texture-reference SYNOPSIS CUresult cuTexRefGetArray(CUarray* array. cuTexRefSetFormat.2. cuTexRefGetFormat. cuTexRefGetFlags 188 .5 cuTexRefGetArray NAME cuTexRefGetArray . cuTexRefSetFilterMode. cuTexRefGetAddressMode. cuTexRefSetFlags. SEE ALSO cuTexRefCreate. cuTexRefDestroy. cuTexRefSetAddressMode. cuTexRefSetArray. DESCRIPTION Returns in *array the CUDA array bound by the texture reference texRef. cuTexRefSetAddress. or returns CUDA_ERROR_INVALID_VAL if the texture reference is not bound to any CUDA array. asynchronous launches. cuTexRefGetFilterMode.

2. cuTexRefGetArray. cuTexRefGetFlags 189 . cuTexRefSetAddressMode. cuTexRefSetAddress. cuTexRefGetAddressMode. CUtexref 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.9. cuTexRefSetFilterMode. DESCRIPTION Returns in *mode the filtering mode of the texture reference texRef. cuTexRefSetFormat. cuTexRefGetAddress. cuTexRefSetFlags. cuTexRefDestroy. cuTexRefGetFormat.gets the filter-mode used by a texture-reference SYNOPSIS CUresult cuTexRefGetFilterMode(CUfilter_mode* mode. SEE ALSO cuTexRefCreate. asynchronous launches.6 cuTexRefGetFilterMode NAME cuTexRefGetFilterMode . cuTexRefSetArray.

2. cuTexRefGetFormat 190 . cuTexRefSetArray. cuTexRefSetFlags. DESCRIPTION Returns in *flags the flags of the texture reference texRef. cuTexRefSetFilterMode.gets the flags used by a texture-reference SYNOPSIS CUresult cuTexRefGetFlags(unsigned int* flags. SEE ALSO cuTexRefCreate. cuTexRefGetAddressMode. asynchronous launches. cuTexRefDestroy. cuTexRefGetAddress. cuTexRefGetArray. cuTexRefSetAddressMode.7 cuTexRefGetFlags NAME cuTexRefGetFlags . cuTexRefSetFormat. cuTexRefSetAddress. 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. CUtexref texRef).9.

cuTexRefSetAddressMode.8 cuTexRefGetFormat NAME cuTexRefGetFormat . cuTexRefGetFlags 191 .gets the format used by a texture-reference SYNOPSIS CUresult cuTexRefGetFormat(CUarray_format* format. CUtexref texRef). cuTexRefGetFilterMode. it will be ignored. cuTexRefSetAddress. cuTexRefSetFlags. cuTexRefGetAddress. cuTexRefSetArray.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.9. cuTexRefSetFormat. SEE ALSO cuTexRefCreate. cuTexRefDestroy. cuTexRefSetFilterMode. int* numPackedComponents. cuTexRefGetArray. asynchronous launches. cuTexRefGetAddressMode. If format or numPackedComponents is null. DESCRIPTION Returns in *format and *numPackedComponents the format and number of components of the CUDA array bound to the texture reference texRef.

cuTexRefSetAddressMode. cuTexRefSetFormat. Any previous address or CUDA array state associated with the texture reference is superseded by this function.9. cuTexRefSetAddress() passes back a byte offset in *byteOffset that must be applied to texture fetches in order to read from the desired memory. cuTexRefGetAddressMode. Any memory previously bound to texRef is unbound. cuTexRefSetFilterMode. CUtexref texRef. cuTexRefGetArray. cuTexRefGetFilterMode. cuTexRefSetArray. 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(). 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. cuTexRefGetAddress.2. Since the hardware enforces an alignment requirement on texture base addresses. cuTexRefGetFlags 192 .binds an address as a texture-reference SYNOPSIS CUresult cuTexRefSetAddress(unsigned int* byteOffset. asynchronous launches. cuTexRefDestroy. DESCRIPTION Binds a linear address range to the texture reference texRef. int bytes).9 cuTexRefSetAddress NAME cuTexRefSetAddress . 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. CUdeviceptr devPtr. cuTexRefGetFormat. SEE ALSO cuTexRefCreate.

CU_TR_ADDRESS_MODE_MIRROR = 2. cuTexRefSetAddress.set the addressing mode for a texture-reference SYNOPSIS CUresult cuTexRefSetAddressMode(CUtexref texRef. } CUaddress_mode. asynchronous launches. Note that this call has no effect if texRef is bound to linear memory. the addressing mode is applied to the first parameter of the functions used to fetch from the texture. cuTexRefSetFlags. int dim. CUaddress_mode mode). and so on. CUaddress_mode is defined as such: typedef enum CUaddress_mode_enum { CU_TR_ADDRESS_MODE_WRAP = 0. the second. SEE ALSO cuTexRefCreate. if dim is 1. cuTexRefSetFilterMode.9. cuTexRefDestroy. CU_TR_ADDRESS_MODE_CLAMP = 1. DESCRIPTION Specifies the addressing mode mode for the given dimension of the texture reference texRef. cuTexRefSetFormat. cuTexRefGetArray. If dim is zero. cuTexRefGetFormat.10 cuTexRefSetAddressMode NAME cuTexRefSetAddressMode . 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. cuTexRefSetArray. cuTexRefGetFilterMode. cuTexRefGetAddressMode. cuTexRefGetFlags 193 . cuTexRefGetAddress.

asynchronous launches. cuTexRefSetAddress. cuTexRefGetFormat. cuTexRefSetAddressMode. unsigned int flags). cuTexRefSetFormat. cuTexRefGetArray. cuTexRefGetFlags 194 . Any CUDA array previously bound to texRef is unbound. cuTexRefSetFilterMode.11 cuTexRefSetArray NAME cuTexRefSetArray .binds an array to a texture-reference SYNOPSIS CUresult cuTexRefSetArray(CUtexref 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.2. cuTexRefGetAddressMode.9. SEE ALSO cuTexRefCreate. DESCRIPTION Binds the CUDA array array to the texture reference texRef. cuTexRefSetFlags. flags must be set to CU_TRSA_OVERRIDE_FORMAT. cuTexRefDestroy. Any previous address or CUDA array state associated with the texture reference is superseded by this function. cuTexRefGetAddress. CUarray array. cuTexRefGetFilterMode.

12 cuTexRefSetFilterMode NAME cuTexRefSetFilterMode . CUfilter_mode mode). DESCRIPTION Specifies the filtering mode mode to be used when reading memory through the texture reference texRef. cuTexRefGetAddress.sets the mode for a texture-reference SYNOPSIS CUresult cuTexRefSetFilterMode(CUtexref texRef.9. cuTexRefGetArray. cuTexRefSetAddress. cuTexRefGetAddressMode. cuTexRefSetFormat. CU_TR_FILTER_MODE_LINEAR = 1 } CUfilter_mode. Note that this call has no effect if texRef is bound to linear memory. cuTexRefDestroy. asynchronous launches.2. CUfilter_mode_enum is defined as such: typedef enum CUfilter_mode_enum { CU_TR_FILTER_MODE_POINT = 0. SEE ALSO cuTexRefCreate. cuTexRefSetAddressMode. cuTexRefGetFlags 195 . 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. cuTexRefSetArray. cuTexRefSetFlags. cuTexRefGetFilterMode.

cuTexRefSetFormat. cuTexRefSetFilterMode. 1]. which suppresses the default behavior of having the texture promote integer data to floating point data in the range [0. The valid flags are: • CU_TRSF_READ_AS_INTEGER. • CU_TRSF_NORMALIZED_COORDINATES. cuTexRefGetFlags 196 . Dim) where Dim is the width or height of the CUDA array. cuTexRefGetAddressMode.13 cuTexRefSetFlags NAME cuTexRefSetFlags .sets flags for a texture-reference SYNOPSIS CUresult cuTexRefSetFlags(CUtexref texRef. cuTexRefDestroy. cuTexRefSetAddressMode. cuTexRefSetArray. 1. Instead. cuTexRefGetFormat. DESCRIPTION Specifies optional flags to control the behavior of data returned through the texture reference. cuTexRefGetArray. which suppresses the default behavior of having the texture coordinates range from [0.9. cuTexRefGetAddress. cuTexRefSetAddress. asynchronous launches. unsigned int Flags). cuTexRefGetFilterMode. SEE ALSO cuTexRefCreate.2.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.

cuTexRefSetAddressMode. cuTexRefSetFlags. SEE ALSO cuTexRefCreate. 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. cuTexRefGetAddressMode. cuTexRefGetAddress. 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.sets the format for a texture-reference SYNOPSIS CUresult cuTexRefSetFormat(CUtexref texRef. cuTexRefSetAddress.9. cuTexRefSetFilterMode. cuTexRefGetFilterMode. cuTexRefGetArray. asynchronous launches. cuTexRefDestroy.2. cuTexRefSetArray. cuTexRefGetFlags 197 .14 cuTexRefSetFormat NAME cuTexRefSetFormat . CUarray_format format. cuTexRefGetFormat. int numPackedComponents) DESCRIPTION Specifies the format of the data to be read by the texture reference texRef.

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

For usage of the Flags parameter. see cuCtxCreate. cuGLMapBufferObject.1 cuGLCtxCreate NAME cuGLCtxCreate . DESCRIPTION Creates a new CUDA context. and associates the CUDA context with the calling thread. SEE ALSO cuCtxCreate. unsigned int Flags. cuGLUnregisterBufferObject 199 . It must be called before performing any other OpenGL interoperability operations. CUdevice device).create a CUDA context for interoperability with OpenGL SYNOPSIS CUresult cuGLCtxCreate(CUcontext *pCtx. 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. cuGLInit cuGLRegisterBufferObject.2.10. It may fail if the needed OpenGL driver facilities are not available. cuGLUnmapBufferObject. asynchronous launches.

It must be called before performing any other OpenGL interoperability operations. SEE ALSO cuGLCtxCreate. cuGLUnregisterBufferObject 200 . It may fail if the needed OpenGL driver facilities are not available.10.2 cuGLInit NAME cuGLInit .2.initializes GL interoperability SYNOPSIS CUresult cuGLInit(void). cuGLUnmapBufferObject. DESCRIPTION Initializes OpenGL interoperability. asynchronous launches. cuGLMapBufferObject. 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. cuGLRegisterBufferObject.

cuGLRegisterBufferObject. 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. asynchronous launches. SEE ALSO cuGLCtxCreate. cuGLUnmapBufferObject.2. GLuint bufferObj). cuGLInit.maps a GL buffer object SYNOPSIS CUresult cuGLMapBufferObject(CUdeviceptr* devPtr. cuGLUnregisterBufferObject 201 . unsigned int* size.10.3 cuGLMapBufferObject NAME cuGLMapBufferObject . 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.

cuGLInit. 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. the buffer object cannot be used by any OpenGL commands except as a data source for OpenGL drawing commands. cuGLUnmapBufferObject. DESCRIPTION Registers the buffer object of ID bufferObj for access by CUDA. SEE ALSO cuGLCtxCreate. cuGLUnregisterBufferObject 202 . While it is registered.registers a GL buffer object SYNOPSIS CUresult cuGLRegisterBufferObject(GLuint bufferObj).10.2. This function must be called before CUDA can map the buffer object. asynchronous launches.4 cuGLRegisterBufferObject NAME cuGLRegisterBufferObject . cuGLMapBufferObject.

SEE ALSO cuGLCtxCreate. cuGLUnregisterBufferObject 203 . cuGLRegisterBufferObject.unmaps a GL buffer object SYNOPSIS CUresult cuGLUnmapBufferObject(GLuint bufferObj).2.5 cuGLUnmapBufferObject NAME cuGLUnmapBufferObject . 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 Unmaps the buffer object of ID bufferObj for access by CUDA.10. cuGLInit. cuGLMapBufferObject.

10.6 cuGLUnregisterBufferObject NAME cuGLUnregisterBufferObject . cuGLUnmapBufferObject 204 . DESCRIPTION Unregisters the buffer object of ID bufferObj for access by CUDA. cuGLInit. asynchronous launches.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. cuGLRegisterBufferObject. cuGLMapBufferObject.unregister a GL buffer object SYNOPSIS CUresult cuGLUnregisterBufferObject(GLuint bufferObj). SEE ALSO cuGLCtxCreate.

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

1 cuD3D9GetDevice NAME cuD3D9GetDevice . cuD3D9ResourceGetSurfaceDimensions. cuD3D9RegisterResource. 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. cuD3D9UnmapResources.gets the device number for an adapter SYNOPSIS CUresult cuD3D9GetDevice(CUdevice* dev. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. SEE ALSO cuD3D9CtxCreate. cuD3D9ResourceGetMappedPitch 206 . asynchronous launches. If no device on the adapter with name adapterName is CUDA-compatible then the call will fail.2. cuD3D9MapResources. cuD3D9ResourceSetMapFlags. const char* adapterName).11. cuD3D9UnregisterResource. cuD3D9GetDirect3DDevice. DESCRIPTION Returns in *dev the CUDA-compatible device corresponding to the adapter name adapterName obtained from EnumDisplayDevices or IDirect3D9::GetAdapterIdentifier().

cuD3D9RegisterResource.2. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. asynchronous launches. this call will increase the internal reference count on pDxDevice. On success. Direct3D resources from this device may be registered and mapped through the lifetime of this CUDA context. The CUcontext created will be returned in *pCtx. cuD3D9ResourceGetMappedPitch 207 .create a CUDA context for interoperability with Direct3D SYNOPSIS CUresult cuD3D9CtxCreate(CUcontext* pCtx. If pCuDevice is non-NULL then the CUdevice on which this CUDA context was created will be returned in *pCuDevice. cuD3D9ResourceSetMapFlags. enables interoperability for that context with the Direct3D device pDxDevice. cuD3D9ResourceGetSurfaceDimensions. This context will function only until its Direct3D device is destroyed.11.2 cuD3D9CtxCreate NAME cuD3D9CtxCreate . see cuCtxCreate. 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. CUdevice* pCuDevice. IDirect3DDevice9* pDxDevice). cuD3D9MapResources cuD3D9UnmapResources. cuD3D9GetDirect3DDevice. and associates the created CUDA context with the calling thread. For usage of the Flags parameter. unsigned int Flags. cuD3D9UnregisterResource. DESCRIPTION Creates a new CUDA context. SEE ALSO cuD3D9GetDevice. This reference count will be decremented upon destruction of this context through cuCtxDestroy.

cuD3D9UnmapResources. cuD3D9MapResources. 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.3 cuD3D9GetDirect3DDevice NAME cuD3D9GetDirect3DDevice . DESCRIPTION Returns in *ppDxDevice the Direct3D device against which this CUDA context was created in cuD3D9CtxCreate. cuD3D9UnregisterResource.get the Direct3D device against which the current CUDA context was created SYNOPSIS CUresult cuD3D9GetDirect3DDevice(IDirect3DDevice9** ppDxDevice). cuD3D9RegisterResource.11.2. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. cuD3D9ResourceGetSurfaceDimensions. cuD3D9ResourceGetMappedPitch 208 . SEE ALSO cuD3D9GetDevice. cuD3D9CtxCreate. asynchronous launches.

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

cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. cuD3D9CtxCreate. If Direct3D interoperability is not initialized on this context then CUDA_ERROR_INVALID_CONTEXT is returned. SEE ALSO cuD3D9GetDevice. cuD3D9MapResources.• Surfaces of depth or stencil formats cannot be shared. is a non-stand-alone IDirect3DSurface9) or is already registered then CUDA_ERROR_INVALID_HANDLE is returned. cuD3D9UnmapResources. 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. If pResource is of incorrect type (e. cuD3D9ResourceGetSurfaceDimensions. cuD3D9ResourceGetMappedPitch 210 . cuD3D9ResourceSetMapFlags. cuD3D9UnregisterResource. asynchronous launches. If pResource cannot be registered then CUDA_ERROR_UNKNOWN is returned.g. cuD3D9GetDirect3DDevice.

cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. cuD3D9UnmapResources. SEE ALSO cuD3D9GetDevice. asynchronous launches. cuD3D9MapResources. If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned. cuD3D9CtxCreate. cuD3D9GetDirect3DDevice.11. DESCRIPTION Unregisters the Direct3D resource pResource so it is not accessable by CUDA unless registered again. cuD3D9ResourceGetMappedPitch 211 .5 cuD3D9UnregisterResource NAME cuD3D9UnregisterResource .2. cuD3D9ResourceGetSurfaceDimensions. 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. cuD3D9ResourceSetMapFlags. cuD3D9RegisterResource.unregister a Direct3D resource SYNOPSIS CUresult cuD3D9UnregisterResource(IDirect3DResource9* pResource).

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_ALREADY_MAPPED CUDA_ERROR_UNKNOWN Note that this function may also return error codes from previous. cuD3D9GetDirect3DDevice. cuD3D9ResourceGetMappedPitch 212 . cuD3D9CtxCreate. cuD3D9UnregisterResource. cuD3D9ResourceGetMappe cuD3D9ResourceGetMappedSize. cuD3D9UnmapResources. If any of ppResources are presently mapped for access by CUDA then CUDA_ERROR_ALREADY_MAPPED is returned. Direct3D should not access any resources while they are mapped by CUDA. DESCRIPTION Maps the count Direct3D resources in ppResources for access by CUDA. The resources in ppResources may be accessed in CUDA kernels until they are unmapped.map Direct3D resources for access by CUDA SYNOPSIS CUresult cuD3D9MapResources(unsigned int count. This function provides the synchronization guarantee that any Direct3D calls issued before cuD3D9MapResources will complete before any CUDA kernels issued after cuD3D9MapResources begin. If an application does so the results are undefined.6 cuD3D9MapResources NAME cuD3D9MapResources .11. cuD3D9RegisterResource. 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). asynchronous launches. SEE ALSO cuD3D9GetDevice. cuD3D9ResourceGetSurfaceDimensions. cuD3D9ResourceSetMapFlags.

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

217 . For all other types Face must be 0. For all other types Level must be 0. If pResource is of type IDirect3DCubeTexture9 then Face must one of the values enumerated by type D3DCUBEMAP_FACES. DESCRIPTION Returns in *pDevPtr the base pointer of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. If pResource is not registered then CUDA_ERROR_INVALID_HANDLE is returned. The value set in pDevPtr may change every time that pResource is mapped. If pResource is of type IDirect3DBaseTexture9 then Level must correspond to a valid mipmap level. At present only mipmap level 0 is supported.11.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.10 cuD3D9ResourceGetMappedPointer NAME cuD3D9ResourceGetMappedPointer . unsigned int Face. If Face is invalid then CUDA_ERROR_INVALID_V is returned.2. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVA is returned. IDirect3DResource9* pResource. asynchronous launches. unsigned int Level). If Level is invalid then CUDA_ERROR_INVALID_VALUE 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. If pResource is not mapped then CUDA_ERROR_NOT_MAPPED is returned.

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

For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer. cuD3D9UnregisterResource. IDirect3DResource9* pResource. cuD3D9ResourceGetSurfaceDimensions. cuD3D9GetDirect3DDevice. cuD3D9UnmapResources. The value set in pSize may change every time that pResource is mapped. unsigned int Face.11. cuD3D9ResourceGetMappedPitch 219 .11 cuD3D9ResourceGetMappedSize NAME cuD3D9ResourceGetMappedSize . cuD3D9ResourceGetMappedPointer. unsigned int Level). cuD3D9RegisterResource. cuD3D9ResourceSetMapFlags. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned.get the size of a subresource of a Direct3D resource which has been mapped for access by CUDA SYNOPSIS CUresult cuD3D9ResourceGetMappedSize(unsigned int* pSize. SEE ALSO cuD3D9GetDevice. DESCRIPTION Returns in *pSize the size of the subresource of the mapped Direct3D resource pResource which corresponds to Face and Level. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE 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.2. cuD3D9MapResources. If pResource has not been registered for use with CUDA then CUDA_ERROR_INVALID_HANDLE is returned. cuD3D9CtxCreate. asynchronous launches.

For usage requirements of Face and Level parameters see cuD3D9ResourceGetMappedPointer.2. 220 . The values set in pPitch and pPitchSlice may change every time that pResource is mapped. 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.12 cuD3D9ResourceGetMappedPitch NAME cuD3D9ResourceGetMappedPitch .y. If pResource is not mapped for access by CUDA then CUDA_ERROR_NOT_MAPPED is returned.11. asynchronous launches.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. 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. unsigned int Level). unsigned int* pPitchSlice.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. 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. If pResource was not registered with usage flags CU_D3D9_REGISTER_FLAGS_NONE then CUDA_ERROR_INVALID_HANDLE is returned. y*pitch + (bytes per pixel)*x For a 3D surface the byte offset of the sample of at position x.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.

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

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

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.

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

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

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

atomicExch. atomicCAS 227 . int val). and stores the result back to global memory at the same address.atomic minimum SYNOPSIS int atomicMin(int* address.3. atomicInc. computes the minimum of old and val. atomicDec. These three operations are performed in one atomic transaction. 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. atomicSub.4 atomicMin NAME atomicMin . The function returns b<old>. SEE ALSO atomicAdd. unsigned int atomicMin(unsigned int* address.1 and higher.1. atomicMax. unsigned int val).

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful