1 #ifndef _G_NO_DEVICE_MEM_NVOC_H_
2 #define _G_NO_DEVICE_MEM_NVOC_H_
3 #include "nvoc/runtime.h"
4 
5 #ifdef __cplusplus
6 extern "C" {
7 #endif
8 
9 /*
10  * SPDX-FileCopyrightText: Copyright (c) 2018 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_no_device_mem_nvoc.h"
33 
34 #ifndef _NO_DEVICE_MEMORY_H_
35 #define _NO_DEVICE_MEMORY_H_
36 
37 #include "mem_mgr/mem.h"
38 
39 /**
40  * This class represents contiguous system memory that is associated with a
41  * client instead of a device. This object can be used for memory allocations
42  * that should survive device teardown.
43  */
44 #ifdef NVOC_NO_DEVICE_MEM_H_PRIVATE_ACCESS_ALLOWED
45 #define PRIVATE_FIELD(x) x
46 #else
47 #define PRIVATE_FIELD(x) NVOC_PRIVATE_FIELD(x)
48 #endif
49 struct NoDeviceMemory {
50     const struct NVOC_RTTI *__nvoc_rtti;
51     struct Memory __nvoc_base_Memory;
52     struct Object *__nvoc_pbase_Object;
53     struct RsResource *__nvoc_pbase_RsResource;
54     struct RmResourceCommon *__nvoc_pbase_RmResourceCommon;
55     struct RmResource *__nvoc_pbase_RmResource;
56     struct Memory *__nvoc_pbase_Memory;
57     struct NoDeviceMemory *__nvoc_pbase_NoDeviceMemory;
58     NV_STATUS (*__nodevicememGetMapAddrSpace__)(struct NoDeviceMemory *, CALL_CONTEXT *, NvU32, NV_ADDRESS_SPACE *);
59     NV_STATUS (*__nodevicememCheckMemInterUnmap__)(struct NoDeviceMemory *, NvBool);
60     NvBool (*__nodevicememShareCallback__)(struct NoDeviceMemory *, struct RsClient *, struct RsResourceRef *, RS_SHARE_POLICY *);
61     NV_STATUS (*__nodevicememMapTo__)(struct NoDeviceMemory *, RS_RES_MAP_TO_PARAMS *);
62     NvBool (*__nodevicememIsExportAllowed__)(struct NoDeviceMemory *);
63     NvU32 (*__nodevicememGetRefCount__)(struct NoDeviceMemory *);
64     void (*__nodevicememAddAdditionalDependants__)(struct RsClient *, struct NoDeviceMemory *, RsResourceRef *);
65     NV_STATUS (*__nodevicememControl_Prologue__)(struct NoDeviceMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
66     NvBool (*__nodevicememIsGpuMapAllowed__)(struct NoDeviceMemory *, struct OBJGPU *);
67     NV_STATUS (*__nodevicememUnmapFrom__)(struct NoDeviceMemory *, RS_RES_UNMAP_FROM_PARAMS *);
68     void (*__nodevicememControl_Epilogue__)(struct NoDeviceMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
69     NV_STATUS (*__nodevicememControlLookup__)(struct NoDeviceMemory *, struct RS_RES_CONTROL_PARAMS_INTERNAL *, const struct NVOC_EXPORTED_METHOD_DEF **);
70     NV_STATUS (*__nodevicememControl__)(struct NoDeviceMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
71     NV_STATUS (*__nodevicememUnmap__)(struct NoDeviceMemory *, CALL_CONTEXT *, RsCpuMapping *);
72     NV_STATUS (*__nodevicememGetMemInterMapParams__)(struct NoDeviceMemory *, RMRES_MEM_INTER_MAP_PARAMS *);
73     NV_STATUS (*__nodevicememGetMemoryMappingDescriptor__)(struct NoDeviceMemory *, MEMORY_DESCRIPTOR **);
74     NV_STATUS (*__nodevicememControlFilter__)(struct NoDeviceMemory *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
75     NV_STATUS (*__nodevicememControlSerialization_Prologue__)(struct NoDeviceMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
76     NvBool (*__nodevicememCanCopy__)(struct NoDeviceMemory *);
77     NV_STATUS (*__nodevicememIsReady__)(struct NoDeviceMemory *, NvBool);
78     NV_STATUS (*__nodevicememCheckCopyPermissions__)(struct NoDeviceMemory *, struct OBJGPU *, struct Device *);
79     void (*__nodevicememPreDestruct__)(struct NoDeviceMemory *);
80     NV_STATUS (*__nodevicememIsDuplicate__)(struct NoDeviceMemory *, NvHandle, NvBool *);
81     void (*__nodevicememControlSerialization_Epilogue__)(struct NoDeviceMemory *, CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
82     NV_STATUS (*__nodevicememMap__)(struct NoDeviceMemory *, CALL_CONTEXT *, struct RS_CPU_MAP_PARAMS *, RsCpuMapping *);
83     NvBool (*__nodevicememAccessCallback__)(struct NoDeviceMemory *, struct RsClient *, void *, RsAccessRight);
84 };
85 
86 #ifndef __NVOC_CLASS_NoDeviceMemory_TYPEDEF__
87 #define __NVOC_CLASS_NoDeviceMemory_TYPEDEF__
88 typedef struct NoDeviceMemory NoDeviceMemory;
89 #endif /* __NVOC_CLASS_NoDeviceMemory_TYPEDEF__ */
90 
91 #ifndef __nvoc_class_id_NoDeviceMemory
92 #define __nvoc_class_id_NoDeviceMemory 0x6c0832
93 #endif /* __nvoc_class_id_NoDeviceMemory */
94 
95 extern const struct NVOC_CLASS_DEF __nvoc_class_def_NoDeviceMemory;
96 
97 #define __staticCast_NoDeviceMemory(pThis) \
98     ((pThis)->__nvoc_pbase_NoDeviceMemory)
99 
100 #ifdef __nvoc_no_device_mem_h_disabled
101 #define __dynamicCast_NoDeviceMemory(pThis) ((NoDeviceMemory*)NULL)
102 #else //__nvoc_no_device_mem_h_disabled
103 #define __dynamicCast_NoDeviceMemory(pThis) \
104     ((NoDeviceMemory*)__nvoc_dynamicCast(staticCast((pThis), Dynamic), classInfo(NoDeviceMemory)))
105 #endif //__nvoc_no_device_mem_h_disabled
106 
107 
108 NV_STATUS __nvoc_objCreateDynamic_NoDeviceMemory(NoDeviceMemory**, Dynamic*, NvU32, va_list);
109 
110 NV_STATUS __nvoc_objCreate_NoDeviceMemory(NoDeviceMemory**, Dynamic*, NvU32, CALL_CONTEXT * arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL * arg_pParams);
111 #define __objCreate_NoDeviceMemory(ppNewObj, pParent, createFlags, arg_pCallContext, arg_pParams) \
112     __nvoc_objCreate_NoDeviceMemory((ppNewObj), staticCast((pParent), Dynamic), (createFlags), arg_pCallContext, arg_pParams)
113 
114 #define nodevicememGetMapAddrSpace(pNoDeviceMemory, pCallContext, mapFlags, pAddrSpace) nodevicememGetMapAddrSpace_DISPATCH(pNoDeviceMemory, pCallContext, mapFlags, pAddrSpace)
115 #define nodevicememCheckMemInterUnmap(pMemory, bSubdeviceHandleProvided) nodevicememCheckMemInterUnmap_DISPATCH(pMemory, bSubdeviceHandleProvided)
116 #define nodevicememShareCallback(pResource, pInvokingClient, pParentRef, pSharePolicy) nodevicememShareCallback_DISPATCH(pResource, pInvokingClient, pParentRef, pSharePolicy)
117 #define nodevicememMapTo(pResource, pParams) nodevicememMapTo_DISPATCH(pResource, pParams)
118 #define nodevicememIsExportAllowed(pMemory) nodevicememIsExportAllowed_DISPATCH(pMemory)
119 #define nodevicememGetRefCount(pResource) nodevicememGetRefCount_DISPATCH(pResource)
120 #define nodevicememAddAdditionalDependants(pClient, pResource, pReference) nodevicememAddAdditionalDependants_DISPATCH(pClient, pResource, pReference)
121 #define nodevicememControl_Prologue(pResource, pCallContext, pParams) nodevicememControl_Prologue_DISPATCH(pResource, pCallContext, pParams)
122 #define nodevicememIsGpuMapAllowed(pMemory, pGpu) nodevicememIsGpuMapAllowed_DISPATCH(pMemory, pGpu)
123 #define nodevicememUnmapFrom(pResource, pParams) nodevicememUnmapFrom_DISPATCH(pResource, pParams)
124 #define nodevicememControl_Epilogue(pResource, pCallContext, pParams) nodevicememControl_Epilogue_DISPATCH(pResource, pCallContext, pParams)
125 #define nodevicememControlLookup(pResource, pParams, ppEntry) nodevicememControlLookup_DISPATCH(pResource, pParams, ppEntry)
126 #define nodevicememControl(pMemory, pCallContext, pParams) nodevicememControl_DISPATCH(pMemory, pCallContext, pParams)
127 #define nodevicememUnmap(pMemory, pCallContext, pCpuMapping) nodevicememUnmap_DISPATCH(pMemory, pCallContext, pCpuMapping)
128 #define nodevicememGetMemInterMapParams(pMemory, pParams) nodevicememGetMemInterMapParams_DISPATCH(pMemory, pParams)
129 #define nodevicememGetMemoryMappingDescriptor(pMemory, ppMemDesc) nodevicememGetMemoryMappingDescriptor_DISPATCH(pMemory, ppMemDesc)
130 #define nodevicememControlFilter(pResource, pCallContext, pParams) nodevicememControlFilter_DISPATCH(pResource, pCallContext, pParams)
131 #define nodevicememControlSerialization_Prologue(pResource, pCallContext, pParams) nodevicememControlSerialization_Prologue_DISPATCH(pResource, pCallContext, pParams)
132 #define nodevicememCanCopy(pResource) nodevicememCanCopy_DISPATCH(pResource)
133 #define nodevicememIsReady(pMemory, bCopyConstructorContext) nodevicememIsReady_DISPATCH(pMemory, bCopyConstructorContext)
134 #define nodevicememCheckCopyPermissions(pMemory, pDstGpu, pDstDevice) nodevicememCheckCopyPermissions_DISPATCH(pMemory, pDstGpu, pDstDevice)
135 #define nodevicememPreDestruct(pResource) nodevicememPreDestruct_DISPATCH(pResource)
136 #define nodevicememIsDuplicate(pMemory, hMemory, pDuplicate) nodevicememIsDuplicate_DISPATCH(pMemory, hMemory, pDuplicate)
137 #define nodevicememControlSerialization_Epilogue(pResource, pCallContext, pParams) nodevicememControlSerialization_Epilogue_DISPATCH(pResource, pCallContext, pParams)
138 #define nodevicememMap(pMemory, pCallContext, pParams, pCpuMapping) nodevicememMap_DISPATCH(pMemory, pCallContext, pParams, pCpuMapping)
139 #define nodevicememAccessCallback(pResource, pInvokingClient, pAllocParams, accessRight) nodevicememAccessCallback_DISPATCH(pResource, pInvokingClient, pAllocParams, accessRight)
140 NV_STATUS nodevicememGetMapAddrSpace_IMPL(struct NoDeviceMemory *pNoDeviceMemory, CALL_CONTEXT *pCallContext, NvU32 mapFlags, NV_ADDRESS_SPACE *pAddrSpace);
141 
142 static inline NV_STATUS nodevicememGetMapAddrSpace_DISPATCH(struct NoDeviceMemory *pNoDeviceMemory, CALL_CONTEXT *pCallContext, NvU32 mapFlags, NV_ADDRESS_SPACE *pAddrSpace) {
143     return pNoDeviceMemory->__nodevicememGetMapAddrSpace__(pNoDeviceMemory, pCallContext, mapFlags, pAddrSpace);
144 }
145 
146 static inline NV_STATUS nodevicememCheckMemInterUnmap_DISPATCH(struct NoDeviceMemory *pMemory, NvBool bSubdeviceHandleProvided) {
147     return pMemory->__nodevicememCheckMemInterUnmap__(pMemory, bSubdeviceHandleProvided);
148 }
149 
150 static inline NvBool nodevicememShareCallback_DISPATCH(struct NoDeviceMemory *pResource, struct RsClient *pInvokingClient, struct RsResourceRef *pParentRef, RS_SHARE_POLICY *pSharePolicy) {
151     return pResource->__nodevicememShareCallback__(pResource, pInvokingClient, pParentRef, pSharePolicy);
152 }
153 
154 static inline NV_STATUS nodevicememMapTo_DISPATCH(struct NoDeviceMemory *pResource, RS_RES_MAP_TO_PARAMS *pParams) {
155     return pResource->__nodevicememMapTo__(pResource, pParams);
156 }
157 
158 static inline NvBool nodevicememIsExportAllowed_DISPATCH(struct NoDeviceMemory *pMemory) {
159     return pMemory->__nodevicememIsExportAllowed__(pMemory);
160 }
161 
162 static inline NvU32 nodevicememGetRefCount_DISPATCH(struct NoDeviceMemory *pResource) {
163     return pResource->__nodevicememGetRefCount__(pResource);
164 }
165 
166 static inline void nodevicememAddAdditionalDependants_DISPATCH(struct RsClient *pClient, struct NoDeviceMemory *pResource, RsResourceRef *pReference) {
167     pResource->__nodevicememAddAdditionalDependants__(pClient, pResource, pReference);
168 }
169 
170 static inline NV_STATUS nodevicememControl_Prologue_DISPATCH(struct NoDeviceMemory *pResource, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
171     return pResource->__nodevicememControl_Prologue__(pResource, pCallContext, pParams);
172 }
173 
174 static inline NvBool nodevicememIsGpuMapAllowed_DISPATCH(struct NoDeviceMemory *pMemory, struct OBJGPU *pGpu) {
175     return pMemory->__nodevicememIsGpuMapAllowed__(pMemory, pGpu);
176 }
177 
178 static inline NV_STATUS nodevicememUnmapFrom_DISPATCH(struct NoDeviceMemory *pResource, RS_RES_UNMAP_FROM_PARAMS *pParams) {
179     return pResource->__nodevicememUnmapFrom__(pResource, pParams);
180 }
181 
182 static inline void nodevicememControl_Epilogue_DISPATCH(struct NoDeviceMemory *pResource, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
183     pResource->__nodevicememControl_Epilogue__(pResource, pCallContext, pParams);
184 }
185 
186 static inline NV_STATUS nodevicememControlLookup_DISPATCH(struct NoDeviceMemory *pResource, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams, const struct NVOC_EXPORTED_METHOD_DEF **ppEntry) {
187     return pResource->__nodevicememControlLookup__(pResource, pParams, ppEntry);
188 }
189 
190 static inline NV_STATUS nodevicememControl_DISPATCH(struct NoDeviceMemory *pMemory, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
191     return pMemory->__nodevicememControl__(pMemory, pCallContext, pParams);
192 }
193 
194 static inline NV_STATUS nodevicememUnmap_DISPATCH(struct NoDeviceMemory *pMemory, CALL_CONTEXT *pCallContext, RsCpuMapping *pCpuMapping) {
195     return pMemory->__nodevicememUnmap__(pMemory, pCallContext, pCpuMapping);
196 }
197 
198 static inline NV_STATUS nodevicememGetMemInterMapParams_DISPATCH(struct NoDeviceMemory *pMemory, RMRES_MEM_INTER_MAP_PARAMS *pParams) {
199     return pMemory->__nodevicememGetMemInterMapParams__(pMemory, pParams);
200 }
201 
202 static inline NV_STATUS nodevicememGetMemoryMappingDescriptor_DISPATCH(struct NoDeviceMemory *pMemory, MEMORY_DESCRIPTOR **ppMemDesc) {
203     return pMemory->__nodevicememGetMemoryMappingDescriptor__(pMemory, ppMemDesc);
204 }
205 
206 static inline NV_STATUS nodevicememControlFilter_DISPATCH(struct NoDeviceMemory *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
207     return pResource->__nodevicememControlFilter__(pResource, pCallContext, pParams);
208 }
209 
210 static inline NV_STATUS nodevicememControlSerialization_Prologue_DISPATCH(struct NoDeviceMemory *pResource, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
211     return pResource->__nodevicememControlSerialization_Prologue__(pResource, pCallContext, pParams);
212 }
213 
214 static inline NvBool nodevicememCanCopy_DISPATCH(struct NoDeviceMemory *pResource) {
215     return pResource->__nodevicememCanCopy__(pResource);
216 }
217 
218 static inline NV_STATUS nodevicememIsReady_DISPATCH(struct NoDeviceMemory *pMemory, NvBool bCopyConstructorContext) {
219     return pMemory->__nodevicememIsReady__(pMemory, bCopyConstructorContext);
220 }
221 
222 static inline NV_STATUS nodevicememCheckCopyPermissions_DISPATCH(struct NoDeviceMemory *pMemory, struct OBJGPU *pDstGpu, struct Device *pDstDevice) {
223     return pMemory->__nodevicememCheckCopyPermissions__(pMemory, pDstGpu, pDstDevice);
224 }
225 
226 static inline void nodevicememPreDestruct_DISPATCH(struct NoDeviceMemory *pResource) {
227     pResource->__nodevicememPreDestruct__(pResource);
228 }
229 
230 static inline NV_STATUS nodevicememIsDuplicate_DISPATCH(struct NoDeviceMemory *pMemory, NvHandle hMemory, NvBool *pDuplicate) {
231     return pMemory->__nodevicememIsDuplicate__(pMemory, hMemory, pDuplicate);
232 }
233 
234 static inline void nodevicememControlSerialization_Epilogue_DISPATCH(struct NoDeviceMemory *pResource, CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
235     pResource->__nodevicememControlSerialization_Epilogue__(pResource, pCallContext, pParams);
236 }
237 
238 static inline NV_STATUS nodevicememMap_DISPATCH(struct NoDeviceMemory *pMemory, CALL_CONTEXT *pCallContext, struct RS_CPU_MAP_PARAMS *pParams, RsCpuMapping *pCpuMapping) {
239     return pMemory->__nodevicememMap__(pMemory, pCallContext, pParams, pCpuMapping);
240 }
241 
242 static inline NvBool nodevicememAccessCallback_DISPATCH(struct NoDeviceMemory *pResource, struct RsClient *pInvokingClient, void *pAllocParams, RsAccessRight accessRight) {
243     return pResource->__nodevicememAccessCallback__(pResource, pInvokingClient, pAllocParams, accessRight);
244 }
245 
246 NV_STATUS nodevicememConstruct_IMPL(struct NoDeviceMemory *arg_pNoDeviceMemory, CALL_CONTEXT *arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL *arg_pParams);
247 
248 #define __nvoc_nodevicememConstruct(arg_pNoDeviceMemory, arg_pCallContext, arg_pParams) nodevicememConstruct_IMPL(arg_pNoDeviceMemory, arg_pCallContext, arg_pParams)
249 void nodevicememDestruct_IMPL(struct NoDeviceMemory *pNoDeviceMemory);
250 
251 #define __nvoc_nodevicememDestruct(pNoDeviceMemory) nodevicememDestruct_IMPL(pNoDeviceMemory)
252 #undef PRIVATE_FIELD
253 
254 
255 #endif
256 
257 #ifdef __cplusplus
258 } // extern "C"
259 #endif
260 
261 #endif // _G_NO_DEVICE_MEM_NVOC_H_
262