openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/GroupConvertor.java

   1 /*
   2  * Copyright (c) 2014 Ericsson India Global Services Pvt Ltd. 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
   9 package org.opendaylight.openflowplugin.openflow.md.core.sal.convertor;
  10
  11 import java.math.BigInteger;
  12 import java.util.ArrayList;
  13 import java.util.Collections;
  14 import java.util.Comparator;
  15 import java.util.List;
  16 import java.util.Optional;
  17 import org.opendaylight.openflowjava.protocol.api.util.BinContent;
  18 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.action.data.ActionConvertorData;
  19 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common.ParametrizedConvertor;
  20 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionDatapathIdConvertorData;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.AddGroupInput;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.RemoveGroupInput;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.UpdatedGroup;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.Group;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.Buckets;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.Action;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupModCommand;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.GroupType;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GroupModInputBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.buckets.grouping.BucketsList;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.buckets.grouping.BucketsListBuilder;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Decodes the SAL - Group Mod Message and encodes into a OF
  41  * Library for the OFPT_GROUP_MOD Message. Input:SAL Layer Group command data.
  42  *
  43  * Example usage:
  44  * <pre>
  45  * {@code
  46  * VersionDatapathIdConvertorData data = new VersionDatapathIdConvertorData(version);
  47  * data.setDatapathId(datapathId);
  48  * Optional<GroupModInputBuilder> ofGroup = ConvertorManager.getInstance().convert(salGroup, data);
  49  * }
  50  * </pre>
  51  */
  52 public class GroupConvertor implements ParametrizedConvertor<Group, GroupModInputBuilder, VersionDatapathIdConvertorData> {
  53     /**
  54      * Create default empty group mod input builder
  55      * Use this method, if result from convertor is empty.
  56      *
  57      * @param version Openflow version
  58      * @return default empty group mod input builder
  59      */
  60     public static GroupModInputBuilder defaultResult(short version) {
  61         return new GroupModInputBuilder()
  62                 .setVersion(version);
  63     }
  64
  65     private static final Logger LOG = LoggerFactory.getLogger(GroupConvertor.class);
  66     private static final Integer DEFAULT_WEIGHT = 0;
  67     private static final Long OFPP_ANY = Long.parseLong("ffffffff", 16);
  68     private static final Long DEFAULT_WATCH_PORT = OFPP_ANY;
  69     private static final Long OFPG_ANY = Long.parseLong("ffffffff", 16);
  70     private static final Long DEFAULT_WATCH_GROUP = OFPG_ANY;
  71     private static final Comparator<Bucket> COMPARATOR = (bucket1, bucket2) -> {
  72         if (bucket1.getBucketId() == null || bucket2.getBucketId() == null) return 0;
  73         return bucket1.getBucketId().getValue().compareTo(bucket2.getBucketId().getValue());
  74     };
  75
  76     private static List<BucketsList> salToOFBucketList(Buckets buckets, short version, int groupType, BigInteger datapathid) {
  77         final List<BucketsList> bucketLists = new ArrayList<>();
  78         final ActionConvertorData data = new ActionConvertorData(version);
  79         data.setDatapathId(datapathid);
  80
  81         for (org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket groupBucket : buckets
  82                 .getBucket()) {
  83             BucketsListBuilder bucketBuilder = new BucketsListBuilder();
  84
  85             salToOFBucketListWeight(groupBucket, bucketBuilder, groupType);
  86             salToOFBucketListWatchGroup(groupBucket, bucketBuilder, groupType);
  87             salToOFBucketListWatchPort(groupBucket, bucketBuilder, groupType);
  88
  89             Optional<List<Action>> bucketActionList = ConvertorManager.getInstance().convert(
  90                     groupBucket.getAction(), data);
  91
  92             bucketBuilder.setAction(bucketActionList.orElse(Collections.emptyList()));
  93             BucketsList bucket = bucketBuilder.build();
  94             bucketLists.add(bucket);
  95         }
  96
  97         return bucketLists;
  98
  99     }
 100
 101     private static void salToOFBucketListWatchPort(Bucket groupBucket, BucketsListBuilder bucketBuilder, int groupType) {
 102         if (null != groupBucket.getWatchPort()) {
 103             bucketBuilder.setWatchPort(new PortNumber(groupBucket.getWatchPort()));
 104         } else {
 105             bucketBuilder.setWatchPort(new PortNumber(BinContent.intToUnsignedLong(DEFAULT_WATCH_PORT.intValue())));
 106             if (groupType == GroupType.OFPGTFF.getIntValue()) {
 107                 LOG.error("WatchPort required for this OFPGT_FF");
 108             }
 109         }
 110     }
 111
 112     private static void salToOFBucketListWatchGroup(Bucket groupBucket, BucketsListBuilder bucketBuilder, int groupType) {
 113         if (null != groupBucket.getWatchGroup()) {
 114             bucketBuilder.setWatchGroup(groupBucket.getWatchGroup());
 115         } else {
 116             bucketBuilder.setWatchGroup(BinContent.intToUnsignedLong(DEFAULT_WATCH_GROUP.intValue()));
 117             if (groupType == GroupType.OFPGTFF.getIntValue()) {
 118                 LOG.error("WatchGroup required for this OFPGT_FF");
 119             }
 120         }
 121     }
 122
 123     private static void salToOFBucketListWeight(Bucket groupBucket, BucketsListBuilder bucketBuilder, int groupType) {
 124         if (null != groupBucket.getWeight()) {
 125             bucketBuilder.setWeight(groupBucket.getWeight());
 126         } else {
 127             bucketBuilder.setWeight(DEFAULT_WEIGHT);
 128             if (groupType == GroupType.OFPGTSELECT.getIntValue()) {
 129                 LOG.error("Weight value required for this OFPGT_SELECT");
 130             }
 131         }
 132     }
 133
 134     @Override
 135     public Class<?> getType() {
 136         return Group.class;
 137     }
 138
 139     @Override
 140     public GroupModInputBuilder convert(Group source, VersionDatapathIdConvertorData data) {
 141         GroupModInputBuilder groupModInputBuilder = new GroupModInputBuilder();
 142         if (source instanceof AddGroupInput) {
 143             groupModInputBuilder.setCommand(GroupModCommand.OFPGCADD);
 144         } else if (source instanceof RemoveGroupInput) {
 145             groupModInputBuilder.setCommand(GroupModCommand.OFPGCDELETE);
 146         } else if (source instanceof UpdatedGroup) {
 147             groupModInputBuilder.setCommand(GroupModCommand.OFPGCMODIFY);
 148         }
 149
 150         if (GroupTypes.GroupAll.equals(source.getGroupType())) {
 151             groupModInputBuilder.setType(GroupType.OFPGTALL);
 152         }
 153
 154         if (GroupTypes.GroupSelect.equals(source.getGroupType())) {
 155             groupModInputBuilder.setType(GroupType.OFPGTSELECT);
 156         }
 157
 158         if (GroupTypes.GroupIndirect.equals(source.getGroupType())) {
 159             groupModInputBuilder.setType(GroupType.OFPGTINDIRECT);
 160         }
 161
 162         if (GroupTypes.GroupFf.equals(source.getGroupType())) {
 163             groupModInputBuilder.setType(GroupType.OFPGTFF);
 164         }
 165
 166         groupModInputBuilder.setGroupId(new GroupId(source.getGroupId().getValue()));
 167
 168         // Only if the bucket is configured for the group then add it
 169         // During group deletion do not push the buckets
 170         if (groupModInputBuilder.getCommand() != GroupModCommand.OFPGCDELETE) {
 171             if ((source.getBuckets() != null) && (source.getBuckets().getBucket().size() != 0)) {
 172
 173                 Collections.sort(source.getBuckets().getBucket(), COMPARATOR);
 174
 175                 List<BucketsList> bucketLists = salToOFBucketList(source.getBuckets(), data.getVersion(), source.getGroupType().getIntValue(), data.getDatapathId());
 176                 groupModInputBuilder.setBucketsList(bucketLists);
 177             }
 178         }
 179
 180         groupModInputBuilder.setVersion(data.getVersion());
 181         return groupModInputBuilder;
 182     }
 183 }