Skip to content

Commit 55f3e17

Browse files
committed
add 'annotations' parameter to the NewDeviceInfo API
Signed-off-by: Ed Bartosh <[email protected]>
1 parent ab34c3a commit 55f3e17

File tree

12 files changed

+60
-53
lines changed

12 files changed

+60
-53
lines changed

cmd/dlb_plugin/dlb_plugin.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ func (dp *DevicePlugin) scan() dpapi.DeviceTree {
8888
ContainerPath: file,
8989
Permissions: "rw",
9090
}}
91-
deviceInfo := dpapi.NewDeviceInfo(pluginapi.Healthy, devs, nil, nil)
91+
deviceInfo := dpapi.NewDeviceInfo(pluginapi.Healthy, devs, nil, nil, nil)
9292

9393
sysfsDev := filepath.Join(dp.sysfsDir, filepath.Base(file))
9494
sriovNumVFs := pluginutils.GetSriovNumVFs(sysfsDev)

cmd/fpga_plugin/dfl_test.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ func TestGetRegionDevelTreeDFL(t *testing.T) {
139139
Permissions: "rw",
140140
},
141141
}
142-
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "region1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
142+
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "region1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
143143

144144
nodes = []pluginapi.DeviceSpec{
145145
{
@@ -158,7 +158,7 @@ func TestGetRegionDevelTreeDFL(t *testing.T) {
158158
Permissions: "rw",
159159
},
160160
}
161-
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "region2", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
161+
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "region2", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
162162

163163
nodes = []pluginapi.DeviceSpec{
164164
{
@@ -177,7 +177,7 @@ func TestGetRegionDevelTreeDFL(t *testing.T) {
177177
Permissions: "rw",
178178
},
179179
}
180-
expected.AddDevice(regionMode+"-"+unhealthyInterfaceID, "region3", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil))
180+
expected.AddDevice(regionMode+"-"+unhealthyInterfaceID, "region3", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil, nil))
181181

182182
result := getRegionDevelTree(getDevicesDFL())
183183
if !reflect.DeepEqual(result, expected) {
@@ -194,7 +194,7 @@ func TestGetRegionTreeDFL(t *testing.T) {
194194
Permissions: "rw",
195195
},
196196
}
197-
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "region1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
197+
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "region1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
198198

199199
nodes = []pluginapi.DeviceSpec{
200200
{
@@ -208,7 +208,7 @@ func TestGetRegionTreeDFL(t *testing.T) {
208208
Permissions: "rw",
209209
},
210210
}
211-
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "region2", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
211+
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "region2", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
212212

213213
nodes = []pluginapi.DeviceSpec{
214214
{
@@ -222,7 +222,7 @@ func TestGetRegionTreeDFL(t *testing.T) {
222222
Permissions: "rw",
223223
},
224224
}
225-
expected.AddDevice(regionMode+"-"+unhealthyInterfaceID, "region3", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil))
225+
expected.AddDevice(regionMode+"-"+unhealthyInterfaceID, "region3", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil, nil))
226226

227227
result := getRegionTree(getDevicesDFL())
228228
if !reflect.DeepEqual(result, expected) {
@@ -239,7 +239,7 @@ func TestGetAfuTreeDFL(t *testing.T) {
239239
Permissions: "rw",
240240
},
241241
}
242-
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "dfl-port.0", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
242+
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "dfl-port.0", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
243243

244244
nodes = []pluginapi.DeviceSpec{
245245
{
@@ -249,7 +249,7 @@ func TestGetAfuTreeDFL(t *testing.T) {
249249
},
250250
}
251251

252-
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "dfl-port.1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
252+
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "dfl-port.1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
253253

254254
nodes = []pluginapi.DeviceSpec{
255255
{
@@ -258,7 +258,7 @@ func TestGetAfuTreeDFL(t *testing.T) {
258258
Permissions: "rw",
259259
},
260260
}
261-
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "dfl-port.2", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
261+
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "dfl-port.2", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
262262

263263
nodes = []pluginapi.DeviceSpec{
264264
{
@@ -267,7 +267,7 @@ func TestGetAfuTreeDFL(t *testing.T) {
267267
Permissions: "rw",
268268
},
269269
}
270-
expected.AddDevice("af-fff.fff.__________________________________________8", "dfl-port.3", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil))
270+
expected.AddDevice("af-fff.fff.__________________________________________8", "dfl-port.3", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil, nil))
271271

272272
nodes = []pluginapi.DeviceSpec{
273273
{
@@ -276,7 +276,7 @@ func TestGetAfuTreeDFL(t *testing.T) {
276276
Permissions: "rw",
277277
},
278278
}
279-
expected.AddDevice("af-fff.fff.__________________________________________8", "dfl-port.4", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil))
279+
expected.AddDevice("af-fff.fff.__________________________________________8", "dfl-port.4", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil, nil))
280280

281281
result := getAfuTree(getDevicesDFL())
282282
if !reflect.DeepEqual(result, expected) {

cmd/fpga_plugin/fpga_plugin.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ func getRegionDevelTree(devices []device) dpapi.DeviceTree {
8383
Permissions: "rw",
8484
}
8585

86-
regionTree.AddDevice(devType, region.id, dpapi.NewDeviceInfo(health, devNodes, nil, nil))
86+
regionTree.AddDevice(devType, region.id, dpapi.NewDeviceInfo(health, devNodes, nil, nil, nil))
8787
}
8888
}
8989

@@ -112,7 +112,7 @@ func getRegionTree(devices []device) dpapi.DeviceTree {
112112
}
113113
}
114114

115-
regionTree.AddDevice(devType, region.id, dpapi.NewDeviceInfo(health, devNodes, nil, nil))
115+
regionTree.AddDevice(devType, region.id, dpapi.NewDeviceInfo(health, devNodes, nil, nil, nil))
116116
}
117117
}
118118

@@ -144,7 +144,7 @@ func getAfuTree(devices []device) dpapi.DeviceTree {
144144
Permissions: "rw",
145145
},
146146
}
147-
afuTree.AddDevice(devType, afu.id, dpapi.NewDeviceInfo(health, devNodes, nil, nil))
147+
afuTree.AddDevice(devType, afu.id, dpapi.NewDeviceInfo(health, devNodes, nil, nil, nil))
148148
}
149149
}
150150
}

cmd/fpga_plugin/opae_test.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ func TestGetRegionDevelTreeOPAE(t *testing.T) {
129129
Permissions: "rw",
130130
},
131131
}
132-
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "intel-fpga-fme.0", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
132+
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "intel-fpga-fme.0", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
133133

134134
nodes = []pluginapi.DeviceSpec{
135135
{
@@ -143,7 +143,7 @@ func TestGetRegionDevelTreeOPAE(t *testing.T) {
143143
Permissions: "rw",
144144
},
145145
}
146-
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "intel-fpga-fme.1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
146+
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "intel-fpga-fme.1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
147147

148148
nodes = []pluginapi.DeviceSpec{
149149
{
@@ -157,7 +157,7 @@ func TestGetRegionDevelTreeOPAE(t *testing.T) {
157157
Permissions: "rw",
158158
},
159159
}
160-
expected.AddDevice(regionMode+"-"+unhealthyInterfaceID, "intel-fpga-fme.2", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil))
160+
expected.AddDevice(regionMode+"-"+unhealthyInterfaceID, "intel-fpga-fme.2", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil, nil))
161161

162162
result := getRegionDevelTree(getDevicesOPAE())
163163
if !reflect.DeepEqual(result, expected) {
@@ -174,7 +174,7 @@ func TestGetRegionTreeOPAE(t *testing.T) {
174174
Permissions: "rw",
175175
},
176176
}
177-
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "intel-fpga-fme.0", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
177+
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "intel-fpga-fme.0", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
178178

179179
nodes = []pluginapi.DeviceSpec{
180180
{
@@ -183,7 +183,7 @@ func TestGetRegionTreeOPAE(t *testing.T) {
183183
Permissions: "rw",
184184
},
185185
}
186-
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "intel-fpga-fme.1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
186+
expected.AddDevice(regionMode+"-ce48969398f05f33946d560708be108a", "intel-fpga-fme.1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
187187

188188
nodes = []pluginapi.DeviceSpec{
189189
{
@@ -192,7 +192,7 @@ func TestGetRegionTreeOPAE(t *testing.T) {
192192
Permissions: "rw",
193193
},
194194
}
195-
expected.AddDevice(regionMode+"-"+unhealthyInterfaceID, "intel-fpga-fme.2", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil))
195+
expected.AddDevice(regionMode+"-"+unhealthyInterfaceID, "intel-fpga-fme.2", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil, nil))
196196

197197
result := getRegionTree(getDevicesOPAE())
198198
if !reflect.DeepEqual(result, expected) {
@@ -209,7 +209,7 @@ func TestGetAfuTreeOPAE(t *testing.T) {
209209
Permissions: "rw",
210210
},
211211
}
212-
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "intel-fpga-port.0", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
212+
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "intel-fpga-port.0", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
213213

214214
nodes = []pluginapi.DeviceSpec{
215215
{
@@ -218,7 +218,7 @@ func TestGetAfuTreeOPAE(t *testing.T) {
218218
Permissions: "rw",
219219
},
220220
}
221-
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "intel-fpga-port.1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil))
221+
expected.AddDevice("af-ce4.d84.zkiWk5jwXzOUbVYHCL4QithCTcSko8QT-J5DNoP5BAs", "intel-fpga-port.1", dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil))
222222

223223
nodes = []pluginapi.DeviceSpec{
224224
{
@@ -227,7 +227,7 @@ func TestGetAfuTreeOPAE(t *testing.T) {
227227
Permissions: "rw",
228228
},
229229
}
230-
expected.AddDevice("af-fff.fff.__________________________________________8", "intel-fpga-port.2", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil))
230+
expected.AddDevice("af-fff.fff.__________________________________________8", "intel-fpga-port.2", dpapi.NewDeviceInfo(pluginapi.Unhealthy, nodes, nil, nil, nil))
231231

232232
result := getAfuTree(getDevicesOPAE())
233233
if !reflect.DeepEqual(result, expected) {

cmd/gpu_plugin/gpu_plugin.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ func (dp *devicePlugin) scan() (dpapi.DeviceTree, error) {
329329
}
330330

331331
if len(nodes) > 0 {
332-
deviceInfo := dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil)
332+
deviceInfo := dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, nil, nil, nil)
333333

334334
for i := 0; i < dp.options.sharedDevNum; i++ {
335335
devID := fmt.Sprintf("%s-%d", f.Name(), i)
@@ -343,7 +343,7 @@ func (dp *devicePlugin) scan() (dpapi.DeviceTree, error) {
343343
}
344344
// all Intel GPUs are under single monitoring resource
345345
if len(monitor) > 0 {
346-
deviceInfo := dpapi.NewDeviceInfo(pluginapi.Healthy, monitor, nil, nil)
346+
deviceInfo := dpapi.NewDeviceInfo(pluginapi.Healthy, monitor, nil, nil, nil)
347347
devTree.AddDevice(monitorType, monitorID, deviceInfo)
348348
}
349349

cmd/qat_plugin/dpdkdrv/dpdkdrv.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ func (dp *DevicePlugin) scan() (dpapi.DeviceTree, error) {
430430
fmt.Sprintf("%s%d", envVarPrefix, n): vfBdf,
431431
}
432432

433-
devinfo := dpapi.NewDeviceInfo(pluginapi.Healthy, dp.getDpdkDeviceSpecs(dpdkDeviceName), dp.getDpdkMounts(dpdkDeviceName), envs)
433+
devinfo := dpapi.NewDeviceInfo(pluginapi.Healthy, dp.getDpdkDeviceSpecs(dpdkDeviceName), dp.getDpdkMounts(dpdkDeviceName), envs, nil)
434434

435435
devTree.AddDevice("generic", vfBdf, devinfo)
436436
}

cmd/qat_plugin/kerneldrv/kerneldrv.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ func getDevTree(sysfs string, qatDevs []device, config map[string]section) (dpap
102102
// The rest should use QAT_SECTION_NAME_XXX variables.
103103
"QAT_SECTION_NAME": sname,
104104
}
105-
deviceInfo := dpapi.NewDeviceInfo(pluginapi.Healthy, devs, nil, envs)
105+
deviceInfo := dpapi.NewDeviceInfo(pluginapi.Healthy, devs, nil, envs, nil)
106106
devTree.AddDevice(devType, fmt.Sprintf("%s_%s_%d", sname, ep.id, i), deviceInfo)
107107
uniqID++
108108
}

cmd/sgx_plugin/sgx_plugin.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,13 @@ func (dp *devicePlugin) scan() (dpapi.DeviceTree, error) {
9494
for i := uint(0); i < dp.nEnclave; i++ {
9595
devID := fmt.Sprintf("%s-%d", "sgx-enclave", i)
9696
nodes := []pluginapi.DeviceSpec{{HostPath: sgxEnclavePath, ContainerPath: sgxEnclavePath, Permissions: "rw"}}
97-
devTree.AddDevice(deviceTypeEnclave, devID, dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, deprecatedMounts, nil))
97+
devTree.AddDevice(deviceTypeEnclave, devID, dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, deprecatedMounts, nil, nil))
9898
}
9999

100100
for i := uint(0); i < dp.nProvision; i++ {
101101
devID := fmt.Sprintf("%s-%d", "sgx-provision", i)
102102
nodes := []pluginapi.DeviceSpec{{HostPath: sgxProvisionPath, ContainerPath: sgxProvisionPath, Permissions: "rw"}}
103-
devTree.AddDevice(deviceTypeProvision, devID, dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, deprecatedMounts, nil))
103+
devTree.AddDevice(deviceTypeProvision, devID, dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, deprecatedMounts, nil, nil))
104104
}
105105

106106
return devTree, nil

cmd/vpu_plugin/vpu_plugin.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ func (dp *devicePlugin) scanUsb(devTree *dpapi.DeviceTree) {
224224
ContainerPath: hddlServicePath2,
225225
},
226226
}
227-
devTree.AddDevice(deviceType, devID, dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, mounts, nil))
227+
devTree.AddDevice(deviceType, devID, dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, mounts, nil, nil))
228228
}
229229
}
230230
}
@@ -284,7 +284,7 @@ func (dp *devicePlugin) scanPci(devTree *dpapi.DeviceTree) {
284284
devID := fmt.Sprintf("%s-device-%d", deviceTypePci, i)
285285
// VPU pci device found and added to node
286286
klog.V(1).Info(devID)
287-
devTree.AddDevice(deviceTypePci, devID, dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, mounts, nil))
287+
devTree.AddDevice(deviceTypePci, devID, dpapi.NewDeviceInfo(pluginapi.Healthy, nodes, mounts, nil, nil))
288288
}
289289
}
290290
}

pkg/deviceplugin/api.go

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ import (
2323

2424
// DeviceInfo contains information about device maintained by Device Plugin.
2525
type DeviceInfo struct {
26-
mounts []pluginapi.Mount
27-
envs map[string]string
28-
topology *pluginapi.TopologyInfo
29-
state string
30-
nodes []pluginapi.DeviceSpec
26+
mounts []pluginapi.Mount
27+
envs map[string]string
28+
annotations map[string]string
29+
topology *pluginapi.TopologyInfo
30+
state string
31+
nodes []pluginapi.DeviceSpec
3132
}
3233

3334
// UseDefaultMethodError allows the plugin to request running the default
@@ -44,12 +45,13 @@ func init() {
4445
}
4546

4647
// NewDeviceInfo makes DeviceInfo struct and adds topology information to it.
47-
func NewDeviceInfo(state string, nodes []pluginapi.DeviceSpec, mounts []pluginapi.Mount, envs map[string]string) DeviceInfo {
48+
func NewDeviceInfo(state string, nodes []pluginapi.DeviceSpec, mounts []pluginapi.Mount, envs map[string]string, annotations map[string]string) DeviceInfo {
4849
deviceInfo := DeviceInfo{
49-
state: state,
50-
nodes: nodes,
51-
mounts: mounts,
52-
envs: envs,
50+
state: state,
51+
nodes: nodes,
52+
mounts: mounts,
53+
envs: envs,
54+
annotations: annotations,
5355
}
5456

5557
devPaths := []string{}
@@ -70,13 +72,14 @@ func NewDeviceInfo(state string, nodes []pluginapi.DeviceSpec, mounts []pluginap
7072

7173
// NewDeviceInfoWithTopologyHints makes DeviceInfo struct with topology information provided to it.
7274
func NewDeviceInfoWithTopologyHints(state string, nodes []pluginapi.DeviceSpec, mounts []pluginapi.Mount, envs map[string]string,
73-
topology *pluginapi.TopologyInfo) DeviceInfo {
75+
annotations map[string]string, topology *pluginapi.TopologyInfo) DeviceInfo {
7476
return DeviceInfo{
75-
state: state,
76-
nodes: nodes,
77-
mounts: mounts,
78-
envs: envs,
79-
topology: topology,
77+
state: state,
78+
nodes: nodes,
79+
mounts: mounts,
80+
envs: envs,
81+
annotations: annotations,
82+
topology: topology,
8083
}
8184
}
8285

0 commit comments

Comments
 (0)