bgp/openconfig-impl/src/main/java/org/opendaylight/protocol/bgp/openconfig/impl/BGPOpenConfigMappingServiceImpl.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
   9 package org.opendaylight.protocol.bgp.openconfig.impl;
  10
  11 import static org.opendaylight.protocol.bgp.openconfig.impl.util.OpenConfigUtil.APPLICATION_PEER_GROUP_NAME;
  12
  13 import com.google.common.base.Optional;
  14 import java.math.BigDecimal;
  15 import java.util.ArrayList;
  16 import java.util.Collections;
  17 import java.util.HashMap;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.stream.Collectors;
  21 import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
  22 import org.opendaylight.protocol.bgp.mode.impl.add.all.paths.AllPathSelection;
  23 import org.opendaylight.protocol.bgp.mode.impl.add.n.paths.AddPathBestNPathSelection;
  24 import org.opendaylight.protocol.bgp.openconfig.impl.util.OpenConfigUtil;
  25 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenConfigMappingService;
  26 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
  27 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.Config1;
  28 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.Config1Builder;
  29 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.global.base.AfiSafisBuilder;
  30 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.global.base.ConfigBuilder;
  31 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.RouteReflectorBuilder;
  32 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.TimersBuilder;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.TransportBuilder;
  34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
  35 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.NeighborBuilder;
  36 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.NeighborKey;
  37 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroup;
  38 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroupBuilder;
  39 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroupKey;
  40 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
  41 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.BgpBuilder;
  42 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Global;
  43 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.GlobalBuilder;
  44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.NeighborsBuilder;
  45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.PeerGroups;
  46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.PeerGroupsBuilder;
  47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.CommunityType;
  48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.PeerType;
  49 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.Protocol;
  50 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.ProtocolBuilder;
  51 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.ProtocolKey;
  52 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.policy.types.rev151009.BGP;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.SendReceive;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.add.path.capability.AddressFamilies;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.add.path.capability.AddressFamiliesBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.AfiSafi1;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.AfiSafi2;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Protocol1;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Protocol1Builder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.SimpleRoutingPolicy;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.rfc2385.cfg.rev160324.Rfc2385Key;
  72
  73 public final class BGPOpenConfigMappingServiceImpl implements BGPOpenConfigMappingService {
  74
  75     private static final PeerGroup APP_PEER_GROUP = new PeerGroupBuilder().setPeerGroupName(APPLICATION_PEER_GROUP_NAME)
  76             .setKey(new PeerGroupKey(APPLICATION_PEER_GROUP_NAME)).build();
  77     private static final PeerGroups PEER_GROUPS = new PeerGroupsBuilder().setPeerGroup(Collections.singletonList(APP_PEER_GROUP)).build();
  78     private static final BigDecimal DEFAULT_KEEP_ALIVE = BigDecimal.valueOf(30);
  79     private static final BigDecimal DEFAULT_MINIMUM_ADV_INTERVAL = BigDecimal.valueOf(30);
  80
  81     @Override
  82     public List<BgpTableType> toTableTypes(final List<AfiSafi> afiSafis) {
  83         return afiSafis.stream()
  84                 .map(afiSafi -> OpenConfigUtil.toBgpTableType(afiSafi.getAfiSafiName()))
  85                 .filter(Optional::isPresent)
  86                 .map(Optional::get)
  87                 .collect(Collectors.toList());
  88     }
  89
  90     @Override
  91     public Map<BgpTableType, PathSelectionMode> toPathSelectionMode(final List<AfiSafi> afiSafis) {
  92         final Map<BgpTableType, PathSelectionMode> pathSelectionModes = new HashMap<>();
  93         for (final AfiSafi afiSafi : afiSafis) {
  94             final AfiSafi1 afiSafi1 = afiSafi.getAugmentation(AfiSafi1.class);
  95             final Optional<BgpTableType> bgpTableType = OpenConfigUtil.toBgpTableType(afiSafi.getAfiSafiName());
  96             if (afiSafi1 != null && bgpTableType.isPresent()) {
  97                 final Short sendMax = afiSafi1.getSendMax();
  98                 final PathSelectionMode selectionMode;
  99                 if (sendMax > 1) {
 100                     selectionMode = new AddPathBestNPathSelection(sendMax.longValue());
 101                 } else {
 102                     selectionMode = new AllPathSelection();
 103                 }
 104                 pathSelectionModes.put(bgpTableType.get(), selectionMode);
 105             }
 106         }
 107         return pathSelectionModes;
 108     }
 109
 110     @Override
 111     public boolean isApplicationPeer(final Neighbor neighbor) {
 112         return OpenConfigUtil.isAppNeighbor(neighbor);
 113     }
 114
 115     @Override
 116     public PeerRole toPeerRole(final Neighbor neighbor) {
 117         return OpenConfigUtil.toPeerRole(neighbor);
 118     }
 119
 120     @Override
 121     public List<AddressFamilies> toAddPathCapability(final List<AfiSafi> afiSafis) {
 122         final List<AddressFamilies> addPathCapability = new ArrayList<>();
 123         for (final AfiSafi afiSafi : afiSafis) {
 124             final AfiSafi2 afiSafi2 = afiSafi.getAugmentation(AfiSafi2.class);
 125             final Optional<BgpTableType> bgpTableType = OpenConfigUtil.toBgpTableType(afiSafi.getAfiSafiName());
 126             if (afiSafi2 != null && bgpTableType.isPresent()) {
 127                 final AddressFamiliesBuilder builder = new AddressFamiliesBuilder(bgpTableType.get());
 128                 builder.setSendReceive(toSendReceiveMode(afiSafi2));
 129                 addPathCapability.add(builder.build());
 130             }
 131         }
 132         return addPathCapability;
 133     }
 134
 135     private static SendReceive toSendReceiveMode(final AfiSafi2 addPath) {
 136         if (addPath.isReceive() && addPath.getSendMax() != null) {
 137             return SendReceive.Both;
 138         }
 139         if (addPath.getSendMax() != null) {
 140             return SendReceive.Send;
 141         }
 142         return SendReceive.Receive;
 143     }
 144
 145     @Override
 146     public Protocol fromRib(final BgpId bgpId, final ClusterIdentifier clusterIdentifier, final RibId ribId,
 147             final AsNumber localAs, final List<BgpTableType> localTables,
 148             final Map<TablesKey, PathSelectionMode> pathSelectionStrategies) {
 149         final Bgp bgp = toGlobalConfiguration(bgpId, clusterIdentifier, localAs, localTables, pathSelectionStrategies);
 150         final ProtocolBuilder protocolBuilder = new ProtocolBuilder();
 151         protocolBuilder.setIdentifier(BGP.class);
 152         protocolBuilder.setName(ribId.getValue());
 153         protocolBuilder.setKey(new ProtocolKey(protocolBuilder.getIdentifier(), protocolBuilder.getName()));
 154         return protocolBuilder.addAugmentation(Protocol1.class, new Protocol1Builder().setBgp(bgp).build()).build();
 155     }
 156
 157     private static Bgp toGlobalConfiguration(final BgpId bgpId, final ClusterIdentifier clusterIdentifier,
 158             final AsNumber localAs, final List<BgpTableType> localTables,
 159             final Map<TablesKey, PathSelectionMode> pathSelectionStrategies) {
 160         final BgpBuilder bgpBuilder = new BgpBuilder();
 161         bgpBuilder.setNeighbors(new NeighborsBuilder().build());
 162         bgpBuilder.setPeerGroups(PEER_GROUPS);
 163         final Global global = new GlobalBuilder().setAfiSafis(new AfiSafisBuilder().setAfiSafi(OpenConfigUtil.toAfiSafis(localTables,
 164                 (afiSafi, tableType) -> OpenConfigUtil.toGlobalAfiSafiAddPath(afiSafi, tableType, pathSelectionStrategies))).build())
 165                 .setConfig(new ConfigBuilder().setAs(localAs).setRouterId(bgpId).build()).build();
 166         bgpBuilder.setGlobal(global);
 167         return bgpBuilder.build();
 168     }
 169
 170     @Override
 171     public Neighbor fromBgpPeer(final List<AddressFamilies> addPathCapabilities,
 172             final List<BgpTableType> advertisedTables, final Integer holdTimer, final IpAddress ipAddress,
 173             final Boolean isActive, final Rfc2385Key password, final PortNumber portNumber, final Integer retryTimer,
 174             final AsNumber remoteAs, final PeerRole peerRole, final SimpleRoutingPolicy simpleRoutingPolicy) {
 175         final NeighborBuilder neighborBuilder = new NeighborBuilder();
 176         neighborBuilder.setNeighborAddress(ipAddress);
 177         neighborBuilder.setKey(new NeighborKey(ipAddress));
 178         neighborBuilder.setAfiSafis(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafisBuilder().setAfiSafi(OpenConfigUtil.toAfiSafis(advertisedTables,
 179                 (afiSafi, tableType) -> OpenConfigUtil.toNeighborAfiSafiAddPath(afiSafi, tableType, addPathCapabilities))).build());
 180         neighborBuilder.setTransport(new TransportBuilder().setConfig(
 181                 new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.transport.ConfigBuilder()
 182                 .setPassiveMode(!isActive)
 183                 .setMtuDiscovery(Boolean.FALSE)
 184                 .addAugmentation(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Config1.class,
 185                         new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Config1Builder()
 186                 .setRemotePort(portNumber).build())
 187                 .build()).build());
 188         neighborBuilder.setConfig(
 189                 new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.ConfigBuilder()
 190                 .setAuthPassword(password != null ? password.getValue() : null)
 191                 .setPeerAs(remoteAs)
 192                 .setPeerType(toPeerTye(peerRole))
 193                 .setSendCommunity(CommunityType.NONE)
 194                 .setRouteFlapDamping(Boolean.FALSE)
 195                 .build());
 196         neighborBuilder.setTimers(new TimersBuilder().setConfig(
 197                 new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.timers.ConfigBuilder()
 198                 .setHoldTime(BigDecimal.valueOf(holdTimer))
 199                 .setConnectRetry(BigDecimal.valueOf(retryTimer))
 200                 .setKeepaliveInterval(DEFAULT_KEEP_ALIVE)
 201                 .setMinimumAdvertisementInterval(DEFAULT_MINIMUM_ADV_INTERVAL)
 202                 .build()).build());
 203         neighborBuilder.setRouteReflector(new RouteReflectorBuilder().setConfig(
 204                 new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.route.reflector.ConfigBuilder()
 205                 .setRouteReflectorClient(peerRole == PeerRole.RrClient).build()).build());
 206         return neighborBuilder.build();
 207     }
 208
 209     private static PeerType toPeerTye(final PeerRole peerRole) {
 210         switch (peerRole) {
 211         case Ibgp:
 212         case RrClient:
 213             return PeerType.INTERNAL;
 214         case Ebgp:
 215             return PeerType.EXTERNAL;
 216         case Internal:
 217             break;
 218         default:
 219             break;
 220         }
 221         return null;
 222     }
 223
 224     @Override
 225     public Neighbor fromApplicationPeer(final ApplicationRibId applicationRibId, final BgpId bgpId) {
 226         final NeighborBuilder neighborBuilder = new NeighborBuilder();
 227         neighborBuilder.setNeighborAddress(new IpAddress(bgpId));
 228         neighborBuilder.setKey(new NeighborKey(neighborBuilder.getNeighborAddress()));
 229         neighborBuilder.setConfig(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.ConfigBuilder()
 230         .setDescription(applicationRibId.getValue())
 231         .addAugmentation(Config1.class, new Config1Builder().setPeerGroup(APPLICATION_PEER_GROUP_NAME).build())
 232         .build());
 233
 234         return neighborBuilder.build();
 235     }
 236
 237 }