summaryrefslogtreecommitdiffstats
path: root/nat/nat2vpp/src/main/java/io/fd/hc2vpp/nat/read/MappingEntryCustomizer.java
blob: 8f22b756fb189ad33855991810b8c815df91036d (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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/*
 * 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.hc2vpp.nat.read;

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.read.ReadContext;
import io.fd.honeycomb.translate.read.ReadFailedException;
import io.fd.honeycomb.translate.spi.read.Initialized;
import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
import io.fd.honeycomb.translate.util.RWUtils;
import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
import io.fd.honeycomb.translate.util.read.cache.EntityDumpExecutor;
import io.fd.vpp.jvpp.nat.dto.Nat44StaticMappingDetails;
import io.fd.vpp.jvpp.nat.dto.Nat44StaticMappingDetailsReplyDump;
import io.fd.vpp.jvpp.nat.dto.Nat44StaticMappingDump;
import io.fd.vpp.jvpp.nat.dto.Nat64BibDetails;
import io.fd.vpp.jvpp.nat.dto.Nat64BibDetailsReplyDump;
import io.fd.vpp.jvpp.nat.dto.Nat64BibDump;
import io.fd.vpp.jvpp.nat.future.FutureJVppNatFacade;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.mapping.entry.ExternalSrcPortBuilder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.mapping.entry.InternalSrcPortBuilder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.config.nat.instances.nat.instance.MappingTable;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.NatInstance;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.nat.instance.MappingTableBuilder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.nat.instance.mapping.table.MappingEntry;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.nat.instance.mapping.table.MappingEntryBuilder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.state.nat.instances.nat.instance.mapping.table.MappingEntryKey;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.port.number.port.type.SinglePortNumberBuilder;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

final class MappingEntryCustomizer implements Ipv4Translator, Ipv6Translator,
        InitializingListReaderCustomizer<MappingEntry, MappingEntryKey, MappingEntryBuilder> {

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

    private final DumpCacheManager<Nat44StaticMappingDetailsReplyDump, Void> nat44DumpManager;
    private final DumpCacheManager<Nat64BibDetailsReplyDump, Void> nat64DumpManager;
    private final MappingEntryContext mappingEntryContext;

    MappingEntryCustomizer(
            final DumpCacheManager<Nat44StaticMappingDetailsReplyDump, Void> nat44DumpManager,
            final DumpCacheManager<Nat64BibDetailsReplyDump, Void> nat64DumpManager,
            final MappingEntryContext mappingEntryContext) {
        this.nat44DumpManager = nat44DumpManager;
        this.nat64DumpManager = nat64DumpManager;
        this.mappingEntryContext = mappingEntryContext;
    }

    @Nonnull
    @Override
    public MappingEntryBuilder getBuilder(@Nonnull final InstanceIdentifier<MappingEntry> id) {
        return new MappingEntryBuilder();
    }

    @Override
    public void readCurrentAttributes(@Nonnull final InstanceIdentifier<MappingEntry> id,
                                      @Nonnull final MappingEntryBuilder builder, @Nonnull final ReadContext ctx)
            throws ReadFailedException {
        LOG.trace("Reading current attributes for mapping-entry: {}", id);

        final int idx = id.firstKeyOf(MappingEntry.class).getIndex().intValue();
        final int natInstanceId = id.firstKeyOf(NatInstance.class).getId().intValue();
        final List<Nat44StaticMappingDetails> nat44Details =
                nat44DumpManager.getDump(id, ctx.getModificationCache(), null)
                        .or(new Nat44StaticMappingDetailsReplyDump()).nat44StaticMappingDetails;
        final Optional<Nat44StaticMappingDetails> nat44StaticMappingDetails =
                mappingEntryContext.findDetailsNat44(nat44Details, natInstanceId, idx, ctx.getMappingContext());

        if (nat44StaticMappingDetails.isPresent()) {
            readNat44Entry(builder, idx, nat44StaticMappingDetails.get());
        } else {
            final List<Nat64BibDetails> nat64Details =
                    nat64DumpManager.getDump(id, ctx.getModificationCache(), null)
                            .or(new Nat64BibDetailsReplyDump()).nat64BibDetails;

            final Optional<Nat64BibDetails> nat64StaticMappingDetails =
                    mappingEntryContext.findDetailsNat64(nat64Details, natInstanceId, idx, ctx.getMappingContext());

            if (nat64StaticMappingDetails.isPresent()) {
                readNat64Entry(builder, idx, nat64StaticMappingDetails.get());
            }
        }


        LOG.trace("Mapping-entry read as: {}", builder);
    }

    private void readNat44Entry(@Nonnull final MappingEntryBuilder builder,
                                final int index, final Nat44StaticMappingDetails detail) {
        builder.setIndex((long) index);
        builder.setType(
                org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.MappingEntry.Type.Static);
        builder.setExternalSrcAddress(arrayToIpv4AddressNoZone(detail.externalIpAddress));
        builder.setInternalSrcAddress(
                new IpAddress(arrayToIpv4AddressNoZone(detail.localIpAddress)));

        if (detail.addrOnly == 0) {
            builder.setExternalSrcPort(new ExternalSrcPortBuilder()
                    .setPortType(new SinglePortNumberBuilder().setSinglePortNumber(new PortNumber(
                            (int) detail.externalPort))
                            .build())
                    .build());
            builder.setInternalSrcPort(new InternalSrcPortBuilder()
                    .setPortType(new SinglePortNumberBuilder().setSinglePortNumber(new PortNumber(
                            (int) detail.localPort))
                            .build())
                    .build());
        }
    }

    private void readNat64Entry(@Nonnull final MappingEntryBuilder builder,
                                final int index, final Nat64BibDetails detail) {
        builder.setIndex((long) index);
        if (detail.isStatic == 1) {
            builder.setType(
                    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.MappingEntry.Type.Static);
        } else {
            builder.setType(
                    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.MappingEntry.Type.Dynamic);
        }
        builder.setExternalSrcAddress(arrayToIpv4AddressNoZone(detail.oAddr));
        builder.setInternalSrcAddress(
                new IpAddress(arrayToIpv6AddressNoZone(detail.iAddr)));

        builder.setExternalSrcPort(new ExternalSrcPortBuilder()
                .setPortType(new SinglePortNumberBuilder().setSinglePortNumber(new PortNumber(
                        (int) detail.oPort))
                        .build())
                .build());
        builder.setInternalSrcPort(new InternalSrcPortBuilder()
                .setPortType(new SinglePortNumberBuilder().setSinglePortNumber(new PortNumber(
                        (int) detail.iPort))
                        .build())
                .build());
    }

    @Nonnull
    @Override
    public List<MappingEntryKey> getAllIds(@Nonnull final InstanceIdentifier<MappingEntry> id,
                                           @Nonnull final ReadContext context) throws ReadFailedException {
        final Long natInstanceId = id.firstKeyOf(NatInstance.class).getId();
        LOG.trace("Listing IDs for all mapping-entries within nat-instance(vrf):{}", natInstanceId);

        final List<MappingEntryKey> entryKeys =
                nat44DumpManager.getDump(id, context.getModificationCache(), null)
                        .or(new Nat44StaticMappingDetailsReplyDump()).nat44StaticMappingDetails.stream()
                        .filter(detail -> natInstanceId == detail.vrfId)
                        .map(detail -> mappingEntryContext
                                .getStoredOrArtificialIndex(natInstanceId, detail, context.getMappingContext()))
                        .map(MappingEntryKey::new)
                        .collect(Collectors.toList());


        final List<MappingEntryKey> nat64Keys =
                nat64DumpManager.getDump(id, context.getModificationCache(), null)
                        .or(new Nat64BibDetailsReplyDump()).nat64BibDetails.stream()
                        .filter(detail -> natInstanceId == detail.vrfId)
                        .map(detail -> mappingEntryContext
                                .getStoredOrArtificialIndex(natInstanceId, detail, context.getMappingContext()))
                        .map(MappingEntryKey::new)
                        .collect(Collectors.toList());
        entryKeys.addAll(nat64Keys);
        LOG.debug("List of mapping-entry keys within nat-instance(vrf):{} : {}", natInstanceId, entryKeys);

        return entryKeys;
    }

    @Override
    public void merge(@Nonnull final Builder<? extends DataObject> builder,
                      @Nonnull final List<MappingEntry> readData) {
        ((MappingTableBuilder) builder).setMappingEntry(readData);
    }

    @Override
    public Initialized<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.config.nat.instances.nat.instance.mapping.table.MappingEntry> init(
            @Nonnull final InstanceIdentifier<MappingEntry> id,
            @Nonnull final MappingEntry readValue,
            @Nonnull final ReadContext ctx) {
        return Initialized.create(getCfgId(id),
                new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.config.nat.instances.nat.instance.mapping.table.MappingEntryBuilder(
                        readValue)
                        .build());
    }

    static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.config.nat.instances.nat.instance.mapping.table.MappingEntry> getCfgId(
            final @Nonnull InstanceIdentifier<MappingEntry> id) {
        return NatInstanceCustomizer.getCfgId(RWUtils.cutId(id, NatInstance.class))
                .child(MappingTable.class)
                .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.config.nat.instances.nat.instance.mapping.table.MappingEntry.class,
                        new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.config.nat.instances.nat.instance.mapping.table.MappingEntryKey(
                                id.firstKeyOf(MappingEntry.class).getIndex()));
    }

    static final class MappingEntryNat44DumpExecutor
            implements EntityDumpExecutor<Nat44StaticMappingDetailsReplyDump, Void>, JvppReplyConsumer {

        private final FutureJVppNatFacade jvppNat;

        MappingEntryNat44DumpExecutor(final FutureJVppNatFacade jvppNat) {
            this.jvppNat = jvppNat;
        }

        @Nonnull
        @Override
        public Nat44StaticMappingDetailsReplyDump executeDump(final InstanceIdentifier<?> identifier, final Void params)
                throws ReadFailedException {
            return getReplyForRead(jvppNat.nat44StaticMappingDump(new Nat44StaticMappingDump()).toCompletableFuture(),
                    identifier);
        }
    }

    static final class MappingEntryNat64DumpExecutor
            implements EntityDumpExecutor<Nat64BibDetailsReplyDump, Void>, JvppReplyConsumer {

        private final FutureJVppNatFacade jvppNat;

        MappingEntryNat64DumpExecutor(final FutureJVppNatFacade jvppNat) {
            this.jvppNat = jvppNat;
        }

        @Nonnull
        @Override
        public Nat64BibDetailsReplyDump executeDump(final InstanceIdentifier<?> identifier, final Void params)
                throws ReadFailedException {
            final Nat64BibDump dump = new Nat64BibDump();
            dump.proto = -1; // dump entries for all protocols
            return getReplyForRead(jvppNat.nat64BibDump(dump).toCompletableFuture(), identifier);
        }
    }
}