lisp/lisp2vpp/src/main/java/io/fd/honeycomb/lisp/translate/read/RemoteMappingCustomizer.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.lisp.translate.read;
  18
  19 import static com.google.common.base.Preconditions.checkNotNull;
  20 import static com.google.common.base.Preconditions.checkState;
  21 import static io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.EidType.valueOf;
  22 import static io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.FilterType;
  23 import static io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.MappingsDumpParamsBuilder;
  24 import static org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.MapReplyAction.NoAction;
  25
  26 import com.google.common.base.Optional;
  27 import io.fd.honeycomb.lisp.context.util.EidMappingContext;
  28 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.LocatorDumpParams;
  29 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.LocatorDumpParams.LocatorDumpParamsBuilder;
  30 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams;
  31 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.QuantityType;
  32 import io.fd.honeycomb.lisp.translate.read.trait.LocatorReader;
  33 import io.fd.honeycomb.lisp.translate.read.trait.MappingReader;
  34 import io.fd.honeycomb.lisp.translate.util.EidTranslator;
  35 import io.fd.honeycomb.translate.ModificationCache;
  36 import io.fd.honeycomb.translate.read.ReadContext;
  37 import io.fd.honeycomb.translate.read.ReadFailedException;
  38 import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
  39 import io.fd.honeycomb.translate.util.RWUtils;
  40 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
  41 import io.fd.honeycomb.translate.vpp.util.AddressTranslator;
  42 import io.fd.honeycomb.translate.vpp.util.ByteDataTranslator;
  43 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  44 import io.fd.vpp.jvpp.core.dto.LispEidTableDetails;
  45 import io.fd.vpp.jvpp.core.dto.LispEidTableDetailsReplyDump;
  46 import io.fd.vpp.jvpp.core.dto.LispLocatorDetails;
  47 import io.fd.vpp.jvpp.core.dto.LispLocatorDetailsReplyDump;
  48 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  49 import java.util.Collections;
  50 import java.util.List;
  51 import java.util.stream.Collectors;
  52 import javax.annotation.Nonnull;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.MapReplyAction;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.MappingId;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.RemoteMappingsBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.RemoteMapping;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.RemoteMappingBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.RemoteMappingKey;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.Eid;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.EidBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.NegativeMappingBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.PositiveMappingBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.negative.mapping.MapReplyBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.positive.mapping.RlocsBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.positive.mapping.rlocs.Locator;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.positive.mapping.rlocs.LocatorBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.dp.subtable.grouping.remote.mappings.remote.mapping.locator.list.positive.mapping.rlocs.LocatorKey;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev161214.eid.table.grouping.eid.table.VniTable;
  70 import org.opendaylight.yangtools.concepts.Builder;
  71 import org.opendaylight.yangtools.yang.binding.DataObject;
  72 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  73 import org.slf4j.Logger;
  74 import org.slf4j.LoggerFactory;
  75
  76 /**
  77  * Customizer for reading {@code RemoteMapping}<br>
  78  */
  79 public class RemoteMappingCustomizer extends FutureJVppCustomizer
  80         implements ListReaderCustomizer<RemoteMapping, RemoteMappingKey, RemoteMappingBuilder>,
  81         EidTranslator, AddressTranslator, ByteDataTranslator, MappingReader, LocatorReader {
  82
  83     private static final Logger LOG = LoggerFactory.getLogger(RemoteMappingCustomizer.class);
  84     private static final String KEY = RemoteMappingCustomizer.class.getName();
  85
  86     private final DumpCacheManager<LispEidTableDetailsReplyDump, MappingsDumpParams> dumpManager;
  87     private final DumpCacheManager<LispLocatorDetailsReplyDump, LocatorDumpParams> locatorsDumpManager;
  88     private final EidMappingContext remoteMappingContext;
  89
  90     public RemoteMappingCustomizer(@Nonnull FutureJVppCore futureJvpp,
  91                                    @Nonnull EidMappingContext remoteMappingContext) {
  92         super(futureJvpp);
  93         this.remoteMappingContext = checkNotNull(remoteMappingContext, "Remote mappings not present");
  94         this.dumpManager =
  95                 new DumpCacheManager.DumpCacheManagerBuilder<LispEidTableDetailsReplyDump, MappingsDumpParams>()
  96                         .withExecutor(createMappingDumpExecutor(futureJvpp))
  97                         .build();
  98         this.locatorsDumpManager =
  99                 new DumpCacheManager.DumpCacheManagerBuilder<LispLocatorDetailsReplyDump, LocatorDumpParams>()
 100                         .withExecutor(createLocatorDumpExecutor(futureJvpp))
 101                         .build();
 102     }
 103
 104
 105     @Override
 106     public RemoteMappingBuilder getBuilder(InstanceIdentifier<RemoteMapping> id) {
 107         return new RemoteMappingBuilder();
 108     }
 109
 110     private Eid copyEid(
 111             org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.mappings.mapping.Eid eid) {
 112         return new EidBuilder().setAddress(eid.getAddress()).setAddressType(eid.getAddressType())
 113                 .setVirtualNetworkId(eid.getVirtualNetworkId()).build();
 114     }
 115
 116     @Override
 117     public void readCurrentAttributes(InstanceIdentifier<RemoteMapping> id, RemoteMappingBuilder builder,
 118                                       ReadContext ctx)
 119             throws ReadFailedException {
 120         checkState(id.firstKeyOf(RemoteMapping.class) != null, "No key present for id({})", id);
 121         checkState(id.firstKeyOf(VniTable.class) != null, "Parent VNI table not specified");
 122
 123         final MappingId mappingId = id.firstKeyOf(RemoteMapping.class).getId();
 124         checkState(remoteMappingContext.containsEid(mappingId, ctx.getMappingContext()),
 125                 "No mapping stored for id %s", mappingId);
 126
 127         final long vni = id.firstKeyOf(VniTable.class).getVirtualNetworkIdentifier();
 128         final String remoteMappingId = id.firstKeyOf(RemoteMapping.class).getId().getValue();
 129         final Eid eid = copyEid(remoteMappingContext.getEid(mappingId, ctx.getMappingContext()));
 130         final MappingsDumpParams dumpParams = new MappingsDumpParamsBuilder()
 131                 .setVni(Long.valueOf(vni).intValue())
 132                 .setEidSet(QuantityType.SPECIFIC)
 133                 .setEidType(getEidType(eid))
 134                 .setEid(getEidAsByteArray(eid))
 135                 .setPrefixLength(getPrefixLength(eid))
 136                 .setFilter(FilterType.REMOTE)
 137                 .build();
 138
 139         LOG.debug("Dumping data for LocalMappings(id={})", id);
 140         final Optional<LispEidTableDetailsReplyDump> replyOptional =
 141                 dumpManager.getDump(id, bindKey("SPECIFIC_" + remoteMappingId), ctx.getModificationCache(), dumpParams);
 142
 143         if (!replyOptional.isPresent() || replyOptional.get().lispEidTableDetails.isEmpty()) {
 144             return;
 145         }
 146
 147         LOG.debug("Valid dump loaded");
 148
 149         LispEidTableDetails details = replyOptional.get().lispEidTableDetails.stream()
 150                 .filter(subtableFilterForRemoteMappings(id))
 151                 .filter(a -> compareAddresses(eid.getAddress(),
 152                         getArrayAsEidLocal(valueOf(a.eidType), a.eid, a.vni).getAddress()))
 153                 .collect(
 154                         RWUtils.singleItemCollector());
 155
 156         builder.setEid(getArrayAsEidRemote(valueOf(details.eidType), details.eid, details.vni));
 157         builder.setKey(new RemoteMappingKey(new MappingId(id.firstKeyOf(RemoteMapping.class).getId())));
 158         builder.setTtl(resolveTtl(details.ttl));
 159         builder.setAuthoritative(
 160                 new RemoteMapping.Authoritative(byteToBoolean(details.authoritative)));
 161         resolverMappings(id, builder, details, ctx.getModificationCache());
 162     }
 163
 164     //compensate ~0 as default value of ttl
 165     private static long resolveTtl(final int ttlValue) {
 166         return ttlValue == -1
 167                 ? Integer.MAX_VALUE
 168                 : ttlValue;
 169     }
 170
 171     @Override
 172     public List<RemoteMappingKey> getAllIds(InstanceIdentifier<RemoteMapping> id, ReadContext context)
 173             throws ReadFailedException {
 174
 175         checkState(id.firstKeyOf(VniTable.class) != null, "Parent VNI table not specified");
 176         final int vni = id.firstKeyOf(VniTable.class).getVirtualNetworkIdentifier().intValue();
 177
 178         if (vni == 0) {
 179             // ignoring default vni mapping
 180             // it's not relevant for us and we also don't store mapping for such eid's
 181             // such mapping is used to create helper local mappings to process remote ones
 182             return Collections.emptyList();
 183         }
 184
 185         //requesting all remote with specific vni
 186         final MappingsDumpParams dumpParams = new MappingsDumpParamsBuilder()
 187                 .setEidSet(QuantityType.ALL)
 188                 .setFilter(FilterType.REMOTE)
 189                 .build();
 190
 191         LOG.debug("Dumping data for LocalMappings(id={})", id);
 192         final Optional<LispEidTableDetailsReplyDump> replyOptional =
 193                 dumpManager.getDump(id, bindKey("ALL_REMOTE"), context.getModificationCache(), dumpParams);
 194
 195         if (!replyOptional.isPresent() || replyOptional.get().lispEidTableDetails.isEmpty()) {
 196             return Collections.emptyList();
 197         }
 198
 199         return replyOptional.get()
 200                 .lispEidTableDetails
 201                 .stream()
 202                 .filter(a -> a.vni == vni)
 203                 .filter(subtableFilterForRemoteMappings(id))
 204                 .map(detail -> getArrayAsEidRemote(valueOf(detail.eidType), detail.eid, detail.vni))
 205                 .map(remoteEid -> remoteMappingContext.getId(remoteEid, context.getMappingContext()))
 206                 .map(MappingId::new)
 207                 .map(RemoteMappingKey::new)
 208                 .collect(Collectors.toList());
 209     }
 210
 211     @Override
 212     public void merge(Builder<? extends DataObject> builder, List<RemoteMapping> readData) {
 213         ((RemoteMappingsBuilder) builder).setRemoteMapping(readData);
 214     }
 215
 216     private String bindKey(String prefix) {
 217         return prefix + "_" + KEY;
 218     }
 219
 220     private void resolverMappings(final InstanceIdentifier id, final RemoteMappingBuilder builder,
 221                                   final LispEidTableDetails details,
 222                                   final ModificationCache cache) throws ReadFailedException {
 223
 224         if (details.action != 0) {
 225             // in this case ,negative action was defined
 226             bindNegativeMapping(builder, MapReplyAction.forValue(details.action));
 227         } else {
 228             // in this case, there is no clear determination whether negative action with NO_ACTION(value == 0) was defined,
 229             // or if its default value and remote locators, are defined, so only chance to determine so, is to dump locators for this mapping
 230
 231             // cache key needs to have locator set scope to not mix with cached data
 232             final Optional<LispLocatorDetailsReplyDump> reply;
 233             try {
 234                 reply = locatorsDumpManager.getDump(id, KEY + "_locator_set_" + details.locatorSetIndex, cache,
 235                         new LocatorDumpParamsBuilder().setLocatorSetIndex(details.locatorSetIndex).build());
 236             } catch (ReadFailedException e) {
 237                 throw new ReadFailedException(id,
 238                         new IllegalStateException("Unable to resolve Positive/Negative mapping for RemoteMapping",
 239                                 e.getCause()));
 240             }
 241
 242             if (!reply.isPresent() || reply.get().lispLocatorDetails.isEmpty()) {
 243                 // no remote locators exist, therefore there was NO_ACTION defined
 244                 bindNegativeMapping(builder, NoAction);
 245             } else {
 246                 // bind remote locators
 247                 bindPositiveMapping(builder, reply.get());
 248             }
 249         }
 250     }
 251
 252     private void bindNegativeMapping(final RemoteMappingBuilder builder,
 253                                      final MapReplyAction action) {
 254         builder.setLocatorList(
 255                 new NegativeMappingBuilder().setMapReply(new MapReplyBuilder().setMapReplyAction(action).build())
 256                         .build());
 257     }
 258
 259     private void bindPositiveMapping(final RemoteMappingBuilder builder, final LispLocatorDetailsReplyDump reply) {
 260         builder.setLocatorList(
 261                 new PositiveMappingBuilder()
 262                         .setRlocs(
 263                                 new RlocsBuilder()
 264                                         .setLocator(reply
 265                                                 .lispLocatorDetails
 266                                                 .stream()
 267                                                 .map(this::detailsToLocator)
 268                                                 .collect(Collectors.toList()))
 269                                         .build()
 270                         )
 271                         .build()
 272         );
 273     }
 274
 275     private Locator detailsToLocator(final LispLocatorDetails details) {
 276         final IpAddress address = arrayToIpAddressReversed(byteToBoolean(details.isIpv6), details.ipAddress);
 277         return new LocatorBuilder()
 278                 .setAddress(address)
 279                 .setKey(new LocatorKey(address))
 280                 .setPriority((short) details.priority)
 281                 .setWeight((short) details.weight)
 282                 .build();
 283     }
 284 }