pcep/impl/src/main/java/org/opendaylight/protocol/pcep/impl/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.impl.object;
  10
  11 import com.google.common.base.Preconditions;
  12
  13 import io.netty.buffer.ByteBuf;
  14
  15 import java.util.BitSet;
  16
  17 import org.opendaylight.protocol.pcep.spi.AbstractObjectWithTlvsParser;
  18 import org.opendaylight.protocol.pcep.spi.ObjectUtil;
  19 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
  20 import org.opendaylight.protocol.pcep.spi.TlvRegistry;
  21 import org.opendaylight.protocol.util.ByteArray;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ObjectHeader;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.RequestId;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Tlv;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.order.tlv.Order;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.RpBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.rp.Tlvs;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.rp.TlvsBuilder;
  31
  32 /**
  33  * Parser for {@link Rp}
  34  */
  35 public class PCEPRequestParameterObjectParser extends AbstractObjectWithTlvsParser<RpBuilder> {
  36
  37     public static final int CLASS = 2;
  38
  39     public static final int TYPE = 1;
  40
  41     /*
  42      * lengths of fields in bytes
  43      */
  44     private static final int FLAGS_PRI_MF_LENGTH = 4;
  45     private static final int RID_F_LENGTH = 4;
  46
  47     /*
  48      * lengths of subfields inside multi-field in bits
  49      */
  50     private static final int FLAGS_SF_LENGTH = 29;
  51
  52     /*
  53      * offsets of field in bytes
  54      */
  55
  56     private static final int FLAGS_PRI_MF_OFFSET = 0;
  57     private static final int RID_F_OFFSET = FLAGS_PRI_MF_OFFSET + FLAGS_PRI_MF_LENGTH;
  58     private static final int TLVS_OFFSET = RID_F_OFFSET + RID_F_LENGTH;
  59
  60     /*
  61      * offsets of subfields inside multi-field in bits
  62      */
  63
  64     private static final int FLAGS_SF_OFFSET = 0;
  65     private static final int PRI_SF_OFFSET = FLAGS_SF_OFFSET + FLAGS_SF_LENGTH;
  66
  67     /*
  68      * flags offsets inside flags sub-field in bits
  69      */
  70
  71     private static final int O_FLAG_OFFSET = 26;
  72     private static final int B_FLAG_OFFSET = 27;
  73     private static final int R_FLAG_OFFSET = 28;
  74
  75     /*
  76      * GCO extension flags offsets inside flags sub-field in bits
  77      */
  78     private static final int M_FLAG_OFFSET = 21;
  79     private static final int D_FLAG_OFFSET = 22;
  80
  81     /*
  82      * Path-key bit (RFC5520)
  83      */
  84     private static final int P_FLAG_OFFSET = 23;
  85     /*
  86      * OF extension flags offsets inside flags sub.field in bits
  87      */
  88     private static final int S_FLAG_OFFSET = 24;
  89     /*
  90      * RFC6006 flags
  91      */
  92     private static final int F_FLAG_OFFSET = 18;
  93
  94     private static final int N_FLAG_OFFSET = 19;
  95
  96     private static final int E_FLAG_OFFSET = 20;
  97
  98     public PCEPRequestParameterObjectParser(final TlvRegistry tlvReg) {
  99         super(tlvReg);
 100     }
 101
 102     @Override
 103     public Object parseObject(final ObjectHeader header, final ByteBuf bytes) throws PCEPDeserializerException {
 104         Preconditions.checkArgument(bytes != null && bytes.isReadable(), "Array of bytes is mandatory. Can't be null or empty.");
 105         final BitSet flags = ByteArray.bytesToBitSet(ByteArray.readBytes(bytes, FLAGS_PRI_MF_LENGTH));
 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
 111         final RpBuilder builder = new RpBuilder();
 112         builder.setIgnore(header.isIgnore());
 113         builder.setProcessingRule(header.isProcessingRule());
 114
 115         builder.setPriority(priority);
 116         builder.setFragmentation(flags.get(F_FLAG_OFFSET));
 117         builder.setP2mp(flags.get(N_FLAG_OFFSET));
 118         builder.setEroCompression(flags.get(E_FLAG_OFFSET));
 119         builder.setMakeBeforeBreak(flags.get(M_FLAG_OFFSET));
 120         builder.setOrder(flags.get(D_FLAG_OFFSET));
 121         builder.setPathKey(flags.get(P_FLAG_OFFSET));
 122         builder.setSupplyOf(flags.get(S_FLAG_OFFSET));
 123         builder.setLoose(flags.get(O_FLAG_OFFSET));
 124         builder.setBiDirectional(flags.get(B_FLAG_OFFSET));
 125         builder.setReoptimization(flags.get(R_FLAG_OFFSET));
 126
 127         builder.setRequestId(new RequestId(bytes.readUnsignedInt()));
 128         parseTlvs(builder, bytes.slice());
 129         return builder.build();
 130     }
 131
 132     @Override
 133     public void addTlv(final RpBuilder builder, final Tlv tlv) {
 134         if (tlv instanceof Order) {
 135             builder.setTlvs(new TlvsBuilder().setOrder((Order) tlv).build());
 136         }
 137     }
 138
 139     @Override
 140     public byte[] serializeObject(final Object object) {
 141         if (!(object instanceof Rp)) {
 142             throw new IllegalArgumentException("Wrong instance of PCEPObject. Passed " + object.getClass() + ". Needed RpObject.");
 143         }
 144         final Rp rPObj = (Rp) object;
 145         final BitSet flags = new BitSet(FLAGS_PRI_MF_LENGTH * Byte.SIZE);
 146
 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
 158         flags.set(PRI_SF_OFFSET, (rPObj.getPriority() & 1 << 2) != 0);
 159         flags.set(PRI_SF_OFFSET + 1, (rPObj.getPriority() & 1 << 1) != 0);
 160         flags.set(PRI_SF_OFFSET + 2, (rPObj.getPriority() & 1) != 0);
 161
 162         final byte[] tlvs = serializeTlvs(rPObj.getTlvs());
 163         final byte[] retBytes = new byte[TLVS_OFFSET + tlvs.length + getPadding(TLVS_OFFSET + tlvs.length, PADDED_TO)];
 164
 165         ByteArray.copyWhole(ByteArray.bitSetToBytes(flags, FLAGS_PRI_MF_LENGTH), retBytes, FLAGS_PRI_MF_OFFSET);
 166         ByteArray.copyWhole(ByteArray.longToBytes(rPObj.getRequestId().getValue(), RID_F_LENGTH), retBytes, RID_F_OFFSET);
 167         if (tlvs.length != 0) {
 168             ByteArray.copyWhole(tlvs, retBytes, TLVS_OFFSET);
 169         }
 170         return ObjectUtil.formatSubobject(TYPE, CLASS, object.isProcessingRule(), object.isIgnore(), retBytes);
 171     }
 172
 173     public byte[] serializeTlvs(final Tlvs tlvs) {
 174         if (tlvs == null) {
 175             return new byte[0];
 176         } else if (tlvs.getOrder() != null) {
 177             return serializeTlv(tlvs.getOrder());
 178         }
 179         return new byte[0];
 180     }
 181 }