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