com.netease.arctic.utils.map.SimpleSpillableMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arctic-spark-3.1-runtime Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.netease.arctic.utils.map;

import com.netease.arctic.utils.SerializationUtils;
import com.netease.arctic.shade.org.apache.iceberg.relocated.com.google.common.collect.Maps;

import javax.annotation.Nullable;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;

public class SimpleSpillableMap implements SimpleMap {

  private static final int RECORDS_TO_SKIP_FOR_ESTIMATING = 200;
  private final long maxInMemorySizeInBytes;
  private final String backendBaseDir;
  // Size Estimator for key type
  private final SizeEstimator keySizeEstimator;
  // Size Estimator for key types
  private final SizeEstimator valueSizeEstimator;
  private Map memoryMap;
  private Optional> diskBasedMap = Optional.empty();
  private long currentInMemoryMapSize;
  private long estimatedPayloadSize = 0;
  private int putCount = 0;

  private final SerializationUtils.SimpleSerializer keySerializer;

  private final SerializationUtils.SimpleSerializer valueSerializer;

  protected SimpleSpillableMap(Long maxInMemorySizeInBytes,
                               @Nullable String backendBaseDir,
                               SizeEstimator keySizeEstimator,
                               SizeEstimator valueSizeEstimator) {
    this(maxInMemorySizeInBytes, backendBaseDir,
        SerializationUtils.JavaSerializer.INSTANT,
        SerializationUtils.JavaSerializer.INSTANT,
        keySizeEstimator, valueSizeEstimator);
  }

  protected SimpleSpillableMap(Long maxInMemorySizeInBytes,
                               @Nullable String backendBaseDir,
                               SerializationUtils.SimpleSerializer keySerializer,
                               SerializationUtils.SimpleSerializer valueSerializer,
                               SizeEstimator keySizeEstimator,
                               SizeEstimator valueSizeEstimator) {
    this.memoryMap = Maps.newHashMap();
    this.maxInMemorySizeInBytes = maxInMemorySizeInBytes;
    this.backendBaseDir = backendBaseDir;
    this.currentInMemoryMapSize = 0L;
    this.keySerializer = keySerializer;
    this.valueSerializer = valueSerializer;
    this.keySizeEstimator = keySizeEstimator;
    this.valueSizeEstimator = valueSizeEstimator;
  }

  /**
   * Number of bytes spilled to disk.
   */
  public long getSizeOfFileOnDiskInBytes() {
    return diskBasedMap.map(SimpleSpilledMap::sizeOfFileOnDiskInBytes).orElse(0L);
  }

  /**
   * Number of entries in InMemoryMap.
   */
  public int getMemoryMapSize() {
    return memoryMap.size();
  }

  /**
   * Approximate memory footprint of the in-memory map.
   */
  public long getMemoryMapSpaceSize() {
    return currentInMemoryMapSize;
  }

  public boolean containsKey(K key) {
    return memoryMap.containsKey(key) ||
            diskBasedMap.map(diskMap -> diskMap.containsKey(key)).orElse(false);
  }

  public T get(K key) {
    return Optional.ofNullable(memoryMap.get(key))
            .orElse(diskBasedMap.map(diskMap -> diskMap.get(key)).orElse(null));
  }

  public void put(K key, T value) {
    if (estimatedPayloadSize == 0) {
      this.estimatedPayloadSize = keySizeEstimator.sizeEstimate(key) + valueSizeEstimator.sizeEstimate(value);
    } else if (++putCount % RECORDS_TO_SKIP_FOR_ESTIMATING == 0) {
      this.estimatedPayloadSize = (long) (this.estimatedPayloadSize * 0.9 +
              (keySizeEstimator.sizeEstimate(key) + valueSizeEstimator.sizeEstimate(value)) * 0.1);
      this.currentInMemoryMapSize = this.memoryMap.size() * this.estimatedPayloadSize;
    }

    if (this.currentInMemoryMapSize < maxInMemorySizeInBytes) {
      if (memoryMap.put(key, value) == null) {
        currentInMemoryMapSize += this.estimatedPayloadSize;
      }
    } else {
      if (!diskBasedMap.isPresent()) {
        diskBasedMap = Optional.of(new SimpleSpilledMap<>(keySerializer, valueSerializer, backendBaseDir));
      }
      diskBasedMap.get().put(key, value);
    }
  }

  public void delete(K key) {
    if (memoryMap.containsKey(key)) {
      currentInMemoryMapSize -= estimatedPayloadSize;
      memoryMap.remove(key);
    } else {
      diskBasedMap.ifPresent(map -> map.delete(key));
    }
  }

  public void close() {
    memoryMap = null;
    diskBasedMap.ifPresent(SimpleSpilledMap::close);
    currentInMemoryMapSize = 0L;
  }

  protected class SimpleSpilledMap
          implements SimpleMap {

    private final RocksDBBackend rocksDB;

    private final String columnFamily = UUID.randomUUID().toString();

    private SerializationUtils.SimpleSerializer keySerializer;

    private SerializationUtils.SimpleSerializer valueSerializer;

    public SimpleSpilledMap(SerializationUtils.SimpleSerializer keySerializer,
                            SerializationUtils.SimpleSerializer valueSerializer,
                            @Nullable String backendBaseDir) {
      rocksDB = RocksDBBackend.getOrCreateInstance(backendBaseDir);
      rocksDB.addColumnFamily(columnFamily);
      this.keySerializer = keySerializer;
      this.valueSerializer = valueSerializer;
    }

    public boolean containsKey(K key) {
      return rocksDB.get(columnFamily, keySerializer.serialize(key)) != null;
    }

    public T get(K key) {
      return valueSerializer.deserialize(rocksDB.get(columnFamily, keySerializer.serialize(key)));
    }

    public void put(K key, T value) {
      rocksDB.put(columnFamily, keySerializer.serialize(key), valueSerializer.serialize(value));
    }

    public void delete(K key) {
      rocksDB.delete(columnFamily, keySerializer.serialize(key));
    }

    public void close() {
      rocksDB.dropColumnFamily(columnFamily);
    }

    public long sizeOfFileOnDiskInBytes() {
      return rocksDB.getTotalBytesWritten();
    }
  }
}