#include <RowSetMemoryOwner.h>

Inheritance diagram for RowSetMemoryOwner:

Collaboration diagram for RowSetMemoryOwner:

Classes
struct	CountDistinctBitmapBuffer

Public Member Functions
	RowSetMemoryOwner (const size_t arena_block_size)

int8_t *	allocate (const size_t num_bytes)

int8_t *	allocateCountDistinctBuffer (const size_t num_bytes)

void	addCountDistinctBuffer (int8_t *count_distinct_buffer, const size_t bytes, const bool physical_buffer)

void	addCountDistinctSet (std::set< int64_t > *count_distinct_set)

void	addGroupByBuffer (int64_t *group_by_buffer)

void	addVarlenBuffer (void *varlen_buffer)

void	addVarlenInputBuffer (Data_Namespace::AbstractBuffer *buffer)

std::string *	addString (const std::string &str)

std::vector< int64_t > *	addArray (const std::vector< int64_t > &arr)

StringDictionaryProxy *	addStringDict (std::shared_ptr< StringDictionary > str_dict, const int dict_id, const int64_t generation)

StringDictionaryProxy *	getStringDictProxy (const int dict_id) const

StringDictionaryProxy *	getOrAddStringDictProxy (const int dict_id_in, const bool with_generation, const Catalog_Namespace::Catalog *catalog)

void	addLiteralStringDictProxy (std::shared_ptr< StringDictionaryProxy > lit_str_dict_proxy)

StringDictionaryProxy *	getLiteralStringDictProxy () const

void	addColBuffer (const void *col_buffer)

	~RowSetMemoryOwner ()

std::shared_ptr < RowSetMemoryOwner >	cloneStrDictDataOnly ()

void	setDictionaryGenerations (StringDictionaryGenerations generations)

StringDictionaryGenerations &	getStringDictionaryGenerations ()

quantile::TDigest *	newTDigest ()

Private Attributes
std::vector < CountDistinctBitmapBuffer >	count_distinct_bitmaps_

std::vector< std::set< int64_t > * >	count_distinct_sets_

std::vector< int64_t * >	group_by_buffers_

std::vector< void * >	varlen_buffers_

std::list< std::string >	strings_

std::list< std::vector< int64_t > >	arrays_

std::unordered_map< int, std::shared_ptr < StringDictionaryProxy > >	str_dict_proxy_owned_

std::shared_ptr < StringDictionaryProxy >	lit_str_dict_proxy_

StringDictionaryGenerations	string_dictionary_generations_

std::vector< void * >	col_buffers_

std::vector < Data_Namespace::AbstractBuffer * >	varlen_input_buffers_

std::vector< std::unique_ptr < quantile::TDigest > >	t_digests_

std::vector < quantile::TDigest::Memory >	t_digest_buffers_

size_t	arena_block_size_

std::unique_ptr< Arena >	allocator_

std::mutex	state_mutex_

Friends
class	ResultSet

class	QueryExecutionContext

Detailed Description

Handles allocations and outputs for all stages in a query, either explicitly or via a managed allocator object

Definition at line 43 of file RowSetMemoryOwner.h.

Constructor & Destructor Documentation

RowSetMemoryOwner::RowSetMemoryOwner ( const size_t arena_block_size )

inline

Definition at line 45 of file RowSetMemoryOwner.h.

46 : arena_block_size_(arena_block_size)

47 , allocator_(std::make_unique<Arena>(arena_block_size)) {}

RowSetMemoryOwner::allocator_

std::unique_ptr< Arena > allocator_

Definition: RowSetMemoryOwner.h:213

RowSetMemoryOwner::arena_block_size_

size_t arena_block_size_

Definition: RowSetMemoryOwner.h:212

RowSetMemoryOwner::~RowSetMemoryOwner ( )

inline

Definition at line 155 of file RowSetMemoryOwner.h.

References CHECK, col_buffers_, count_distinct_sets_, group_by_buffers_, varlen_buffers_, and varlen_input_buffers_.

                        {
     for (auto count_distinct_set : count_distinct_sets_) {
       delete count_distinct_set;
     }
     for (auto group_by_buffer : group_by_buffers_) {
       free(group_by_buffer);
     }
     for (auto varlen_buffer : varlen_buffers_) {
       free(varlen_buffer);
     }
     for (auto varlen_input_buffer : varlen_input_buffers_) {
       CHECK(varlen_input_buffer);
       varlen_input_buffer->unPin();
     }
     for (auto col_buffer : col_buffers_) {
       free(col_buffer);
     }
   }

Member Function Documentation

std::vector<int64_t>* RowSetMemoryOwner::addArray ( const std::vector< int64_t > & arr )

inline

Definition at line 104 of file RowSetMemoryOwner.h.

References arrays_, and state_mutex_.

                                                               {
     std::lock_guard<std::mutex> lock(state_mutex_);
     arrays_.emplace_back(arr);
     return &arrays_.back();
   }

void RowSetMemoryOwner::addColBuffer ( const void * col_buffer )

inline

Definition at line 150 of file RowSetMemoryOwner.h.

References col_buffers_, and state_mutex_.

                                             {
     std::lock_guard<std::mutex> lock(state_mutex_);
     col_buffers_.push_back(const_cast<void*>(col_buffer));
   }

void RowSetMemoryOwner::addCountDistinctBuffer	(	int8_t *	count_distinct_buffer,
		const size_t	bytes,
		const bool	physical_buffer
	)

inline

Definition at line 64 of file RowSetMemoryOwner.h.

References count_distinct_bitmaps_, and state_mutex_.

                                                           {
     std::lock_guard<std::mutex> lock(state_mutex_);
     count_distinct_bitmaps_.emplace_back(
         CountDistinctBitmapBuffer{count_distinct_buffer, bytes, physical_buffer});
   }

void RowSetMemoryOwner::addCountDistinctSet ( std::set< int64_t > * count_distinct_set )

inline

Definition at line 72 of file RowSetMemoryOwner.h.

References count_distinct_sets_, and state_mutex_.

                                                                 {
     std::lock_guard<std::mutex> lock(state_mutex_);
     count_distinct_sets_.push_back(count_distinct_set);
   }

void RowSetMemoryOwner::addGroupByBuffer ( int64_t * group_by_buffer )

inline

Definition at line 77 of file RowSetMemoryOwner.h.

References group_by_buffers_, and state_mutex_.

                                                   {
     std::lock_guard<std::mutex> lock(state_mutex_);
     group_by_buffers_.push_back(group_by_buffer);
   }

void RowSetMemoryOwner::addLiteralStringDictProxy ( std::shared_ptr< StringDictionaryProxy > lit_str_dict_proxy )

inline

Definition at line 139 of file RowSetMemoryOwner.h.

References lit_str_dict_proxy_, and state_mutex_.

                                                                {
     std::lock_guard<std::mutex> lock(state_mutex_);
     lit_str_dict_proxy_ = lit_str_dict_proxy;
   }

std::string* RowSetMemoryOwner::addString ( const std::string & str )

inline

Definition at line 98 of file RowSetMemoryOwner.h.

References state_mutex_, and strings_.

                                              {
     std::lock_guard<std::mutex> lock(state_mutex_);
     strings_.emplace_back(str);
     return &strings_.back();
   }

StringDictionaryProxy* RowSetMemoryOwner::addStringDict	(	std::shared_ptr< StringDictionary >	str_dict,
		const int	dict_id,
		const int64_t	generation
	)

inline

Definition at line 110 of file RowSetMemoryOwner.h.

References CHECK_EQ, state_mutex_, and str_dict_proxy_owned_.

Referenced by getOrAddStringDictProxy().

                                                                  {
     std::lock_guard<std::mutex> lock(state_mutex_);
     auto it = str_dict_proxy_owned_.find(dict_id);
     if (it != str_dict_proxy_owned_.end()) {
       CHECK_EQ(it->second->getDictionary(), str_dict.get());
       it->second->updateGeneration(generation);
       return it->second.get();
     }
     it = str_dict_proxy_owned_
              .emplace(dict_id,
                       std::make_shared<StringDictionaryProxy>(str_dict, generation))
              .first;
     return it->second.get();
   }

Here is the caller graph for this function:

void RowSetMemoryOwner::addVarlenBuffer ( void * varlen_buffer )

inline

Definition at line 82 of file RowSetMemoryOwner.h.

References state_mutex_, and varlen_buffers_.

                                             {
     std::lock_guard<std::mutex> lock(state_mutex_);
     varlen_buffers_.push_back(varlen_buffer);
   }

void RowSetMemoryOwner::addVarlenInputBuffer ( Data_Namespace::AbstractBuffer * buffer )

inline

Adds a GPU buffer containing a variable length input column. Variable length inputs on GPU are referenced in output projected targets and should not be freed until the query results have been resolved.

Definition at line 92 of file RowSetMemoryOwner.h.

References CHECK_EQ, Data_Namespace::AbstractBuffer::getType(), Data_Namespace::GPU_LEVEL, state_mutex_, and varlen_input_buffers_.

                                                                   {
     std::lock_guard<std::mutex> lock(state_mutex_);
     CHECK_EQ(buffer->getType(), Data_Namespace::MemoryLevel::GPU_LEVEL);
     varlen_input_buffers_.push_back(buffer);
   }

Here is the call graph for this function:

int8_t* RowSetMemoryOwner::allocate ( const size_t num_bytes )

inline

Definition at line 49 of file RowSetMemoryOwner.h.

References allocator_, CHECK, and state_mutex_.

Referenced by anonymous_namespace{QueryMemoryInitializer.cpp}::alloc_group_by_buffer().

                                            {
     CHECK(allocator_);
     std::lock_guard<std::mutex> lock(state_mutex_);
     return reinterpret_cast<int8_t*>(allocator_->allocate(num_bytes));
   }

Here is the caller graph for this function:

int8_t* RowSetMemoryOwner::allocateCountDistinctBuffer ( const size_t num_bytes )

inline

Definition at line 55 of file RowSetMemoryOwner.h.

References allocator_, CHECK, count_distinct_bitmaps_, and state_mutex_.

                                                               {
     CHECK(allocator_);
     std::lock_guard<std::mutex> lock(state_mutex_);
     auto ret = reinterpret_cast<int8_t*>(allocator_->allocateAndZero(num_bytes));
     count_distinct_bitmaps_.emplace_back(
         CountDistinctBitmapBuffer{ret, num_bytes, /*physical_buffer=*/true});
     return ret;
   }

std::shared_ptr<RowSetMemoryOwner> RowSetMemoryOwner::cloneStrDictDataOnly ( )

inline

Definition at line 174 of file RowSetMemoryOwner.h.

References arena_block_size_, lit_str_dict_proxy_, and str_dict_proxy_owned_.

                                                           {
     auto rtn = std::make_shared<RowSetMemoryOwner>(arena_block_size_);
     rtn->str_dict_proxy_owned_ = str_dict_proxy_owned_;
     rtn->lit_str_dict_proxy_ = lit_str_dict_proxy_;
     return rtn;
   }

StringDictionaryProxy* RowSetMemoryOwner::getLiteralStringDictProxy ( ) const

inline

Definition at line 145 of file RowSetMemoryOwner.h.

References lit_str_dict_proxy_, and state_mutex_.

                                                            {
     std::lock_guard<std::mutex> lock(state_mutex_);
     return lit_str_dict_proxy_.get();
   }

StringDictionaryProxy * RowSetMemoryOwner::getOrAddStringDictProxy	(	const int	dict_id_in,
		const bool	with_generation,
		const Catalog_Namespace::Catalog *	catalog
	)

Definition at line 218 of file Execute.cpp.

References addStringDict(), CHECK, CHECK_EQ, CHECK_LE, g_cache_string_hash, StringDictionaryGenerations::getGeneration(), Catalog_Namespace::Catalog::getMetadataForDict(), lit_str_dict_proxy_, REGULAR_DICT, and string_dictionary_generations_.

                                              {
   const int dict_id{dict_id_in < 0 ? REGULAR_DICT(dict_id_in) : dict_id_in};
   CHECK(catalog);
   const auto dd = catalog->getMetadataForDict(dict_id);
   if (dd) {
     CHECK(dd->stringDict);
     CHECK_LE(dd->dictNBits, 32);
     const int64_t generation =
         with_generation ? string_dictionary_generations_.getGeneration(dict_id) : -1;
     return addStringDict(dd->stringDict, dict_id, generation);
   }
   CHECK_EQ(0, dict_id);
   if (!lit_str_dict_proxy_) {
     std::shared_ptr<StringDictionary> tsd =
         std::make_shared<StringDictionary>("", false, true, g_cache_string_hash);
     lit_str_dict_proxy_.reset(new StringDictionaryProxy(tsd, 0));
   }
   return lit_str_dict_proxy_.get();
 }

Here is the call graph for this function:

StringDictionaryGenerations& RowSetMemoryOwner::getStringDictionaryGenerations ( )

inline

Definition at line 185 of file RowSetMemoryOwner.h.

References string_dictionary_generations_.

                                                                 {
     return string_dictionary_generations_;
   }

StringDictionaryProxy* RowSetMemoryOwner::getStringDictProxy ( const int dict_id ) const

inline

Definition at line 127 of file RowSetMemoryOwner.h.

References CHECK, state_mutex_, and str_dict_proxy_owned_.

                                                                      {
     std::lock_guard<std::mutex> lock(state_mutex_);
     auto it = str_dict_proxy_owned_.find(dict_id);
     CHECK(it != str_dict_proxy_owned_.end());
     return it->second.get();
   }

quantile::TDigest * RowSetMemoryOwner::newTDigest ( )

Definition at line 241 of file Execute.cpp.

References g_approx_quantile_buffer, g_approx_quantile_centroids, state_mutex_, t_digest_buffers_, and t_digests_.

                                                {
   std::lock_guard<std::mutex> lock(state_mutex_);
   auto& td = t_digests_.emplace_back(std::make_unique<quantile::TDigest>());
   // Separating TDigests from their buffers allows for flexibile memory management.
   // The incoming Buffer is used to collect and sort incoming data,
   // and used as scratch space during its merging into the main Centroids buffer.
   td->setBuffer(t_digest_buffers_.emplace_back(g_approx_quantile_buffer));
   td->setCentroids(t_digest_buffers_.emplace_back(g_approx_quantile_centroids));
   return td.get();
 }

void RowSetMemoryOwner::setDictionaryGenerations ( StringDictionaryGenerations generations )

inline

Definition at line 181 of file RowSetMemoryOwner.h.

References string_dictionary_generations_.

                                                                          {
     string_dictionary_generations_ = generations;
   }

Friends And Related Function Documentation

friend class QueryExecutionContext

friend

Definition at line 218 of file RowSetMemoryOwner.h.

friend class ResultSet

friend

Definition at line 217 of file RowSetMemoryOwner.h.

Member Data Documentation

std::unique_ptr<Arena> RowSetMemoryOwner::allocator_

private

Definition at line 213 of file RowSetMemoryOwner.h.

Referenced by allocate(), and allocateCountDistinctBuffer().

size_t RowSetMemoryOwner::arena_block_size_

private

Definition at line 212 of file RowSetMemoryOwner.h.

Referenced by cloneStrDictDataOnly().

std::list<std::vector<int64_t> > RowSetMemoryOwner::arrays_

private

Definition at line 203 of file RowSetMemoryOwner.h.

Referenced by addArray().

std::vector<void*> RowSetMemoryOwner::col_buffers_

private

Definition at line 207 of file RowSetMemoryOwner.h.

Referenced by addColBuffer(), and ~RowSetMemoryOwner().

std::vector<CountDistinctBitmapBuffer> RowSetMemoryOwner::count_distinct_bitmaps_

private

Definition at line 198 of file RowSetMemoryOwner.h.

Referenced by addCountDistinctBuffer(), and allocateCountDistinctBuffer().

std::vector<std::set<int64_t>*> RowSetMemoryOwner::count_distinct_sets_

private

Definition at line 199 of file RowSetMemoryOwner.h.

Referenced by addCountDistinctSet(), and ~RowSetMemoryOwner().

std::vector<int64_t*> RowSetMemoryOwner::group_by_buffers_

private

Definition at line 200 of file RowSetMemoryOwner.h.

Referenced by addGroupByBuffer(), and ~RowSetMemoryOwner().

std::shared_ptr<StringDictionaryProxy> RowSetMemoryOwner::lit_str_dict_proxy_

private

Definition at line 205 of file RowSetMemoryOwner.h.

Referenced by addLiteralStringDictProxy(), cloneStrDictDataOnly(), getLiteralStringDictProxy(), and getOrAddStringDictProxy().

std::mutex RowSetMemoryOwner::state_mutex_

mutableprivate

Definition at line 215 of file RowSetMemoryOwner.h.

Referenced by addArray(), addColBuffer(), addCountDistinctBuffer(), addCountDistinctSet(), addGroupByBuffer(), addLiteralStringDictProxy(), addString(), addStringDict(), addVarlenBuffer(), addVarlenInputBuffer(), allocate(), allocateCountDistinctBuffer(), getLiteralStringDictProxy(), getStringDictProxy(), and newTDigest().

std::unordered_map<int, std::shared_ptr<StringDictionaryProxy> > RowSetMemoryOwner::str_dict_proxy_owned_

private

Definition at line 204 of file RowSetMemoryOwner.h.

Referenced by addStringDict(), cloneStrDictDataOnly(), and getStringDictProxy().

StringDictionaryGenerations RowSetMemoryOwner::string_dictionary_generations_

private

Definition at line 206 of file RowSetMemoryOwner.h.

Referenced by getOrAddStringDictProxy(), getStringDictionaryGenerations(), and setDictionaryGenerations().

std::list<std::string> RowSetMemoryOwner::strings_

private

Definition at line 202 of file RowSetMemoryOwner.h.

Referenced by addString().

std::vector<quantile::TDigest::Memory> RowSetMemoryOwner::t_digest_buffers_

private

Definition at line 210 of file RowSetMemoryOwner.h.

Referenced by newTDigest().

std::vector<std::unique_ptr<quantile::TDigest> > RowSetMemoryOwner::t_digests_

private

Definition at line 209 of file RowSetMemoryOwner.h.

Referenced by newTDigest().

std::vector<void*> RowSetMemoryOwner::varlen_buffers_

private

Definition at line 201 of file RowSetMemoryOwner.h.

Referenced by addVarlenBuffer(), and ~RowSetMemoryOwner().

std::vector<Data_Namespace::AbstractBuffer*> RowSetMemoryOwner::varlen_input_buffers_

private

Definition at line 208 of file RowSetMemoryOwner.h.

Referenced by addVarlenInputBuffer(), and ~RowSetMemoryOwner().

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

/home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/Descriptors/RowSetMemoryOwner.h
/home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/Execute.cpp

Classes

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation