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