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