com.hazelcast.map.impl.eviction.EvictionCheckerImpl Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2015, Hazelcast, Inc. All Rights Reserved.
*
* Licensed 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.hazelcast.map.impl.eviction;
import com.hazelcast.config.MaxSizeConfig;
import com.hazelcast.config.MaxSizeConfig.MaxSizePolicy;
import com.hazelcast.map.impl.MapContainer;
import com.hazelcast.map.impl.MapServiceContext;
import com.hazelcast.map.impl.PartitionContainer;
import com.hazelcast.map.impl.recordstore.RecordStore;
import com.hazelcast.nio.Address;
import com.hazelcast.partition.InternalPartition;
import com.hazelcast.partition.InternalPartitionService;
import com.hazelcast.spi.NodeEngine;
import com.hazelcast.util.MemoryInfoAccessor;
import com.hazelcast.util.RuntimeMemoryInfoAccessor;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* Checks whether a specific threshold is exceeded or not
* according to configured {@link com.hazelcast.config.MaxSizeConfig.MaxSizePolicy}
* to start eviction process.
*
* @see EvictorImpl#evictionChecker
*/
public class EvictionCheckerImpl implements EvictionChecker {
protected static final int ONE_HUNDRED_PERCENT = 100;
protected static final int EVICTION_START_THRESHOLD_PERCENTAGE = 95;
protected static final int ONE_KILOBYTE = 1024;
protected static final int ONE_MEGABYTE = ONE_KILOBYTE * ONE_KILOBYTE;
protected final MapServiceContext mapServiceContext;
// not final for testing purposes.
protected MemoryInfoAccessor memoryInfoAccessor;
public EvictionCheckerImpl(MapServiceContext mapServiceContext) {
this.memoryInfoAccessor = new RuntimeMemoryInfoAccessor();
this.mapServiceContext = mapServiceContext;
}
@Override
public boolean checkEvictionPossible(RecordStore recordStore) {
String mapName = recordStore.getName();
int partitionId = recordStore.getPartitionId();
MapContainer mapContainer = recordStore.getMapContainer();
MaxSizeConfig maxSizeConfig = mapContainer.getMapConfig().getMaxSizeConfig();
MaxSizeConfig.MaxSizePolicy maxSizePolicy = maxSizeConfig.getMaxSizePolicy();
boolean result;
switch (maxSizePolicy) {
case PER_NODE:
result = checkPerNodeEviction(mapName, maxSizeConfig);
break;
case PER_PARTITION:
result = checkPerPartitionEviction(mapName, maxSizeConfig, partitionId);
break;
case USED_HEAP_PERCENTAGE:
result = checkHeapPercentageEviction(mapName, maxSizeConfig);
break;
case USED_HEAP_SIZE:
result = checkHeapSizeEviction(mapName, maxSizeConfig);
break;
case FREE_HEAP_PERCENTAGE:
result = checkFreeHeapPercentageEviction(maxSizeConfig);
break;
case FREE_HEAP_SIZE:
result = checkFreeHeapSizeEviction(maxSizeConfig);
break;
default:
throw new IllegalArgumentException("Not an appropriate max size policy [" + maxSizePolicy + ']');
}
return result;
}
protected boolean checkPerNodeEviction(String mapName, MaxSizeConfig maxSizeConfig) {
long nodeTotalSize = 0;
final double maxSize = getApproximateMaxSize(maxSizeConfig.getSize());
final List partitionIds = findPartitionIds();
for (int partitionId : partitionIds) {
final PartitionContainer container = mapServiceContext.getPartitionContainer(partitionId);
if (container == null) {
continue;
}
nodeTotalSize += getRecordStoreSize(mapName, container);
if (nodeTotalSize >= maxSize) {
return true;
}
}
return false;
}
protected boolean checkPerPartitionEviction(String mapName, MaxSizeConfig maxSizeConfig, int partitionId) {
final double maxSize = getApproximateMaxSize(maxSizeConfig.getSize());
final PartitionContainer container = mapServiceContext.getPartitionContainer(partitionId);
if (container == null) {
return false;
}
final int size = getRecordStoreSize(mapName, container);
return size >= maxSize;
}
protected boolean checkHeapSizeEviction(String mapName, MaxSizeConfig maxSizeConfig) {
final long usedHeapSize = getUsedHeapSize(mapName);
if (usedHeapSize == -1L) {
return false;
}
final double maxSize = getApproximateMaxSize(maxSizeConfig.getSize());
return maxSize < (1D * usedHeapSize / ONE_MEGABYTE);
}
protected boolean checkFreeHeapSizeEviction(MaxSizeConfig maxSizeConfig) {
final long currentFreeHeapSize = getAvailableMemory();
final double minFreeHeapSize = getApproximateMaxSize(maxSizeConfig.getSize());
return minFreeHeapSize > (1D * currentFreeHeapSize / ONE_MEGABYTE);
}
protected boolean checkHeapPercentageEviction(String mapName, MaxSizeConfig maxSizeConfig) {
final long usedHeapSize = getUsedHeapSize(mapName);
if (usedHeapSize == -1L) {
return false;
}
final double maxSize = getApproximateMaxSize(maxSizeConfig.getSize());
final long total = getTotalMemory();
return maxSize < (1D * ONE_HUNDRED_PERCENT * usedHeapSize / total);
}
protected boolean checkFreeHeapPercentageEviction(MaxSizeConfig maxSizeConfig) {
final long currentFreeHeapSize = getAvailableMemory();
final double freeHeapPercentage = getApproximateMaxSize(maxSizeConfig.getSize());
final long total = getTotalMemory();
return freeHeapPercentage > (1D * ONE_HUNDRED_PERCENT * currentFreeHeapSize / total);
}
protected long getTotalMemory() {
return memoryInfoAccessor.getTotalMemory();
}
protected long getFreeMemory() {
return memoryInfoAccessor.getFreeMemory();
}
protected long getMaxMemory() {
return memoryInfoAccessor.getMaxMemory();
}
protected long getAvailableMemory() {
final long totalMemory = getTotalMemory();
final long freeMemory = getFreeMemory();
final long maxMemory = getMaxMemory();
return freeMemory + (maxMemory - totalMemory);
}
protected long getUsedHeapSize(String mapName) {
long heapCost = 0L;
final List partitionIds = findPartitionIds();
for (int partitionId : partitionIds) {
final PartitionContainer container = mapServiceContext.getPartitionContainer(partitionId);
if (container == null) {
continue;
}
heapCost += getRecordStoreHeapCost(mapName, container);
}
MapContainer mapContainer = mapServiceContext.getMapContainer(mapName);
heapCost += mapContainer.getNearCacheSizeEstimator().getSize();
return heapCost;
}
protected int getRecordStoreSize(String mapName, PartitionContainer partitionContainer) {
final RecordStore existingRecordStore = partitionContainer.getExistingRecordStore(mapName);
if (existingRecordStore == null) {
return 0;
}
return existingRecordStore.size();
}
protected long getRecordStoreHeapCost(String mapName, PartitionContainer partitionContainer) {
final RecordStore existingRecordStore = partitionContainer.getExistingRecordStore(mapName);
if (existingRecordStore == null) {
return 0L;
}
return existingRecordStore.getHeapCost();
}
/**
* used when deciding evictable or not.
*/
protected static double getApproximateMaxSize(int maxSizeFromConfig) {
// because not to exceed the max size much we start eviction early.
// so decrease the max size with ratio .95 below
return 1D * maxSizeFromConfig * EVICTION_START_THRESHOLD_PERCENTAGE / ONE_HUNDRED_PERCENT;
}
/**
* Get max size setting form config for given policy
*
* @return max size or -1 if policy is different or not set
*/
public static double getApproximateMaxSize(MaxSizeConfig maxSizeConfig, MaxSizePolicy policy) {
if (maxSizeConfig.getMaxSizePolicy() == policy) {
return getApproximateMaxSize(maxSizeConfig.getSize());
}
return -1D;
}
protected List findPartitionIds() {
final NodeEngine nodeEngine = mapServiceContext.getNodeEngine();
final InternalPartitionService partitionService = nodeEngine.getPartitionService();
final int partitionCount = partitionService.getPartitionCount();
List partitionIds = null;
for (int partitionId = 0; partitionId < partitionCount; partitionId++) {
if (isOwnerOrBackup(partitionId)) {
if (partitionIds == null) {
partitionIds = new ArrayList();
}
partitionIds.add(partitionId);
}
}
return partitionIds == null ? Collections.emptyList() : partitionIds;
}
protected boolean isOwnerOrBackup(int partitionId) {
final NodeEngine nodeEngine = mapServiceContext.getNodeEngine();
final InternalPartitionService partitionService = nodeEngine.getPartitionService();
final InternalPartition partition = partitionService.getPartition(partitionId, false);
final Address thisAddress = nodeEngine.getThisAddress();
return partition.isOwnerOrBackup(thisAddress);
}
// only used when testing.
public void setMemoryInfoAccessor(MemoryInfoAccessor memoryInfoAccessor) {
this.memoryInfoAccessor = memoryInfoAccessor;
}
}