Bug 8228 - metadata service fix made cleaner
[groupbasedpolicy.git] / neutron-vpp-mapper / src / main / java / org / opendaylight / groupbasedpolicy / neutron / vpp / mapper / processors / PortHandler.java
1 /*\r
2  * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.\r
3  *\r
4  * This program and the accompanying materials are made available under the\r
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
7  */\r
8 \r
9 package org.opendaylight.groupbasedpolicy.neutron.vpp.mapper.processors;\r
10 \r
11 import java.util.Collections;\r
12 import java.util.List;\r
13 \r
14 import javax.annotation.Nonnull;\r
15 import javax.annotation.Nullable;\r
16 \r
17 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;\r
18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;\r
19 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;\r
20 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;\r
21 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;\r
22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;\r
23 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;\r
24 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;\r
25 import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;\r
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;\r
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;\r
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;\r
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;\r
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.UniqueId;\r
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.Mappings;\r
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.mappings.GbpByNeutronMappings;\r
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.mappings.gbp.by.neutron.mappings.BaseEndpointsByPorts;\r
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.mappings.gbp.by.neutron.mappings.base.endpoints.by.ports.BaseEndpointByPort;\r
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.mappings.gbp.by.neutron.mappings.base.endpoints.by.ports.BaseEndpointByPortKey;\r
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.Config;\r
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.ExcludeFromPolicy;\r
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.ExcludeFromPolicyBuilder;\r
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes._interface.type.choice.LoopbackCase;\r
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes._interface.type.choice.LoopbackCaseBuilder;\r
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes._interface.type.choice.TapCase;\r
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes._interface.type.choice.TapCaseBuilder;\r
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes._interface.type.choice.VhostUserCaseBuilder;\r
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.VppEndpoint;\r
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.VppEndpointBuilder;\r
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.VppEndpointKey;\r
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.binding.rev150712.PortBindingExtension;\r
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.binding.rev150712.binding.attributes.VifDetails;\r
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;\r
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;\r
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;\r
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;\r
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;\r
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;\r
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;\r
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;\r
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;\r
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;\r
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;\r
60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;\r
61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;\r
62 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;\r
63 import org.slf4j.Logger;\r
64 import org.slf4j.LoggerFactory;\r
65 \r
66 import com.google.common.annotations.VisibleForTesting;\r
67 import com.google.common.base.Optional;\r
68 import com.google.common.base.Strings;\r
69 public class PortHandler implements TransactionChainListener {\r
70 \r
71     private static final Logger LOG = LoggerFactory.getLogger(PortHandler.class);\r
72 \r
73     private static final String COMPUTE_OWNER = "compute";\r
74     private static final String DHCP_OWNER = "dhcp";\r
75     static final String ROUTER_OWNER = "network:router_interface";\r
76     private static final String[] SUPPORTED_DEVICE_OWNERS = {COMPUTE_OWNER, DHCP_OWNER, ROUTER_OWNER};\r
77     private static final String VHOST_USER = "vhostuser";\r
78     private static final String UNBOUND = "unbound";\r
79     private static final String VPP_INTERFACE_NAME_PREFIX = "neutron_port_";\r
80     private static final String TAP_PORT_NAME_PREFIX = "tap";\r
81     private static final String RT_PORT_NAME_PREFIX = "qr-";\r
82     private static final String VHOST_SOCKET_KEY = "vhostuser_socket";\r
83     static final String DEFAULT_NODE = "default";\r
84 \r
85     private final NodeId routingNode;\r
86     private BindingTransactionChain transactionChain;\r
87     private DataBroker dataBroker;\r
88 \r
89     PortHandler(DataBroker dataBroker, NodeId routingNodeId) {\r
90         this.dataBroker = dataBroker;\r
91         this.routingNode = routingNodeId;\r
92         transactionChain = this.dataBroker.createTransactionChain(this);\r
93     }\r
94 \r
95     void processCreated(Port port) {\r
96         ReadOnlyTransaction rTx = transactionChain.newReadOnlyTransaction();\r
97         Optional<BaseEndpointByPort> optBaseEpByPort = DataStoreHelper.readFromDs(LogicalDatastoreType.OPERATIONAL,\r
98                 createBaseEpByPortIid(port.getUuid()), rTx);\r
99         rTx.close();\r
100         if (!optBaseEpByPort.isPresent()) {\r
101             return;\r
102         }\r
103         processCreatedData(port, optBaseEpByPort.get());\r
104     }\r
105 \r
106     void processCreated(BaseEndpointByPort bebp) {\r
107         ReadOnlyTransaction rTx = transactionChain.newReadOnlyTransaction();\r
108         Optional<Port> optPort = DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION,\r
109                 createPortIid(bebp.getPortId()), rTx);\r
110         rTx.close();\r
111         if (!optPort.isPresent()) {\r
112             return;\r
113         }\r
114         processCreatedData(optPort.get(), bebp);\r
115     }\r
116 \r
117     @VisibleForTesting\r
118     void processCreatedData(Port port, BaseEndpointByPort bebp) {\r
119         if (isValidVhostUser(port)\r
120                 // this is a hack for vpp router port\r
121                 // Openstack does not send binding details yet\r
122                 || isValidVppRouterPort(port)) {\r
123             VppEndpoint vppEp = buildVppEndpoint(port, bebp);\r
124             if (vppEp == null) {\r
125                 LOG.warn("Cannot create vpp-endpoint from neutron port {}", port);\r
126                 return;\r
127             }\r
128             writeVppEndpoint(createVppEndpointIid(vppEp.getKey()), vppEp);\r
129             LOG.debug("Created vpp-endpoint {}", vppEp);\r
130         }\r
131     }\r
132 \r
133     private boolean isValidVhostUser(Port port) {\r
134         PortBindingExtension portBindingExt = port.getAugmentation(PortBindingExtension.class);\r
135         if (portBindingExt != null) {\r
136             String vifType = portBindingExt.getVifType();\r
137             String deviceOwner = port.getDeviceOwner();\r
138             if (vifType != null && deviceOwner != null) {\r
139                 if (vifType.contains(VHOST_USER)) {\r
140                     for (String supportedDeviceOwner : SUPPORTED_DEVICE_OWNERS) {\r
141                         if (deviceOwner.contains(supportedDeviceOwner)) {\r
142                             return true;\r
143                         }\r
144                     }\r
145                 }\r
146             }\r
147         }\r
148         return false;\r
149     }\r
150 \r
151     void processUpdated(Port original, Port delta) {\r
152         if (!isUpdateNeeded(original, delta)){\r
153             LOG.trace("Port update skipped, port didn`t change. before {}, after: {}" , original, delta);\r
154             return;\r
155         }\r
156 \r
157         LOG.trace("Updating port before: {}, after: {}" , original, delta);\r
158         if (isValidVhostUser(original)) {\r
159             ReadOnlyTransaction rTx = transactionChain.newReadOnlyTransaction();\r
160             Optional<BaseEndpointByPort> optBebp = DataStoreHelper.readFromDs(LogicalDatastoreType.OPERATIONAL,\r
161                     createBaseEpByPortIid(original.getUuid()), rTx);\r
162             rTx.close();\r
163             if (!optBebp.isPresent()) {\r
164                 return;\r
165             }\r
166             LOG.trace("Updating port - deleting old port {}" , optBebp.get().getPortId());\r
167             processDeleted(optBebp.get());\r
168         }\r
169         LOG.trace("Updating port - creating new port {}" , delta.getUuid());\r
170         processCreated(delta);\r
171     }\r
172 \r
173     private boolean isUpdateNeeded(final Port oldPort, final Port newPort) {\r
174         //TODO fix this to better support update of ports for VPP\r
175         final PortBindingExtension oldPortAugmentation = oldPort.getAugmentation(PortBindingExtension.class);\r
176         final PortBindingExtension newPortAugmentation = newPort.getAugmentation(PortBindingExtension.class);\r
177 \r
178         if (newPortAugmentation == null) {\r
179             LOG.trace("Port {} is no longer a vhost type port, updating port...");\r
180             return true;\r
181         }\r
182 \r
183         final String oldDeviceOwner = oldPort.getDeviceOwner();\r
184         final String oldVifType = oldPortAugmentation.getVifType();\r
185         final String newDeviceOwner = newPort.getDeviceOwner();\r
186         final String newVifType = newPortAugmentation.getVifType();\r
187 \r
188         // TODO potential bug here\r
189         // Temporary change for Openstack Mitaka: If old neutron-binding:vif-type is vhost, new one is unbound and\r
190         // device owner is ROUTER_OWNER, skip update. Openstack (or ml2) sometimes sends router update messages in\r
191         // incorrect order which causes unwanted port removal\r
192         if (oldVifType.equals(VHOST_USER) && newVifType.equals(UNBOUND) && oldDeviceOwner != null &&\r
193                 ROUTER_OWNER.equals(oldDeviceOwner) && ROUTER_OWNER.equals(newDeviceOwner)) {\r
194             LOG.warn("Port vif-type was updated from vhost to unbound. This update is currently disabled and will be skipped");\r
195             return false;\r
196         }\r
197 \r
198         if (newVifType != null && !newVifType.equals(oldVifType)) {\r
199             LOG.trace("Vif type changed, old: {} new {}", oldVifType, newVifType);\r
200             return true;\r
201         }\r
202 \r
203         final List<VifDetails> vifDetails = oldPortAugmentation.getVifDetails();\r
204 \r
205         if (!oldPortAugmentation.getHostId().equals(newPortAugmentation.getHostId()) ||\r
206             nullToEmpty(vifDetails).size() != nullToEmpty(newPortAugmentation.getVifDetails()).size()) {\r
207             return true;\r
208         }\r
209 \r
210         for (VifDetails vifDetail : nullToEmpty(vifDetails)) {\r
211             //check if vhostuser_socket, vhostuser_mode and port_filter are changed\r
212             if (!newPortAugmentation.getVifDetails().contains(vifDetail))\r
213                 return true;\r
214         }\r
215         return false;\r
216     }\r
217 \r
218     void processDeleted(BaseEndpointByPort bebp) {\r
219         LOG.trace("Deleting vpp-endpoint by BaseEndpointByPort {}" , bebp);\r
220         VppEndpointKey vppEpKey = new VppEndpointKey(bebp.getAddress(), bebp.getAddressType(), bebp.getContextId(),\r
221                 bebp.getContextType());\r
222         InstanceIdentifier<VppEndpoint> vppEpIid = createVppEndpointIid(vppEpKey);\r
223         ReadOnlyTransaction rTx = transactionChain.newReadOnlyTransaction();\r
224         Optional<VppEndpoint> readVppEp = DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION, vppEpIid, rTx);\r
225         rTx.close();\r
226         if (readVppEp.isPresent()) {\r
227             writeVppEndpoint(vppEpIid, null);\r
228             LOG.debug("Deleted vpp-endpoint {}", vppEpKey);\r
229         }\r
230     }\r
231 \r
232     private synchronized void writeVppEndpoint(InstanceIdentifier<VppEndpoint> vppEpIid, VppEndpoint vppEp) {\r
233         WriteTransaction wTx = transactionChain.newWriteOnlyTransaction();\r
234         if (vppEp != null) {\r
235             wTx.put(LogicalDatastoreType.CONFIGURATION, vppEpIid, vppEp, true);\r
236         } else {\r
237             wTx.delete(LogicalDatastoreType.CONFIGURATION, vppEpIid);\r
238         }\r
239         wTx.submit();\r
240     }\r
241 \r
242     @VisibleForTesting\r
243     VppEndpoint buildVppEndpoint(Port port, BaseEndpointByPort bebp) {\r
244         PortBindingExtension portBinding = port.getAugmentation(PortBindingExtension.class);\r
245         VppEndpointBuilder vppEpBuilder = new VppEndpointBuilder().setDescription("neutron port")\r
246             .setContextId(bebp.getContextId())\r
247             .setContextType(bebp.getContextType())\r
248             .setAddress(bebp.getAddress())\r
249             .setAddressType(bebp.getAddressType())\r
250             .setVppInterfaceName(VPP_INTERFACE_NAME_PREFIX + bebp.getPortId().getValue())\r
251             .setVppNodeId(new NodeId(portBinding.getHostId()));\r
252         if (port.getDeviceOwner().contains(COMPUTE_OWNER)) {\r
253             vppEpBuilder.setInterfaceTypeChoice(\r
254                 new VhostUserCaseBuilder().setSocket(getSocketFromPortBinding(portBinding)).build());\r
255         } else if (port.getDeviceOwner().contains(DHCP_OWNER) && port.getMacAddress() != null) {\r
256             TapCase tapCase = new TapCaseBuilder().setPhysicalAddress(new PhysAddress(port.getMacAddress().getValue()))\r
257                 .setName(createPortName(port.getUuid()))\r
258                 .build();\r
259             vppEpBuilder.setInterfaceTypeChoice(tapCase);\r
260         } else if (isValidQRouterPort(port)) {\r
261             TapCase tapCase = new TapCaseBuilder().setPhysicalAddress(new PhysAddress(port.getMacAddress().getValue()))\r
262                     .setName(createQRouterPortName(port.getUuid()))\r
263                     .build();\r
264             vppEpBuilder.setInterfaceTypeChoice(tapCase);\r
265             vppEpBuilder.addAugmentation(ExcludeFromPolicy.class,\r
266                     new ExcludeFromPolicyBuilder().setExcludeFromPolicy(true).build());\r
267         } else if (isValidVppRouterPort(port)) {\r
268             if (!DEFAULT_NODE.equals(routingNode.getValue())) {\r
269                 LOG.warn(\r
270                         "Host-id changed by ODL for port {}. This is a supplementary workaround for choosing a routing node.",\r
271                         port);\r
272                 vppEpBuilder.setVppNodeId(routingNode);\r
273             } else if (port.getDeviceId() != null) {\r
274                 LOG.debug("Resolving host-id for unbound router port {}", port.getUuid());\r
275                 ReadOnlyTransaction readTx = dataBroker.newReadOnlyTransaction();\r
276                 Optional<Ports> optPorts = DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION,\r
277                         InstanceIdentifier.builder(Neutron.class).child(Ports.class).build(), readTx);\r
278                 readTx.close();\r
279                 if (optPorts.isPresent() && optPorts.get().getPort() != null) {\r
280                     java.util.Optional<Port> optPortOnTheSameNode = optPorts.get()\r
281                         .getPort()\r
282                         .stream()\r
283                         .filter(p -> !p.getUuid().equals(port.getUuid()))\r
284                         .filter(p -> p.getAugmentation(PortBindingExtension.class) != null)\r
285                         .filter(p -> p.getDeviceOwner().contains(DHCP_OWNER))\r
286                         .findFirst();\r
287                     if (optPortOnTheSameNode.isPresent()) {\r
288                         PortBindingExtension binding =\r
289                                 optPortOnTheSameNode.get().getAugmentation(PortBindingExtension.class);\r
290                         if (binding != null && binding.getHostId() != null) {\r
291                             vppEpBuilder.setVppNodeId(new NodeId(binding.getHostId()));\r
292                         } else {\r
293                             LOG.warn("Cannot resolve location of router-port {}", port.getUuid());\r
294                             return null;\r
295                         }\r
296                     }\r
297                 }\r
298             }\r
299             vppEpBuilder.addAugmentation(ExcludeFromPolicy.class,\r
300                     new ExcludeFromPolicyBuilder().setExcludeFromPolicy(true).build());\r
301             vppEpBuilder.setInterfaceTypeChoice(getLoopbackCase(port));\r
302         }\r
303         return vppEpBuilder.build();\r
304     }\r
305 \r
306     private String getSocketFromPortBinding(@Nonnull PortBindingExtension portBindingExtension) {\r
307         List<VifDetails> vifDetails = nullToEmpty(portBindingExtension.getVifDetails());\r
308 \r
309         for (VifDetails detail : vifDetails) {\r
310             if (VHOST_SOCKET_KEY.equalsIgnoreCase(detail.getDetailsKey())) {\r
311                 return detail.getValue();\r
312             }\r
313         }\r
314         return null;\r
315     }\r
316 \r
317     private LoopbackCase getLoopbackCase(Port port) {\r
318         LoopbackCaseBuilder loopbackCase = new LoopbackCaseBuilder()\r
319             .setPhysAddress(new PhysAddress(port.getMacAddress().getValue()));\r
320         Optional<FixedIps> fixedIpsOptional = resolveFirstFixedIps(port);\r
321         if(fixedIpsOptional.isPresent() && fixedIpsOptional.get().getIpAddress() != null){\r
322             loopbackCase.setIpAddress(fixedIpsOptional.get().getIpAddress());\r
323             ReadOnlyTransaction rTx = transactionChain.newReadOnlyTransaction();\r
324             Optional<Subnet> subnetOptional =\r
325                 DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION,\r
326                     InstanceIdentifier.builder(Neutron.class)\r
327                         .child(Subnets.class)\r
328                         .child(Subnet.class, new SubnetKey(fixedIpsOptional.get().getSubnetId()))\r
329                         .build(), rTx);\r
330             if (subnetOptional.isPresent()) {\r
331                 Ipv4Prefix ipv4Prefix = subnetOptional.get().getCidr().getIpv4Prefix();\r
332                 loopbackCase.setIpPrefix(new IpPrefix(ipv4Prefix));\r
333             } else {\r
334                 LOG.warn("IpPrefix for loopback port: {} was not set.", port);\r
335             }\r
336             if (loopbackCase.getIpAddress() != null && loopbackCase.getIpPrefix() != null) {\r
337                 loopbackCase.setBvi(true);\r
338                 LOG.trace("Creating loopback BVI interface: {} for VPP router port: {}.", loopbackCase, port);\r
339             }\r
340 \r
341         } else {\r
342             LOG.warn("IpAddress for loopback port: {} was not set.", port);\r
343         }\r
344         return loopbackCase.build();\r
345     }\r
346 \r
347     /**\r
348      * If Qrouter (L3 Agent) is in use, any of Openstack neutron routers is not going be mapped\r
349      * to ODL neutron.\r
350      */\r
351     private boolean isValidQRouterPort(Port port) {\r
352         Optional<Router> optRouter = getRouterOptional(port);\r
353         return !optRouter.isPresent() && port.getDeviceOwner().contains(ROUTER_OWNER)\r
354                 && port.getMacAddress() != null;\r
355     }\r
356 \r
357     private boolean isValidVppRouterPort(Port port) {\r
358         Optional<Router> optRouter = getRouterOptional(port);\r
359         return optRouter.isPresent() && port.getDeviceOwner().contains(ROUTER_OWNER)\r
360             && port.getMacAddress() != null;\r
361     }\r
362 \r
363     private Optional<Router> getRouterOptional(Port port) {\r
364         if (Strings.isNullOrEmpty(port.getDeviceId())) {\r
365             return Optional.absent();\r
366         }\r
367         RouterKey routerKey = null;\r
368         try {\r
369             routerKey = new RouterKey(new Uuid(port.getDeviceId()));\r
370         } catch (IllegalArgumentException e) {\r
371             // port.getDeviceId() may not match Uuid.PATTERN_CONSTANTS\r
372             return Optional.absent();\r
373         }\r
374         ReadOnlyTransaction rTx = transactionChain.newReadOnlyTransaction();\r
375         InstanceIdentifier<Router> routerIid = InstanceIdentifier.builder(Neutron.class)\r
376             .child(Routers.class)\r
377             .child(Router.class, routerKey)\r
378             .build();\r
379         Optional<Router> optRouter = DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION, routerIid, rTx);\r
380         rTx.close();\r
381         return optRouter;\r
382     }\r
383 \r
384     public static Optional<FixedIps> resolveFirstFixedIps(Port port) {\r
385         List<FixedIps> fixedIps = port.getFixedIps();\r
386         if (fixedIps != null && !fixedIps.isEmpty()) {\r
387             return Optional.of(fixedIps.get(0));\r
388         }\r
389         return Optional.absent();\r
390     }\r
391 \r
392     private String createPortName(Uuid portUuid) {\r
393         String tapPortName;\r
394         String uuid = portUuid.getValue();\r
395         if (uuid != null && uuid.length() >= 12) {\r
396             tapPortName = TAP_PORT_NAME_PREFIX + uuid.substring(0, 11);\r
397         } else {\r
398             tapPortName = TAP_PORT_NAME_PREFIX + uuid;\r
399         }\r
400         return tapPortName;\r
401     }\r
402 \r
403     private String createQRouterPortName(Uuid portUuid) {\r
404         String tapPortName;\r
405         String uuid = portUuid.getValue();\r
406         if (uuid != null && uuid.length() >= 12) {\r
407             tapPortName = RT_PORT_NAME_PREFIX + uuid.substring(0, 11);\r
408         } else {\r
409             tapPortName = RT_PORT_NAME_PREFIX + uuid;\r
410         }\r
411         return tapPortName;\r
412     }\r
413 \r
414     private InstanceIdentifier<VppEndpoint> createVppEndpointIid(VppEndpointKey vppEpKey) {\r
415         return InstanceIdentifier.builder(Config.class).child(VppEndpoint.class, vppEpKey).build();\r
416     }\r
417 \r
418     private InstanceIdentifier<BaseEndpointByPort> createBaseEpByPortIid(Uuid uuid) {\r
419         return createBaseEpByPortIid(new UniqueId(uuid.getValue()));\r
420     }\r
421 \r
422     private InstanceIdentifier<BaseEndpointByPort> createBaseEpByPortIid(UniqueId uuid) {\r
423         return InstanceIdentifier.builder(Mappings.class)\r
424             .child(GbpByNeutronMappings.class)\r
425             .child(BaseEndpointsByPorts.class)\r
426             .child(BaseEndpointByPort.class, new BaseEndpointByPortKey(uuid))\r
427             .build();\r
428     }\r
429 \r
430     InstanceIdentifier<Port> createWildcartedPortIid() {\r
431         return portsIid().child(Port.class).build();\r
432     }\r
433 \r
434     private InstanceIdentifier<Port> createPortIid(UniqueId uuid) {\r
435         return portsIid().child(Port.class, new PortKey(new Uuid(uuid.getValue()))).build();\r
436     }\r
437 \r
438     private InstanceIdentifierBuilder<Ports> portsIid() {\r
439         return InstanceIdentifier.builder(Neutron.class).child(Ports.class);\r
440     }\r
441 \r
442     @Override\r
443     public void onTransactionChainFailed(TransactionChain<?, ?> chain, AsyncTransaction<?, ?> transaction,\r
444             Throwable cause) {\r
445         LOG.error("Transaction chain failed. {} \nTransaction which caused the chain to fail {}", cause.getMessage(),\r
446                 transaction, cause);\r
447         transactionChain.close();\r
448         transactionChain = dataBroker.createTransactionChain(this);\r
449     }\r
450 \r
451     @Override\r
452     public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {\r
453         LOG.trace("Transaction chain was successful. {}", chain);\r
454     }\r
455 \r
456     private <T> List<T> nullToEmpty(@Nullable List<T> list) {\r
457         return list == null ? Collections.emptyList() : list;\r
458     }\r
459 }\r