2 * Copyright (c) 2015, 2017 China Telecom Beijing Research Institute 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.ovsdb.hwvtepsouthbound.transact;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.Maps;
14 import org.apache.commons.lang3.tuple.Pair;
15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
16 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
17 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
18 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepConnectionInstance;
19 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepDeviceInfo;
20 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepSouthboundUtil;
21 import org.opendaylight.ovsdb.lib.notation.UUID;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.EncapsulationTypeBase;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeName;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalLocatorAugmentation;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentation;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.PhysicalSwitchAugmentation;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LocalMcastMacs;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LocalMcastMacsKey;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LocalUcastMacs;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LocalUcastMacsKey;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitchesKey;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacs;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacsKey;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacs;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacsKey;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.Switches;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical._switch.attributes.Tunnels;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical._switch.attributes.TunnelsKey;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
44 import org.opendaylight.yangtools.yang.binding.Identifiable;
45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
49 import java.util.Collection;
50 import java.util.Collections;
51 import java.util.HashMap;
52 import java.util.List;
54 import java.util.Map.Entry;
56 import java.util.concurrent.ConcurrentHashMap;
58 //TODO: need to be optimized, get entry by iid not name
59 public class HwvtepOperationalState {
61 private static final Logger LOG = LoggerFactory.getLogger(HwvtepOperationalState.class);
63 private Map<InstanceIdentifier<Node>, Node> operationalNodes = new HashMap<>();
64 private ReadWriteTransaction transaction;
65 HashMap<InstanceIdentifier<TerminationPoint>, UUID> inflightLocators = Maps.newHashMap();
66 private HwvtepDeviceInfo deviceInfo;
67 private HwvtepConnectionInstance connectionInstance;
68 private Map<Class<? extends Identifiable>, Map<InstanceIdentifier, UUID>> currentTxUUIDs = new ConcurrentHashMap<>();
69 private Map<Class<? extends Identifiable>, Map<InstanceIdentifier, Boolean>> currentTxDeletedKeys = new ConcurrentHashMap<>();
71 /* stores the modified and deleted data for each child type of each node id
72 Map<nodeid , Pair < updated, deleted >
73 each updated/ deleted contains Map < child type, List<ChildData>>
74 child type is the child of hwvtep Global augmentation
76 private Map<InstanceIdentifier<Node>,
77 Pair<Map<Class<? extends Identifiable>, List<Identifiable>>,
78 Map<Class<? extends Identifiable>, List<Identifiable>>>> modifiedData = new HashMap<>();
79 private boolean inReconciliation = false;
80 private final DataBroker db;
81 private final Collection<DataTreeModification<Node>> changes;
83 public HwvtepOperationalState(DataBroker db, HwvtepConnectionInstance connectionInstance,
84 Collection<DataTreeModification<Node>> changes) {
85 this.connectionInstance = connectionInstance;
86 this.deviceInfo = connectionInstance.getDeviceInfo();
88 this.changes = changes;
89 this.transaction = db.newReadWriteTransaction();
92 public HwvtepOperationalState(HwvtepConnectionInstance connectionInstance) {
93 this.connectionInstance = connectionInstance;
94 this.deviceInfo = connectionInstance.getDeviceInfo();
95 this.db = connectionInstance.getDataBroker();
97 transaction = connectionInstance.getDataBroker().newReadWriteTransaction();
98 Optional<Node> readNode = HwvtepSouthboundUtil.readNode(transaction,
99 connectionInstance.getInstanceIdentifier());
100 if (readNode.isPresent()) {
101 operationalNodes.put(connectionInstance.getInstanceIdentifier(), readNode.get());
105 public void readOperationalNodes() {
106 if (inReconciliation) {
109 if (changes == null) {
110 LOG.warn("Could not read operational nodes for {} as changes is",
111 connectionInstance.getNodeId().getValue());
114 Map<InstanceIdentifier<Node>, Node> nodeCreateOrUpdate =
115 TransactUtils.extractCreatedOrUpdatedOrRemoved(changes, Node.class);
116 if (nodeCreateOrUpdate != null) {
117 transaction = db.newReadWriteTransaction();
118 for (Entry<InstanceIdentifier<Node>, Node> entry: nodeCreateOrUpdate.entrySet()) {
119 Optional<Node> readNode = HwvtepSouthboundUtil.readNode(transaction, entry.getKey());
120 //add related globalNode or physicalSwitchNode to operationalNodes map
121 //for example, when creating physical port, logical switch is needed
122 //but logical switch is in HwvtepGlobalAugmentation rather than PhysicalSwitchAugmentation
123 if (readNode.isPresent()) {
124 operationalNodes.put(entry.getKey(), readNode.get());
125 HwvtepGlobalAugmentation hgAugmentation = readNode.get().getAugmentation(HwvtepGlobalAugmentation.class);
126 PhysicalSwitchAugmentation psAugmentation = readNode.get().getAugmentation(PhysicalSwitchAugmentation.class);
127 if (hgAugmentation != null && hgAugmentation.getSwitches() != null) {
128 for (Switches pswitch : hgAugmentation.getSwitches()) {
129 @SuppressWarnings("unchecked")
130 InstanceIdentifier<Node> psNodeIid = (InstanceIdentifier<Node>) pswitch.getSwitchRef().getValue();
131 Optional<Node> psNode = HwvtepSouthboundUtil.readNode(transaction, psNodeIid);
132 if (psNode.isPresent()) {
133 operationalNodes.put(psNodeIid, psNode.get());
137 if (psAugmentation != null) {
138 @SuppressWarnings("unchecked")
139 InstanceIdentifier<Node> hgNodeIid = (InstanceIdentifier<Node>) psAugmentation.getManagedBy().getValue();
140 Optional<Node> hgNode = HwvtepSouthboundUtil.readNode(transaction, hgNodeIid);
141 if (hgNode.isPresent()) {
142 operationalNodes.put(hgNodeIid, hgNode.get());
150 public Optional<Node> getGlobalNode(InstanceIdentifier<?> iid) {
151 InstanceIdentifier<Node> nodeIid = iid.firstIdentifierOf(Node.class);
152 return Optional.fromNullable(operationalNodes.get(nodeIid));
155 public Optional<HwvtepGlobalAugmentation> getHwvtepGlobalAugmentation(InstanceIdentifier<?> iid) {
156 Preconditions.checkNotNull(iid);
157 Optional<Node> nodeOptional = getGlobalNode(iid);
158 if (nodeOptional.isPresent()) {
159 return Optional.fromNullable(nodeOptional.get().getAugmentation(HwvtepGlobalAugmentation.class));
161 return Optional.absent();
164 public Optional<PhysicalSwitchAugmentation> getPhysicalSwitchAugmentation(InstanceIdentifier<?> iid) {
165 Preconditions.checkNotNull(iid);
166 Optional<Node> nodeOptional = getGlobalNode(iid);
167 if (nodeOptional.isPresent()) {
168 return Optional.fromNullable(nodeOptional.get().getAugmentation(PhysicalSwitchAugmentation.class));
170 return Optional.absent();
173 public Optional<List<TerminationPoint>> getTerminationPointList(InstanceIdentifier<?> iid) {
174 Preconditions.checkNotNull(iid);
175 Optional<Node> nodeOptional = getGlobalNode(iid);
176 if (nodeOptional.isPresent() && nodeOptional.get().getTerminationPoint() != null) {
177 return Optional.fromNullable(nodeOptional.get().getTerminationPoint());
179 return Optional.absent();
182 public Optional<LogicalSwitches> getLogicalSwitches(InstanceIdentifier<?> iid, LogicalSwitchesKey logicalSwitchesKey) {
183 Preconditions.checkNotNull(iid);
184 Optional<HwvtepGlobalAugmentation> nodeOptional = getHwvtepGlobalAugmentation(iid);
185 if (nodeOptional.isPresent()) {
186 HwvtepGlobalAugmentation hgAugmentation = nodeOptional.get();
187 List<LogicalSwitches> lswitchList = null;
188 if (hgAugmentation != null) {
189 lswitchList = hgAugmentation.getLogicalSwitches();
191 if (lswitchList != null) {
192 for (LogicalSwitches lswitch: lswitchList) {
193 if (lswitch.getKey().equals(logicalSwitchesKey)) {
194 return Optional.fromNullable(lswitch);
199 return Optional.absent();
202 public Optional<Tunnels> getTunnels(InstanceIdentifier<?> iid, TunnelsKey tunnelsKey) {
203 Preconditions.checkNotNull(iid);
204 Optional<PhysicalSwitchAugmentation> psOptional = getPhysicalSwitchAugmentation(iid);
205 if (psOptional.isPresent()) {
206 PhysicalSwitchAugmentation psAugmentation = psOptional.get();
207 List<Tunnels> tunnelList = null;
208 if (psAugmentation != null) {
209 tunnelList = psAugmentation.getTunnels();
211 if (tunnelList != null) {
212 for (Tunnels tunnel: tunnelList) {
213 if (tunnel.getKey().equals(tunnelsKey)) {
214 return Optional.fromNullable(tunnel);
219 return Optional.absent();
222 public Optional<HwvtepPhysicalPortAugmentation> getPhysicalPortAugmentation(InstanceIdentifier<?> iid,
223 HwvtepNodeName hwvtepNodeName) {
224 Preconditions.checkNotNull(iid);
225 Optional<List<TerminationPoint>> nodeOptional = getTerminationPointList(iid);
226 if (nodeOptional.isPresent()) {
227 List<TerminationPoint> tpList = nodeOptional.get();
228 for (TerminationPoint tp : tpList) {
229 HwvtepPhysicalPortAugmentation hppAugmentation = tp.getAugmentation(HwvtepPhysicalPortAugmentation.class);
230 if (hppAugmentation != null && hppAugmentation.getHwvtepNodeName().equals(hwvtepNodeName)) {
231 return Optional.fromNullable(hppAugmentation);
235 return Optional.absent();
238 public Optional<HwvtepPhysicalLocatorAugmentation> getPhysicalLocatorAugmentation(InstanceIdentifier<?> iid,
239 IpAddress dstIp, Class<? extends EncapsulationTypeBase> encapType) {
240 Preconditions.checkNotNull(iid);
241 Optional<List<TerminationPoint>> nodeOptional = getTerminationPointList(iid);
242 if (nodeOptional.isPresent()) {
243 List<TerminationPoint> tpList = nodeOptional.get();
244 for (TerminationPoint tp : tpList) {
245 HwvtepPhysicalLocatorAugmentation hppAugmentation = tp.getAugmentation(HwvtepPhysicalLocatorAugmentation.class);
246 if (hppAugmentation != null && hppAugmentation.getDstIp().equals(dstIp)
247 && hppAugmentation.getEncapsulationType().equals(encapType)) {
248 return Optional.fromNullable(hppAugmentation);
252 return Optional.absent();
255 public Optional<LocalMcastMacs> getLocalMcastMacs(InstanceIdentifier<?> iid, LocalMcastMacsKey key) {
256 Preconditions.checkNotNull(iid);
257 Optional<HwvtepGlobalAugmentation> nodeOptional = getHwvtepGlobalAugmentation(iid);
258 if (nodeOptional.isPresent()) {
259 HwvtepGlobalAugmentation hgAugmentation = nodeOptional.get();
260 List<LocalMcastMacs> macList = null;
261 if (hgAugmentation != null) {
262 macList = hgAugmentation.getLocalMcastMacs();
264 if (macList != null) {
265 for (LocalMcastMacs mac: macList) {
266 if (mac.getKey().equals(key)) {
267 return Optional.fromNullable(mac);
272 return Optional.absent();
275 public Optional<RemoteMcastMacs> getRemoteMcastMacs(InstanceIdentifier<?> iid, RemoteMcastMacsKey key) {
276 Preconditions.checkNotNull(iid);
277 Optional<HwvtepGlobalAugmentation> nodeOptional = getHwvtepGlobalAugmentation(iid);
278 if (nodeOptional.isPresent()) {
279 HwvtepGlobalAugmentation hgAugmentation = nodeOptional.get();
280 List<RemoteMcastMacs> macList = null;
281 if (hgAugmentation != null) {
282 macList = hgAugmentation.getRemoteMcastMacs();
284 if (macList != null) {
285 for (RemoteMcastMacs mac: macList) {
286 if (mac.getKey().equals(key)) {
287 return Optional.fromNullable(mac);
292 return Optional.absent();
295 public Optional<LocalUcastMacs> getLocalUcastMacs(InstanceIdentifier<?> iid, LocalUcastMacsKey key) {
296 Preconditions.checkNotNull(iid);
297 Optional<HwvtepGlobalAugmentation> nodeOptional = getHwvtepGlobalAugmentation(iid);
298 if (nodeOptional.isPresent()) {
299 HwvtepGlobalAugmentation hgAugmentation = nodeOptional.get();
300 List<LocalUcastMacs> macList = null;
301 if (hgAugmentation != null) {
302 macList = hgAugmentation.getLocalUcastMacs();
304 if (macList != null) {
305 for (LocalUcastMacs mac: macList) {
306 if (mac.getKey().equals(key)) {
307 return Optional.fromNullable(mac);
312 return Optional.absent();
315 public Optional<RemoteUcastMacs> getRemoteUcastMacs(InstanceIdentifier<?> iid, RemoteUcastMacsKey key) {
316 Preconditions.checkNotNull(iid);
317 Optional<HwvtepGlobalAugmentation> nodeOptional = getHwvtepGlobalAugmentation(iid);
318 if (nodeOptional.isPresent()) {
319 HwvtepGlobalAugmentation hgAugmentation = nodeOptional.get();
320 List<RemoteUcastMacs> macList = null;
321 if (hgAugmentation != null) {
322 macList = hgAugmentation.getRemoteUcastMacs();
324 if (macList != null) {
325 for (RemoteUcastMacs mac: macList) {
326 if (mac.getKey().equals(key)) {
327 return Optional.fromNullable(mac);
332 return Optional.absent();
335 public Optional<HwvtepPhysicalLocatorAugmentation> getPhysicalLocatorAugmentation(InstanceIdentifier<TerminationPoint> iid) {
336 Optional<TerminationPoint> tp = HwvtepSouthboundUtil.readNode(transaction, iid);
337 if (tp.isPresent()) {
338 return Optional.fromNullable(tp.get().getAugmentation(HwvtepPhysicalLocatorAugmentation.class));
340 return Optional.absent();
343 public Optional<LogicalSwitches> getLogicalSwitches(InstanceIdentifier<LogicalSwitches> iid) {
344 Optional<LogicalSwitches> lswitch = HwvtepSouthboundUtil.readNode(transaction, iid);
348 public Optional<Tunnels> getTunnels(InstanceIdentifier<Tunnels> iid) {
349 Optional<Tunnels> tunnels = HwvtepSouthboundUtil.readNode(transaction, iid);
353 public ReadWriteTransaction getReadWriteTransaction() {
357 public void setPhysicalLocatorInFlight(InstanceIdentifier<TerminationPoint> iid,
359 inflightLocators.put(iid, uuid);
362 public UUID getPhysicalLocatorInFlight(InstanceIdentifier<TerminationPoint> iid) {
363 return inflightLocators.get(iid);
366 public HwvtepConnectionInstance getConnectionInstance() {
367 return connectionInstance;
370 public HwvtepDeviceInfo getDeviceInfo() {
374 public void updateCurrentTxData(Class<? extends Identifiable> cls, InstanceIdentifier key, UUID uuid) {
375 HwvtepSouthboundUtil.updateData(currentTxUUIDs, cls, key, uuid);
378 public void updateCurrentTxDeleteData(Class<? extends Identifiable> cls, InstanceIdentifier key) {
379 HwvtepSouthboundUtil.updateData(currentTxDeletedKeys, cls, key, Boolean.TRUE);
382 public UUID getUUIDFromCurrentTx(Class<? extends Identifiable> cls, InstanceIdentifier key) {
383 return HwvtepSouthboundUtil.getData(currentTxUUIDs, cls, key);
386 public boolean isKeyPartOfCurrentTx(Class<? extends Identifiable> cls, InstanceIdentifier key) {
387 return HwvtepSouthboundUtil.containsKey(currentTxUUIDs, cls, key);
390 public Set<InstanceIdentifier> getDeletedKeysInCurrentTx(Class<? extends Identifiable> cls) {
391 if (currentTxDeletedKeys.containsKey(cls)) {
392 return currentTxDeletedKeys.get(cls).keySet();
394 return Collections.EMPTY_SET;
397 public List<? extends Identifiable> getUpdatedData(final InstanceIdentifier<Node> key,
398 final Class<? extends Identifiable> cls) {
399 List<Identifiable> result = null;
400 if (modifiedData.get(key) != null && modifiedData.get(key).getLeft() != null) {
401 result = modifiedData.get(key).getLeft().get(cls);
403 if (result == null) {
404 result = Collections.EMPTY_LIST;
409 public List<? extends Identifiable> getDeletedData(final InstanceIdentifier<Node> key,
410 final Class<? extends Identifiable> cls) {
411 List<Identifiable> result = null;
412 if (modifiedData.get(key) != null && modifiedData.get(key).getRight() != null) {
413 result = modifiedData.get(key).getRight().get(cls);
415 if (result == null) {
416 result = Collections.EMPTY_LIST;
421 public void setModifiedData(final Map<InstanceIdentifier<Node>,
422 Pair<Map<Class<? extends Identifiable>, List<Identifiable>>,
423 Map<Class<? extends Identifiable>, List<Identifiable>>>> modifiedData) {
424 this.modifiedData = modifiedData;
427 public boolean isInReconciliation() {
428 return inReconciliation;
431 public void setInReconciliation(boolean inReconciliation) {
432 this.inReconciliation = inReconciliation;