2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.groupbasedpolicy.neutron.ovsdb;
11 import static com.google.common.base.Preconditions.checkNotNull;
12 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.NodeDataChangeListener.getProviderMapping;
13 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.NodeDataChangeListener.processNodeNotification;
14 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.EndpointHelper.lookupEndpoint;
15 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.EndpointHelper.updateEndpointRemoveLocation;
16 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.EndpointHelper.updateEndpointWithLocation;
17 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.InventoryHelper.checkOfOverlayConfig;
18 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.InventoryHelper.getInventoryNodeConnectorIdString;
19 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.InventoryHelper.getInventoryNodeIdString;
20 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.InventoryHelper.removeTunnelsOfOverlayConfig;
21 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.InventoryHelper.updateOfOverlayConfig;
22 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.NeutronHelper.getEpKeyFromNeutronMapper;
23 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.OvsdbHelper.createTunnelPort;
24 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.OvsdbHelper.getManagerNode;
25 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.OvsdbHelper.getOvsdbBridgeFromTerminationPoint;
26 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.OvsdbHelper.getTopologyNode;
27 import static org.opendaylight.groupbasedpolicy.util.DataStoreHelper.readFromDs;
29 import java.util.ArrayList;
30 import java.util.Collections;
31 import java.util.List;
32 import java.util.Map.Entry;
34 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
35 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
36 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
37 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
38 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
39 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
40 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
41 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Uuid;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.EndpointService;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointKey;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIds;
51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
56 import org.opendaylight.yangtools.concepts.ListenerRegistration;
57 import org.opendaylight.yangtools.yang.binding.DataObject;
58 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
59 import org.slf4j.Logger;
60 import org.slf4j.LoggerFactory;
62 import com.google.common.base.Optional;
64 public class TerminationPointDataChangeListener implements DataChangeListener, AutoCloseable {
66 private static final String NEUTRON_EXTERNAL_ID_KEY = "iface-id";
67 private final ListenerRegistration<DataChangeListener> registration;
68 private final DataBroker dataBroker;
69 private final EndpointService epService;
70 private static final Logger LOG = LoggerFactory.getLogger(TerminationPointDataChangeListener.class);
71 private final List<AbstractTunnelType> requiredTunnelTypes;
73 public TerminationPointDataChangeListener(DataBroker dataBroker, EndpointService epService) {
74 this.dataBroker = checkNotNull(dataBroker);
75 this.epService = checkNotNull(epService);
76 InstanceIdentifier<OvsdbTerminationPointAugmentation> iid = InstanceIdentifier.create(NetworkTopology.class)
77 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
79 .child(TerminationPoint.class)
80 .augmentation(OvsdbTerminationPointAugmentation.class);
81 registration = dataBroker.registerDataChangeListener(LogicalDatastoreType.OPERATIONAL, iid, this,
83 requiredTunnelTypes = createSupportedTunnelsList();
86 private List<AbstractTunnelType> createSupportedTunnelsList() {
87 List<AbstractTunnelType> required = new ArrayList<AbstractTunnelType>();
88 required.add(new VxlanTunnelType());
89 required.add(new VxlanGpeTunnelType());
90 return Collections.unmodifiableList(required);
94 public void close() throws Exception {
99 public void onDataChanged(AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
102 * TerminationPoint notifications with OVSDB augmentations
103 * vSwitch ports. Iterate through the list of new ports.
105 for (Entry<InstanceIdentifier<?>, DataObject> entry : change.getCreatedData().entrySet()) {
106 if (entry.getValue() instanceof OvsdbTerminationPointAugmentation) {
107 OvsdbTerminationPointAugmentation ovsdbTp = (OvsdbTerminationPointAugmentation) entry.getValue();
108 InstanceIdentifier<OvsdbTerminationPointAugmentation> ovsdbTpIid = (InstanceIdentifier<OvsdbTerminationPointAugmentation>) entry.getKey();
109 OvsdbBridgeAugmentation ovsdbBridge = getOvsdbBridgeFromTerminationPoint(ovsdbTpIid, dataBroker);
110 processOvsdbBridge(ovsdbBridge, ovsdbTp, ovsdbTpIid);
117 for (Entry<InstanceIdentifier<?>, DataObject> entry : change.getUpdatedData().entrySet()) {
118 if (entry.getValue() instanceof OvsdbTerminationPointAugmentation) {
119 OvsdbTerminationPointAugmentation ovsdbTp = (OvsdbTerminationPointAugmentation) entry.getValue();
120 InstanceIdentifier<OvsdbTerminationPointAugmentation> ovsdbTpIid = (InstanceIdentifier<OvsdbTerminationPointAugmentation>) entry.getKey();
121 OvsdbBridgeAugmentation ovsdbBridge = getOvsdbBridgeFromTerminationPoint(ovsdbTpIid, dataBroker);
122 processOvsdbBridge(ovsdbBridge, ovsdbTp, ovsdbTpIid);
129 for (InstanceIdentifier<?> iid : change.getRemovedPaths()) {
130 DataObject old = change.getOriginalData().get(iid);
131 if (old instanceof OvsdbTerminationPointAugmentation) {
132 OvsdbTerminationPointAugmentation ovsdbTp = (OvsdbTerminationPointAugmentation) old;
133 @SuppressWarnings("unchecked")
134 InstanceIdentifier<OvsdbTerminationPointAugmentation> ovsdbTpIid = (InstanceIdentifier<OvsdbTerminationPointAugmentation>) iid;
135 OvsdbBridgeAugmentation ovsdbBridge = getOvsdbBridgeFromTerminationPoint(ovsdbTpIid, dataBroker);
136 if (ovsdbBridge != null) {
137 processRemovedTp(ovsdbBridge, ovsdbTp, ovsdbTpIid);
143 private void processOvsdbBridge(OvsdbBridgeAugmentation ovsdbBridge, OvsdbTerminationPointAugmentation ovsdbTp,
144 InstanceIdentifier<OvsdbTerminationPointAugmentation> ovsdbTpIid) {
146 checkNotNull(ovsdbBridge);
147 if (ovsdbBridge.getBridgeName().getValue().equals(ovsdbTp.getName())) {
148 LOG.debug("Termination Point {} same as Bridge {}. Not processing", ovsdbTp.getName(),
149 ovsdbBridge.getBridgeName().getValue());
153 String nodeIdString = getInventoryNodeIdString(ovsdbBridge, ovsdbTpIid, dataBroker);
154 if (nodeIdString == null) {
155 LOG.debug("nodeIdString for TerminationPoint {} was null", ovsdbTp);
158 String nodeConnectorIdString = getInventoryNodeConnectorIdString(nodeIdString, ovsdbTp, ovsdbTpIid, dataBroker);
159 if (nodeConnectorIdString == null) {
160 LOG.debug("nodeConnectorIdString for TerminationPoint {} was null", ovsdbTp);
164 InstanceIdentifier<Node> nodeIid = ovsdbTpIid.firstIdentifierOf(Node.class);
165 String externalId = getNeutronPortUuid(ovsdbTp);
167 IpAddress hostIp = getIpFromOvsdb(ovsdbBridge);
170 * Ports created by Nova have an external_id field
171 * in them, which is the Neutron port UUID. If a port
172 * has an external_id, get the EndpointKey for the
173 * Neutron port UUID from neutron-mapper, then look
174 * up the Endpoint in the Endpoint Registry using
175 * that key an update it with the location information
176 * (NodeId and NodeConnectorId from the inventory model)
177 * and the port name, constructed using the port UUID.
180 if (externalId != null) {
181 EndpointKey epKey = getEpKeyFromNeutronMapper(new Uuid(externalId), dataBroker);
183 LOG.debug("TerminationPoint {} with external ID {} is not in Neutron Map", ovsdbTp, externalId);
186 ReadOnlyTransaction transaction = dataBroker.newReadOnlyTransaction();
187 ep = lookupEndpoint(epKey, transaction);
190 "TerminationPoint {} with external ID {} is in Neutron Map, but corresponding Endpoint {} isn't in Endpoint Repository",
191 ovsdbTp, externalId, epKey);
195 * Look up the Node in Inventory that corresponds to the
196 * Topology Node that owns this Termination Point (port),
197 * and see if it already is configured with a complete
198 * OfOverlay augmentation. If it hasn't, go see if the
199 * tunnel ports exist, and if not, go and create them.
201 if (checkOfOverlayConfig(nodeIdString, requiredTunnelTypes, dataBroker) != true) {
202 checkNotNull(nodeIid);
204 * Check to see if we need to create a
205 * tunnel port on the parent node
207 createTunnelPorts(nodeIid, dataBroker);
210 LOG.debug("TerminationPoint {} had no external ID, not processing for external ID.", ovsdbTp);
215 * Check if Neutron External port was announed in Node before TerminationPoint it refers to
216 * was actually instantiated. This may or may not have external information in the future,
218 * not process as IF/ELSE externalID.
220 ReadOnlyTransaction transaction = dataBroker.newReadOnlyTransaction();
221 Optional<Node> node = readFromDs(LogicalDatastoreType.OPERATIONAL, nodeIid, transaction);
222 if (node.isPresent() && node.get().getAugmentation(OvsdbNodeAugmentation.class) != null) {
223 OvsdbNodeAugmentation ovsdbNodeAug = node.get().getAugmentation(OvsdbNodeAugmentation.class);
224 if (getProviderMapping(ovsdbNodeAug) != null) {
225 processNodeNotification(ovsdbNodeAug);
231 * This may be a notification for a tunnel we just created.
232 * In that case, we need to update the Inventory Node's OfOverlay
233 * augmentation with missing information
235 AbstractTunnelType tunnel = getTunnelType(ovsdbTp, requiredTunnelTypes);
236 if (tunnel != null) {
237 updateOfOverlayConfig(hostIp, nodeIdString, nodeConnectorIdString, tunnel, dataBroker);
239 if (externalId != null) {
240 ReadWriteTransaction rwTx = dataBroker.newReadWriteTransaction();
241 updateEndpointWithLocation(ep, nodeIdString, nodeConnectorIdString, rwTx);
246 * If removed termination point was a tunnel port,
247 * removes attached tunnels (namely Vxlan-type) from OVSDB bridge;
248 * else removes location info from TP
250 * @param ovsdbBridge {@link OvsdbBridgeAugmentation}
251 * @param ovsdbTp {@link OvsdbTerminationPointAugmentation}
252 * @param ovsdbTpIid termination point's IID {@link InstanceIdentifier}
254 private void processRemovedTp(OvsdbBridgeAugmentation ovsdbBridge, OvsdbTerminationPointAugmentation ovsdbTp,
255 InstanceIdentifier<OvsdbTerminationPointAugmentation> ovsdbTpIid) {
257 checkNotNull(ovsdbBridge);
258 if (ovsdbBridge.getBridgeName().getValue().equals(ovsdbTp.getName())) {
259 LOG.debug("Termination Point {} same as Bridge {}. Not processing.", ovsdbTp.getName(),
260 ovsdbBridge.getBridgeName().getValue());
264 String nodeIdString = getInventoryNodeIdString(ovsdbBridge, ovsdbTpIid, dataBroker);
265 if (nodeIdString == null) {
266 LOG.debug("nodeIdString for TerminationPoint {} was null.", ovsdbTp);
270 if (isTunnelPort(ovsdbTp, requiredTunnelTypes)) {
271 removeTunnelsOfOverlayConfig(nodeIdString, requiredTunnelTypes, dataBroker);
273 deleteLocationForTp(ovsdbTp);
278 * Delete location on EP for given TP
280 * @param ovsdbTp {@link OvsdbTerminationPointAugmentation}
282 private void deleteLocationForTp(OvsdbTerminationPointAugmentation ovsdbTp) {
283 String externalId = getNeutronPortUuid(ovsdbTp);
284 if (externalId != null) {
285 EndpointKey epKey = getEpKeyFromNeutronMapper(new Uuid(externalId), dataBroker);
287 LOG.debug("TerminationPoint {} with external ID {} is not in Neutron Map.", ovsdbTp, externalId);
290 ReadOnlyTransaction readOnlyTransaction = dataBroker.newReadOnlyTransaction();
291 Endpoint ep = lookupEndpoint(epKey, readOnlyTransaction);
292 readOnlyTransaction.close();
295 "TerminationPoint {} with external ID {} is in Neutron Map, but corresponding Endpoint {} isn't in Endpoint Repository.",
296 ovsdbTp, externalId, epKey);
299 updateEndpointRemoveLocation(ep, dataBroker.newReadWriteTransaction());
301 LOG.debug("TerminationPoint {} has no external ID, not processing.", ovsdbTp);
306 * Check to see if the {@link OvsdbTerminationPointAugmentation} is also a Tunnel port that we
309 * @param ovsdbTp {@link OvsdbTerminationPointAugmentation}
310 * @param requiredTunnelTypes {@link List} of tunnel types
312 private static AbstractTunnelType getTunnelType(OvsdbTerminationPointAugmentation ovsdbTp,
313 List<AbstractTunnelType> requiredTunnelTypes) {
314 if (ovsdbTp.getInterfaceType() != null) {
315 for (AbstractTunnelType tunnelType : requiredTunnelTypes) {
316 if (tunnelType.isValidTunnelPort(ovsdbTp)) {
325 * Check to see if the {@link OvsdbTerminationPointAugmentation}
326 * is also a Tunnel port that we care about.
328 * @param ovsdbTp {@link OvsdbTerminationPointAugmentation}
330 * @param requiredTunnelTypes {@link List} of tunnel types
332 * @return true if it's a required tunnel port, false if it isn't
334 private boolean isTunnelPort(OvsdbTerminationPointAugmentation ovsdbTp, List<AbstractTunnelType> requiredTunnelTypes) {
335 if (ovsdbTp.getInterfaceType() != null) {
336 for (AbstractTunnelType tunnelType : requiredTunnelTypes) {
337 if (tunnelType.isValidTunnelPort(ovsdbTp)) {
346 * Get the Neutron Port UUID from an {@link OvsdbTerminationPointAugmentation}.
347 * The Neutron Port UUID is stored as an "external-id" in the termination point.
349 * @param ovsdbTp The OVSDB Termination Point augmentation
350 * @return The String representation of the Neutron Port UUID, null if not present
352 private String getNeutronPortUuid(OvsdbTerminationPointAugmentation ovsdbTp) {
353 if (ovsdbTp.getInterfaceExternalIds() == null) {
356 for (InterfaceExternalIds id : ovsdbTp.getInterfaceExternalIds()) {
357 if (id.getExternalIdKey() != null && id.getExternalIdKey().equals(NEUTRON_EXTERNAL_ID_KEY)) {
359 if (id.getExternalIdValue() != null) {
360 return id.getExternalIdValue();
368 * Check to see if all tunnel ports are present, and if not,
371 * @param nodeIid {@link InstanceIdentifier}
372 * @param dataBroker {@link DataBroker}
374 private void createTunnelPorts(InstanceIdentifier<Node> nodeIid, DataBroker dataBroker) {
376 Node node = getTopologyNode(nodeIid, dataBroker);
379 if (node.getAugmentation(OvsdbBridgeAugmentation.class) == null) {
380 LOG.trace("Node {} is not an OVSDB manageable node", nodeIid);
385 * See if this Topology Node has the required tunnel ports,
386 * and if not, go and create them
388 for (AbstractTunnelType tunnelType : requiredTunnelTypes) {
389 boolean tunnelPresent = false;
390 for (TerminationPoint tp : node.getTerminationPoint()) {
391 OvsdbTerminationPointAugmentation tpAug = tp.getAugmentation(OvsdbTerminationPointAugmentation.class);
395 if (tunnelType.isValidTunnelPort(tpAug)) {
396 tunnelPresent = true;
400 if (!tunnelPresent) {
401 createTunnelPort(nodeIid, node, tunnelType, dataBroker);
407 * Get the IP address of the host that owns the {@link OvsdbBridgeAugmentation}.
409 * @param ovsdbBridge The OVSDB bridge node
410 * @return The IP address of the host that the bridge is on
412 private IpAddress getIpFromOvsdb(OvsdbBridgeAugmentation ovsdbBridge) {
414 * The manager Node referenced by this node has the
417 OvsdbNodeAugmentation managerNode = getManagerNode(ovsdbBridge, dataBroker);
419 if (managerNode == null)
422 if (managerNode.getConnectionInfo() != null) {
423 return managerNode.getConnectionInfo().getRemoteIp();