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