bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/config/RibImpl.java

   1 /*
   2  * Copyright (c) 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
   9 package org.opendaylight.protocol.bgp.rib.impl.config;
  10
  11 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getAfiSafiWithDefault;
  12
  13 import com.google.common.base.Preconditions;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.Set;
  17 import java.util.stream.Collectors;
  18 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  20 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  22 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  23 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
  24 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
  25 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  26 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
  27 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
  28 import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
  29 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenConfigMappingService;
  30 import org.opendaylight.protocol.bgp.rib.impl.RIBImpl;
  31 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
  32 import org.opendaylight.protocol.bgp.rib.impl.spi.BgpDeployer;
  33 import org.opendaylight.protocol.bgp.rib.impl.spi.CodecsRegistry;
  34 import org.opendaylight.protocol.bgp.rib.impl.spi.ImportPolicyPeerTracker;
  35 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  36 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
  37 import org.opendaylight.protocol.bgp.rib.impl.stats.rib.impl.BGPRenderStats;
  38 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
  39 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
  40 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
  41 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.global.base.Config;
  42 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Global;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.RibKey;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
  52 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  53 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  55 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  56 import org.osgi.framework.ServiceRegistration;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 public final class RibImpl implements RIB, AutoCloseable {
  61
  62     private static final Logger LOG = LoggerFactory.getLogger(RibImpl.class);
  63
  64     private final RIBExtensionConsumerContext extensions;
  65     private final BGPDispatcher dispatcher;
  66     private final BindingCodecTreeFactory codecTreeFactory;
  67     private final DOMDataBroker domBroker;
  68     private final SchemaService schemaService;
  69     private RIBImpl ribImpl;
  70     private ServiceRegistration<?> serviceRegistration;
  71     private ListenerRegistration<SchemaContextListener> schemaContextRegistration;
  72     private final ClusterSingletonServiceProvider provider;
  73     private List<AfiSafi> afiSafi;
  74     private AsNumber asNumber;
  75     private Ipv4Address routerId;
  76
  77     private ClusterIdentifier clusterId;
  78
  79     public RibImpl(final ClusterSingletonServiceProvider provider, final RIBExtensionConsumerContext contextProvider, final BGPDispatcher dispatcher,
  80             final BindingCodecTreeFactory codecTreeFactory, final DOMDataBroker domBroker, final SchemaService schemaService) {
  81         this.provider = Preconditions.checkNotNull(provider);
  82         this.extensions = contextProvider;
  83         this.dispatcher = dispatcher;
  84         this.codecTreeFactory = codecTreeFactory;
  85         this.domBroker = domBroker;
  86         this.schemaService = schemaService;
  87     }
  88
  89     void start(final Global global, final String instanceName, final BGPOpenConfigMappingService mappingService,
  90         final BgpDeployer.WriteConfiguration configurationWriter) {
  91         Preconditions.checkState(this.ribImpl == null, "Previous instance %s was not closed.", this);
  92         this.ribImpl = createRib(this.provider, global, instanceName, mappingService, configurationWriter);
  93         this.schemaContextRegistration = this.schemaService.registerSchemaContextListener(this.ribImpl);
  94     }
  95
  96     Boolean isGlobalEqual(final Global global) {
  97         final List<AfiSafi> globalAfiSafi = getAfiSafiWithDefault(global.getAfiSafis(), true);
  98         final Config globalConfig = global.getConfig();
  99         final AsNumber globalAs = globalConfig.getAs();
 100         final Ipv4Address globalRouterId = global.getConfig().getRouterId();
 101         final ClusterIdentifier globalClusterId = OpenConfigMappingUtil.getClusterIdentifier(globalConfig);
 102         return this.afiSafi.containsAll(globalAfiSafi) && globalAfiSafi.containsAll(this.afiSafi)
 103             && globalAs.equals(this.asNumber)
 104             && globalRouterId.getValue().equals(this.routerId.getValue())
 105             && globalClusterId.getValue().equals(this.clusterId.getValue());
 106     }
 107
 108     @Override
 109     public KeyedInstanceIdentifier<Rib, RibKey> getInstanceIdentifier() {
 110         return this.ribImpl.getInstanceIdentifier();
 111     }
 112
 113     @Override
 114     public AsNumber getLocalAs() {
 115         return this.ribImpl.getLocalAs();
 116     }
 117
 118     @Override
 119     public BgpId getBgpIdentifier() {
 120         return this.ribImpl.getBgpIdentifier();
 121     }
 122
 123     @Override
 124     public Set<? extends BgpTableType> getLocalTables() {
 125         return this.ribImpl.getLocalTables();
 126     }
 127
 128     @Override
 129     public BGPDispatcher getDispatcher() {
 130         return this.ribImpl.getDispatcher();
 131     }
 132
 133     @Override
 134     public DOMTransactionChain createPeerChain(final TransactionChainListener listener) {
 135         return this.ribImpl.createPeerChain(listener);
 136     }
 137
 138     @Override
 139     public RIBExtensionConsumerContext getRibExtensions() {
 140         return this.ribImpl.getRibExtensions();
 141     }
 142
 143     @Override
 144     public RIBSupportContextRegistry getRibSupportContext() {
 145         return this.ribImpl.getRibSupportContext();
 146     }
 147
 148     @Override
 149     public YangInstanceIdentifier getYangRibId() {
 150         return this.ribImpl.getYangRibId();
 151     }
 152
 153     @Override
 154     public CodecsRegistry getCodecsRegistry() {
 155         return this.ribImpl.getCodecsRegistry();
 156     }
 157
 158     @Override
 159     public DOMDataTreeChangeService getService() {
 160         return this.ribImpl.getService();
 161     }
 162
 163     @Override
 164     public void close() {
 165         if (this.ribImpl != null) {
 166             try {
 167                 this.ribImpl.close();
 168             } catch (final Exception e) {
 169                 LOG.warn("Failed to close {} rib instance", this, e);
 170             }
 171             this.ribImpl = null;
 172         }
 173         if (this.schemaContextRegistration != null) {
 174             this.schemaContextRegistration.close();
 175             this.schemaContextRegistration = null;
 176         }
 177         if (this.serviceRegistration != null) {
 178             try {
 179                 this.serviceRegistration.unregister();
 180             } catch(final IllegalStateException e) {
 181                 LOG.warn("Failed to unregister {} service instance", this, e);
 182             }
 183             this.serviceRegistration = null;
 184         }
 185     }
 186
 187     void setServiceRegistration(final ServiceRegistration<?> serviceRegistration) {
 188         this.serviceRegistration = serviceRegistration;
 189     }
 190
 191     @Override
 192     public BGPRenderStats getRenderStats() {
 193         return this.ribImpl.getRenderStats();
 194     }
 195
 196     @Override
 197     public ImportPolicyPeerTracker getImportPolicyPeerTracker() {
 198         return this.ribImpl.getImportPolicyPeerTracker();
 199     }
 200
 201     @Override
 202     public ExportPolicyPeerTracker getExportPolicyPeerTracker(final TablesKey tablesKey) {
 203         return this.ribImpl.getExportPolicyPeerTracker(tablesKey);
 204     }
 205
 206     @Override
 207     public Set<TablesKey> getLocalTablesKeys() {
 208         return this.ribImpl.getLocalTablesKeys();
 209     }
 210
 211     @Override
 212     public ServiceGroupIdentifier getRibIServiceGroupIdentifier() {
 213         return this.ribImpl.getRibIServiceGroupIdentifier();
 214     }
 215
 216     @Override
 217     public String toString() {
 218         return this.ribImpl != null ? this.ribImpl.toString() : null;
 219     }
 220
 221     private RIBImpl createRib(final ClusterSingletonServiceProvider provider, final Global global, final String bgpInstanceName,
 222         final BGPOpenConfigMappingService mappingService, final BgpDeployer.WriteConfiguration configurationWriter) {
 223         this.afiSafi = getAfiSafiWithDefault(global.getAfiSafis(), true);
 224         final Config globalConfig = global.getConfig();
 225         this.asNumber = globalConfig.getAs();
 226         this.routerId = globalConfig.getRouterId();
 227         this.clusterId = OpenConfigMappingUtil.getClusterIdentifier(globalConfig);
 228         final Map<TablesKey, PathSelectionMode> pathSelectionModes = mappingService.toPathSelectionMode(this.afiSafi).entrySet()
 229                 .stream().collect(Collectors.toMap(entry -> new TablesKey(entry.getKey().getAfi(), entry.getKey().getSafi()), Map.Entry::getValue));
 230         return new RIBImpl(provider, new RibId(bgpInstanceName), this.asNumber, new BgpId(this.routerId), this.clusterId,
 231                 this.extensions, this.dispatcher, this.codecTreeFactory, this.domBroker, mappingService.toTableTypes(this.afiSafi), pathSelectionModes,
 232                 this.extensions.getClassLoadingStrategy(), configurationWriter);
 233     }
 234
 235     @Override
 236     public ClusterSingletonServiceRegistration registerClusterSingletonService(final ClusterSingletonService clusterSingletonService) {
 237         return this.ribImpl.registerClusterSingletonService(clusterSingletonService);
 238     }
 239 }