bgp/linkstate/src/main/java/org/opendaylight/protocol/bgp/linkstate/impl/attribute/sr/SrLinkAttributesParser.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.impl.attribute.sr;
   9
  10 import static org.opendaylight.protocol.bgp.linkstate.impl.attribute.LinkAttributesParser.SR_LAN_ADJ_ID;
  11
  12 import io.netty.buffer.ByteBuf;
  13 import io.netty.buffer.Unpooled;
  14 import java.util.List;
  15 import org.opendaylight.protocol.bgp.linkstate.impl.attribute.sr.SidLabelIndexParser.Size;
  16 import org.opendaylight.protocol.bgp.linkstate.spi.TlvUtil;
  17 import org.opendaylight.protocol.util.BitArray;
  18 import org.opendaylight.protocol.util.ByteArray;
  19 import org.opendaylight.protocol.util.Ipv4Util;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.ProtocolId;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.attribute.SrAdjIds;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.attribute.SrAdjIdsBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.attribute.SrLanAdjIds;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.attribute.SrLanAdjIdsBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.EpeAdjSidTlv;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.Weight;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.adj.flags.Flags;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.adj.flags.flags.IsisAdjFlagsCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.adj.flags.flags.IsisAdjFlagsCaseBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.adj.flags.flags.OspfAdjFlagsCase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.adj.flags.flags.OspfAdjFlagsCaseBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.sid.label.index.SidLabelIndex;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.IsoSystemIdentifier;
  34 import org.opendaylight.yangtools.yang.binding.DataContainer;
  35
  36 public final class SrLinkAttributesParser {
  37
  38     private static final int ISO_SYSTEM_ID_SIZE = 6;
  39     private static final int RESERVED = 2;
  40
  41     /* Adj-SID flags */
  42     private static final int ADDRESS_FAMILY_FLAG = 0;
  43     private static final int BACKUP_ISIS = 1;
  44     private static final int BACKUP_OSPF = 0;
  45     private static final int VALUE_ISIS = 2;
  46     private static final int VALUE_OSPF = 1;
  47     private static final int VALUE_EPE = 0;
  48     private static final int LOCAL_ISIS = 3;
  49     private static final int LOCAL_OSPF = 2;
  50     private static final int LOCAL_EPE = 1;
  51     private static final int SET_ISIS = 4;
  52     private static final int SET_OSPF = 3;
  53     private static final int FLAGS_BITS_SIZE = 8;
  54     private static final int FLAGS_BYTE_SIZE = 1;
  55
  56     /** OSPF flags
  57        0 1 2 3 4 5 6 7
  58       +-+-+-+-+-+-+-+-+
  59       |B|V|L|S|       |
  60       +-+-+-+-+-+-+-+-+
  61
  62        ISIS flags
  63        0 1 2 3 4 5 6 7
  64       +-+-+-+-+-+-+-+-+
  65       |F|B|V|L|S|     |
  66       +-+-+-+-+-+-+-+-+
  67      */
  68
  69     private SrLinkAttributesParser() {
  70         throw new UnsupportedOperationException();
  71     }
  72
  73     public static SrAdjIds parseAdjacencySegmentIdentifier(final ByteBuf buffer, final ProtocolId protocolId) {
  74         final Flags adjFlags;
  75         final Weight weight;
  76         final SidLabelIndex sidValue;
  77         if (buffer.isReadable()) {
  78             final BitArray flags = BitArray.valueOf(buffer, FLAGS_BITS_SIZE);
  79             adjFlags = parseFlags(flags, protocolId);
  80             weight = new Weight(buffer.readUnsignedByte());
  81             buffer.skipBytes(RESERVED);
  82             sidValue = SidLabelIndexParser.parseSidLabelIndex(Size.forValue(buffer.readableBytes()), buffer);
  83         } else {
  84             adjFlags = null;
  85             weight = null;
  86             sidValue = null;
  87         }
  88         return new SrAdjIdsBuilder().setFlags(adjFlags).setSidLabelIndex(sidValue).setWeight(weight).build();
  89     }
  90
  91     public static EpeAdjSidTlv parseEpeAdjacencySegmentIdentifier(final ByteBuf buffer) {
  92         final Weight weight;
  93         final SidLabelIndex sidValue;
  94         if (buffer.isReadable()) {
  95             buffer.skipBytes(FLAGS_BYTE_SIZE);
  96             weight = new Weight(buffer.readUnsignedByte());
  97             buffer.skipBytes(RESERVED);
  98             sidValue = SidLabelIndexParser.parseSidLabelIndex(Size.forValue(buffer.readableBytes()), buffer);
  99         } else {
 100             weight = null;
 101             sidValue = null;
 102         }
 103         return new EpeAdjSidTlv() {
 104             @Override
 105             public Class<? extends DataContainer> getImplementedInterface() {
 106                 return EpeAdjSidTlv.class;
 107             }
 108             @Override
 109             public Weight getWeight() {
 110                 return weight;
 111             }
 112             @Override
 113             public SidLabelIndex getSidLabelIndex() {
 114                 return sidValue;
 115             }
 116         };
 117     }
 118
 119     public static SrLanAdjIds parseLanAdjacencySegmentIdentifier(final ByteBuf buffer, final ProtocolId protocolId) {
 120         if (!buffer.isReadable()) {
 121             return new SrLanAdjIdsBuilder().build();
 122         }
 123         final SrLanAdjIdsBuilder srLanAdjIdBuilder = new SrLanAdjIdsBuilder();
 124         final BitArray flags = BitArray.valueOf(buffer, FLAGS_BITS_SIZE);
 125         srLanAdjIdBuilder.setFlags(parseFlags(flags, protocolId));
 126         srLanAdjIdBuilder.setWeight(new Weight(buffer.readUnsignedByte()));
 127         buffer.skipBytes(RESERVED);
 128         switch (protocolId) {
 129         case IsisLevel1:
 130         case IsisLevel2:
 131             srLanAdjIdBuilder.setIsoSystemId(new IsoSystemIdentifier(ByteArray.readBytes(buffer, ISO_SYSTEM_ID_SIZE)));
 132             break;
 133         case Ospf:
 134         case OspfV3:
 135             srLanAdjIdBuilder.setNeighborId(Ipv4Util.addressForByteBuf(buffer));
 136             break;
 137         default:
 138             return null;
 139         }
 140         // length determines a type of next field, which is used for parsing
 141         srLanAdjIdBuilder.setSidLabelIndex(SidLabelIndexParser.parseSidLabelIndex(Size.forValue(buffer.readableBytes()), buffer));
 142         return srLanAdjIdBuilder.build();
 143     }
 144
 145     private static Flags parseFlags(final BitArray flags, final ProtocolId protocol) {
 146         if (protocol == null) {
 147             return null;
 148         }
 149         switch (protocol) {
 150         case IsisLevel1:
 151         case IsisLevel2:
 152             return new IsisAdjFlagsCaseBuilder().setAddressFamily(flags.get(ADDRESS_FAMILY_FLAG)).setBackup(flags.get(BACKUP_ISIS))
 153                 .setSet(flags.get(SET_ISIS)).build();
 154         case Ospf:
 155         case OspfV3:
 156             return new OspfAdjFlagsCaseBuilder().setBackup(flags.get(BACKUP_OSPF)).setSet(flags.get(SET_OSPF)).build();
 157         default:
 158             return null;
 159         }
 160     }
 161
 162     public static <T extends EpeAdjSidTlv> void serializeAdjacencySegmentIdentifiers(final List<T> adjSids, final int type, final ByteBuf byteAggregator) {
 163         adjSids.forEach(id -> TlvUtil.writeTLV(type, serializeAdjacencySegmentIdentifier(id), byteAggregator));
 164     }
 165
 166     public static <T extends EpeAdjSidTlv> ByteBuf serializeAdjacencySegmentIdentifier(final T adjSid) {
 167         final ByteBuf value = Unpooled.buffer();
 168         if(adjSid instanceof SrAdjIds) {
 169             final BitArray flags = serializeAdjFlags(((SrAdjIds) adjSid).getFlags(), adjSid.getSidLabelIndex());
 170             flags.toByteBuf(value);
 171         }else {
 172             value.writeZero(FLAGS_BYTE_SIZE);
 173         }
 174         value.writeByte(adjSid.getWeight().getValue());
 175         value.writeZero(RESERVED);
 176         value.writeBytes(SidLabelIndexParser.serializeSidValue(adjSid.getSidLabelIndex()));
 177         return value;
 178     }
 179
 180     public static void serializeLanAdjacencySegmentIdentifiers(final List<SrLanAdjIds> srLanAdjIds, final ByteBuf byteAggregator) {
 181         for (final SrLanAdjIds id : srLanAdjIds) {
 182             TlvUtil.writeTLV(SR_LAN_ADJ_ID, serializeLanAdjacencySegmentIdentifier(id), byteAggregator);
 183         }
 184     }
 185
 186     public static ByteBuf serializeLanAdjacencySegmentIdentifier(final SrLanAdjIds srLanAdjId) {
 187         final ByteBuf value = Unpooled.buffer();
 188         final BitArray flags = serializeAdjFlags(srLanAdjId.getFlags(), srLanAdjId.getSidLabelIndex());
 189         flags.toByteBuf(value);
 190         value.writeByte(srLanAdjId.getWeight().getValue());
 191         value.writeZero(RESERVED);
 192         if (srLanAdjId.getIsoSystemId() != null) {
 193             value.writeBytes(srLanAdjId.getIsoSystemId().getValue());
 194         } else if (srLanAdjId.getNeighborId() != null) {
 195             value.writeBytes(Ipv4Util.byteBufForAddress(srLanAdjId.getNeighborId()));
 196         }
 197         value.writeBytes(SidLabelIndexParser.serializeSidValue(srLanAdjId.getSidLabelIndex()));
 198         return value;
 199     }
 200
 201     private static BitArray serializeAdjFlags(final Flags flags, final SidLabelIndex sidLabelIndex) {
 202         final BitArray bitFlags = new BitArray(FLAGS_BITS_SIZE);
 203         if (flags instanceof OspfAdjFlagsCase) {
 204             final OspfAdjFlagsCase ospfFlags = (OspfAdjFlagsCase) flags;
 205             bitFlags.set(BACKUP_OSPF, ospfFlags.isBackup());
 206             bitFlags.set(SET_OSPF, ospfFlags.isSet());
 207             SidLabelIndexParser.setFlags(sidLabelIndex, bitFlags, VALUE_OSPF, LOCAL_OSPF);
 208         } else if (flags instanceof IsisAdjFlagsCase) {
 209             final IsisAdjFlagsCase isisFlags = (IsisAdjFlagsCase) flags;
 210             bitFlags.set(ADDRESS_FAMILY_FLAG, isisFlags.isAddressFamily());
 211             bitFlags.set(BACKUP_ISIS, isisFlags.isBackup());
 212             bitFlags.set(SET_ISIS, isisFlags.isSet());
 213             SidLabelIndexParser.setFlags(sidLabelIndex, bitFlags, VALUE_ISIS, LOCAL_ISIS);
 214         } else if (flags == null){
 215             SidLabelIndexParser.setFlags(sidLabelIndex, bitFlags, VALUE_EPE, LOCAL_EPE);
 216         }
 217         return bitFlags;
 218     }
 219
 220 }