forked from projectcalico/felix
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rule_scanner.go
314 lines (272 loc) · 10.1 KB
/
rule_scanner.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
// Copyright (c) 2016-2017 Tigera, Inc. All rights reserved.
//
// 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 calc
import (
log "github.com/Sirupsen/logrus"
"fmt"
"github.com/projectcalico/felix/multidict"
"github.com/projectcalico/felix/set"
"github.com/projectcalico/libcalico-go/lib/backend/model"
"github.com/projectcalico/libcalico-go/lib/net"
"github.com/projectcalico/libcalico-go/lib/numorstring"
"github.com/projectcalico/libcalico-go/lib/selector"
)
// RuleScanner scans the rules sent to it by the ActiveRulesCalculator, looking for tags and
// selectors. It calculates the set of active tags and selectors and emits events when they become
// active/inactive.
//
// Previously, Felix tracked tags and selectors separately, with a separate tag and label index.
// However, we found that had a high occupancy cost. The current code uses a shared index and
// maps tags onto labels, so a tag named tagName, becomes a label tagName="". The RuleScanner
// maps tags to label selectors of the form "has(tagName)", taking advantage of the mapping.
// Such a selector is almost equivalent to having the tag; the only case where the behaviour would
// differ is if the user was using the same name for a tag and a label and the label and tags
// of the same name were applied to different endpoints. Since tags are being deprecated, we can
// live with that potential aliasing issue in return for a significant occupancy improvement at
// high scale.
//
// The RuleScanner also emits events when rules are updated: since the input rule
// structs contain tags and selectors but downstream, we only care about IP sets, the
// RuleScanner converts rules from model.Rule objects to calc.ParsedRule objects.
// The latter share most fields, but the tags and selector fields are replaced by lists of
// IP sets.
//
// The RuleScanner only calculates which selectors and tags are active/inactive. It doesn't
// match endpoints against tags/selectors. (That is done downstream in a labelindex.InheritIndex
// created in NewCalculationGraph.)
type RuleScanner struct {
// selectorsByUID maps from the selector's hash back to the selector.
selectorsByUID map[string]selector.Selector
// activeUidsByResource maps from policy or profile ID to "set" of selector UIDs
rulesIDToUIDs multidict.IfaceToString
// activeResourcesByUid maps from selector UID back to the "set" of resources using it.
uidsToRulesIDs multidict.StringToIface
OnSelectorActive func(selector selector.Selector)
OnSelectorInactive func(selector selector.Selector)
RulesUpdateCallbacks rulesUpdateCallbacks
}
func NewRuleScanner() *RuleScanner {
calc := &RuleScanner{
selectorsByUID: make(map[string]selector.Selector),
rulesIDToUIDs: multidict.NewIfaceToString(),
uidsToRulesIDs: multidict.NewStringToIface(),
}
return calc
}
func (rs *RuleScanner) OnProfileActive(key model.ProfileRulesKey, profile *model.ProfileRules) {
parsedRules := rs.updateRules(key, profile.InboundRules, profile.OutboundRules, false)
rs.RulesUpdateCallbacks.OnProfileActive(key, parsedRules)
}
func (rs *RuleScanner) OnProfileInactive(key model.ProfileRulesKey) {
rs.updateRules(key, nil, nil, false)
rs.RulesUpdateCallbacks.OnProfileInactive(key)
}
func (rs *RuleScanner) OnPolicyActive(key model.PolicyKey, policy *model.Policy) {
parsedRules := rs.updateRules(key, policy.InboundRules, policy.OutboundRules, policy.DoNotTrack)
rs.RulesUpdateCallbacks.OnPolicyActive(key, parsedRules)
}
func (rs *RuleScanner) OnPolicyInactive(key model.PolicyKey) {
rs.updateRules(key, nil, nil, false)
rs.RulesUpdateCallbacks.OnPolicyInactive(key)
}
func (rs *RuleScanner) updateRules(key interface{}, inbound, outbound []model.Rule, untracked bool) (parsedRules *ParsedRules) {
log.Debugf("Scanning rules (%v in, %v out) for key %v",
len(inbound), len(outbound), key)
// Extract all the new selectors/tags.
currentUIDToSel := make(map[string]selector.Selector)
parsedInbound := make([]*ParsedRule, len(inbound))
for ii, rule := range inbound {
parsed, allSels := ruleToParsedRule(&rule)
parsedInbound[ii] = parsed
for _, sel := range allSels {
currentUIDToSel[sel.UniqueId()] = sel
}
}
parsedOutbound := make([]*ParsedRule, len(outbound))
for ii, rule := range outbound {
parsed, allSels := ruleToParsedRule(&rule)
parsedOutbound[ii] = parsed
for _, sel := range allSels {
currentUIDToSel[sel.UniqueId()] = sel
}
}
parsedRules = &ParsedRules{
InboundRules: parsedInbound,
OutboundRules: parsedOutbound,
Untracked: untracked,
}
// Figure out which selectors/tags are new.
addedUids := set.New()
for uid := range currentUIDToSel {
log.Debugf("Checking if UID %v is new.", uid)
if !rs.rulesIDToUIDs.Contains(key, uid) {
log.Debugf("UID %v is new", uid)
addedUids.Add(uid)
}
}
// Figure out which selectors/tags are no-longer in use.
removedUids := set.New()
rs.rulesIDToUIDs.Iter(key, func(uid string) {
if _, ok := currentUIDToSel[uid]; !ok {
log.Debugf("Removed UID: %v", uid)
removedUids.Add(uid)
}
})
// Add the new into the index, triggering events as we discover
// newly-active tags/selectors.
addedUids.Iter(func(item interface{}) error {
uid := item.(string)
rs.rulesIDToUIDs.Put(key, uid)
if !rs.uidsToRulesIDs.ContainsKey(uid) {
sel := currentUIDToSel[uid]
rs.selectorsByUID[uid] = sel
log.Debugf("Selector became active: %v -> %v",
uid, sel)
// This selector just became active, trigger event.
rs.OnSelectorActive(sel)
}
rs.uidsToRulesIDs.Put(uid, key)
return nil
})
// And remove the old, triggering events as we clean up unused
// selectors/tags.
removedUids.Iter(func(item interface{}) error {
uid := item.(string)
rs.rulesIDToUIDs.Discard(key, uid)
rs.uidsToRulesIDs.Discard(uid, key)
if !rs.uidsToRulesIDs.ContainsKey(uid) {
log.Debugf("Selector/tag became inactive: %v", uid)
sel := rs.selectorsByUID[uid]
delete(rs.selectorsByUID, uid)
// This selector just became inactive, trigger event.
log.Debugf("Selector became inactive: %v -> %v",
uid, sel)
rs.OnSelectorInactive(sel)
}
return nil
})
return
}
type ParsedRules struct {
InboundRules []*ParsedRule
OutboundRules []*ParsedRule
// Untracked is true if these rules should not be "conntracked".
Untracked bool
}
// Rule is like a backend.model.Rule, except the tag and selector matches are
// replaced with pre-calculated ipset IDs.
type ParsedRule struct {
Action string
IPVersion *int
Protocol *numorstring.Protocol
SrcNet *net.IPNet
SrcPorts []numorstring.Port
DstNet *net.IPNet
DstPorts []numorstring.Port
ICMPType *int
ICMPCode *int
SrcIPSetIDs []string
DstIPSetIDs []string
NotProtocol *numorstring.Protocol
NotSrcNet *net.IPNet
NotSrcPorts []numorstring.Port
NotDstNet *net.IPNet
NotDstPorts []numorstring.Port
NotICMPType *int
NotICMPCode *int
NotSrcIPSetIDs []string
NotDstIPSetIDs []string
}
func ruleToParsedRule(rule *model.Rule) (parsedRule *ParsedRule, allTagOrSels []selector.Selector) {
src, dst, notSrc, notDst := extractTagsAndSelectors(rule)
parsedRule = &ParsedRule{
Action: rule.Action,
IPVersion: rule.IPVersion,
Protocol: rule.Protocol,
SrcNet: rule.SrcNet,
SrcPorts: rule.SrcPorts,
DstNet: rule.DstNet,
DstPorts: rule.DstPorts,
ICMPType: rule.ICMPType,
ICMPCode: rule.ICMPCode,
SrcIPSetIDs: selectors(src).ToUIDs(),
DstIPSetIDs: selectors(dst).ToUIDs(),
NotProtocol: rule.NotProtocol,
NotSrcNet: rule.NotSrcNet,
NotSrcPorts: rule.NotSrcPorts,
NotDstNet: rule.NotDstNet,
NotDstPorts: rule.NotDstPorts,
NotICMPType: rule.NotICMPType,
NotICMPCode: rule.NotICMPCode,
NotSrcIPSetIDs: selectors(notSrc).ToUIDs(),
NotDstIPSetIDs: selectors(notDst).ToUIDs(),
}
allTagOrSels = append(allTagOrSels, src...)
allTagOrSels = append(allTagOrSels, dst...)
allTagOrSels = append(allTagOrSels, notSrc...)
allTagOrSels = append(allTagOrSels, notDst...)
return
}
func extractTagsAndSelectors(rule *model.Rule) (src, dst, notSrc, notDst []selector.Selector) {
appendTagSelector := func(slice []selector.Selector, tagName string) []selector.Selector {
if tagName == "" {
return slice
}
sel, err := selFromTag(tagName)
if err != nil {
// This shouldn't happen because the data should have been validated
// further back in the pipeline.
log.WithField("tag", tagName).Panic(
"Failed to convert tag to selector; but tag should have been " +
"validated already.")
}
return append(slice, sel)
}
appendSelector := func(slice []selector.Selector, rawSelector string) []selector.Selector {
if rawSelector == "" {
return slice
}
sel, err := selector.Parse(rawSelector)
if err != nil {
// This shouldn't happen because the data should have been validated
// further back in the pipeline.
log.WithField("selector", rawSelector).Panic(
"Failed to parse selector that should have been validated already.")
}
return append(slice, sel)
}
src = appendTagSelector(src, rule.SrcTag)
src = appendSelector(src, rule.SrcSelector)
dst = appendTagSelector(dst, rule.DstTag)
dst = appendSelector(dst, rule.DstSelector)
notSrc = appendTagSelector(notSrc, rule.NotSrcTag)
notSrc = appendSelector(notSrc, rule.NotSrcSelector)
notDst = appendTagSelector(notDst, rule.NotDstTag)
notDst = appendSelector(notDst, rule.NotDstSelector)
return
}
func selFromTag(tag string) (selector.Selector, error) {
return selector.Parse(fmt.Sprintf("has(%s)", tag))
}
type selectors []selector.Selector
func (ss selectors) ToUIDs() []string {
if len(ss) == 0 {
return nil
}
uids := make([]string, len(ss))
for i, sel := range ss {
uids[i] = sel.UniqueId()
}
return uids
}