openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/util/MdSalRegistrationUtils.java

   1 /*
   2  * Copyright (c) 2015 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.openflowplugin.impl.util;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.reflect.TypeToken;
  12 import java.util.concurrent.atomic.AtomicLong;
  13 import javax.annotation.CheckForNull;
  14 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  15 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  16 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
  17 import org.opendaylight.openflowplugin.api.openflow.statistics.compatibility.Delegator;
  18 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
  19 import org.opendaylight.openflowplugin.impl.services.sal.FlowCapableTransactionServiceImpl;
  20 import org.opendaylight.openflowplugin.impl.services.sal.NodeConfigServiceImpl;
  21 import org.opendaylight.openflowplugin.impl.services.sal.PacketProcessingServiceImpl;
  22 import org.opendaylight.openflowplugin.impl.services.sal.SalEchoServiceImpl;
  23 import org.opendaylight.openflowplugin.impl.services.sal.SalExperimenterMessageServiceImpl;
  24 import org.opendaylight.openflowplugin.impl.services.sal.SalExperimenterMpMessageServiceImpl;
  25 import org.opendaylight.openflowplugin.impl.services.sal.SalFlatBatchServiceImpl;
  26 import org.opendaylight.openflowplugin.impl.services.sal.SalFlowServiceImpl;
  27 import org.opendaylight.openflowplugin.impl.services.sal.SalFlowsBatchServiceImpl;
  28 import org.opendaylight.openflowplugin.impl.services.sal.SalGroupServiceImpl;
  29 import org.opendaylight.openflowplugin.impl.services.sal.SalGroupsBatchServiceImpl;
  30 import org.opendaylight.openflowplugin.impl.services.sal.SalMeterServiceImpl;
  31 import org.opendaylight.openflowplugin.impl.services.sal.SalMetersBatchServiceImpl;
  32 import org.opendaylight.openflowplugin.impl.services.sal.SalPortServiceImpl;
  33 import org.opendaylight.openflowplugin.impl.services.sal.SalTableServiceImpl;
  34 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
  35 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProviderFactory;
  36 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightFlowStatisticsServiceImpl;
  37 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightFlowTableStatisticsServiceImpl;
  38 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightGroupStatisticsServiceImpl;
  39 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightMeterStatisticsServiceImpl;
  40 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightPortStatisticsServiceImpl;
  41 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightQueueStatisticsServiceImpl;
  42 import org.opendaylight.openflowplugin.impl.statistics.services.compatibility.OpendaylightFlowStatisticsServiceDelegateImpl;
  43 import org.opendaylight.openflowplugin.impl.statistics.services.direct.OpendaylightDirectStatisticsServiceImpl;
  44 import org.opendaylight.openflowplugin.impl.statistics.services.direct.multilayer.MultiLayerDirectStatisticsProviderInitializer;
  45 import org.opendaylight.openflowplugin.impl.statistics.services.direct.singlelayer.SingleLayerDirectStatisticsProviderInitializer;
  46 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.direct.statistics.rev160511.OpendaylightDirectStatisticsService;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.echo.service.rev150305.SalEchoService;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.SalExperimenterMessageService;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.mp.message.service.rev151020.SalExperimenterMpMessageService;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.SalFlatBatchService;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.OpendaylightFlowStatisticsService;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.OpendaylightFlowTableStatisticsService;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.FlowCapableTransactionService;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.SalGroupService;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.OpendaylightGroupStatisticsService;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.SalMeterService;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.OpendaylightMeterStatisticsService;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.module.config.rev141015.NodeConfigService;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingService;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.service.rev131107.SalPortService;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.OpendaylightPortStatisticsService;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.OpendaylightQueueStatisticsService;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.SalTableService;
  67
  68 public class MdSalRegistrationUtils {
  69
  70     //TODO: Make one register and one unregister method for all services
  71
  72     private static final TypeToken<Delegator<OpendaylightFlowStatisticsService>> COMPOSITE_SERVICE_TYPE_TOKEN =
  73             new TypeToken<Delegator<OpendaylightFlowStatisticsService>>() {
  74                 //NOBODY
  75             };
  76
  77     private MdSalRegistrationUtils() {
  78         throw new IllegalStateException();
  79     }
  80
  81     /**
  82      * Method registers all OF services for role {@link OfpRole#BECOMEMASTER}
  83      *  @param rpcContext    - registration processing is implemented in {@link org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext}
  84      * @param deviceContext - every service needs {@link org.opendaylight.openflowplugin.api.openflow.device.DeviceContext} as input parameter
  85      * @param convertorExecutor convertor executor
  86      */
  87     public static void registerServices(@CheckForNull final RpcContext rpcContext,
  88                                         @CheckForNull final DeviceContext deviceContext,
  89                                         final ExtensionConverterProvider extensionConverterProvider,
  90                                         final ConvertorExecutor convertorExecutor) {
  91         Preconditions.checkArgument(rpcContext != null);
  92         Preconditions.checkArgument(deviceContext != null);
  93
  94         // TODO: Use multipart writer provider from device context
  95         final MultipartWriterProvider multipartWriterProvider = MultipartWriterProviderFactory
  96             .createDefaultProvider(deviceContext);
  97
  98         // create service instances
  99         final SalFlowServiceImpl salFlowService = new SalFlowServiceImpl(rpcContext, deviceContext, convertorExecutor);
 100         final FlowCapableTransactionServiceImpl flowCapableTransactionService = new FlowCapableTransactionServiceImpl(rpcContext, deviceContext);
 101         final SalGroupServiceImpl salGroupService = new SalGroupServiceImpl(rpcContext, deviceContext, convertorExecutor);
 102         final SalMeterServiceImpl salMeterService = new SalMeterServiceImpl(rpcContext, deviceContext, convertorExecutor);
 103
 104         // register routed service instances
 105         rpcContext.registerRpcServiceImplementation(SalEchoService.class, new SalEchoServiceImpl(rpcContext, deviceContext));
 106         rpcContext.registerRpcServiceImplementation(SalFlowService.class, salFlowService);
 107         rpcContext.registerRpcServiceImplementation(FlowCapableTransactionService.class, flowCapableTransactionService);
 108         rpcContext.registerRpcServiceImplementation(SalMeterService.class, salMeterService);
 109         rpcContext.registerRpcServiceImplementation(SalGroupService.class, salGroupService);
 110         rpcContext.registerRpcServiceImplementation(SalTableService.class, new SalTableServiceImpl(rpcContext, deviceContext, convertorExecutor, multipartWriterProvider));
 111         rpcContext.registerRpcServiceImplementation(SalPortService.class, new SalPortServiceImpl(rpcContext, deviceContext, convertorExecutor));
 112         rpcContext.registerRpcServiceImplementation(PacketProcessingService.class, new PacketProcessingServiceImpl(rpcContext, deviceContext, convertorExecutor));
 113         rpcContext.registerRpcServiceImplementation(NodeConfigService.class, new NodeConfigServiceImpl(rpcContext, deviceContext));
 114         rpcContext.registerRpcServiceImplementation(OpendaylightFlowStatisticsService.class, OpendaylightFlowStatisticsServiceImpl.createWithOook(rpcContext, deviceContext, convertorExecutor));
 115
 116         // register direct statistics gathering services
 117         rpcContext.registerRpcServiceImplementation(OpendaylightDirectStatisticsService.class,
 118             new OpendaylightDirectStatisticsServiceImpl(deviceContext.canUseSingleLayerSerialization()
 119                 ? SingleLayerDirectStatisticsProviderInitializer
 120                     .createProvider(rpcContext, deviceContext, convertorExecutor, multipartWriterProvider)
 121                 : MultiLayerDirectStatisticsProviderInitializer
 122                     .createProvider(rpcContext, deviceContext, convertorExecutor, multipartWriterProvider)));
 123
 124         // register flat batch services
 125         rpcContext.registerRpcServiceImplementation(SalFlatBatchService.class, new SalFlatBatchServiceImpl(
 126                 new SalFlowsBatchServiceImpl(salFlowService, flowCapableTransactionService),
 127                 new SalGroupsBatchServiceImpl(salGroupService, flowCapableTransactionService),
 128                 new SalMetersBatchServiceImpl(salMeterService, flowCapableTransactionService)
 129         ));
 130
 131         // register experimenter services
 132         rpcContext.registerRpcServiceImplementation(SalExperimenterMessageService.class,
 133                 new SalExperimenterMessageServiceImpl(rpcContext, deviceContext, extensionConverterProvider));
 134         rpcContext.registerRpcServiceImplementation(SalExperimenterMpMessageService.class,
 135                 new SalExperimenterMpMessageServiceImpl(rpcContext, deviceContext, extensionConverterProvider));
 136     }
 137
 138     /**
 139      * Support deprecated statistic related services for backward compatibility. The only exception from deprecation is
 140      * the aggregated flow statistic with match criteria input.
 141      * @param rpcContext
 142      * @param deviceContext
 143      * @param notificationPublishService
 144      * @param convertorExecutor
 145      */
 146     public static void registerStatCompatibilityServices(final RpcContext rpcContext, final DeviceContext deviceContext,
 147                                                          final NotificationPublishService notificationPublishService,
 148                                                          final ConvertorExecutor convertorExecutor) {
 149
 150         AtomicLong compatibilityXidSeed = new AtomicLong();
 151         // pickup low statistics service
 152         final OpendaylightFlowStatisticsService flowStatisticsService = Preconditions.checkNotNull(
 153                 rpcContext.lookupRpcService(OpendaylightFlowStatisticsService.class));
 154         Preconditions.checkArgument(COMPOSITE_SERVICE_TYPE_TOKEN.isAssignableFrom(flowStatisticsService.getClass()));
 155         // attach delegate to flow statistics service (to cover all but aggregated stats with match filter input)
 156         final OpendaylightFlowStatisticsServiceDelegateImpl flowStatisticsDelegate =
 157                 new OpendaylightFlowStatisticsServiceDelegateImpl(rpcContext, deviceContext, notificationPublishService, new AtomicLong(), convertorExecutor);
 158         ((Delegator<OpendaylightFlowStatisticsService>) flowStatisticsService).setDelegate(flowStatisticsDelegate);
 159
 160         // register all statistics (deprecated) services
 161         rpcContext.registerRpcServiceImplementation(OpendaylightFlowTableStatisticsService.class,
 162                 new OpendaylightFlowTableStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService));
 163         rpcContext.registerRpcServiceImplementation(OpendaylightGroupStatisticsService.class,
 164                 new OpendaylightGroupStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService, convertorExecutor));
 165         rpcContext.registerRpcServiceImplementation(OpendaylightMeterStatisticsService.class,
 166                 new OpendaylightMeterStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService, convertorExecutor));
 167         rpcContext.registerRpcServiceImplementation(OpendaylightQueueStatisticsService.class,
 168                 new OpendaylightQueueStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService));
 169         rpcContext.registerRpcServiceImplementation(OpendaylightPortStatisticsService.class,
 170                 new OpendaylightPortStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService));
 171     }
 172 }