summaryrefslogtreecommitdiffstats
path: root/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/common/AbstractIetfAclWriter.java
blob: 1a1fbd519853e2f33faf59da09af779bcbf6aad0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.fd.honeycomb.translate.v3po.interfaces.acl.common;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import io.fd.honeycomb.translate.vpp.util.JvppReplyConsumer;
import io.fd.honeycomb.translate.write.WriteContext;
import io.fd.honeycomb.translate.write.WriteFailedException;
import io.fd.vpp.jvpp.core.dto.ClassifyAddDelSession;
import io.fd.vpp.jvpp.core.dto.ClassifyAddDelSessionReply;
import io.fd.vpp.jvpp.core.dto.ClassifyAddDelTable;
import io.fd.vpp.jvpp.core.dto.ClassifyAddDelTableReply;
import io.fd.vpp.jvpp.core.future.FutureJVppCore;
import java.util.HashMap;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.concurrent.CompletionStage;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nonnull;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.AclBase;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.AclKey;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.AccessListEntries;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.Ace;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.actions.PacketHandling;
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;
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;
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;
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;
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;
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.AceIpv6;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.InterfaceMode;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.access.lists.acl.access.list.entries.ace.matches.ace.type.AceIpAndEth;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.AccessLists;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.access.lists.Acl;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public abstract class AbstractIetfAclWriter implements IetfAclWriter, JvppReplyConsumer, AclTranslator {

    private static final Logger LOG = LoggerFactory.getLogger(AbstractIetfAclWriter.class);
    private static final int NOT_DEFINED = -1;
    protected final FutureJVppCore jvpp;

    private Map<AclType, AceWriter<? extends AceType>> aceWriters = new HashMap<>();

    public AbstractIetfAclWriter(@Nonnull final FutureJVppCore futureJVppCore) {
        this.jvpp = Preconditions.checkNotNull(futureJVppCore, "futureJVppCore should not be null");
        aceWriters.put(AclType.ETH, new AceEthWriter());
        aceWriters.put(AclType.IP4, new AceIp4Writer());
        aceWriters.put(AclType.IP6, new AceIp6Writer());
        aceWriters.put(AclType.ETH_AND_IP, new AceIpAndEthWriter());
    }

    private static Stream<Ace> aclToAceStream(@Nonnull final Acl assignedAcl,
                                              @Nonnull final WriteContext writeContext) {
        final String aclName = assignedAcl.getName();
        final Class<? extends AclBase> aclType = assignedAcl.getType();

        // ietf-acl updates are handled first, so we use writeContext.readAfter
        final Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.Acl>
            aclOptional =
            writeContext.readAfter(io.fd.honeycomb.translate.v3po.interfaces.acl.IetfAclWriter.ACL_ID.child(
                org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.Acl.class,
                new AclKey(aclName, aclType)));
        checkArgument(aclOptional.isPresent(), "Acl lists not configured");
        final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.Acl
            acl = aclOptional.get();

        final AccessListEntries accessListEntries = acl.getAccessListEntries();
        checkArgument(accessListEntries != null, "access list entries not configured");

        return accessListEntries.getAce().stream();
    }

    protected void removeClassifyTable(@Nonnull final InstanceIdentifier<?> id, final int tableIndex)
        throws WriteFailedException {

        if (tableIndex == -1) {
            return; // classify table id is absent
        }
        final ClassifyAddDelTable request = new ClassifyAddDelTable();
        request.tableIndex = tableIndex;
        final CompletionStage<ClassifyAddDelTableReply> cs = jvpp.classifyAddDelTable(request);
        getReplyForDelete(cs.toCompletableFuture(), id);
    }

    protected static boolean appliesToIp4Path(final Ace ace) {
        final AceType aceType = ace.getMatches().getAceType();
        final AclType aclType = AclType.fromAce(ace);
        if (aclType == AclType.IP4) {
            return true;
        }
        if (aclType == AclType.ETH) {
            return true;  // L2 only rules are possible for IP4 traffic
        }
        if (aclType == AclType.ETH_AND_IP && ((AceIpAndEth) aceType)
            .getAceIpVersion() instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.access.lists.acl.access.list.entries.ace.matches.ace.type.ace.ip.and.eth.ace.ip.version.AceIpv4) {
            return true;
        }
        return false;
    }

    protected static boolean appliesToIp6Path(final Ace ace) {
        final AceType aceType = ace.getMatches().getAceType();
        final AclType aclType = AclType.fromAce(ace);
        if (aclType == AclType.IP6) {
            return true;
        }
        if (aclType == AclType.ETH) {
            return true;  // L2 only rules are possible for IP6 traffic
        }
        if (aclType == AclType.ETH_AND_IP && ((AceIpAndEth) aceType)
            .getAceIpVersion() instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.access.lists.acl.access.list.entries.ace.matches.ace.type.ace.ip.and.eth.ace.ip.version.AceIpv6) {
            return true;
        }
        return false;
    }

    protected static List<Ace> getACEs(@Nonnull final List<Acl> acls, @Nonnull final WriteContext writeContext,
                                       final Predicate<? super Ace> filter) {
        return acls.stream().flatMap(acl -> aclToAceStream(acl, writeContext)).filter(filter)
            .collect(Collectors.toList());
    }

    protected int writeAces(final InstanceIdentifier<?> id, final List<Ace> aces,
                            final AccessLists.DefaultAction defaultAction, final InterfaceMode mode,
                            final int vlanTags) throws WriteFailedException {
        if (aces.isEmpty()) {
            return NOT_DEFINED;
        }

        int nextTableIndex = configureDefaultAction(id, defaultAction);
        final ListIterator<Ace> iterator = aces.listIterator(aces.size());
        while (iterator.hasPrevious()) {
            final Ace ace = iterator.previous();
            LOG.trace("Processing ACE: {}", ace);

            final AceWriter aceWriter =
                aceWriters.get(AclType.fromAce(ace));
            if (aceWriter == null) {
                LOG.warn("AceProcessor for {} not registered. Skipping ACE.", ace.getClass());
            } else {
                final AceType aceType = ace.getMatches().getAceType();
                final PacketHandling action = ace.getActions().getPacketHandling();
                final ClassifyAddDelTable ctRequest = aceWriter.createTable(aceType, mode, nextTableIndex, vlanTags);
                nextTableIndex = createClassifyTable(id, ctRequest);
                final List<ClassifyAddDelSession> sessionRequests =
                    aceWriter.createSession(action, aceType, mode, nextTableIndex, vlanTags);
                for (ClassifyAddDelSession csRequest : sessionRequests) {
                    createClassifySession(id, csRequest);
                }
            }
        }
        return nextTableIndex;
    }

    private int configureDefaultAction(@Nonnull final InstanceIdentifier<?> id,
                                       final AccessLists.DefaultAction defaultAction)
        throws WriteFailedException {
        ClassifyAddDelTable ctRequest = createTable(-1);
        if (AccessLists.DefaultAction.Permit.equals(defaultAction)) {
            ctRequest.missNextIndex = -1;
        } else {
            ctRequest.missNextIndex = 0;
        }
        ctRequest.mask = new byte[16];
        ctRequest.skipNVectors = 0;
        ctRequest.matchNVectors = 1;
        return createClassifyTable(id, ctRequest);
    }

    private int createClassifyTable(@Nonnull final InstanceIdentifier<?> id,
                                    @Nonnull final ClassifyAddDelTable request)
        throws WriteFailedException {
        final CompletionStage<ClassifyAddDelTableReply> cs = jvpp.classifyAddDelTable(request);

        final ClassifyAddDelTableReply reply = getReplyForWrite(cs.toCompletableFuture(), id);
        return reply.newTableIndex;
    }

    private void createClassifySession(@Nonnull final InstanceIdentifier<?> id,
                                       @Nonnull final ClassifyAddDelSession request)
        throws WriteFailedException {
        final CompletionStage<ClassifyAddDelSessionReply> cs = jvpp.classifyAddDelSession(request);

        getReplyForWrite(cs.toCompletableFuture(), id);
    }

    private enum AclType {
        ETH, IP4, IP6, ETH_AND_IP;

        @Nonnull
        private static AclType fromAce(final Ace ace) {
            AclType result = null;
            final AceType aceType;
            try {
                aceType = ace.getMatches().getAceType();
                if (aceType instanceof AceEth) {
                    result = ETH;
                } else if (aceType instanceof AceIp) {
                    final AceIpVersion aceIpVersion = ((AceIp) aceType).getAceIpVersion();
                    if (aceIpVersion == null) {
                        throw new IllegalArgumentException("Incomplete ACE (ip-version was not provided): " + ace);
                    }
                    if (aceIpVersion instanceof AceIpv4) {
                        result = IP4;
                    } else if (aceIpVersion instanceof AceIpv6) {
                        result = IP6;
                    }
                } else if (aceType instanceof AceIpAndEth) {
                    result = ETH_AND_IP;
                }
            } catch (NullPointerException e) {
                throw new IllegalArgumentException("Incomplete ACE: " + ace, e);
            }
            if (result == null) {
                throw new IllegalArgumentException(String.format("Not supported ace type %s", aceType));
            }
            return result;
        }
    }
}