Merge "Fix MatchIcmpv4 & MatchIcmpv6's problems with XtendBeanGenerator (2/2)"
[genius.git] / interfacemanager / interfacemanager-impl / src / main / java / org / opendaylight / genius / interfacemanager / renderer / ovs / utilities / SouthboundUtils.java
1 /*
2  * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.genius.interfacemanager.renderer.ovs.utilities;
9
10 import com.google.common.collect.Maps;
11 import com.google.common.util.concurrent.ListenableFuture;
12 import java.math.BigInteger;
13 import java.util.ArrayList;
14 import java.util.HashMap;
15 import java.util.List;
16 import java.util.Map;
17 import java.util.UUID;
18 import org.apache.commons.lang3.BooleanUtils;
19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
20 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
22 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
23 import org.opendaylight.genius.interfacemanager.globals.IfmConstants;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntry;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntry;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelMonitoringTypeBfd;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlanGpe;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.tunnel.optional.params.TunnelOptions;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbPortInterfaceAttributes;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfd;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdKey;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsKey;
52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
62 import org.slf4j.Logger;
63 import org.slf4j.LoggerFactory;
64
65 public class SouthboundUtils {
66     private static final Logger LOG = LoggerFactory.getLogger(SouthboundUtils.class);
67
68     public static final String BFD_PARAM_ENABLE = "enable";
69     static final String BFD_PARAM_MIN_TX = "min_tx";
70     static final String BFD_PARAM_MIN_RX = "min_rx";
71     static final String BFD_PARAM_DECAY_MIN_RX = "decay_min_rx";
72     static final String BFD_PARAM_FORWARDING_IF_RX = "forwarding_if_rx";
73     static final String BFD_PARAM_CPATH_DOWN = "cpath_down";
74     static final String BFD_PARAM_CHECK_TNL_KEY = "check_tnl_key";
75
76     // BFD parameters
77     public static final String BFD_OP_STATE = "state";
78     public static final String BFD_STATE_UP = "up";
79     private static final String BFD_MIN_RX_VAL = "1000";
80     private static final String BFD_MIN_TX_VAL = "100";
81     private static final String BFD_DECAY_MIN_RX_VAL = "200";
82     private static final String BFD_FORWARDING_IF_RX_VAL = "true";
83     private static final String BFD_CPATH_DOWN_VAL = "false";
84     private static final String BFD_CHECK_TNL_KEY_VAL = "false";
85
86     // Tunnel options
87     private static final String TUNNEL_OPTIONS_KEY = "key";
88     private static final String TUNNEL_OPTIONS_LOCAL_IP = "local_ip";
89     private static final String TUNNEL_OPTIONS_REMOTE_IP = "remote_ip";
90     private static final String TUNNEL_OPTIONS_DESTINATION_PORT = "dst_port";
91
92     // Option values for VxLAN-GPE + NSH tunnels
93     private static final String TUNNEL_OPTIONS_EXTS = "exts";
94     private static final String TUNNEL_OPTIONS_NSI = "nsi";
95     private static final String TUNNEL_OPTIONS_NSP = "nsp";
96     private static final String TUNNEL_OPTIONS_NSHC1 = "nshc1";
97     private static final String TUNNEL_OPTIONS_NSHC2 = "nshc2";
98     private static final String TUNNEL_OPTIONS_NSHC3 = "nshc3";
99     private static final String TUNNEL_OPTIONS_NSHC4 = "nshc4";
100
101     // Option values for VxLAN-GPE + NSH tunnels
102     private static final String TUNNEL_OPTIONS_VALUE_FLOW = "flow";
103     private static final String TUNNEL_OPTIONS_VALUE_GPE = "gpe";
104     // UDP port for VxLAN-GPE Tunnels
105     private static final String TUNNEL_OPTIONS_VALUE_GPE_DESTINATION_PORT = "4880";
106
107     // To keep the mapping between Tunnel Types and Tunnel Interfaces
108     private static final Map<Class<? extends TunnelTypeBase>, Class<? extends InterfaceTypeBase>>
109         TUNNEL_TYPE_MAP = new HashMap<Class<? extends TunnelTypeBase>, Class<? extends InterfaceTypeBase>>() {
110             {
111                 put(TunnelTypeGre.class, InterfaceTypeGre.class);
112                 put(TunnelTypeVxlan.class, InterfaceTypeVxlan.class);
113                 put(TunnelTypeVxlanGpe.class, InterfaceTypeVxlan.class);
114             }
115         };
116
117     public static void addPortToBridge(InstanceIdentifier<?> bridgeIid, Interface iface, String portName,
118             DataBroker dataBroker, List<ListenableFuture<Void>> futures) {
119         IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
120         if (ifTunnel != null) {
121             addTunnelPortToBridge(ifTunnel, bridgeIid, iface, portName, dataBroker);
122         }
123     }
124
125     /*
126      * Add all tunnels ports corresponding to the bridge to the topology config
127      * DS
128      */
129     public static void addAllPortsToBridge(BridgeEntry bridgeEntry, DataBroker dataBroker,
130             InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid, OvsdbBridgeAugmentation bridgeNew,
131             List<ListenableFuture<Void>> futures) {
132         String bridgeName = bridgeNew.getBridgeName().getValue();
133         LOG.debug("adding all ports to bridge: {}", bridgeName);
134         List<BridgeInterfaceEntry> bridgeInterfaceEntries = bridgeEntry.getBridgeInterfaceEntry();
135         if (bridgeInterfaceEntries != null) {
136             for (BridgeInterfaceEntry bridgeInterfaceEntry : bridgeInterfaceEntries) {
137                 String portName = bridgeInterfaceEntry.getInterfaceName();
138                 InterfaceKey interfaceKey = new InterfaceKey(portName);
139                 Interface iface = InterfaceManagerCommonUtils.getInterfaceFromConfigDS(interfaceKey, dataBroker);
140                 if (iface != null) {
141                     IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
142                     if (ifTunnel != null) {
143                         addTunnelPortToBridge(ifTunnel, bridgeIid, iface, portName, dataBroker);
144                     }
145                     if (SouthboundUtils.isOfTunnel(ifTunnel)) {
146                         LOG.debug("Using OFTunnel. Only one tunnel port will be added");
147                         return;
148                     }
149                 } else {
150                     LOG.debug("Interface {} not found in config DS", portName);
151                 }
152             }
153         }
154     }
155
156     private static void addTunnelPortToBridge(IfTunnel ifTunnel, InstanceIdentifier<?> bridgeIid, Interface iface,
157             String portName, DataBroker dataBroker) {
158         LOG.debug("adding tunnel port {} to bridge {}", portName, bridgeIid);
159
160         Class<? extends InterfaceTypeBase> type = TUNNEL_TYPE_MAP.get(ifTunnel.getTunnelInterfaceType());
161
162         if (type == null) {
163             LOG.warn("Unknown Tunnel Type obtained while creating interface: {}", iface);
164             return;
165         }
166
167         int vlanId = 0;
168         IfL2vlan ifL2vlan = iface.getAugmentation(IfL2vlan.class);
169         if (ifL2vlan != null && ifL2vlan.getVlanId() != null) {
170             vlanId = ifL2vlan.getVlanId().getValue();
171         }
172
173         Map<String, String> options = Maps.newHashMap();
174
175         // Options common to any kind of tunnel
176         if (BooleanUtils.isTrue(ifTunnel.isTunnelSourceIpFlow())) {
177             options.put(TUNNEL_OPTIONS_LOCAL_IP, TUNNEL_OPTIONS_VALUE_FLOW);
178         } else {
179             IpAddress localIp = ifTunnel.getTunnelSource();
180             options.put(TUNNEL_OPTIONS_LOCAL_IP, String.valueOf(localIp.getValue()));
181         }
182         if (BooleanUtils.isTrue(ifTunnel.isTunnelRemoteIpFlow())) {
183             options.put(TUNNEL_OPTIONS_REMOTE_IP, TUNNEL_OPTIONS_VALUE_FLOW);
184         } else {
185             IpAddress remoteIp = ifTunnel.getTunnelDestination();
186             options.put(TUNNEL_OPTIONS_REMOTE_IP, String.valueOf(remoteIp.getValue()));
187         }
188
189         // Specific options for each type of tunnel
190         if (!ifTunnel.getTunnelInterfaceType().equals(TunnelTypeMplsOverGre.class)) {
191             options.put(TUNNEL_OPTIONS_KEY, TUNNEL_OPTIONS_VALUE_FLOW);
192         }
193         if (ifTunnel.getTunnelInterfaceType().equals(TunnelTypeVxlanGpe.class)) {
194             options.put(TUNNEL_OPTIONS_EXTS, TUNNEL_OPTIONS_VALUE_GPE);
195             options.put(TUNNEL_OPTIONS_NSI, TUNNEL_OPTIONS_VALUE_FLOW);
196             options.put(TUNNEL_OPTIONS_NSP, TUNNEL_OPTIONS_VALUE_FLOW);
197             options.put(TUNNEL_OPTIONS_NSHC1, TUNNEL_OPTIONS_VALUE_FLOW);
198             options.put(TUNNEL_OPTIONS_NSHC2, TUNNEL_OPTIONS_VALUE_FLOW);
199             options.put(TUNNEL_OPTIONS_NSHC3, TUNNEL_OPTIONS_VALUE_FLOW);
200             options.put(TUNNEL_OPTIONS_NSHC4, TUNNEL_OPTIONS_VALUE_FLOW);
201             // VxLAN-GPE interfaces will not use the default UDP port to avoid
202             // problems with other meshes
203             options.put(TUNNEL_OPTIONS_DESTINATION_PORT, TUNNEL_OPTIONS_VALUE_GPE_DESTINATION_PORT);
204         }
205
206         if (ifTunnel.getTunnelOptions() != null) {
207             for (TunnelOptions tunOpt : ifTunnel.getTunnelOptions()) {
208                 options.putIfAbsent(tunOpt.getTunnelOption(), tunOpt.getValue());
209             }
210         }
211
212         addTerminationPoint(bridgeIid, portName, vlanId, type, options, ifTunnel);
213     }
214
215     // Update is allowed only for tunnel monitoring attributes
216     public static void updateBfdParamtersForTerminationPoint(InstanceIdentifier<?> bridgeIid, IfTunnel ifTunnel,
217             String portName, WriteTransaction transaction) {
218         InstanceIdentifier<TerminationPoint> tpIid = createTerminationPointInstanceIdentifier(
219                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), portName);
220         if (isOfTunnel(ifTunnel)) {
221             LOG.warn("BFD monitoring not supported for OFTunnels. Skipping BFD parameters for {}", portName);
222             return;
223         }
224         LOG.debug("update bfd parameters for interface {}", tpIid);
225         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
226         List<InterfaceBfd> bfdParams = getBfdParams(ifTunnel);
227         tpAugmentationBuilder.setInterfaceBfd(bfdParams);
228
229         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
230         tpBuilder.setKey(InstanceIdentifier.keyOf(tpIid));
231         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
232
233         transaction.merge(LogicalDatastoreType.CONFIGURATION, tpIid, tpBuilder.build(), true);
234     }
235
236     private static void addTerminationPoint(InstanceIdentifier<?> bridgeIid, String portName, int vlanId,
237             Class<? extends InterfaceTypeBase> type, Map<String, String> options, IfTunnel ifTunnel) {
238         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
239
240         tpAugmentationBuilder.setName(portName);
241
242         if (type != null) {
243             tpAugmentationBuilder.setInterfaceType(type);
244         }
245
246         if (options != null) {
247             List<Options> optionsList = new ArrayList<>();
248             for (Map.Entry<String, String> entry : options.entrySet()) {
249                 OptionsBuilder optionsBuilder = new OptionsBuilder();
250                 optionsBuilder.setKey(new OptionsKey(entry.getKey()));
251                 optionsBuilder.setOption(entry.getKey());
252                 optionsBuilder.setValue(entry.getValue());
253                 optionsList.add(optionsBuilder.build());
254             }
255             tpAugmentationBuilder.setOptions(optionsList);
256         }
257
258         if (vlanId != 0) {
259             tpAugmentationBuilder.setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.Access);
260             tpAugmentationBuilder.setVlanTag(new VlanId(vlanId));
261         }
262
263         if (bfdMonitoringEnabled(ifTunnel)) {
264             if (isOfTunnel(ifTunnel)) {
265                 LOG.warn("BFD Monitoring not supported for OFTunnels");
266             } else {
267                 List<InterfaceBfd> bfdParams = getBfdParams(ifTunnel);
268                 tpAugmentationBuilder.setInterfaceBfd(bfdParams);
269             }
270         }
271         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
272         InstanceIdentifier<TerminationPoint> tpIid = createTerminationPointInstanceIdentifier(
273                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), portName);
274         tpBuilder.setKey(InstanceIdentifier.keyOf(tpIid));
275         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
276
277         BatchingUtils.write(tpIid, tpBuilder.build(), BatchingUtils.EntityType.TOPOLOGY_CONFIG);
278     }
279
280     private static List<InterfaceBfd> getBfdParams(IfTunnel ifTunnel) {
281         List<InterfaceBfd> bfdParams = new ArrayList<>();
282         bfdParams.add(
283                 getIfBfdObj(BFD_PARAM_ENABLE, ifTunnel != null ? ifTunnel.isMonitorEnabled().toString() : "false"));
284         bfdParams.add(getIfBfdObj(BFD_PARAM_MIN_TX,
285                 ifTunnel != null && ifTunnel.getMonitorInterval() != null ? ifTunnel.getMonitorInterval().toString()
286                         : BFD_MIN_TX_VAL));
287         bfdParams.add(getIfBfdObj(BFD_PARAM_FORWARDING_IF_RX, BFD_FORWARDING_IF_RX_VAL));
288         return bfdParams;
289     }
290
291     private static InterfaceBfd getIfBfdObj(String key, String value) {
292         InterfaceBfdBuilder bfdBuilder = new InterfaceBfdBuilder();
293         bfdBuilder.setBfdKey(key).setKey(new InterfaceBfdKey(key)).setBfdValue(value);
294         return bfdBuilder.build();
295     }
296
297     public static InstanceIdentifier<TerminationPoint> createTerminationPointInstanceIdentifier(NodeKey nodekey,
298             String portName) {
299         InstanceIdentifier<TerminationPoint> terminationPointPath = InstanceIdentifier.create(NetworkTopology.class)
300                 .child(Topology.class, new TopologyKey(IfmConstants.OVSDB_TOPOLOGY_ID)).child(Node.class, nodekey)
301                 .child(TerminationPoint.class, new TerminationPointKey(new TpId(portName)));
302
303         LOG.debug("Termination point InstanceIdentifier generated : {}", terminationPointPath);
304         return terminationPointPath;
305     }
306
307     public static void removeTerminationEndPoint(DataBroker dataBroker, InstanceIdentifier<?> bridgeIid,
308             String interfaceName) {
309         LOG.debug("removing termination point for {}", interfaceName);
310         WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
311         InstanceIdentifier<TerminationPoint> tpIid = SouthboundUtils.createTerminationPointInstanceIdentifier(
312                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(Node.class)), interfaceName);
313         BatchingUtils.delete(tpIid, BatchingUtils.EntityType.TOPOLOGY_CONFIG);
314     }
315
316     public static boolean bfdMonitoringEnabled(IfTunnel ifTunnel) {
317         return ifTunnel.isMonitorEnabled()
318                 && TunnelMonitoringTypeBfd.class.isAssignableFrom(ifTunnel.getMonitorProtocol());
319     }
320
321     public static boolean isMonitorProtocolBfd(IfTunnel ifTunnel) {
322         return TunnelMonitoringTypeBfd.class.isAssignableFrom(ifTunnel.getMonitorProtocol());
323     }
324
325     public static String generateOfTunnelName(BigInteger dpId, IfTunnel ifTunnel) {
326         String sourceKey = new String(ifTunnel.getTunnelSource().getValue());
327         String remoteKey = new String(ifTunnel.getTunnelDestination().getValue());
328         if (ifTunnel.isTunnelSourceIpFlow() != null) {
329             sourceKey = "flow";
330         }
331         if (ifTunnel.isTunnelRemoteIpFlow() != null) {
332             remoteKey = "flow";
333         }
334         String tunnelNameKey = dpId.toString() + sourceKey + remoteKey;
335         String uuidStr = UUID.nameUUIDFromBytes(tunnelNameKey.getBytes()).toString().substring(0, 12).replace("-", "");
336         return String.format("%s%s", "tun", uuidStr);
337     }
338
339     public static boolean isOfTunnel(IfTunnel ifTunnel) {
340         if (BooleanUtils.isTrue(ifTunnel.isTunnelRemoteIpFlow())
341                 || BooleanUtils.isTrue(ifTunnel.isTunnelSourceIpFlow())) {
342             return true;
343         }
344         return false;
345     }
346
347     public static boolean isInterfaceTypeTunnel(Class<? extends InterfaceTypeBase> interfaceType) {
348         return interfaceType.equals(InterfaceTypeGre.class) || interfaceType.equals(InterfaceTypeVxlan.class)
349                 ? true : false;
350     }
351
352 }