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

   1 /*
   2  * Copyright (c) 2015 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.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;
  61
  62 import com.google.common.collect.ImmutableMap;
  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             Map<String, String> externalIdsMap = new HashMap<>();
 164
 165             List<OpenvswitchExternalIds> externalIds = this.initialCreateData.getOpenvswitchExternalIds();
 166
 167             if (externalIds != null) {
 168                 for (OpenvswitchExternalIds externalId : externalIds) {
 169                     externalIdsMap.put(externalId.getExternalIdKey(), externalId.getExternalIdValue());
 170                 }
 171             }
 172
 173             stampInstanceIdentifier(transaction,this.instanceIdentifier.firstIdentifierOf(Node.class));
 174
 175             try {
 176                 ovs.setExternalIds(ImmutableMap.copyOf(externalIdsMap));
 177                 Mutate<GenericTableSchema> mutate = op.mutate(ovs)
 178                             .addMutation(ovs.getExternalIdsColumn().getSchema(),
 179                                 Mutator.INSERT,
 180                                 ovs.getExternalIdsColumn().getData());
 181                 transaction.add(mutate);
 182             } catch (NullPointerException e) {
 183                 LOG.warn("Incomplete OVSDB Node external IDs");
 184             }
 185
 186
 187
 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());
 193                 }
 194                 try {
 195                     ovs.setOtherConfig(ImmutableMap.copyOf(otherConfigsMap));
 196                     transaction.add(op.mutate(ovs).addMutation(ovs.getOtherConfigColumn().getSchema(),
 197                         Mutator.INSERT,
 198                         ovs.getOtherConfigColumn().getData()));
 199                 } catch (NullPointerException e) {
 200                     LOG.warn("Incomplete OVSDB Node other_config", e);
 201                 }
 202             }
 203
 204             invoke(transaction);
 205         }
 206     }
 207
 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,
 212                 iid,
 213                 ovs.getSchema(),
 214                 ovs.getExternalIdsColumn().getSchema());
 215     }
 216
 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) {
 221             try {
 222                 List<OperationResult> got = result.get();
 223                 LOG.debug("OVSDB transaction result: {}", got);
 224             } catch (Exception e) {
 225                 LOG.warn("Transact execution exception: ", e);
 226             }
 227             LOG.trace("invoke exit tb: {}", txBuilder);
 228         }
 229     }
 230
 231
 232     public ListenableFuture<List<String>> getDatabases() {
 233         return client.getDatabases();
 234     }
 235
 236     public ListenableFuture<DatabaseSchema> getSchema(String database) {
 237         return client.getSchema(database);
 238     }
 239
 240     public TransactionBuilder transactBuilder(DatabaseSchema dbSchema) {
 241         return client.transactBuilder(dbSchema);
 242     }
 243
 244     public ListenableFuture<List<OperationResult>> transact(
 245             DatabaseSchema dbSchema, List<Operation> operations) {
 246         return client.transact(dbSchema, operations);
 247     }
 248
 249     public <E extends TableSchema<E>> TableUpdates monitor(
 250             DatabaseSchema schema, List<MonitorRequest> monitorRequests,
 251             MonitorCallBack callback) {
 252         return client.monitor(schema, monitorRequests, callback);
 253     }
 254
 255     public void cancelMonitor(MonitorHandle handler) {
 256         client.cancelMonitor(handler);
 257     }
 258
 259     public void lock(String lockId, LockAquisitionCallback lockedCallBack,
 260             LockStolenCallback stolenCallback) {
 261         client.lock(lockId, lockedCallBack, stolenCallback);
 262     }
 263
 264     public ListenableFuture<Boolean> steal(String lockId) {
 265         return client.steal(lockId);
 266     }
 267
 268     public ListenableFuture<Boolean> unLock(String lockId) {
 269         return client.unLock(lockId);
 270     }
 271
 272     public void startEchoService(EchoServiceCallbackFilters callbackFilters) {
 273         client.startEchoService(callbackFilters);
 274     }
 275
 276     public void stopEchoService() {
 277         client.stopEchoService();
 278     }
 279
 280     public boolean isActive() {
 281         return client.isActive();
 282     }
 283
 284     public void disconnect() {
 285         client.disconnect();
 286     }
 287
 288     public DatabaseSchema getDatabaseSchema(String dbName) {
 289         return client.getDatabaseSchema(dbName);
 290     }
 291
 292     public <T extends TypedBaseTable<?>> T createTypedRowWrapper(Class<T> klazz) {
 293         return client.createTypedRowWrapper(klazz);
 294     }
 295
 296     public <T extends TypedBaseTable<?>> T createTypedRowWrapper(
 297             DatabaseSchema dbSchema, Class<T> klazz) {
 298         return client.createTypedRowWrapper(dbSchema, klazz);
 299     }
 300
 301     public <T extends TypedBaseTable<?>> T getTypedRowWrapper(Class<T> klazz,
 302             Row<GenericTableSchema> row) {
 303         return client.getTypedRowWrapper(klazz, row);
 304     }
 305
 306     public OvsdbConnectionInfo getConnectionInfo() {
 307         return client.getConnectionInfo();
 308     }
 309
 310     public ConnectionInfo getMDConnectionInfo() {
 311         return connectionInfo;
 312     }
 313
 314     public void setMDConnectionInfo(ConnectionInfo key) {
 315         this.connectionInfo = key;
 316     }
 317
 318     public InstanceIdentifier<Node> getInstanceIdentifier() {
 319         return instanceIdentifier;
 320     }
 321
 322     public NodeKey getNodeKey() {
 323         return getInstanceIdentifier().firstKeyOf(Node.class, NodeKey.class);
 324     }
 325
 326     public NodeId getNodeId() {
 327         return getNodeKey().getNodeId();
 328     }
 329
 330     public void setInstanceIdentifier(InstanceIdentifier<Node> iid) {
 331         this.instanceIdentifier = iid;
 332     }
 333
 334     @Override
 335     public <E extends TableSchema<E>> TableUpdates monitor(
 336             DatabaseSchema schema, List<MonitorRequest> monitorRequests,
 337             MonitorHandle monitorHandle, MonitorCallBack callback) {
 338         return null;
 339     }
 340
 341     public Entity getConnectedEntity() {
 342         return this.connectedEntity;
 343     }
 344
 345     public void setConnectedEntity(Entity entity ) {
 346         this.connectedEntity = entity;
 347     }
 348
 349     public Boolean hasOvsdbClient(OvsdbClient otherClient) {
 350         return client.equals(otherClient);
 351     }
 352
 353     public Boolean getHasDeviceOwnership() {
 354         return hasDeviceOwnership;
 355     }
 356
 357     public void setHasDeviceOwnership(Boolean hasDeviceOwnership) {
 358         if (hasDeviceOwnership != null) {
 359             this.hasDeviceOwnership = hasDeviceOwnership;
 360         }
 361     }
 362
 363     public void setDeviceOwnershipCandidateRegistration(@Nonnull EntityOwnershipCandidateRegistration registration) {
 364         this.deviceOwnershipCandidateRegistration = registration;
 365     }
 366
 367     public void closeDeviceOwnershipCandidateRegistration() {
 368         if (deviceOwnershipCandidateRegistration != null) {
 369             this.deviceOwnershipCandidateRegistration.close();
 370             setHasDeviceOwnership(Boolean.FALSE);
 371         }
 372     }
 373
 374     public OvsdbNodeAugmentation getOvsdbNodeAugmentation() {
 375         return this.initialCreateData;
 376     }
 377     public void setOvsdbNodeAugmentation(OvsdbNodeAugmentation ovsdbNodeCreateData) {
 378         this.initialCreateData = ovsdbNodeCreateData;
 379     }
 380 }