OmniSciDB  91042dcc5b
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OverlapsTuningParamRecycler Class Reference

#include <OverlapsTuningParamRecycler.h>

+ Inheritance diagram for OverlapsTuningParamRecycler:
+ Collaboration diagram for OverlapsTuningParamRecycler:

Public Member Functions

 OverlapsTuningParamRecycler ()
 
 std::numeric_limits ()
 
 std::numeric_limits ()
 
void putItemToCache (QueryPlanHash key, std::optional< AutoTunerMetaInfo > item, CacheItemType item_type, DeviceIdentifier device_identifier, size_t item_size, size_t compute_time, std::optional< EMPTY_META_INFO > meta_info=std::nullopt) override
 
void initCache () override
 
void clearCache () override
 
void markCachedItemAsDirty (size_t table_key, std::unordered_set< QueryPlanHash > &key_set, CacheItemType item_type, DeviceIdentifier device_identifier) override
 
std::string toString () const override
 
- Public Member Functions inherited from DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >
 DataRecycler (const std::vector< CacheItemType > &item_types, size_t total_cache_size, size_t max_item_size, int num_gpus)
 
virtual ~DataRecycler ()=default
 
virtual std::optional
< AutoTunerMetaInfo
getItemFromCache (QueryPlanHash key, CacheItemType item_type, DeviceIdentifier device_identifier, std::optional< EMPTY_META_INFO > meta_info=std::nullopt)=0
 
void markCachedItemAsDirtyImpl (QueryPlanHash key, CachedItemContainer &m) const
 
bool isCachedItemDirty (QueryPlanHash key, CachedItemContainer &m) const
 
std::shared_ptr
< CachedItemContainer
getCachedItemContainer (CacheItemType item_type, DeviceIdentifier device_identifier) const
 
std::optional< CachedItem
< std::optional
< AutoTunerMetaInfo >
, EMPTY_META_INFO > > 
getCachedItemWithoutConsideringMetaInfo (QueryPlanHash key, CacheItemType item_type, DeviceIdentifier device_identifier, CachedItemContainer &m, std::lock_guard< std::mutex > &lock)
 
size_t getCurrentNumCachedItems (CacheItemType item_type, DeviceIdentifier device_identifier) const
 
size_t getCurrentNumDirtyCachedItems (CacheItemType item_type, DeviceIdentifier device_identifier) const
 
size_t getCurrentNumCleanCachedItems (CacheItemType item_type, DeviceIdentifier device_identifier) const
 
size_t getCurrentCacheSizeForDevice (CacheItemType item_type, DeviceIdentifier device_identifier) const
 
std::shared_ptr< CacheItemMetricgetCachedItemMetric (CacheItemType item_type, DeviceIdentifier device_identifier, QueryPlanHash key) const
 
void setTotalCacheSize (CacheItemType item_type, size_t new_total_cache_size)
 
void setMaxCacheItemSize (CacheItemType item_type, size_t new_max_cache_item_size)
 

Private Member Functions

bool hasItemInCache (QueryPlanHash key, CacheItemType item_type, DeviceIdentifier device_identifier, std::lock_guard< std::mutex > &lock, std::optional< EMPTY_META_INFO > meta_info=std::nullopt) const override
 
void removeItemFromCache (QueryPlanHash key, CacheItemType item_type, DeviceIdentifier device_identifier, std::lock_guard< std::mutex > &lock, std::optional< EMPTY_META_INFO > meta_info=std::nullopt) override
 
void cleanupCacheForInsertion (CacheItemType item_type, DeviceIdentifier device_identifier, size_t required_size, std::lock_guard< std::mutex > &lock, std::optional< EMPTY_META_INFO > meta_info=std::nullopt) override
 

Additional Inherited Members

- Public Types inherited from DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >
using CachedItemContainer = std::vector< CachedItem< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >>
 
using PerDeviceCacheItemContainer = std::unordered_map< DeviceIdentifier, std::shared_ptr< CachedItemContainer >>
 
using PerTypeCacheItemContainer = std::unordered_map< CacheItemType, std::shared_ptr< PerDeviceCacheItemContainer >>
 
using PerTypeCacheMetricTracker = std::unordered_map< CacheItemType, CacheMetricTracker >
 
- Protected Member Functions inherited from DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >
void removeCachedItemFromBeginning (CacheItemType item_type, DeviceIdentifier device_identifier, int offset)
 
void sortCacheContainerByQueryMetric (CacheItemType item_type, DeviceIdentifier device_identifier)
 
std::mutex & getCacheLock () const
 
CacheMetricTrackergetMetricTracker (CacheItemType item_type)
 
CacheMetricTracker constgetMetricTracker (CacheItemType item_type) const
 
std::unordered_set
< CacheItemType > const
getCacheItemType () const
 
PerTypeCacheItemContainer constgetItemCache () const
 

Detailed Description

Definition at line 32 of file OverlapsTuningParamRecycler.h.

Constructor & Destructor Documentation

OverlapsTuningParamRecycler::OverlapsTuningParamRecycler ( )
inline

Definition at line 38 of file OverlapsTuningParamRecycler.h.

References OVERLAPS_AUTO_TUNER_PARAM.

DataRecycler(const std::vector< CacheItemType > &item_types, size_t total_cache_size, size_t max_item_size, int num_gpus)
Definition: DataRecycler.h:410

Member Function Documentation

void OverlapsTuningParamRecycler::cleanupCacheForInsertion ( CacheItemType  item_type,
DeviceIdentifier  device_identifier,
size_t  required_size,
std::lock_guard< std::mutex > &  lock,
std::optional< EMPTY_META_INFO meta_info = std::nullopt 
)
inlineoverrideprivatevirtual

Implements DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >.

Definition at line 87 of file OverlapsTuningParamRecycler.h.

References UNREACHABLE.

92  {
93  UNREACHABLE();
94  }
#define UNREACHABLE()
Definition: Logger.h:255
void OverlapsTuningParamRecycler::clearCache ( )
overridevirtual

Implements DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >.

Definition at line 105 of file OverlapsTuningParamRecycler.cpp.

References DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCachedItemContainer(), DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCacheLock(), OVERLAPS_AUTO_TUNER_PARAM, and PARAM_CACHE_DEVICE_IDENTIFIER.

105  {
106  std::lock_guard<std::mutex> lock(getCacheLock());
109  param_cache->clear();
110 }
std::shared_ptr< CachedItemContainer > getCachedItemContainer(CacheItemType item_type, DeviceIdentifier device_identifier) const
Definition: DataRecycler.h:480
constexpr DeviceIdentifier PARAM_CACHE_DEVICE_IDENTIFIER

+ Here is the call graph for this function:

bool OverlapsTuningParamRecycler::hasItemInCache ( QueryPlanHash  key,
CacheItemType  item_type,
DeviceIdentifier  device_identifier,
std::lock_guard< std::mutex > &  lock,
std::optional< EMPTY_META_INFO meta_info = std::nullopt 
) const
overrideprivatevirtual

Implements DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >.

Definition at line 70 of file OverlapsTuningParamRecycler.cpp.

References CHECK_EQ, EMPTY_HASHED_PLAN_DAG_KEY, g_enable_data_recycler, g_use_hashtable_cache, DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCachedItemContainer(), and OVERLAPS_AUTO_TUNER_PARAM.

75  {
78  return false;
79  }
81  auto param_cache = getCachedItemContainer(item_type, device_identifier);
82  auto candidate_it = std::find_if(
83  param_cache->begin(), param_cache->end(), [&key](const auto& cached_item) {
84  return cached_item.key == key;
85  });
86  return candidate_it != param_cache->end();
87 }
#define CHECK_EQ(x, y)
Definition: Logger.h:219
constexpr QueryPlanHash EMPTY_HASHED_PLAN_DAG_KEY
std::shared_ptr< CachedItemContainer > getCachedItemContainer(CacheItemType item_type, DeviceIdentifier device_identifier) const
Definition: DataRecycler.h:480
bool g_enable_data_recycler
Definition: Execute.cpp:141
bool g_use_hashtable_cache
Definition: Execute.cpp:142

+ Here is the call graph for this function:

void OverlapsTuningParamRecycler::initCache ( )
inlineoverridevirtual
void OverlapsTuningParamRecycler::markCachedItemAsDirty ( size_t  table_key,
std::unordered_set< QueryPlanHash > &  key_set,
CacheItemType  item_type,
DeviceIdentifier  device_identifier 
)
overridevirtual

Implements DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >.

Definition at line 112 of file OverlapsTuningParamRecycler.cpp.

References CHECK_EQ, g_enable_data_recycler, g_use_hashtable_cache, DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCachedItemContainer(), DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCacheLock(), DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::markCachedItemAsDirtyImpl(), and OVERLAPS_AUTO_TUNER_PARAM.

116  {
117  if (!g_enable_data_recycler || !g_use_hashtable_cache || key_set.empty()) {
118  return;
119  }
121  std::lock_guard<std::mutex> lock(getCacheLock());
122  auto param_cache = getCachedItemContainer(item_type, device_identifier);
123  for (auto key : key_set) {
124  markCachedItemAsDirtyImpl(key, *param_cache);
125  }
126 }
#define CHECK_EQ(x, y)
Definition: Logger.h:219
std::shared_ptr< CachedItemContainer > getCachedItemContainer(CacheItemType item_type, DeviceIdentifier device_identifier) const
Definition: DataRecycler.h:480
void markCachedItemAsDirtyImpl(QueryPlanHash key, CachedItemContainer &m) const
Definition: DataRecycler.h:456
bool g_enable_data_recycler
Definition: Execute.cpp:141
bool g_use_hashtable_cache
Definition: Execute.cpp:142

+ Here is the call graph for this function:

void OverlapsTuningParamRecycler::putItemToCache ( QueryPlanHash  key,
std::optional< AutoTunerMetaInfo item,
CacheItemType  item_type,
DeviceIdentifier  device_identifier,
size_t  item_size,
size_t  compute_time,
std::optional< EMPTY_META_INFO meta_info = std::nullopt 
)
overridevirtual

Implements DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >.

Definition at line 43 of file OverlapsTuningParamRecycler.cpp.

References CHECK_EQ, EMPTY_HASHED_PLAN_DAG_KEY, g_enable_data_recycler, g_use_hashtable_cache, DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCachedItemContainer(), DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCachedItemWithoutConsideringMetaInfo(), DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCacheLock(), DataRecyclerUtil::getDeviceIdentifierString(), OVERLAPS_AUTO_TUNER_PARAM, DataRecyclerUtil::toStringCacheItemType(), and VLOG.

50  {
53  return;
54  }
56  std::lock_guard<std::mutex> lock(getCacheLock());
57  auto param_cache = getCachedItemContainer(item_type, device_identifier);
58  auto cached_param = getCachedItemWithoutConsideringMetaInfo(
59  key, item_type, device_identifier, *param_cache, lock);
60  if (cached_param) {
61  return;
62  }
63  param_cache->emplace_back(key, item, nullptr, meta_info);
64  VLOG(1) << "[" << DataRecyclerUtil::toStringCacheItemType(item_type) << ", "
66  << "] Put auto tuner parameters to cache";
67  return;
68 }
#define CHECK_EQ(x, y)
Definition: Logger.h:219
static std::string getDeviceIdentifierString(DeviceIdentifier device_identifier)
Definition: DataRecycler.h:135
static std::string_view toStringCacheItemType(CacheItemType item_type)
Definition: DataRecycler.h:128
std::optional< CachedItem< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO > > getCachedItemWithoutConsideringMetaInfo(QueryPlanHash key, CacheItemType item_type, DeviceIdentifier device_identifier, CachedItemContainer &m, std::lock_guard< std::mutex > &lock)
Definition: DataRecycler.h:495
constexpr QueryPlanHash EMPTY_HASHED_PLAN_DAG_KEY
std::shared_ptr< CachedItemContainer > getCachedItemContainer(CacheItemType item_type, DeviceIdentifier device_identifier) const
Definition: DataRecycler.h:480
bool g_enable_data_recycler
Definition: Execute.cpp:141
bool g_use_hashtable_cache
Definition: Execute.cpp:142
#define VLOG(n)
Definition: Logger.h:305

+ Here is the call graph for this function:

void OverlapsTuningParamRecycler::removeItemFromCache ( QueryPlanHash  key,
CacheItemType  item_type,
DeviceIdentifier  device_identifier,
std::lock_guard< std::mutex > &  lock,
std::optional< EMPTY_META_INFO meta_info = std::nullopt 
)
overrideprivatevirtual

Implements DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >.

Definition at line 89 of file OverlapsTuningParamRecycler.cpp.

References DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCachedItemContainer().

94  {
95  auto param_cache = getCachedItemContainer(item_type, device_identifier);
96  auto filter = [key](auto const& item) { return item.key == key; };
97  auto itr = std::find_if(param_cache->cbegin(), param_cache->cend(), filter);
98  if (itr == param_cache->cend()) {
99  return;
100  } else {
101  param_cache->erase(itr);
102  }
103 }
std::shared_ptr< CachedItemContainer > getCachedItemContainer(CacheItemType item_type, DeviceIdentifier device_identifier) const
Definition: DataRecycler.h:480

+ Here is the call graph for this function:

OverlapsTuningParamRecycler::std::numeric_limits ( )
OverlapsTuningParamRecycler::std::numeric_limits ( )
std::string OverlapsTuningParamRecycler::toString ( ) const
overridevirtual

Implements DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >.

Definition at line 128 of file OverlapsTuningParamRecycler.cpp.

References DataRecycler< std::optional< AutoTunerMetaInfo >, EMPTY_META_INFO >::getCachedItemContainer(), OVERLAPS_AUTO_TUNER_PARAM, and PARAM_CACHE_DEVICE_IDENTIFIER.

128  {
129  std::ostringstream oss;
130  oss << "A current status of the Overlaps Join Hashtable Tuning Parameter Recycler:\n";
131  oss << "\t# cached parameters:\n";
132  oss << "\t\tDevice" << PARAM_CACHE_DEVICE_IDENTIFIER << "\n";
134  PARAM_CACHE_DEVICE_IDENTIFIER);
135  for (auto& cache_container : *param_cache) {
136  oss << "\t\t\tCache_key: " << cache_container.key;
137  if (cache_container.cached_item.has_value()) {
138  oss << ", Max_hashtable_size: " << cache_container.cached_item->max_hashtable_size
139  << ", Bucket_threshold: " << cache_container.cached_item->bucket_threshold
140  << ", Bucket_sizes: " << ::toString(cache_container.cached_item->bucket_sizes)
141  << "\n";
142  } else {
143  oss << ", Params info is not available\n";
144  }
145  }
146  return oss.str();
147 }
std::shared_ptr< CachedItemContainer > getCachedItemContainer(CacheItemType item_type, DeviceIdentifier device_identifier) const
Definition: DataRecycler.h:480
constexpr DeviceIdentifier PARAM_CACHE_DEVICE_IDENTIFIER
std::string toString() const override

+ Here is the call graph for this function:


The documentation for this class was generated from the following files: