bgp/linkstate/src/main/java/org/opendaylight/protocol/bgp/linkstate/nlri/NodeNlriParser.java

   1 /*
   2  * Copyright (c) 2014 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.nlri;
   9
  10 import com.google.common.primitives.UnsignedInteger;
  11 import io.netty.buffer.ByteBuf;
  12 import io.netty.buffer.ByteBufUtil;
  13 import io.netty.buffer.Unpooled;
  14 import org.opendaylight.protocol.bgp.linkstate.TlvUtil;
  15 import org.opendaylight.protocol.bgp.parser.BGPParsingException;
  16 import org.opendaylight.protocol.util.ByteArray;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.AreaIdentifier;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.DomainIdentifier;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.NodeIdentifier;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.OspfInterfaceIdentifier;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.isis.lan.identifier.IsIsRouterIdentifier;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.isis.lan.identifier.IsIsRouterIdentifierBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.destination.c.linkstate.destination.LocalNodeDescriptorsBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.destination.c.linkstate.destination.RemoteNodeDescriptorsBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.CRouterIdentifier;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.IsisNodeCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.IsisNodeCaseBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.IsisPseudonodeCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.IsisPseudonodeCaseBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.OspfNodeCase;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.OspfNodeCaseBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.OspfPseudonodeCase;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.OspfPseudonodeCaseBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.isis.node._case.IsisNode;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.isis.node._case.IsisNodeBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.isis.pseudonode._case.IsisPseudonode;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.isis.pseudonode._case.IsisPseudonodeBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.ospf.node._case.OspfNodeBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.ospf.pseudonode._case.OspfPseudonode;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.identifier.c.router.identifier.ospf.pseudonode._case.OspfPseudonodeBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.IsoSystemIdentifier;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45 final class NodeNlriParser {
  46
  47     private static final Logger LOG = LoggerFactory.getLogger(NodeNlriParser.class);
  48
  49     private static final int OSPF_PSEUDONODE_ROUTER_ID_LENGTH = 8;
  50     private static final int OSPF_ROUTER_ID_LENGTH = 4;
  51     private static final int ISO_SYSTEM_ID_LENGTH = 6;
  52     private static final int PSN_LENGTH = 1;
  53
  54     /* Node Descriptor TLVs */
  55     private static final int AS_NUMBER = 512;
  56     private static final int BGP_LS_ID = 513;
  57     private static final int AREA_ID = 514;
  58     private static final int IGP_ROUTER_ID = 515;
  59
  60     static NodeIdentifier parseNodeDescriptors(final ByteBuf buffer, final boolean local) throws BGPParsingException {
  61         AsNumber asnumber = null;
  62         DomainIdentifier bgpId = null;
  63         AreaIdentifier ai = null;
  64         CRouterIdentifier routerId = null;
  65         while (buffer.isReadable()) {
  66             final int type = buffer.readUnsignedShort();
  67             final int length = buffer.readUnsignedShort();
  68             final ByteBuf value = buffer.readSlice(length);
  69             if (LOG.isTraceEnabled()) {
  70                 LOG.trace("Parsing Node Descriptor: {}", ByteBufUtil.hexDump(value));
  71             }
  72             switch (type) {
  73             case AS_NUMBER:
  74                 asnumber = new AsNumber(value.readUnsignedInt());
  75                 LOG.debug("Parsed {}", asnumber);
  76                 break;
  77             case BGP_LS_ID:
  78                 bgpId = new DomainIdentifier(value.readUnsignedInt());
  79                 LOG.debug("Parsed {}", bgpId);
  80                 break;
  81             case AREA_ID:
  82                 ai = new AreaIdentifier(value.readUnsignedInt());
  83                 LOG.debug("Parsed area identifier {}", ai);
  84                 break;
  85             case IGP_ROUTER_ID:
  86                 routerId = parseRouterId(value);
  87                 LOG.debug("Parsed Router Identifier {}", routerId);
  88                 break;
  89             default:
  90                 throw new BGPParsingException("Node Descriptor not recognized, type: " + type);
  91             }
  92         }
  93         LOG.trace("Finished parsing Node descriptors.");
  94         return (local) ? new LocalNodeDescriptorsBuilder().setAsNumber(asnumber).setDomainId(bgpId).setAreaId(ai).setCRouterIdentifier(
  95             routerId).build()
  96             : new RemoteNodeDescriptorsBuilder().setAsNumber(asnumber).setDomainId(bgpId).setAreaId(ai).setCRouterIdentifier(routerId).build();
  97     }
  98
  99     private static CRouterIdentifier parseRouterId(final ByteBuf value) throws BGPParsingException {
 100         if (value.readableBytes() == ISO_SYSTEM_ID_LENGTH || (value.readableBytes() == ISO_SYSTEM_ID_LENGTH + PSN_LENGTH && value.getByte(ISO_SYSTEM_ID_LENGTH) == 0)) {
 101             return new IsisNodeCaseBuilder().setIsisNode(
 102                 new IsisNodeBuilder().setIsoSystemId(new IsoSystemIdentifier(ByteArray.readBytes(value, ISO_SYSTEM_ID_LENGTH))).build()).build();
 103         }
 104         if (value.readableBytes() == ISO_SYSTEM_ID_LENGTH + PSN_LENGTH) {
 105             final IsIsRouterIdentifier iri = new IsIsRouterIdentifierBuilder().setIsoSystemId(
 106                 new IsoSystemIdentifier(ByteArray.readBytes(value, ISO_SYSTEM_ID_LENGTH))).build();
 107             return new IsisPseudonodeCaseBuilder().setIsisPseudonode(new IsisPseudonodeBuilder().setIsIsRouterIdentifier(iri).setPsn((short) value.readByte()).build()).build();
 108         }
 109         if (value.readableBytes() == OSPF_ROUTER_ID_LENGTH) {
 110             return new OspfNodeCaseBuilder().setOspfNode(
 111                 new OspfNodeBuilder().setOspfRouterId(value.readUnsignedInt()).build()).build();
 112         }
 113         if (value.readableBytes() == OSPF_PSEUDONODE_ROUTER_ID_LENGTH) {
 114             return new OspfPseudonodeCaseBuilder().setOspfPseudonode(
 115                 new OspfPseudonodeBuilder().setOspfRouterId(value.readUnsignedInt()).setLanInterface(new OspfInterfaceIdentifier(value.readUnsignedInt())).build()).build();
 116         }
 117         throw new BGPParsingException("Router Id of invalid length " + value.readableBytes());
 118     }
 119
 120     static void serializeNodeDescriptors(final NodeIdentifier descriptors, final ByteBuf buffer) {
 121         if (descriptors.getAsNumber() != null) {
 122             TlvUtil.writeTLV(AS_NUMBER, Unpooled.copyInt(UnsignedInteger.valueOf(descriptors.getAsNumber().getValue()).intValue()), buffer);
 123         }
 124         if (descriptors.getDomainId() != null) {
 125             TlvUtil.writeTLV(BGP_LS_ID, Unpooled.copyInt(UnsignedInteger.valueOf(descriptors.getDomainId().getValue()).intValue()), buffer);
 126         }
 127         if (descriptors.getAreaId() != null) {
 128             TlvUtil.writeTLV(AREA_ID, Unpooled.copyInt(UnsignedInteger.valueOf(descriptors.getAreaId().getValue()).intValue()), buffer);
 129         }
 130         if (descriptors.getCRouterIdentifier() != null) {
 131             final ByteBuf routerIdBuf = Unpooled.buffer();
 132             serializeRouterId(descriptors.getCRouterIdentifier(), routerIdBuf);
 133             TlvUtil.writeTLV(IGP_ROUTER_ID, routerIdBuf, buffer);
 134         }
 135     }
 136
 137     private static void serializeRouterId(final CRouterIdentifier routerId, final ByteBuf buffer) {
 138         if (routerId instanceof IsisNodeCase) {
 139             final IsisNode isis = ((IsisNodeCase) routerId).getIsisNode();
 140             buffer.writeBytes(isis.getIsoSystemId().getValue());
 141         } else if (routerId instanceof IsisPseudonodeCase) {
 142             final IsisPseudonode isis = ((IsisPseudonodeCase) routerId).getIsisPseudonode();
 143             buffer.writeBytes(isis.getIsIsRouterIdentifier().getIsoSystemId().getValue());
 144             buffer.writeByte(((isis.getPsn() != null) ? isis.getPsn() : 0));
 145         } else if (routerId instanceof OspfNodeCase) {
 146             buffer.writeInt(UnsignedInteger.valueOf(((OspfNodeCase) routerId).getOspfNode().getOspfRouterId()).intValue());
 147         } else if (routerId instanceof OspfPseudonodeCase) {
 148             final OspfPseudonode node = ((OspfPseudonodeCase) routerId).getOspfPseudonode();
 149             buffer.writeInt(UnsignedInteger.valueOf(node.getOspfRouterId()).intValue());
 150             buffer.writeInt(UnsignedInteger.valueOf(node.getLanInterface().getValue()).intValue());
 151         }
 152     }
 153 }