forked from ligato/vpp-agent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vrf_table.go
147 lines (127 loc) · 4.44 KB
/
vrf_table.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
// Copyright (c) 2018 Cisco and/or its affiliates.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package descriptor
import (
"fmt"
"strings"
"github.com/pkg/errors"
"github.com/ligato/cn-infra/logging"
l3 "github.com/ligato/vpp-agent/api/models/vpp/l3"
kvs "github.com/ligato/vpp-agent/plugins/kvscheduler/api"
"github.com/ligato/vpp-agent/plugins/vpp/l3plugin/descriptor/adapter"
"github.com/ligato/vpp-agent/plugins/vpp/l3plugin/vppcalls"
)
const (
// VrfTableDescriptorName is the name of the descriptor for VRF tables.
VrfTableDescriptorName = "vpp-vrf-table"
// how many characters a VRF table label is allowed to have
// - determined by much fits into the binary API (64 null-terminated character string)
labelLengthLimit = 63
)
// A list of non-retriable errors:
var (
// ErrVrfTableLabelTooLong is returned when VRF table label exceeds the length limit.
ErrVrfTableLabelTooLong = errors.New("VPP VRF table label exceeds the length limit (63 characters)")
)
// VrfTableDescriptor teaches KVScheduler how to configure VPP VRF tables.
type VrfTableDescriptor struct {
log logging.Logger
vtHandler vppcalls.VrfTableVppAPI
}
// NewVrfTableDescriptor creates a new instance of the VrfTable descriptor.
func NewVrfTableDescriptor(
vtHandler vppcalls.VrfTableVppAPI, log logging.PluginLogger) *kvs.KVDescriptor {
ctx := &VrfTableDescriptor{
vtHandler: vtHandler,
log: log.NewLogger("vrf-table-descriptor"),
}
typedDescr := &adapter.VrfTableDescriptor{
Name: VrfTableDescriptorName,
NBKeyPrefix: l3.ModelVrfTable.KeyPrefix(),
ValueTypeName: l3.ModelVrfTable.ProtoName(),
KeySelector: l3.ModelVrfTable.IsKeyValid,
KeyLabel: l3.ModelVrfTable.StripKeyPrefix,
ValueComparator: ctx.EquivalentVrfTables,
Validate: ctx.Validate,
Create: ctx.Create,
Delete: ctx.Delete,
Retrieve: ctx.Retrieve,
}
return adapter.NewVrfTableDescriptor(typedDescr)
}
// EquivalentVrfTables is a comparison function for l3.VrfTable.
func (d *VrfTableDescriptor) EquivalentVrfTables(key string, oldVrfTable, newVrfTable *l3.VrfTable) bool {
if getVrfTableLabel(oldVrfTable) != getVrfTableLabel(newVrfTable) {
return false
}
return true
}
// Validate validates configuration of VPP VRF table.
func (d *VrfTableDescriptor) Validate(key string, vrfTable *l3.VrfTable) (err error) {
if len(vrfTable.Label) > labelLengthLimit {
return kvs.NewInvalidValueError(ErrVrfTableLabelTooLong, "label")
}
return nil
}
// Create adds VPP VRF table.
func (d *VrfTableDescriptor) Create(key string, vrfTable *l3.VrfTable) (metadata interface{}, err error) {
if vrfTable.Id == 0 {
// nothing to do, automatically created by VPP
}
err = d.vtHandler.AddVrfTable(vrfTable)
if err != nil {
return nil, err
}
return nil, nil
}
// Delete removes VPP VRF table.
func (d *VrfTableDescriptor) Delete(key string, vrfTable *l3.VrfTable, metadata interface{}) error {
if vrfTable.Id == 0 {
// nothing to do, VRF ID=0 always exists
}
err := d.vtHandler.DelVrfTable(vrfTable)
if err != nil {
return err
}
return nil
}
// Retrieve returns all configured VPP VRF tables.
func (d *VrfTableDescriptor) Retrieve(correlate []adapter.VrfTableKVWithMetadata) (
retrieved []adapter.VrfTableKVWithMetadata, err error,
) {
tables, err := d.vtHandler.DumpVrfTables()
if err != nil {
return nil, errors.Errorf("failed to dump VPP VRF tables: %v", err)
}
for _, table := range tables {
origin := kvs.UnknownOrigin
if table.Id > 0 {
origin = kvs.FromNB
}
retrieved = append(retrieved, adapter.VrfTableKVWithMetadata{
Key: l3.VrfTableKey(table.Id, table.Protocol),
Value: table,
Origin: origin,
})
}
return retrieved, nil
}
func getVrfTableLabel(vrfTable *l3.VrfTable) string {
if vrfTable.Label == "" {
// label generated by VPP (e.g. "ipv4-VRF:0")
return fmt.Sprintf("%s-VRF:%d",
strings.ToLower(vrfTable.Protocol.String()), vrfTable.Id)
}
return vrfTable.Label
}