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