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.impl.message;
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.Lists;
13 import io.netty.buffer.ByteBuf;
14 import io.netty.buffer.Unpooled;
16 import java.util.List;
18 import org.opendaylight.protocol.pcep.spi.AbstractMessageParser;
19 import org.opendaylight.protocol.pcep.spi.MessageUtil;
20 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
21 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
22 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Pcreq;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcreqBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.Bandwidth;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.BandwidthBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.classtype.object.ClassType;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.object.EndpointsObj;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.exclude.route.object.Xro;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.gc.object.Gc;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.include.route.object.Iro;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.load.balancing.object.LoadBalancing;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.Metrics;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.MetricsBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.Lspa;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.metric.object.Metric;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.of.object.Of;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.path.key.object.PathKey;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.PcreqMessage;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.PcreqMessageBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Requests;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.RequestsBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Svec;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.SvecBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.PathKeyExpansionBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputation;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputationBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2p;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2pBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRoute;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRouteBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reported.route.object.Rro;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
58 * Parser for {@link Pcreq}
60 public class PCEPRequestMessageParser extends AbstractMessageParser {
62 public static final int TYPE = 3;
64 public PCEPRequestMessageParser(final ObjectRegistry registry) {
69 public void serializeMessage(final Message message, final ByteBuf out) {
70 Preconditions.checkArgument(message instanceof Pcreq, "Wrong instance of Message. Passed instance of %s. Need Pcreq.", message.getClass());
71 final PcreqMessage msg = ((Pcreq) message).getPcreqMessage();
72 if (msg.getRequests() == null || msg.getRequests().isEmpty()) {
73 throw new IllegalArgumentException("Requests cannot be null or empty.");
75 ByteBuf buffer = Unpooled.buffer();
76 for (final Requests req : msg.getRequests()) {
77 serializeObject(req.getRp(), buffer);
78 if (req.getPathKeyExpansion() != null) {
79 serializeObject(req.getPathKeyExpansion().getPathKey(), buffer);
81 if (req.getSegmentComputation() != null) {
82 final SegmentComputation sc = req.getSegmentComputation();
83 if (sc.getP2p() != null) {
84 serializeP2P(buffer, sc.getP2p());
88 if (msg.getSvec() != null) {
89 for (final Svec s : msg.getSvec()) {
90 serializeObject(s.getSvec(), buffer);
91 if (s.getOf() != null) {
92 serializeObject(s.getOf(), buffer);
94 if (s.getGc() != null) {
95 serializeObject(s.getGc(), buffer);
97 if (s.getXro() != null) {
98 serializeObject(s.getXro(), buffer);
100 if (s.getMetric() != null) {
101 for (final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.svec.Metric m : s.getMetric()) {
102 serializeObject(m.getMetric(), buffer);
107 MessageUtil.formatMessage(TYPE, buffer, out);
110 protected void serializeP2P(final ByteBuf buffer, final P2p p2p) {
111 if (p2p.getEndpointsObj() != null) {
112 serializeObject(p2p.getEndpointsObj(), buffer);
114 if (p2p.getReportedRoute() != null) {
115 final ReportedRoute rr = p2p.getReportedRoute();
116 if (rr.getRro() != null) {
117 serializeObject(rr.getRro(), buffer);
119 if (rr.getBandwidth() != null) {
120 serializeObject(rr.getBandwidth(), buffer);
123 if (p2p.getLoadBalancing() != null) {
124 serializeObject(p2p.getLoadBalancing(), buffer);
126 if (p2p.getLspa() != null) {
127 serializeObject(p2p.getLspa(), buffer);
129 if (p2p.getBandwidth() != null) {
130 serializeObject(p2p.getBandwidth(), buffer);
132 if (p2p.getMetrics() != null) {
133 for (final Metrics m : p2p.getMetrics()) {
134 serializeObject(m.getMetric(), buffer);
137 if (p2p.getIro() != null) {
138 serializeObject(p2p.getIro(), buffer);
140 if (p2p.getRro() != null) {
141 serializeObject(p2p.getRro(), buffer);
143 if (p2p.getXro() != null) {
144 serializeObject(p2p.getXro(), buffer);
146 if (p2p.getOf() != null) {
147 serializeObject(p2p.getOf(), buffer);
149 if (p2p.getClassType() != null) {
150 serializeObject(p2p.getClassType(), buffer);
155 protected Message validate(
156 final List<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object> objects,
157 final List<Message> errors) throws PCEPDeserializerException {
158 if (objects == null) {
159 throw new IllegalArgumentException("Passed list can't be null.");
162 final List<Requests> requests = Lists.newArrayList();
163 final List<Svec> svecList = Lists.newArrayList();
164 while (!objects.isEmpty()) {
165 final RequestsBuilder rBuilder = new RequestsBuilder();
167 if (objects.get(0) instanceof Rp) {
168 rpObj = (Rp) objects.get(0);
170 if (!rpObj.isProcessingRule()) {
171 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET));
173 rBuilder.setRp(rpObj);
176 // if RP obj is missing return error only
177 errors.add(createErrorMsg(PCEPErrors.RP_MISSING));
182 if (rpObj.isPathKey()) {
183 if (objects.get(0) instanceof PathKey) {
184 rBuilder.setPathKeyExpansion(new PathKeyExpansionBuilder().setPathKey((PathKey) objects.get(0)).build());
189 final P2pBuilder p2pBuilder = new P2pBuilder();
191 if (objects.get(0) instanceof EndpointsObj) {
192 final EndpointsObj ep = (EndpointsObj) objects.get(0);
194 if (!ep.isProcessingRule()) {
195 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, rpObj));
197 p2pBuilder.setEndpointsObj(ep);
200 errors.add(createErrorMsg(PCEPErrors.END_POINTS_MISSING, rpObj));
204 if (!rpObj.isP2mp()) {
205 final SegmentComputation segm = getSegmentComputation(p2pBuilder, objects, errors, rpObj);
207 rBuilder.setSegmentComputation(segm);
210 while (!objects.isEmpty()) {
211 final SvecBuilder sBuilder = new SvecBuilder();
212 final Svec svecComp = getValidSvec(sBuilder, objects);
213 if (svecComp == null) {
216 svecList.add(svecComp);
218 requests.add(rBuilder.build());
221 final PcreqMessageBuilder mBuilder = new PcreqMessageBuilder();
222 mBuilder.setRequests(requests);
223 if (!svecList.isEmpty()) {
224 mBuilder.setSvec(svecList);
226 return new PcreqBuilder().setPcreqMessage(mBuilder.build()).build();
229 protected SegmentComputation getSegmentComputation(final P2pBuilder builder, final List<Object> objects, final List<Message> errors,
231 final List<Metrics> metrics = Lists.newArrayList();
233 State state = State.Init;
234 while (!objects.isEmpty() && state != State.End) {
235 Object obj = objects.get(0);
239 state = State.ReportedIn;
240 if (obj instanceof Rro) {
241 final ReportedRouteBuilder rrBuilder = new ReportedRouteBuilder();
242 rrBuilder.setRro((Rro) obj);
244 obj = objects.get(0);
245 if (obj instanceof Bandwidth) {
246 rrBuilder.setBandwidth((Bandwidth) obj);
251 state = State.LoadBIn;
252 if (obj instanceof LoadBalancing) {
253 builder.setLoadBalancing((LoadBalancing) obj);
257 state = State.LspaIn;
258 if (obj instanceof Lspa) {
259 builder.setLspa((Lspa) obj);
263 state = State.BandwidthIn;
264 if (obj instanceof Bandwidth) {
265 builder.setBandwidth((Bandwidth) obj);
269 state = State.MetricIn;
270 if (obj instanceof Metric) {
271 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
272 state = State.BandwidthIn;
277 if (obj instanceof Iro) {
278 builder.setIro((Iro) obj);
283 if (obj instanceof Rro) {
284 builder.setRro((Rro) obj);
289 if (obj instanceof Xro) {
290 builder.setXro((Xro) obj);
295 if (obj instanceof Of) {
296 builder.setOf((Of) obj);
301 if (obj instanceof ClassType) {
302 final ClassType classType = (ClassType) obj;
303 if (!classType.isProcessingRule()) {
304 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, rp));
306 builder.setClassType(classType);
316 if (!state.equals(State.End)) {
320 if (!metrics.isEmpty()) {
321 builder.setMetrics(metrics);
324 if (rp.isReoptimization()
325 && builder.getBandwidth() != null
326 && builder.getReportedRoute().getBandwidth().getBandwidth() != new BandwidthBuilder().setBandwidth(
327 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth(new byte[] { 0 })).build()
328 && builder.getReportedRoute().getRro() == null) {
329 errors.add(createErrorMsg(PCEPErrors.RRO_MISSING, rp));
332 return new SegmentComputationBuilder().setP2p(builder.build()).build();
336 Init, ReportedIn, LoadBIn, LspaIn, BandwidthIn, MetricIn, IroIn, RroIn, XroIn, OfIn, CtIn, End
339 private Svec getValidSvec(final SvecBuilder builder, final List<Object> objects) {
340 if (objects == null || objects.isEmpty()) {
341 throw new IllegalArgumentException("List cannot be null or empty.");
344 if (objects.get(0) instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) {
345 builder.setSvec((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) objects.get(0));
351 final List<Metrics> metrics = Lists.newArrayList();
354 SvecState state = SvecState.Init;
355 while (!objects.isEmpty() && !state.equals(SvecState.End)) {
356 obj = objects.get(0);
360 state = SvecState.OfIn;
361 if (obj instanceof Of) {
362 builder.setOf((Of) obj);
366 state = SvecState.GcIn;
367 if (obj instanceof Gc) {
368 builder.setGc((Gc) obj);
372 state = SvecState.XroIn;
373 if (obj instanceof Xro) {
374 builder.setXro((Xro) obj);
378 state = SvecState.MetricIn;
379 if (obj instanceof Metric) {
380 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
381 state = SvecState.XroIn;
385 state = SvecState.End;
390 if (!state.equals(SvecState.End)) {
394 return builder.build();
397 private enum SvecState {
398 Init, OfIn, GcIn, XroIn, MetricIn, End