summaryrefslogtreecommitdiffstats
path: root/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/write/MappingEntryCustomizer.java
blob: e51d610e136157413a94be8c871b75bbc00a97d3 (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
/*
 * Copyright (c) 2018 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.hc2vpp.nat.write;

import com.google.common.base.Optional;
import io.fd.hc2vpp.common.translate.util.ByteDataTranslator;
import io.fd.hc2vpp.common.translate.util.Ipv4Translator;
import io.fd.hc2vpp.common.translate.util.Ipv6Translator;
import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
import io.fd.hc2vpp.nat.util.MappingEntryContext;
import io.fd.honeycomb.translate.spi.write.ListWriterCustomizer;
import io.fd.honeycomb.translate.write.WriteContext;
import io.fd.honeycomb.translate.write.WriteFailedException;
import io.fd.vpp.jvpp.nat.dto.Nat44AddDelStaticMapping;
import io.fd.vpp.jvpp.nat.dto.Nat64AddDelStaticBib;
import io.fd.vpp.jvpp.nat.future.FutureJVppNatFacade;
import javax.annotation.Nonnull;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev180628.PortNumber;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev180628.nat.instances.Instance;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev180628.nat.instances.instance.mapping.table.MappingEntry;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev180628.nat.instances.instance.mapping.table.MappingEntryKey;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

final class MappingEntryCustomizer implements ListWriterCustomizer<MappingEntry, MappingEntryKey>,
        JvppReplyConsumer, Ipv4Translator, Ipv6Translator, ByteDataTranslator {

    private static final Logger LOG = LoggerFactory.getLogger(MappingEntryCustomizer.class);

    private final FutureJVppNatFacade jvppNat;
    private final MappingEntryContext mappingEntryContext;

    MappingEntryCustomizer(final FutureJVppNatFacade jvppNat, final MappingEntryContext mappingEntryContext) {
        this.jvppNat = jvppNat;
        this.mappingEntryContext = mappingEntryContext;
    }

    @Override
    public void writeCurrentAttributes(@Nonnull final InstanceIdentifier<MappingEntry> id,
                                       @Nonnull final MappingEntry dataAfter,
                                       @Nonnull final WriteContext writeContext)
            throws WriteFailedException {
        final Long natInstanceId = id.firstKeyOf(Instance.class).getId();
        final Long mappingEntryId = id.firstKeyOf(MappingEntry.class).getIndex();
        LOG.debug("Writing mapping entry: {} for nat-instance(vrf): {}", natInstanceId, mappingEntryId);

        configureMapping(id, dataAfter, natInstanceId, true);

        // Store context mapping only if not already present under the same exact mapping
        synchronized (mappingEntryContext) {
            if (shouldStoreContextMapping(natInstanceId, mappingEntryId, dataAfter, writeContext)) {
                mappingEntryContext
                        .addEntry(natInstanceId, mappingEntryId, dataAfter, writeContext.getMappingContext());
            }
        }
        LOG.trace("Mapping entry: {} for nat-instance(vrf): {} written successfully", natInstanceId, id);
    }

    private void configureMapping(@Nonnull final InstanceIdentifier<MappingEntry> id,
                                  @Nonnull final MappingEntry entry,
                                  @Nonnull final Long natInstanceId,
                                  final boolean isAdd) throws WriteFailedException {
        final IpPrefix internalSrcPrefix = entry.getInternalSrcAddress();
        final Ipv4Prefix internalV4SrcPrefix = internalSrcPrefix.getIpv4Prefix();
        if (internalV4SrcPrefix != null) {
            final Nat44AddDelStaticMapping request = getNat44Request(id, entry, natInstanceId, isAdd);
            getReplyForWrite(jvppNat.nat44AddDelStaticMapping(request).toCompletableFuture(), id);
        } else {
            final Nat64AddDelStaticBib request = getNat64Request(id, entry, natInstanceId, isAdd);
            getReplyForWrite(jvppNat.nat64AddDelStaticBib(request).toCompletableFuture(), id);
        }
    }

    /**
     * Check whether entry is already stored in context under the same index.
     *
     * @return true if it's not yet stored under same index, false otherwise.
     */
    private boolean shouldStoreContextMapping(final long natInstanceId, final long mappingEntryId,
                                              final MappingEntry dataAfter,
                                              final WriteContext writeCtx) {
        if (!mappingEntryContext.containsEntry(natInstanceId, dataAfter, writeCtx.getMappingContext())) {
            return true;
        }

        final Optional<Long> storedIndex =
                mappingEntryContext.getStoredIndex(natInstanceId, dataAfter, writeCtx.getMappingContext());
        if (!storedIndex.isPresent()) {
            return true;
        }

        if (storedIndex.get() != mappingEntryId) {
            return true;
        }

        return false;
    }

    @Override
    public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<MappingEntry> id,
                                        @Nonnull final MappingEntry dataBefore,
                                        @Nonnull final WriteContext writeContext) throws WriteFailedException {
        final long natInstanceId = id.firstKeyOf(Instance.class).getId();
        final MappingEntryKey mappingEntryKey = id.firstKeyOf(MappingEntry.class);
        LOG.debug("Deleting mapping entry: {} for nat-instance(vrf): {}", natInstanceId, mappingEntryKey);

        configureMapping(id, dataBefore, natInstanceId, false);
        mappingEntryContext.removeEntry(natInstanceId, dataBefore, writeContext.getMappingContext());
        LOG.trace("Mapping entry: {} for nat-instance(vrf): {} deleted successfully", natInstanceId, id);
    }

    private Nat44AddDelStaticMapping getNat44Request(final InstanceIdentifier<MappingEntry> id,
                                                 final MappingEntry mappingEntry,
                                                 final Long natInstanceId,
                                                 final boolean isAdd)
            throws WriteFailedException.CreateFailedException {
        final Nat44AddDelStaticMapping request = new Nat44AddDelStaticMapping();
        request.isAdd = booleanToByte(isAdd);
        // VPP uses int, model long
        request.vrfId = natInstanceId.intValue();

        final Ipv4Prefix internalAddress = mappingEntry.getInternalSrcAddress().getIpv4Prefix();
        request.addrOnly = 1;
        request.localIpAddress = ipv4AddressPrefixToArray(internalAddress);
        request.externalIpAddress = ipv4AddressPrefixToArray(mappingEntry.getExternalSrcAddress().getIpv4Prefix());
        request.externalSwIfIndex = -1; // external ip address is ignored if externalSwIfIndex is given
        request.protocol = -1;
        final Short protocol = mappingEntry.getTransportProtocol();
        if (protocol != null) {
            request.protocol = protocol.byteValue();
        }

        final Integer internalPortNumber = getPortNumber(mappingEntry.getInternalSrcPort());
        final Integer externalPortNumber = getPortNumber(mappingEntry.getExternalSrcPort());
        if (internalPortNumber != null && externalPortNumber != null) {
            request.addrOnly = 0;
            request.localPort = internalPortNumber.shortValue();
            request.externalPort = externalPortNumber.shortValue();
        }
        return request;
    }

    private Nat64AddDelStaticBib getNat64Request(final InstanceIdentifier<MappingEntry> id,
                                                 final MappingEntry mappingEntry,
                                                 final Long natInstanceId,
                                                 final boolean isAdd)
            throws WriteFailedException.CreateFailedException {
        final Nat64AddDelStaticBib request = new Nat64AddDelStaticBib();
        request.isAdd = booleanToByte(isAdd);
        // VPP uses int, model long
        request.vrfId = natInstanceId.intValue();

        final Ipv6Prefix internalAddress = mappingEntry.getInternalSrcAddress().getIpv6Prefix();
        request.iAddr = ipv6AddressPrefixToArray(internalAddress);
        request.oAddr = ipv4AddressPrefixToArray(mappingEntry.getExternalSrcAddress().getIpv4Prefix());
        request.proto = -1;
        final Short protocol = mappingEntry.getTransportProtocol();
        if (protocol != null) {
            request.proto = protocol.byteValue();
        }

        final Integer internalPortNumber = getPortNumber(mappingEntry.getInternalSrcPort());
        final Integer externalPortNumber = getPortNumber(mappingEntry.getExternalSrcPort());
        if (internalPortNumber != null && externalPortNumber != null) {
            request.iPort = internalPortNumber.shortValue();
            request.oPort = externalPortNumber.shortValue();
        }
        return request;
    }

    private Integer getPortNumber(final PortNumber portNumber) {
        if (portNumber != null) {
            return portNumber.getStartPortNumber().getValue();
        }
        return null;
    }
}