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

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