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 java.util.Arrays;
  12 import java.util.BitSet;
  13
  14 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
  15 import org.opendaylight.protocol.pcep.PCEPDocumentedException;
  16 import org.opendaylight.protocol.pcep.spi.TlvHandlerRegistry;
  17 import org.opendaylight.protocol.util.ByteArray;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ObjectHeader;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.RequestId;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Tlv;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.order.tlv.Order;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.RpBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.rp.Tlvs;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.rp.TlvsBuilder;
  27
  28 /**
  29  * Parser for {@link Rp}
  30  */
  31 public class PCEPRequestParameterObjectParser extends AbstractObjectWithTlvsParser<RpBuilder> {
  32
  33         public static final int CLASS = 2;
  34
  35         public static final int TYPE = 1;
  36
  37         /*
  38          * lengths of fields in bytes
  39          */
  40         private static final int FLAGS_PRI_MF_LENGTH = 4;
  41         private static final int RID_F_LENGTH = 4;
  42
  43         /*
  44          * lengths of subfields inside multi-field in bits
  45          */
  46         private static final int FLAGS_SF_LENGTH = 29;
  47
  48         /*
  49          * offsets of field in bytes
  50          */
  51
  52         private static final int FLAGS_PRI_MF_OFFSET = 0;
  53         private static final int RID_F_OFFSET = FLAGS_PRI_MF_OFFSET + FLAGS_PRI_MF_LENGTH;
  54         private static final int TLVS_OFFSET = RID_F_OFFSET + RID_F_LENGTH;
  55
  56         /*
  57          * offsets of subfields inside multi-field in bits
  58          */
  59
  60         private static final int FLAGS_SF_OFFSET = 0;
  61         private static final int PRI_SF_OFFSET = FLAGS_SF_OFFSET + FLAGS_SF_LENGTH;
  62
  63         /*
  64          * flags offsets inside flags sub-field in bits
  65          */
  66
  67         private static final int O_FLAG_OFFSET = 26;
  68         private static final int B_FLAG_OFFSET = 27;
  69         private static final int R_FLAG_OFFSET = 28;
  70
  71         /*
  72          * GCO extension flags offsets inside flags sub-field in bits
  73          */
  74         private static final int M_FLAG_OFFSET = 21;
  75         private static final int D_FLAG_OFFSET = 22;
  76
  77         /*
  78          * OF extension flags offsets inside flags sub.field in bits
  79          */
  80
  81         private static final int S_FLAG_OFFSET = 24;
  82         /*
  83          * RFC6006 flags
  84          */
  85         private static final int F_FLAG_OFFSET = 18;
  86
  87         private static final int N_FLAG_OFFSET = 19;
  88
  89         private static final int E_FLAG_OFFSET = 20;
  90
  91         public PCEPRequestParameterObjectParser(final TlvHandlerRegistry tlvReg) {
  92                 super(tlvReg);
  93         }
  94
  95         @Override
  96         public Rp parseObject(final ObjectHeader header, final byte[] bytes) throws PCEPDeserializerException, PCEPDocumentedException {
  97                 if (bytes == null || bytes.length == 0) {
  98                         throw new IllegalArgumentException("Array of bytes is mandatory. Can't be null or empty.");
  99                 }
 100
 101                 final BitSet flags = ByteArray.bytesToBitSet(Arrays.copyOfRange(bytes, FLAGS_PRI_MF_OFFSET, FLAGS_PRI_MF_OFFSET
 102                                 + FLAGS_PRI_MF_LENGTH));
 103                 short priority = 0;
 104                 priority |= flags.get(PRI_SF_OFFSET + 2) ? 1 : 0;
 105                 priority |= (flags.get(PRI_SF_OFFSET + 1) ? 1 : 0) << 1;
 106                 priority |= (flags.get(PRI_SF_OFFSET) ? 1 : 0) << 2;
 107
 108                 final RpBuilder builder = new RpBuilder();
 109                 builder.setIgnore(header.isIgnore());
 110                 // FIXME: change binary files
 111                 // if (!header.isProcessingRule()) {
 112                 // throw new PCEPDocumentedException("P flag is not set.", PCEPErrors.P_FLAG_NOT_SET);
 113                 // }
 114                 builder.setProcessingRule(header.isProcessingRule());
 115
 116                 builder.setPriority(priority);
 117                 builder.setFragmentation(flags.get(F_FLAG_OFFSET));
 118                 builder.setP2mp(flags.get(N_FLAG_OFFSET));
 119                 builder.setEroCompression(flags.get(E_FLAG_OFFSET));
 120                 builder.setMakeBeforeBreak(flags.get(M_FLAG_OFFSET));
 121                 builder.setOrder(flags.get(D_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(ByteArray.bytesToLong(Arrays.copyOfRange(bytes, RID_F_OFFSET, RID_F_OFFSET + RID_F_LENGTH))));
 128                 parseTlvs(builder, ByteArray.cutBytes(bytes, TLVS_OFFSET));
 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(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
 157                 flags.set(PRI_SF_OFFSET, (rPObj.getPriority() & 1 << 2) != 0);
 158                 flags.set(PRI_SF_OFFSET + 1, (rPObj.getPriority() & 1 << 1) != 0);
 159                 flags.set(PRI_SF_OFFSET + 2, (rPObj.getPriority() & 1) != 0);
 160
 161                 final byte[] tlvs = serializeTlvs(rPObj.getTlvs());
 162                 final byte[] retBytes = new byte[TLVS_OFFSET + tlvs.length + getPadding(TLVS_OFFSET + tlvs.length, PADDED_TO)];
 163
 164                 ByteArray.copyWhole(ByteArray.bitSetToBytes(flags, FLAGS_PRI_MF_LENGTH), retBytes, FLAGS_PRI_MF_OFFSET);
 165                 ByteArray.copyWhole(ByteArray.subByte(ByteArray.longToBytes(rPObj.getRequestId().getValue()), (Long.SIZE / Byte.SIZE)
 166                                 - RID_F_LENGTH, RID_F_LENGTH), retBytes, RID_F_OFFSET);
 167                 if (tlvs.length != 0) {
 168                         ByteArray.copyWhole(tlvs, retBytes, TLVS_OFFSET);
 169                 }
 170                 return 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
 182         @Override
 183         public int getObjectType() {
 184                 return TYPE;
 185         }
 186
 187         @Override
 188         public int getObjectClass() {
 189                 return CLASS;
 190         }
 191 }