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

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

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

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

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

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

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

If there is no such device.0 that are available for execution. cudaSetDevice. this device will report major and minor compute capability versions of 9999.1. cudaChooseDevice 3 .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. asynchronous launches. Since this device will be able to emulate all hardware features. 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. cudaGetDeviceProperties.1.1 cudaGetDeviceCount NAME cudaGetDeviceCount . SEE ALSO cudaGetDevice.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

5. cudaMallocArray. The function may pad the allocation to ensure that corresponding pointers in any given row will continue to meet the alignment requirements for coalescing as the address is updated from row to row. For allocations of 2D arrays. cudaFreeArray. 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). Due to pitch alignment restrictions in the hardware.1. cudaFreeHost 26 . 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. 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. it is recommended that programmers consider performing pitch allocations using cudaMallocPitch(). The intended usage of pitch is as a separate parameter of the allocation. size_t height ) DESCRIPTION Allocates at least widthInBytes*height bytes of linear memory on the device and returns in *devPtr a pointer to the allocated memory.2 cudaMallocPitch NAME cudaMallocPitch . asynchronous launches. SEE ALSO cudaMalloc. the address is computed as T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column.allocates memory on the GPU SYNOPSIS cudaError_t cudaMallocPitch( void** devPtr. size_t* pitch. cudaFree. cudaMallocHost. size_t widthInBytes.

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

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

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

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

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

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

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

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

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

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

including any padding added to the end of each row. asynchronous launches.13 cudaMemcpy2DToArray NAME cudaMemcpy2DToArray .5. cudaError_t cudaMemcpy2DToArrayAsync(struct cudaArray* dstArray. const void* src. dstY). cudaMemcpyArrayToArray. cudaMemcpyToArray. size_t dstY. enum cudaMemcpyKind kind. size_t width. cudaMemcpyDeviceToHost.copies data between host and device SYNOPSIS cudaError_t cudaMemcpy2DToArray(struct cudaArray* dstArray. where kind is one of cudaMemcpyHostToHost. 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. size_t height. and specifies the direction of the copy. cudaMemcpyToSymbol. spitch is the width in memory in bytes of the 2D array pointed to by src.1. size_t spitch. cudaStream_t stream). 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. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. size_t spitch. size_t dstX. size_t height. cudaMemcpyHostToDevice. cudaMemcpy2DToArrayAsync() is asynchronous and can optionally be associated to a stream by passing a non-zero stream argument. cudaMemcpyFromArray. cudaMemcpy2DArrayToArray. enum cudaMemcpyKind kind). cudaMemcpy2DFromArray. size_t width. size_t dstX. cudaMemcpyFromSymbol 37 . or cudaMemcpyDeviceToDevice. cudaMemcpy2D() returns an error if spitch is greater than the maximum allowed. cudaMemcpy2D. const void* src.

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

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

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

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

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

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

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

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

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

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

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

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

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

cudaMalloc3D 51 .SEE ALSO cudaMemset. cudaMemset2D.

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

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

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

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

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

cudaGetTextureAlignmentOffset 57 . cudaUnbindTexture. SEE ALSO cudaCreateChannelDesc.Low-level texture API SYNOPSIS cudaError_t cudaGetChannelDesc(struct cudaChannelFormatDesc* desc. asynchronous launches. cudaBindTexture. const struct cudaArray* array). 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. cudaBindTextureToArray.cudaGetChannelDesc NAME cudaGetChannelDesc .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

10. 95 .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. RETURN VALUE Relevant return values: cudaSuccess cudaErrorInitializationError cudaErrorLaunchFailure cudaErrorPriorLaunchFailure cudaErrorLaunchTimeout cudaErrorLaunchOutOfResources cudaErrorInvalidDeviceFunction cudaErrorInvalidConfiguration cudaErrorInvalidDevice cudaErrorInvalidValue cudaErrorInvalidDevicePointer cudaErrorInvalidTexture cudaErrorInvalidTextureBinding cudaErrorInvalidChannelDescriptor cudaErrorTextureFetchFailed cudaErrorTextureNotBound cudaErrorSynchronizationError cudaErrorUnknown cudaErrorInvalidResourceHandle cudaErrorNotReady Note that this function may also return error codes from previous asynchronous launches.1 cudaGetLastError NAME cudaGetLastError .1.

SEE ALSO cudaGetErrorString. cudaError 96 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

destroys a CUDA array SYNOPSIS CUresult cuArrayDestroy(CUarray array). asynchronous launches.2.8.3 cuArrayDestroy NAME cuArrayDestroy . 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. cuArrayCreate. cuMemFree. cuMemAlloc. cuMemGetAddressRange. cuMemset2D 156 . cuMemset. cuMemAllocPitch. cuMemAllocHost. SEE ALSO cuMemGetInfo. cuMemFreeHost. cuArrayGetDescriptor. DESCRIPTION Destroys the CUDA array array.

but need to know the CUDA array parameters for validation or other purposes. 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_HANDLE Note that this function may also return error codes from previous. CUarray array) DESCRIPTION Returns in *arrayDesc a descriptor of the format and dimensions of the 1D or 2D CUDA array array.2. cuArrayDestroy 157 . cuArray3DCreate. SEE ALSO cuArrayCreate.8.get a 1D or 2D CUDA array descriptor SYNOPSIS CUresult cuArrayGetDescriptor(CUDA_ARRAY_DESCRIPTOR* arrayDesc.4 cuArrayGetDescriptor NAME cuArrayGetDescriptor . cuArray3DGetDescriptor. It is useful for subroutines that have been passed a CUDA array.

cuArray3DCreate. SEE ALSO cuArrayCreate.2. cuArrayDestroy 158 . CUarray array).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. but need to know the CUDA array parameters for validation or other purposes. 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.8.5 cuArray3DGetDescriptor NAME cuArray3DGetDescriptor . asynchronous launches. It is useful for subroutines that have been passed a CUDA array.

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

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

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

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

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

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

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

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

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

cuMemcpyDtoD. cuMemcpyDtoH. SEE ALSO cuMemcpyHtoD. cuMemcpy3D 169 . cuMemcpyDtoA. cuMemcpyAtoA. cuMemcpyAtoD. 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. cuMemcpyAtoH. cuMemcpyHtoA.

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

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

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

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

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

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

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

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

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

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

respectively. unsigned int count). cuMemcpyAtoH. cuMemcpyHtoDAsync() is asynchronous and can optionally be associated to a stream by passing a nonzero stream argument. 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). cuMemcpyDtoD. asynchronous launches.8. cuMemcpyDtoA.22 cuMemcpyHtoD NAME cuMemcpyHtoD . cuMemcpy2D 180 . SEE ALSO cuMemcpyDtoH.copy memory from Host to Device SYNOPSIS CUresult cuMemcpyHtoD(CUdeviceptr dstDevPtr. cuMemcpyHtoA. cuMemcpyAtoD. DESCRIPTION Copies from host memory to device memory. const void *srcHostPtr. cuMemcpyAtoA. It only works on page-locked host memory and returns an error if a pointer to pageable memory is passed as input. CUresult cuMemcpyHtoDAsync(CUdeviceptr dstDevPtr. const void *srcHostPtr.2. count specifies the number of bytes to copy. dstDevPtr and srcHostPtr specify the base addresses of the destination and source. unsigned int count.

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

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

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

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

cuTexRefGetFormat.9.2. cuTexRefGetFilterMode. cuTexRefSetFormat.destroys a texture-reference SYNOPSIS CUresult cuTexRefDestroy(CUtexref texRef). cuTexRefGetArray. cuTexRefSetAddressMode. 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. cuTexRefGetAddress. cuTexRefSetAddress. DESCRIPTION Destroys the texture reference. cuTexRefSetFlags. cuTexRefGetAddressMode. cuTexRefSetArray. SEE ALSO cuTexRefCreate. cuTexRefSetFilterMode.2 cuTexRefDestroy NAME cuTexRefDestroy . cuTexRefGetFlags 185 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful