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