pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/AbstractMessageParser.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.spi;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.primitives.UnsignedBytes;
  13 import io.netty.buffer.ByteBuf;
  14 import java.util.ArrayList;
  15 import java.util.Arrays;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import javax.annotation.Nullable;
  19 import org.opendaylight.protocol.util.BitArray;
  20 import org.opendaylight.protocol.util.ByteArray;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.iana.rev130816.EnterpriseNumber;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev131007.PcerrBuilder;
  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.ObjectHeader;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcep.error.object.ErrorObjectBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessageBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.ErrorsBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.RequestCaseBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.request._case.RequestBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.pcerr.message.error.type.request._case.request.RpsBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.rp.object.Rp;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.vendor.information.objects.VendorInformationObject;
  34
  35 public abstract class AbstractMessageParser implements MessageParser, MessageSerializer {
  36
  37     private static final int COMMON_OBJECT_HEADER_LENGTH = 4;
  38
  39     private static final int OT_SF_LENGTH = 4;
  40     /*
  41      * offsets of fields inside of multi-field in bits
  42      */
  43     private static final int OT_SF_OFFSET = 0;
  44     /*
  45      * flags offsets inside multi-filed
  46      */
  47     private static final int PROCESSED = 6;
  48     private static final int IGNORED = 7;
  49
  50     private final ObjectRegistry registry;
  51     private final VendorInformationObjectRegistry viRegistry;
  52
  53     protected AbstractMessageParser(final ObjectRegistry registry) {
  54         this.registry = Preconditions.checkNotNull(registry);
  55         this.viRegistry = null;
  56     }
  57
  58     protected AbstractMessageParser(final ObjectRegistry registry, final VendorInformationObjectRegistry viRegistry) {
  59         this.registry = Preconditions.checkNotNull(registry);
  60         this.viRegistry = Preconditions.checkNotNull(viRegistry);
  61     }
  62
  63     /**
  64      * Calls registry to pick up specific object serializer for given object.
  65      * Checks if the object is not null.
  66      * @param object Object to be serialized, may be null
  67      * @param buffer ByteBuf where the object should be serialized
  68      */
  69     protected void serializeObject(@Nullable final Object object, final ByteBuf buffer) {
  70         if (object == null) {
  71             return;
  72         }
  73         this.registry.serializeObject(object, buffer);
  74     }
  75
  76     private List<Object> parseObjects(final ByteBuf bytes) throws PCEPDeserializerException {
  77         final List<Object> objs = new ArrayList<>();
  78         while (bytes.isReadable()) {
  79             if (bytes.readableBytes() < COMMON_OBJECT_HEADER_LENGTH) {
  80                 throw new PCEPDeserializerException("Too few bytes in passed array. Passed: " + bytes.readableBytes() + " Expected: >= "
  81                         + COMMON_OBJECT_HEADER_LENGTH + ".");
  82             }
  83             final int objClass = bytes.readUnsignedByte();
  84
  85             final byte flagsByte = bytes.readByte();
  86             final BitArray flags = BitArray.valueOf(flagsByte);
  87             final int objType = UnsignedBytes.toInt(ByteArray.copyBitsRange(flagsByte, OT_SF_OFFSET, OT_SF_LENGTH));
  88             final int objLength = bytes.readUnsignedShort();
  89
  90             if (bytes.readableBytes() < objLength - COMMON_OBJECT_HEADER_LENGTH) {
  91                 throw new PCEPDeserializerException("Too few bytes in passed array. Passed: " + bytes.readableBytes() + " Expected: >= "
  92                         + objLength + ".");
  93             }
  94             // copy bytes for deeper parsing
  95             final ByteBuf bytesToPass = bytes.readSlice(objLength - COMMON_OBJECT_HEADER_LENGTH);
  96
  97             final ObjectHeader header = new ObjectHeaderImpl(flags.get(PROCESSED), flags.get(IGNORED));
  98
  99             if (VendorInformationUtil.isVendorInformationObject(objClass, objType)) {
 100                 Preconditions.checkState(this.viRegistry != null);
 101                 final EnterpriseNumber enterpriseNumber = new EnterpriseNumber(bytesToPass.readUnsignedInt());
 102                 final Optional<? extends Object> obj = this.viRegistry.parseVendorInformationObject(enterpriseNumber, header, bytesToPass);
 103                 if (obj.isPresent()) {
 104                     objs.add(obj.get());
 105                 }
 106             } else {
 107                 // parseObject is required to return null for P=0 errored objects
 108                 final Object o = this.registry.parseObject(objClass, objType, header, bytesToPass);
 109                 if (o != null) {
 110                     objs.add(o);
 111                 }
 112             }
 113         }
 114
 115         return objs;
 116     }
 117
 118     public static Message createErrorMsg(final PCEPErrors e, final Optional<Rp> rp) {
 119         final PcerrMessageBuilder msgBuilder = new PcerrMessageBuilder();
 120         if (rp.isPresent()) {
 121             new RequestCaseBuilder().setRequest(new RequestBuilder().setRps(Collections.singletonList(new RpsBuilder().setRp(
 122                     rp.get()).build())).build()).build();
 123         }
 124         return new PcerrBuilder().setPcerrMessage(
 125                 msgBuilder.setErrors(Arrays.asList(new ErrorsBuilder().setErrorObject(
 126                         new ErrorObjectBuilder().setType(e.getErrorType()).setValue(
 127                                 e.getErrorValue()).build()).build())).build()).build();
 128     }
 129
 130     protected abstract Message validate(final List<Object> objects, final List<Message> errors) throws PCEPDeserializerException;
 131
 132     @Override
 133     public final Message parseMessage(final ByteBuf buffer, final List<Message> errors) throws PCEPDeserializerException {
 134         Preconditions.checkNotNull(buffer, "Buffer may not be null");
 135
 136         // Parse objects first
 137         final List<Object> objs = parseObjects(buffer);
 138
 139         // Run validation
 140         return validate(objs, errors);
 141     }
 142
 143     protected final void serializeVendorInformationObjects(final List<VendorInformationObject> viObjects, final ByteBuf buffer) {
 144         if (viObjects != null) {
 145             for (final VendorInformationObject viObject : viObjects) {
 146                 this.viRegistry.serializeVendorInformationObject(viObject, buffer);
 147             }
 148         }
 149     }
 150
 151     protected final List<VendorInformationObject> addVendorInformationObjects(final List<Object> objects) {
 152         final List<VendorInformationObject> vendorInfo = new ArrayList<>();
 153         while (!objects.isEmpty() && objects.get(0) instanceof VendorInformationObject) {
 154             final VendorInformationObject viObject = (VendorInformationObject) objects.get(0);
 155             vendorInfo.add(viObject);
 156             objects.remove(0);
 157         }
 158         return vendorInfo;
 159     }
 160 }