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