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.impl.Util;
  17 import org.opendaylight.protocol.pcep.spi.AbstractObjectParser;
  18 import org.opendaylight.protocol.pcep.spi.HandlerRegistry;
  19 import org.opendaylight.protocol.util.ByteArray;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ObjectHeader;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.OrderTlv;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.RequestId;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.RpObject;
  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.pcreq.message.pcreq.message.requests.RpBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Tlvs;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.TlvsBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.tlvs.OrderBuilder;
  30
  31 /**
  32  * Parser for {@link RpObject}
  33  */
  34
  35 public class PCEPRequestParameterObjectParser extends AbstractObjectParser<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         public static final int FLAGS_PRI_MF_LENGTH = 4; // multi-field
  45         public static final int RID_F_LENGTH = 4;
  46
  47         /*
  48          * lengths of subfields inside multi-field in bits
  49          */
  50         public static final int FLAGS_SF_LENGTH = 29;
  51         public static final int PRI_SF_LENGTH = 3;
  52
  53         /*
  54          * offsets of field in bytes
  55          */
  56
  57         public static final int FLAGS_PRI_MF_OFFSET = 0;
  58         public static final int RID_F_OFFSET = FLAGS_PRI_MF_OFFSET + FLAGS_PRI_MF_LENGTH;
  59         public static final int TLVS_OFFSET = RID_F_OFFSET + RID_F_LENGTH;
  60
  61         /*
  62          * offsets of subfields inside multi-field in bits
  63          */
  64
  65         public static final int FLAGS_SF_OFFSET = 0;
  66         public static final int PRI_SF_OFFSET = FLAGS_SF_OFFSET + FLAGS_SF_LENGTH;
  67
  68         /*
  69          * flags offsets inside flags sub-field in bits
  70          */
  71
  72         private static final int O_FLAG_OFFSET = 26;
  73         private static final int B_FLAG_OFFSET = 27;
  74         private static final int R_FLAG_OFFSET = 28;
  75
  76         /*
  77          * GCO extension flags offsets inside flags sub-field in bits
  78          */
  79         private static final int M_FLAG_OFFSET = 21;
  80         private static final int D_FLAG_OFFSET = 22;
  81
  82         /*
  83          * OF extension flags offsets inside flags sub.field in bits
  84          */
  85
  86         private static int S_FLAG_OFFSET = 24; // Supply OF on response
  87
  88         /*
  89          * RFC6006 flags
  90          */
  91         private static int F_FLAG_OFFSET = 18;
  92
  93         private static int N_FLAG_OFFSET = 19;
  94
  95         private static int E_FLAG_OFFSET = 20;
  96
  97         public PCEPRequestParameterObjectParser(final HandlerRegistry registry) {
  98                 super(registry);
  99         }
 100
 101         @Override
 102         public RpObject parseObject(final ObjectHeader header, final byte[] bytes) throws PCEPDeserializerException, PCEPDocumentedException {
 103                 if (bytes == null || bytes.length == 0)
 104                         throw new IllegalArgumentException("Array of bytes is mandatory. Can't be null or empty.");
 105
 106                 final BitSet flags = ByteArray.bytesToBitSet(Arrays.copyOfRange(bytes, FLAGS_PRI_MF_OFFSET, FLAGS_PRI_MF_OFFSET
 107                                 + FLAGS_PRI_MF_LENGTH));
 108                 short priority = 0;
 109                 priority |= flags.get(PRI_SF_OFFSET + 2) ? 1 : 0;
 110                 priority |= (flags.get(PRI_SF_OFFSET + 1) ? 1 : 0) << 1;
 111                 priority |= (flags.get(PRI_SF_OFFSET) ? 1 : 0) << 2;
 112
 113                 final RpBuilder builder = new RpBuilder();
 114
 115                 parseTlvs(builder, ByteArray.cutBytes(bytes, TLVS_OFFSET));
 116
 117                 builder.setIgnore(header.isIgnore());
 118                 builder.setProcessingRule(header.isProcessingRule());
 119
 120                 builder.setBiDirectional(flags.get(B_FLAG_OFFSET));
 121                 builder.setEroCompression(flags.get(E_FLAG_OFFSET));
 122                 builder.setFragmentation(flags.get(F_FLAG_OFFSET));
 123                 builder.setLoose(flags.get(O_FLAG_OFFSET));
 124                 builder.setMakeBeforeBreak(flags.get(M_FLAG_OFFSET));
 125                 builder.setOrder(flags.get(D_FLAG_OFFSET));
 126                 builder.setP2mp(flags.get(N_FLAG_OFFSET));
 127                 builder.setReoptimization(flags.get(R_FLAG_OFFSET));
 128                 builder.setSupplyOf(flags.get(S_FLAG_OFFSET));
 129                 builder.setPriority(priority);
 130                 builder.setRequestId(new RequestId(ByteArray.bytesToLong(Arrays.copyOfRange(bytes, RID_F_OFFSET, RID_F_OFFSET + RID_F_LENGTH))));
 131
 132                 return builder.build();
 133         }
 134
 135         @Override
 136         public void addTlv(final RpBuilder builder, final Tlv tlv) {
 137                 final TlvsBuilder tbuilder = new TlvsBuilder();
 138                 if (tlv instanceof OrderTlv) {
 139                         final OrderBuilder b = new OrderBuilder();
 140                         b.setDelete(((OrderTlv) tlv).getDelete());
 141                         b.setSetup(((OrderTlv) tlv).getSetup());
 142                         tbuilder.setOrder(b.build());
 143                 }
 144                 builder.setTlvs(tbuilder.build());
 145         }
 146
 147         @Override
 148         public byte[] serializeObject(final Object object) {
 149                 if (!(object instanceof RpObject))
 150                         throw new IllegalArgumentException("Wrong instance of PCEPObject. Passed " + object.getClass() + ". Needed RpObject.");
 151
 152                 final RpObject rPObj = (RpObject) object;
 153
 154                 final BitSet flags_priority = new BitSet(FLAGS_PRI_MF_LENGTH * Byte.SIZE);
 155
 156                 flags_priority.set(R_FLAG_OFFSET, rPObj.isReoptimization());
 157                 flags_priority.set(B_FLAG_OFFSET, rPObj.isBiDirectional());
 158                 flags_priority.set(O_FLAG_OFFSET, rPObj.isLoose());
 159                 flags_priority.set(M_FLAG_OFFSET, rPObj.isMakeBeforeBreak());
 160                 flags_priority.set(D_FLAG_OFFSET, rPObj.isOrder());
 161                 flags_priority.set(S_FLAG_OFFSET, rPObj.isSupplyOf());
 162                 flags_priority.set(F_FLAG_OFFSET, rPObj.isFragmentation());
 163                 flags_priority.set(N_FLAG_OFFSET, rPObj.isP2mp());
 164                 flags_priority.set(E_FLAG_OFFSET, rPObj.isEroCompression());
 165
 166                 flags_priority.set(PRI_SF_OFFSET, (rPObj.getPriority() & 1 << 2) != 0);
 167                 flags_priority.set(PRI_SF_OFFSET + 1, (rPObj.getPriority() & 1 << 1) != 0);
 168                 flags_priority.set(PRI_SF_OFFSET + 2, (rPObj.getPriority() & 1) != 0);
 169
 170                 final byte[] tlvs = serializeTlvs(rPObj.getTlvs());
 171                 int tlvsLength = 0;
 172                 if (tlvs != null)
 173                         tlvsLength = tlvs.length;
 174                 final byte[] retBytes = new byte[TLVS_OFFSET + tlvsLength + Util.getPadding(TLVS_OFFSET + tlvs.length, PADDED_TO)];
 175
 176                 if (tlvs != null)
 177                         ByteArray.copyWhole(tlvs, retBytes, TLVS_OFFSET);
 178
 179                 ByteArray.copyWhole(ByteArray.bitSetToBytes(flags_priority, FLAGS_PRI_MF_LENGTH), retBytes, FLAGS_PRI_MF_OFFSET);
 180                 ByteArray.copyWhole(ByteArray.subByte(ByteArray.longToBytes(rPObj.getRequestId().getValue()), (Long.SIZE / Byte.SIZE)
 181                                 - RID_F_LENGTH, RID_F_LENGTH), retBytes, RID_F_OFFSET);
 182
 183                 return retBytes;
 184         }
 185
 186         public byte[] serializeTlvs(final Tlvs tlvs) {
 187                 if (tlvs.getOrder() != null) {
 188                         return serializeTlv(new OrderBuilder().setDelete(tlvs.getOrder().getDelete()).setSetup(tlvs.getOrder().getSetup()).build());
 189                 }
 190                 return null;
 191         }
 192
 193         @Override
 194         public int getObjectType() {
 195                 return TYPE;
 196         }
 197
 198         @Override
 199         public int getObjectClass() {
 200                 return CLASS;
 201         }
 202 }