2 * Copyright (c) 2015, 2016 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
8 package org.opendaylight.ovsdb.southbound;
10 import static org.opendaylight.ovsdb.lib.operations.Operations.op;
12 import java.util.Collection;
13 import java.util.Collections;
14 import java.util.HashMap;
15 import java.util.List;
18 import java.util.concurrent.ExecutionException;
20 import javax.annotation.Nonnull;
22 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
23 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
24 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
25 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
26 import org.opendaylight.ovsdb.lib.EchoServiceCallbackFilters;
27 import org.opendaylight.ovsdb.lib.LockAquisitionCallback;
28 import org.opendaylight.ovsdb.lib.LockStolenCallback;
29 import org.opendaylight.ovsdb.lib.MonitorCallBack;
30 import org.opendaylight.ovsdb.lib.MonitorHandle;
31 import org.opendaylight.ovsdb.lib.OvsdbClient;
32 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
33 import org.opendaylight.ovsdb.lib.message.MonitorRequest;
34 import org.opendaylight.ovsdb.lib.message.MonitorRequestBuilder;
35 import org.opendaylight.ovsdb.lib.message.MonitorSelect;
36 import org.opendaylight.ovsdb.lib.message.TableUpdates;
37 import org.opendaylight.ovsdb.lib.notation.Mutator;
38 import org.opendaylight.ovsdb.lib.notation.Row;
39 import org.opendaylight.ovsdb.lib.operations.Mutate;
40 import org.opendaylight.ovsdb.lib.operations.Operation;
41 import org.opendaylight.ovsdb.lib.operations.OperationResult;
42 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
43 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
44 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
45 import org.opendaylight.ovsdb.lib.schema.TableSchema;
46 import org.opendaylight.ovsdb.lib.schema.typed.TypedBaseTable;
47 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
48 import org.opendaylight.ovsdb.schema.openvswitch.OpenVSwitch;
49 import org.opendaylight.ovsdb.southbound.ovsdb.transact.BridgeOperationalState;
50 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactCommand;
51 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactInvoker;
52 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactInvokerImpl;
53 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactUtils;
54 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
55 import org.opendaylight.ovsdb.utils.yang.YangUtils;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchExternalIds;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchOtherConfigs;
60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
63 import org.opendaylight.yangtools.yang.binding.DataObject;
64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
65 import org.slf4j.Logger;
66 import org.slf4j.LoggerFactory;
68 import com.google.common.collect.Lists;
69 import com.google.common.util.concurrent.ListenableFuture;
71 public class OvsdbConnectionInstance implements OvsdbClient {
72 private static final Logger LOG = LoggerFactory.getLogger(OvsdbConnectionInstance.class);
73 private OvsdbClient client;
74 private ConnectionInfo connectionInfo;
75 private TransactionInvoker txInvoker;
76 private Map<DatabaseSchema,TransactInvoker> transactInvokers;
77 private MonitorCallBack callback;
78 private InstanceIdentifier<Node> instanceIdentifier;
79 private volatile boolean hasDeviceOwnership = false;
80 private Entity connectedEntity;
81 private EntityOwnershipCandidateRegistration deviceOwnershipCandidateRegistration;
82 private OvsdbNodeAugmentation initialCreateData = null;
84 OvsdbConnectionInstance(ConnectionInfo key,OvsdbClient client,TransactionInvoker txInvoker,
85 InstanceIdentifier<Node> iid) {
86 this.connectionInfo = key;
88 this.txInvoker = txInvoker;
90 this.instanceIdentifier = iid;
94 * Apply the given command to the given events, based on the given bridge state.
96 * @param command The command to run.
97 * @param state The current bridge state.
98 * @param events The events to process.
100 public void transact(TransactCommand command, BridgeOperationalState state,
101 AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> events) {
102 for (TransactInvoker transactInvoker : transactInvokers.values()) {
103 transactInvoker.invoke(command, state, events);
108 * Apply the given command to the given modifications, based on the given bridge state.
110 * @param command The command to run.
111 * @param state The current bridge state.
112 * @param modifications The modifications to process.
114 public void transact(TransactCommand command, BridgeOperationalState state,
115 Collection<DataTreeModification<Node>> modifications) {
116 for (TransactInvoker transactInvoker : transactInvokers.values()) {
117 transactInvoker.invoke(command, state, modifications);
121 public void registerCallbacks() {
122 if ( this.callback == null) {
123 if (this.initialCreateData != null ) {
124 this.updateConnectionAttributes();
128 String database = SouthboundConstants.OPEN_V_SWITCH;
129 DatabaseSchema dbSchema = getSchema(database).get();
130 if (dbSchema != null) {
131 LOG.info("Monitoring database: {}", database);
132 callback = new OvsdbMonitorCallback(this, txInvoker);
133 monitorAllTables(database, dbSchema);
135 LOG.info("No database {} found on {}", database, connectionInfo);
137 } catch (InterruptedException | ExecutionException e) {
138 LOG.warn("Exception attempting to registerCallbacks {}: ", connectionInfo, e);
143 public void createTransactInvokers() {
144 if (transactInvokers == null) {
146 transactInvokers = new HashMap<>();
147 List<String> databases = getDatabases().get();
148 for (String database : databases) {
149 DatabaseSchema dbSchema = getSchema(database).get();
150 if (dbSchema != null) {
151 transactInvokers.put(dbSchema, new TransactInvokerImpl(this,dbSchema));
154 } catch (InterruptedException | ExecutionException e) {
155 LOG.warn("Exception attempting to createTransactionInvokers {}", connectionInfo, e);
160 private void monitorAllTables(String database, DatabaseSchema dbSchema) {
161 Set<String> tables = dbSchema.getTables();
162 if (tables != null) {
163 List<MonitorRequest> monitorRequests = Lists.newArrayList();
164 for (String tableName : tables) {
165 LOG.info("Southbound monitoring table {} in {}", tableName, dbSchema.getName());
166 GenericTableSchema tableSchema = dbSchema.table(tableName, GenericTableSchema.class);
167 Set<String> columns = tableSchema.getColumns();
168 MonitorRequestBuilder<GenericTableSchema> monitorBuilder = MonitorRequestBuilder.builder(tableSchema);
169 for (String column : columns) {
170 monitorBuilder.addColumn(column);
172 monitorRequests.add(monitorBuilder.with(new MonitorSelect(true, true, true, true)).build());
174 this.callback.update(monitor(dbSchema, monitorRequests, callback),dbSchema);
176 LOG.warn("No tables for schema {} for database {} for key {}",dbSchema,database,connectionInfo);
180 private void updateConnectionAttributes() {
181 LOG.debug("Update attributes of ovsdb node ip: {} port: {}",
182 this.initialCreateData.getConnectionInfo().getRemoteIp(),
183 this.initialCreateData.getConnectionInfo().getRemotePort());
184 for ( Map.Entry<DatabaseSchema,TransactInvoker> entry: transactInvokers.entrySet()) {
186 TransactionBuilder transaction = new TransactionBuilder(this, entry.getKey());
189 OpenVSwitch ovs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), OpenVSwitch.class);
191 List<OpenvswitchExternalIds> externalIds = this.initialCreateData.getOpenvswitchExternalIds();
193 stampInstanceIdentifier(transaction,this.instanceIdentifier.firstIdentifierOf(Node.class));
197 YangUtils.convertYangKeyValueListToMap(externalIds, OpenvswitchExternalIds::getExternalIdKey,
198 OpenvswitchExternalIds::getExternalIdValue));
199 Mutate<GenericTableSchema> mutate = op.mutate(ovs)
200 .addMutation(ovs.getExternalIdsColumn().getSchema(),
202 ovs.getExternalIdsColumn().getData());
203 transaction.add(mutate);
204 } catch (NullPointerException e) {
205 LOG.warn("Incomplete OVSDB Node external IDs", e);
210 List<OpenvswitchOtherConfigs> otherConfigs = this.initialCreateData.getOpenvswitchOtherConfigs();
211 if (otherConfigs != null) {
213 ovs.setOtherConfig(YangUtils.convertYangKeyValueListToMap(otherConfigs,
214 OpenvswitchOtherConfigs::getOtherConfigKey,
215 OpenvswitchOtherConfigs::getOtherConfigValue));
216 transaction.add(op.mutate(ovs).addMutation(ovs.getOtherConfigColumn().getSchema(),
218 ovs.getOtherConfigColumn().getData()));
219 } catch (NullPointerException e) {
220 LOG.warn("Incomplete OVSDB Node other_config", e);
228 private void stampInstanceIdentifier(TransactionBuilder transaction,InstanceIdentifier<Node> iid) {
229 OpenVSwitch ovs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), OpenVSwitch.class);
230 ovs.setExternalIds(Collections.<String,String>emptyMap());
231 TransactUtils.stampInstanceIdentifier(transaction,
234 ovs.getExternalIdsColumn().getSchema());
237 private void invoke(TransactionBuilder txBuilder) {
238 ListenableFuture<List<OperationResult>> result = txBuilder.execute();
239 LOG.debug("invoke: tb: {}", txBuilder);
240 if (txBuilder.getOperations().size() > 0) {
242 List<OperationResult> got = result.get();
243 LOG.debug("OVSDB transaction result: {}", got);
244 } catch (Exception e) {
245 LOG.warn("Transact execution exception: ", e);
247 LOG.trace("invoke exit tb: {}", txBuilder);
252 public ListenableFuture<List<String>> getDatabases() {
253 return client.getDatabases();
256 public ListenableFuture<DatabaseSchema> getSchema(String database) {
257 return client.getSchema(database);
260 public TransactionBuilder transactBuilder(DatabaseSchema dbSchema) {
261 return client.transactBuilder(dbSchema);
264 public ListenableFuture<List<OperationResult>> transact(
265 DatabaseSchema dbSchema, List<Operation> operations) {
266 return client.transact(dbSchema, operations);
269 public <E extends TableSchema<E>> TableUpdates monitor(
270 DatabaseSchema schema, List<MonitorRequest> monitorRequests,
271 MonitorCallBack callback) {
272 return client.monitor(schema, monitorRequests, callback);
275 public void cancelMonitor(MonitorHandle handler) {
276 client.cancelMonitor(handler);
279 public void lock(String lockId, LockAquisitionCallback lockedCallBack,
280 LockStolenCallback stolenCallback) {
281 client.lock(lockId, lockedCallBack, stolenCallback);
284 public ListenableFuture<Boolean> steal(String lockId) {
285 return client.steal(lockId);
288 public ListenableFuture<Boolean> unLock(String lockId) {
289 return client.unLock(lockId);
292 public void startEchoService(EchoServiceCallbackFilters callbackFilters) {
293 client.startEchoService(callbackFilters);
296 public void stopEchoService() {
297 client.stopEchoService();
300 public boolean isActive() {
301 return client.isActive();
304 public void disconnect() {
308 public DatabaseSchema getDatabaseSchema(String dbName) {
309 return client.getDatabaseSchema(dbName);
312 public <T extends TypedBaseTable<?>> T createTypedRowWrapper(Class<T> klazz) {
313 return client.createTypedRowWrapper(klazz);
316 public <T extends TypedBaseTable<?>> T createTypedRowWrapper(
317 DatabaseSchema dbSchema, Class<T> klazz) {
318 return client.createTypedRowWrapper(dbSchema, klazz);
321 public <T extends TypedBaseTable<?>> T getTypedRowWrapper(Class<T> klazz,
322 Row<GenericTableSchema> row) {
323 return client.getTypedRowWrapper(klazz, row);
326 public OvsdbConnectionInfo getConnectionInfo() {
327 return client.getConnectionInfo();
330 public ConnectionInfo getMDConnectionInfo() {
331 return connectionInfo;
334 public void setMDConnectionInfo(ConnectionInfo key) {
335 this.connectionInfo = key;
338 public InstanceIdentifier<Node> getInstanceIdentifier() {
339 return instanceIdentifier;
342 public NodeKey getNodeKey() {
343 return getInstanceIdentifier().firstKeyOf(Node.class, NodeKey.class);
346 public NodeId getNodeId() {
347 return getNodeKey().getNodeId();
350 public void setInstanceIdentifier(InstanceIdentifier<Node> iid) {
351 this.instanceIdentifier = iid;
355 public <E extends TableSchema<E>> TableUpdates monitor(
356 DatabaseSchema schema, List<MonitorRequest> monitorRequests,
357 MonitorHandle monitorHandle, MonitorCallBack callback) {
361 public Entity getConnectedEntity() {
362 return this.connectedEntity;
365 public void setConnectedEntity(Entity entity ) {
366 this.connectedEntity = entity;
369 public Boolean hasOvsdbClient(OvsdbClient otherClient) {
370 return client.equals(otherClient);
373 public Boolean getHasDeviceOwnership() {
374 return hasDeviceOwnership;
377 public void setHasDeviceOwnership(Boolean hasDeviceOwnership) {
378 if (hasDeviceOwnership != null) {
379 this.hasDeviceOwnership = hasDeviceOwnership;
383 public void setDeviceOwnershipCandidateRegistration(@Nonnull EntityOwnershipCandidateRegistration registration) {
384 this.deviceOwnershipCandidateRegistration = registration;
387 public void closeDeviceOwnershipCandidateRegistration() {
388 if (deviceOwnershipCandidateRegistration != null) {
389 this.deviceOwnershipCandidateRegistration.close();
390 setHasDeviceOwnership(Boolean.FALSE);
394 public OvsdbNodeAugmentation getOvsdbNodeAugmentation() {
395 return this.initialCreateData;
397 public void setOvsdbNodeAugmentation(OvsdbNodeAugmentation ovsdbNodeCreateData) {
398 this.initialCreateData = ovsdbNodeCreateData;