1 #ifndef _G_VIRTUAL_MEM_NVOC_H_ 2 #define _G_VIRTUAL_MEM_NVOC_H_ 3 #include "nvoc/runtime.h" 4 5 #ifdef __cplusplus 6 extern "C" { 7 #endif 8 9 /* 10 * SPDX-FileCopyrightText: Copyright (c) 2020-2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 11 * SPDX-License-Identifier: MIT 12 * 13 * Permission is hereby granted, free of charge, to any person obtaining a 14 * copy of this software and associated documentation files (the "Software"), 15 * to deal in the Software without restriction, including without limitation 16 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 17 * and/or sell copies of the Software, and to permit persons to whom the 18 * Software is furnished to do so, subject to the following conditions: 19 * 20 * The above copyright notice and this permission notice shall be included in 21 * all copies or substantial portions of the Software. 22 * 23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 26 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 28 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 29 * DEALINGS IN THE SOFTWARE. 30 */ 31 32 #include "g_virtual_mem_nvoc.h" 33 34 #ifndef _VIRTUAL_MEMORY_H_ 35 #define _VIRTUAL_MEMORY_H_ 36 37 #include "mem_mgr/standard_mem.h" 38 #include "gpu/mem_mgr/heap_base.h" 39 40 /*! 41 * Allocator for NV50_MEMORY_VIRTUAL class. 42 * 43 * Describes a range of typed virtual memory. Used as 44 * a target space for RmMapMemoryDma. 45 * 46 * The NV01_MEMORY_VIRTUAL subclass class is typeless. 47 */ 48 #ifdef NVOC_VIRTUAL_MEM_H_PRIVATE_ACCESS_ALLOWED 49 #define PRIVATE_FIELD(x) x 50 #else 51 #define PRIVATE_FIELD(x) NVOC_PRIVATE_FIELD(x) 52 #endif 53 struct VirtualMemory { 54 const struct NVOC_RTTI *__nvoc_rtti; 55 struct StandardMemory __nvoc_base_StandardMemory; 56 struct Object *__nvoc_pbase_Object; 57 struct RsResource *__nvoc_pbase_RsResource; 58 struct RmResourceCommon *__nvoc_pbase_RmResourceCommon; 59 struct RmResource *__nvoc_pbase_RmResource; 60 struct Memory *__nvoc_pbase_Memory; 61 struct StandardMemory *__nvoc_pbase_StandardMemory; 62 struct VirtualMemory *__nvoc_pbase_VirtualMemory; 63 NV_STATUS (*__virtmemMapTo__)(struct VirtualMemory *, struct RS_RES_MAP_TO_PARAMS *); 64 NV_STATUS (*__virtmemUnmapFrom__)(struct VirtualMemory *, struct RS_RES_UNMAP_FROM_PARAMS *); 65 NV_STATUS (*__virtmemCheckMemInterUnmap__)(struct VirtualMemory *, NvBool); 66 NvBool (*__virtmemShareCallback__)(struct VirtualMemory *, struct RsClient *, struct RsResourceRef *, RS_SHARE_POLICY *); 67 NV_STATUS (*__virtmemGetMapAddrSpace__)(struct VirtualMemory *, CALL_CONTEXT *, NvU32, NV_ADDRESS_SPACE *); 68 NvU32 (*__virtmemGetRefCount__)(struct VirtualMemory *); 69 void (*__virtmemAddAdditionalDependants__)(struct RsClient *, struct VirtualMemory *, RsResourceRef *); 70 NV_STATUS (*__virtmemControl_Prologue__)(struct VirtualMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 71 NvBool (*__virtmemIsGpuMapAllowed__)(struct VirtualMemory *, struct OBJGPU *); 72 void (*__virtmemControl_Epilogue__)(struct VirtualMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 73 NV_STATUS (*__virtmemControlLookup__)(struct VirtualMemory *, struct RS_RES_CONTROL_PARAMS_INTERNAL *, const struct NVOC_EXPORTED_METHOD_DEF **); 74 NV_STATUS (*__virtmemControl__)(struct VirtualMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 75 NV_STATUS (*__virtmemUnmap__)(struct VirtualMemory *, CALL_CONTEXT *, RsCpuMapping *); 76 NV_STATUS (*__virtmemGetMemInterMapParams__)(struct VirtualMemory *, RMRES_MEM_INTER_MAP_PARAMS *); 77 NV_STATUS (*__virtmemGetMemoryMappingDescriptor__)(struct VirtualMemory *, MEMORY_DESCRIPTOR **); 78 NV_STATUS (*__virtmemControlFilter__)(struct VirtualMemory *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 79 NV_STATUS (*__virtmemControlSerialization_Prologue__)(struct VirtualMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 80 NvBool (*__virtmemCanCopy__)(struct VirtualMemory *); 81 NV_STATUS (*__virtmemIsReady__)(struct VirtualMemory *, NvBool); 82 NV_STATUS (*__virtmemCheckCopyPermissions__)(struct VirtualMemory *, struct OBJGPU *, NvHandle); 83 void (*__virtmemPreDestruct__)(struct VirtualMemory *); 84 NV_STATUS (*__virtmemIsDuplicate__)(struct VirtualMemory *, NvHandle, NvBool *); 85 void (*__virtmemControlSerialization_Epilogue__)(struct VirtualMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 86 NV_STATUS (*__virtmemMap__)(struct VirtualMemory *, CALL_CONTEXT *, struct RS_CPU_MAP_PARAMS *, RsCpuMapping *); 87 NvBool (*__virtmemAccessCallback__)(struct VirtualMemory *, struct RsClient *, void *, RsAccessRight); 88 NvHandle hVASpace; 89 NvBool bAllowUnicastMapping; 90 NvBool bReserveVaOnAlloc; 91 NvBool bFlaVAS; 92 NvBool bRpcAlloc; 93 NODE *pDmaMappingList; 94 NvBool bOptimizePageTableMempoolUsage; 95 }; 96 97 #ifndef __NVOC_CLASS_VirtualMemory_TYPEDEF__ 98 #define __NVOC_CLASS_VirtualMemory_TYPEDEF__ 99 typedef struct VirtualMemory VirtualMemory; 100 #endif /* __NVOC_CLASS_VirtualMemory_TYPEDEF__ */ 101 102 #ifndef __nvoc_class_id_VirtualMemory 103 #define __nvoc_class_id_VirtualMemory 0x2aea5c 104 #endif /* __nvoc_class_id_VirtualMemory */ 105 106 extern const struct NVOC_CLASS_DEF __nvoc_class_def_VirtualMemory; 107 108 #define __staticCast_VirtualMemory(pThis) \ 109 ((pThis)->__nvoc_pbase_VirtualMemory) 110 111 #ifdef __nvoc_virtual_mem_h_disabled 112 #define __dynamicCast_VirtualMemory(pThis) ((VirtualMemory*)NULL) 113 #else //__nvoc_virtual_mem_h_disabled 114 #define __dynamicCast_VirtualMemory(pThis) \ 115 ((VirtualMemory*)__nvoc_dynamicCast(staticCast((pThis), Dynamic), classInfo(VirtualMemory))) 116 #endif //__nvoc_virtual_mem_h_disabled 117 118 119 NV_STATUS __nvoc_objCreateDynamic_VirtualMemory(VirtualMemory**, Dynamic*, NvU32, va_list); 120 121 NV_STATUS __nvoc_objCreate_VirtualMemory(VirtualMemory**, Dynamic*, NvU32, CALL_CONTEXT * arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL * arg_pParams); 122 #define __objCreate_VirtualMemory(ppNewObj, pParent, createFlags, arg_pCallContext, arg_pParams) \ 123 __nvoc_objCreate_VirtualMemory((ppNewObj), staticCast((pParent), Dynamic), (createFlags), arg_pCallContext, arg_pParams) 124 125 #define virtmemMapTo(pVirtualMemory, pParams) virtmemMapTo_DISPATCH(pVirtualMemory, pParams) 126 #define virtmemUnmapFrom(pVirtualMemory, pParams) virtmemUnmapFrom_DISPATCH(pVirtualMemory, pParams) 127 #define virtmemCheckMemInterUnmap(pMemory, bSubdeviceHandleProvided) virtmemCheckMemInterUnmap_DISPATCH(pMemory, bSubdeviceHandleProvided) 128 #define virtmemShareCallback(pResource, pInvokingClient, pParentRef, pSharePolicy) virtmemShareCallback_DISPATCH(pResource, pInvokingClient, pParentRef, pSharePolicy) 129 #define virtmemGetMapAddrSpace(pMemory, pCallContext, mapFlags, pAddrSpace) virtmemGetMapAddrSpace_DISPATCH(pMemory, pCallContext, mapFlags, pAddrSpace) 130 #define virtmemGetRefCount(pResource) virtmemGetRefCount_DISPATCH(pResource) 131 #define virtmemAddAdditionalDependants(pClient, pResource, pReference) virtmemAddAdditionalDependants_DISPATCH(pClient, pResource, pReference) 132 #define virtmemControl_Prologue(pResource, pCallContext, pParams) virtmemControl_Prologue_DISPATCH(pResource, pCallContext, pParams) 133 #define virtmemIsGpuMapAllowed(pMemory, pGpu) virtmemIsGpuMapAllowed_DISPATCH(pMemory, pGpu) 134 #define virtmemControl_Epilogue(pResource, pCallContext, pParams) virtmemControl_Epilogue_DISPATCH(pResource, pCallContext, pParams) 135 #define virtmemControlLookup(pResource, pParams, ppEntry) virtmemControlLookup_DISPATCH(pResource, pParams, ppEntry) 136 #define virtmemControl(pMemory, pCallContext, pParams) virtmemControl_DISPATCH(pMemory, pCallContext, pParams) 137 #define virtmemUnmap(pMemory, pCallContext, pCpuMapping) virtmemUnmap_DISPATCH(pMemory, pCallContext, pCpuMapping) 138 #define virtmemGetMemInterMapParams(pMemory, pParams) virtmemGetMemInterMapParams_DISPATCH(pMemory, pParams) 139 #define virtmemGetMemoryMappingDescriptor(pMemory, ppMemDesc) virtmemGetMemoryMappingDescriptor_DISPATCH(pMemory, ppMemDesc) 140 #define virtmemControlFilter(pResource, pCallContext, pParams) virtmemControlFilter_DISPATCH(pResource, pCallContext, pParams) 141 #define virtmemControlSerialization_Prologue(pResource, pCallContext, pParams) virtmemControlSerialization_Prologue_DISPATCH(pResource, pCallContext, pParams) 142 #define virtmemCanCopy(pStandardMemory) virtmemCanCopy_DISPATCH(pStandardMemory) 143 #define virtmemIsReady(pMemory, bCopyConstructorContext) virtmemIsReady_DISPATCH(pMemory, bCopyConstructorContext) 144 #define virtmemCheckCopyPermissions(pMemory, pDstGpu, hDstClientNvBool) virtmemCheckCopyPermissions_DISPATCH(pMemory, pDstGpu, hDstClientNvBool) 145 #define virtmemPreDestruct(pResource) virtmemPreDestruct_DISPATCH(pResource) 146 #define virtmemIsDuplicate(pMemory, hMemory, pDuplicate) virtmemIsDuplicate_DISPATCH(pMemory, hMemory, pDuplicate) 147 #define virtmemControlSerialization_Epilogue(pResource, pCallContext, pParams) virtmemControlSerialization_Epilogue_DISPATCH(pResource, pCallContext, pParams) 148 #define virtmemMap(pMemory, pCallContext, pParams, pCpuMapping) virtmemMap_DISPATCH(pMemory, pCallContext, pParams, pCpuMapping) 149 #define virtmemAccessCallback(pResource, pInvokingClient, pAllocParams, accessRight) virtmemAccessCallback_DISPATCH(pResource, pInvokingClient, pAllocParams, accessRight) 150 NV_STATUS virtmemMapTo_IMPL(struct VirtualMemory *pVirtualMemory, struct RS_RES_MAP_TO_PARAMS *pParams); 151 152 static inline NV_STATUS virtmemMapTo_DISPATCH(struct VirtualMemory *pVirtualMemory, struct RS_RES_MAP_TO_PARAMS *pParams) { 153 return pVirtualMemory->__virtmemMapTo__(pVirtualMemory, pParams); 154 } 155 156 NV_STATUS virtmemUnmapFrom_IMPL(struct VirtualMemory *pVirtualMemory, struct RS_RES_UNMAP_FROM_PARAMS *pParams); 157 158 static inline NV_STATUS virtmemUnmapFrom_DISPATCH(struct VirtualMemory *pVirtualMemory, struct RS_RES_UNMAP_FROM_PARAMS *pParams) { 159 return pVirtualMemory->__virtmemUnmapFrom__(pVirtualMemory, pParams); 160 } 161 162 static inline NV_STATUS virtmemCheckMemInterUnmap_DISPATCH(struct VirtualMemory *pMemory, NvBool bSubdeviceHandleProvided) { 163 return pMemory->__virtmemCheckMemInterUnmap__(pMemory, bSubdeviceHandleProvided); 164 } 165 166 static inline NvBool virtmemShareCallback_DISPATCH(struct VirtualMemory *pResource, struct RsClient *pInvokingClient, struct RsResourceRef *pParentRef, RS_SHARE_POLICY *pSharePolicy) { 167 return pResource->__virtmemShareCallback__(pResource, pInvokingClient, pParentRef, pSharePolicy); 168 } 169 170 static inline NV_STATUS virtmemGetMapAddrSpace_DISPATCH(struct VirtualMemory *pMemory, CALL_CONTEXT *pCallContext, NvU32 mapFlags, NV_ADDRESS_SPACE *pAddrSpace) { 171 return pMemory->__virtmemGetMapAddrSpace__(pMemory, pCallContext, mapFlags, pAddrSpace); 172 } 173 174 static inline NvU32 virtmemGetRefCount_DISPATCH(struct VirtualMemory *pResource) { 175 return pResource->__virtmemGetRefCount__(pResource); 176 } 177 178 static inline void virtmemAddAdditionalDependants_DISPATCH(struct RsClient *pClient, struct VirtualMemory *pResource, RsResourceRef *pReference) { 179 pResource->__virtmemAddAdditionalDependants__(pClient, pResource, pReference); 180 } 181 182 static inline NV_STATUS virtmemControl_Prologue_DISPATCH(struct VirtualMemory *pResource, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 183 return pResource->__virtmemControl_Prologue__(pResource, pCallContext, pParams); 184 } 185 186 static inline NvBool virtmemIsGpuMapAllowed_DISPATCH(struct VirtualMemory *pMemory, struct OBJGPU *pGpu) { 187 return pMemory->__virtmemIsGpuMapAllowed__(pMemory, pGpu); 188 } 189 190 static inline void virtmemControl_Epilogue_DISPATCH(struct VirtualMemory *pResource, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 191 pResource->__virtmemControl_Epilogue__(pResource, pCallContext, pParams); 192 } 193 194 static inline NV_STATUS virtmemControlLookup_DISPATCH(struct VirtualMemory *pResource, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams, const struct NVOC_EXPORTED_METHOD_DEF **ppEntry) { 195 return pResource->__virtmemControlLookup__(pResource, pParams, ppEntry); 196 } 197 198 static inline NV_STATUS virtmemControl_DISPATCH(struct VirtualMemory *pMemory, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 199 return pMemory->__virtmemControl__(pMemory, pCallContext, pParams); 200 } 201 202 static inline NV_STATUS virtmemUnmap_DISPATCH(struct VirtualMemory *pMemory, CALL_CONTEXT *pCallContext, RsCpuMapping *pCpuMapping) { 203 return pMemory->__virtmemUnmap__(pMemory, pCallContext, pCpuMapping); 204 } 205 206 static inline NV_STATUS virtmemGetMemInterMapParams_DISPATCH(struct VirtualMemory *pMemory, RMRES_MEM_INTER_MAP_PARAMS *pParams) { 207 return pMemory->__virtmemGetMemInterMapParams__(pMemory, pParams); 208 } 209 210 static inline NV_STATUS virtmemGetMemoryMappingDescriptor_DISPATCH(struct VirtualMemory *pMemory, MEMORY_DESCRIPTOR **ppMemDesc) { 211 return pMemory->__virtmemGetMemoryMappingDescriptor__(pMemory, ppMemDesc); 212 } 213 214 static inline NV_STATUS virtmemControlFilter_DISPATCH(struct VirtualMemory *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 215 return pResource->__virtmemControlFilter__(pResource, pCallContext, pParams); 216 } 217 218 static inline NV_STATUS virtmemControlSerialization_Prologue_DISPATCH(struct VirtualMemory *pResource, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 219 return pResource->__virtmemControlSerialization_Prologue__(pResource, pCallContext, pParams); 220 } 221 222 static inline NvBool virtmemCanCopy_DISPATCH(struct VirtualMemory *pStandardMemory) { 223 return pStandardMemory->__virtmemCanCopy__(pStandardMemory); 224 } 225 226 static inline NV_STATUS virtmemIsReady_DISPATCH(struct VirtualMemory *pMemory, NvBool bCopyConstructorContext) { 227 return pMemory->__virtmemIsReady__(pMemory, bCopyConstructorContext); 228 } 229 230 static inline NV_STATUS virtmemCheckCopyPermissions_DISPATCH(struct VirtualMemory *pMemory, struct OBJGPU *pDstGpu, NvHandle hDstClientNvBool) { 231 return pMemory->__virtmemCheckCopyPermissions__(pMemory, pDstGpu, hDstClientNvBool); 232 } 233 234 static inline void virtmemPreDestruct_DISPATCH(struct VirtualMemory *pResource) { 235 pResource->__virtmemPreDestruct__(pResource); 236 } 237 238 static inline NV_STATUS virtmemIsDuplicate_DISPATCH(struct VirtualMemory *pMemory, NvHandle hMemory, NvBool *pDuplicate) { 239 return pMemory->__virtmemIsDuplicate__(pMemory, hMemory, pDuplicate); 240 } 241 242 static inline void virtmemControlSerialization_Epilogue_DISPATCH(struct VirtualMemory *pResource, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 243 pResource->__virtmemControlSerialization_Epilogue__(pResource, pCallContext, pParams); 244 } 245 246 static inline NV_STATUS virtmemMap_DISPATCH(struct VirtualMemory *pMemory, CALL_CONTEXT *pCallContext, struct RS_CPU_MAP_PARAMS *pParams, RsCpuMapping *pCpuMapping) { 247 return pMemory->__virtmemMap__(pMemory, pCallContext, pParams, pCpuMapping); 248 } 249 250 static inline NvBool virtmemAccessCallback_DISPATCH(struct VirtualMemory *pResource, struct RsClient *pInvokingClient, void *pAllocParams, RsAccessRight accessRight) { 251 return pResource->__virtmemAccessCallback__(pResource, pInvokingClient, pAllocParams, accessRight); 252 } 253 254 NV_STATUS virtmemConstruct_IMPL(struct VirtualMemory *arg_pVirtualMemory, CALL_CONTEXT *arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL *arg_pParams); 255 256 #define __nvoc_virtmemConstruct(arg_pVirtualMemory, arg_pCallContext, arg_pParams) virtmemConstruct_IMPL(arg_pVirtualMemory, arg_pCallContext, arg_pParams) 257 void virtmemDestruct_IMPL(struct VirtualMemory *pVirtualMemory); 258 259 #define __nvoc_virtmemDestruct(pVirtualMemory) virtmemDestruct_IMPL(pVirtualMemory) 260 NV_STATUS virtmemReserveMempool_IMPL(struct VirtualMemory *pVirtualMemory, struct OBJGPU *arg0, NvHandle hDevice, NvU64 size, NvU64 pageSizeMask); 261 262 #ifdef __nvoc_virtual_mem_h_disabled 263 static inline NV_STATUS virtmemReserveMempool(struct VirtualMemory *pVirtualMemory, struct OBJGPU *arg0, NvHandle hDevice, NvU64 size, NvU64 pageSizeMask) { 264 NV_ASSERT_FAILED_PRECOMP("VirtualMemory was disabled!"); 265 return NV_ERR_NOT_SUPPORTED; 266 } 267 #else //__nvoc_virtual_mem_h_disabled 268 #define virtmemReserveMempool(pVirtualMemory, arg0, hDevice, size, pageSizeMask) virtmemReserveMempool_IMPL(pVirtualMemory, arg0, hDevice, size, pageSizeMask) 269 #endif //__nvoc_virtual_mem_h_disabled 270 271 NvBool virtmemMatchesVASpace_IMPL(struct VirtualMemory *pVirtualMemory, NvHandle hClient, NvHandle hVASpace); 272 273 #ifdef __nvoc_virtual_mem_h_disabled 274 static inline NvBool virtmemMatchesVASpace(struct VirtualMemory *pVirtualMemory, NvHandle hClient, NvHandle hVASpace) { 275 NV_ASSERT_FAILED_PRECOMP("VirtualMemory was disabled!"); 276 return NV_FALSE; 277 } 278 #else //__nvoc_virtual_mem_h_disabled 279 #define virtmemMatchesVASpace(pVirtualMemory, hClient, hVASpace) virtmemMatchesVASpace_IMPL(pVirtualMemory, hClient, hVASpace) 280 #endif //__nvoc_virtual_mem_h_disabled 281 282 NV_STATUS virtmemGetByHandleAndDevice_IMPL(struct RsClient *pClient, NvHandle hMemory, NvHandle hDevice, struct VirtualMemory **ppVirtualMemory); 283 284 #define virtmemGetByHandleAndDevice(pClient, hMemory, hDevice, ppVirtualMemory) virtmemGetByHandleAndDevice_IMPL(pClient, hMemory, hDevice, ppVirtualMemory) 285 void virtmemGetAddressAndSize_IMPL(struct VirtualMemory *arg0, NvU64 *pVAddr, NvU64 *pSize); 286 287 #define virtmemGetAddressAndSize(arg0, pVAddr, pSize) virtmemGetAddressAndSize_IMPL(arg0, pVAddr, pSize) 288 #undef PRIVATE_FIELD 289 290 291 NV_STATUS virtmemAllocResources(OBJGPU *pGpu, struct MemoryManager *pMemoryManager, MEMORY_ALLOCATION_REQUEST *pAllocRequest, 292 FB_ALLOC_INFO *pFbAllocInfo); 293 294 #endif 295 296 #ifdef __cplusplus 297 } // extern "C" 298 #endif 299 #endif // _G_VIRTUAL_MEM_NVOC_H_ 300