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.convert(salGroup, data);
  52  * }
  53  * </pre>
  54  */
  55 public class GroupConvertor extends 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      * Create default empty group mod input builder
  59      * Use this method, if result from convertor is empty.
  60      *
  61      * @param version Openflow version
  62      * @return default empty group mod input builder
  63      */
  64     public static GroupModInputBuilder defaultResult(short version) {
  65         return new GroupModInputBuilder()
  66                 .setVersion(version);
  67     }
  68
  69     private static final Logger LOG = LoggerFactory.getLogger(GroupConvertor.class);
  70     private static final Integer DEFAULT_WEIGHT = 0;
  71     private static final Long OFPP_ANY = Long.parseLong("ffffffff", 16);
  72     private static final Long DEFAULT_WATCH_PORT = OFPP_ANY;
  73     private static final Long OFPG_ANY = Long.parseLong("ffffffff", 16);
  74     private static final Long DEFAULT_WATCH_GROUP = OFPG_ANY;
  75     private static final Comparator<Bucket> COMPARATOR = (bucket1, bucket2) -> {
  76         if (bucket1.getBucketId() == null || bucket2.getBucketId() == null) return 0;
  77         return bucket1.getBucketId().getValue().compareTo(bucket2.getBucketId().getValue());
  78     };
  79
  80     private List<BucketsList> salToOFBucketList(Buckets buckets, short version, int groupType, BigInteger datapathid) {
  81         final List<BucketsList> bucketLists = new ArrayList<>();
  82         final ActionConvertorData data = new ActionConvertorData(version);
  83         data.setDatapathId(datapathid);
  84
  85         for (org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket groupBucket : buckets
  86                 .getBucket()) {
  87             BucketsListBuilder bucketBuilder = new BucketsListBuilder();
  88
  89             salToOFBucketListWeight(groupBucket, bucketBuilder, groupType);
  90             salToOFBucketListWatchGroup(groupBucket, bucketBuilder, groupType);
  91             salToOFBucketListWatchPort(groupBucket, bucketBuilder, groupType);
  92
  93             Optional<List<Action>> bucketActionList = getConvertorExecutor().convert(
  94                     groupBucket.getAction(), data);
  95
  96             bucketBuilder.setAction(bucketActionList.orElse(Collections.emptyList()));
  97             BucketsList bucket = bucketBuilder.build();
  98             bucketLists.add(bucket);
  99         }
 100
 101         return bucketLists;
 102
 103     }
 104
 105     private static void salToOFBucketListWatchPort(Bucket groupBucket, BucketsListBuilder bucketBuilder, int groupType) {
 106         if (null != groupBucket.getWatchPort()) {
 107             bucketBuilder.setWatchPort(new PortNumber(groupBucket.getWatchPort()));
 108         } else {
 109             bucketBuilder.setWatchPort(new PortNumber(BinContent.intToUnsignedLong(DEFAULT_WATCH_PORT.intValue())));
 110             if (groupType == GroupType.OFPGTFF.getIntValue()) {
 111                 LOG.error("WatchPort required for this OFPGT_FF");
 112             }
 113         }
 114     }
 115
 116     private static void salToOFBucketListWatchGroup(Bucket groupBucket, BucketsListBuilder bucketBuilder, int groupType) {
 117         if (null != groupBucket.getWatchGroup()) {
 118             bucketBuilder.setWatchGroup(groupBucket.getWatchGroup());
 119         } else {
 120             bucketBuilder.setWatchGroup(BinContent.intToUnsignedLong(DEFAULT_WATCH_GROUP.intValue()));
 121             if (groupType == GroupType.OFPGTFF.getIntValue()) {
 122                 LOG.error("WatchGroup required for this OFPGT_FF");
 123             }
 124         }
 125     }
 126
 127     private static void salToOFBucketListWeight(Bucket groupBucket, BucketsListBuilder bucketBuilder, int groupType) {
 128         if (null != groupBucket.getWeight()) {
 129             bucketBuilder.setWeight(groupBucket.getWeight());
 130         } else {
 131             bucketBuilder.setWeight(DEFAULT_WEIGHT);
 132             if (groupType == GroupType.OFPGTSELECT.getIntValue()) {
 133                 LOG.error("Weight value required for this OFPGT_SELECT");
 134             }
 135         }
 136     }
 137
 138     @Override
 139     public Collection<Class<? extends DataContainer>> getTypes() {
 140         return  TYPES;
 141     }
 142
 143     @Override
 144     public GroupModInputBuilder convert(Group source, VersionDatapathIdConvertorData data) {
 145         GroupModInputBuilder groupModInputBuilder = new GroupModInputBuilder();
 146         if (source instanceof AddGroupInput) {
 147             groupModInputBuilder.setCommand(GroupModCommand.OFPGCADD);
 148         } else if (source instanceof RemoveGroupInput) {
 149             groupModInputBuilder.setCommand(GroupModCommand.OFPGCDELETE);
 150         } else if (source instanceof UpdatedGroup) {
 151             groupModInputBuilder.setCommand(GroupModCommand.OFPGCMODIFY);
 152         }
 153
 154         if (GroupTypes.GroupAll.equals(source.getGroupType())) {
 155             groupModInputBuilder.setType(GroupType.OFPGTALL);
 156         }
 157
 158         if (GroupTypes.GroupSelect.equals(source.getGroupType())) {
 159             groupModInputBuilder.setType(GroupType.OFPGTSELECT);
 160         }
 161
 162         if (GroupTypes.GroupIndirect.equals(source.getGroupType())) {
 163             groupModInputBuilder.setType(GroupType.OFPGTINDIRECT);
 164         }
 165
 166         if (GroupTypes.GroupFf.equals(source.getGroupType())) {
 167             groupModInputBuilder.setType(GroupType.OFPGTFF);
 168         }
 169
 170         groupModInputBuilder.setGroupId(new GroupId(source.getGroupId().getValue()));
 171
 172         // Only if the bucket is configured for the group then add it
 173         // During group deletion do not push the buckets
 174         if (groupModInputBuilder.getCommand() != GroupModCommand.OFPGCDELETE) {
 175             if ((source.getBuckets() != null) && (source.getBuckets().getBucket().size() != 0)) {
 176
 177                 Collections.sort(source.getBuckets().getBucket(), COMPARATOR);
 178
 179                 List<BucketsList> bucketLists = salToOFBucketList(source.getBuckets(), data.getVersion(), source.getGroupType().getIntValue(), data.getDatapathId());
 180                 groupModInputBuilder.setBucketsList(bucketLists);
 181             }
 182         }
 183
 184         groupModInputBuilder.setVersion(data.getVersion());
 185         return groupModInputBuilder;
 186     }
 187 }