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