bgp/linkstate/src/main/java/org/opendaylight/protocol/bgp/linkstate/LinkstateAdjRIBsIn.java

   1 /*
   2  * Copyright (c) 2013 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.protocol.bgp.linkstate;
   9
  10 import com.google.common.base.MoreObjects.ToStringHelper;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.Lists;
  13 import io.netty.buffer.ByteBuf;
  14 import io.netty.buffer.Unpooled;
  15 import java.util.List;
  16 import org.opendaylight.protocol.bgp.linkstate.nlri.LinkstateNlriParser;
  17 import org.opendaylight.protocol.bgp.parser.BGPParsingException;
  18 import org.opendaylight.protocol.bgp.rib.spi.AbstractAdjRIBs;
  19 import org.opendaylight.protocol.bgp.rib.spi.AdjRIBsTransaction;
  20 import org.opendaylight.protocol.bgp.rib.spi.Peer;
  21 import org.opendaylight.protocol.util.ByteArray;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateDestination;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.ObjectType;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.destination.CLinkstateDestination;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.destination.CLinkstateDestinationBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.object.type.LinkCase;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.object.type.NodeCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.object.type.PrefixCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.LinkStateAttribute;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.LinkAttributesCase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.LinkAttributesCaseBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.NodeAttributesCase;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.NodeAttributesCaseBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.PrefixAttributesCase;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.PrefixAttributesCaseBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.link.attributes._case.LinkAttributesBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.node.attributes._case.NodeAttributesBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributesBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.LinkstateRoutes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.linkstate.routes.LinkstateRoute;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.linkstate.routes.LinkstateRouteBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.linkstate.routes.LinkstateRouteKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.linkstate.routes.linkstate.route.Attributes1;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.linkstate.routes.linkstate.route.Attributes1Builder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationLinkstateCase;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationLinkstateCaseBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.linkstate._case.DestinationLinkstateBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.destination.linkstate._case.DestinationLinkstate;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutes;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutes;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  62 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  63 import org.slf4j.Logger;
  64 import org.slf4j.LoggerFactory;
  65
  66 final class LinkstateAdjRIBsIn extends AbstractAdjRIBs<CLinkstateDestination, LinkstateRoute, LinkstateRouteKey> {
  67
  68     private abstract static class LinkstateRIBEntryData<A extends LinkStateAttribute> extends RIBEntryData<CLinkstateDestination, LinkstateRoute, LinkstateRouteKey> {
  69         private final A lsattr;
  70
  71         protected LinkstateRIBEntryData(final Peer peer, final Attributes attributes, final A lsattr) {
  72             super(peer, attributes);
  73             this.lsattr = lsattr;
  74         }
  75
  76         protected abstract LinkStateAttribute createAttributes(A lsattr);
  77
  78         @Override
  79         protected final LinkstateRoute getDataObject(final CLinkstateDestination key, final LinkstateRouteKey id) {
  80             final LinkstateRouteBuilder builder = new LinkstateRouteBuilder();
  81
  82             builder.setKey(id);
  83             builder.setIdentifier(key.getIdentifier());
  84             builder.setProtocolId(key.getProtocolId());
  85             builder.setDistinguisher(key.getDistinguisher());
  86             builder.setAttributes(new AttributesBuilder(getAttributes()).addAugmentation(Attributes1.class,
  87                 new Attributes1Builder().setLinkStateAttribute(Preconditions.checkNotNull(createAttributes(this.lsattr))).build()).build());
  88             builder.setObjectType(Preconditions.checkNotNull(key.getObjectType()));
  89
  90             return builder.build();
  91         }
  92
  93         @Override
  94         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  95             return toStringHelper.add("lsattr", this.lsattr);
  96         }
  97     }
  98
  99     private static final Logger LOG = LoggerFactory.getLogger(LinkstateAdjRIBsIn.class);
 100     private final InstanceIdentifier<LinkstateRoutes> routesBasePath;
 101
 102     LinkstateAdjRIBsIn(final KeyedInstanceIdentifier<Tables, TablesKey> basePath) {
 103         super(basePath);
 104         this.routesBasePath = basePath.builder().child((Class)LinkstateRoutes.class).build();
 105     }
 106
 107     @Override
 108     @Deprecated
 109     public KeyedInstanceIdentifier<LinkstateRoute, LinkstateRouteKey> identifierForKey(final InstanceIdentifier<Tables> basePath, final CLinkstateDestination key) {
 110         final ByteBuf keyBuf = Unpooled.buffer();
 111         LinkstateNlriParser.serializeNlri(key, keyBuf);
 112         return basePath.child((Class)LinkstateRoutes.class).child(LinkstateRoute.class,
 113             new LinkstateRouteKey(ByteArray.readAllBytes(keyBuf)));
 114     }
 115
 116     @Override
 117     public KeyedInstanceIdentifier<LinkstateRoute, LinkstateRouteKey> identifierForKey(final CLinkstateDestination key) {
 118         final ByteBuf keyBuf = Unpooled.buffer();
 119         LinkstateNlriParser.serializeNlri(key, keyBuf);
 120         return this.routesBasePath.child(LinkstateRoute.class,
 121             new LinkstateRouteKey(ByteArray.readAllBytes(keyBuf)));
 122     }
 123
 124     private static LinkstateRIBEntryData<PrefixAttributesCase> createPrefixData(final Peer peer,
 125         final Attributes attributes, final LinkStateAttribute lsattr) {
 126         return new LinkstateRIBEntryData<PrefixAttributesCase>(peer, attributes, (PrefixAttributesCase) lsattr) {
 127             @Override
 128             protected LinkStateAttribute createAttributes(final PrefixAttributesCase lsattr) {
 129                 final PrefixAttributesCaseBuilder b = new PrefixAttributesCaseBuilder();
 130                 if (lsattr != null && lsattr.getPrefixAttributes() != null) {
 131                     b.setPrefixAttributes(new PrefixAttributesBuilder(lsattr.getPrefixAttributes()).build());
 132                 }
 133                 return b.build();
 134             }
 135         };
 136     }
 137
 138     private static LinkstateRIBEntryData<LinkAttributesCase> createLinkData(final Peer peer,
 139         final Attributes attributes, final LinkStateAttribute lsattr) {
 140         return new LinkstateRIBEntryData<LinkAttributesCase>(peer, attributes, (LinkAttributesCase) lsattr) {
 141             @Override
 142             protected LinkStateAttribute createAttributes(final LinkAttributesCase lsattr) {
 143                 final LinkAttributesCaseBuilder b = new LinkAttributesCaseBuilder();
 144                 if (lsattr != null && lsattr.getLinkAttributes() != null) {
 145                     b.setLinkAttributes(new LinkAttributesBuilder(lsattr.getLinkAttributes()).build());
 146                 }
 147                 return b.build();
 148             }
 149         };
 150     }
 151
 152     private static LinkstateRIBEntryData<NodeAttributesCase> createNodeData(final Peer peer,
 153         final Attributes attributes, final LinkStateAttribute lsattr) {
 154         return new LinkstateRIBEntryData<NodeAttributesCase>(peer, attributes, (NodeAttributesCase) lsattr) {
 155             @Override
 156             protected LinkStateAttribute createAttributes(final NodeAttributesCase lsattr) {
 157                 final NodeAttributesCaseBuilder b = new NodeAttributesCaseBuilder();
 158                 if (lsattr != null && lsattr.getNodeAttributes() != null) {
 159                     b.setNodeAttributes(new NodeAttributesBuilder(lsattr.getNodeAttributes()).build());
 160                 }
 161                 return b.build();
 162             }
 163         };
 164     }
 165
 166     @Override
 167     public void addRoutes(final AdjRIBsTransaction trans, final Peer peer, final MpReachNlri nlri,
 168         final Attributes attributes) {
 169         LOG.debug("Passed nlri {}", nlri);
 170         final LinkstateDestination keys = ((DestinationLinkstateCase) nlri.getAdvertizedRoutes().getDestinationType()).getDestinationLinkstate();
 171         if (keys == null) {
 172             LOG.debug("No destinations present in advertized routes");
 173             return;
 174         }
 175         LOG.debug("Iterating over route destinations {}", keys);
 176         for (final CLinkstateDestination key : keys.getCLinkstateDestination()) {
 177             LOG.debug("Processing route key {}", key);
 178             LinkStateAttribute lsattr = null;
 179             final Attributes1 pa = attributes.getAugmentation(Attributes1.class);
 180             if (pa != null) {
 181                 lsattr = pa.getLinkStateAttribute();
 182             }
 183             RIBEntryData<CLinkstateDestination, LinkstateRoute, LinkstateRouteKey> data = null;
 184             final ObjectType ot = key.getObjectType();
 185             if (ot instanceof LinkCase) {
 186                 data = createLinkData(peer, attributes, lsattr);
 187             } else if (ot instanceof NodeCase) {
 188                 data = createNodeData(peer, attributes, lsattr);
 189             } else if (ot instanceof PrefixCase) {
 190                 data = createPrefixData(peer, attributes, lsattr);
 191             }
 192             super.add(trans, peer, key, data);
 193         }
 194     }
 195
 196     @Override
 197     public void removeRoutes(final AdjRIBsTransaction trans, final Peer peer, final MpUnreachNlri nlri) {
 198         final DestinationLinkstate keys = ((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationLinkstateCase) nlri.getWithdrawnRoutes().getDestinationType()).getDestinationLinkstate();
 199
 200         for (final CLinkstateDestination key : keys.getCLinkstateDestination()) {
 201             super.remove(trans, peer, key);
 202         }
 203     }
 204
 205     @Override
 206     public void addAdvertisement(final MpReachNlriBuilder builder, final LinkstateRoute data) {
 207         final CLinkstateDestinationBuilder nlri = new CLinkstateDestinationBuilder();
 208         nlri.setProtocolId(data.getProtocolId());
 209         nlri.setIdentifier(data.getIdentifier());
 210         final Attributes a = data.getAttributes();
 211         if (a != null && a.getCNextHop() != null) {
 212             builder.setCNextHop(a.getCNextHop());
 213         }
 214         final ObjectType type = data.getObjectType();
 215         nlri.setObjectType(type);
 216         final AdvertizedRoutes ar = builder.getAdvertizedRoutes();
 217         if (ar == null) {
 218             builder.setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(
 219                 new DestinationLinkstateCaseBuilder().setDestinationLinkstate(new DestinationLinkstateBuilder()
 220                     .setCLinkstateDestination(Lists.newArrayList(nlri.build())).build()).build()).build());
 221         } else {
 222             ((DestinationLinkstateCase) ar.getDestinationType()).getDestinationLinkstate().getCLinkstateDestination().add(nlri.build());
 223         }
 224     }
 225
 226     @Override
 227     public void addWithdrawal(final MpUnreachNlriBuilder builder, final CLinkstateDestination id) {
 228         final WithdrawnRoutes wr = builder.getWithdrawnRoutes();
 229         if (wr == null) {
 230             builder.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(
 231                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationLinkstateCaseBuilder().setDestinationLinkstate(
 232                     new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.destination.linkstate._case.DestinationLinkstateBuilder()
 233                         .setCLinkstateDestination(Lists.newArrayList(id)).build()).build()).build());
 234         } else {
 235             ((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationLinkstateCase) wr.getDestinationType())
 236             .getDestinationLinkstate().getCLinkstateDestination().add(id);
 237         }
 238     }
 239
 240     @SuppressWarnings("unchecked")
 241     @Override
 242     public KeyedInstanceIdentifier<LinkstateRoute, LinkstateRouteKey> routeIdentifier(final InstanceIdentifier<?> id) {
 243         return (KeyedInstanceIdentifier<LinkstateRoute, LinkstateRouteKey>)id.firstIdentifierOf(LinkstateRoute.class);
 244     }
 245
 246     @Override
 247     public CLinkstateDestination keyForIdentifier(final KeyedInstanceIdentifier<LinkstateRoute, LinkstateRouteKey> id) {
 248         final LinkstateRouteKey route = id.getKey();
 249         List<CLinkstateDestination> dests = null;
 250         try {
 251             dests = LinkstateNlriParser.parseNlri(Unpooled.wrappedBuffer(route.getRouteKey()), false);
 252         } catch (final BGPParsingException e) {
 253             LOG.warn("Unable to parse LinkstateRoute Key {}", route, e);
 254         }
 255         if (dests == null || dests.size() != 1) {
 256             LOG.warn("Null or more than one LinkstateRoute Key was parsed");
 257             return null;
 258         }
 259         return dests.get(0);
 260     }
 261 }