mappingservice/southbound/src/main/java/org/opendaylight/lispflowmapping/southbound/LispSouthboundRPC.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc.  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.lispflowmapping.southbound;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.util.concurrent.Futures;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import java.nio.ByteBuffer;
  14 import java.util.ArrayList;
  15 import java.util.List;
  16 import javax.annotation.PreDestroy;
  17 import javax.inject.Inject;
  18 import javax.inject.Singleton;
  19 import org.opendaylight.lispflowmapping.lisp.serializer.MapNotifySerializer;
  20 import org.opendaylight.lispflowmapping.lisp.serializer.MapRegisterSerializer;
  21 import org.opendaylight.lispflowmapping.lisp.serializer.MapReplySerializer;
  22 import org.opendaylight.lispflowmapping.lisp.serializer.MapRequestSerializer;
  23 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MessageType;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.GetStats;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.GetStatsInput;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.GetStatsOutput;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.GetStatsOutputBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.ResetStats;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.ResetStatsInput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.ResetStatsOutput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.ResetStatsOutputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotify;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyInput;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyOutput;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyOutputBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRegister;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRegisterInput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRegisterOutput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRegisterOutputBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReply;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReplyInput;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReplyOutput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReplyOutputBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequest;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequestInput;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequestOutput;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequestOutputBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.ctrl.msg.stats.ControlMessage;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.ctrl.msg.stats.ControlMessageBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.get.stats.output.ControlMessageStatsBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.get.stats.output.MapRegisterCacheStatsBuilder;
  53 import org.opendaylight.yangtools.concepts.Registration;
  54 import org.opendaylight.yangtools.yang.common.ErrorTag;
  55 import org.opendaylight.yangtools.yang.common.ErrorType;
  56 import org.opendaylight.yangtools.yang.common.RpcResult;
  57 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  58 import org.osgi.service.component.annotations.Activate;
  59 import org.osgi.service.component.annotations.Component;
  60 import org.osgi.service.component.annotations.Deactivate;
  61 import org.osgi.service.component.annotations.Reference;
  62 import org.slf4j.Logger;
  63 import org.slf4j.LoggerFactory;
  64
  65 /**
  66  * This class holds all RPCs methods for LispSouthbound Plugin.
  67  *
  68  * <p>
  69  * @author Florin Coras (fcoras@cisco.com)
  70  * @author Lorand Jakab (lojakab@cisco.com)
  71  */
  72 @Singleton
  73 @Component(service = { })
  74 public class LispSouthboundRPC {
  75     protected static final Logger LOG = LoggerFactory.getLogger(LispSouthboundRPC.class);
  76
  77     private final LispSouthboundPlugin lispSbPlugin;
  78     private final Registration rpcRegistration;
  79
  80     @Inject
  81     @Activate
  82     public LispSouthboundRPC(final @Reference LispSouthboundPlugin lispSbPlugin,
  83             final @Reference RpcProviderService rpcProviderService) {
  84         this.lispSbPlugin = lispSbPlugin;
  85         rpcRegistration = rpcProviderService.registerRpcImplementations(
  86             (SendMapRequest) this::sendMapRequest,
  87             (SendMapReply) this::sendMapReply,
  88             (SendMapRegister) this::sendMapRegister,
  89             (SendMapNotify) this::sendMapNotify,
  90             (GetStats) this::getStats,
  91             (ResetStats) this::resetStats);
  92     }
  93
  94     @Deactivate
  95     @PreDestroy
  96     public void deactivate() {
  97         rpcRegistration.close();
  98     }
  99
 100     public ListenableFuture<RpcResult<SendMapNotifyOutput>> sendMapNotify(final SendMapNotifyInput mapNotifyInput) {
 101         LOG.trace("sendMapNotify called!!");
 102         if (mapNotifyInput != null) {
 103             ByteBuffer outBuffer = MapNotifySerializer.getInstance().serialize(mapNotifyInput.getMapNotify());
 104             lispSbPlugin.handleSerializedLispBuffer(mapNotifyInput.getTransportAddress(), outBuffer,
 105                     MessageType.MapNotify);
 106         } else {
 107             LOG.warn("MapNotify was null");
 108             return Futures.immediateFuture(RpcResultBuilder.<SendMapNotifyOutput>failed().build());
 109         }
 110         return Futures.immediateFuture(RpcResultBuilder.<SendMapNotifyOutput>success(
 111                 new SendMapNotifyOutputBuilder().build()).build());
 112     }
 113
 114     public ListenableFuture<RpcResult<SendMapReplyOutput>> sendMapReply(final SendMapReplyInput mapReplyInput) {
 115         LOG.trace("sendMapReply called!!");
 116         if (mapReplyInput != null) {
 117             ByteBuffer outBuffer = MapReplySerializer.getInstance().serialize(mapReplyInput.getMapReply());
 118             lispSbPlugin.handleSerializedLispBuffer(mapReplyInput.getTransportAddress(), outBuffer,
 119                     MessageType.MapReply);
 120         } else {
 121             LOG.warn("MapReply was null");
 122             return Futures.immediateFuture(RpcResultBuilder.<SendMapReplyOutput>failed().build());
 123         }
 124         return Futures.immediateFuture(RpcResultBuilder.<SendMapReplyOutput>success(
 125                 new SendMapReplyOutputBuilder().build()).build());
 126     }
 127
 128     public ListenableFuture<RpcResult<SendMapRequestOutput>> sendMapRequest(final SendMapRequestInput mapRequestInput) {
 129         LOG.trace("sendMapRequest called!!");
 130         if (mapRequestInput != null) {
 131             ByteBuffer outBuffer = MapRequestSerializer.getInstance().serialize(mapRequestInput.getMapRequest());
 132             lispSbPlugin.handleSerializedLispBuffer(mapRequestInput.getTransportAddress(), outBuffer,
 133                     MessageType.MapRequest);
 134         } else {
 135             LOG.debug("MapRequest was null");
 136             return Futures.immediateFuture(RpcResultBuilder.<SendMapRequestOutput>failed().build());
 137         }
 138         return Futures.immediateFuture(RpcResultBuilder.<SendMapRequestOutput>success(
 139                 new SendMapRequestOutputBuilder().build()).build());
 140     }
 141
 142     @VisibleForTesting
 143     ListenableFuture<RpcResult<SendMapRegisterOutput>> sendMapRegister(
 144             final SendMapRegisterInput mapRegisterInput) {
 145         LOG.trace("sendMapRegister called!!");
 146         if (mapRegisterInput != null) {
 147             ByteBuffer outBuffer = MapRegisterSerializer.getInstance().serialize(mapRegisterInput.getMapRegister());
 148             lispSbPlugin.handleSerializedLispBuffer(mapRegisterInput.getTransportAddress(), outBuffer,
 149                     MessageType.MapRegister);
 150         } else {
 151             LOG.debug("MapRegister was null");
 152             return Futures.immediateFuture(RpcResultBuilder.<SendMapRegisterOutput>failed().build());
 153         }
 154         return Futures.immediateFuture(RpcResultBuilder.<SendMapRegisterOutput>success(
 155                 new SendMapRegisterOutputBuilder().build()).build());
 156     }
 157
 158     ListenableFuture<RpcResult<GetStatsOutput>> getStats(final GetStatsInput input) {
 159         LOG.trace("getStats called!!");
 160
 161         RpcResultBuilder<GetStatsOutput> rpcResultBuilder;
 162
 163         ConcurrentLispSouthboundStats stats = lispSbPlugin.getStats();
 164
 165         if (stats == null) {
 166             rpcResultBuilder = RpcResultBuilder.<GetStatsOutput>failed()
 167                     .withError(ErrorType.APPLICATION, ErrorTag.DATA_MISSING, "No stats found");
 168         } else {
 169             rpcResultBuilder = RpcResultBuilder.success(createGetStatsOutput(stats));
 170         }
 171         return Futures.immediateFuture(rpcResultBuilder.build());
 172     }
 173
 174     ListenableFuture<RpcResult<ResetStatsOutput>> resetStats(final ResetStatsInput input) {
 175         LOG.trace("resetStats called!!");
 176
 177         ConcurrentLispSouthboundStats stats = lispSbPlugin.getStats();
 178
 179         if (stats == null) {
 180             return Futures.immediateFuture(RpcResultBuilder.<ResetStatsOutput>failed()
 181                     .withError(ErrorType.APPLICATION, ErrorTag.DATA_MISSING, "No stats found")
 182                     .build());
 183         } else {
 184             stats.resetStats();
 185             return Futures.immediateFuture(RpcResultBuilder.<ResetStatsOutput>success(
 186                     new ResetStatsOutputBuilder().build()).build());
 187         }
 188     }
 189
 190     private static GetStatsOutput createGetStatsOutput(final ConcurrentLispSouthboundStats stats) {
 191         long[] rxStats = stats.getRx();
 192         long[] txStats = stats.getTx();
 193
 194         ControlMessageStatsBuilder cmsb = new ControlMessageStatsBuilder();
 195         cmsb.setRxUnknown(stats.getRxUnknown());
 196         cmsb.setTxErrors(stats.getTxErrors());
 197
 198         List<ControlMessage> messages = new ArrayList<>();
 199         for (int i = 0; i <= ConcurrentLispSouthboundStats.MAX_LISP_TYPES; i++) {
 200             final var type = MessageType.forValue(i);
 201             if (type != null) {
 202                 messages.add(new ControlMessageBuilder()
 203                     .setMsgType(type)
 204                     .setRxCount(rxStats[i])
 205                     .setTxCount(txStats[i])
 206                     .build());
 207             }
 208         }
 209
 210         cmsb.setControlMessage(messages);
 211
 212         MapRegisterCacheStatsBuilder mrcsb = new MapRegisterCacheStatsBuilder();
 213         mrcsb.setHits(stats.getCacheHits());
 214         mrcsb.setMisses(stats.getCacheMisses());
 215
 216         return new GetStatsOutputBuilder().setControlMessageStats(cmsb.build())
 217                 .setMapRegisterCacheStats(mrcsb.build()).build();
 218     }
 219 }