pcep/ietf-stateful07/src/main/java/org/opendaylight/protocol/pcep/ietf/stateful07/Stateful07LspObjectParser.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.stateful07;
   9
  10 import static org.opendaylight.protocol.util.ByteBufWriteUtil.writeMedium;
  11 import com.google.common.base.Preconditions;
  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.spi.AbstractObjectWithTlvsParser;
  17 import org.opendaylight.protocol.pcep.spi.ObjectUtil;
  18 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
  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.rev181109.OperationalStatus;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.PlspId;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.error.code.tlv.LspErrorCode;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.identifiers.tlv.LspIdentifiers;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.Lsp;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.LspBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.lsp.Tlvs;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.lsp.TlvsBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.path.binding.tlv.PathBinding;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.rsvp.error.spec.tlv.RsvpErrorSpec;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.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
  39 /**
  40  * Parser for {@link Lsp}
  41  */
  42 public class Stateful07LspObjectParser extends AbstractObjectWithTlvsParser<TlvsBuilder> {
  43
  44     private static final int CLASS = 32;
  45
  46     private static final int TYPE = 1;
  47
  48     /*
  49      * 12b extended to 16b so first 4b are restricted (belongs to LSP ID)
  50      */
  51     protected static final int DELEGATE = 11;
  52     protected static final int SYNC = 10;
  53     protected static final int REMOVE = 9;
  54     protected static final int ADMINISTRATIVE = 8;
  55     protected static final int OPERATIONAL = 5;
  56
  57     protected static final int FOUR_BITS_SHIFT = 4;
  58     protected static final int FLAGS_SIZE = 12;
  59
  60     public Stateful07LspObjectParser(final TlvRegistry tlvReg, final VendorInformationTlvRegistry viTlvReg) {
  61         super(tlvReg, viTlvReg, CLASS, TYPE);
  62     }
  63
  64     @Override
  65     public Lsp parseObject(final ObjectHeader header, final ByteBuf bytes) throws PCEPDeserializerException {
  66         Preconditions.checkArgument(bytes != null && bytes.isReadable(),
  67             "Array of bytes is mandatory. Can't be null or empty.");
  68         final LspBuilder builder = new LspBuilder();
  69         builder.setIgnore(header.isIgnore());
  70         builder.setProcessingRule(header.isProcessingRule());
  71         final int[] plspIdRaw
  72             = new int[] { bytes.readUnsignedByte(), bytes.readUnsignedByte(), bytes.getUnsignedByte(2), };
  73         builder.setPlspId(new PlspId((long) ((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 s = 0;
  89         s |= flags.get(OPERATIONAL + 2) ? 1 : 0;
  90         s |= (flags.get(OPERATIONAL + 1) ? 1 : 0) << 1;
  91         s |= (flags.get(OPERATIONAL) ? 1 : 0) << 2;
  92         builder.setOperational(OperationalStatus.forValue(s));
  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         Preconditions.checkArgument(object instanceof Lsp, "Wrong instance of PCEPObject. Passed %s . Needed LspObject.", object.getClass());
 115         final Lsp specObj = (Lsp) object;
 116         final ByteBuf body = Unpooled.buffer();
 117         Preconditions.checkArgument(specObj.getPlspId() != null, "PLSP-ID not present");
 118         writeMedium(specObj.getPlspId().getValue().intValue() << FOUR_BITS_SHIFT, body);
 119         final BitArray flags = serializeFlags(specObj);
 120         byte op = 0;
 121         if (specObj.getOperational() != null) {
 122             op = UnsignedBytes.checkedCast(specObj.getOperational().getIntValue());
 123             op = (byte) (op << FOUR_BITS_SHIFT);
 124         }
 125         final byte[] res = flags.array();
 126         res[res.length -1] = (byte) (res[res.length -1] | op);
 127         body.writeByte(res[res.length -1]);
 128         serializeTlvs(specObj.getTlvs(), body);
 129         ObjectUtil.formatSubobject(TYPE, CLASS, object.isProcessingRule(), object.isIgnore(), body, buffer);
 130     }
 131
 132     protected BitArray serializeFlags(final Lsp specObj) {
 133         final BitArray flags = new BitArray(FLAGS_SIZE);
 134         flags.set(DELEGATE, specObj.isDelegate());
 135         flags.set(REMOVE, specObj.isRemove());
 136         flags.set(SYNC, specObj.isSync());
 137         flags.set(ADMINISTRATIVE, specObj.isAdministrative());
 138         return flags;
 139     }
 140
 141     public void serializeTlvs(final Tlvs tlvs, final ByteBuf body) {
 142         if (tlvs == null) {
 143             return;
 144         }
 145         if (tlvs.getLspErrorCode() != null) {
 146             serializeTlv(tlvs.getLspErrorCode(), body);
 147         }
 148         if (tlvs.getLspIdentifiers() != null) {
 149             serializeTlv(tlvs.getLspIdentifiers(), body);
 150         }
 151         if (tlvs.getRsvpErrorSpec() != null) {
 152             serializeTlv(tlvs.getRsvpErrorSpec(), body);
 153         }
 154         if (tlvs.getSymbolicPathName() != null) {
 155             serializeTlv(tlvs.getSymbolicPathName(), body);
 156         }
 157         if (tlvs.getVsTlv() != null) {
 158             serializeTlv(tlvs.getVsTlv(), body);
 159         }
 160         serializeVendorInformationTlvs(tlvs.getVendorInformationTlv(), body);
 161         if (tlvs.getPathBinding() != null) {
 162             serializeTlv(tlvs.getPathBinding(), body);
 163         }
 164     }
 165
 166     @Override
 167     protected final void addVendorInformationTlvs(final TlvsBuilder builder, final List<VendorInformationTlv> tlvs) {
 168         if (!tlvs.isEmpty()) {
 169             builder.setVendorInformationTlv(tlvs);
 170         }
 171     }
 172 }