2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.protocol.pcep.parser.object;
10 import static com.google.common.base.Preconditions.checkArgument;
12 import io.netty.buffer.ByteBuf;
13 import io.netty.buffer.Unpooled;
14 import java.util.List;
15 import org.opendaylight.protocol.pcep.spi.AbstractObjectWithTlvsParser;
16 import org.opendaylight.protocol.pcep.spi.ObjectUtil;
17 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
18 import org.opendaylight.protocol.pcep.spi.TlvRegistry;
19 import org.opendaylight.protocol.pcep.spi.VendorInformationTlvRegistry;
20 import org.opendaylight.protocol.util.BitArray;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.RequestId;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Tlv;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.order.tlv.Order;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.setup.type.tlv.PathSetupType;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.Rp;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.RpBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.rp.Tlvs;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.rp.TlvsBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vendor.information.tlvs.VendorInformationTlv;
32 import org.opendaylight.yangtools.yang.common.Uint32;
33 import org.opendaylight.yangtools.yang.common.Uint8;
34 import org.opendaylight.yangtools.yang.common.netty.ByteBufUtils;
37 * Parser for {@link Rp}.
39 public class PCEPRequestParameterObjectParser extends AbstractObjectWithTlvsParser<TlvsBuilder> {
40 private static final int CLASS = 2;
41 private static final int TYPE = 1;
44 * lengths of fields in bytes
46 private static final int FLAGS_SIZE = 32;
49 * lengths of subfields inside multi-field in bits
51 private static final int FLAGS_SF_LENGTH = 29;
54 * offsets of subfields inside multi-field in bits
56 private static final int FLAGS_SF_OFFSET = 0;
57 private static final int PRI_SF_OFFSET = FLAGS_SF_OFFSET + FLAGS_SF_LENGTH;
60 * flags offsets inside flags sub-field in bits
62 private static final int O_FLAG_OFFSET = 26;
63 private static final int B_FLAG_OFFSET = 27;
64 private static final int R_FLAG_OFFSET = 28;
67 * GCO extension flags offsets inside flags sub-field in bits
69 private static final int M_FLAG_OFFSET = 21;
70 private static final int D_FLAG_OFFSET = 22;
73 * Path-key bit (RFC5520)
75 private static final int P_FLAG_OFFSET = 23;
77 * OF extension flags offsets inside flags sub.field in bits
79 private static final int S_FLAG_OFFSET = 24;
83 private static final int F_FLAG_OFFSET = 18;
84 private static final int N_FLAG_OFFSET = 19;
85 private static final int E_FLAG_OFFSET = 20;
87 public PCEPRequestParameterObjectParser(final TlvRegistry tlvReg, final VendorInformationTlvRegistry viTlvReg) {
88 super(tlvReg, viTlvReg, CLASS, TYPE);
92 public Object parseObject(final ObjectHeader header, final ByteBuf bytes) throws PCEPDeserializerException {
93 checkArgument(bytes != null && bytes.isReadable(), "Array of bytes is mandatory. Cannot be null or empty.");
94 final BitArray flags = BitArray.valueOf(bytes, FLAGS_SIZE);
95 final Uint32 reqId = ByteBufUtils.readUint32(bytes);
96 final TlvsBuilder tlvsBuilder = new TlvsBuilder();
97 parseTlvs(tlvsBuilder, bytes.slice());
98 final RpBuilder builder = new RpBuilder()
99 .setIgnore(header.getIgnore())
100 .setProcessingRule(header.getProcessingRule())
101 .setFragmentation(flags.get(F_FLAG_OFFSET))
102 .setP2mp(flags.get(N_FLAG_OFFSET))
103 .setEroCompression(flags.get(E_FLAG_OFFSET))
104 .setMakeBeforeBreak(flags.get(M_FLAG_OFFSET))
105 .setOrder(flags.get(D_FLAG_OFFSET))
106 .setPathKey(flags.get(P_FLAG_OFFSET))
107 .setSupplyOf(flags.get(S_FLAG_OFFSET))
108 .setLoose(flags.get(O_FLAG_OFFSET))
109 .setBiDirectional(flags.get(B_FLAG_OFFSET))
110 .setReoptimization(flags.get(R_FLAG_OFFSET))
111 .setRequestId(new RequestId(reqId))
112 .setTlvs(tlvsBuilder.build());
115 priority |= flags.get(PRI_SF_OFFSET + 2) ? 1 : 0;
116 priority |= (flags.get(PRI_SF_OFFSET + 1) ? 1 : 0) << 1;
117 priority |= (flags.get(PRI_SF_OFFSET) ? 1 : 0) << 2;
119 builder.setPriority(Uint8.valueOf(priority));
122 return builder.build();
126 public void addTlv(final TlvsBuilder builder, final Tlv tlv) {
127 if (tlv instanceof Order) {
128 builder.setOrder((Order) tlv);
130 if (tlv instanceof PathSetupType) {
131 builder.setPathSetupType((PathSetupType) tlv);
136 public void serializeObject(final Object object, final ByteBuf buffer) {
137 checkArgument(object instanceof Rp, "Wrong instance of PCEPObject. Passed %s. Needed RPObject.",
139 final ByteBuf body = Unpooled.buffer();
140 final Rp rpObj = (Rp) object;
141 final BitArray flags = new BitArray(FLAGS_SIZE);
142 flags.set(R_FLAG_OFFSET, rpObj.getReoptimization());
143 flags.set(B_FLAG_OFFSET, rpObj.getBiDirectional());
144 flags.set(O_FLAG_OFFSET, rpObj.getLoose());
145 flags.set(M_FLAG_OFFSET, rpObj.getMakeBeforeBreak());
146 flags.set(D_FLAG_OFFSET, rpObj.getOrder());
147 flags.set(P_FLAG_OFFSET, rpObj.getPathKey());
148 flags.set(S_FLAG_OFFSET, rpObj.getSupplyOf());
149 flags.set(F_FLAG_OFFSET, rpObj.getFragmentation());
150 flags.set(N_FLAG_OFFSET, rpObj.getP2mp());
151 flags.set(E_FLAG_OFFSET, rpObj.getEroCompression());
152 final byte[] res = flags.array();
153 if (rpObj.getPriority() != null) {
154 final byte p = rpObj.getPriority().byteValue();
155 res[res.length - 1] = (byte) (res[res.length - 1] | p);
157 body.writeBytes(res);
158 final RequestId requestId = rpObj.getRequestId();
159 checkArgument(requestId != null, "RequestId is mandatory");
160 ByteBufUtils.write(body, requestId.getValue());
161 serializeTlvs(rpObj.getTlvs(), body);
162 ObjectUtil.formatSubobject(TYPE, CLASS, object.getProcessingRule(), object.getIgnore(), body, buffer);
165 public void serializeTlvs(final Tlvs tlvs, final ByteBuf body) {
167 if (tlvs.getOrder() != null) {
168 serializeTlv(tlvs.getOrder(), body);
170 if (tlvs.getPathSetupType() != null) {
171 serializeTlv(tlvs.getPathSetupType(), body);
173 serializeVendorInformationTlvs(tlvs.getVendorInformationTlv(), body);
178 protected final void addVendorInformationTlvs(final TlvsBuilder builder, final List<VendorInformationTlv> tlvs) {
179 if (!tlvs.isEmpty()) {
180 builder.setVendorInformationTlv(tlvs);