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