3429

Build # 3429

Build Type

push

jenkins

Committed by GitHub

Commit Message

<a href="https://github.com/apache/carbondata/commit/<a class=hub.com/apache/carbondata/commit/1ee4ca480f0a9d875e22a3bbdfc1a945978b63bd">1ee4ca480<a href="https://github.com/apache/carbondata/commit/1ee4ca480f0a9d875e22a3bbdfc1a945978b63bd">">Merge </a><a class="double-link" href="https://github.com/apache/carbondata/commit/<a class="double-link" href="https://github.com/apache/carbondata/commit/c0813d2cdb5222561768bbd76c1bc35e259e3395">c0813d2cd</a>">c0813d2cd</a><a href="https://github.com/apache/carbondata/commit/1ee4ca480f0a9d875e22a3bbdfc1a945978b63bd"> into 5a4684f7f">5a4684f7f</a>

Run Details

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

63547 of 80500 relevant lines covered (78.94%)

1.04 hits per line

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

96.36

/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.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;

import org.apache.log4j.Logger;

/**
 * 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 Logger 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,
            CarbonCommonConstants.IS_DRIVER_INSTANCE_DEFAULT));
    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();
  }

  public CarbonLRUCache getCarbonCache() {
    return carbonLRUCache;
  }
}

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.LogServiceFactory;
25	import org.apache.carbondata.core.cache.dictionary.Dictionary;
26	import org.apache.carbondata.core.cache.dictionary.DictionaryColumnUniqueIdentifier;
27	import org.apache.carbondata.core.cache.dictionary.ForwardDictionaryCache;
28	import org.apache.carbondata.core.cache.dictionary.ReverseDictionaryCache;
29	import org.apache.carbondata.core.constants.CarbonCommonConstants;
30	import org.apache.carbondata.core.indexstore.BlockletDataMapIndexStore;
31	import org.apache.carbondata.core.util.CarbonProperties;
32
33	import org.apache.log4j.Logger;
34
35	/**
36	* Cache provider class which will create a cache based on given type
37	*/
38	public class CacheProvider {
39
40	/**
41	* cache provider instance
42	*/
43	private static CacheProvider cacheProvider = new CacheProvider();	2✔
44
45	/**
46	* a map that will hold the entry for cache type to cache object mapping
47	*/
48	private Map<CacheType, Cache> cacheTypeToCacheMap =	2✔
49	new HashMap<>(CarbonCommonConstants.DEFAULT_COLLECTION_SIZE);
50
51	/**
52	* object lock instance to be used in synchronization block
53	*/
54	private final Object lock = new Object();	2✔
55	/**
56	* LRU cache instance
57	*/
58	private CarbonLRUCache carbonLRUCache;
59
60	/**
61	* instance for CacheProvider LOGGER
62	*/
63	private static final Logger LOGGER =	2✔
64	LogServiceFactory.getLogService(CacheProvider.class.getName());	2✔
65
66	/**
67	* private constructor to follow singleton design pattern for this class
68	*/
69	private CacheProvider() {	2✔
70
71	}	2✔
72
73	/**
74	* @return cache provider instance
75	*/
76	public static CacheProvider getInstance() {
77	return cacheProvider;	2✔
78	}
79
80	/**
81	* This method will check if a cache already exists for given cache type and create in case
82	* it is not present in the map
83	*
84	* @param cacheType type of cache
85	* @param <K>
86	* @param <V>
87	* @return
88	*/
89	public <K, V> Cache<K, V> createCache(CacheType cacheType) {
90	//check if lru cache is null, if null create one
91	//check if cache is null for given cache type, if null create one
92	if (!dictionaryCacheAlreadyExists(cacheType)) {	2✔
93	synchronized (lock) {	2✔
94	if (!dictionaryCacheAlreadyExists(cacheType)) {	2✔
95	if (null == carbonLRUCache) {	2✔
96	createLRULevelCacheInstance();	2✔
97	}
98	createDictionaryCacheForGivenType(cacheType);	2✔
99	}
100	}	2✔
101	}
102	return cacheTypeToCacheMap.get(cacheType);	2✔
103	}
104
105	/**
106	* This method will check if a cache already exists for given cache type and store
107	* if it is not present in the map
108	*/
109	public <K, V> Cache<K, V> createCache(CacheType cacheType, String cacheClassName)
110	throws Exception {
111	//check if lru cache is null, if null create one
112	//check if cache is null for given cache type, if null create one
113	if (!dictionaryCacheAlreadyExists(cacheType)) {	1✔
114	synchronized (lock) {	1✔
115	if (!dictionaryCacheAlreadyExists(cacheType)) {	1✔
116	if (null == carbonLRUCache) {	1✔
117	createLRULevelCacheInstance();	×
118	}
119	Class<?> clazz = Class.forName(cacheClassName);	1✔
120	Constructor<?> constructor = clazz.getConstructors()[0];	1✔
121	constructor.setAccessible(true);	1✔
122	Cache cacheObject = (Cache) constructor.newInstance(carbonLRUCache);	1✔
123	cacheTypeToCacheMap.put(cacheType, cacheObject);	1✔
124	}
125	}	1✔
126	}
127	return cacheTypeToCacheMap.get(cacheType);	1✔
128	}
129
130	/**
131	* This method will create the cache for given cache type
132	*
133	* @param cacheType type of cache
134	*/
135	private void createDictionaryCacheForGivenType(CacheType cacheType) {
136	Cache cacheObject = null;	2✔
137	if (cacheType.equals(CacheType.REVERSE_DICTIONARY)) {	2✔
138	cacheObject =	2✔
139	new ReverseDictionaryCache<DictionaryColumnUniqueIdentifier, Dictionary>(carbonLRUCache);
140	} else if (cacheType.equals(CacheType.FORWARD_DICTIONARY)) {	2✔
141	cacheObject =	2✔
142	new ForwardDictionaryCache<DictionaryColumnUniqueIdentifier, Dictionary>(carbonLRUCache);
143	} else if (cacheType.equals(cacheType.DRIVER_BLOCKLET_DATAMAP)) {	2✔
144	cacheObject = new BlockletDataMapIndexStore(carbonLRUCache);	2✔
145	}
146	cacheTypeToCacheMap.put(cacheType, cacheObject);	2✔
147	}	2✔
148
149	/**
150	* This method will create the lru cache instance based on the given type
151	*
152	*/
153	private void createLRULevelCacheInstance() {
154	boolean isDriver = Boolean.parseBoolean(CarbonProperties.getInstance()	2✔
155	.getProperty(CarbonCommonConstants.IS_DRIVER_INSTANCE,	2✔
156	CarbonCommonConstants.IS_DRIVER_INSTANCE_DEFAULT));
157	if (isDriver) {	2✔
158	carbonLRUCache = new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_DRIVER_LRU_CACHE_SIZE,	1✔
159	CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
160	} else {
161	// if executor cache size is not configured then driver cache conf will be used
162	String executorCacheSize = CarbonProperties.getInstance()	2✔
163	.getProperty(CarbonCommonConstants.CARBON_MAX_EXECUTOR_LRU_CACHE_SIZE);	2✔
164	if (null != executorCacheSize) {	2✔
165	carbonLRUCache =	×
166	new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_EXECUTOR_LRU_CACHE_SIZE,
167	CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
168	} else {
169	LOGGER.info(	2✔
170	"Executor LRU cache size not configured. Initializing with driver LRU cache size.");
171	carbonLRUCache = new CarbonLRUCache(CarbonCommonConstants.CARBON_MAX_DRIVER_LRU_CACHE_SIZE,	2✔
172	CarbonCommonConstants.CARBON_MAX_LRU_CACHE_SIZE_DEFAULT);
173	}
174	}
175	}	2✔
176
177	/**
178	* This method will check whether the map already has an entry for
179	* given cache type
180	*
181	* @param cacheType
182	* @return
183	*/
184	private boolean dictionaryCacheAlreadyExists(CacheType cacheType) {
185	return null != cacheTypeToCacheMap.get(cacheType);	2✔
186	}
187
188	/**
189	* Below method will be used to clear the cache
190	*/
191	public void dropAllCache() {
192	if (null != carbonLRUCache) {	2✔
193	carbonLRUCache.clear();	2✔
194	carbonLRUCache = null;	2✔
195	}
196	cacheTypeToCacheMap.clear();	2✔
197	}	2✔
198
199	public CarbonLRUCache getCarbonCache() {
200	return carbonLRUCache;	1✔
201	}
202	}

apache / carbondata / 3429

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