apache / carbondata / 323

Build # 323

Build Type

push

jenkins

Committed by GitHub

Commit Message

<a href="https://github.com/apache/carbondata/commit/<a class=hub.com/apache/carbondata/commit/5f8423a5bc595b2365f95f226609fb0edf3d4818">5f8423a5b<a href="https://github.com/apache/carbondata/commit/5f8423a5bc595b2365f95f226609fb0edf3d4818">">Merge </a><a class="double-link" href="https://github.com/apache/carbondata/commit/<a class="double-link" href="https://github.com/apache/carbondata/commit/08fc944f7b1a74f326bc8315f8bf5511a1940b60">08fc944f7</a>">08fc944f7</a><a href="https://github.com/apache/carbondata/commit/5f8423a5bc595b2365f95f226609fb0edf3d4818"> into b6bd90d80">b6bd90d80</a>

Run Details

44 of 44 new or added lines in 1 file covered. (100.0%)

57928 of 71882 relevant lines covered (80.59%)

1.07 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.3

/core/src/main/java/org/apache/carbondata/core/cache/CacheProvider.java

/*
 * 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 org.apache.carbondata.core.cache;

import java.lang.reflect.Constructor;
import java.util.HashMap;
import java.util.Map;

import org.apache.carbondata.common.logging.LogService;
import org.apache.carbondata.common.logging.LogServiceFactory;
import org.apache.carbondata.core.cache.dictionary.Dictionary;
import org.apache.carbondata.core.cache.dictionary.DictionaryColumnUniqueIdentifier;
import org.apache.carbondata.core.cache.dictionary.ForwardDictionaryCache;
import org.apache.carbondata.core.cache.dictionary.ReverseDictionaryCache;
import org.apache.carbondata.core.constants.CarbonCommonConstants;
import org.apache.carbondata.core.indexstore.BlockletDataMapIndexStore;
import org.apache.carbondata.core.util.CarbonProperties;

/**
 * Cache provider class which will create a cache based on given type
 */
public class CacheProvider {

  /**
   * cache provider instance
   */
  private static CacheProvider cacheProvider = new CacheProvider();

  /**
   * a map that will hold the entry for cache type to cache object mapping
   */
  private Map<CacheType, Cache> cacheTypeToCacheMap =
      new HashMap<>(CarbonCommonConstants.DEFAULT_COLLECTION_SIZE);

  /**
   * object lock instance to be used in synchronization block
   */
  private final Object lock = new Object();
  /**
   * LRU cache instance
   */
  private CarbonLRUCache carbonLRUCache;

  /**
   * instance for CacheProvider LOGGER
   */
  private static final LogService LOGGER =
      LogServiceFactory.getLogService(CacheProvider.class.getName());

  /**
   * private constructor to follow singleton design pattern for this class
   */
  private CacheProvider() {

  }

  /**
   * @return cache provider instance
   */
  public static CacheProvider getInstance() {
    return cacheProvider;
  }

  /**
   * This method will check if a cache already exists for given cache type and create in case
   * it is not present in the map
   *
   * @param cacheType       type of cache
   * @param <K>
   * @param <V>
   * @return
   */
  public <K, V> Cache<K, V> createCache(CacheType cacheType) {
    //check if lru cache is null, if null create one
    //check if cache is null for given cache type, if null create one
    if (!dictionaryCacheAlreadyExists(cacheType)) {
      synchronized (lock) {
        if (!dictionaryCacheAlreadyExists(cacheType)) {
          if (null == carbonLRUCache) {
            createLRULevelCacheInstance();
          }
          createDictionaryCacheForGivenType(cacheType);
        }
      }
    }
    return cacheTypeToCacheMap.get(cacheType);
  }

  /**
   * This method will check if a cache already exists for given cache type and store
   * if it is not present in the map
   */
  public <K, V> Cache<K, V> createCache(CacheType cacheType, String cacheClassName)
      throws Exception {
    //check if lru cache is null, if null create one
    //check if cache is null for given cache type, if null create one
    if (!dictionaryCacheAlreadyExists(cacheType)) {
      synchronized (lock) {
        if (!dictionaryCacheAlreadyExists(cacheType)) {
          if (null == carbonLRUCache) {
            createLRULevelCacheInstance();
          }
          Class<?> clazz = Class.forName(cacheClassName);
          Constructor<?> constructor = clazz.getConstructors()[0];
          constructor.setAccessible(true);
          Cache cacheObject = (Cache) constructor.newInstance(carbonLRUCache);
          cacheTypeToCacheMap.put(cacheType, cacheObject);
        }
      }
    }
    return cacheTypeToCacheMap.get(cacheType);
  }

  /**
   * This method will create the cache for given cache type
   *
   * @param cacheType       type of cache
   */
  private void createDictionaryCacheForGivenType(CacheType cacheType) {
    Cache cacheObject = null;
    if (cacheType.equals(CacheType.REVERSE_DICTIONARY)) {
      cacheObject =
          new ReverseDictionaryCache<DictionaryColumnUniqueIdentifier, Dictionary>(carbonLRUCache);
    } else if (cacheType.equals(CacheType.FORWARD_DICTIONARY)) {
      cacheObject =
          new ForwardDictionaryCache<DictionaryColumnUniqueIdentifier, Dictionary>(carbonLRUCache);
    } else if (cacheType.equals(cacheType.DRIVER_BLOCKLET_DATAMAP)) {
      cacheObject = new BlockletDataMapIndexStore(carbonLRUCache);
    }
    cacheTypeToCacheMap.put(cacheType, cacheObject);
  }

  /**
   * This method will create the lru cache instance based on the given type
   *
   */
  private void createLRULevelCacheInstance() {
    boolean isDriver = Boolean.parseBoolean(CarbonProperties.getInstance()
        .getProperty(CarbonCommonConstants.IS_DRIVER_INSTANCE, "false"));
    if (isDriver) {
      carbonLRUCache = new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_DRIVER_LRU_CACHE_SIZE,
          CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
    } else {
      // if executor cache size is not configured then driver cache conf will be used
      String executorCacheSize = CarbonProperties.getInstance()
          .getProperty(CarbonCommonConstants.CARBON_MAX_EXECUTOR_LRU_CACHE_SIZE);
      if (null != executorCacheSize) {
        carbonLRUCache =
            new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_EXECUTOR_LRU_CACHE_SIZE,
                CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
      } else {
        LOGGER.info(
            "Executor LRU cache size not configured. Initializing with driver LRU cache size.");
        carbonLRUCache = new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_DRIVER_LRU_CACHE_SIZE,
            CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
      }
    }
  }

  /**
   * This method will check whether the map already has an entry for
   * given cache type
   *
   * @param cacheType
   * @return
   */
  private boolean dictionaryCacheAlreadyExists(CacheType cacheType) {
    return null != cacheTypeToCacheMap.get(cacheType);
  }

  /**
   * Below method will be used to clear the cache
   */
  public void dropAllCache() {
    if (null != carbonLRUCache) {
      carbonLRUCache.clear();
      carbonLRUCache = null;
    }
    cacheTypeToCacheMap.clear();
  }
}

1	/*
2	* Licensed to the Apache Software Foundation (ASF) under one or more
3	* contributor license agreements. See the NOTICE file distributed with
4	* this work for additional information regarding copyright ownership.
5	* The ASF licenses this file to You under the Apache License, Version 2.0
6	* (the "License"); you may not use this file except in compliance with
7	* the License. You may obtain a copy of the License at
8	*
9	* http://www.apache.org/licenses/LICENSE-2.0
10	*
11	* Unless required by applicable law or agreed to in writing, software
12	* distributed under the License is distributed on an "AS IS" BASIS,
13	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14	* See the License for the specific language governing permissions and
15	* limitations under the License.
16	*/
17
18	package org.apache.carbondata.core.cache;
19
20	import java.lang.reflect.Constructor;
21	import java.util.HashMap;
22	import java.util.Map;
23
24	import org.apache.carbondata.common.logging.LogService;
25	import org.apache.carbondata.common.logging.LogServiceFactory;
26	import org.apache.carbondata.core.cache.dictionary.Dictionary;
27	import org.apache.carbondata.core.cache.dictionary.DictionaryColumnUniqueIdentifier;
28	import org.apache.carbondata.core.cache.dictionary.ForwardDictionaryCache;
29	import org.apache.carbondata.core.cache.dictionary.ReverseDictionaryCache;
30	import org.apache.carbondata.core.constants.CarbonCommonConstants;
31	import org.apache.carbondata.core.indexstore.BlockletDataMapIndexStore;
32	import org.apache.carbondata.core.util.CarbonProperties;
33
34	/**
35	* Cache provider class which will create a cache based on given type
36	*/
37	public class CacheProvider {
38
39	/**
40	* cache provider instance
41	*/
42	private static CacheProvider cacheProvider = new CacheProvider();	2✔
43
44	/**
45	* a map that will hold the entry for cache type to cache object mapping
46	*/
47	private Map<CacheType, Cache> cacheTypeToCacheMap =	2✔
48	new HashMap<>(CarbonCommonConstants.DEFAULT_COLLECTION_SIZE);
49
50	/**
51	* object lock instance to be used in synchronization block
52	*/
53	private final Object lock = new Object();	2✔
54	/**
55	* LRU cache instance
56	*/
57	private CarbonLRUCache carbonLRUCache;
58
59	/**
60	* instance for CacheProvider LOGGER
61	*/
62	private static final LogService LOGGER =	2✔
63	LogServiceFactory.getLogService(CacheProvider.class.getName());	2✔
64
65	/**
66	* private constructor to follow singleton design pattern for this class
67	*/
68	private CacheProvider() {	2✔
69
70	}	2✔
71
72	/**
73	* @return cache provider instance
74	*/
75	public static CacheProvider getInstance() {
76	return cacheProvider;	2✔
77	}
78
79	/**
80	* This method will check if a cache already exists for given cache type and create in case
81	* it is not present in the map
82	*
83	* @param cacheType type of cache
84	* @param <K>
85	* @param <V>
86	* @return
87	*/
88	public <K, V> Cache<K, V> createCache(CacheType cacheType) {
89	//check if lru cache is null, if null create one
90	//check if cache is null for given cache type, if null create one
91	if (!dictionaryCacheAlreadyExists(cacheType)) {	2✔
92	synchronized (lock) {	2✔
93	if (!dictionaryCacheAlreadyExists(cacheType)) {	2✔
94	if (null == carbonLRUCache) {	2✔
95	createLRULevelCacheInstance();	2✔
96	}
97	createDictionaryCacheForGivenType(cacheType);	2✔
98	}
99	}	2✔
100	}
101	return cacheTypeToCacheMap.get(cacheType);	2✔
102	}
103
104	/**
105	* This method will check if a cache already exists for given cache type and store
106	* if it is not present in the map
107	*/
108	public <K, V> Cache<K, V> createCache(CacheType cacheType, String cacheClassName)
109	throws Exception {
110	//check if lru cache is null, if null create one
111	//check if cache is null for given cache type, if null create one
112	if (!dictionaryCacheAlreadyExists(cacheType)) {	1✔
113	synchronized (lock) {	1✔
114	if (!dictionaryCacheAlreadyExists(cacheType)) {	1✔
115	if (null == carbonLRUCache) {	1✔
116	createLRULevelCacheInstance();	×
117	}
118	Class<?> clazz = Class.forName(cacheClassName);	1✔
119	Constructor<?> constructor = clazz.getConstructors()[0];	1✔
120	constructor.setAccessible(true);	1✔
121	Cache cacheObject = (Cache) constructor.newInstance(carbonLRUCache);	1✔
122	cacheTypeToCacheMap.put(cacheType, cacheObject);	1✔
123	}
124	}	1✔
125	}
126	return cacheTypeToCacheMap.get(cacheType);	1✔
127	}
128
129	/**
130	* This method will create the cache for given cache type
131	*
132	* @param cacheType type of cache
133	*/
134	private void createDictionaryCacheForGivenType(CacheType cacheType) {
135	Cache cacheObject = null;	2✔
136	if (cacheType.equals(CacheType.REVERSE_DICTIONARY)) {	2✔
137	cacheObject =	2✔
138	new ReverseDictionaryCache<DictionaryColumnUniqueIdentifier, Dictionary>(carbonLRUCache);
139	} else if (cacheType.equals(CacheType.FORWARD_DICTIONARY)) {	2✔
140	cacheObject =	2✔
141	new ForwardDictionaryCache<DictionaryColumnUniqueIdentifier, Dictionary>(carbonLRUCache);
142	} else if (cacheType.equals(cacheType.DRIVER_BLOCKLET_DATAMAP)) {	2✔
143	cacheObject = new BlockletDataMapIndexStore(carbonLRUCache);	2✔
144	}
145	cacheTypeToCacheMap.put(cacheType, cacheObject);	2✔
146	}	2✔
147
148	/**
149	* This method will create the lru cache instance based on the given type
150	*
151	*/
152	private void createLRULevelCacheInstance() {
153	boolean isDriver = Boolean.parseBoolean(CarbonProperties.getInstance()	2✔
154	.getProperty(CarbonCommonConstants.IS_DRIVER_INSTANCE, "false"));	2✔
155	if (isDriver) {	2✔
156	carbonLRUCache = new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_DRIVER_LRU_CACHE_SIZE,	1✔
157	CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
158	} else {
159	// if executor cache size is not configured then driver cache conf will be used
160	String executorCacheSize = CarbonProperties.getInstance()	2✔
161	.getProperty(CarbonCommonConstants.CARBON_MAX_EXECUTOR_LRU_CACHE_SIZE);	2✔
162	if (null != executorCacheSize) {	2✔
163	carbonLRUCache =	×
164	new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_EXECUTOR_LRU_CACHE_SIZE,
165	CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
166	} else {
167	LOGGER.info(	2✔
168	"Executor LRU cache size not configured. Initializing with driver LRU cache size.");
169	carbonLRUCache = new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_DRIVER_LRU_CACHE_SIZE,	2✔
170	CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
171	}
172	}
173	}	2✔
174
175	/**
176	* This method will check whether the map already has an entry for
177	* given cache type
178	*
179	* @param cacheType
180	* @return
181	*/
182	private boolean dictionaryCacheAlreadyExists(CacheType cacheType) {
183	return null != cacheTypeToCacheMap.get(cacheType);	2✔
184	}
185
186	/**
187	* Below method will be used to clear the cache
188	*/
189	public void dropAllCache() {
190	if (null != carbonLRUCache) {	2✔
191	carbonLRUCache.clear();	2✔
192	carbonLRUCache = null;	2✔
193	}
194	cacheTypeToCacheMap.clear();	2✔
195	}	2✔
196	}

apache / carbondata / 323

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous