-/**
- * Build PCMM gate requests from API QoS Gate objects
+/*
+ * Copyright (c) 2015 CableLabs and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
*/
+
package org.opendaylight.controller.packetcable.provider;
-import org.opendaylight.yang.gen.v1.urn.packetcable.rev150327.ServiceFlowDirection;
-import org.opendaylight.yang.gen.v1.urn.packetcable.rev150327.TosByte;
-import org.opendaylight.yang.gen.v1.urn.packetcable.rev150327.ccap.attributes.AmId;
-import org.opendaylight.yang.gen.v1.urn.packetcable.rev150327.pcmm.qos.classifier.Classifier;
-import org.opendaylight.yang.gen.v1.urn.packetcable.rev150327.pcmm.qos.ext.classifier.ExtClassifier;
-import org.opendaylight.yang.gen.v1.urn.packetcable.rev150327.pcmm.qos.gate.spec.GateSpec;
-import org.opendaylight.yang.gen.v1.urn.packetcable.rev150327.pcmm.qos.ipv6.classifier.Ipv6Classifier;
-import org.opendaylight.yang.gen.v1.urn.packetcable.rev150327.pcmm.qos.traffic.profile.TrafficProfile;
-import org.pcmm.gates.*;
-import org.pcmm.gates.IGateSpec.DSCPTOS;
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.google.common.collect.Lists;
+import java.net.Inet4Address;
+import java.net.Inet6Address;
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+import java.util.List;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.ServiceFlowDirection;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.TosByte;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.ccap.attributes.AmId;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.classifier.attributes.classifiers.ClassifierContainer;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.classifier.attributes.classifiers.classifier.container.ClassifierChoice;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.classifier.attributes.classifiers.classifier.container.classifier.choice.ExtClassifierChoice;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.classifier.attributes.classifiers.classifier.container.classifier.choice.Ipv6ClassifierChoice;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.classifier.attributes.classifiers.classifier.container.classifier.choice.QosClassifierChoice;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.classifier.Classifier;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.ext.classifier.ExtClassifier;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.gate.spec.GateSpec;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.ipv6.classifier.Ipv6Classifier;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.traffic.profile.TrafficProfile;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.serviceclass.name.profile.ServiceClassNameProfile;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.flow.spec.profile.FlowSpecProfile;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.ugs.profile.UgsProfile;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.rtp.profile.RtpProfile;
+import org.pcmm.gates.IClassifier;
+import org.pcmm.gates.IClassifier.Protocol;
+import org.pcmm.gates.IExtendedClassifier;
+import org.pcmm.gates.IExtendedClassifier.ActivationState;
import org.pcmm.gates.IGateSpec.Direction;
+import org.pcmm.gates.IIPv6Classifier.FlowLabel;
+import org.pcmm.gates.ITrafficProfile;
+import org.pcmm.gates.impl.AMID;
import org.pcmm.gates.impl.DOCSISServiceClassNameTrafficProfile;
+import org.pcmm.gates.impl.DOCSISFlowSpecTrafficProfile;
+import org.pcmm.gates.impl.DOCSISUGSTrafficProfile;
+import org.pcmm.gates.impl.DOCSISRTPTrafficProfile;
+import org.pcmm.gates.impl.GateID;
+import org.pcmm.gates.impl.GateState;
+import org.pcmm.gates.impl.GateTimeInfo;
+import org.pcmm.gates.impl.GateUsageInfo;
+import org.pcmm.gates.impl.PCMMError;
import org.pcmm.gates.impl.PCMMGateReq;
+import org.pcmm.gates.impl.SessionClassID;
import org.pcmm.gates.impl.SubscriberID;
+import org.pcmm.gates.impl.TransactionID;
+import org.pcmm.utils.PCMMUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
-import java.net.InetAddress;
-import java.net.UnknownHostException;
-
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.traffic.profile.TrafficProfile;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.traffic.profile.traffic.profile.TrafficProfileChoice;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.traffic.profile.traffic.profile.traffic.profile.choice.FlowSpecChoice;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.traffic.profile.traffic.profile.traffic.profile.choice.ServiceClassNameChoice;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.traffic.profile.traffic.profile.traffic.profile.choice.RtpChoice;
+import org.opendaylight.yang.gen.v1.urn.packetcable.rev170125.pcmm.qos.traffic.profile.traffic.profile.traffic.profile.choice.UgsChoice;
+
/**
- *
- * PacketCable data processor
- *
+ * Build PCMM gate requests from API QoS Gate objects
*/
public class PCMMGateReqBuilder {
- private Logger logger = LoggerFactory.getLogger(PCMMGateReqBuilder.class);
-
- private PCMMGateReq gateReq = null;
-
- public PCMMGateReqBuilder() {
- gateReq = new org.pcmm.gates.impl.PCMMGateReq();
- }
-
- public PCMMGateReq getGateReq() {
- return gateReq;
- }
-
- public void build(AmId qosAmId){
- IAMID amId = new org.pcmm.gates.impl.AMID();
- amId.setApplicationMgrTag(qosAmId.getAmTag().shortValue());
- amId.setApplicationType(qosAmId.getAmType().shortValue());
- gateReq.setAMID(amId);
- }
-
- public void build(InetAddress qosSubId){
- ISubscriberID subId = new SubscriberID();
- subId.setSourceIPAddress(qosSubId);
- gateReq.setSubscriberID(subId);
- }
-
- public void build(GateSpec qosGateSpec, ServiceFlowDirection scnDirection) {
- IGateSpec gateSpec = new org.pcmm.gates.impl.GateSpec();
- // service flow direction
- ServiceFlowDirection qosDir = null;
- Direction gateDir = null;
- if (scnDirection != null) {
- qosDir = scnDirection;
- } else if (qosGateSpec.getDirection() != null) {
- qosDir = qosGateSpec.getDirection();
- }
- if (qosDir == ServiceFlowDirection.Ds) {
- gateDir = Direction.DOWNSTREAM;
- } else if (qosDir == ServiceFlowDirection.Us) {
- gateDir = Direction.UPSTREAM;
- }
- gateSpec.setDirection(gateDir);
- // DSCP/TOS Overwrite
- TosByte tosOverwrite = qosGateSpec.getDscpTosOverwrite();
- if (tosOverwrite != null) {
- byte gateTos = tosOverwrite.getValue().byteValue();
- gateSpec.setDSCP_TOSOverwrite(DSCPTOS.ENABLE);
- gateSpec.setDSCP_TOSOverwrite(gateTos);
- TosByte tosMask = qosGateSpec.getDscpTosMask();
- if (tosMask != null) {
- byte gateTosMask = tosMask.getValue().byteValue();
- gateSpec.setDSCP_TOSMask(gateTosMask);
- } else {
- gateSpec.setDSCP_TOSMask((byte)0xff);
- }
- }
- gateReq.setGateSpec(gateSpec);
- }
-
- public void build(TrafficProfile qosTrafficProfile) {
- if (qosTrafficProfile.getServiceClassName() != null) {
- String scn = qosTrafficProfile.getServiceClassName().getValue();
- DOCSISServiceClassNameTrafficProfile trafficProfile = new DOCSISServiceClassNameTrafficProfile();
- if (scn.length() <= 16) { // NB.16 char SCN is max length per PCMM spec
- trafficProfile.setServiceClassName(scn);
- gateReq.setTrafficProfile(trafficProfile);
- }
- }
- }
-
- private InetAddress getByName(String ipAddressStr){
- InetAddress ipAddress = null;
- try {
- ipAddress = InetAddress.getByName(ipAddressStr);
- } catch (UnknownHostException e) {
- logger.error(e.getMessage());
- }
- return ipAddress;
- }
-
- public void build(Classifier qosClassifier) {
- // Legacy classifier
- IClassifier classifier = new org.pcmm.gates.impl.Classifier();
- classifier.setPriority((byte) 64);
- if (qosClassifier.getProtocol() != null){
- classifier.setProtocol(qosClassifier.getProtocol().getValue().shortValue());
- }
- if (qosClassifier.getSrcIp() != null) {
- InetAddress sip = getByName(qosClassifier.getSrcIp().getValue());
- if (sip != null) {
- classifier.setSourceIPAddress(sip);
- }
- }
- if (qosClassifier.getDstIp() != null) {
- InetAddress dip = getByName(qosClassifier.getDstIp().getValue());
- if (dip != null) {
- classifier.setDestinationIPAddress(dip);
- }
- }
- if (qosClassifier.getSrcPort() != null) {
- classifier.setSourcePort(qosClassifier.getSrcPort().getValue().shortValue());
- }
- if (qosClassifier.getDstPort() != null) {
- classifier.setDestinationPort(qosClassifier.getDstPort().getValue().shortValue());
- }
- if (qosClassifier.getTosByte() != null) {
- classifier.setDSCPTOS(qosClassifier.getTosByte().getValue().byteValue());
- if (qosClassifier.getTosMask() != null) {
- classifier.setDSCPTOSMask(qosClassifier.getTosMask().getValue().byteValue());
- } else {
- // set default TOS mask
- classifier.setDSCPTOSMask((byte)0xff);
- }
- }
- // push the classifier to the gate request
- gateReq.setClassifier(classifier);
- }
-
- public void build(ExtClassifier qosExtClassifier) {
- // Extended classifier
- IExtendedClassifier extClassifier = new org.pcmm.gates.impl.ExtendedClassifier();
- extClassifier.setPriority((byte) 64);
- extClassifier.setActivationState((byte) 0x01);
- // Protocol -- zero is match any
- if (qosExtClassifier.getProtocol() != null){
- extClassifier.setProtocol(qosExtClassifier.getProtocol().getValue().shortValue());
- } else {
- extClassifier.setProtocol((short)0);
- }
- // Source IP address & mask
- if (qosExtClassifier.getSrcIp() != null) {
- InetAddress sip = getByName(qosExtClassifier.getSrcIp().getValue());
- if (sip != null) {
- extClassifier.setSourceIPAddress(sip);
- if (qosExtClassifier.getSrcIpMask() != null) {
- InetAddress sipMask = getByName(qosExtClassifier.getSrcIpMask().getValue());
- extClassifier.setIPSourceMask(sipMask);
- } else {
- // default mask is /32
- extClassifier.setIPSourceMask(getByName("255.255.255.255"));
- }
- }
- }
- // Destination IP address & mask
- if (qosExtClassifier.getDstIp() != null) {
- InetAddress dip = getByName(qosExtClassifier.getDstIp().getValue());
- if (dip != null) {
- extClassifier.setDestinationIPAddress(dip);
- if (qosExtClassifier.getDstIpMask() != null) {
- InetAddress dipMask = getByName(qosExtClassifier.getDstIpMask().getValue());
- extClassifier.setIPDestinationMask(dipMask);
- } else {
- // default mask is /32
- extClassifier.setIPDestinationMask(getByName("255.255.255.255"));
- }
- }
- }
- // default source port range must be set to match any even if qosExtClassifier has no range
- // match any port range is 0-65535, NOT 0-0
- short startPort = (short)0;
- short endPort = (short)65535;
- if (qosExtClassifier.getSrcPortStart() != null) {
- startPort = qosExtClassifier.getSrcPortStart().getValue().shortValue();
- endPort = startPort;
- if (qosExtClassifier.getSrcPortEnd() != null) {
- endPort = qosExtClassifier.getSrcPortEnd().getValue().shortValue();
- }
- if (startPort > endPort) {
- logger.warn("Start port %d > End port %d in ext-classifier source port range -- forcing to same", startPort, endPort);
- endPort = startPort;
- }
- }
- extClassifier.setSourcePortStart(startPort);
- extClassifier.setSourcePortEnd(endPort);
- // default destination port range must be set to match any even if qosExtClassifier has no range
- // match any port range is 0-65535, NOT 0-0
- startPort = (short)0;
- endPort = (short)65535;
- if (qosExtClassifier.getDstPortStart() != null) {
- startPort = qosExtClassifier.getDstPortStart().getValue().shortValue();
- endPort = startPort;
- if (qosExtClassifier.getDstPortEnd() != null) {
- endPort = qosExtClassifier.getDstPortEnd().getValue().shortValue();
- }
- if (startPort > endPort) {
- logger.warn("Start port %d > End port %d in ext-classifier destination port range -- forcing to same", startPort, endPort);
- endPort = startPort;
- }
- }
- extClassifier.setDestinationPortStart(startPort);
- extClassifier.setDestinationPortEnd(endPort);
- // DSCP/TOP byte
- if (qosExtClassifier.getTosByte() != null) {
- // OR in the DSCP/TOS enable bit 0x01
- extClassifier.setDSCPTOS((byte) (qosExtClassifier.getTosByte().getValue().byteValue() | 0x01));
- if (qosExtClassifier.getTosMask() != null) {
- extClassifier.setDSCPTOSMask(qosExtClassifier.getTosMask().getValue().byteValue());
- } else {
- // set default TOS mask
- extClassifier.setDSCPTOSMask((byte)0xff);
- }
- }
- // push the extended classifier to the gate request
- gateReq.setClassifier(extClassifier);
- }
-
- public void build(Ipv6Classifier qosIpv6Classifier) {
- // IPv6 classifier
- IIPv6Classifier ipv6Classifier = new org.pcmm.gates.impl.IPv6Classifier();
- ipv6Classifier.setPriority((byte) 64);
- ipv6Classifier.setActivationState((byte) 0x01);
- // Flow Label
- if (qosIpv6Classifier.getFlowLabel() != null){
- ipv6Classifier.setFlowLabel(qosIpv6Classifier.getFlowLabel());
- ipv6Classifier.setFlowLabelEnableFlag((byte)0x01);
- }
- // Next Header
- if (qosIpv6Classifier.getNextHdr() != null){
- ipv6Classifier.setNextHdr(qosIpv6Classifier.getNextHdr().getValue().shortValue());
- } else {
- // default: match any nextHdr is 256 because nextHdr 0 is Hop-by-Hop option
- ipv6Classifier.setNextHdr((short)256);
- }
- // Source IPv6 address & prefix len
- byte prefLen;
- if (qosIpv6Classifier.getSrcIp6() != null) {
- String[] parts = qosIpv6Classifier.getSrcIp6().getValue().split("/");
- String Ipv6AddressStr = parts[0];
- InetAddress sip6 = getByName(Ipv6AddressStr);
- if (sip6 != null) {
- ipv6Classifier.setSourceIPAddress(sip6);
- }
- prefLen = (byte)128;
- if (parts.length > 1) {
- prefLen = (byte)Integer.parseInt(parts[1]);
- }
- ipv6Classifier.setSourcePrefixLen(prefLen);
- }
- // Destination IPv6 address & prefix len
- if (qosIpv6Classifier.getDstIp6() != null) {
- String[] parts = qosIpv6Classifier.getDstIp6().getValue().split("/");
- String Ipv6AddressStr = parts[0];
- InetAddress dip6 = getByName(Ipv6AddressStr);
- if (dip6 != null) {
- ipv6Classifier.setDestinationIPAddress(dip6);
- }
- prefLen = (byte)128;
- if (parts.length > 1) {
- prefLen = (byte)Integer.parseInt(parts[1]);
- }
- ipv6Classifier.setDestinationPrefixLen(prefLen);
- }
- // default source port range must be set to match any -- even if qosExtClassifier has no range value
- // match any port range is 0-65535, NOT 0-0
- short startPort = (short)0;
- short endPort = (short)65535;
- if (qosIpv6Classifier.getSrcPortStart() != null) {
- startPort = qosIpv6Classifier.getSrcPortStart().getValue().shortValue();
- endPort = startPort;
- if (qosIpv6Classifier.getSrcPortEnd() != null) {
- endPort = qosIpv6Classifier.getSrcPortEnd().getValue().shortValue();
- }
- if (startPort > endPort) {
- logger.warn("Start port %d > End port %d in ipv6-classifier source port range -- forcing to same", startPort, endPort);
- endPort = startPort;
- }
- }
- ipv6Classifier.setSourcePortStart(startPort);
- ipv6Classifier.setSourcePortEnd(endPort);
- // default destination port range must be set to match any -- even if qosExtClassifier has no range value
- // match any port range is 0-65535, NOT 0-0
- startPort = (short)0;
- endPort = (short)65535;
- if (qosIpv6Classifier.getDstPortStart() != null) {
- startPort = qosIpv6Classifier.getDstPortStart().getValue().shortValue();
- endPort = startPort;
- if (qosIpv6Classifier.getDstPortEnd() != null) {
- endPort = qosIpv6Classifier.getDstPortEnd().getValue().shortValue();
- }
- if (startPort > endPort) {
- logger.warn("Start port %d > End port %d in ipv6-classifier destination port range -- forcing to same", startPort, endPort);
- endPort = startPort;
- }
- }
- ipv6Classifier.setDestinationPortStart(startPort);
- ipv6Classifier.setDestinationPortEnd(endPort);
- // TC low, high, mask
- if (qosIpv6Classifier.getTcLow() != null) {
- ipv6Classifier.setTcLow(qosIpv6Classifier.getTcLow().getValue().byteValue());
- if (qosIpv6Classifier.getTcHigh() != null) {
- ipv6Classifier.setTcHigh(qosIpv6Classifier.getTcHigh().getValue().byteValue());
- }
- if (qosIpv6Classifier.getTcMask() != null) {
- ipv6Classifier.setTcMask(qosIpv6Classifier.getTcMask().getValue().byteValue());
- } else {
- // set default TOS mask
- ipv6Classifier.setTcMask((byte)0xff);
- }
- } else {
- // mask 0x00 is match any
- ipv6Classifier.setTcMask((byte)0x00);
- }
- // push the IPv6 classifier to the gate request
- gateReq.setClassifier(ipv6Classifier);
- }
+ private final Logger logger = LoggerFactory.getLogger(PCMMGateReqBuilder.class);
+
+ private GateID gateID = null;
+ private AMID amid = null;
+ private SubscriberID subscriberID = null;
+ private TransactionID transactionID = null;
+ private org.pcmm.gates.impl.GateSpec gateSpec = null;
+ private ITrafficProfile trafficProfile = null;
+ private final List<IClassifier> classifiers = Lists.newArrayListWithExpectedSize(4);
+ private PCMMError error = null;
+ private GateState gateState = null;
+ private GateTimeInfo gateTimeInfo = null;
+ private GateUsageInfo gateUsageInfo = null;
+
+ public PCMMGateReq build() {
+ return new PCMMGateReq(amid, subscriberID, transactionID, gateSpec, trafficProfile, classifiers,
+ gateID, error, gateState, gateTimeInfo, gateUsageInfo);
+ }
+
+ public void setAmId(final AmId qosAmId) {
+ amid = new AMID(qosAmId.getAmType().shortValue(), qosAmId.getAmTag().shortValue());
+ }
+
+ public void setSubscriberId(final InetAddress qosSubId) {
+ subscriberID = new SubscriberID(qosSubId);
+ }
+
+ public void setGateId(int gateId) {
+ gateID = new GateID(gateId);
+ }
+
+ public void setGateSpec(final GateSpec qosGateSpec) {
+
+ final ServiceFlowDirection qosDir = qosGateSpec.getDirection();
+
+ // convert to PCMM API Type
+ final Direction gateDir;
+ if (qosDir == ServiceFlowDirection.Ds) {
+ gateDir = Direction.DOWNSTREAM;
+ } else {
+ gateDir = Direction.UPSTREAM;
+ }
+
+ final byte dscptos = 1;
+ final byte gateTosMask;
+
+ TosByte tosMask = qosGateSpec.getDscpTosMask();
+ if (tosMask != null) {
+ gateTosMask = tosMask.getValue().byteValue();
+ } else {
+ gateTosMask = (byte) 0xff;
+ }
+
+ java.lang.Short scid = qosGateSpec.getSessionClassId();
+ byte bscid = 0;
+ if (scid != null) {
+ bscid = (byte)(qosGateSpec.getSessionClassId() & 0x00ff);
+ }
+
+ java.lang.Long inactivity = qosGateSpec.getInactivityTimer();
+ short sinactivity = 300;
+ if (inactivity != null) {
+ sinactivity = inactivity.shortValue();
+ }
+
+ gateSpec = new org.pcmm.gates.impl.GateSpec(gateDir, dscptos, gateTosMask,
+ new SessionClassID(bscid),
+ (short)1,(short)300,sinactivity,(short)0);
+ }
+
+ public void setTrafficProfile(final TrafficProfile qosTrafficProfile) {
+ TrafficProfileChoice choice = qosTrafficProfile.getTrafficProfileChoice();
+
+ if (choice instanceof ServiceClassNameChoice) {
+ ServiceClassNameProfile scnp = ((ServiceClassNameChoice)choice).getServiceClassNameProfile();
+ trafficProfile = new DOCSISServiceClassNameTrafficProfile(scnp.getServiceClassName().getValue());
+ }
+ else if (choice instanceof FlowSpecChoice) {
+ FlowSpecProfile fsp = ((FlowSpecChoice)choice).getFlowSpecProfile();
+ trafficProfile = new DOCSISFlowSpecTrafficProfile(fsp.getTokenBucketRate(),
+ fsp.getTokenBucketSize(),
+ fsp.getPeakDataRate(),
+ fsp.getMinimumPolicedUnit(),
+ fsp.getMaximumPacketSize(),
+ fsp.getRate(),
+ fsp.getSlackTerm());
+ }
+ else if (choice instanceof UgsChoice) {
+ UgsProfile ugsp = ((UgsChoice)choice).getUgsProfile();
+ trafficProfile = new DOCSISUGSTrafficProfile(ugsp.getRequestTransmissionPolicy(),
+ ugsp.getUnsolicitedGrantSize(),
+ ugsp.getGrantsPerInterval(),
+ ugsp.getNominalGrantInterval(),
+ ugsp.getToleratedGrantJitter(),
+ ugsp.getUpstreamPeakTrafficRate(),
+ ugsp.getRequiredAttributeMask(),
+ ugsp.getForbiddenAttributeMask(),
+ ugsp.getAttributeAggregationRuleMask());
+ }
+ else if (choice instanceof RtpChoice) {
+ RtpProfile rtpp = ((RtpChoice)choice).getRtpProfile();
+ trafficProfile = new DOCSISRTPTrafficProfile(rtpp.getRequestTransmissionPolicy(),
+ rtpp.getMaximumSustainedTrafficRate(),
+ rtpp.getMaximumTrafficBurst(),
+ rtpp.getMinimumReservedTrafficRate(),
+ rtpp.getAmrtrPacketSize().longValue(),
+ rtpp.getMaximumConcatenatedBurst().longValue(),
+ rtpp.getNominalPollingInterval(),
+ rtpp.getToleratedPollJitter(),
+ rtpp.getUpstreamPeakTrafficRate(),
+ rtpp.getRequiredAttributeMask(),
+ rtpp.getForbiddenAttributeMask(),
+ rtpp.getAttributeAggregationRuleMask());
+ }
+ else {
+ logger.debug("PCMMGateReq().setTrafficProfile() Unsupported Traffic Profile: " + choice.getClass().getName());
+ }
+ }
+
+ private InetAddress getByName(final String ipAddressStr) {
+ try {
+ return InetAddress.getByName(ipAddressStr);
+ } catch (UnknownHostException e) {
+ logger.error(e.getMessage());
+ }
+ return null;
+ }
+
+ public void setClassifiers(final List<ClassifierContainer> classifiers) {
+ checkNotNull(classifiers);
+
+ for (ClassifierContainer container : classifiers) {
+ final ClassifierChoice choice = container.getClassifierChoice();
+ final Short index = container.getClassifierId();
+
+ if (choice instanceof QosClassifierChoice) {
+ addClassifier(index, ((QosClassifierChoice) choice).getClassifier());
+ }
+ else if (choice instanceof ExtClassifierChoice) {
+ addExtClassifier(index, ((ExtClassifierChoice) choice).getExtClassifier());
+ }
+ else if (choice instanceof Ipv6ClassifierChoice) {
+ addIpv6Classifier(index, ((Ipv6ClassifierChoice) choice).getIpv6Classifier());
+ }
+ else {
+ throw new IllegalStateException("Unknown ClassifierChoice: " + choice);
+ }
+ }
+ }
+
+ private void addClassifier(final Short index,final Classifier qosClassifier) {
+ // TODO - try and make these variables immutable
+ Protocol protocol = null;
+ byte tosOverwrite = 0;
+ byte tosMask = (byte)0x0;
+ short srcPort = (short) 0;
+ short dstPort = (short) 0;
+
+ // Legacy classifier
+
+ // Protocol -- zero is match any
+ if (qosClassifier.getProtocol() != null) {
+ protocol = Protocol.valueOf(qosClassifier.getProtocol().getValue().shortValue());
+ } else {
+ protocol = Protocol.NONE;
+ }
+
+ // IP Addresss and mask wildcards - addr byte 0 for no match (or match anything)
+
+ Inet4Address srcAddress = (Inet4Address) getByName("0.0.0.0");
+
+ if (qosClassifier.getSrcIp() != null) {
+ srcAddress = (Inet4Address) getByName(qosClassifier.getSrcIp().getValue());
+ }
+
+ Inet4Address dstAddress = (Inet4Address) getByName("0.0.0.0");
+
+ if (qosClassifier.getDstIp() != null) {
+ dstAddress = (Inet4Address) getByName(qosClassifier.getDstIp().getValue());
+ }
+
+
+ if (qosClassifier.getSrcPort() != null) {
+ srcPort = qosClassifier.getSrcPort().getValue().shortValue();
+ }
+ if (qosClassifier.getDstPort() != null) {
+ dstPort = qosClassifier.getDstPort().getValue().shortValue();
+ }
+ if (qosClassifier.getTosByte() != null) {
+ tosOverwrite = qosClassifier.getTosByte().getValue().byteValue();
+ if (qosClassifier.getTosMask() != null) {
+ tosMask = qosClassifier.getTosMask().getValue().byteValue();
+ } else {
+ // set default TOS mask
+ tosMask = (byte) 0xff;
+ }
+ }
+ //
+ // The packetcable.yang models priority as an uint8 which means the java generated
+ // implementation saves the value in a short, so we mask it back into a byte
+ //
+ byte priority = 64;
+ if (qosClassifier.getPriority() != null) {
+ short result = qosClassifier.getPriority();
+ priority = (byte)(result % 255);
+ }
+
+ // push the classifier to the gate request
+ classifiers.add(new org.pcmm.gates.impl.Classifier(protocol, tosOverwrite, tosMask, srcAddress, dstAddress, srcPort,
+ dstPort, priority));
+ }
+
+ private void addExtClassifier(final Short index, final ExtClassifier qosExtClassifier) {
+ // Extended classifier
+ // Protocol -- zero is match any
+ final Protocol protocol;
+ if (qosExtClassifier.getProtocol() != null) {
+ protocol = Protocol.valueOf(qosExtClassifier.getProtocol().getValue().shortValue());
+ } else {
+ protocol = Protocol.NONE;
+ }
+
+ // default source port range must be set to match any even if qosExtClassifier has no range
+ // match any port range is 0-65535, NOT 0-0
+ // TODO - try to make these two variables immutable
+ short srcStartPort = (short) 0;
+ short srcEndPort = (short) 65535;
+ if (qosExtClassifier.getSrcPortStart() != null) {
+ srcStartPort = qosExtClassifier.getSrcPortStart().getValue().shortValue();
+ srcEndPort = srcStartPort;
+ if (qosExtClassifier.getSrcPortEnd() != null) {
+ srcEndPort = qosExtClassifier.getSrcPortEnd().getValue().shortValue();
+ }
+ if ((int)(srcStartPort & 0xffff) > (int) (srcEndPort & 0xffff)) {
+ logger.warn("Start port %d > End port %d in ext-classifier source port range -- forcing to same",
+ srcStartPort, srcEndPort);
+ srcEndPort = srcStartPort;
+ }
+ }
+ // default destination port range must be set to match any even if qosExtClassifier has no range
+ // match any port range is 0-65535, NOT 0-0
+ // TODO - try to make these two variables immutable
+ short dstStartPort = (short) 0;
+ short dstEndPort = (short) 65535;
+ if (qosExtClassifier.getDstPortStart() != null) {
+ dstStartPort = qosExtClassifier.getDstPortStart().getValue().shortValue();
+ dstEndPort = dstStartPort;
+ if (qosExtClassifier.getDstPortEnd() != null) {
+ dstEndPort = qosExtClassifier.getDstPortEnd().getValue().shortValue();
+ }
+ if ((int)(dstStartPort & 0xffff) > (int)(dstEndPort & 0xffff)) {
+ logger.warn("Start port %d > End port %d in ext-classifier destination port range -- forcing to same",
+ dstStartPort, dstEndPort);
+ dstEndPort = dstStartPort;
+ }
+ }
+
+ // DSCP/TOP byte
+ // TODO - try to make these two variables immutable
+ byte tosOverwrite = 0;
+ byte tosMask = (byte)0x00;
+ if (qosExtClassifier.getTosByte() != null) {
+ // OR in the DSCP/TOS enable bit 0x01
+ tosOverwrite = (byte) (qosExtClassifier.getTosByte().getValue().byteValue() | 0x01);
+ if (qosExtClassifier.getTosMask() != null) {
+ tosMask = qosExtClassifier.getTosMask().getValue().byteValue();
+ } else {
+ // set default TOS mask
+ tosMask = (byte) 0xff;
+ }
+ }
+
+ // IP Addresss and mask wildcards - addr byte 0 for no match (or match anything) and mask is 255.255.255.255 by default
+ Inet4Address srcIpAddr = (Inet4Address) getByName("0.0.0.0");
+
+ if (qosExtClassifier.getSrcIp() != null) {
+ srcIpAddr = getInet4Address(qosExtClassifier.getSrcIp());
+ }
+
+ Inet4Address dstIpAddr = (Inet4Address) getByName("0.0.0.0");
+ if (qosExtClassifier.getDstIp() != null) {
+ dstIpAddr = getInet4Address(qosExtClassifier.getDstIp());
+ }
+
+ //mask
+ Inet4Address srcIpMask = (Inet4Address) getByName("255.255.255.255");
+ if (qosExtClassifier.getSrcIpMask() != null) {
+ srcIpMask = getInet4Address(qosExtClassifier.getSrcIpMask());
+ }
+
+ Inet4Address dstIpMask = (Inet4Address) getByName("255.255.255.255");
+ if (qosExtClassifier.getDstIpMask() != null) {
+ dstIpMask = getInet4Address(qosExtClassifier.getDstIpMask());
+ }
+
+ // TODO - find out what the classifier ID should really be. It was never getting set previously
+ final short classifierId = (short)index;
+
+ // TODO - find out what the action value should really be. It was never getting set previously
+ final IExtendedClassifier.Action action = IExtendedClassifier.Action.ADD;
+
+ //
+ // Convert from Enum to byte for serialization
+ //
+ ActivationState activationState = ActivationState.ACTIVE;
+ if (qosExtClassifier.getActivationState() != null) {
+ activationState = ActivationState.valueOf((byte)qosExtClassifier.getActivationState().getIntValue());
+ }
+
+ //
+ // The packetcable.yang models priority as an uint8 which means the java generated
+ // implementation saves the value in a short, so we mask it back into a byte
+ //
+ byte priority = 64;
+ if (qosExtClassifier.getPriority() != null) {
+ short result = qosExtClassifier.getPriority();
+ priority = (byte)(result % 255);
+ }
+
+ // push the extended classifier to the gate request
+ classifiers.add(new org.pcmm.gates.impl.ExtendedClassifier(protocol, tosOverwrite, tosMask,
+ srcIpAddr, dstIpAddr,
+ srcStartPort, dstStartPort, priority, srcIpMask, dstIpMask, srcEndPort, dstEndPort, classifierId, activationState,
+ action));
+ }
+
+ private Inet4Address getInet4Address(
+ final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address address) {
+ if (address != null) {
+ final InetAddress out = getByName(address.getValue());
+ if (out != null && out instanceof Inet4Address) {
+ return (Inet4Address) out;
+ }
+ }
+ return null;
+ }
+
+ private void addIpv6Classifier(final Short index, final Ipv6Classifier qosIpv6Classifier) {
+ // Next Header
+ final short nextHdr;
+ if (qosIpv6Classifier.getNextHdr() != null) {
+ nextHdr = qosIpv6Classifier.getNextHdr().getValue().shortValue();
+ }
+ // default: match any nextHdr is 256 because nextHdr 0 is Hop-by-Hop option
+ else {
+ nextHdr = (short) 256;
+ }
+
+ // Source IPv6 address & prefix len
+ // TODO - try to make these two variables immutable
+ byte srcPrefixLen = (byte) 128;
+ Inet6Address srcAddress = (Inet6Address) getByName("0::0");
+
+ if (qosIpv6Classifier.getSrcIp6() != null) {
+ String[] parts = qosIpv6Classifier.getSrcIp6().getValue().split("/");
+ String Ipv6AddressStr = parts[0];
+ srcAddress = (Inet6Address) getByName(Ipv6AddressStr);
+ if (parts.length > 1) {
+ srcPrefixLen = (byte) Integer.parseInt(parts[1]);
+ } else {
+ srcPrefixLen = (byte) 128;
+ }
+
+ }
+
+ // TODO - try to make these two variables immutable
+ Inet6Address dstAddress = (Inet6Address) getByName("0::0");
+
+ byte dstPrefLen = (byte) 128;
+ // Destination IPv6 address & prefix len
+ if (qosIpv6Classifier.getDstIp6() != null) {
+ final String[] parts = qosIpv6Classifier.getDstIp6().getValue().split("/");
+ final String Ipv6AddressStr = parts[0];
+ dstAddress = (Inet6Address)getByName(Ipv6AddressStr);
+ if (parts.length > 1) dstPrefLen = (byte) Integer.parseInt(parts[1]);
+ else dstPrefLen = (byte) 128;
+ }
+
+ // default source port range must be set to match any -- even if qosExtClassifier has no range value
+ // match any port range is 0-65535, NOT 0-0
+ short srcPortBegin = (short) 0;
+ short srcPortEnd = (short) 65535;
+ if (qosIpv6Classifier.getSrcPortStart() != null) {
+ srcPortBegin = qosIpv6Classifier.getSrcPortStart().getValue().shortValue();
+ srcPortEnd = srcPortBegin;
+ if (qosIpv6Classifier.getSrcPortEnd() != null) {
+ srcPortEnd = qosIpv6Classifier.getSrcPortEnd().getValue().shortValue();
+ }
+ if ((int)(srcPortBegin & 0xffff) > (int)(srcPortEnd & 0xffff)) {
+ logger.warn("Start port %d > End port %d in ipv6-classifier source port range -- forcing to same",
+ srcPortBegin, srcPortEnd);
+ srcPortEnd = srcPortBegin;
+ }
+ }
+
+ // default destination port range must be set to match any -- even if qosExtClassifier has no range value
+ // match any port range is 0-65535, NOT 0-0
+ short dstPortBegin = (short) 0;
+ short dstPortEnd = (short) 65535;
+ if (qosIpv6Classifier.getDstPortStart() != null) {
+ dstPortBegin = qosIpv6Classifier.getDstPortStart().getValue().shortValue();
+ dstPortEnd = dstPortBegin;
+ if (qosIpv6Classifier.getDstPortEnd() != null) {
+ dstPortEnd = qosIpv6Classifier.getDstPortEnd().getValue().shortValue();
+ }
+ if ( (int)(dstPortBegin & 0xffff) > (int)(dstPortEnd & 0xffff)) {
+ logger.warn("Start port %d > End port %d in ipv6-classifier destination port range -- forcing to same",
+ dstPortBegin, dstPortEnd);
+ dstPortEnd = dstPortBegin;
+ }
+ }
+
+ final byte tcLow;
+ if (qosIpv6Classifier.getTcLow() != null)
+ tcLow = qosIpv6Classifier.getTcLow().getValue().byteValue();
+ else tcLow = (byte) 0x00;
+
+ final byte tcHigh;
+ if (qosIpv6Classifier.getTcHigh() != null)
+ tcHigh = qosIpv6Classifier.getTcHigh().getValue().byteValue();
+ else tcHigh = (byte) 0x00;
+
+ final byte tcMask;
+ if (qosIpv6Classifier.getTcHigh() != null)
+ tcMask = qosIpv6Classifier.getTcHigh().getValue().byteValue();
+ else if (qosIpv6Classifier.getTcLow() != null) tcMask = (byte) 0xff;
+ else tcMask = (byte) 0x00;
+
+ FlowLabel flowLabelFlag = FlowLabel.IRRELEVANT;
+ int flowLabelId = 0;
+
+ if (qosIpv6Classifier.getFlowLabel() != null) {
+ flowLabelFlag = FlowLabel.VALID;
+ flowLabelId = qosIpv6Classifier.getFlowLabel().intValue();
+ }
+
+
+ // TODO - find out what the classifier ID should really be. It was never getting set previously
+ final short classifierId = (short)index;
+
+ // TODO - find out what the action value should really be. It was never getting set previously
+ final IExtendedClassifier.Action action = IExtendedClassifier.Action.ADD;
+
+ //
+ // Convert from Enum to byte for serialization
+ //
+ ActivationState activationState = ActivationState.ACTIVE;
+ if (qosIpv6Classifier.getActivationState() != null) {
+ activationState = ActivationState.valueOf((byte)qosIpv6Classifier.getActivationState().getIntValue());
+ }
+
+ //
+ // The packetcable.yang models priority as an uint8 which means the java generated
+ // implementation saves the value in a short, so we mask it back into a byte
+ //
+ byte priority = 64;
+ if (qosIpv6Classifier.getPriority() != null) {
+ short result = qosIpv6Classifier.getPriority();
+ priority = (byte)(result % 255);
+ }
+
+ // push the IPv6 classifier to the gate request
+ classifiers.add(
+ new org.pcmm.gates.impl.IPv6Classifier(srcAddress, dstAddress, srcPortBegin, dstPortBegin, priority,
+ srcPortEnd, dstPortEnd, classifierId, activationState, action, flowLabelFlag, tcLow,
+ tcHigh, tcMask, flowLabelId, nextHdr, srcPrefixLen, dstPrefLen));
+ }
}
Code Review / packetcable.git / blobdiff