-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
ovs.go
432 lines (371 loc) · 12.9 KB
/
ovs.go
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
package ovs
import (
"bytes"
"fmt"
"strconv"
"strings"
"k8s.io/klog"
utilversion "k8s.io/apimachinery/pkg/util/version"
"k8s.io/utils/exec"
)
// Interface represents an interface to OVS
type Interface interface {
// AddBridge creates the bridge associated with the interface, optionally setting
// properties on it (as with "ovs-vsctl set Bridge ..."). If the bridge already
// exists this errors.
AddBridge(properties ...string) error
// DeleteBridge deletes the bridge associated with the interface. The boolean
// that can be passed determines if a bridge not existing is an error. Passing
// true will delete bridge --if-exists, passing false will error if the bridge
// does not exist.
DeleteBridge(ifExists bool) error
// AddPort adds an interface to the bridge, requesting the indicated port
// number, and optionally setting properties on it (as with "ovs-vsctl set
// Interface ..."). Returns the allocated port number (or an error).
AddPort(port string, ofportRequest int, properties ...string) (int, error)
// DeletePort removes an interface from the bridge. (It is not an
// error if the interface is not currently a bridge port.)
DeletePort(port string) error
// GetOFPort returns the OpenFlow port number of a given network interface
// attached to a bridge.
GetOFPort(port string) (int, error)
// SetFrags sets the fragmented-packet-handling mode (as with
// "ovs-ofctl set-frags")
SetFrags(mode string) error
// Create creates a record in the OVS database, as with "ovs-vsctl create" and
// returns the UUID of the newly-created item.
// NOTE: This only works for QoS; for all other tables the created object will
// immediately be garbage-collected; we'd need an API that calls "create" and "set"
// in the same "ovs-vsctl" call.
Create(table string, values ...string) (string, error)
// Destroy deletes the indicated record in the OVS database. It is not an error if
// the record does not exist
Destroy(table, record string) error
// Get gets the indicated value from the OVS database. For multi-valued or
// map-valued columns, the data is returned in the same format as "ovs-vsctl get".
Get(table, record, column string) (string, error)
// Set sets one or more columns on a record in the OVS database, as with
// "ovs-vsctl set"
Set(table, record string, values ...string) error
// Clear unsets the indicated columns in the OVS database. It is not an error if
// the value is already unset
Clear(table, record string, columns ...string) error
// Find finds records in the OVS database that match the given condition.
// It returns the value of the given columns of matching records.
Find(table string, column []string, condition string) ([]map[string]string, error)
// FindOne is like Find but returns only a single column
FindOne(table, column, condition string) ([]string, error)
// DumpFlows dumps the flow table for the bridge and returns it as an array of
// strings, one per flow. If flow is not "" then it describes the flows to dump.
DumpFlows(flow string, args ...interface{}) ([]string, error)
// NewTransaction begins a new OVS transaction.
NewTransaction() Transaction
}
// Transaction manages a single set of OVS flow modifications
type Transaction interface {
// AddFlow prepares adding a flow to the bridge.
// Given flow is cached but not executed at this time.
// The arguments are passed to fmt.Sprintf().
AddFlow(flow string, args ...interface{})
// DeleteFlows prepares deleting all matching flows from the bridge.
// Given flow is cached but not executed at this time.
// The arguments are passed to fmt.Sprintf().
DeleteFlows(flow string, args ...interface{})
// Commit executes all cached flows as a single atomic transaction and
// returns any error that occurred during the transaction.
Commit() error
}
const (
OVS_OFCTL = "ovs-ofctl"
OVS_VSCTL = "ovs-vsctl"
)
// ovsExec implements ovs.Interface via calls to ovs-ofctl and ovs-vsctl
type ovsExec struct {
execer exec.Interface
bridge string
}
// New returns a new ovs.Interface
func New(execer exec.Interface, bridge string, minVersion string) (Interface, error) {
if _, err := execer.LookPath(OVS_OFCTL); err != nil {
return nil, fmt.Errorf("OVS is not installed")
}
if _, err := execer.LookPath(OVS_VSCTL); err != nil {
return nil, fmt.Errorf("OVS is not installed")
}
ovsif := &ovsExec{execer: execer, bridge: bridge}
if minVersion != "" {
minVer := utilversion.MustParseGeneric(minVersion)
out, err := ovsif.exec(OVS_VSCTL, "--version")
if err != nil {
return nil, fmt.Errorf("could not check OVS version is %s or higher", minVersion)
}
// First output line should end with version
lines := strings.Split(out, "\n")
spc := strings.LastIndex(lines[0], " ")
instVer, err := utilversion.ParseGeneric(lines[0][spc+1:])
if err != nil {
return nil, fmt.Errorf("could not find OVS version in %q", lines[0])
}
if !instVer.AtLeast(minVer) {
return nil, fmt.Errorf("found OVS %v, need %s or later", instVer, minVersion)
}
}
return ovsif, nil
}
func (ovsif *ovsExec) execWithStdin(cmd string, stdinArgs []string, args ...string) (string, error) {
logLevel := klog.Level(4)
switch cmd {
case OVS_OFCTL:
if args[0] == "dump-flows" {
logLevel = klog.Level(5)
}
args = append([]string{"-O", "OpenFlow13"}, args...)
case OVS_VSCTL:
args = append([]string{"--timeout=30"}, args...)
}
kcmd := ovsif.execer.Command(cmd, args...)
if stdinArgs != nil {
stdinString := strings.Join(stdinArgs, "\n")
stdin := bytes.NewBufferString(stdinString)
kcmd.SetStdin(stdin)
klog.V(logLevel).Infof("Executing: %s %s <<\n%s", cmd, strings.Join(args, " "), stdinString)
} else {
klog.V(logLevel).Infof("Executing: %s %s", cmd, strings.Join(args, " "))
}
output, err := kcmd.CombinedOutput()
if err != nil {
klog.V(2).Infof("Error executing %s: %s", cmd, string(output))
return "", err
}
outStr := string(output)
if outStr != "" {
// If output is a single line, strip the trailing newline
nl := strings.Index(outStr, "\n")
if nl == len(outStr)-1 {
outStr = outStr[:nl]
}
}
return outStr, nil
}
func (ovsif *ovsExec) exec(cmd string, args ...string) (string, error) {
return ovsif.execWithStdin(cmd, nil, args...)
}
func validateColumns(columns ...string) error {
for _, col := range columns {
end := strings.IndexAny(col, ":=")
if end != -1 {
col = col[:end]
}
if strings.Contains(col, "-") {
return fmt.Errorf("bad ovsdb column name %q: should be %q", col, strings.Replace(col, "-", "_", -1))
}
}
return nil
}
func (ovsif *ovsExec) AddBridge(properties ...string) error {
args := []string{"add-br", ovsif.bridge}
if len(properties) > 0 {
if err := validateColumns(properties...); err != nil {
return err
}
args = append(args, "--", "set", "Bridge", ovsif.bridge)
args = append(args, properties...)
}
_, err := ovsif.exec(OVS_VSCTL, args...)
return err
}
func (ovsif *ovsExec) DeleteBridge(ifExists bool) error {
args := []string{"del-br", ovsif.bridge}
if ifExists {
args = append([]string{"--if-exists"}, args...)
}
_, err := ovsif.exec(OVS_VSCTL, args...)
return err
}
func (ovsif *ovsExec) GetOFPort(port string) (int, error) {
ofportStr, err := ovsif.exec(OVS_VSCTL, "get", "Interface", port, "ofport")
if err != nil {
return -1, fmt.Errorf("failed to get OVS port for %s: %v", port, err)
}
ofport, err := strconv.Atoi(ofportStr)
if err != nil {
return -1, fmt.Errorf("could not parse allocated ofport %q: %v", ofportStr, err)
}
if ofport == -1 {
errStr, err := ovsif.exec(OVS_VSCTL, "get", "Interface", port, "error")
if err != nil || errStr == "" {
errStr = "unknown error"
}
return -1, fmt.Errorf("error on port %s: %s", port, errStr)
}
return ofport, nil
}
func (ovsif *ovsExec) AddPort(port string, ofportRequest int, properties ...string) (int, error) {
args := []string{"--may-exist", "add-port", ovsif.bridge, port}
if ofportRequest > 0 || len(properties) > 0 {
args = append(args, "--", "set", "Interface", port)
if ofportRequest > 0 {
args = append(args, fmt.Sprintf("ofport_request=%d", ofportRequest))
}
if len(properties) > 0 {
if err := validateColumns(properties...); err != nil {
return -1, err
}
args = append(args, properties...)
}
}
_, err := ovsif.exec(OVS_VSCTL, args...)
if err != nil {
return -1, err
}
ofport, err := ovsif.GetOFPort(port)
if err != nil {
return -1, err
}
if ofportRequest > 0 && ofportRequest != ofport {
return -1, fmt.Errorf("allocated ofport (%d) did not match request (%d)", ofport, ofportRequest)
}
return ofport, nil
}
func (ovsif *ovsExec) DeletePort(port string) error {
_, err := ovsif.exec(OVS_VSCTL, "--if-exists", "del-port", ovsif.bridge, port)
return err
}
func (ovsif *ovsExec) SetFrags(mode string) error {
_, err := ovsif.exec(OVS_OFCTL, "set-frags", ovsif.bridge, mode)
return err
}
func (ovsif *ovsExec) Create(table string, values ...string) (string, error) {
if err := validateColumns(values...); err != nil {
return "", err
}
args := append([]string{"create", table}, values...)
return ovsif.exec(OVS_VSCTL, args...)
}
func (ovsif *ovsExec) Destroy(table, record string) error {
_, err := ovsif.exec(OVS_VSCTL, "--if-exists", "destroy", table, record)
return err
}
func (ovsif *ovsExec) Get(table, record, column string) (string, error) {
if err := validateColumns(column); err != nil {
return "", err
}
return ovsif.exec(OVS_VSCTL, "get", table, record, column)
}
func (ovsif *ovsExec) Set(table, record string, values ...string) error {
if err := validateColumns(values...); err != nil {
return err
}
args := append([]string{"set", table, record}, values...)
_, err := ovsif.exec(OVS_VSCTL, args...)
return err
}
func (ovsif *ovsExec) Find(table string, columns []string, condition string) ([]map[string]string, error) {
if err := validateColumns(columns...); err != nil {
return nil, err
}
if err := validateColumns(condition); err != nil {
return nil, err
}
output, err := ovsif.exec(OVS_VSCTL, "--columns="+strings.Join(columns, ","), "find", table, condition)
if err != nil {
return nil, err
}
output = strings.TrimSuffix(output, "\n")
if output == "" {
return nil, err
}
rows := strings.Split(output, "\n\n")
result := make([]map[string]string, len(rows))
for i, row := range rows {
cols := make(map[string]string)
for _, col := range strings.Split(row, "\n") {
data := strings.SplitN(col, ":", 2)
if len(data) != 2 {
return nil, fmt.Errorf("bad 'ovs-vsctl find' line %q", col)
}
name := strings.TrimSpace(data[0])
val := strings.TrimSpace(data[1])
// We want "bare" values for strings, but we can't pass --bare to
// ovs-vsctl because it breaks more complicated types. So try
// passing each value through Unquote(); if it fails, that means
// the value wasn't a quoted string, so use it as-is.
if unquoted, err := strconv.Unquote(val); err == nil {
val = unquoted
}
cols[name] = val
}
result[i] = cols
}
return result, nil
}
func (ovsif *ovsExec) FindOne(table, column, condition string) ([]string, error) {
fullResult, err := ovsif.Find(table, []string{column}, condition)
if err != nil {
return nil, err
}
result := make([]string, 0, len(fullResult))
for _, row := range fullResult {
result = append(result, row[column])
}
return result, nil
}
func (ovsif *ovsExec) Clear(table, record string, columns ...string) error {
if err := validateColumns(columns...); err != nil {
return err
}
args := append([]string{"--if-exists", "clear", table, record}, columns...)
_, err := ovsif.exec(OVS_VSCTL, args...)
return err
}
func (ovsif *ovsExec) DumpFlows(flow string, args ...interface{}) ([]string, error) {
if len(args) > 0 {
flow = fmt.Sprintf(flow, args...)
}
out, err := ovsif.exec(OVS_OFCTL, "dump-flows", ovsif.bridge, flow)
if err != nil {
return nil, err
}
lines := strings.Split(out, "\n")
flows := make([]string, 0, len(lines))
for _, line := range lines {
if strings.Contains(line, "cookie=") {
flows = append(flows, line)
}
}
return flows, nil
}
func (ovsif *ovsExec) NewTransaction() Transaction {
return &ovsExecTx{ovsif: ovsif, flows: []string{}}
}
// bundle executes all given flows as a single atomic transaction
func (ovsif *ovsExec) bundle(flows []string) error {
if len(flows) == 0 {
return nil
}
_, err := ovsif.execWithStdin(OVS_OFCTL, flows, "bundle", ovsif.bridge, "-")
return err
}
// ovsExecTx implements ovs.Transaction and maintains current flow context
type ovsExecTx struct {
ovsif *ovsExec
flows []string
}
func (tx *ovsExecTx) AddFlow(flow string, args ...interface{}) {
if len(args) > 0 {
flow = fmt.Sprintf(flow, args...)
}
tx.flows = append(tx.flows, fmt.Sprintf("flow add %s", flow))
}
func (tx *ovsExecTx) DeleteFlows(flow string, args ...interface{}) {
if len(args) > 0 {
flow = fmt.Sprintf(flow, args...)
}
tx.flows = append(tx.flows, fmt.Sprintf("flow delete %s", flow))
}
func (tx *ovsExecTx) Commit() error {
err := tx.ovsif.bundle(tx.flows)
// Reset flow context
tx.flows = []string{}
return err
}