Debian Codegraph @

networking_bagpipe/bagpipe_bgp/common/dataplane_utils.py

raw
1 # Copyright 2018 Orange
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 import abc
16 import collections
17
18 from oslo_log import log as logging
19
20 from networking_bagpipe._i18n import _
21 from networking_bagpipe.bagpipe_bgp.common import log_decorator
22
23 from neutron.agent.common import ovs_lib
24
25 from neutron_lib import exceptions
26 from neutron_lib.plugins.ml2 import ovs_constants as ovs_const
27
28 LOG = logging.getLogger(__name__)
29
30
31 # largely copied from networking_sfc.services.sfc.common.ovs_ext_lib
32 class OVSBridgeWithGroups:
33
34 def __init__(self, ovs_bridge):
35 self.bridge = ovs_bridge
36
37 # OpenFlow 1.1 is needed to manipulate groups
38 self.bridge.use_at_least_protocol(ovs_const.OPENFLOW11)
39
40 # proxy most methods to self.bridge
41 def __getattr__(self, name):
42 return getattr(self.bridge, name)
43
44 def do_action_groups(self, action, kwargs_list):
45 group_strs = [_build_group_expr_str(kw, action) for kw in kwargs_list]
46 options = ['-']
47 if action == 'add' or action == 'del':
48 cmd = '%s-groups' % action
49 elif action == 'mod':
50 cmd = '%s-group' % action
51 options.insert(0, '--may-create')
52 elif action == 'insert-buckets' or action == 'remove-buckets':
53 cmd = action
54 else:
55 msg = _("Action is illegal")
56 raise exceptions.InvalidInput(error_message=msg)
57
58 if action == 'del' and {} in kwargs_list:
59 self.run_ofctl(cmd, [])
60 else:
61 self.run_ofctl(cmd, options, '\n'.join(group_strs))
62
63 @log_decorator.log_info
64 def add_group(self, **kwargs):
65 self.do_action_groups('add', [kwargs])
66
67 @log_decorator.log_info
68 def mod_group(self, **kwargs):
69 self.do_action_groups('mod', [kwargs])
70
71 @log_decorator.log_info
72 def delete_group(self, **kwargs):
73 self.do_action_groups('del', [kwargs])
74
75 @log_decorator.log_info
76 def insert_bucket(self, **kwargs):
77 self.do_action_groups('insert-buckets', [kwargs])
78
79 @log_decorator.log_info
80 def remove_bucket(self, **kwargs):
81 self.do_action_groups('remove-buckets', [kwargs])
82
83 def dump_group_for_id(self, group_id):
84 retval = None
85 group_str = "%d" % group_id
86 group = self.run_ofctl("dump-groups", [group_str])
87 if group:
88 retval = '\n'.join(item for item in group.splitlines()
89 if ovs_lib.is_a_flow_line(item))
90 return retval
91
92 def get_bridge_ports(self):
93 port_name_list = self.bridge.get_port_name_list()
94 of_portno_list = list()
95 for port_name in port_name_list:
96 of_portno_list.append(self.bridge.get_port_ofport(port_name))
97 return of_portno_list
98
99
100 def _build_group_expr_str(group_dict, cmd):
101 group_expr_arr = []
102 buckets = None
103 group_id = None
104
105 if cmd != 'del':
106 if "group_id" not in group_dict:
107 msg = _("Must specify one group Id on group addition"
108 " or modification")
109 raise exceptions.InvalidInput(error_message=msg)
110 group_id = "group_id=%s" % group_dict.pop('group_id')
111
112 if cmd != 'remove-buckets':
113 if "buckets" not in group_dict:
114 msg = _("Must specify one or more buckets on group addition/"
115 "modification or buckets insertion/deletion")
116 raise exceptions.InvalidInput(error_message=msg)
117 buckets = "%s" % group_dict.pop('buckets')
118
119 if group_id:
120 group_expr_arr.append(group_id)
121
122 for key, value in group_dict.items():
123 group_expr_arr.append("{}={}".format(key, value))
124
125 if buckets:
126 group_expr_arr.append(buckets)
127
128 return ','.join(group_expr_arr)
129
130
131 class OVSExtendedBridge(ovs_lib.OVSBridge):
132
133 def add_flow_extended(self, flow_matches=None, actions=None):
134 if flow_matches is None:
135 flow_matches = []
136 if actions is None:
137 actions = []
138 flow_args = {}
139 for match in flow_matches:
140 flow_args.update(match)
141
142 if actions:
143 flow_args["actions"] = join_s(*actions)
144
145 self.add_flow(**flow_args)
146
147 def delete_flows_extended(self, flow_matches=None):
148 if flow_matches is None:
149 flow_matches = []
150 flow_args = {}
151 for match in flow_matches:
152 flow_args.update(match)
153
154 self.delete_flows(**flow_args)
155
156
157 def join_s(*args):
158 return ','.join([_f for _f in args if _f])
159
160
161 class ObjectLifecycleManager:
162
163 def __init__(self):
164 self.objects = dict()
165 self.object_used_for = collections.defaultdict(set)
166
167 @log_decorator.log_info
168 def is_object_user(self, object_key, user_key):
169 return (object_key in self.objects and
170 user_key in self.object_used_for[object_key])
171
172 @abc.abstractmethod
173 def create_object(self, object_key, *args, **kwargs):
174 pass
175
176 @abc.abstractmethod
177 def delete_object(self, object):
178 pass
179
180 @log_decorator.log_info
181 def get_object(self, object_key, user_key, *args, **kwargs):
182 obj = self.find_object(object_key)
183 if obj is None:
184 obj = self.create_object(object_key, *args, **kwargs)
185 self.objects[object_key] = obj
186 LOG.debug("object for %s: %s", object_key, obj)
187
188 first = not self.object_used_for[object_key]
189 self.object_used_for[object_key].add(user_key)
190
191 if first:
192 LOG.debug("%s is first user for %s", user_key, object_key)
193
194 return (obj, first)
195
196 @log_decorator.log_info
197 def find_object(self, object_key):
198 obj = self.objects.get(object_key)
199 if obj is not None:
200 LOG.debug("existing object for %s: %s", object_key, obj)
201
202 return obj
203
204 @log_decorator.log_info
205 def free_object(self, object_key, user_key):
206 if object_key not in self.object_used_for:
207 LOG.debug("no object to free for %s", object_key)
208 return
209
210 self.object_used_for[object_key].discard(user_key)
211
212 last = not self.object_used_for[object_key]
213 if last:
214 obj = self.objects[object_key]
215
216 LOG.debug("%s was last user for %s, clearing", user_key,
217 object_key)
218 self.delete_object(obj)
219
220 del self.objects[object_key]
221 del self.object_used_for[object_key]
222 else:
223 LOG.debug("remaining users for object %s: %s", object_key,
224 self.object_used_for[object_key])
225
226 return last
227
228 @log_decorator.log_info
229 def clear_objects(self, filter_method):
230 for object_key, users in list(self.object_used_for.items()):
231 for user in users:
232 if filter_method(object_key, user):
233 self.delete_object(self.objects[object_key])
234 del self.objects[object_key]
235 del self.object_used_for[object_key]
236 break
237
238 def infos(self):
239 return self.objects
240
241
242 class ObjectLifecycleManagerProxy:
243
244 def __init__(self, manager, parent_user):
245 self.manager = manager
246 self.parent_user = parent_user
247
248 def _object_key(self, object_key):
249 return (self.parent_user, object_key)
250
251 def is_object_user(self, object_key, user_key):
252 return self.manager.is_object_user(self._object_key(object_key),
253 (self.parent_user, user_key))
254
255 def get_object(self, object_key, user_key, *args, **kwargs):
256 return self.manager.get_object(self._object_key(object_key),
257 (self.parent_user, user_key),
258 *args, **kwargs)
259
260 def find_object(self, object_key):
261 return self.manager.find_object(self._object_key(object_key))
262
263 def free_object(self, object_key, user_key):
264 if user_key:
265 return self.manager.free_object(self._object_key(object_key),
266 (self.parent_user, user_key))
267
268 def clear_objects(self, filter_method=lambda obj_key, user_key: True):
269 self.manager.clear_objects(
270 lambda obj_key, user_key: (user_key[0] == self.parent_user and
271 filter_method(obj_key, user_key[1]))
272 )
273
274 def infos(self):
275 return self.manager.infos()
276
277
278 class SharedObjectLifecycleManagerProxy(ObjectLifecycleManagerProxy):
279
280 def _object_key(self, object_key):
281 return object_key