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
8 package org.opendaylight.ovsdb.southbound;
10 import static org.opendaylight.ovsdb.lib.operations.Operations.op;
12 import java.util.Collections;
13 import java.util.HashMap;
14 import java.util.List;
17 import java.util.concurrent.ExecutionException;
19 import javax.annotation.Nonnull;
21 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
22 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
23 import org.opendaylight.ovsdb.lib.EchoServiceCallbackFilters;
24 import org.opendaylight.ovsdb.lib.LockAquisitionCallback;
25 import org.opendaylight.ovsdb.lib.LockStolenCallback;
26 import org.opendaylight.ovsdb.lib.MonitorCallBack;
27 import org.opendaylight.ovsdb.lib.MonitorHandle;
28 import org.opendaylight.ovsdb.lib.OvsdbClient;
29 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
30 import org.opendaylight.ovsdb.lib.message.MonitorRequest;
31 import org.opendaylight.ovsdb.lib.message.MonitorRequestBuilder;
32 import org.opendaylight.ovsdb.lib.message.MonitorSelect;
33 import org.opendaylight.ovsdb.lib.message.TableUpdates;
34 import org.opendaylight.ovsdb.lib.notation.Mutator;
35 import org.opendaylight.ovsdb.lib.notation.Row;
36 import org.opendaylight.ovsdb.lib.operations.Mutate;
37 import org.opendaylight.ovsdb.lib.operations.Operation;
38 import org.opendaylight.ovsdb.lib.operations.OperationResult;
39 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
40 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
41 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
42 import org.opendaylight.ovsdb.lib.schema.TableSchema;
43 import org.opendaylight.ovsdb.lib.schema.typed.TypedBaseTable;
44 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
45 import org.opendaylight.ovsdb.schema.openvswitch.OpenVSwitch;
46 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactCommand;
47 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactInvoker;
48 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactInvokerImpl;
49 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactUtils;
50 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchExternalIds;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchOtherConfigs;
55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
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.yangtools.yang.binding.InstanceIdentifier;
59 import org.slf4j.Logger;
60 import org.slf4j.LoggerFactory;
62 import com.google.common.collect.ImmutableMap;
63 import com.google.common.collect.Lists;
64 import com.google.common.util.concurrent.ListenableFuture;
66 public class OvsdbConnectionInstance implements OvsdbClient {
67 private static final Logger LOG = LoggerFactory.getLogger(OvsdbConnectionInstance.class);
68 private OvsdbClient client;
69 private ConnectionInfo connectionInfo;
70 private TransactionInvoker txInvoker;
71 private Map<DatabaseSchema,TransactInvoker> transactInvokers;
72 private MonitorCallBack callback;
73 private InstanceIdentifier<Node> instanceIdentifier;
74 private volatile boolean hasDeviceOwnership = false;
75 private Entity connectedEntity;
76 private EntityOwnershipCandidateRegistration deviceOwnershipCandidateRegistration;
77 private OvsdbNodeAugmentation initialCreateData = null;
79 OvsdbConnectionInstance(ConnectionInfo key,OvsdbClient client,TransactionInvoker txInvoker,
80 InstanceIdentifier<Node> iid) {
81 this.connectionInfo = key;
83 this.txInvoker = txInvoker;
85 this.instanceIdentifier = iid;
88 public void transact(TransactCommand command) {
89 for (TransactInvoker transactInvoker: transactInvokers.values()) {
90 transactInvoker.invoke(command);
94 public void registerCallbacks() {
95 if ( this.callback == null) {
96 if (this.initialCreateData != null ) {
97 this.updateConnectionAttributes();
101 String database = SouthboundConstants.OPEN_V_SWITCH;
102 DatabaseSchema dbSchema = getSchema(database).get();
103 if (dbSchema != null) {
104 LOG.info("Monitoring database: {}", database);
105 callback = new OvsdbMonitorCallback(this, txInvoker);
106 monitorAllTables(database, dbSchema);
108 LOG.info("No database {} found on {}", database, connectionInfo);
110 } catch (InterruptedException | ExecutionException e) {
111 LOG.warn("Exception attempting to registerCallbacks {}: ", connectionInfo, e);
116 public void createTransactInvokers() {
117 if (transactInvokers == null) {
119 transactInvokers = new HashMap<>();
120 List<String> databases = getDatabases().get();
121 for (String database : databases) {
122 DatabaseSchema dbSchema = getSchema(database).get();
123 if (dbSchema != null) {
124 transactInvokers.put(dbSchema, new TransactInvokerImpl(this,dbSchema));
127 } catch (InterruptedException | ExecutionException e) {
128 LOG.warn("Exception attempting to createTransactionInvokers {}: {}",connectionInfo,e);
133 private void monitorAllTables(String database, DatabaseSchema dbSchema) {
134 Set<String> tables = dbSchema.getTables();
135 if (tables != null) {
136 List<MonitorRequest> monitorRequests = Lists.newArrayList();
137 for (String tableName : tables) {
138 LOG.info("Southbound monitoring table {} in {}", tableName, dbSchema.getName());
139 GenericTableSchema tableSchema = dbSchema.table(tableName, GenericTableSchema.class);
140 Set<String> columns = tableSchema.getColumns();
141 MonitorRequestBuilder<GenericTableSchema> monitorBuilder = MonitorRequestBuilder.builder(tableSchema);
142 for (String column : columns) {
143 monitorBuilder.addColumn(column);
145 monitorRequests.add(monitorBuilder.with(new MonitorSelect(true, true, true, true)).build());
147 this.callback.update(monitor(dbSchema, monitorRequests, callback),dbSchema);
149 LOG.warn("No tables for schema {} for database {} for key {}",dbSchema,database,connectionInfo);
153 private void updateConnectionAttributes() {
154 LOG.debug("Update attributes of ovsdb node ip: {} port: {}",
155 this.initialCreateData.getConnectionInfo().getRemoteIp(),
156 this.initialCreateData.getConnectionInfo().getRemotePort());
157 for ( Map.Entry<DatabaseSchema,TransactInvoker> entry: transactInvokers.entrySet()) {
159 TransactionBuilder transaction = new TransactionBuilder(this, entry.getKey());
162 OpenVSwitch ovs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), OpenVSwitch.class);
163 Map<String, String> externalIdsMap = new HashMap<>();
165 List<OpenvswitchExternalIds> externalIds = this.initialCreateData.getOpenvswitchExternalIds();
167 if (externalIds != null) {
168 for (OpenvswitchExternalIds externalId : externalIds) {
169 externalIdsMap.put(externalId.getExternalIdKey(), externalId.getExternalIdValue());
173 stampInstanceIdentifier(transaction,this.instanceIdentifier.firstIdentifierOf(Node.class));
176 ovs.setExternalIds(ImmutableMap.copyOf(externalIdsMap));
177 Mutate<GenericTableSchema> mutate = op.mutate(ovs)
178 .addMutation(ovs.getExternalIdsColumn().getSchema(),
180 ovs.getExternalIdsColumn().getData());
181 transaction.add(mutate);
182 } catch (NullPointerException e) {
183 LOG.warn("Incomplete OVSDB Node external IDs");
188 List<OpenvswitchOtherConfigs> otherConfigs = this.initialCreateData.getOpenvswitchOtherConfigs();
189 if (otherConfigs != null) {
190 Map<String, String> otherConfigsMap = new HashMap<>();
191 for (OpenvswitchOtherConfigs otherConfig : otherConfigs) {
192 otherConfigsMap.put(otherConfig.getOtherConfigKey(), otherConfig.getOtherConfigValue());
195 ovs.setOtherConfig(ImmutableMap.copyOf(otherConfigsMap));
196 transaction.add(op.mutate(ovs).addMutation(ovs.getOtherConfigColumn().getSchema(),
198 ovs.getOtherConfigColumn().getData()));
199 } catch (NullPointerException e) {
200 LOG.warn("Incomplete OVSDB Node other_config", e);
208 private void stampInstanceIdentifier(TransactionBuilder transaction,InstanceIdentifier<Node> iid) {
209 OpenVSwitch ovs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), OpenVSwitch.class);
210 ovs.setExternalIds(Collections.<String,String>emptyMap());
211 TransactUtils.stampInstanceIdentifier(transaction,
214 ovs.getExternalIdsColumn().getSchema());
217 private void invoke(TransactionBuilder txBuilder) {
218 ListenableFuture<List<OperationResult>> result = txBuilder.execute();
219 LOG.debug("invoke: tb: {}", txBuilder);
220 if (txBuilder.getOperations().size() > 0) {
222 List<OperationResult> got = result.get();
223 LOG.debug("OVSDB transaction result: {}", got);
224 } catch (Exception e) {
225 LOG.warn("Transact execution exception: ", e);
227 LOG.trace("invoke exit tb: {}", txBuilder);
232 public ListenableFuture<List<String>> getDatabases() {
233 return client.getDatabases();
236 public ListenableFuture<DatabaseSchema> getSchema(String database) {
237 return client.getSchema(database);
240 public TransactionBuilder transactBuilder(DatabaseSchema dbSchema) {
241 return client.transactBuilder(dbSchema);
244 public ListenableFuture<List<OperationResult>> transact(
245 DatabaseSchema dbSchema, List<Operation> operations) {
246 return client.transact(dbSchema, operations);
249 public <E extends TableSchema<E>> TableUpdates monitor(
250 DatabaseSchema schema, List<MonitorRequest> monitorRequests,
251 MonitorCallBack callback) {
252 return client.monitor(schema, monitorRequests, callback);
255 public void cancelMonitor(MonitorHandle handler) {
256 client.cancelMonitor(handler);
259 public void lock(String lockId, LockAquisitionCallback lockedCallBack,
260 LockStolenCallback stolenCallback) {
261 client.lock(lockId, lockedCallBack, stolenCallback);
264 public ListenableFuture<Boolean> steal(String lockId) {
265 return client.steal(lockId);
268 public ListenableFuture<Boolean> unLock(String lockId) {
269 return client.unLock(lockId);
272 public void startEchoService(EchoServiceCallbackFilters callbackFilters) {
273 client.startEchoService(callbackFilters);
276 public void stopEchoService() {
277 client.stopEchoService();
280 public boolean isActive() {
281 return client.isActive();
284 public void disconnect() {
288 public DatabaseSchema getDatabaseSchema(String dbName) {
289 return client.getDatabaseSchema(dbName);
292 public <T extends TypedBaseTable<?>> T createTypedRowWrapper(Class<T> klazz) {
293 return client.createTypedRowWrapper(klazz);
296 public <T extends TypedBaseTable<?>> T createTypedRowWrapper(
297 DatabaseSchema dbSchema, Class<T> klazz) {
298 return client.createTypedRowWrapper(dbSchema, klazz);
301 public <T extends TypedBaseTable<?>> T getTypedRowWrapper(Class<T> klazz,
302 Row<GenericTableSchema> row) {
303 return client.getTypedRowWrapper(klazz, row);
306 public OvsdbConnectionInfo getConnectionInfo() {
307 return client.getConnectionInfo();
310 public ConnectionInfo getMDConnectionInfo() {
311 return connectionInfo;
314 public void setMDConnectionInfo(ConnectionInfo key) {
315 this.connectionInfo = key;
318 public InstanceIdentifier<Node> getInstanceIdentifier() {
319 return instanceIdentifier;
322 public NodeKey getNodeKey() {
323 return getInstanceIdentifier().firstKeyOf(Node.class, NodeKey.class);
326 public NodeId getNodeId() {
327 return getNodeKey().getNodeId();
330 public void setInstanceIdentifier(InstanceIdentifier<Node> iid) {
331 this.instanceIdentifier = iid;
335 public <E extends TableSchema<E>> TableUpdates monitor(
336 DatabaseSchema schema, List<MonitorRequest> monitorRequests,
337 MonitorHandle monitorHandle, MonitorCallBack callback) {
341 public Entity getConnectedEntity() {
342 return this.connectedEntity;
345 public void setConnectedEntity(Entity entity ) {
346 this.connectedEntity = entity;
349 public Boolean hasOvsdbClient(OvsdbClient otherClient) {
350 return client.equals(otherClient);
353 public Boolean getHasDeviceOwnership() {
354 return hasDeviceOwnership;
357 public void setHasDeviceOwnership(Boolean hasDeviceOwnership) {
358 if (hasDeviceOwnership != null) {
359 this.hasDeviceOwnership = hasDeviceOwnership;
363 public void setDeviceOwnershipCandidateRegistration(@Nonnull EntityOwnershipCandidateRegistration registration) {
364 this.deviceOwnershipCandidateRegistration = registration;
367 public void closeDeviceOwnershipCandidateRegistration() {
368 if (deviceOwnershipCandidateRegistration != null) {
369 this.deviceOwnershipCandidateRegistration.close();
370 setHasDeviceOwnership(Boolean.FALSE);
374 public OvsdbNodeAugmentation getOvsdbNodeAugmentation() {
375 return this.initialCreateData;
377 public void setOvsdbNodeAugmentation(OvsdbNodeAugmentation ovsdbNodeCreateData) {
378 this.initialCreateData = ovsdbNodeCreateData;