1 #ifndef _G_MIG_CONFIG_SESSION_NVOC_H_
2 #define _G_MIG_CONFIG_SESSION_NVOC_H_
3 #include "nvoc/runtime.h"
4
5 #ifdef __cplusplus
6 extern "C" {
7 #endif
8
9 /*
10 * SPDX-FileCopyrightText: Copyright (c) 2019-2023 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 /******************************************************************************
33 *
34 * Description:
35 * This file contains the functions managing MIG configuration
36 *
37 * Key attributes of MIGConfigSession class:
38 * - hClient is parent of MIGConfigSession.
39 * - MIGConfigSession can be allocated by privileged client.
40 * - RmApi lock must be held.
41 *****************************************************************************/
42
43 #include "g_mig_config_session_nvoc.h"
44
45 #ifndef MIG_CONFIG_SESSION_H
46 #define MIG_CONFIG_SESSION_H
47
48 #include "rmapi/resource.h"
49 #include "class/clc639.h"
50
51 // ****************************************************************************
52 // Type Definitions
53 // ****************************************************************************
54
55
56 // Private field names are wrapped in PRIVATE_FIELD, which does nothing for
57 // the matching C source file, but causes diagnostics to be issued if another
58 // source file references the field.
59 #ifdef NVOC_MIG_CONFIG_SESSION_H_PRIVATE_ACCESS_ALLOWED
60 #define PRIVATE_FIELD(x) x
61 #else
62 #define PRIVATE_FIELD(x) NVOC_PRIVATE_FIELD(x)
63 #endif
64
65 struct MIGConfigSession {
66 const struct NVOC_RTTI *__nvoc_rtti;
67 struct RmResource __nvoc_base_RmResource;
68 struct Object *__nvoc_pbase_Object;
69 struct RsResource *__nvoc_pbase_RsResource;
70 struct RmResourceCommon *__nvoc_pbase_RmResourceCommon;
71 struct RmResource *__nvoc_pbase_RmResource;
72 struct MIGConfigSession *__nvoc_pbase_MIGConfigSession;
73 NvBool (*__migconfigsessionShareCallback__)(struct MIGConfigSession *, struct RsClient *, struct RsResourceRef *, RS_SHARE_POLICY *);
74 NV_STATUS (*__migconfigsessionCheckMemInterUnmap__)(struct MIGConfigSession *, NvBool);
75 NV_STATUS (*__migconfigsessionControl__)(struct MIGConfigSession *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
76 NV_STATUS (*__migconfigsessionGetMemInterMapParams__)(struct MIGConfigSession *, RMRES_MEM_INTER_MAP_PARAMS *);
77 NV_STATUS (*__migconfigsessionGetMemoryMappingDescriptor__)(struct MIGConfigSession *, struct MEMORY_DESCRIPTOR **);
78 NvU32 (*__migconfigsessionGetRefCount__)(struct MIGConfigSession *);
79 NV_STATUS (*__migconfigsessionControlFilter__)(struct MIGConfigSession *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
80 void (*__migconfigsessionAddAdditionalDependants__)(struct RsClient *, struct MIGConfigSession *, RsResourceRef *);
81 NV_STATUS (*__migconfigsessionControlSerialization_Prologue__)(struct MIGConfigSession *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
82 NV_STATUS (*__migconfigsessionControl_Prologue__)(struct MIGConfigSession *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
83 NvBool (*__migconfigsessionCanCopy__)(struct MIGConfigSession *);
84 NV_STATUS (*__migconfigsessionUnmap__)(struct MIGConfigSession *, struct CALL_CONTEXT *, RsCpuMapping *);
85 NvBool (*__migconfigsessionIsPartialUnmapSupported__)(struct MIGConfigSession *);
86 void (*__migconfigsessionPreDestruct__)(struct MIGConfigSession *);
87 NV_STATUS (*__migconfigsessionMapTo__)(struct MIGConfigSession *, RS_RES_MAP_TO_PARAMS *);
88 NV_STATUS (*__migconfigsessionIsDuplicate__)(struct MIGConfigSession *, NvHandle, NvBool *);
89 void (*__migconfigsessionControlSerialization_Epilogue__)(struct MIGConfigSession *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
90 void (*__migconfigsessionControl_Epilogue__)(struct MIGConfigSession *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
91 NV_STATUS (*__migconfigsessionUnmapFrom__)(struct MIGConfigSession *, RS_RES_UNMAP_FROM_PARAMS *);
92 NV_STATUS (*__migconfigsessionMap__)(struct MIGConfigSession *, struct CALL_CONTEXT *, RS_CPU_MAP_PARAMS *, RsCpuMapping *);
93 NvBool (*__migconfigsessionAccessCallback__)(struct MIGConfigSession *, struct RsClient *, void *, RsAccessRight);
94 NvU64 PRIVATE_FIELD(dupedCapDescriptor);
95 };
96
97 #ifndef __NVOC_CLASS_MIGConfigSession_TYPEDEF__
98 #define __NVOC_CLASS_MIGConfigSession_TYPEDEF__
99 typedef struct MIGConfigSession MIGConfigSession;
100 #endif /* __NVOC_CLASS_MIGConfigSession_TYPEDEF__ */
101
102 #ifndef __nvoc_class_id_MIGConfigSession
103 #define __nvoc_class_id_MIGConfigSession 0x36a941
104 #endif /* __nvoc_class_id_MIGConfigSession */
105
106 extern const struct NVOC_CLASS_DEF __nvoc_class_def_MIGConfigSession;
107
108 #define __staticCast_MIGConfigSession(pThis) \
109 ((pThis)->__nvoc_pbase_MIGConfigSession)
110
111 #ifdef __nvoc_mig_config_session_h_disabled
112 #define __dynamicCast_MIGConfigSession(pThis) ((MIGConfigSession*)NULL)
113 #else //__nvoc_mig_config_session_h_disabled
114 #define __dynamicCast_MIGConfigSession(pThis) \
115 ((MIGConfigSession*)__nvoc_dynamicCast(staticCast((pThis), Dynamic), classInfo(MIGConfigSession)))
116 #endif //__nvoc_mig_config_session_h_disabled
117
118
119 NV_STATUS __nvoc_objCreateDynamic_MIGConfigSession(MIGConfigSession**, Dynamic*, NvU32, va_list);
120
121 NV_STATUS __nvoc_objCreate_MIGConfigSession(MIGConfigSession**, Dynamic*, NvU32, struct CALL_CONTEXT * arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL * arg_pParams);
122 #define __objCreate_MIGConfigSession(ppNewObj, pParent, createFlags, arg_pCallContext, arg_pParams) \
123 __nvoc_objCreate_MIGConfigSession((ppNewObj), staticCast((pParent), Dynamic), (createFlags), arg_pCallContext, arg_pParams)
124
125 #define migconfigsessionShareCallback(pResource, pInvokingClient, pParentRef, pSharePolicy) migconfigsessionShareCallback_DISPATCH(pResource, pInvokingClient, pParentRef, pSharePolicy)
126 #define migconfigsessionCheckMemInterUnmap(pRmResource, bSubdeviceHandleProvided) migconfigsessionCheckMemInterUnmap_DISPATCH(pRmResource, bSubdeviceHandleProvided)
127 #define migconfigsessionControl(pResource, pCallContext, pParams) migconfigsessionControl_DISPATCH(pResource, pCallContext, pParams)
128 #define migconfigsessionGetMemInterMapParams(pRmResource, pParams) migconfigsessionGetMemInterMapParams_DISPATCH(pRmResource, pParams)
129 #define migconfigsessionGetMemoryMappingDescriptor(pRmResource, ppMemDesc) migconfigsessionGetMemoryMappingDescriptor_DISPATCH(pRmResource, ppMemDesc)
130 #define migconfigsessionGetRefCount(pResource) migconfigsessionGetRefCount_DISPATCH(pResource)
131 #define migconfigsessionControlFilter(pResource, pCallContext, pParams) migconfigsessionControlFilter_DISPATCH(pResource, pCallContext, pParams)
132 #define migconfigsessionAddAdditionalDependants(pClient, pResource, pReference) migconfigsessionAddAdditionalDependants_DISPATCH(pClient, pResource, pReference)
133 #define migconfigsessionControlSerialization_Prologue(pResource, pCallContext, pParams) migconfigsessionControlSerialization_Prologue_DISPATCH(pResource, pCallContext, pParams)
134 #define migconfigsessionControl_Prologue(pResource, pCallContext, pParams) migconfigsessionControl_Prologue_DISPATCH(pResource, pCallContext, pParams)
135 #define migconfigsessionCanCopy(pResource) migconfigsessionCanCopy_DISPATCH(pResource)
136 #define migconfigsessionUnmap(pResource, pCallContext, pCpuMapping) migconfigsessionUnmap_DISPATCH(pResource, pCallContext, pCpuMapping)
137 #define migconfigsessionIsPartialUnmapSupported(pResource) migconfigsessionIsPartialUnmapSupported_DISPATCH(pResource)
138 #define migconfigsessionPreDestruct(pResource) migconfigsessionPreDestruct_DISPATCH(pResource)
139 #define migconfigsessionMapTo(pResource, pParams) migconfigsessionMapTo_DISPATCH(pResource, pParams)
140 #define migconfigsessionIsDuplicate(pResource, hMemory, pDuplicate) migconfigsessionIsDuplicate_DISPATCH(pResource, hMemory, pDuplicate)
141 #define migconfigsessionControlSerialization_Epilogue(pResource, pCallContext, pParams) migconfigsessionControlSerialization_Epilogue_DISPATCH(pResource, pCallContext, pParams)
142 #define migconfigsessionControl_Epilogue(pResource, pCallContext, pParams) migconfigsessionControl_Epilogue_DISPATCH(pResource, pCallContext, pParams)
143 #define migconfigsessionUnmapFrom(pResource, pParams) migconfigsessionUnmapFrom_DISPATCH(pResource, pParams)
144 #define migconfigsessionMap(pResource, pCallContext, pParams, pCpuMapping) migconfigsessionMap_DISPATCH(pResource, pCallContext, pParams, pCpuMapping)
145 #define migconfigsessionAccessCallback(pResource, pInvokingClient, pAllocParams, accessRight) migconfigsessionAccessCallback_DISPATCH(pResource, pInvokingClient, pAllocParams, accessRight)
migconfigsessionShareCallback_DISPATCH(struct MIGConfigSession * pResource,struct RsClient * pInvokingClient,struct RsResourceRef * pParentRef,RS_SHARE_POLICY * pSharePolicy)146 static inline NvBool migconfigsessionShareCallback_DISPATCH(struct MIGConfigSession *pResource, struct RsClient *pInvokingClient, struct RsResourceRef *pParentRef, RS_SHARE_POLICY *pSharePolicy) {
147 return pResource->__migconfigsessionShareCallback__(pResource, pInvokingClient, pParentRef, pSharePolicy);
148 }
149
migconfigsessionCheckMemInterUnmap_DISPATCH(struct MIGConfigSession * pRmResource,NvBool bSubdeviceHandleProvided)150 static inline NV_STATUS migconfigsessionCheckMemInterUnmap_DISPATCH(struct MIGConfigSession *pRmResource, NvBool bSubdeviceHandleProvided) {
151 return pRmResource->__migconfigsessionCheckMemInterUnmap__(pRmResource, bSubdeviceHandleProvided);
152 }
153
migconfigsessionControl_DISPATCH(struct MIGConfigSession * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)154 static inline NV_STATUS migconfigsessionControl_DISPATCH(struct MIGConfigSession *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
155 return pResource->__migconfigsessionControl__(pResource, pCallContext, pParams);
156 }
157
migconfigsessionGetMemInterMapParams_DISPATCH(struct MIGConfigSession * pRmResource,RMRES_MEM_INTER_MAP_PARAMS * pParams)158 static inline NV_STATUS migconfigsessionGetMemInterMapParams_DISPATCH(struct MIGConfigSession *pRmResource, RMRES_MEM_INTER_MAP_PARAMS *pParams) {
159 return pRmResource->__migconfigsessionGetMemInterMapParams__(pRmResource, pParams);
160 }
161
migconfigsessionGetMemoryMappingDescriptor_DISPATCH(struct MIGConfigSession * pRmResource,struct MEMORY_DESCRIPTOR ** ppMemDesc)162 static inline NV_STATUS migconfigsessionGetMemoryMappingDescriptor_DISPATCH(struct MIGConfigSession *pRmResource, struct MEMORY_DESCRIPTOR **ppMemDesc) {
163 return pRmResource->__migconfigsessionGetMemoryMappingDescriptor__(pRmResource, ppMemDesc);
164 }
165
migconfigsessionGetRefCount_DISPATCH(struct MIGConfigSession * pResource)166 static inline NvU32 migconfigsessionGetRefCount_DISPATCH(struct MIGConfigSession *pResource) {
167 return pResource->__migconfigsessionGetRefCount__(pResource);
168 }
169
migconfigsessionControlFilter_DISPATCH(struct MIGConfigSession * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)170 static inline NV_STATUS migconfigsessionControlFilter_DISPATCH(struct MIGConfigSession *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
171 return pResource->__migconfigsessionControlFilter__(pResource, pCallContext, pParams);
172 }
173
migconfigsessionAddAdditionalDependants_DISPATCH(struct RsClient * pClient,struct MIGConfigSession * pResource,RsResourceRef * pReference)174 static inline void migconfigsessionAddAdditionalDependants_DISPATCH(struct RsClient *pClient, struct MIGConfigSession *pResource, RsResourceRef *pReference) {
175 pResource->__migconfigsessionAddAdditionalDependants__(pClient, pResource, pReference);
176 }
177
migconfigsessionControlSerialization_Prologue_DISPATCH(struct MIGConfigSession * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)178 static inline NV_STATUS migconfigsessionControlSerialization_Prologue_DISPATCH(struct MIGConfigSession *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
179 return pResource->__migconfigsessionControlSerialization_Prologue__(pResource, pCallContext, pParams);
180 }
181
migconfigsessionControl_Prologue_DISPATCH(struct MIGConfigSession * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)182 static inline NV_STATUS migconfigsessionControl_Prologue_DISPATCH(struct MIGConfigSession *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
183 return pResource->__migconfigsessionControl_Prologue__(pResource, pCallContext, pParams);
184 }
185
migconfigsessionCanCopy_DISPATCH(struct MIGConfigSession * pResource)186 static inline NvBool migconfigsessionCanCopy_DISPATCH(struct MIGConfigSession *pResource) {
187 return pResource->__migconfigsessionCanCopy__(pResource);
188 }
189
migconfigsessionUnmap_DISPATCH(struct MIGConfigSession * pResource,struct CALL_CONTEXT * pCallContext,RsCpuMapping * pCpuMapping)190 static inline NV_STATUS migconfigsessionUnmap_DISPATCH(struct MIGConfigSession *pResource, struct CALL_CONTEXT *pCallContext, RsCpuMapping *pCpuMapping) {
191 return pResource->__migconfigsessionUnmap__(pResource, pCallContext, pCpuMapping);
192 }
193
migconfigsessionIsPartialUnmapSupported_DISPATCH(struct MIGConfigSession * pResource)194 static inline NvBool migconfigsessionIsPartialUnmapSupported_DISPATCH(struct MIGConfigSession *pResource) {
195 return pResource->__migconfigsessionIsPartialUnmapSupported__(pResource);
196 }
197
migconfigsessionPreDestruct_DISPATCH(struct MIGConfigSession * pResource)198 static inline void migconfigsessionPreDestruct_DISPATCH(struct MIGConfigSession *pResource) {
199 pResource->__migconfigsessionPreDestruct__(pResource);
200 }
201
migconfigsessionMapTo_DISPATCH(struct MIGConfigSession * pResource,RS_RES_MAP_TO_PARAMS * pParams)202 static inline NV_STATUS migconfigsessionMapTo_DISPATCH(struct MIGConfigSession *pResource, RS_RES_MAP_TO_PARAMS *pParams) {
203 return pResource->__migconfigsessionMapTo__(pResource, pParams);
204 }
205
migconfigsessionIsDuplicate_DISPATCH(struct MIGConfigSession * pResource,NvHandle hMemory,NvBool * pDuplicate)206 static inline NV_STATUS migconfigsessionIsDuplicate_DISPATCH(struct MIGConfigSession *pResource, NvHandle hMemory, NvBool *pDuplicate) {
207 return pResource->__migconfigsessionIsDuplicate__(pResource, hMemory, pDuplicate);
208 }
209
migconfigsessionControlSerialization_Epilogue_DISPATCH(struct MIGConfigSession * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)210 static inline void migconfigsessionControlSerialization_Epilogue_DISPATCH(struct MIGConfigSession *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
211 pResource->__migconfigsessionControlSerialization_Epilogue__(pResource, pCallContext, pParams);
212 }
213
migconfigsessionControl_Epilogue_DISPATCH(struct MIGConfigSession * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)214 static inline void migconfigsessionControl_Epilogue_DISPATCH(struct MIGConfigSession *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
215 pResource->__migconfigsessionControl_Epilogue__(pResource, pCallContext, pParams);
216 }
217
migconfigsessionUnmapFrom_DISPATCH(struct MIGConfigSession * pResource,RS_RES_UNMAP_FROM_PARAMS * pParams)218 static inline NV_STATUS migconfigsessionUnmapFrom_DISPATCH(struct MIGConfigSession *pResource, RS_RES_UNMAP_FROM_PARAMS *pParams) {
219 return pResource->__migconfigsessionUnmapFrom__(pResource, pParams);
220 }
221
migconfigsessionMap_DISPATCH(struct MIGConfigSession * pResource,struct CALL_CONTEXT * pCallContext,RS_CPU_MAP_PARAMS * pParams,RsCpuMapping * pCpuMapping)222 static inline NV_STATUS migconfigsessionMap_DISPATCH(struct MIGConfigSession *pResource, struct CALL_CONTEXT *pCallContext, RS_CPU_MAP_PARAMS *pParams, RsCpuMapping *pCpuMapping) {
223 return pResource->__migconfigsessionMap__(pResource, pCallContext, pParams, pCpuMapping);
224 }
225
migconfigsessionAccessCallback_DISPATCH(struct MIGConfigSession * pResource,struct RsClient * pInvokingClient,void * pAllocParams,RsAccessRight accessRight)226 static inline NvBool migconfigsessionAccessCallback_DISPATCH(struct MIGConfigSession *pResource, struct RsClient *pInvokingClient, void *pAllocParams, RsAccessRight accessRight) {
227 return pResource->__migconfigsessionAccessCallback__(pResource, pInvokingClient, pAllocParams, accessRight);
228 }
229
230 NV_STATUS migconfigsessionConstruct_IMPL(struct MIGConfigSession *arg_pMIGConfigSession, struct CALL_CONTEXT *arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL *arg_pParams);
231
232 #define __nvoc_migconfigsessionConstruct(arg_pMIGConfigSession, arg_pCallContext, arg_pParams) migconfigsessionConstruct_IMPL(arg_pMIGConfigSession, arg_pCallContext, arg_pParams)
233 void migconfigsessionDestruct_IMPL(struct MIGConfigSession *pMIGConfigSession);
234
235 #define __nvoc_migconfigsessionDestruct(pMIGConfigSession) migconfigsessionDestruct_IMPL(pMIGConfigSession)
236 #undef PRIVATE_FIELD
237
238
239 #endif // MIG_CONFIG_SESSION_H
240
241 #ifdef __cplusplus
242 } // extern "C"
243 #endif
244
245 #endif // _G_MIG_CONFIG_SESSION_NVOC_H_
246