lisp/lisp2vpp/src/main/java/io/fd/honeycomb/lisp/translate/read/LocalMappingCustomizer.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 io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams.QuantityType;
  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.check.MappingsDumpCheck;
  29 import io.fd.honeycomb.lisp.translate.read.dump.executor.MappingsDumpExecutor;
  30 import io.fd.honeycomb.lisp.translate.read.dump.executor.params.MappingsDumpParams;
  31 import io.fd.honeycomb.lisp.translate.util.EidTranslator;
  32 import io.fd.honeycomb.translate.read.ReadContext;
  33 import io.fd.honeycomb.translate.read.ReadFailedException;
  34 import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
  35 import io.fd.honeycomb.translate.util.RWUtils;
  36 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
  37 import io.fd.honeycomb.translate.util.read.cache.exceptions.execution.DumpExecutionFailedException;
  38 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  39 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  40 import java.util.Collections;
  41 import java.util.List;
  42 import java.util.stream.Collectors;
  43 import javax.annotation.Nonnull;
  44 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.mappings.mapping.Eid;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev160520.MappingId;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev160520.eid.table.grouping.eid.table.VniTable;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev160520.eid.table.grouping.eid.table.vni.table.LocalMappingsBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev160520.eid.table.grouping.eid.table.vni.table.local.mappings.LocalMapping;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev160520.eid.table.grouping.eid.table.vni.table.local.mappings.LocalMappingBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev160520.eid.table.grouping.eid.table.vni.table.local.mappings.LocalMappingKey;
  51 import org.opendaylight.yangtools.concepts.Builder;
  52 import org.opendaylight.yangtools.yang.binding.DataObject;
  53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  54 import org.openvpp.jvpp.core.dto.LispEidTableDetails;
  55 import org.openvpp.jvpp.core.dto.LispEidTableDetailsReplyDump;
  56 import org.openvpp.jvpp.core.future.FutureJVppCore;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 /**
  61  * Customizer for reading {@code LocalMapping}<br> Currently unsupported by jvpp
  62  */
  63 public class LocalMappingCustomizer
  64         extends FutureJVppCustomizer
  65         implements ListReaderCustomizer<LocalMapping, LocalMappingKey, LocalMappingBuilder>, EidTranslator {
  66
  67     private static final Logger LOG = LoggerFactory.getLogger(LocalMappingCustomizer.class);
  68     private static final String KEY = LocalMappingCustomizer.class.getName();
  69
  70     private final DumpCacheManager<LispEidTableDetailsReplyDump, MappingsDumpParams> dumpManager;
  71     private final MappingsDumpExecutor dumpExecutor;
  72     private final NamingContext locatorSetContext;
  73     private final EidMappingContext localMappingContext;
  74
  75     public LocalMappingCustomizer(@Nonnull FutureJVppCore futureJvpp, @Nonnull NamingContext locatorSetContext,
  76                                   @Nonnull EidMappingContext localMappingsContext) {
  77         super(futureJvpp);
  78         this.locatorSetContext = checkNotNull(locatorSetContext, "Locator Set Mapping Context cannot be null");
  79         this.localMappingContext = checkNotNull(localMappingsContext, "Local mappings context cannot be null");
  80         this.dumpExecutor = new MappingsDumpExecutor(futureJvpp);
  81         this.dumpManager =
  82                 new DumpCacheManager.DumpCacheManagerBuilder<LispEidTableDetailsReplyDump, MappingsDumpParams>()
  83                         .withExecutor(dumpExecutor)
  84                         .withNonEmptyPredicate(new MappingsDumpCheck())
  85                         .build();
  86     }
  87
  88
  89     @Override
  90     public LocalMappingBuilder getBuilder(InstanceIdentifier<LocalMapping> id) {
  91         return new LocalMappingBuilder();
  92     }
  93
  94     @Override
  95     public void readCurrentAttributes(InstanceIdentifier<LocalMapping> id, LocalMappingBuilder builder,
  96                                       ReadContext ctx) throws ReadFailedException {
  97         checkState(id.firstKeyOf(LocalMapping.class) != null, "No key present for id({})", id);
  98         checkState(id.firstKeyOf(VniTable.class) != null, "Parent VNI table not specified");
  99
 100         //checks whether there is an existing mapping
 101         final MappingId mappingId = id.firstKeyOf(LocalMapping.class).getId();
 102         checkState(localMappingContext.containsEid(mappingId, ctx.getMappingContext()));
 103
 104         final long vni = id.firstKeyOf(VniTable.class).getVirtualNetworkIdentifier();
 105
 106         final String localMappingId = id.firstKeyOf(LocalMapping.class).getId().getValue();
 107         final Eid eid = localMappingContext.getEid(mappingId, ctx.getMappingContext());
 108
 109         //Requesting for specific mapping dump,only from local mappings with specified eid/vni/eid type
 110         final MappingsDumpParams dumpParams = new MappingsDumpParams.MappingsDumpParamsBuilder()
 111                 .setEidSet(QuantityType.SPECIFIC)
 112                 .setVni(Long.valueOf(vni).intValue())
 113                 .setEid(getEidAsByteArray(eid))
 114                 .setEidType(getEidType(eid))
 115                 .setPrefixLength(getPrefixLength(eid))
 116                 .build();
 117
 118         LOG.debug("Dumping data for LocalMappings(id={})", id);
 119         Optional<LispEidTableDetailsReplyDump> replyOptional;
 120
 121         try {
 122             replyOptional =
 123                     dumpManager.getDump(bindKey("SPECIFIC_" + localMappingId), ctx.getModificationCache(), dumpParams);
 124         } catch (DumpExecutionFailedException e) {
 125             throw new ReadFailedException(id, e);
 126         }
 127
 128         if (replyOptional.isPresent()) {
 129             LOG.debug("Valid dump loaded");
 130
 131             LispEidTableDetails details = replyOptional.get().lispEidTableDetails.stream()
 132                     .filter(a -> compareAddresses(eid.getAddress(),
 133                             getArrayAsEidLocal(valueOf(a.eidType), a.eid).getAddress()))
 134                     .collect(
 135                             RWUtils.singleItemCollector());
 136
 137             //in case of local mappings,locator_set_index stands for interface index
 138             checkState(locatorSetContext.containsName(details.locatorSetIndex, ctx.getMappingContext()),
 139                     "No Locator Set name found for index %s", details.locatorSetIndex);
 140             builder.setLocatorSet(locatorSetContext.getName(details.locatorSetIndex, ctx.getMappingContext()));
 141             builder.setKey(new LocalMappingKey(new MappingId(id.firstKeyOf(LocalMapping.class).getId())));
 142             builder.setEid(getArrayAsEidLocal(valueOf(details.eidType), details.eid));
 143         } else {
 144             LOG.debug("No data dumped");
 145         }
 146     }
 147
 148     @Override
 149     public List<LocalMappingKey> getAllIds(InstanceIdentifier<LocalMapping> id, ReadContext context)
 150             throws ReadFailedException {
 151
 152         checkState(id.firstKeyOf(VniTable.class) != null, "Parent VNI table not specified");
 153         final long vni = id.firstKeyOf(VniTable.class).getVirtualNetworkIdentifier();
 154
 155         if (vni == 0) {
 156             // ignoring default vni mapping
 157             // its not relevant for us and we also don't store mapping for such eid's
 158             // such mapping is used to create helper local mappings to process remote ones
 159             return Collections.emptyList();
 160         }
 161
 162         //request for all local mappings
 163         final MappingsDumpParams dumpParams = new MappingsDumpParamsBuilder()
 164                 .setFilter(FilterType.LOCAL)
 165                 .setEidSet(QuantityType.ALL)
 166                 .build();
 167
 168         LOG.debug("Dumping data for LocalMappings(id={})", id);
 169         Optional<LispEidTableDetailsReplyDump> replyOptional;
 170         try {
 171             replyOptional = dumpManager.getDump(bindKey("ALL_LOCAL"), context.getModificationCache(), dumpParams);
 172         } catch (DumpExecutionFailedException e) {
 173             throw new ReadFailedException(id, e);
 174         }
 175
 176         if (replyOptional.isPresent()) {
 177             LOG.debug("Valid dump loaded");
 178             return replyOptional.get().lispEidTableDetails.stream()
 179                     //filtering with vni to skip help local mappings that are created in vpp to handle remote mappings(vpp feature)
 180                     .filter(a -> a.vni == vni)
 181                     .map(a -> new LocalMappingKey(
 182                             new MappingId(
 183                                     localMappingContext.getId(
 184                                             getArrayAsEidLocal(valueOf(a.eidType), a.eid),
 185                                             context.getMappingContext()))))
 186                     .collect(Collectors.toList());
 187         } else {
 188             LOG.debug("No data dumped");
 189             return Collections.emptyList();
 190         }
 191     }
 192
 193     @Override
 194     public void merge(Builder<? extends DataObject> builder, List<LocalMapping> readData) {
 195         ((LocalMappingsBuilder) builder).setLocalMapping(readData);
 196     }
 197
 198     private static String bindKey(String prefix) {
 199         return prefix + "_" + KEY;
 200     }
 201 }