bgp/path-selection-mode/src/main/java/org/opendaylight/protocol/bgp/mode/impl/add/OffsetMap.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.protocol.bgp.mode.impl.add;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.cache.CacheBuilder;
  12 import com.google.common.cache.CacheLoader;
  13 import com.google.common.cache.LoadingCache;
  14 import com.google.common.collect.ImmutableSet;
  15 import com.google.common.collect.ImmutableSet.Builder;
  16 import java.lang.reflect.Array;
  17 import java.util.Arrays;
  18 import java.util.Collections;
  19 import java.util.Comparator;
  20 import java.util.List;
  21 import java.util.Set;
  22 import java.util.stream.Collectors;
  23 import javax.annotation.Nonnull;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 /**
  28  * A map of Router identifier to an offset. Used to maintain a simple
  29  * offset-based lookup across multiple RouteEntry objects,
  30  * which share either contributors or consumers.
  31  * We also provide utility reformat methods, which provide access to
  32  * array members and array management features.
  33  */
  34 public final class OffsetMap {
  35     private static final Logger LOG = LoggerFactory.getLogger(OffsetMap.class);
  36     private static final String NEGATIVEOFFSET = "Invalid negative offset %s";
  37     private static final String INVALIDOFFSET = "Invalid offset %s for %s router IDs";
  38     private static final LoadingCache<Set<RouteKey>, OffsetMap> OFFSETMAPS = CacheBuilder.newBuilder().weakValues()
  39         .build(new CacheLoader<Set<RouteKey>, OffsetMap>() {
  40                 @Override
  41                 public OffsetMap load(@Nonnull final Set<RouteKey> key) {
  42                     return new OffsetMap(key);
  43                 }
  44             });
  45     private static final Comparator<RouteKey> COMPARATOR = RouteKey::compareTo;
  46     static final OffsetMap EMPTY = new OffsetMap(Collections.emptySet());
  47
  48     private final RouteKey[] routeKeys;
  49
  50     private OffsetMap(final Set<RouteKey> routerIds) {
  51         final RouteKey[] array = routerIds.toArray(new RouteKey[0]);
  52         Arrays.sort(array, COMPARATOR);
  53         this.routeKeys = array;
  54     }
  55
  56     public int offsetOf(final RouteKey key) {
  57         return Arrays.binarySearch(this.routeKeys, key, COMPARATOR);
  58     }
  59
  60     public int size() {
  61         return this.routeKeys.length;
  62     }
  63
  64     public OffsetMap with(final RouteKey key) {
  65         // TODO: we could make this faster if we had an array-backed Set and requiring
  66         //       the caller to give us the result of offsetOf() -- as that indicates
  67         //       where to insert the new routerId while maintaining the sorted nature
  68         //       of the array
  69         final Builder<RouteKey> builder = ImmutableSet.builder();
  70         builder.add(this.routeKeys);
  71         builder.add(key);
  72
  73         return OFFSETMAPS.getUnchecked(builder.build());
  74     }
  75
  76     public OffsetMap without(final RouteKey key) {
  77         final Builder<RouteKey> builder = ImmutableSet.builder();
  78         final int index = indexOfRouterId(key);
  79         if (index < 0) {
  80             LOG.trace("Router key not found", key);
  81         } else {
  82             builder.add(removeValue(this.routeKeys, index));
  83         }
  84         return OFFSETMAPS.getUnchecked(builder.build());
  85     }
  86
  87     private int indexOfRouterId(final RouteKey key) {
  88         for (int i = 0; i < this.routeKeys.length; i++) {
  89             if (key.equals(this.routeKeys[i])) {
  90                 return i;
  91             }
  92         }
  93         return -1;
  94     }
  95
  96     public <T> T getValue(final T[] array, final int offset) {
  97         Preconditions.checkArgument(offset >= 0, NEGATIVEOFFSET, offset);
  98         Preconditions.checkArgument(offset < this.routeKeys.length, INVALIDOFFSET, offset, this.routeKeys.length);
  99         return array[offset];
 100     }
 101
 102     public <T> void setValue(final T[] array, final int offset, final T value) {
 103         Preconditions.checkArgument(offset >= 0, NEGATIVEOFFSET, offset);
 104         Preconditions.checkArgument(offset < this.routeKeys.length, INVALIDOFFSET, offset, this.routeKeys.length);
 105         array[offset] = value;
 106     }
 107
 108     public <T> T[] expand(final OffsetMap oldOffsets, final T[] oldArray, final int offset) {
 109         @SuppressWarnings("unchecked")
 110         final T[] ret = (T[]) Array.newInstance(oldArray.getClass().getComponentType(), this.routeKeys.length);
 111         final int oldSize = oldOffsets.routeKeys.length;
 112
 113         System.arraycopy(oldArray, 0, ret, 0, offset);
 114         System.arraycopy(oldArray, offset, ret, offset + 1, oldSize - offset);
 115
 116         return ret;
 117     }
 118
 119     public <T> T[] removeValue(final T[] oldArray, final int offset) {
 120         final int length = oldArray.length;
 121         Preconditions.checkArgument(offset >= 0, NEGATIVEOFFSET, offset);
 122         Preconditions.checkArgument(offset < this.routeKeys.length, INVALIDOFFSET, offset, length);
 123
 124         final T[] ret = (T[]) Array.newInstance(oldArray.getClass().getComponentType(), length - 1);
 125         System.arraycopy(oldArray, 0, ret, 0, offset);
 126         if (offset < length - 1) {
 127             System.arraycopy(oldArray, offset + 1, ret, offset, length - offset - 1);
 128         }
 129
 130         return ret;
 131     }
 132
 133     boolean isEmpty() {
 134         return this.size() == 0;
 135     }
 136
 137     public List<RouteKey> getRouteKeysList() {
 138         return Arrays.stream(this.routeKeys).collect(Collectors.toList());
 139     }
 140 }