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.Collection;
  13 import java.util.Collections;
  14 import java.util.HashMap;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import java.util.concurrent.ExecutionException;
  19
  20 import javax.annotation.Nonnull;
  21
  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;
  67
  68 import com.google.common.collect.Lists;
  69 import com.google.common.util.concurrent.ListenableFuture;
  70
  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;
  83
  84     OvsdbConnectionInstance(ConnectionInfo key,OvsdbClient client,TransactionInvoker txInvoker,
  85             InstanceIdentifier<Node> iid) {
  86         this.connectionInfo = key;
  87         this.client = client;
  88         this.txInvoker = txInvoker;
  89         // this.key = key;
  90         this.instanceIdentifier = iid;
  91     }
  92
  93     /**
  94      * Apply the given command to the given events, based on the given bridge state.
  95      *
  96      * @param command The command to run.
  97      * @param state The current bridge state.
  98      * @param events The events to process.
  99      */
 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);
 104         }
 105     }
 106
 107     /**
 108      * Apply the given command to the given modifications, based on the given bridge state.
 109      *
 110      * @param command The command to run.
 111      * @param state The current bridge state.
 112      * @param modifications The modifications to process.
 113      */
 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);
 118         }
 119     }
 120
 121     public void registerCallbacks() {
 122         if ( this.callback == null) {
 123             if (this.initialCreateData != null ) {
 124                 this.updateConnectionAttributes();
 125             }
 126
 127             try {
 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);
 134                 } else {
 135                     LOG.info("No database {} found on {}", database, connectionInfo);
 136                 }
 137             } catch (InterruptedException | ExecutionException e) {
 138                 LOG.warn("Exception attempting to registerCallbacks {}: ", connectionInfo, e);
 139             }
 140         }
 141     }
 142
 143     public void createTransactInvokers() {
 144         if (transactInvokers == null) {
 145             try {
 146                 transactInvokers = new HashMap<>();
 147                 DatabaseSchema dbSchema = getSchema(SouthboundConstants.OPEN_V_SWITCH).get();
 148                 if(dbSchema != null) {
 149                     transactInvokers.put(dbSchema, new TransactInvokerImpl(this,dbSchema));
 150                 }
 151             } catch (InterruptedException | ExecutionException e) {
 152                 LOG.warn("Exception attempting to createTransactionInvokers {}", connectionInfo, e);
 153             }
 154         }
 155     }
 156
 157     private void monitorAllTables(String database, DatabaseSchema dbSchema) {
 158         Set<String> tables = dbSchema.getTables();
 159         if (tables != null) {
 160             List<MonitorRequest> monitorRequests = Lists.newArrayList();
 161             for (String tableName : tables) {
 162                 LOG.info("Southbound monitoring table {} in {}", tableName, dbSchema.getName());
 163                 GenericTableSchema tableSchema = dbSchema.table(tableName, GenericTableSchema.class);
 164                 Set<String> columns = tableSchema.getColumns();
 165                 MonitorRequestBuilder<GenericTableSchema> monitorBuilder = MonitorRequestBuilder.builder(tableSchema);
 166                 for (String column : columns) {
 167                     monitorBuilder.addColumn(column);
 168                 }
 169                 monitorRequests.add(monitorBuilder.with(new MonitorSelect(true, true, true, true)).build());
 170             }
 171             this.callback.update(monitor(dbSchema, monitorRequests, callback),dbSchema);
 172         } else {
 173             LOG.warn("No tables for schema {} for database {} for key {}",dbSchema,database,connectionInfo);
 174         }
 175     }
 176
 177     private void updateConnectionAttributes() {
 178         LOG.debug("Update attributes of ovsdb node ip: {} port: {}",
 179                     this.initialCreateData.getConnectionInfo().getRemoteIp(),
 180                     this.initialCreateData.getConnectionInfo().getRemotePort());
 181         for ( Map.Entry<DatabaseSchema,TransactInvoker> entry: transactInvokers.entrySet()) {
 182
 183             TransactionBuilder transaction = new TransactionBuilder(this, entry.getKey());
 184
 185             // OpenVSwitchPart
 186             OpenVSwitch ovs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), OpenVSwitch.class);
 187
 188             List<OpenvswitchExternalIds> externalIds = this.initialCreateData.getOpenvswitchExternalIds();
 189
 190             stampInstanceIdentifier(transaction,this.instanceIdentifier.firstIdentifierOf(Node.class));
 191
 192             try {
 193                 ovs.setExternalIds(
 194                         YangUtils.convertYangKeyValueListToMap(externalIds, OpenvswitchExternalIds::getExternalIdKey,
 195                                 OpenvswitchExternalIds::getExternalIdValue));
 196                 Mutate<GenericTableSchema> mutate = op.mutate(ovs)
 197                             .addMutation(ovs.getExternalIdsColumn().getSchema(),
 198                                 Mutator.INSERT,
 199                                 ovs.getExternalIdsColumn().getData());
 200                 transaction.add(mutate);
 201             } catch (NullPointerException e) {
 202                 LOG.warn("Incomplete OVSDB Node external IDs", e);
 203             }
 204
 205
 206
 207             List<OpenvswitchOtherConfigs> otherConfigs = this.initialCreateData.getOpenvswitchOtherConfigs();
 208             if (otherConfigs != null) {
 209                 try {
 210                     ovs.setOtherConfig(YangUtils.convertYangKeyValueListToMap(otherConfigs,
 211                             OpenvswitchOtherConfigs::getOtherConfigKey,
 212                             OpenvswitchOtherConfigs::getOtherConfigValue));
 213                     transaction.add(op.mutate(ovs).addMutation(ovs.getOtherConfigColumn().getSchema(),
 214                         Mutator.INSERT,
 215                         ovs.getOtherConfigColumn().getData()));
 216                 } catch (NullPointerException e) {
 217                     LOG.warn("Incomplete OVSDB Node other_config", e);
 218                 }
 219             }
 220
 221             invoke(transaction);
 222         }
 223     }
 224
 225     private void stampInstanceIdentifier(TransactionBuilder transaction,InstanceIdentifier<Node> iid) {
 226         OpenVSwitch ovs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), OpenVSwitch.class);
 227         ovs.setExternalIds(Collections.<String,String>emptyMap());
 228         TransactUtils.stampInstanceIdentifier(transaction,
 229                 iid,
 230                 ovs.getSchema(),
 231                 ovs.getExternalIdsColumn().getSchema());
 232     }
 233
 234     private void invoke(TransactionBuilder txBuilder) {
 235         ListenableFuture<List<OperationResult>> result = txBuilder.execute();
 236         LOG.debug("invoke: tb: {}", txBuilder);
 237         if (txBuilder.getOperations().size() > 0) {
 238             try {
 239                 List<OperationResult> got = result.get();
 240                 LOG.debug("OVSDB transaction result: {}", got);
 241             } catch (Exception e) {
 242                 LOG.warn("Transact execution exception: ", e);
 243             }
 244             LOG.trace("invoke exit tb: {}", txBuilder);
 245         }
 246     }
 247
 248
 249     public ListenableFuture<List<String>> getDatabases() {
 250         return client.getDatabases();
 251     }
 252
 253     public ListenableFuture<DatabaseSchema> getSchema(String database) {
 254         return client.getSchema(database);
 255     }
 256
 257     public TransactionBuilder transactBuilder(DatabaseSchema dbSchema) {
 258         return client.transactBuilder(dbSchema);
 259     }
 260
 261     public ListenableFuture<List<OperationResult>> transact(
 262             DatabaseSchema dbSchema, List<Operation> operations) {
 263         return client.transact(dbSchema, operations);
 264     }
 265
 266     public <E extends TableSchema<E>> TableUpdates monitor(
 267             DatabaseSchema schema, List<MonitorRequest> monitorRequests,
 268             MonitorCallBack callback) {
 269         return client.monitor(schema, monitorRequests, callback);
 270     }
 271
 272     public void cancelMonitor(MonitorHandle handler) {
 273         client.cancelMonitor(handler);
 274     }
 275
 276     public void lock(String lockId, LockAquisitionCallback lockedCallBack,
 277             LockStolenCallback stolenCallback) {
 278         client.lock(lockId, lockedCallBack, stolenCallback);
 279     }
 280
 281     public ListenableFuture<Boolean> steal(String lockId) {
 282         return client.steal(lockId);
 283     }
 284
 285     public ListenableFuture<Boolean> unLock(String lockId) {
 286         return client.unLock(lockId);
 287     }
 288
 289     public void startEchoService(EchoServiceCallbackFilters callbackFilters) {
 290         client.startEchoService(callbackFilters);
 291     }
 292
 293     public void stopEchoService() {
 294         client.stopEchoService();
 295     }
 296
 297     public boolean isActive() {
 298         return client.isActive();
 299     }
 300
 301     public void disconnect() {
 302         client.disconnect();
 303     }
 304
 305     public DatabaseSchema getDatabaseSchema(String dbName) {
 306         return client.getDatabaseSchema(dbName);
 307     }
 308
 309     public <T extends TypedBaseTable<?>> T createTypedRowWrapper(Class<T> klazz) {
 310         return client.createTypedRowWrapper(klazz);
 311     }
 312
 313     public <T extends TypedBaseTable<?>> T createTypedRowWrapper(
 314             DatabaseSchema dbSchema, Class<T> klazz) {
 315         return client.createTypedRowWrapper(dbSchema, klazz);
 316     }
 317
 318     public <T extends TypedBaseTable<?>> T getTypedRowWrapper(Class<T> klazz,
 319             Row<GenericTableSchema> row) {
 320         return client.getTypedRowWrapper(klazz, row);
 321     }
 322
 323     public OvsdbConnectionInfo getConnectionInfo() {
 324         return client.getConnectionInfo();
 325     }
 326
 327     public ConnectionInfo getMDConnectionInfo() {
 328         return connectionInfo;
 329     }
 330
 331     public void setMDConnectionInfo(ConnectionInfo key) {
 332         this.connectionInfo = key;
 333     }
 334
 335     public InstanceIdentifier<Node> getInstanceIdentifier() {
 336         return instanceIdentifier;
 337     }
 338
 339     public NodeKey getNodeKey() {
 340         return getInstanceIdentifier().firstKeyOf(Node.class, NodeKey.class);
 341     }
 342
 343     public NodeId getNodeId() {
 344         return getNodeKey().getNodeId();
 345     }
 346
 347     public void setInstanceIdentifier(InstanceIdentifier<Node> iid) {
 348         this.instanceIdentifier = iid;
 349     }
 350
 351     @Override
 352     public <E extends TableSchema<E>> TableUpdates monitor(
 353             DatabaseSchema schema, List<MonitorRequest> monitorRequests,
 354             MonitorHandle monitorHandle, MonitorCallBack callback) {
 355         return null;
 356     }
 357
 358     public Entity getConnectedEntity() {
 359         return this.connectedEntity;
 360     }
 361
 362     public void setConnectedEntity(Entity entity ) {
 363         this.connectedEntity = entity;
 364     }
 365
 366     public Boolean hasOvsdbClient(OvsdbClient otherClient) {
 367         return client.equals(otherClient);
 368     }
 369
 370     public Boolean getHasDeviceOwnership() {
 371         return hasDeviceOwnership;
 372     }
 373
 374     public void setHasDeviceOwnership(Boolean hasDeviceOwnership) {
 375         if (hasDeviceOwnership != null) {
 376             this.hasDeviceOwnership = hasDeviceOwnership;
 377         }
 378     }
 379
 380     public void setDeviceOwnershipCandidateRegistration(@Nonnull EntityOwnershipCandidateRegistration registration) {
 381         this.deviceOwnershipCandidateRegistration = registration;
 382     }
 383
 384     public void closeDeviceOwnershipCandidateRegistration() {
 385         if (deviceOwnershipCandidateRegistration != null) {
 386             this.deviceOwnershipCandidateRegistration.close();
 387             setHasDeviceOwnership(Boolean.FALSE);
 388         }
 389     }
 390
 391     public OvsdbNodeAugmentation getOvsdbNodeAugmentation() {
 392         return this.initialCreateData;
 393     }
 394     public void setOvsdbNodeAugmentation(OvsdbNodeAugmentation ovsdbNodeCreateData) {
 395         this.initialCreateData = ovsdbNodeCreateData;
 396     }
 397
 398     @Override
 399     public void echo() {
 400         client.echo();
 401     }
 402 }