pcep/base-parser/src/main/java/org/opendaylight/protocol/pcep/parser/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 package org.opendaylight.protocol.pcep.parser.object;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static org.opendaylight.protocol.util.ByteBufWriteUtil.writeUnsignedInt;
  12
  13 import io.netty.buffer.ByteBuf;
  14 import io.netty.buffer.Unpooled;
  15 import java.util.List;
  16 import org.opendaylight.protocol.pcep.spi.AbstractObjectWithTlvsParser;
  17 import org.opendaylight.protocol.pcep.spi.ObjectUtil;
  18 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
  19 import org.opendaylight.protocol.pcep.spi.TlvRegistry;
  20 import org.opendaylight.protocol.pcep.spi.VendorInformationTlvRegistry;
  21 import org.opendaylight.protocol.util.BitArray;
  22 import org.opendaylight.protocol.util.ByteBufUtils;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.RequestId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Tlv;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.order.tlv.Order;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.setup.type.tlv.PathSetupType;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.Rp;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.RpBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.rp.Tlvs;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.rp.TlvsBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vendor.information.tlvs.VendorInformationTlv;
  34 import org.opendaylight.yangtools.yang.common.Uint32;
  35 import org.opendaylight.yangtools.yang.common.Uint8;
  36
  37 /**
  38  * Parser for {@link Rp}.
  39  */
  40 public class PCEPRequestParameterObjectParser extends AbstractObjectWithTlvsParser<TlvsBuilder> {
  41
  42     private static final int CLASS = 2;
  43     private static final int TYPE = 1;
  44
  45     /*
  46      * lengths of fields in bytes
  47      */
  48     private static final int FLAGS_SIZE = 32;
  49
  50     /*
  51      * lengths of subfields inside multi-field in bits
  52      */
  53     private static final int FLAGS_SF_LENGTH = 29;
  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      * Path-key bit (RFC5520)
  78      */
  79     private static final int P_FLAG_OFFSET = 23;
  80     /*
  81      * OF extension flags offsets inside flags sub.field in bits
  82      */
  83     private static final int S_FLAG_OFFSET = 24;
  84     /*
  85      * RFC6006 flags
  86      */
  87     private static final int F_FLAG_OFFSET = 18;
  88
  89     private static final int N_FLAG_OFFSET = 19;
  90
  91     private static final int E_FLAG_OFFSET = 20;
  92
  93     public PCEPRequestParameterObjectParser(final TlvRegistry tlvReg, final VendorInformationTlvRegistry viTlvReg) {
  94         super(tlvReg, viTlvReg, CLASS, TYPE);
  95     }
  96
  97     @Override
  98     public Object parseObject(final ObjectHeader header, final ByteBuf bytes) throws PCEPDeserializerException {
  99         checkArgument(bytes != null && bytes.isReadable(), "Array of bytes is mandatory. Cannot be null or empty.");
 100         final BitArray flags = BitArray.valueOf(bytes, FLAGS_SIZE);
 101         final Uint32 reqId = ByteBufUtils.readUint32(bytes);
 102         final TlvsBuilder tlvsBuilder = new TlvsBuilder();
 103         parseTlvs(tlvsBuilder, bytes.slice());
 104         final RpBuilder builder = new RpBuilder()
 105                 .setIgnore(header.isIgnore())
 106                 .setProcessingRule(header.isProcessingRule())
 107                 .setFragmentation(flags.get(F_FLAG_OFFSET))
 108                 .setP2mp(flags.get(N_FLAG_OFFSET))
 109                 .setEroCompression(flags.get(E_FLAG_OFFSET))
 110                 .setMakeBeforeBreak(flags.get(M_FLAG_OFFSET))
 111                 .setOrder(flags.get(D_FLAG_OFFSET))
 112                 .setPathKey(flags.get(P_FLAG_OFFSET))
 113                 .setSupplyOf(flags.get(S_FLAG_OFFSET))
 114                 .setLoose(flags.get(O_FLAG_OFFSET))
 115                 .setBiDirectional(flags.get(B_FLAG_OFFSET))
 116                 .setReoptimization(flags.get(R_FLAG_OFFSET))
 117                 .setRequestId(new RequestId(reqId))
 118                 .setTlvs(tlvsBuilder.build());
 119
 120         short priority = 0;
 121         priority |= flags.get(PRI_SF_OFFSET + 2) ? 1 : 0;
 122         priority |= (flags.get(PRI_SF_OFFSET + 1) ? 1 : 0) << 1;
 123         priority |= (flags.get(PRI_SF_OFFSET) ? 1 : 0) << 2;
 124         if (priority != 0) {
 125             builder.setPriority(Uint8.valueOf(priority));
 126         }
 127
 128         return builder.build();
 129     }
 130
 131     @Override
 132     public void addTlv(final TlvsBuilder builder, final Tlv tlv) {
 133         if (tlv instanceof Order) {
 134             builder.setOrder((Order) tlv);
 135         }
 136         if (tlv instanceof PathSetupType) {
 137             builder.setPathSetupType((PathSetupType) tlv);
 138         }
 139     }
 140
 141     @Override
 142     public void serializeObject(final Object object, final ByteBuf buffer) {
 143         checkArgument(object instanceof Rp, "Wrong instance of PCEPObject. Passed %s. Needed RPObject.",
 144             object.getClass());
 145         final ByteBuf body = Unpooled.buffer();
 146         final Rp rpObj = (Rp) object;
 147         final BitArray flags = new BitArray(FLAGS_SIZE);
 148         flags.set(R_FLAG_OFFSET, rpObj.isReoptimization());
 149         flags.set(B_FLAG_OFFSET, rpObj.isBiDirectional());
 150         flags.set(O_FLAG_OFFSET, rpObj.isLoose());
 151         flags.set(M_FLAG_OFFSET, rpObj.isMakeBeforeBreak());
 152         flags.set(D_FLAG_OFFSET, rpObj.isOrder());
 153         flags.set(P_FLAG_OFFSET, rpObj.isPathKey());
 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         final byte[] res = flags.array();
 159         if (rpObj.getPriority() != null) {
 160             final byte p = rpObj.getPriority().byteValue();
 161             res[res.length - 1] = (byte) (res[res.length - 1] | p);
 162         }
 163         body.writeBytes(res);
 164         checkArgument(rpObj.getRequestId() != null, "RequestId is mandatory");
 165         writeUnsignedInt(rpObj.getRequestId().getValue(), body);
 166         serializeTlvs(rpObj.getTlvs(), body);
 167         ObjectUtil.formatSubobject(TYPE, CLASS, object.isProcessingRule(), object.isIgnore(), body, buffer);
 168     }
 169
 170     public void serializeTlvs(final Tlvs tlvs, final ByteBuf body) {
 171         if (tlvs == null) {
 172             return;
 173         }
 174         if (tlvs.getOrder() != null) {
 175             serializeTlv(tlvs.getOrder(), body);
 176         }
 177         if (tlvs.getPathSetupType() != null) {
 178             serializeTlv(tlvs.getPathSetupType(), body);
 179         }
 180         serializeVendorInformationTlvs(tlvs.getVendorInformationTlv(), body);
 181     }
 182
 183     @Override
 184     protected final void addVendorInformationTlvs(final TlvsBuilder builder, final List<VendorInformationTlv> tlvs) {
 185         if (!tlvs.isEmpty()) {
 186             builder.setVendorInformationTlv(tlvs);
 187         }
 188     }
 189 }