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