fixes for Meter Service

Change-Id: I83d5b8a2e0a955c050f7afe96761d5709d4f9f18

cli/src/main/java/org/onosproject/cli/net/AddMeter.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.cli.net;
+
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.core.CoreService;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.meter.Band;
+import org.onosproject.net.meter.DefaultBand;
+import org.onosproject.net.meter.DefaultMeter;
+import org.onosproject.net.meter.Meter;
+import org.onosproject.net.meter.MeterId;
+import org.onosproject.net.meter.MeterOperation;
+import org.onosproject.net.meter.MeterService;
+
+import java.util.Collections;
+
+/**
+ * Add a meter.
+ */
+@Command(scope = "onos", name = "add-meter",
+        description = "Adds a meter to a device (currently for testing)")
+public class AddMeter extends AbstractShellCommand {
+
+    @Argument(index = 0, name = "uri", description = "Device ID",
+            required = true, multiValued = false)
+    String uri = null;
+
+    private final String appId = "org.onosproject.cli.addMeter";
+
+    @Override
+    protected void execute() {
+        MeterService service = get(MeterService.class);
+        CoreService coreService = get(CoreService.class);
+
+        DeviceId deviceId = DeviceId.deviceId(uri);
+
+        MeterId meterId = service.allocateMeterId();
+
+        Band band = DefaultBand.builder()
+                        .ofType(Band.Type.DROP)
+                        .withRate(500)
+                        .build();
+
+
+        Meter meter = DefaultMeter.builder()
+                .forDevice(deviceId)
+                .fromApp(coreService.registerApplication(appId))
+                .withId(meterId)
+                .withUnit(Meter.Unit.KB_PER_SEC)
+                .withBands(Collections.singleton(band))
+                .build();
+
+        MeterOperation op = new MeterOperation(meter, MeterOperation.Type.ADD, null);
+
+        service.addMeter(op);
+
+    }
+}

cli/src/main/java/org/onosproject/cli/net/Meters.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.cli.net;
+
+import com.google.common.collect.Collections2;
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.meter.Meter;
+import org.onosproject.net.meter.MeterService;
+
+import java.util.Collection;
+
+/**
+ * Add a meter.
+ */
+@Command(scope = "onos", name = "meters",
+        description = "Shows meters")
+public class Meters extends AbstractShellCommand {
+
+    @Argument(index = 0, name = "uri", description = "Device ID",
+            required = false, multiValued = false)
+    String uri = null;
+
+
+    @Override
+    protected void execute() {
+        MeterService service = get(MeterService.class);
+
+        Collection<Meter> meters = service.getAllMeters();
+        if (uri != null) {
+            DeviceId deviceId = DeviceId.deviceId(uri);
+            Collection<Meter> devMeters = Collections2.filter(meters,
+                                                              m -> m.deviceId().equals(deviceId));
+            printMeters(devMeters);
+        } else {
+            printMeters(meters);
+        }
+    }
+
+    private void printMeters(Collection<Meter> meters) {
+        meters.forEach(m -> print(" %s", m));
+    }
+}

cli/src/main/resources/OSGI-INF/blueprint/shell-config.xml

@@ -112,6 +112,18 @@
                 <ref component-id="deviceIdCompleter"/>
             </completers>
         </command>
+        <command>
+            <action class="org.onosproject.cli.net.AddMeter"/>
+            <completers>
+                <ref component-id="deviceIdCompleter"/>
+            </completers>
+        </command>
+        <command>
+            <action class="org.onosproject.cli.net.Meters"/>
+            <completers>
+                <ref component-id="deviceIdCompleter"/>
+            </completers>
+        </command>
         <command>
             <action class="org.onosproject.cli.net.DeviceRoleCommand"/>
             <completers>

core/api/src/main/java/org/onosproject/net/meter/DefaultBand.java

@@ -15,6 +15,7 @@
  */
 package org.onosproject.net.meter;
 
+import static com.google.common.base.MoreObjects.toStringHelper;
 import static com.google.common.base.Preconditions.checkArgument;
 
 /**
@@ -24,13 +25,14 @@ public final class DefaultBand implements Band, BandEntry {
 
     private final Type type;
     private final long rate;
-    private final long burstSize;
+    //TODO: should be made optional
-    private final short prec;
+    private final Long burstSize;
+    private final Short prec;
     private long packets;
     private long bytes;
 
     public DefaultBand(Type type, long rate,
-                       long burstSize, short prec) {
+                       Long burstSize, Short prec) {
         this.type = type;
         this.rate = rate;
         this.burstSize = burstSize;
@@ -77,6 +79,15 @@ public final class DefaultBand implements Band, BandEntry {
         this.bytes = bytes;
     }
 
+    @Override
+    public String toString() {
+        return toStringHelper(this)
+                .add("rate", rate)
+                .add("burst-size", burstSize)
+                .add("type", type)
+                .add("drop-precedence", prec).toString();
+    }
+
     public static Builder builder() {
         return new Builder();
     }
@@ -84,7 +95,7 @@ public final class DefaultBand implements Band, BandEntry {
     public static final class Builder implements Band.Builder {
 
         private long rate;
-        private long burstSize;
+        private Long burstSize;
         private Short prec;
         private Type type;
 
@@ -114,7 +125,7 @@ public final class DefaultBand implements Band, BandEntry {
 
         @Override
         public DefaultBand build() {
-            checkArgument(prec != null && type == Type.REMARK,
+            checkArgument(type != Type.REMARK && prec == null,
                           "Only REMARK bands can have a precendence.");
 
             return new DefaultBand(type, rate, burstSize, prec);

core/api/src/main/java/org/onosproject/net/meter/DefaultMeter.java

@@ -15,12 +15,13 @@
  */
 package org.onosproject.net.meter;
 
+import com.google.common.collect.ImmutableSet;
 import org.onosproject.core.ApplicationId;
 import org.onosproject.net.DeviceId;
 
 import java.util.Collection;
-import java.util.Collections;
 
+import static com.google.common.base.MoreObjects.toStringHelper;
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 
@@ -138,6 +139,18 @@ public final class DefaultMeter implements Meter, MeterEntry  {
         this.bytes = bytes;
     }
 
+    @Override
+    public String toString() {
+        return toStringHelper(this)
+                .add("device", deviceId)
+                .add("id", id)
+                .add("appId", appId.name())
+                .add("unit", unit)
+                .add("isBurst", burst)
+                .add("state", state)
+                .add("bands", bands).toString();
+    }
+
     public static final class Builder implements Meter.Builder {
 
         private MeterId id;
@@ -155,8 +168,8 @@ public final class DefaultMeter implements Meter, MeterEntry  {
         }
 
         @Override
-        public Meter.Builder withId(long id) {
+        public Meter.Builder withId(MeterId id) {
-            this.id = MeterId.meterId(id);
+            this.id = id;
             return this;
         }
 
@@ -180,7 +193,7 @@ public final class DefaultMeter implements Meter, MeterEntry  {
 
         @Override
         public Meter.Builder withBands(Collection<Band> bands) {
-            this.bands = Collections.unmodifiableCollection(bands);
+            this.bands = ImmutableSet.copyOf(bands);
             return this;
         }
 

core/api/src/main/java/org/onosproject/net/meter/Meter.java

@@ -130,10 +130,10 @@ public interface Meter {
         /**
          * Assigns the id to this meter.
          *
-         * @param id a long
+         * @param id a meter id
          * @return this
          */
-        Builder withId(long id);
+        Builder withId(MeterId id);
 
         /**
          * Assigns the application that built this meter.

core/api/src/main/java/org/onosproject/net/meter/MeterId.java

@@ -32,7 +32,7 @@ public final class MeterId {
     public static final MeterId ALL = new MeterId(0xFFFFFFFF);
 
     private MeterId(long id) {
-        checkArgument(id <= MAX, "id cannot be larger than 0xFFFF0000");
+        checkArgument(id >= MAX, "id cannot be larger than 0xFFFF0000");
         this.id = id;
     }
 
@@ -65,6 +65,11 @@ public final class MeterId {
         return Long.hashCode(id);
     }
 
+    @Override
+    public String toString() {
+        return Long.toHexString(this.id);
+    }
+
     public static MeterId meterId(long id) {
         return new MeterId(id);
 

core/api/src/main/java/org/onosproject/net/meter/MeterService.java

@@ -17,6 +17,8 @@ package org.onosproject.net.meter;
 
 import org.onosproject.event.ListenerService;
 
+import java.util.Collection;
+
 /**
  * Service for add/updating and removing meters. Meters are
  * are assigned to flow to rate limit them and provide a certain
@@ -54,6 +56,13 @@ public interface MeterService
      */
     Meter getMeter(MeterId id);
 
+    /**
+     * Fetches all the meters.
+     *
+     * @return a collection of meters
+     */
+    Collection<Meter> getAllMeters();
+
     /**
      * Allocate a meter id which must be used to create the meter.
      *

incubator/net/src/main/java/org/onosproject/incubator/net/meter/impl/MeterManager.java

@@ -52,7 +52,7 @@ import static org.slf4j.LoggerFactory.getLogger;
 /**
  * Provides implementation of the meter service APIs.
  */
-@Component(immediate = true)
+@Component(immediate = true, enabled = true)
 @Service
 public class MeterManager extends AbstractListenerProviderRegistry<MeterEvent, MeterListener,
         MeterProvider, MeterProviderService>
@@ -66,7 +66,7 @@ public class MeterManager extends AbstractListenerProviderRegistry<MeterEvent, M
     protected StorageService storageService;
 
     @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
-    MeterStore store;
+    protected MeterStore store;
 
     private AtomicCounter meterIdCounter;
 
@@ -78,6 +78,8 @@ public class MeterManager extends AbstractListenerProviderRegistry<MeterEvent, M
                 .withName(meterIdentifier)
                 .build();
 
+        store.setDelegate(delegate);
+
         onComplete = (op, result, error) ->
             {
                 op.context().ifPresent(c -> {
@@ -98,6 +100,7 @@ public class MeterManager extends AbstractListenerProviderRegistry<MeterEvent, M
 
     @Deactivate
     public void deactivate() {
+        store.unsetDelegate(delegate);
         log.info("Stopped");
     }
 
@@ -135,6 +138,11 @@ public class MeterManager extends AbstractListenerProviderRegistry<MeterEvent, M
         return store.getMeter(id);
     }
 
+    @Override
+    public Collection<Meter> getAllMeters() {
+        return store.getAllMeters();
+    }
+
     @Override
     public MeterId allocateMeterId() {
         // FIXME: This will break one day.

incubator/store/src/main/java/org/onosproject/incubator/store/meter/impl/DistributedMeterStore.java

@@ -18,11 +18,16 @@ package org.onosproject.incubator.store.meter.impl;
 import com.google.common.collect.Collections2;
 import com.google.common.collect.Maps;
 import org.apache.felix.scr.annotations.Activate;
+import org.apache.felix.scr.annotations.Component;
 import org.apache.felix.scr.annotations.Deactivate;
 import org.apache.felix.scr.annotations.Reference;
 import org.apache.felix.scr.annotations.ReferenceCardinality;
+import org.apache.felix.scr.annotations.Service;
 import org.onosproject.cluster.ClusterService;
 import org.onosproject.cluster.NodeId;
+import org.onosproject.mastership.MastershipService;
+import org.onosproject.net.meter.Band;
+import org.onosproject.net.meter.DefaultBand;
 import org.onosproject.net.meter.DefaultMeter;
 import org.onosproject.net.meter.Meter;
 import org.onosproject.net.meter.MeterEvent;
@@ -33,7 +38,6 @@ import org.onosproject.net.meter.MeterState;
 import org.onosproject.net.meter.MeterStore;
 import org.onosproject.net.meter.MeterStoreDelegate;
 import org.onosproject.net.meter.MeterStoreResult;
-import org.onosproject.mastership.MastershipService;
 import org.onosproject.store.AbstractStore;
 import org.onosproject.store.serializers.KryoNamespaces;
 import org.onosproject.store.service.ConsistentMap;
@@ -56,6 +60,8 @@ import static org.slf4j.LoggerFactory.getLogger;
  * A distributed meter store implementation. Meters are stored consistently
  * across the cluster.
  */
+@Component(immediate = true)
+@Service
 public class DistributedMeterStore extends AbstractStore<MeterEvent, MeterStoreDelegate>
                     implements MeterStore {
 
@@ -89,8 +95,14 @@ public class DistributedMeterStore extends AbstractStore<MeterEvent, MeterStoreD
         meters = storageService.<MeterId, MeterData>consistentMapBuilder()
                     .withName(METERSTORE)
                     .withSerializer(Serializer.using(Arrays.asList(KryoNamespaces.API),
-                                                     MeterData.class))
+                                                     MeterData.class,
-                    .build();
+                                                     DefaultMeter.class,
+                                                     DefaultBand.class,
+                                                     Band.Type.class,
+                                                     MeterState.class,
+                                                     Meter.Unit.class,
+                                                     MeterFailReason.class,
+                                                     MeterId.class)).build();
 
         meters.addListener(mapListener);
 
@@ -205,13 +217,13 @@ public class DistributedMeterStore extends AbstractStore<MeterEvent, MeterStoreD
                                 } else if (data.reason().isPresent() && local.equals(data.origin())) {
                                     MeterStoreResult msr = MeterStoreResult.fail(data.reason().get());
                                     //TODO: No future -> no friend
-                                    futures.get(data.meter().id()).complete(msr);
+                                    futures.remove(data.meter().id()).complete(msr);
                                 }
                                 break;
                             case ADDED:
                             case REMOVED:
                                 if (local.equals(data.origin())) {
-                                    futures.get(data.meter().id()).complete(MeterStoreResult.success());
+                                    futures.remove(data.meter().id()).complete(MeterStoreResult.success());
                                 }
                                 break;
                             default:

providers/openflow/meter/src/main/java/org/onosproject/provider/of/meter/impl/MeterModBuilder.java

@@ -116,7 +116,8 @@ public final class MeterModBuilder {
             default:
                 log.warn("Unknown unit type {}", unit);
         }
-        builder.setBands(buildBands());
+        //FIXME: THIS WILL CHANGE IN OF1.4 to setBands.
+        builder.setMeters(buildBands());
         builder.setFlags(flags)
                 .setMeterId(id)
                 .setXid(xid);

providers/openflow/meter/src/main/java/org/onosproject/provider/of/meter/impl/OpenFlowMeterProvider.java

@@ -33,6 +33,7 @@ import org.onosproject.net.meter.DefaultBand;
 import org.onosproject.net.meter.DefaultMeter;
 import org.onosproject.net.meter.Meter;
 import org.onosproject.net.meter.MeterFailReason;
+import org.onosproject.net.meter.MeterId;
 import org.onosproject.net.meter.MeterOperation;
 import org.onosproject.net.meter.MeterOperations;
 import org.onosproject.net.meter.MeterProvider;
@@ -74,7 +75,7 @@ import static org.slf4j.LoggerFactory.getLogger;
 /**
  * Provider which uses an OpenFlow controller to handle meters.
  */
-@Component(immediate = true, enabled = false)
+@Component(immediate = true, enabled = true)
 public class OpenFlowMeterProvider extends AbstractProvider implements MeterProvider {
 
 
@@ -245,7 +246,7 @@ public class OpenFlowMeterProvider extends AbstractProvider implements MeterProv
             DefaultMeter.Builder builder = DefaultMeter.builder();
             Collection<Band> bands = buildBands(stat.getBandStats());
             builder.forDevice(deviceId)
-                    .withId(stat.getMeterId())
+                    .withId(MeterId.meterId(stat.getMeterId()))
                     //FIXME: need to encode appId in meter id, but that makes
                     // things a little annoying for debugging
                     .fromApp(coreService.getAppId("org.onosproject.core"))