v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/ingress/IetfAClWriter.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.translate.v3po.interfaces.acl.ingress;
  18
  19 import static com.google.common.base.Preconditions.checkArgument;
  20
  21 import com.google.common.base.Optional;
  22 import com.google.common.base.Preconditions;
  23 import io.fd.honeycomb.translate.v3po.interfaces.acl.IetfAclWriter;
  24 import io.fd.honeycomb.translate.vpp.util.JvppReplyConsumer;
  25 import io.fd.honeycomb.translate.write.WriteContext;
  26 import io.fd.honeycomb.translate.write.WriteFailedException;
  27 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelTable;
  28 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelTableReply;
  29 import io.fd.vpp.jvpp.core.dto.ClassifyTableByInterface;
  30 import io.fd.vpp.jvpp.core.dto.ClassifyTableByInterfaceReply;
  31 import io.fd.vpp.jvpp.core.dto.InputAclSetInterface;
  32 import io.fd.vpp.jvpp.core.dto.InputAclSetInterfaceReply;
  33 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  34 import java.util.HashMap;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.concurrent.CompletionStage;
  38 import java.util.stream.Collectors;
  39 import java.util.stream.Stream;
  40 import javax.annotation.Nonnegative;
  41 import javax.annotation.Nonnull;
  42 import javax.annotation.Nullable;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.AclBase;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.AclKey;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.AccessListEntries;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.Ace;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.matches.AceType;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.matches.ace.type.AceEth;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.matches.ace.type.AceIp;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.matches.ace.type.ace.ip.AceIpVersion;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.matches.ace.type.ace.ip.ace.ip.version.AceIpv4;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.InterfaceMode;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.ietf.acl.base.attributes.access.lists.Acl;
  54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 public final class IetfAClWriter implements JvppReplyConsumer {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(IetfAClWriter.class);
  61     private final FutureJVppCore jvpp;
  62
  63     private Map<AclType, AceWriter> aceWriters = new HashMap<>();
  64
  65     public IetfAClWriter(@Nonnull final FutureJVppCore futureJVppCore) {
  66         this.jvpp = Preconditions.checkNotNull(futureJVppCore, "futureJVppCore should not be null");
  67         aceWriters.put(AclType.ETH, new AceEthWriter(futureJVppCore));
  68         aceWriters.put(AclType.IP4, new AceIp4Writer(futureJVppCore));
  69         aceWriters.put(AclType.IP6, new AceIp6Writer(futureJVppCore));
  70     }
  71
  72     private static Stream<Ace> aclToAceStream(@Nonnull final Acl assignedAcl,
  73                                               @Nonnull final WriteContext writeContext) {
  74         final String aclName = assignedAcl.getName();
  75         final Class<? extends AclBase> aclType = assignedAcl.getType();
  76
  77         // ietf-acl updates are handled first, so we use writeContext.readAfter
  78         final Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.Acl>
  79                 aclOptional = writeContext.readAfter(IetfAclWriter.ACL_ID.child(
  80                 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.Acl.class,
  81                 new AclKey(aclName, aclType)));
  82         checkArgument(aclOptional.isPresent(), "Acl lists not configured");
  83         final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.Acl
  84                 acl = aclOptional.get();
  85
  86         final AccessListEntries accessListEntries = acl.getAccessListEntries();
  87         checkArgument(accessListEntries != null, "access list entries not configured");
  88
  89         return accessListEntries.getAce().stream();
  90     }
  91
  92     void deleteAcl(@Nonnull final InstanceIdentifier<?> id, final int swIfIndex)
  93             throws WriteFailedException {
  94         final ClassifyTableByInterface request = new ClassifyTableByInterface();
  95         request.swIfIndex = swIfIndex;
  96
  97         final CompletionStage<ClassifyTableByInterfaceReply> cs = jvpp.classifyTableByInterface(request);
  98         final ClassifyTableByInterfaceReply reply = getReplyForDelete(cs.toCompletableFuture(), id);
  99
 100         // We unassign and remove all ACL-related classify tables for given interface (we assume we are the only
 101         // classify table manager)
 102
 103         unassignClassifyTables(id, reply);
 104
 105         removeClassifyTable(id, reply.l2TableId);
 106         removeClassifyTable(id, reply.ip4TableId);
 107         removeClassifyTable(id, reply.ip6TableId);
 108     }
 109
 110     private void unassignClassifyTables(@Nonnull final InstanceIdentifier<?> id,
 111                                         final ClassifyTableByInterfaceReply currentState)
 112             throws WriteFailedException {
 113         final InputAclSetInterface request = new InputAclSetInterface();
 114         request.isAdd = 0;
 115         request.swIfIndex = currentState.swIfIndex;
 116         request.l2TableIndex = currentState.l2TableId;
 117         request.ip4TableIndex = currentState.ip4TableId;
 118         request.ip6TableIndex = currentState.ip6TableId;
 119         final CompletionStage<InputAclSetInterfaceReply> inputAclSetInterfaceReplyCompletionStage =
 120                 jvpp.inputAclSetInterface(request);
 121         getReplyForDelete(inputAclSetInterfaceReplyCompletionStage.toCompletableFuture(), id);
 122     }
 123
 124     private void removeClassifyTable(@Nonnull final InstanceIdentifier<?> id, final int tableIndex)
 125             throws WriteFailedException {
 126
 127         if (tableIndex == -1) {
 128             return; // classify table id is absent
 129         }
 130         final ClassifyAddDelTable request = new ClassifyAddDelTable();
 131         request.tableIndex = tableIndex;
 132         final CompletionStage<ClassifyAddDelTableReply> cs = jvpp.classifyAddDelTable(request);
 133         getReplyForDelete(cs.toCompletableFuture(), id);
 134     }
 135
 136     void write(@Nonnull final InstanceIdentifier<?> id, final int swIfIndex, @Nonnull final List<Acl> acls,
 137                @Nullable final InterfaceMode mode, @Nonnull final WriteContext writeContext)
 138             throws WriteFailedException {
 139         write(id, swIfIndex, mode, acls, writeContext, 0);
 140     }
 141
 142     void write(@Nonnull final InstanceIdentifier<?> id, final int swIfIndex, final InterfaceMode mode,
 143                @Nonnull final List<Acl> acls,
 144                @Nonnull final WriteContext writeContext, @Nonnegative final int numberOfTags)
 145             throws WriteFailedException {
 146
 147         // filter ACE entries and group by AceType
 148         final Map<AclType, List<Ace>> acesByType = acls.stream()
 149                 .flatMap(acl -> aclToAceStream(acl, writeContext))
 150                 .collect(Collectors.groupingBy(AclType::fromAce));
 151
 152         final InputAclSetInterface request = new InputAclSetInterface();
 153         request.isAdd = 1;
 154         request.swIfIndex = swIfIndex;
 155         request.l2TableIndex = -1;
 156         request.ip4TableIndex = -1;
 157         request.ip6TableIndex = -1;
 158
 159         // for each AceType:
 160         for (Map.Entry<AclType, List<Ace>> entry : acesByType.entrySet()) {
 161             final AclType aceType = entry.getKey();
 162             final List<Ace> aces = entry.getValue();
 163             LOG.trace("Processing ACEs of {} type: {}", aceType, aces);
 164
 165             final AceWriter aceWriter = aceWriters.get(aceType);
 166             if (aceWriter == null) {
 167                 LOG.warn("AceProcessor for {} not registered. Skipping ACE.", aceType);
 168             } else {
 169                 aceWriter.write(id, aces, mode, request, numberOfTags);
 170             }
 171         }
 172
 173         final CompletionStage<InputAclSetInterfaceReply> inputAclSetInterfaceReplyCompletionStage =
 174                 jvpp.inputAclSetInterface(request);
 175         getReplyForWrite(inputAclSetInterfaceReplyCompletionStage.toCompletableFuture(), id);
 176     }
 177
 178     private enum AclType {
 179         ETH, IP4, IP6;
 180
 181         @Nonnull
 182         private static AclType fromAce(final Ace ace) {
 183             AclType result = null;
 184             final AceType aceType;
 185             try {
 186                 aceType = ace.getMatches().getAceType();
 187                 if (aceType instanceof AceEth) {
 188                     result = ETH;
 189                 } else if (aceType instanceof AceIp) {
 190                     final AceIpVersion aceIpVersion = ((AceIp) aceType).getAceIpVersion();
 191                     if (aceIpVersion instanceof AceIpv4) {
 192                         result = IP4;
 193                     } else {
 194                         result = IP6;
 195                     }
 196                 }
 197             } catch (NullPointerException e) {
 198                 throw new IllegalArgumentException("Incomplete ACE: " + ace, e);
 199             }
 200             if (result == null) {
 201                 throw new IllegalArgumentException(String.format("Not supported ace type %s", aceType));
 202             }
 203             return result;
 204         }
 205     }
 206 }