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.spi.TlvHandlerRegistry;
  16 import org.opendaylight.protocol.util.ByteArray;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ObjectHeader;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.RequestId;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Tlv;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.order.tlv.Order;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.RpBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.rp.Tlvs;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.rp.TlvsBuilder;
  26
  27 /**
  28  * Parser for {@link Rp}
  29  */
  30 public class PCEPRequestParameterObjectParser extends AbstractObjectWithTlvsParser<RpBuilder> {
  31
  32         public static final int CLASS = 2;
  33
  34         public static final int TYPE = 1;
  35
  36         /*
  37          * lengths of fields in bytes
  38          */
  39         private static final int FLAGS_PRI_MF_LENGTH = 4;
  40         private static final int RID_F_LENGTH = 4;
  41
  42         /*
  43          * lengths of subfields inside multi-field in bits
  44          */
  45         private static final int FLAGS_SF_LENGTH = 29;
  46
  47         /*
  48          * offsets of field in bytes
  49          */
  50
  51         private static final int FLAGS_PRI_MF_OFFSET = 0;
  52         private static final int RID_F_OFFSET = FLAGS_PRI_MF_OFFSET + FLAGS_PRI_MF_LENGTH;
  53         private static final int TLVS_OFFSET = RID_F_OFFSET + RID_F_LENGTH;
  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          * OF extension flags offsets inside flags sub.field in bits
  78          */
  79
  80         private static final int S_FLAG_OFFSET = 24;
  81         /*
  82          * RFC6006 flags
  83          */
  84         private static final int F_FLAG_OFFSET = 18;
  85
  86         private static final int N_FLAG_OFFSET = 19;
  87
  88         private static final int E_FLAG_OFFSET = 20;
  89
  90         public PCEPRequestParameterObjectParser(final TlvHandlerRegistry tlvReg) {
  91                 super(tlvReg);
  92         }
  93
  94         @Override
  95         public Rp parseObject(final ObjectHeader header, final byte[] bytes) throws PCEPDeserializerException {
  96                 if (bytes == null || bytes.length == 0) {
  97                         throw new IllegalArgumentException("Array of bytes is mandatory. Can't be null or empty.");
  98                 }
  99
 100                 final BitSet flags = ByteArray.bytesToBitSet(Arrays.copyOfRange(bytes, FLAGS_PRI_MF_OFFSET, FLAGS_PRI_MF_OFFSET
 101                                 + FLAGS_PRI_MF_LENGTH));
 102                 short priority = 0;
 103                 priority |= flags.get(PRI_SF_OFFSET + 2) ? 1 : 0;
 104                 priority |= (flags.get(PRI_SF_OFFSET + 1) ? 1 : 0) << 1;
 105                 priority |= (flags.get(PRI_SF_OFFSET) ? 1 : 0) << 2;
 106
 107                 final RpBuilder builder = new RpBuilder();
 108                 builder.setIgnore(header.isIgnore());
 109
 110                 //FIXME : change binary files
 111                 //if (!header.isProcessingRule()) {
 112                 //LOG.debug("Processed bit not set on RP OBJECT, ignoring it");
 113                 //      return null;
 114                 //}
 115
 116                 builder.setProcessingRule(header.isProcessingRule());
 117
 118                 builder.setPriority(priority);
 119                 builder.setFragmentation(flags.get(F_FLAG_OFFSET));
 120                 builder.setP2mp(flags.get(N_FLAG_OFFSET));
 121                 builder.setEroCompression(flags.get(E_FLAG_OFFSET));
 122                 builder.setMakeBeforeBreak(flags.get(M_FLAG_OFFSET));
 123                 builder.setOrder(flags.get(D_FLAG_OFFSET));
 124                 builder.setSupplyOf(flags.get(S_FLAG_OFFSET));
 125                 builder.setLoose(flags.get(O_FLAG_OFFSET));
 126                 builder.setBiDirectional(flags.get(B_FLAG_OFFSET));
 127                 builder.setReoptimization(flags.get(R_FLAG_OFFSET));
 128
 129                 builder.setRequestId(new RequestId(ByteArray.bytesToLong(Arrays.copyOfRange(bytes, RID_F_OFFSET, RID_F_OFFSET + RID_F_LENGTH))));
 130                 parseTlvs(builder, ByteArray.cutBytes(bytes, TLVS_OFFSET));
 131                 return builder.build();
 132         }
 133
 134         @Override
 135         public void addTlv(final RpBuilder builder, final Tlv tlv) {
 136                 if (tlv instanceof Order) {
 137                         builder.setTlvs(new TlvsBuilder().setOrder((Order) tlv).build());
 138                 }
 139         }
 140
 141         @Override
 142         public byte[] serializeObject(final Object object) {
 143                 if (!(object instanceof Rp)) {
 144                         throw new IllegalArgumentException("Wrong instance of PCEPObject. Passed " + object.getClass() + ". Needed RpObject.");
 145                 }
 146                 final Rp rPObj = (Rp) object;
 147                 final BitSet flags = new BitSet(FLAGS_PRI_MF_LENGTH * Byte.SIZE);
 148
 149                 flags.set(R_FLAG_OFFSET, rPObj.isReoptimization());
 150                 flags.set(B_FLAG_OFFSET, rPObj.isBiDirectional());
 151                 flags.set(O_FLAG_OFFSET, rPObj.isLoose());
 152                 flags.set(M_FLAG_OFFSET, rPObj.isMakeBeforeBreak());
 153                 flags.set(D_FLAG_OFFSET, rPObj.isOrder());
 154                 flags.set(S_FLAG_OFFSET, rPObj.isSupplyOf());
 155                 flags.set(F_FLAG_OFFSET, rPObj.isFragmentation());
 156                 flags.set(N_FLAG_OFFSET, rPObj.isP2mp());
 157                 flags.set(E_FLAG_OFFSET, rPObj.isEroCompression());
 158
 159                 flags.set(PRI_SF_OFFSET, (rPObj.getPriority() & 1 << 2) != 0);
 160                 flags.set(PRI_SF_OFFSET + 1, (rPObj.getPriority() & 1 << 1) != 0);
 161                 flags.set(PRI_SF_OFFSET + 2, (rPObj.getPriority() & 1) != 0);
 162
 163                 final byte[] tlvs = serializeTlvs(rPObj.getTlvs());
 164                 final byte[] retBytes = new byte[TLVS_OFFSET + tlvs.length + getPadding(TLVS_OFFSET + tlvs.length, PADDED_TO)];
 165
 166                 ByteArray.copyWhole(ByteArray.bitSetToBytes(flags, FLAGS_PRI_MF_LENGTH), retBytes, FLAGS_PRI_MF_OFFSET);
 167                 ByteArray.copyWhole(ByteArray.subByte(ByteArray.longToBytes(rPObj.getRequestId().getValue()), (Long.SIZE / Byte.SIZE)
 168                                 - RID_F_LENGTH, RID_F_LENGTH), retBytes, RID_F_OFFSET);
 169                 if (tlvs.length != 0) {
 170                         ByteArray.copyWhole(tlvs, retBytes, TLVS_OFFSET);
 171                 }
 172                 return retBytes;
 173         }
 174
 175         public byte[] serializeTlvs(final Tlvs tlvs) {
 176                 if (tlvs == null) {
 177                         return new byte[0];
 178                 } else if (tlvs.getOrder() != null) {
 179                         return serializeTlv(tlvs.getOrder());
 180                 }
 181                 return new byte[0];
 182         }
 183
 184         @Override
 185         public int getObjectType() {
 186                 return TYPE;
 187         }
 188
 189         @Override
 190         public int getObjectClass() {
 191                 return CLASS;
 192         }
 193 }