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

   1 /*
   2  * Copyright (c) 2014, 2018 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 com.google.common.base.Optional;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  13 import java.util.Collection;
  14 import java.util.Map;
  15 import java.util.concurrent.ExecutionException;
  16 import java.util.concurrent.atomic.AtomicBoolean;
  17 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
  18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  19 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  20 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  21 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  24 import org.opendaylight.infrautils.diagstatus.DiagStatusService;
  25 import org.opendaylight.infrautils.diagstatus.ServiceState;
  26 import org.opendaylight.infrautils.ready.SystemReadyMonitor;
  27 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  28 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  29 import org.opendaylight.mdsal.eos.binding.api.Entity;
  30 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipCandidateRegistration;
  31 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipChange;
  32 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipListener;
  33 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipListenerRegistration;
  34 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
  35 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
  36 import org.opendaylight.ovsdb.lib.OvsdbConnection;
  37 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvoker;
  38 import org.opendaylight.ovsdb.southbound.transactions.md.TransactionInvokerImpl;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  43 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 public class SouthboundProvider implements ClusteredDataTreeChangeListener<Topology>, AutoCloseable {
  49
  50     private static final Logger LOG = LoggerFactory.getLogger(SouthboundProvider.class);
  51
  52     private static final String ENTITY_TYPE = "ovsdb-southbound-provider";
  53     private static final String SKIP_MONITORING_MANAGER_STATUS_PARAM = "skip-monitoring-manager-status";
  54
  55     public static DataBroker getDb() {
  56         return db;
  57     }
  58
  59     // FIXME: get rid of this static
  60     @SuppressFBWarnings("ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD")
  61     private static DataBroker db;
  62     private OvsdbConnectionManager cm;
  63     private TransactionInvoker txInvoker;
  64     private OvsdbDataTreeChangeListener ovsdbDataTreeChangeListener;
  65     private final EntityOwnershipService entityOwnershipService;
  66     private EntityOwnershipCandidateRegistration registration;
  67     private SouthboundPluginInstanceEntityOwnershipListener providerOwnershipChangeListener;
  68     private final OvsdbConnection ovsdbConnection;
  69     private final InstanceIdentifierCodec instanceIdentifierCodec;
  70     private final SystemReadyMonitor systemReadyMonitor;
  71
  72     private final AtomicBoolean registered = new AtomicBoolean(false);
  73     private ListenerRegistration<SouthboundProvider> operTopologyRegistration;
  74     private final OvsdbDiagStatusProvider ovsdbStatusProvider;
  75
  76     public SouthboundProvider(final DataBroker dataBroker,
  77             final EntityOwnershipService entityOwnershipServiceDependency,
  78             final OvsdbConnection ovsdbConnection,
  79             final DOMSchemaService schemaService,
  80             final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer,
  81             final SystemReadyMonitor systemReadyMonitor,
  82             final DiagStatusService diagStatusService) {
  83         this.db = dataBroker;
  84         this.entityOwnershipService = entityOwnershipServiceDependency;
  85         registration = null;
  86         this.ovsdbConnection = ovsdbConnection;
  87         this.ovsdbStatusProvider = new OvsdbDiagStatusProvider(diagStatusService);
  88         this.instanceIdentifierCodec = new InstanceIdentifierCodec(schemaService,
  89                 bindingNormalizedNodeSerializer);
  90         this.systemReadyMonitor = systemReadyMonitor;
  91         LOG.info("SouthboundProvider ovsdbConnectionService Initialized");
  92     }
  93
  94     /**
  95      * Used by blueprint when starting the container.
  96      */
  97     public void init() {
  98         LOG.info("SouthboundProvider Session Initiated");
  99         ovsdbStatusProvider.reportStatus(ServiceState.STARTING, "OVSDB initialization in progress");
 100         this.txInvoker = new TransactionInvokerImpl(db);
 101         cm = new OvsdbConnectionManager(db, txInvoker, entityOwnershipService, ovsdbConnection,
 102                 instanceIdentifierCodec);
 103         ovsdbDataTreeChangeListener = new OvsdbDataTreeChangeListener(db, cm, instanceIdentifierCodec);
 104
 105         //Register listener for entityOnwership changes
 106         providerOwnershipChangeListener =
 107                 new SouthboundPluginInstanceEntityOwnershipListener(this,this.entityOwnershipService);
 108
 109         //register instance entity to get the ownership of the provider
 110         Entity instanceEntity = new Entity(ENTITY_TYPE, ENTITY_TYPE);
 111         try {
 112             registration = entityOwnershipService.registerCandidate(instanceEntity);
 113         } catch (CandidateAlreadyRegisteredException e) {
 114             LOG.warn("OVSDB Southbound Provider instance entity {} was already "
 115                     + "registered for ownership", instanceEntity, e);
 116         }
 117         InstanceIdentifier<Topology> path = InstanceIdentifier
 118                 .create(NetworkTopology.class)
 119                 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
 120         DataTreeIdentifier<Topology> treeId =
 121                 new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL, path);
 122
 123         LOG.trace("Registering listener for path {}", treeId);
 124         operTopologyRegistration = db.registerDataTreeChangeListener(treeId, this);
 125     }
 126
 127     @Override
 128     public void close() {
 129         LOG.info("SouthboundProvider Closed");
 130         try {
 131             txInvoker.close();
 132         } catch (InterruptedException e) {
 133             ovsdbStatusProvider.reportStatus(ServiceState.ERROR, "OVSDB service shutdown error");
 134             LOG.debug("SouthboundProvider failed to close TransactionInvoker.");
 135         }
 136         cm.close();
 137         ovsdbDataTreeChangeListener.close();
 138         registration.close();
 139         providerOwnershipChangeListener.close();
 140         if (operTopologyRegistration != null) {
 141             operTopologyRegistration.close();
 142             operTopologyRegistration = null;
 143         }
 144         ovsdbStatusProvider.reportStatus(ServiceState.UNREGISTERED, "OVSDB Service stopped");
 145     }
 146
 147     private void initializeOvsdbTopology(LogicalDatastoreType type) {
 148         InstanceIdentifier<Topology> path = InstanceIdentifier
 149                 .create(NetworkTopology.class)
 150                 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID));
 151         ReadWriteTransaction transaction = db.newReadWriteTransaction();
 152         CheckedFuture<Optional<Topology>, ReadFailedException> ovsdbTp = transaction.read(type, path);
 153         try {
 154             if (!ovsdbTp.get().isPresent()) {
 155                 TopologyBuilder tpb = new TopologyBuilder();
 156                 tpb.setTopologyId(SouthboundConstants.OVSDB_TOPOLOGY_ID);
 157                 transaction.put(type, path, tpb.build(), true);
 158                 transaction.submit();
 159             } else {
 160                 transaction.cancel();
 161             }
 162         } catch (InterruptedException | ExecutionException e) {
 163             LOG.error("Error initializing ovsdb topology", e);
 164         }
 165     }
 166
 167     public void handleOwnershipChange(EntityOwnershipChange ownershipChange) {
 168         if (ownershipChange.getState().isOwner()) {
 169             LOG.info("*This* instance of OVSDB southbound provider is set as a MASTER instance");
 170             LOG.info("Initialize OVSDB topology {} in operational and config data store if not already present",
 171                     SouthboundConstants.OVSDB_TOPOLOGY_ID);
 172             initializeOvsdbTopology(LogicalDatastoreType.OPERATIONAL);
 173             initializeOvsdbTopology(LogicalDatastoreType.CONFIGURATION);
 174         } else {
 175             LOG.info("*This* instance of OVSDB southbound provider is set as a SLAVE instance");
 176         }
 177     }
 178
 179     @Override
 180     public void onDataTreeChanged(Collection<DataTreeModification<Topology>> collection) {
 181         if (!registered.getAndSet(true)) {
 182             LOG.info("Starting the ovsdb port");
 183             ovsdbConnection.registerConnectionListener(cm);
 184             LOG.info("Registering deferred system ready listener to start OVSDB Manager later");
 185             systemReadyMonitor.registerListener(() -> {
 186                 ovsdbConnection.startOvsdbManager();
 187                 LOG.info("Started OVSDB Manager (in system ready listener)");
 188             });
 189             //mdsal registration/deregistration in mdsal update callback should be avoided
 190             new Thread(() -> {
 191                 if (operTopologyRegistration != null) {
 192                     operTopologyRegistration.close();
 193                     operTopologyRegistration = null;
 194                 }
 195             }).start();
 196             ovsdbStatusProvider.reportStatus(ServiceState.OPERATIONAL, "OVSDB initialization complete");
 197         }
 198     }
 199
 200     private static class SouthboundPluginInstanceEntityOwnershipListener implements EntityOwnershipListener {
 201         private final SouthboundProvider sp;
 202         private final EntityOwnershipListenerRegistration listenerRegistration;
 203
 204         SouthboundPluginInstanceEntityOwnershipListener(SouthboundProvider sp,
 205                 EntityOwnershipService entityOwnershipService) {
 206             this.sp = sp;
 207             listenerRegistration = entityOwnershipService.registerListener(ENTITY_TYPE, this);
 208         }
 209
 210         public void close() {
 211             this.listenerRegistration.close();
 212         }
 213
 214         @Override
 215         public void ownershipChanged(EntityOwnershipChange ownershipChange) {
 216             sp.handleOwnershipChange(ownershipChange);
 217         }
 218     }
 219
 220     public void updateConfigParameter(Map<String, Object> configParameters) {
 221         if (configParameters != null && !configParameters.isEmpty()) {
 222             LOG.debug("Config parameters received : {}", configParameters.entrySet());
 223             for (Map.Entry<String, Object> paramEntry : configParameters.entrySet()) {
 224                 if (paramEntry.getKey().equalsIgnoreCase(SKIP_MONITORING_MANAGER_STATUS_PARAM)) {
 225                     setSkipMonitoringManagerStatus(Boolean.parseBoolean((String)paramEntry.getValue()));
 226                     break;
 227                 }
 228             }
 229         }
 230     }
 231
 232     public void setSkipMonitoringManagerStatus(boolean flag) {
 233         LOG.debug("skipManagerStatus set to {}", flag);
 234         if (flag) {
 235             SouthboundConstants.SKIP_COLUMN_FROM_TABLE.get("Manager").add("status");
 236         } else {
 237             SouthboundConstants.SKIP_COLUMN_FROM_TABLE.get("Manager").remove("status");
 238         }
 239     }
 240 }