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