southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/OvsdbConnectionInstance.java

   1 /*
   2  * Copyright (c) 2015, 2016 Cisco Systems, Inc. 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.ovsdb.southbound;
   9
  10 import static org.opendaylight.ovsdb.lib.operations.Operations.op;
  11
  12 import java.util.Collections;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.Set;
  17 import java.util.concurrent.ExecutionException;
  18
  19 import javax.annotation.Nonnull;
  20
  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.ovsdb.utils.yang.YangUtils;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfo;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchExternalIds;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.OpenvswitchOtherConfigs;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  59 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  60 import org.slf4j.Logger;
  61 import org.slf4j.LoggerFactory;
  62
  63 import com.google.common.collect.Lists;
  64 import com.google.common.util.concurrent.ListenableFuture;
  65
  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;
  78
  79     OvsdbConnectionInstance(ConnectionInfo key,OvsdbClient client,TransactionInvoker txInvoker,
  80             InstanceIdentifier<Node> iid) {
  81         this.connectionInfo = key;
  82         this.client = client;
  83         this.txInvoker = txInvoker;
  84         // this.key = key;
  85         this.instanceIdentifier = iid;
  86     }
  87
  88     public void transact(TransactCommand command) {
  89         for (TransactInvoker transactInvoker: transactInvokers.values()) {
  90             transactInvoker.invoke(command);
  91         }
  92     }
  93
  94     public void registerCallbacks() {
  95         if ( this.callback == null) {
  96             if (this.initialCreateData != null ) {
  97                 this.updateConnectionAttributes();
  98             }
  99
 100             try {
 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);
 107                 } else {
 108                     LOG.info("No database {} found on {}", database, connectionInfo);
 109                 }
 110             } catch (InterruptedException | ExecutionException e) {
 111                 LOG.warn("Exception attempting to registerCallbacks {}: ", connectionInfo, e);
 112             }
 113         }
 114     }
 115
 116     public void createTransactInvokers() {
 117         if (transactInvokers == null) {
 118             try {
 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));
 125                     }
 126                 }
 127             } catch (InterruptedException | ExecutionException e) {
 128                 LOG.warn("Exception attempting to createTransactionInvokers {}", connectionInfo, e);
 129             }
 130         }
 131     }
 132
 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);
 144                 }
 145                 monitorRequests.add(monitorBuilder.with(new MonitorSelect(true, true, true, true)).build());
 146             }
 147             this.callback.update(monitor(dbSchema, monitorRequests, callback),dbSchema);
 148         } else {
 149             LOG.warn("No tables for schema {} for database {} for key {}",dbSchema,database,connectionInfo);
 150         }
 151     }
 152
 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()) {
 158
 159             TransactionBuilder transaction = new TransactionBuilder(this, entry.getKey());
 160
 161             // OpenVSwitchPart
 162             OpenVSwitch ovs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), OpenVSwitch.class);
 163
 164             List<OpenvswitchExternalIds> externalIds = this.initialCreateData.getOpenvswitchExternalIds();
 165
 166             stampInstanceIdentifier(transaction,this.instanceIdentifier.firstIdentifierOf(Node.class));
 167
 168             try {
 169                 ovs.setExternalIds(
 170                         YangUtils.convertYangKeyValueListToMap(externalIds, OpenvswitchExternalIds::getExternalIdKey,
 171                                 OpenvswitchExternalIds::getExternalIdValue));
 172                 Mutate<GenericTableSchema> mutate = op.mutate(ovs)
 173                             .addMutation(ovs.getExternalIdsColumn().getSchema(),
 174                                 Mutator.INSERT,
 175                                 ovs.getExternalIdsColumn().getData());
 176                 transaction.add(mutate);
 177             } catch (NullPointerException e) {
 178                 LOG.warn("Incomplete OVSDB Node external IDs", e);
 179             }
 180
 181
 182
 183             List<OpenvswitchOtherConfigs> otherConfigs = this.initialCreateData.getOpenvswitchOtherConfigs();
 184             if (otherConfigs != null) {
 185                 try {
 186                     ovs.setOtherConfig(YangUtils.convertYangKeyValueListToMap(otherConfigs,
 187                             OpenvswitchOtherConfigs::getOtherConfigKey,
 188                             OpenvswitchOtherConfigs::getOtherConfigValue));
 189                     transaction.add(op.mutate(ovs).addMutation(ovs.getOtherConfigColumn().getSchema(),
 190                         Mutator.INSERT,
 191                         ovs.getOtherConfigColumn().getData()));
 192                 } catch (NullPointerException e) {
 193                     LOG.warn("Incomplete OVSDB Node other_config", e);
 194                 }
 195             }
 196
 197             invoke(transaction);
 198         }
 199     }
 200
 201     private void stampInstanceIdentifier(TransactionBuilder transaction,InstanceIdentifier<Node> iid) {
 202         OpenVSwitch ovs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), OpenVSwitch.class);
 203         ovs.setExternalIds(Collections.<String,String>emptyMap());
 204         TransactUtils.stampInstanceIdentifier(transaction,
 205                 iid,
 206                 ovs.getSchema(),
 207                 ovs.getExternalIdsColumn().getSchema());
 208     }
 209
 210     private void invoke(TransactionBuilder txBuilder) {
 211         ListenableFuture<List<OperationResult>> result = txBuilder.execute();
 212         LOG.debug("invoke: tb: {}", txBuilder);
 213         if (txBuilder.getOperations().size() > 0) {
 214             try {
 215                 List<OperationResult> got = result.get();
 216                 LOG.debug("OVSDB transaction result: {}", got);
 217             } catch (Exception e) {
 218                 LOG.warn("Transact execution exception: ", e);
 219             }
 220             LOG.trace("invoke exit tb: {}", txBuilder);
 221         }
 222     }
 223
 224
 225     public ListenableFuture<List<String>> getDatabases() {
 226         return client.getDatabases();
 227     }
 228
 229     public ListenableFuture<DatabaseSchema> getSchema(String database) {
 230         return client.getSchema(database);
 231     }
 232
 233     public TransactionBuilder transactBuilder(DatabaseSchema dbSchema) {
 234         return client.transactBuilder(dbSchema);
 235     }
 236
 237     public ListenableFuture<List<OperationResult>> transact(
 238             DatabaseSchema dbSchema, List<Operation> operations) {
 239         return client.transact(dbSchema, operations);
 240     }
 241
 242     public <E extends TableSchema<E>> TableUpdates monitor(
 243             DatabaseSchema schema, List<MonitorRequest> monitorRequests,
 244             MonitorCallBack callback) {
 245         return client.monitor(schema, monitorRequests, callback);
 246     }
 247
 248     public void cancelMonitor(MonitorHandle handler) {
 249         client.cancelMonitor(handler);
 250     }
 251
 252     public void lock(String lockId, LockAquisitionCallback lockedCallBack,
 253             LockStolenCallback stolenCallback) {
 254         client.lock(lockId, lockedCallBack, stolenCallback);
 255     }
 256
 257     public ListenableFuture<Boolean> steal(String lockId) {
 258         return client.steal(lockId);
 259     }
 260
 261     public ListenableFuture<Boolean> unLock(String lockId) {
 262         return client.unLock(lockId);
 263     }
 264
 265     public void startEchoService(EchoServiceCallbackFilters callbackFilters) {
 266         client.startEchoService(callbackFilters);
 267     }
 268
 269     public void stopEchoService() {
 270         client.stopEchoService();
 271     }
 272
 273     public boolean isActive() {
 274         return client.isActive();
 275     }
 276
 277     public void disconnect() {
 278         client.disconnect();
 279     }
 280
 281     public DatabaseSchema getDatabaseSchema(String dbName) {
 282         return client.getDatabaseSchema(dbName);
 283     }
 284
 285     public <T extends TypedBaseTable<?>> T createTypedRowWrapper(Class<T> klazz) {
 286         return client.createTypedRowWrapper(klazz);
 287     }
 288
 289     public <T extends TypedBaseTable<?>> T createTypedRowWrapper(
 290             DatabaseSchema dbSchema, Class<T> klazz) {
 291         return client.createTypedRowWrapper(dbSchema, klazz);
 292     }
 293
 294     public <T extends TypedBaseTable<?>> T getTypedRowWrapper(Class<T> klazz,
 295             Row<GenericTableSchema> row) {
 296         return client.getTypedRowWrapper(klazz, row);
 297     }
 298
 299     public OvsdbConnectionInfo getConnectionInfo() {
 300         return client.getConnectionInfo();
 301     }
 302
 303     public ConnectionInfo getMDConnectionInfo() {
 304         return connectionInfo;
 305     }
 306
 307     public void setMDConnectionInfo(ConnectionInfo key) {
 308         this.connectionInfo = key;
 309     }
 310
 311     public InstanceIdentifier<Node> getInstanceIdentifier() {
 312         return instanceIdentifier;
 313     }
 314
 315     public NodeKey getNodeKey() {
 316         return getInstanceIdentifier().firstKeyOf(Node.class, NodeKey.class);
 317     }
 318
 319     public NodeId getNodeId() {
 320         return getNodeKey().getNodeId();
 321     }
 322
 323     public void setInstanceIdentifier(InstanceIdentifier<Node> iid) {
 324         this.instanceIdentifier = iid;
 325     }
 326
 327     @Override
 328     public <E extends TableSchema<E>> TableUpdates monitor(
 329             DatabaseSchema schema, List<MonitorRequest> monitorRequests,
 330             MonitorHandle monitorHandle, MonitorCallBack callback) {
 331         return null;
 332     }
 333
 334     public Entity getConnectedEntity() {
 335         return this.connectedEntity;
 336     }
 337
 338     public void setConnectedEntity(Entity entity ) {
 339         this.connectedEntity = entity;
 340     }
 341
 342     public Boolean hasOvsdbClient(OvsdbClient otherClient) {
 343         return client.equals(otherClient);
 344     }
 345
 346     public Boolean getHasDeviceOwnership() {
 347         return hasDeviceOwnership;
 348     }
 349
 350     public void setHasDeviceOwnership(Boolean hasDeviceOwnership) {
 351         if (hasDeviceOwnership != null) {
 352             this.hasDeviceOwnership = hasDeviceOwnership;
 353         }
 354     }
 355
 356     public void setDeviceOwnershipCandidateRegistration(@Nonnull EntityOwnershipCandidateRegistration registration) {
 357         this.deviceOwnershipCandidateRegistration = registration;
 358     }
 359
 360     public void closeDeviceOwnershipCandidateRegistration() {
 361         if (deviceOwnershipCandidateRegistration != null) {
 362             this.deviceOwnershipCandidateRegistration.close();
 363             setHasDeviceOwnership(Boolean.FALSE);
 364         }
 365     }
 366
 367     public OvsdbNodeAugmentation getOvsdbNodeAugmentation() {
 368         return this.initialCreateData;
 369     }
 370     public void setOvsdbNodeAugmentation(OvsdbNodeAugmentation ovsdbNodeCreateData) {
 371         this.initialCreateData = ovsdbNodeCreateData;
 372     }
 373 }