|
| 1 | +/* |
| 2 | + Copyright © The CDI Authors |
| 3 | +
|
| 4 | + Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + you may not use this file except in compliance with the License. |
| 6 | + You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | + Unless required by applicable law or agreed to in writing, software |
| 11 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + See the License for the specific language governing permissions and |
| 14 | + limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package cdi |
| 18 | + |
| 19 | +import ( |
| 20 | + "strings" |
| 21 | + |
| 22 | + "golang.org/x/mod/semver" |
| 23 | + |
| 24 | + cdi "github.com/container-orchestrated-devices/container-device-interface/specs-go" |
| 25 | +) |
| 26 | + |
| 27 | +const ( |
| 28 | + // CurrentVersion is the current vesion of the CDI Spec. |
| 29 | + CurrentVersion = cdi.CurrentVersion |
| 30 | + |
| 31 | + vCurrent version = "v" + CurrentVersion |
| 32 | + |
| 33 | + vEarliest version = v020 |
| 34 | + |
| 35 | + v020 version = "v0.2.0" |
| 36 | + v030 version = "v0.3.0" |
| 37 | + v040 version = "v0.4.0" |
| 38 | + v050 version = "v0.5.0" |
| 39 | +) |
| 40 | + |
| 41 | +// version represents a semantic version string |
| 42 | +type version string |
| 43 | + |
| 44 | +// String returns the string representation of the version. |
| 45 | +// This trims a leading v if present. |
| 46 | +func (v version) String() string { |
| 47 | + return strings.TrimPrefix(string(v), "v") |
| 48 | +} |
| 49 | + |
| 50 | +// LT checks whether a version is less than the specified version. |
| 51 | +// Semantic versioning is used to perform the comparison. |
| 52 | +func (v version) LT(o version) bool { |
| 53 | + return semver.Compare(string(v), string(o)) < 0 |
| 54 | +} |
| 55 | + |
| 56 | +// IsLatest checks whether the version is the latest supported version |
| 57 | +func (v version) IsLatest() bool { |
| 58 | + return v == vCurrent |
| 59 | +} |
| 60 | + |
| 61 | +type requiredFunc func(*cdi.Spec) bool |
| 62 | + |
| 63 | +type requiredVersionMap map[version]requiredFunc |
| 64 | + |
| 65 | +// required stores a map of spec versions to functions to check the required versions. |
| 66 | +// Adding new fields / spec versions requires that a `requiredFunc` be implemented and |
| 67 | +// this map be updated. |
| 68 | +var required = requiredVersionMap{ |
| 69 | + v050: requiresV050, |
| 70 | + v040: requiresV040, |
| 71 | +} |
| 72 | + |
| 73 | +// minVersion returns the minimum version required for the given spec |
| 74 | +func (r requiredVersionMap) minVersion(spec *cdi.Spec) version { |
| 75 | + minVersion := vEarliest |
| 76 | + |
| 77 | + for specVersion := range validSpecVersions { |
| 78 | + v := version("v" + strings.TrimPrefix(specVersion, "v")) |
| 79 | + if f, ok := r[v]; ok { |
| 80 | + if f(spec) && minVersion.LT(v) { |
| 81 | + minVersion = v |
| 82 | + } |
| 83 | + } |
| 84 | + // If we have already detected the latest version then no later version could be detected |
| 85 | + if minVersion.IsLatest() { |
| 86 | + break |
| 87 | + } |
| 88 | + } |
| 89 | + |
| 90 | + return minVersion |
| 91 | +} |
| 92 | + |
| 93 | +// requiresV050 returns true if the spec uses v0.5.0 features |
| 94 | +func requiresV050(spec *cdi.Spec) bool { |
| 95 | + var edits []*cdi.ContainerEdits |
| 96 | + |
| 97 | + for _, d := range spec.Devices { |
| 98 | + // The v0.5.0 spec allowed device names to start with a digit instead of requiring a letter |
| 99 | + if len(d.Name) > 0 && !isLetter(rune(d.Name[0])) { |
| 100 | + return true |
| 101 | + } |
| 102 | + edits = append(edits, &d.ContainerEdits) |
| 103 | + } |
| 104 | + |
| 105 | + edits = append(edits, &spec.ContainerEdits) |
| 106 | + for _, e := range edits { |
| 107 | + for _, dn := range e.DeviceNodes { |
| 108 | + // The HostPath field was added in v0.5.0 |
| 109 | + if dn.HostPath != "" { |
| 110 | + return true |
| 111 | + } |
| 112 | + } |
| 113 | + } |
| 114 | + return false |
| 115 | +} |
| 116 | + |
| 117 | +// requiresV040 returns true if the spec uses v0.4.0 features |
| 118 | +func requiresV040(spec *cdi.Spec) bool { |
| 119 | + var edits []*cdi.ContainerEdits |
| 120 | + |
| 121 | + for _, d := range spec.Devices { |
| 122 | + edits = append(edits, &d.ContainerEdits) |
| 123 | + } |
| 124 | + |
| 125 | + edits = append(edits, &spec.ContainerEdits) |
| 126 | + for _, e := range edits { |
| 127 | + for _, m := range e.Mounts { |
| 128 | + // The Type field was added in v0.4.0 |
| 129 | + if m.Type != "" { |
| 130 | + return true |
| 131 | + } |
| 132 | + } |
| 133 | + } |
| 134 | + return false |
| 135 | +} |
0 commit comments