3f93e7e1e92ca886e1f29954ea6f13b06f860c97
[bgpcep.git] / pcep / base-parser / src / main / java / org / opendaylight / protocol / pcep / parser / message / PCEPRequestMessageParser.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.message;
9
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import io.netty.buffer.ByteBuf;
13 import io.netty.buffer.Unpooled;
14 import java.util.ArrayList;
15 import java.util.List;
16 import org.opendaylight.protocol.pcep.spi.AbstractMessageParser;
17 import org.opendaylight.protocol.pcep.spi.MessageUtil;
18 import org.opendaylight.protocol.pcep.spi.ObjectRegistry;
19 import org.opendaylight.protocol.pcep.spi.PCEPDeserializerException;
20 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.Pcreq;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcreqBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.Bandwidth;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.classtype.object.ClassType;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.object.EndpointsObj;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.exclude.route.object.Xro;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.gc.object.Gc;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.include.route.object.Iro;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.load.balancing.object.LoadBalancing;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.Metrics;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lsp.attributes.MetricsBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.Lspa;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.metric.object.Metric;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.monitoring.object.Monitoring;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.of.object.Of;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.path.key.object.PathKey;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcc.id.req.object.PccIdReq;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pce.id.object.PceId;
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.MonitoringRequest;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.MonitoringRequestBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Requests;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.RequestsBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.Svec;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.SvecBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.monitoring.request.PceIdList;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.monitoring.request.PceIdListBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.PathKeyExpansionBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputation;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.SegmentComputationBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2p;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.P2pBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRoute;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRouteBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reported.route.object.Rro;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.vendor.information.objects.VendorInformationObject;
61
62 /**
63  * Parser for {@link Pcreq}
64  */
65 public class PCEPRequestMessageParser extends AbstractMessageParser {
66
67     public static final int TYPE = 3;
68
69     public PCEPRequestMessageParser(final ObjectRegistry registry) {
70         super(registry);
71     }
72
73     @Override
74     public void serializeMessage(final Message message, final ByteBuf out) {
75         Preconditions.checkArgument(message instanceof Pcreq, "Wrong instance of Message. Passed instance of %s. Need Pcreq.", message.getClass());
76         final PcreqMessage msg = ((Pcreq) message).getPcreqMessage();
77         Preconditions.checkArgument(msg.getRequests() != null && !msg.getRequests().isEmpty(), "Requests cannot be null or empty.");
78         final ByteBuf buffer = Unpooled.buffer();
79         if (msg.getMonitoringRequest() != null) {
80             serializeMonitoringRequest(msg.getMonitoringRequest(), buffer);
81         }
82         if (msg.getSvec() != null) {
83             serializeSvec(msg, buffer);
84         }
85         serializeRequest(msg, buffer);
86         MessageUtil.formatMessage(TYPE, buffer, out);
87     }
88
89     protected void serializeRequest(final PcreqMessage msg, final ByteBuf buffer) {
90         for (final Requests req : msg.getRequests()) {
91             serializeObject(req.getRp(), buffer);
92             serializeVendorInformationObjects(req.getVendorInformationObject(), buffer);
93             if (req.getPathKeyExpansion() != null) {
94                 serializeObject(req.getPathKeyExpansion().getPathKey(), buffer);
95             }
96             if (req.getSegmentComputation() != null) {
97                 final SegmentComputation sc = req.getSegmentComputation();
98                 if (sc.getP2p() != null) {
99                     serializeP2P(buffer, sc.getP2p());
100                 }
101             }
102         }
103     }
104
105     protected void serializeSvec(final PcreqMessage msg, final ByteBuf buffer) {
106         for (final Svec s : msg.getSvec()) {
107             serializeObject(s.getSvec(), buffer);
108             serializeObject(s.getOf(), buffer);
109             serializeObject(s.getGc(), buffer);
110             serializeObject(s.getXro(), buffer);
111             if (s.getMetric() != null) {
112                 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()) {
113                     serializeObject(m.getMetric(), buffer);
114                 }
115             }
116             serializeVendorInformationObjects(s.getVendorInformationObject(), buffer);
117         }
118     }
119
120     protected void serializeP2P(final ByteBuf buffer, final P2p p2p) {
121         serializeObject(p2p.getEndpointsObj(), buffer);
122         serializeVendorInformationObjects(p2p.getVendorInformationObject(), buffer);
123         if (p2p.getReportedRoute() != null) {
124             final ReportedRoute rr = p2p.getReportedRoute();
125             if (rr != null) {
126                 serializeObject(rr.getRro(), buffer);
127                 serializeObject(rr.getReoptimizationBandwidth(), buffer);
128             }
129         }
130         serializeObject(p2p.getLoadBalancing(), buffer);
131         serializeObject(p2p.getLspa(), buffer);
132         serializeObject(p2p.getBandwidth(), buffer);
133         if (p2p.getMetrics() != null) {
134             for (final Metrics m : p2p.getMetrics()) {
135                 serializeObject(m.getMetric(), buffer);
136             }
137         }
138         serializeObject(p2p.getIro(), buffer);
139         serializeObject(p2p.getRro(), buffer);
140         serializeObject(p2p.getXro(), buffer);
141         serializeObject(p2p.getOf(), buffer);
142         serializeObject(p2p.getClassType(), buffer);
143     }
144
145     protected void serializeMonitoringRequest(final MonitoringRequest monReq, final ByteBuf out) {
146         serializeObject(monReq.getMonitoring(), out);
147         serializeObject(monReq.getPccIdReq(), out);
148         if (monReq.getPceIdList() != null) {
149             for (final PceIdList pceId : monReq.getPceIdList()) {
150                 serializeObject(pceId.getPceId(), out);
151             }
152         }
153     }
154
155     @Override
156     protected Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException {
157         Preconditions.checkArgument(objects != null, "Passed list can't be null.");
158         if (objects.isEmpty()) {
159             throw new PCEPDeserializerException("Pcrep message cannot be empty.");
160         }
161         final PcreqMessageBuilder mBuilder = new PcreqMessageBuilder();
162         mBuilder.setMonitoringRequest(getMonitoring(objects));
163         final List<Svec> svecs = getSvecs(objects);
164         if (!svecs.isEmpty()) {
165             mBuilder.setSvec(svecs);
166         }
167         final List<Requests> requests = getRequests(objects, errors);
168         if (requests != null) {
169             mBuilder.setRequests(requests);
170         } else {
171             errors.add(createErrorMsg(PCEPErrors.RP_MISSING, Optional.<Rp>absent()));
172         }
173         if (!objects.isEmpty()) {
174             throw new PCEPDeserializerException("Unprocessed Objects: " + objects);
175         }
176         return new PcreqBuilder().setPcreqMessage(mBuilder.build()).build();
177     }
178
179     protected List<Svec> getSvecs(final List<Object> objects) {
180         final List<Svec> svecList = new ArrayList<>();
181         while (!objects.isEmpty()) {
182             final SvecBuilder sBuilder = new SvecBuilder();
183             final Svec svecComp = getValidSvec(sBuilder, objects);
184             if (svecComp == null) {
185                 break;
186             }
187             svecList.add(svecComp);
188         }
189         return svecList;
190     }
191
192     protected List<Requests> getRequests(final List<Object> objects, final List<Message> errors) {
193         final List<Requests> requests = new ArrayList<>();
194         while (!objects.isEmpty()) {
195             final RequestsBuilder rBuilder = new RequestsBuilder();
196             Rp rpObj = null;
197             if (!(objects.get(0) instanceof Rp)) {
198                 // if RP obj is missing return error only
199                 errors.add(createErrorMsg(PCEPErrors.RP_MISSING, Optional.<Rp>absent()));
200                 return null;
201             }
202             rpObj = (Rp) objects.get(0);
203             objects.remove(0);
204             if (!rpObj.isProcessingRule()) {
205                 errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.<Rp>absent()));
206             } else {
207                 rBuilder.setRp(rpObj);
208             }
209             final List<VendorInformationObject> vendorInfo = addVendorInformationObjects(objects);
210             if (!vendorInfo.isEmpty()) {
211                 rBuilder.setVendorInformationObject(vendorInfo);
212             }
213             // expansion
214             if (rpObj.isPathKey() && objects.get(0) instanceof PathKey) {
215                 rBuilder.setPathKeyExpansion(new PathKeyExpansionBuilder().setPathKey((PathKey) objects.get(0)).build());
216             }
217
218             final P2pBuilder p2pBuilder = new P2pBuilder();
219
220             if (!objects.isEmpty() && objects.get(0) instanceof EndpointsObj) {
221                 final EndpointsObj ep = (EndpointsObj) objects.get(0);
222                 objects.remove(0);
223                 if (!ep.isProcessingRule()) {
224                     errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.of(rpObj)));
225                 } else {
226                     p2pBuilder.setEndpointsObj(ep);
227                 }
228             } else {
229                 errors.add(createErrorMsg(PCEPErrors.END_POINTS_MISSING, Optional.of(rpObj)));
230                 return null;
231             }
232             // p2p
233             if (!rpObj.isP2mp()) {
234                 final SegmentComputation segm = getSegmentComputation(p2pBuilder, objects, errors, rpObj);
235                 if (segm != null) {
236                     rBuilder.setSegmentComputation(segm);
237                 }
238             }
239             requests.add(rBuilder.build());
240         }
241         return requests;
242     }
243
244     protected SegmentComputation getSegmentComputation(final P2pBuilder builder, final List<Object> objects, final List<Message> errors,
245             final Rp rp) {
246         final List<Metrics> metrics = new ArrayList<>();
247         final List<VendorInformationObject> viObjects = new ArrayList<>();
248
249         State state = State.INIT;
250         while (!objects.isEmpty() && state != State.END) {
251             state = insertObject(state, objects, viObjects, builder, metrics, errors, rp);
252             if (!state.equals(State.END)) {
253                 objects.remove(0);
254             }
255         }
256         if (!metrics.isEmpty()) {
257             builder.setMetrics(metrics);
258         }
259         if (!viObjects.isEmpty()) {
260             builder.setVendorInformationObject(viObjects);
261         }
262
263         if (rp.isReoptimization()
264                 && builder.getBandwidth() != null
265                 && !builder.getReportedRoute().getReoptimizationBandwidth().getBandwidth().equals(
266                         new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth(new byte[] { 0 }))
267                 && builder.getReportedRoute().getRro() == null) {
268             errors.add(createErrorMsg(PCEPErrors.RRO_MISSING, Optional.of(rp)));
269             return null;
270         }
271         return new SegmentComputationBuilder().setP2p(builder.build()).build();
272     }
273
274     private State insertObject(final State state, final List<Object> objects, final List<VendorInformationObject> viObjects, final P2pBuilder builder, final List<Metrics> metrics, final List<Message> errors, final Rp rp) {
275         final Object obj = objects.get(0);
276         switch (state) {
277         case INIT:
278             if (obj instanceof Rro) {
279                 final ReportedRouteBuilder rrBuilder = new ReportedRouteBuilder();
280                 rrBuilder.setRro((Rro) obj);
281                 objects.remove(0);
282                 final Object nextObj = objects.get(0);
283                 if (nextObj instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reoptimization.bandwidth.object.ReoptimizationBandwidth) {
284                     rrBuilder.setReoptimizationBandwidth((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.reoptimization.bandwidth.object.ReoptimizationBandwidth) nextObj);
285                 }
286                 return State.REPORTED_IN;
287             }
288         case REPORTED_IN:
289             if (obj instanceof VendorInformationObject) {
290                 viObjects.add((VendorInformationObject) obj);
291                 return State.REPORTED_IN;
292             }
293         case VENDOR_INFO_LIST:
294             if (obj instanceof LoadBalancing) {
295                 builder.setLoadBalancing((LoadBalancing) obj);
296                 return State.LOAD_BIN;
297             }
298         case LOAD_BIN:
299             if (obj instanceof Lspa) {
300                 builder.setLspa((Lspa) obj);
301                 return State.LSPA_IN;
302             }
303         case LSPA_IN:
304             if (obj instanceof Bandwidth) {
305                 builder.setBandwidth((Bandwidth) obj);
306                 return State.BANDWIDTH_IN;
307             }
308         case BANDWIDTH_IN:
309             if (obj instanceof Metric) {
310                 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
311                 return State.BANDWIDTH_IN;
312             }
313         case METRIC_IN:
314             if (obj instanceof Iro) {
315                 builder.setIro((Iro) obj);
316                 return State.IRO_IN;
317             }
318         case IRO_IN:
319             if (obj instanceof Rro) {
320                 builder.setRro((Rro) obj);
321                 return State.RRO_IN;
322             }
323         case RRO_IN:
324             if (obj instanceof Xro) {
325                 builder.setXro((Xro) obj);
326                 return State.XRO_IN;
327             }
328         case XRO_IN:
329             if (obj instanceof Of) {
330                 builder.setOf((Of) obj);
331                 return State.OF_IN;
332             }
333         case OF_IN:
334             if (obj instanceof ClassType) {
335                 final ClassType classType = (ClassType) obj;
336                 if (!classType.isProcessingRule()) {
337                     errors.add(createErrorMsg(PCEPErrors.P_FLAG_NOT_SET, Optional.of(rp)));
338                 } else {
339                     builder.setClassType(classType);
340                 }
341                 return State.CT_IN;
342             }
343         case CT_IN:
344         case END:
345             return State.END;
346         default:
347             return state;
348         }
349     }
350
351     private enum State {
352         INIT, REPORTED_IN, VENDOR_INFO_LIST, LOAD_BIN, LSPA_IN, BANDWIDTH_IN, METRIC_IN, IRO_IN, RRO_IN, XRO_IN, OF_IN, CT_IN, END
353     }
354
355     private Svec getValidSvec(final SvecBuilder builder, final List<Object> objects) {
356         Preconditions.checkArgument(objects != null && !objects.isEmpty(), "Passed list can't be null or empty.");
357
358         if (objects.get(0) instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) {
359             builder.setSvec((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.svec.object.Svec) objects.get(0));
360             objects.remove(0);
361         } else {
362             return null;
363         }
364
365         final List<Metrics> metrics = new ArrayList<>();
366         final List<VendorInformationObject> viObjects = new ArrayList<>();
367
368         Object obj = null;
369         SvecState state = SvecState.INIT;
370         while (!objects.isEmpty() && !state.equals(SvecState.END)) {
371             obj = objects.get(0);
372             state = insertObject(state, obj, builder, metrics, viObjects);
373             if (!state.equals(SvecState.END)) {
374                 objects.remove(0);
375             }
376         }
377         if (!viObjects.isEmpty()) {
378             builder.setVendorInformationObject(viObjects);
379         }
380         return builder.build();
381     }
382
383     private SvecState insertObject(final SvecState state, final Object obj, final SvecBuilder builder, final List<Metrics> metrics, final List<VendorInformationObject> viObjects) {
384         switch (state) {
385         case INIT:
386             if (obj instanceof Of) {
387                 builder.setOf((Of) obj);
388                 return SvecState.OF_IN;
389             }
390         case OF_IN:
391             if (obj instanceof Gc) {
392                 builder.setGc((Gc) obj);
393                 return SvecState.GC_IN;
394             }
395         case GC_IN:
396             if (obj instanceof Xro) {
397                 builder.setXro((Xro) obj);
398                 return SvecState.XRO_IN;
399             }
400         case XRO_IN:
401             if (obj instanceof Metric) {
402                 metrics.add(new MetricsBuilder().setMetric((Metric) obj).build());
403                 return SvecState.XRO_IN;
404             }
405         case METRIC_IN:
406             if (obj instanceof VendorInformationObject) {
407                 viObjects.add((VendorInformationObject) obj);
408                 return SvecState.METRIC_IN;
409             }
410         case VENDOR_INFO:
411         case END:
412             return SvecState.END;
413         default:
414             return state;
415         }
416     }
417
418     private enum SvecState {
419         INIT, OF_IN, GC_IN, XRO_IN, METRIC_IN, VENDOR_INFO, END
420     }
421
422     protected MonitoringRequest getMonitoring(final List<Object> objects) {
423         final MonitoringRequestBuilder builder = new MonitoringRequestBuilder();
424         if (!objects.isEmpty() && objects.get(0) instanceof Monitoring) {
425             builder.setMonitoring((Monitoring) objects.get(0));
426             objects.remove(0);
427         } else {
428             return null;
429         }
430         if (!objects.isEmpty() && objects.get(0) instanceof PccIdReq) {
431             builder.setPccIdReq((PccIdReq) objects.get(0));
432             objects.remove(0);
433         }
434         final List<PceIdList> pceIdList = new ArrayList<>();
435         while(!objects.isEmpty() && objects.get(0) instanceof PceId) {
436             pceIdList.add(new PceIdListBuilder().setPceId((PceId) objects.get(0)).build());
437             objects.remove(0);
438         }
439         if (!pceIdList.isEmpty()) {
440             builder.setPceIdList(pceIdList);
441         }
442         return builder.build();
443     }
444 }