pcep/ietf-stateful/src/main/java/org/opendaylight/protocol/pcep/ietf/stateful/StatefulLspObjectParser.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.pcep.ietf.stateful;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.primitives.UnsignedBytes;
  13 import io.netty.buffer.ByteBuf;
  14 import io.netty.buffer.Unpooled;
  15 import java.util.List;
  16 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
  17 import org.opendaylight.protocol.pcep.spi.AbstractObjectWithTlvsParser;
  18 import org.opendaylight.protocol.pcep.spi.ObjectUtil;
  19 import org.opendaylight.protocol.pcep.spi.TlvRegistry;
  20 import org.opendaylight.protocol.pcep.spi.VendorInformationTlvRegistry;
  21 import org.opendaylight.protocol.util.BitArray;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.OperationalStatus;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.PlspId;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.error.code.tlv.LspErrorCode;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.identifiers.tlv.LspIdentifiers;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.object.Lsp;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.object.LspBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.object.lsp.Tlvs;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.object.lsp.TlvsBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.path.binding.tlv.PathBinding;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.rsvp.error.spec.tlv.RsvpErrorSpec;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.symbolic.path.name.tlv.SymbolicPathName;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Tlv;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vendor.information.tlvs.VendorInformationTlv;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vs.tlv.VsTlv;
  38 import org.opendaylight.yangtools.yang.common.Uint32;
  39
  40 /**
  41  * Parser for {@link Lsp}.
  42  */
  43 public class StatefulLspObjectParser extends AbstractObjectWithTlvsParser<TlvsBuilder> {
  44
  45     private static final int CLASS = 32;
  46
  47     private static final int TYPE = 1;
  48
  49     /*
  50      * 12b extended to 16b so first 4b are restricted (belongs to LSP ID)
  51      */
  52     protected static final int DELEGATE = 11;
  53     protected static final int SYNC = 10;
  54     protected static final int REMOVE = 9;
  55     protected static final int ADMINISTRATIVE = 8;
  56     protected static final int OPERATIONAL = 5;
  57
  58     protected static final int FOUR_BITS_SHIFT = 4;
  59     protected static final int FLAGS_SIZE = 12;
  60
  61     public StatefulLspObjectParser(final TlvRegistry tlvReg, final VendorInformationTlvRegistry viTlvReg) {
  62         super(tlvReg, viTlvReg, CLASS, TYPE);
  63     }
  64
  65     @Override
  66     public Lsp parseObject(final ObjectHeader header, final ByteBuf bytes) throws PCEPDeserializerException {
  67         checkArgument(bytes != null && bytes.isReadable(), "Array of bytes is mandatory. Can't be null or empty.");
  68         final LspBuilder builder = new LspBuilder()
  69             .setIgnore(header.getIgnore())
  70             .setProcessingRule(header.getProcessingRule());
  71         final int[] plspIdRaw
  72             = new int[] { bytes.readUnsignedByte(), bytes.readUnsignedByte(), bytes.getUnsignedByte(2), };
  73         builder.setPlspId(new PlspId(Uint32.valueOf(plspIdRaw[0] << FLAGS_SIZE | plspIdRaw[1] << FOUR_BITS_SHIFT
  74             | plspIdRaw[2] >> FOUR_BITS_SHIFT)));
  75         parseFlags(builder, bytes);
  76         final TlvsBuilder b = new TlvsBuilder();
  77         parseTlvs(b, bytes.slice());
  78         builder.setTlvs(b.build());
  79         return builder.build();
  80     }
  81
  82     protected void parseFlags(final LspBuilder builder, final ByteBuf bytes) {
  83         final BitArray flags = BitArray.valueOf(bytes, FLAGS_SIZE);
  84         builder.setDelegate(flags.get(DELEGATE));
  85         builder.setSync(flags.get(SYNC));
  86         builder.setRemove(flags.get(REMOVE));
  87         builder.setAdministrative(flags.get(ADMINISTRATIVE));
  88         short oper = 0;
  89         oper |= flags.get(OPERATIONAL + 2) ? 1 : 0;
  90         oper |= (flags.get(OPERATIONAL + 1) ? 1 : 0) << 1;
  91         oper |= (flags.get(OPERATIONAL) ? 1 : 0) << 2;
  92         builder.setOperational(OperationalStatus.forValue(oper));
  93     }
  94
  95     @Override
  96     public void addTlv(final TlvsBuilder builder, final Tlv tlv) {
  97         if (tlv instanceof LspErrorCode) {
  98             builder.setLspErrorCode((LspErrorCode) tlv);
  99         } else if (tlv instanceof LspIdentifiers) {
 100             builder.setLspIdentifiers((LspIdentifiers) tlv);
 101         } else if (tlv instanceof RsvpErrorSpec) {
 102             builder.setRsvpErrorSpec((RsvpErrorSpec) tlv);
 103         } else if (tlv instanceof SymbolicPathName) {
 104             builder.setSymbolicPathName((SymbolicPathName) tlv);
 105         } else if (tlv instanceof VsTlv) {
 106             builder.setVsTlv((VsTlv) tlv);
 107         } else if (tlv instanceof PathBinding) {
 108             builder.setPathBinding((PathBinding) tlv);
 109         }
 110     }
 111
 112     @Override
 113     public void serializeObject(final Object object, final ByteBuf buffer) {
 114         checkArgument(object instanceof Lsp, "Wrong instance of PCEPObject. Passed %s . Needed LspObject.",
 115             object.getClass());
 116         final Lsp specObj = (Lsp) object;
 117         final ByteBuf body = Unpooled.buffer();
 118         final PlspId plspId = specObj.getPlspId();
 119         checkArgument(plspId != null, "PLSP-ID not present");
 120         body.writeMedium(plspId.getValue().intValue() << FOUR_BITS_SHIFT);
 121         final BitArray flags = serializeFlags(specObj);
 122         byte op = 0;
 123         if (specObj.getOperational() != null) {
 124             op = UnsignedBytes.checkedCast(specObj.getOperational().getIntValue());
 125             op = (byte) (op << FOUR_BITS_SHIFT);
 126         }
 127         final byte[] res = flags.array();
 128         res[res.length - 1] = (byte) (res[res.length - 1] | op);
 129         body.writeByte(res[res.length - 1]);
 130         serializeTlvs(specObj.getTlvs(), body);
 131         ObjectUtil.formatSubobject(TYPE, CLASS, object.getProcessingRule(), object.getIgnore(), body, buffer);
 132     }
 133
 134     protected BitArray serializeFlags(final Lsp specObj) {
 135         final BitArray flags = new BitArray(FLAGS_SIZE);
 136         flags.set(DELEGATE, specObj.getDelegate());
 137         flags.set(REMOVE, specObj.getRemove());
 138         flags.set(SYNC, specObj.getSync());
 139         flags.set(ADMINISTRATIVE, specObj.getAdministrative());
 140         return flags;
 141     }
 142
 143     public void serializeTlvs(final Tlvs tlvs, final ByteBuf body) {
 144         if (tlvs == null) {
 145             return;
 146         }
 147         if (tlvs.getLspErrorCode() != null) {
 148             serializeTlv(tlvs.getLspErrorCode(), body);
 149         }
 150         if (tlvs.getLspIdentifiers() != null) {
 151             serializeTlv(tlvs.getLspIdentifiers(), body);
 152         }
 153         if (tlvs.getRsvpErrorSpec() != null) {
 154             serializeTlv(tlvs.getRsvpErrorSpec(), body);
 155         }
 156         if (tlvs.getSymbolicPathName() != null) {
 157             serializeTlv(tlvs.getSymbolicPathName(), body);
 158         }
 159         if (tlvs.getVsTlv() != null) {
 160             serializeTlv(tlvs.getVsTlv(), body);
 161         }
 162         serializeVendorInformationTlvs(tlvs.getVendorInformationTlv(), body);
 163         if (tlvs.getPathBinding() != null) {
 164             serializeTlv(tlvs.getPathBinding(), body);
 165         }
 166     }
 167
 168     @Override
 169     protected final void addVendorInformationTlvs(final TlvsBuilder builder, final List<VendorInformationTlv> tlvs) {
 170         if (!tlvs.isEmpty()) {
 171             builder.setVendorInformationTlv(tlvs);
 172         }
 173     }
 174 }