DataRecycler.h File Reference

#include "Analyzer/Analyzer.h"
#include "QueryEngine/ColumnarResults.h"
#include "QueryEngine/Descriptors/InputDescriptors.h"
#include "QueryEngine/Descriptors/RelAlgExecutionDescriptor.h"
#include "QueryEngine/JoinHashTable/HashTable.h"
#include "QueryEngine/RelAlgExecutionUnit.h"
#include "QueryEngine/ResultSet.h"
#include "Shared/heavyai_shared_mutex.h"
#include "Shared/misc.h"
#include <boost/functional/hash.hpp>
#include <algorithm>
#include <ostream>
#include <unordered_map>

Include dependency graph for DataRecycler.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	EMPTY_META_INFO
class	CacheItemMetric
class	DataRecyclerUtil
class	CacheMetricTracker
struct	CachedItem< CACHED_ITEM_TYPE, META_INFO_TYPE >
class	DataRecycler< CACHED_ITEM_TYPE, META_INFO_TYPE >

Typedefs
using	DeviceIdentifier = size_t
using	CacheSizeMap = std::unordered_map< DeviceIdentifier, size_t >
using	CacheMetricInfoMap = std::unordered_map< DeviceIdentifier, std::vector< std::shared_ptr< CacheItemMetric >>>

Enumerations
enum	CacheItemType {   PERFECT_HT = 0, BASELINE_HT, OVERLAPS_HT, HT_HASHING_SCHEME,   BASELINE_HT_APPROX_CARD, OVERLAPS_AUTO_TUNER_PARAM, QUERY_RESULTSET, CHUNK_METADATA,   NUM_CACHE_ITEM_TYPE }
enum	CacheAvailability { AVAILABLE, AVAILABLE_AFTER_CLEANUP, UNAVAILABLE }
enum	CacheUpdateAction { ADD, REMOVE }
enum	CacheMetricType { REF_COUNT = 0, MEM_SIZE, COMPUTE_TIME, NUM_METRIC_TYPE }

Functions
std::ostream &	operator<< (std::ostream &os, CacheItemType const item_type)

Typedef Documentation

using CacheMetricInfoMap = std::unordered_map<DeviceIdentifier, std::vector<std::shared_ptr<CacheItemMetric>>>

Definition at line 132 of file DataRecycler.h.

using CacheSizeMap = std::unordered_map<DeviceIdentifier, size_t>

Definition at line 130 of file DataRecycler.h.

using DeviceIdentifier = size_t

Definition at line 129 of file DataRecycler.h.

Enumeration Type Documentation

enum CacheAvailability

Enumerator
AVAILABLE
AVAILABLE_AFTER_CLEANUP
UNAVAILABLE

Definition at line 71 of file DataRecycler.h.

                       {
  AVAILABLE,                // item can be cached as is
  AVAILABLE_AFTER_CLEANUP,  // item can be cached after removing already cached items
  UNAVAILABLE               // item cannot be cached due to size limitation
};

enum CacheItemType

Enumerator
PERFECT_HT
BASELINE_HT
OVERLAPS_HT
HT_HASHING_SCHEME
BASELINE_HT_APPROX_CARD
OVERLAPS_AUTO_TUNER_PARAM
QUERY_RESULTSET
CHUNK_METADATA
NUM_CACHE_ITEM_TYPE

Definition at line 38 of file DataRecycler.h.

                   {
  PERFECT_HT = 0,             // Perfect hashtable
  BASELINE_HT,                // Baseline hashtable
  OVERLAPS_HT,                // Overlaps hashtable
  HT_HASHING_SCHEME,          // Hashtable layout
  BASELINE_HT_APPROX_CARD,    // Approximated cardinality for baseline hashtable
  OVERLAPS_AUTO_TUNER_PARAM,  // Hashtable auto tuner's params for overlaps join
  QUERY_RESULTSET,            // query resultset
  CHUNK_METADATA,             // query resultset's chunk metadata
  // TODO (yoonmin): support the following items for recycling
  // COUNTALL_CARD_EST,  Cardinality of query result
  // NDV_CARD_EST,       # Non-distinct value
  // FILTER_SEL          Selectivity of (push-downed) filter node
  NUM_CACHE_ITEM_TYPE
};

enum CacheMetricType

Enumerator
REF_COUNT
MEM_SIZE
COMPUTE_TIME
NUM_METRIC_TYPE

Definition at line 84 of file DataRecycler.h.

{ REF_COUNT = 0, MEM_SIZE, COMPUTE_TIME, NUM_METRIC_TYPE };

enum CacheUpdateAction

Enumerator
ADD
REMOVE

Definition at line 77 of file DataRecycler.h.

{ ADD, REMOVE };

Function Documentation

std::ostream& operator<< ( std::ostream &  os, CacheItemType const  item_type  )

inline

Definition at line 54 of file DataRecycler.h.

References NUM_CACHE_ITEM_TYPE.

                                                                             {
  constexpr char const* cache_item_type_str[]{
      "Perfect Join Hashtable",
      "Baseline Join Hashtable",
      "Overlaps Join Hashtable",
      "Hashing Scheme for Join Hashtable",
      "Baseline Join Hashtable's Approximated Cardinality",
      "Overlaps Join Hashtable's Auto Tuner's Parameters",
      "Query ResultSet",
      "Chunk Metadata"};
  static_assert(sizeof(cache_item_type_str) / sizeof(*cache_item_type_str) ==
                NUM_CACHE_ITEM_TYPE);
  return os << cache_item_type_str[item_type];
}