/
span.go
209 lines (184 loc) · 6.24 KB
/
span.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
// Copyright (c) 2019 PANTHEON.tech
//
// 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 (
"github.com/go-errors/errors"
"github.com/ligato/cn-infra/logging"
interfaces "github.com/ligato/vpp-agent/api/models/vpp/interfaces"
kvs "github.com/ligato/vpp-agent/plugins/kvscheduler/api"
"github.com/ligato/vpp-agent/plugins/vpp/ifplugin/descriptor/adapter"
"github.com/ligato/vpp-agent/plugins/vpp/ifplugin/ifaceidx"
"github.com/ligato/vpp-agent/plugins/vpp/ifplugin/vppcalls"
)
const (
// SpanDescriptorName is the name of the descriptor.
SpanDescriptorName = "vpp-span"
)
// A list of non-retriable errors:
var (
ErrSpanWithoutInterface = errors.New("VPP SPAN defined without From/To interface")
ErrSpanWithoutDirection = errors.New("VPP SPAN defined without direction (Rx, Tx or Both)")
)
// SpanDescriptor teaches KVScheduler how to configure VPP SPAN.
type SpanDescriptor struct {
log logging.Logger
spanHandler vppcalls.InterfaceVppAPI
intfIndex ifaceidx.IfaceMetadataIndex
}
// NewSpanDescriptor creates a new instance of the SpanDescriptor.
func NewSpanDescriptor(spanHandler vppcalls.InterfaceVppAPI, log logging.PluginLogger) (*kvs.KVDescriptor, *SpanDescriptor) {
ctx := &SpanDescriptor{
spanHandler: spanHandler,
log: log.NewLogger("span-descriptor"),
}
typedDescr := &adapter.SpanDescriptor{
Name: SpanDescriptorName,
KeySelector: interfaces.ModelSpan.IsKeyValid,
KeyLabel: interfaces.ModelSpan.StripKeyPrefix,
NBKeyPrefix: interfaces.ModelSpan.KeyPrefix(),
ValueTypeName: interfaces.ModelSpan.ProtoName(),
Create: ctx.Create,
Delete: ctx.Delete,
Retrieve: ctx.Retrieve,
Validate: ctx.Validate,
Dependencies: ctx.Dependencies,
RetrieveDependencies: []string{InterfaceDescriptorName},
}
return adapter.NewSpanDescriptor(typedDescr), ctx
}
// SetInterfaceIndex should be used to provide interface index immediately after
// the descriptor registration.
func (d *SpanDescriptor) SetInterfaceIndex(intfIndex ifaceidx.IfaceMetadataIndex) {
d.intfIndex = intfIndex
}
// Validate checks if required filed are not empty.
func (d *SpanDescriptor) Validate(key string, value *interfaces.Span) error {
if value.InterfaceFrom == "" && value.InterfaceTo == "" {
return kvs.NewInvalidValueError(ErrSpanWithoutInterface,
"interface_from", "interface_to")
}
if value.InterfaceFrom == "" {
return kvs.NewInvalidValueError(ErrSpanWithoutInterface, "interface_from")
}
if value.InterfaceTo == "" {
return kvs.NewInvalidValueError(ErrSpanWithoutInterface, "interface_to")
}
if value.Direction == interfaces.Span_UNKNOWN {
return kvs.NewInvalidValueError(ErrSpanWithoutDirection, "direction")
}
return nil
}
// Create configures SPAN.
func (d *SpanDescriptor) Create(key string, value *interfaces.Span) (metadata interface{}, err error) {
ifaceFrom, found := d.intfIndex.LookupByName(value.InterfaceFrom)
if !found {
err = errors.Errorf("failed to find InterfaceFrom %s", value.InterfaceFrom)
d.log.Error(err)
return nil, err
}
ifaceTo, found := d.intfIndex.LookupByName(value.InterfaceTo)
if !found {
err = errors.Errorf("failed to find InterfaceTo %s", value.InterfaceTo)
d.log.Error(err)
return nil, err
}
var isL2 uint8
if value.IsL2 {
isL2 = 1
}
err = d.spanHandler.AddSpan(ifaceFrom.SwIfIndex, ifaceTo.SwIfIndex, uint8(value.Direction), isL2)
if err != nil {
err = errors.Errorf("failed to add interface span: %v", err)
d.log.Error(err)
return nil, err
}
return nil, err
}
// Delete removes SPAN.
func (d *SpanDescriptor) Delete(key string, value *interfaces.Span, metadata interface{}) error {
var err error
ifaceFrom, found := d.intfIndex.LookupByName(value.InterfaceFrom)
if !found {
err = errors.Errorf("failed to find InterfaceFrom %s", value.InterfaceFrom)
d.log.Error(err)
return err
}
ifaceTo, found := d.intfIndex.LookupByName(value.InterfaceTo)
if !found {
err = errors.Errorf("failed to find InterfaceTo %s", value.InterfaceTo)
d.log.Error(err)
return err
}
var isL2 uint8
if value.IsL2 {
isL2 = 1
}
err = d.spanHandler.DelSpan(ifaceFrom.SwIfIndex, ifaceTo.SwIfIndex, isL2)
if err != nil {
err = errors.Errorf("failed to delete interface span: %v", err)
d.log.Error(err)
return err
}
return err
}
// Retrieve returns all records from VPP SPAN table.
func (d *SpanDescriptor) Retrieve(correlate []adapter.SpanKVWithMetadata) (retrieved []adapter.SpanKVWithMetadata, err error) {
spans, err := d.spanHandler.DumpSpan()
if err != nil {
d.log.Error(err)
return retrieved, err
}
var nameFrom, nameTo string
var exists bool
for _, s := range spans {
nameFrom, _, exists = d.intfIndex.LookupBySwIfIndex(s.SwIfIndexFrom)
if !exists {
d.log.Debugf("failed to find interface with index %d", s.SwIfIndexFrom)
continue
}
nameTo, _, exists = d.intfIndex.LookupBySwIfIndex(s.SwIfIndexTo)
if !exists {
d.log.Debugf("failed to find interface with index %d", s.SwIfIndexTo)
continue
}
var isL2 bool
if s.IsL2 == 1 {
isL2 = true
}
retrieved = append(retrieved, adapter.SpanKVWithMetadata{
Key: interfaces.SpanKey(nameFrom, nameTo),
Value: &interfaces.Span{
InterfaceFrom: nameFrom,
InterfaceTo: nameTo,
Direction: interfaces.Span_Direction(s.Direction),
IsL2: isL2,
},
Origin: kvs.FromNB,
})
}
return retrieved, nil
}
// Dependencies lists both From and To interfaces as dependencies.
func (d *SpanDescriptor) Dependencies(key string, value *interfaces.Span) []kvs.Dependency {
return []kvs.Dependency{
{
Label: "interface-from",
Key: interfaces.InterfaceKey(value.InterfaceFrom),
},
{
Label: "interface-to",
Key: interfaces.InterfaceKey(value.InterfaceTo),
},
}
}