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