2 * Copyright (c) 2014 Ericsson India Global Services Pvt Ltd. 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
9 package org.opendaylight.openflowplugin.openflow.md.core.sal.convertor;
11 import java.util.ArrayList;
12 import java.util.Arrays;
13 import java.util.Collection;
14 import java.util.List;
15 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.Convertor;
16 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionConvertorData;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.AddMeterInput;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterInput;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.UpdatedMeter;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.Meter;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.Drop;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.DscpRemark;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.Experimenter;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.MeterBandHeaders;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.MeterBandHeader;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.ExperimenterIdMeterBand;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.ExperimenterIdMeterBandBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ExperimenterId;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterBandType;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterFlags;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterId;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MeterModCommand;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterModInputBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.MeterBand;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDropCaseBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandDscpRemarkCaseBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCaseBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.drop._case.MeterBandDropBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.dscp.remark._case.MeterBandDscpRemarkBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.experimenter._case.MeterBandExperimenterBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.mod.Bands;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.mod.BandsBuilder;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
47 * Converts a MD-SAL meter mod command into the OF library meter mod command.
53 * VersionConvertorData data = new VersionConvertorData(version);
54 * Optional<MeterModInputBuilder> ofMeter = convertorManager.convert(salMeter, data);
58 public class MeterConvertor extends Convertor<Meter, MeterModInputBuilder, VersionConvertorData> {
59 private static final Logger LOG = LoggerFactory.getLogger(MeterConvertor.class);
60 private static final List<Class<?>> TYPES = Arrays.asList(Meter.class, AddMeterInput.class,
61 RemoveMeterInput.class, UpdatedMeter.class);
64 * Create default empty meter mot input builder.
65 * Use this method, if result from convertor is empty.
67 * @param version Openflow version
68 * @return default empty meter mod input builder
70 public static MeterModInputBuilder defaultResult(short version) {
71 return new MeterModInputBuilder()
73 .setFlags(new MeterFlags(false, false, true, false));
76 private static void getBandsFromSAL(MeterBandHeaders meterBandHeaders, List<Bands> bands) {
77 for (MeterBandHeader meterBandHeader : meterBandHeaders.getMeterBandHeader()) {
78 // The band types :drop,DSCP_Remark or experimenter.
79 if (null != meterBandHeader.getMeterBandTypes() && null != meterBandHeader.getMeterBandTypes().getFlags()) {
80 if (meterBandHeader.getMeterBandTypes().getFlags().isOfpmbtDrop()) {
81 if (meterBandHeader.getBandType() != null) {
82 MeterBandDropBuilder meterBandDropBuilder = new MeterBandDropBuilder();
83 meterBandDropBuilder.setType(MeterBandType.OFPMBTDROP);
84 Drop drop = (Drop) meterBandHeader.getBandType();
85 meterBandDropBuilder.setBurstSize(drop.getDropBurstSize());
86 meterBandDropBuilder.setRate(drop.getDropRate());
87 MeterBandDropCaseBuilder dropCaseBuilder = new MeterBandDropCaseBuilder();
88 dropCaseBuilder.setMeterBandDrop(meterBandDropBuilder.build());
89 MeterBand meterBandItem = dropCaseBuilder.build();
90 BandsBuilder bandsB = new BandsBuilder();
91 bandsB.setMeterBand(meterBandItem);
93 bands.add(bandsB.build());
95 logBandTypeMissing(MeterBandType.OFPMBTDROP);
97 } else if (meterBandHeader.getMeterBandTypes().getFlags().isOfpmbtDscpRemark()) {
98 if (meterBandHeader.getBandType() != null) {
99 MeterBandDscpRemarkBuilder meterBandDscpRemarkBuilder = new MeterBandDscpRemarkBuilder();
100 meterBandDscpRemarkBuilder.setType(MeterBandType.OFPMBTDSCPREMARK);
101 DscpRemark dscpRemark = (DscpRemark) meterBandHeader.getBandType();
102 meterBandDscpRemarkBuilder.setBurstSize(dscpRemark.getDscpRemarkBurstSize());
103 meterBandDscpRemarkBuilder.setRate(dscpRemark.getDscpRemarkRate());
104 meterBandDscpRemarkBuilder.setPrecLevel(dscpRemark.getPrecLevel());
105 MeterBandDscpRemarkCaseBuilder dscpCaseBuilder = new MeterBandDscpRemarkCaseBuilder();
106 dscpCaseBuilder.setMeterBandDscpRemark(meterBandDscpRemarkBuilder.build());
107 MeterBand meterBandItem = dscpCaseBuilder.build();
108 BandsBuilder bandsB = new BandsBuilder();
109 bandsB.setMeterBand(meterBandItem);
111 bands.add(bandsB.build());
113 logBandTypeMissing(MeterBandType.OFPMBTDSCPREMARK);
115 } else if (meterBandHeader.getMeterBandTypes().getFlags().isOfpmbtExperimenter()) {
116 if (meterBandHeader.getBandType() != null) {
117 MeterBandExperimenterBuilder meterBandExperimenterBuilder = new MeterBandExperimenterBuilder();
118 meterBandExperimenterBuilder.setType(MeterBandType.OFPMBTEXPERIMENTER);
119 Experimenter experimenter = (Experimenter) meterBandHeader.getBandType();
120 meterBandExperimenterBuilder.setBurstSize(experimenter.getExperimenterBurstSize());
121 meterBandExperimenterBuilder.setRate(experimenter.getExperimenterRate());
122 ExperimenterIdMeterBandBuilder expBuilder = new ExperimenterIdMeterBandBuilder();
123 expBuilder.setExperimenter(new ExperimenterId(experimenter.getExperimenter()));
124 meterBandExperimenterBuilder.addAugmentation(ExperimenterIdMeterBand.class, expBuilder.build());
125 // TODO - implement / finish experimenter meter band translation
126 MeterBandExperimenterCaseBuilder experimenterCaseBuilder =
127 new MeterBandExperimenterCaseBuilder();
128 experimenterCaseBuilder.setMeterBandExperimenter(meterBandExperimenterBuilder.build());
129 MeterBand meterBandItem = experimenterCaseBuilder.build();
130 BandsBuilder bandsB = new BandsBuilder();
131 bandsB.setMeterBand(meterBandItem);
133 bands.add(bandsB.build());
135 logBandTypeMissing(MeterBandType.OFPMBTEXPERIMENTER);
139 LOG.error("Invalid meter band data found.");
145 private static void logBandTypeMissing(final MeterBandType meterBandType) {
146 LOG.error("BandType: {} No Band Data found", meterBandType);
150 public Collection<Class<?>> getTypes() {
155 public MeterModInputBuilder convert(Meter source, VersionConvertorData data) {
156 MeterModInputBuilder meterModInputBuilder = new MeterModInputBuilder();
157 List<Bands> bands = new ArrayList<>();
159 if (source instanceof AddMeterInput) {
160 meterModInputBuilder.setCommand(MeterModCommand.OFPMCADD);
161 } else if (source instanceof RemoveMeterInput) {
162 meterModInputBuilder.setCommand(MeterModCommand.OFPMCDELETE);
163 } else if (source instanceof UpdatedMeter) {
164 meterModInputBuilder.setCommand(MeterModCommand.OFPMCMODIFY);
167 meterModInputBuilder.setMeterId(new MeterId(source.getMeterId().getValue()));
169 if (null != source.getFlags()) {
170 meterModInputBuilder.setFlags(new MeterFlags(source.getFlags().isMeterBurst(), source.getFlags()
171 .isMeterKbps(), source.getFlags().isMeterPktps(), source.getFlags().isMeterStats()));
175 * As per 0F1.3.1,The rate field indicates the rate value above
176 * which the corresponding band may apply to packets (see 5.7.1).
177 * The rate value is in kilobit per seconds, unless the flags eld
178 * includes OFPMF_PKTPS, in which case the rate is in packets per
182 meterModInputBuilder.setFlags(new MeterFlags(false, false, true, false));
185 if (source.getMeterBandHeaders() != null) {
186 getBandsFromSAL(source.getMeterBandHeaders(), bands);
187 meterModInputBuilder.setBands(bands);
189 LOG.error("For this meter Id {}, no associated band data found!", source.getMeterId().getValue());
192 meterModInputBuilder.setVersion(data.getVersion());
193 return meterModInputBuilder;