1
2
3
4
5
6
7
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
/******************************************************************************
*
* Description
* mpapi-plugin.h - interfaces for the MP API Version 1.0 plugin library.
* A compliant plugin library should implement interfaces with name without Fn
* suffix from function definitions below.
*
* License:
* The contents of this file are subject to the SNIA Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
*
* TBD
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is iSCSI Management API and Multipath Management API
* plugin header file
*
* The Initial Developer of the Original Code is:
* Benjamin F. Kuo Troika Networks, Inc. (benk@troikanetworks.com)
* David Dillard VERITAS Software(david.dillard@veritas.com)
* Jeff Ding Adaptec, Inc. (jding@corp.adaptec.com)
* Hyon Kim Sun Microsystems(hyon.kim@sun.com)
*
* Contributor(s):
* Paul von Behren Sun Microsystems(paul.vonbehren@sun.com)
*
******************************************************************************
*
* Changes:
* 1/15/2005 Implemented SNIA MP API specification 1.0
*****************************************************************************/
#ifdef __cplusplus
extern "C" {
#endif
#ifndef MPPLUGIN_H
#define MPPLUGIN_H
/*
* MP API common library calls InitaizeFn as part of dynamically loading
* the plugins. For this version of implementation the common library
* passes the sequence number of the plugin oid through InitializeFn. The
* sequnece number will be used as the ownerId for the plugin generated OIDs.
*/
typedef MP_STATUS (* InitializeFn) (
MP_UINT32 pluginOwnerID
);
/*
* MP API common library calls TerminateFn as part of dynamically unloading
* the plugins.
*/
typedef MP_STATUS (* TerminateFn) (void);
/**
******************************************************************************
*
* Function table for OID and properties discovery API
*
******************************************************************************
*/
typedef MP_STATUS (* MP_GetPluginPropertiesPluginFn)(
MP_PLUGIN_PROPERTIES *pProps
);
typedef MP_STATUS (* MP_GetDeviceProductOidListPluginFn)(
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetDeviceProductPropertiesFn)(
MP_OID oid,
MP_DEVICE_PRODUCT_PROPERTIES *pProps
);
typedef MP_STATUS (* MP_GetInitiatorPortOidListPluginFn)(
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetInitiatorPortPropertiesFn)(
MP_OID oid,
MP_INITIATOR_PORT_PROPERTIES *pProps
);
typedef MP_STATUS (* MP_GetMultipathLusPluginFn)(
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetMultipathLusDevProdFn)(
MP_OID oid,
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetMPLogicalUnitPropertiesFn)(
MP_OID oid,
MP_MULTIPATH_LOGICAL_UNIT_PROPERTIES *pProps
);
typedef MP_STATUS (* MP_GetAssociatedPathOidListFn)(
MP_OID oid,
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetPathLogicalUnitPropertiesFn)(
MP_OID oid,
MP_PATH_LOGICAL_UNIT_PROPERTIES *pProps
);
typedef MP_STATUS (* MP_GetAssociatedTPGOidListFn)(
MP_OID oid,
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetTargetPortGroupPropertiesFn)(
MP_OID oid,
MP_TARGET_PORT_GROUP_PROPERTIES *pProps
);
typedef MP_STATUS (* MP_GetMPLuOidListFromTPGFn)(
MP_OID oid,
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetProprietaryLoadBalanceOidListPluginFn)(
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetProprietaryLoadBalancePropertiesFn)(
MP_OID oid,
MP_PROPRIETARY_LOAD_BALANCE_PROPERTIES *pProps
);
typedef MP_STATUS (* MP_GetTargetPortOidListFn)(
MP_OID oid,
MP_OID_LIST **ppList
);
typedef MP_STATUS (* MP_GetTargetPortPropertiesFn)(
MP_OID oid,
MP_TARGET_PORT_PROPERTIES *pProps
);
/**
******************************************************************************
*
* Function table for path management API
*
******************************************************************************
*/
typedef MP_STATUS (* MP_AssignLogicalUnitToTPGFn)(
MP_OID tpgOid,
MP_OID luOid
);
typedef MP_STATUS (* MP_SetOverridePathFn)(
MP_OID logicalUnitOid,
MP_OID pathOid
);
typedef MP_STATUS (* MP_CancelOverridePathFn)(
MP_OID luOid
);
typedef MP_STATUS (* MP_EnableAutoFailbackPluginFn)(
);
typedef MP_STATUS (* MP_EnableAutoFailbackLuFn)(
MP_OID oid
);
typedef MP_STATUS (* MP_EnableAutoProbingPluginFn)(
);
typedef MP_STATUS (* MP_EnableAutoProbingLuFn)(
MP_OID oid
);
typedef MP_STATUS (* MP_DisableAutoFailbackPluginFn)(
);
typedef MP_STATUS (* MP_DisableAutoFailbackLuFn)(
MP_OID oid
);
typedef MP_STATUS (* MP_DisableAutoProbingPluginFn)(
);
typedef MP_STATUS (* MP_DisableAutoProbingLuFn)(
MP_OID oid
);
typedef MP_STATUS (* MP_EnablePathFn)(
MP_OID oid
);
typedef MP_STATUS (* MP_DisablePathFn)(
MP_OID oid
);
typedef MP_STATUS (* MP_SetLogicalUnitLoadBalanceTypeFn)(
MP_OID logicalUnitoid,
MP_LOAD_BALANCE_TYPE loadBalance
);
typedef MP_STATUS (* MP_SetPathWeightFn)(
MP_OID pathOid,
MP_UINT32 weight
);
typedef MP_STATUS (* MP_SetPluginLoadBalanceTypePluginFn)(
MP_LOAD_BALANCE_TYPE loadBalance
);
typedef MP_STATUS (* MP_SetFailbackPollingRatePluginFn)(
MP_UINT32 pollingRate
);
typedef MP_STATUS (* MP_SetFailbackPollingRateLuFn)(
MP_OID oid,
MP_UINT32 pollingRate
);
typedef MP_STATUS (* MP_SetProbingPollingRatePluginFn)(
MP_UINT32 pollingRate
);
typedef MP_STATUS (* MP_SetProbingPollingRateLuFn)(
MP_OID oid,
MP_UINT32 pollingRate
);
typedef MP_STATUS (* MP_SetProprietaryPropertiesFn)(
MP_OID oid,
MP_UINT32 count,
MP_PROPRIETARY_PROPERTY *pPropertyList
);
typedef MP_STATUS (* MP_SetTPGAccessFn)(
MP_OID luOid,
MP_UINT32 count,
MP_TPG_STATE_PAIR *pTpgStateList
);
/**
******************************************************************************
*
* Function table for event support API
*
******************************************************************************
*/
typedef MP_STATUS (* MP_RegisterForObjectPropertyChangesPluginFn)(
MP_OBJECT_PROPERTY_FN pClientFn,
MP_OBJECT_TYPE objectType,
void *pCallerData
);
typedef MP_STATUS (* MP_DeregisterForObjectPropertyChangesPluginFn)(
MP_OBJECT_PROPERTY_FN pClientFn,
MP_OBJECT_TYPE objectType
);
typedef MP_STATUS (* MP_RegisterForObjectVisibilityChangesPluginFn)(
MP_OBJECT_VISIBILITY_FN pClientFn,
MP_OBJECT_TYPE objectType,
void *pCallerData
);
typedef MP_STATUS (* MP_DeregisterForObjectVisibilityChangesPluginFn)(
MP_OBJECT_VISIBILITY_FN pClientFn,
MP_OBJECT_TYPE objectType
);
typedef MP_STATUS (* Sun_MP_SendScsiCmdFn)(
MP_OID oid, struct uscsi_cmd *cmd
);
#endif
#ifdef __cplusplus
};
#endif
|
