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