pcep/base-parser/src/main/java/org/opendaylight/protocol/pcep/parser/object/PCEPRequestParameterObjectParser.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
   9 package org.opendaylight.protocol.pcep.parser.object;
  10
  11 import static org.opendaylight.protocol.util.ByteBufWriteUtil.writeUnsignedInt;
  12
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.primitives.UnsignedBytes;
  15 import io.netty.buffer.ByteBuf;
  16 import io.netty.buffer.Unpooled;
  17 import java.util.List;
  18 import org.opendaylight.protocol.pcep.spi.AbstractObjectWithTlvsParser;
  19 import org.opendaylight.protocol.pcep.spi.ObjectUtil;
  20 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
  21 import org.opendaylight.protocol.pcep.spi.TlvRegistry;
  22 import org.opendaylight.protocol.pcep.spi.VendorInformationTlvRegistry;
  23 import org.opendaylight.protocol.util.BitArray;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ObjectHeader;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.RequestId;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Tlv;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.order.tlv.Order;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.path.setup.type.tlv.PathSetupType;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.RpBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.rp.Tlvs;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.rp.TlvsBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.vendor.information.tlvs.VendorInformationTlv;
  35
  36 /**
  37  * Parser for {@link Rp}
  38  */
  39 public class PCEPRequestParameterObjectParser extends AbstractObjectWithTlvsParser<TlvsBuilder> {
  40
  41     public static final int CLASS = 2;
  42
  43     public static final int TYPE = 1;
  44
  45     /*
  46      * lengths of fields in bytes
  47      */
  48     private static final int FLAGS_SIZE = 32;
  49
  50     /*
  51      * lengths of subfields inside multi-field in bits
  52      */
  53     private static final int FLAGS_SF_LENGTH = 29;
  54
  55     /*
  56      * offsets of subfields inside multi-field in bits
  57      */
  58
  59     private static final int FLAGS_SF_OFFSET = 0;
  60     private static final int PRI_SF_OFFSET = FLAGS_SF_OFFSET + FLAGS_SF_LENGTH;
  61
  62     /*
  63      * flags offsets inside flags sub-field in bits
  64      */
  65
  66     private static final int O_FLAG_OFFSET = 26;
  67     private static final int B_FLAG_OFFSET = 27;
  68     private static final int R_FLAG_OFFSET = 28;
  69
  70     /*
  71      * GCO extension flags offsets inside flags sub-field in bits
  72      */
  73     private static final int M_FLAG_OFFSET = 21;
  74     private static final int D_FLAG_OFFSET = 22;
  75
  76     /*
  77      * Path-key bit (RFC5520)
  78      */
  79     private static final int P_FLAG_OFFSET = 23;
  80     /*
  81      * OF extension flags offsets inside flags sub.field in bits
  82      */
  83     private static final int S_FLAG_OFFSET = 24;
  84     /*
  85      * RFC6006 flags
  86      */
  87     private static final int F_FLAG_OFFSET = 18;
  88
  89     private static final int N_FLAG_OFFSET = 19;
  90
  91     private static final int E_FLAG_OFFSET = 20;
  92
  93     public PCEPRequestParameterObjectParser(final TlvRegistry tlvReg, final VendorInformationTlvRegistry viTlvReg) {
  94         super(tlvReg, viTlvReg);
  95     }
  96
  97     @Override
  98     public Object parseObject(final ObjectHeader header, final ByteBuf bytes) throws PCEPDeserializerException {
  99         Preconditions.checkArgument(bytes != null && bytes.isReadable(), "Array of bytes is mandatory. Can't be null or empty.");
 100         final BitArray flags = BitArray.valueOf(bytes, FLAGS_SIZE);
 101
 102         final RpBuilder builder = new RpBuilder();
 103         builder.setIgnore(header.isIgnore());
 104         builder.setProcessingRule(header.isProcessingRule());
 105
 106         short priority = 0;
 107         priority |= flags.get(PRI_SF_OFFSET + 2) ? 1 : 0;
 108         priority |= (flags.get(PRI_SF_OFFSET + 1) ? 1 : 0) << 1;
 109         priority |= (flags.get(PRI_SF_OFFSET) ? 1 : 0) << 2;
 110         if (priority != 0) {
 111             builder.setPriority(priority);
 112         }
 113         builder.setFragmentation(flags.get(F_FLAG_OFFSET));
 114         builder.setP2mp(flags.get(N_FLAG_OFFSET));
 115         builder.setEroCompression(flags.get(E_FLAG_OFFSET));
 116         builder.setMakeBeforeBreak(flags.get(M_FLAG_OFFSET));
 117         builder.setOrder(flags.get(D_FLAG_OFFSET));
 118         builder.setPathKey(flags.get(P_FLAG_OFFSET));
 119         builder.setSupplyOf(flags.get(S_FLAG_OFFSET));
 120         builder.setLoose(flags.get(O_FLAG_OFFSET));
 121         builder.setBiDirectional(flags.get(B_FLAG_OFFSET));
 122         builder.setReoptimization(flags.get(R_FLAG_OFFSET));
 123
 124         builder.setRequestId(new RequestId(bytes.readUnsignedInt()));
 125         final TlvsBuilder tlvsBuilder = new TlvsBuilder();
 126         parseTlvs(tlvsBuilder, bytes.slice());
 127         builder.setTlvs(tlvsBuilder.build());
 128         return builder.build();
 129     }
 130
 131     @Override
 132     public void addTlv(final TlvsBuilder builder, final Tlv tlv) {
 133         if (tlv instanceof Order) {
 134             builder.setOrder((Order) tlv);
 135         }
 136         if (tlv instanceof PathSetupType) {
 137             builder.setPathSetupType((PathSetupType) tlv);
 138         }
 139     }
 140
 141     @Override
 142     public void serializeObject(final Object object, final ByteBuf buffer) {
 143         Preconditions.checkArgument(object instanceof Rp, "Wrong instance of PCEPObject. Passed %s. Needed RPObject.", object.getClass());
 144         final ByteBuf body = Unpooled.buffer();
 145         final Rp rpObj = (Rp) object;
 146         final BitArray flags = new BitArray(FLAGS_SIZE);
 147         flags.set(R_FLAG_OFFSET, rpObj.isReoptimization());
 148         flags.set(B_FLAG_OFFSET, rpObj.isBiDirectional());
 149         flags.set(O_FLAG_OFFSET, rpObj.isLoose());
 150         flags.set(M_FLAG_OFFSET, rpObj.isMakeBeforeBreak());
 151         flags.set(D_FLAG_OFFSET, rpObj.isOrder());
 152         flags.set(P_FLAG_OFFSET, rpObj.isPathKey());
 153         flags.set(S_FLAG_OFFSET, rpObj.isSupplyOf());
 154         flags.set(F_FLAG_OFFSET, rpObj.isFragmentation());
 155         flags.set(N_FLAG_OFFSET, rpObj.isP2mp());
 156         flags.set(E_FLAG_OFFSET, rpObj.isEroCompression());
 157         final byte[] res = flags.array();
 158         if (rpObj.getPriority() != null) {
 159             final byte p = UnsignedBytes.checkedCast(rpObj.getPriority().shortValue());
 160             res[res.length -1] = (byte) (res[res.length -1] | p);
 161         }
 162         body.writeBytes(res);
 163         Preconditions.checkArgument(rpObj.getRequestId() != null, "RequestId is mandatory");
 164         writeUnsignedInt(rpObj.getRequestId().getValue(), body);
 165         serializeTlvs(rpObj.getTlvs(), body);
 166         ObjectUtil.formatSubobject(TYPE, CLASS, object.isProcessingRule(), object.isIgnore(), body, buffer);
 167     }
 168
 169     public void serializeTlvs(final Tlvs tlvs, final ByteBuf body) {
 170         if (tlvs == null) {
 171             return;
 172         }
 173         if (tlvs.getOrder() != null) {
 174             serializeTlv(tlvs.getOrder(), body);
 175         }
 176         if (tlvs.getPathSetupType() != null) {
 177             serializeTlv(tlvs.getPathSetupType(), body);
 178         }
 179         serializeVendorInformationTlvs(tlvs.getVendorInformationTlv(), body);
 180     }
 181
 182     @Override
 183     protected final void addVendorInformationTlvs(final TlvsBuilder builder, final List<VendorInformationTlv> tlvs) {
 184         if (!tlvs.isEmpty()) {
 185             builder.setVendorInformationTlv(tlvs);
 186         }
 187     }
 188 }