openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/statistics/services/GroupFeaturesService.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.statistics.services;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.base.Preconditions;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import java.util.concurrent.atomic.AtomicLong;
  15 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  16 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  17 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  18 import org.opendaylight.openflowplugin.impl.services.util.RequestInputUtils;
  19 import org.opendaylight.openflowplugin.impl.statistics.services.compatibility.AbstractCompatibleStatService;
  20 import org.opendaylight.openflowplugin.impl.util.GroupUtil;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupFeaturesInput;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupFeaturesOutput;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupFeaturesOutputBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupFeaturesUpdated;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GroupFeaturesUpdatedBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.Chaining;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.ChainingChecks;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupAll;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupCapability;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupFf;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupIndirect;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupSelect;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupType;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.SelectLiveness;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.SelectWeight;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupCapabilities;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupTypes;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupFeaturesCase;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.features._case.MultipartReplyGroupFeatures;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCase;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCaseBuilder;
  47
  48 final class GroupFeaturesService
  49         extends AbstractCompatibleStatService<GetGroupFeaturesInput, GetGroupFeaturesOutput, GroupFeaturesUpdated> {
  50
  51     private static final MultipartRequestGroupFeaturesCase GROUP_FEAT_CASE =
  52             new MultipartRequestGroupFeaturesCaseBuilder().build();
  53
  54     GroupFeaturesService(final RequestContextStack requestContextStack,
  55                                 final DeviceContext deviceContext,
  56                                 final AtomicLong compatibilityXidSeed) {
  57         super(requestContextStack, deviceContext, compatibilityXidSeed);
  58     }
  59
  60     @Override
  61     protected OfHeader buildRequest(final Xid xid, final GetGroupFeaturesInput input) {
  62         final MultipartRequestInputBuilder mprInput = RequestInputUtils.createMultipartHeader(
  63                 MultipartType.OFPMPGROUPFEATURES, xid.getValue(), getVersion());
  64         mprInput.setMultipartRequestBody(GROUP_FEAT_CASE);
  65         return mprInput.build();
  66     }
  67
  68     @Override
  69     public GetGroupFeaturesOutput buildTxCapableResult(final TransactionId emulatedTxId) {
  70         return new GetGroupFeaturesOutputBuilder().setTransactionId(emulatedTxId).build();
  71     }
  72
  73     @Override
  74     public GroupFeaturesUpdated transformToNotification(final List<MultipartReply> result,
  75             final TransactionId emulatedTxId) {
  76         final int mpSize = result.size();
  77         Preconditions.checkArgument(mpSize == 1, "unexpected (!=1) mp-reply size received: {}", mpSize);
  78
  79         GroupFeaturesUpdatedBuilder notification = new GroupFeaturesUpdatedBuilder();
  80         notification.setId(getDeviceInfo().getNodeId());
  81         notification.setMoreReplies(Boolean.FALSE);
  82         notification.setTransactionId(emulatedTxId);
  83
  84         MultipartReplyGroupFeaturesCase caseBody =
  85                 (MultipartReplyGroupFeaturesCase) result.get(0).getMultipartReplyBody();
  86         MultipartReplyGroupFeatures replyBody = caseBody.getMultipartReplyGroupFeatures();
  87
  88         notification.setGroupTypesSupported(extractSupportedGroupTypes(replyBody.getTypes()));
  89         notification.setMaxGroups(replyBody.getMaxGroups());
  90         notification.setGroupCapabilitiesSupported(extractSupportedCapabilities(replyBody.getCapabilities()));
  91         notification.setActions(GroupUtil.extractGroupActionsSupportBitmap(replyBody.getActionsBitmap()));
  92
  93         return notification.build();
  94     }
  95
  96     @VisibleForTesting
  97     static List<Class<? extends GroupCapability>> extractSupportedCapabilities(final GroupCapabilities capabilities) {
  98         List<Class<? extends GroupCapability>> supportedCapabilities = new ArrayList<>();
  99         if (capabilities.getOFPGFCCHAINING()) {
 100             supportedCapabilities.add(Chaining.class);
 101         }
 102         if (capabilities.getOFPGFCCHAININGCHECKS()) {
 103             supportedCapabilities.add(ChainingChecks.class);
 104         }
 105         if (capabilities.getOFPGFCSELECTLIVENESS()) {
 106             supportedCapabilities.add(SelectLiveness.class);
 107         }
 108         if (capabilities.getOFPGFCSELECTWEIGHT()) {
 109             supportedCapabilities.add(SelectWeight.class);
 110         }
 111         return supportedCapabilities;
 112     }
 113
 114     @VisibleForTesting
 115     static List<Class<? extends GroupType>> extractSupportedGroupTypes(final GroupTypes types) {
 116         List<Class<? extends GroupType>> supportedGroups = new ArrayList<>();
 117         if (types.getOFPGTALL()) {
 118             supportedGroups.add(GroupAll.class);
 119         }
 120         if (types.getOFPGTSELECT()) {
 121             supportedGroups.add(GroupSelect.class);
 122         }
 123         if (types.getOFPGTINDIRECT()) {
 124             supportedGroups.add(GroupIndirect.class);
 125         }
 126         if (types.getOFPGTFF()) {
 127             supportedGroups.add(GroupFf.class);
 128         }
 129         return supportedGroups;
 130     }
 131 }