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.util;
11 import static org.opendaylight.groupbasedpolicy.util.DataStoreHelper.readFromDs;
12 import static org.opendaylight.groupbasedpolicy.util.DataStoreHelper.submitToDs;
14 import java.util.ArrayList;
15 import java.util.List;
17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
18 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
19 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
21 import org.opendaylight.groupbasedpolicy.neutron.ovsdb.AbstractTunnelType;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentationBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeRef;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
45 import com.google.common.base.Optional;
47 public class OvsdbHelper {
48 private static final Logger LOG = LoggerFactory.getLogger(OvsdbHelper.class);
49 private static final String OF_PORT = "6653";
52 * Look up the {@link OvsdbBridgeAugmentation} from the data store
53 * given a child {@link InstanceIdentifier} of {@link OvsdbTerminationPointAugmentation}
55 * @param tpIid The InstanceIdentifier for a child TerminationPoint augmentation
56 * @param dataBroker the {@link DataBroker}
57 * @return the {@link OvsdbBridgeAugmentation}, null if the augmentation isn't present
59 public static OvsdbBridgeAugmentation getOvsdbBridgeFromTerminationPoint(
60 InstanceIdentifier<OvsdbTerminationPointAugmentation> tpIid, DataBroker dataBroker) {
61 InstanceIdentifier<Node> nodeIid = tpIid.firstIdentifierOf(Node.class);
62 if (nodeIid != null) {
63 InstanceIdentifier<OvsdbBridgeAugmentation> ovsdbBridgeIid = nodeIid.augmentation(OvsdbBridgeAugmentation.class);
64 if (ovsdbBridgeIid != null) {
65 ReadTransaction transaction = dataBroker.newReadOnlyTransaction();
66 Optional<OvsdbBridgeAugmentation> ovsdbBridge =
67 readFromDs(LogicalDatastoreType.OPERATIONAL, ovsdbBridgeIid, transaction);
68 if (ovsdbBridge.isPresent()) {
69 return ovsdbBridge.get();
76 public static Node getNodeFromBridgeRef(OvsdbBridgeRef bridgeRef, DataBroker dataBroker) {
77 InstanceIdentifier<Node> nodeIid = bridgeRef.getValue().firstIdentifierOf(Node.class);
78 ReadTransaction transaction = dataBroker.newReadOnlyTransaction();
80 readFromDs(LogicalDatastoreType.OPERATIONAL, nodeIid, transaction );
81 if (node.isPresent()) {
82 if (node.get() instanceof Node) {
83 return (Node)node.get();
89 public static OvsdbTerminationPointAugmentation getOvsdbTerminationPoint(
90 InstanceIdentifier<OvsdbTerminationPointAugmentation> tpIid, DataBroker dataBroker) {
91 ReadTransaction transaction = dataBroker.newReadOnlyTransaction();
92 Optional<OvsdbTerminationPointAugmentation> ovsdbTp =
93 readFromDs(LogicalDatastoreType.OPERATIONAL, tpIid, transaction );
94 if (ovsdbTp.isPresent()) {
100 public static Node getNode(Node node, List<TerminationPoint> tps,
101 OvsdbBridgeAugmentation ovsdbBridgeAugmentation) {
102 NodeBuilder nodeBuilder = new NodeBuilder();
103 nodeBuilder.setKey(node.getKey());
105 nodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class,
106 ovsdbBridgeAugmentation);
108 nodeBuilder.setTerminationPoint(tps);
109 return nodeBuilder.build();
112 public static OvsdbBridgeAugmentation buildOvsdbBridgeAugmentation(OvsdbBridgeAugmentation bridge,
113 OvsdbNodeAugmentation ovsdbNode) {
114 OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentation = new OvsdbBridgeAugmentationBuilder();
115 IpAddress managerIp = getManagerIp(ovsdbNode);
116 if (managerIp != null) {
117 List<ControllerEntry> controllerEntries = buildControllerEntries(managerIp);
118 ovsdbBridgeAugmentation.setControllerEntry(controllerEntries);
120 ovsdbBridgeAugmentation.setBridgeName(bridge.getBridgeName());
121 ovsdbBridgeAugmentation.setManagedBy(bridge.getManagedBy());
122 return ovsdbBridgeAugmentation.build();
125 public static List<TerminationPoint> buildTerminationPoints(OvsdbBridgeAugmentation bridge,
126 OvsdbTerminationPointAugmentation ovsdbTp, AbstractTunnelType tunnelType) {
127 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
128 tpBuilder.setTpId(new TpId(new Uri(generateTpName(bridge, tunnelType))));
129 tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, ovsdbTp);
131 List<TerminationPoint> tps = new ArrayList<TerminationPoint>();
132 tps.add(tpBuilder.build());
136 public static String generateTpName(OvsdbBridgeAugmentation bridge, AbstractTunnelType tunnelType) {
137 return tunnelType.getTunnelPrefix() + bridge.getBridgeName().getValue();
140 public static OvsdbTerminationPointAugmentation buildOvsdbTerminationPointAugmentation(OvsdbBridgeAugmentation bridge,
141 List<Options> options, AbstractTunnelType tunnelType) {
142 OvsdbTerminationPointAugmentationBuilder ovsdbTpBuilder = new OvsdbTerminationPointAugmentationBuilder();
143 ovsdbTpBuilder.setName(generateTpName(bridge, tunnelType));
144 ovsdbTpBuilder.setOptions(options);
145 ovsdbTpBuilder.setInterfaceType(InterfaceTypeVxlan.class);
146 return ovsdbTpBuilder.build();
149 public static void setOption(List<Options> options, String key, String value) {
150 OptionsBuilder option = new OptionsBuilder();
151 option.setOption(key);
152 option.setValue(value);
153 options.add(option.build());
156 public static IpAddress getManagerIp(OvsdbNodeAugmentation ovsdbNode) {
157 if (ovsdbNode.getConnectionInfo() != null) {
158 return ovsdbNode.getConnectionInfo().getLocalIp();
163 public static IpAddress getNodeIp(OvsdbNodeAugmentation ovsdbNode) {
164 if (ovsdbNode.getConnectionInfo() != null) {
165 return ovsdbNode.getConnectionInfo().getRemoteIp();
170 public static List<ControllerEntry> buildControllerEntries(IpAddress ip) {
171 List<ControllerEntry> result = new ArrayList<ControllerEntry>();
174 ControllerEntryBuilder controllerBuilder = new ControllerEntryBuilder();
175 String localIp = String.valueOf(ip.getValue());
176 String targetString = "tcp:" + localIp + ":" + OF_PORT;
177 controllerBuilder.setTarget(new Uri(targetString));
178 result.add(controllerBuilder.build());
185 * Get the manager node for this bridge node
187 * @param bridge the bridge node
188 * @param dataBroker the {@link DataBroker}
189 * @return The {@link OvsdbBridgeAugmentation} for the manager node, null
190 * if not found or if it already is the manager node
192 public static OvsdbNodeAugmentation getManagerNode(OvsdbBridgeAugmentation bridge, DataBroker dataBroker) {
193 OvsdbNodeRef bareIId = bridge.getManagedBy();
194 if(bareIId != null) {
195 if(bareIId.getValue().getTargetType().equals(Node.class)) {
196 ReadWriteTransaction transaction = dataBroker.newReadWriteTransaction();
197 InstanceIdentifier<Node> iid = (InstanceIdentifier<Node>) bareIId.getValue();
198 Optional<Node> nodeOptional = readFromDs(LogicalDatastoreType.OPERATIONAL, iid, transaction);
199 if(nodeOptional.isPresent()
200 && nodeOptional.get().getAugmentation(OvsdbNodeAugmentation.class) != null) {
201 return nodeOptional.get().getAugmentation(OvsdbNodeAugmentation.class);
203 LOG.warn("Could not find ovsdb-node for connection for {}",bridge);
206 LOG.warn("Bridge 'managedBy' non-ovsdb-node. bridge {} getManagedBy() {}",bridge,bareIId.getValue());
209 LOG.debug("Bridge 'managedBy' is null. bridge {}",bridge);
214 public static Node getTopologyNode(InstanceIdentifier<Node> nodeIid, DataBroker dataBroker) {
215 ReadTransaction transaction = dataBroker.newReadOnlyTransaction();
216 Optional<Node> nodeOptional =
217 readFromDs(LogicalDatastoreType.OPERATIONAL, nodeIid, transaction );
218 if (nodeOptional.isPresent()) {
219 return nodeOptional.get();
225 * Use OVSDB CRUD to create any missing tunnels on a given
228 * @param nodeIid the node instance identifier
229 * @param node the inventory node
230 * @param tunnelType the tunnel type
231 * @param dataBroker the {@link DataBroker}
233 public static void createTunnelPort(InstanceIdentifier<Node> nodeIid,
234 Node node, AbstractTunnelType tunnelType, DataBroker dataBroker) {
235 ReadWriteTransaction transaction = dataBroker.newReadWriteTransaction();
236 OvsdbBridgeAugmentation bridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
237 if (bridge == null) {
238 LOG.warn("No OvsdbBridgeAugmentationfor Node {}", node);
242 OvsdbNodeAugmentation managerNode = getManagerNode(bridge, dataBroker);
243 if(managerNode == null) {
244 LOG.warn("Couldn't create tunnel port for Node {}, no manager", node);
247 List<Options> options = tunnelType.getOptions();
248 OvsdbTerminationPointAugmentation ovsdbTp =
249 buildOvsdbTerminationPointAugmentation(bridge,options, tunnelType);
250 List<TerminationPoint> tps = buildTerminationPoints(bridge,ovsdbTp, tunnelType);
251 OvsdbBridgeAugmentation ovsdbBridgeAugmentation =
252 buildOvsdbBridgeAugmentation(bridge,managerNode);
253 Node configNode = getNode(node, tps,ovsdbBridgeAugmentation);
254 LOG.info("About to write nodeId {} node {}",nodeIid,configNode);
255 transaction.merge(LogicalDatastoreType.CONFIGURATION, nodeIid, configNode);
256 submitToDs(transaction);