Utility functions for easy access to the result set buffers. More...

#include "BufferCompaction.h"
#include "Shared/SqlTypesLayout.h"
#include "Shared/misc.h"
#include "TypePunning.h"
#include "Descriptors/QueryMemoryDescriptor.h"
#include <algorithm>

Include dependency graph for ResultSetBufferAccessors.h:

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

Go to the source code of this file.

Functions
bool	is_real_str_or_array (const TargetInfo &target_info)

size_t	get_slots_for_geo_target (const TargetInfo &target_info, const bool separate_varlen_storage)

size_t	get_slots_for_target (const TargetInfo &target_info, const bool separate_varlen_storage)

size_t	advance_slot (const size_t j, const TargetInfo &target_info, const bool separate_varlen_storage)

size_t	slot_offset_rowwise (const size_t entry_idx, const size_t slot_idx, const size_t key_count, const size_t slot_count)

size_t	slot_offset_colwise (const size_t entry_idx, const size_t slot_idx, const size_t key_count, const size_t entry_count)

size_t	key_offset_rowwise (const size_t entry_idx, const size_t key_count, const size_t slot_count)

size_t	key_offset_colwise (const size_t entry_idx, const size_t key_idx, const size_t entry_count)

template<class T >
T	advance_to_next_columnar_target_buff (T target_ptr, const QueryMemoryDescriptor &query_mem_desc, const size_t target_slot_idx)

template<class T >
T	get_cols_ptr (T buff, const QueryMemoryDescriptor &query_mem_desc)

size_t	get_key_bytes_rowwise (const QueryMemoryDescriptor &query_mem_desc)

size_t	get_row_bytes (const QueryMemoryDescriptor &query_mem_desc)

template<class T >
T	row_ptr_rowwise (T buff, const QueryMemoryDescriptor &query_mem_desc, const size_t entry_idx)

template<class T >
T	advance_target_ptr_row_wise (T target_ptr, const TargetInfo &target_info, const size_t slot_idx, const QueryMemoryDescriptor &query_mem_desc, const bool separate_varlen_storage)

template<class T >
T	advance_target_ptr_col_wise (T target_ptr, const TargetInfo &target_info, const size_t slot_idx, const QueryMemoryDescriptor &query_mem_desc, const bool separate_varlen_storage)

size_t	get_slot_off_quad (const QueryMemoryDescriptor &query_mem_desc)

double	pair_to_double (const std::pair< int64_t, int64_t > &fp_pair, const SQLTypeInfo &ti, const bool float_argument_input)

int64_t	null_val_bit_pattern (const SQLTypeInfo &ti, const bool float_argument_input)

int64_t	read_int_from_buff (const int8_t *ptr, const int8_t compact_sz)

Detailed Description

Utility functions for easy access to the result set buffers.

Definition in file ResultSetBufferAccessors.h.

Function Documentation

size_t advance_slot	(	const size_t	j,
		const TargetInfo &	target_info,
		const bool	separate_varlen_storage
	)

inline

Definition at line 74 of file ResultSetBufferAccessors.h.

References get_slots_for_geo_target(), get_slots_for_target(), SQLTypeInfo::is_geometry(), and TargetInfo::sql_type.

Referenced by anonymous_namespace{ResultSetIteration.cpp}::advance_col_buff_to_slot(), ResultSet::eachCellInColumn(), get_heap_key_slot_index(), ResultSet::getSlotIndicesForTargetIndices(), ResultSet::RowWiseTargetAccessor::initializeOffsetsForStorage(), ResultSet::ColumnWiseTargetAccessor::initializeOffsetsForStorage(), ResultSetReductionJIT::reduceOneEntryBaseline(), ResultSetStorage::reduceOneEntrySlotsBaseline(), and ResultSetStorage::rewriteAggregateBufferOffsets().

                                                                {
   if (target_info.sql_type.is_geometry()) {
     return j + get_slots_for_geo_target(target_info, separate_varlen_storage);
   }
   return j + get_slots_for_target(target_info, separate_varlen_storage);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

T advance_target_ptr_col_wise	(	T	target_ptr,
		const TargetInfo &	target_info,
		const size_t	slot_idx,
		const QueryMemoryDescriptor &	query_mem_desc,
		const bool	separate_varlen_storage
	)

inline

Definition at line 172 of file ResultSetBufferAccessors.h.

References advance_to_next_columnar_target_buff(), TargetInfo::agg_kind, SQLTypeInfo::get_physical_coord_cols(), TargetInfo::is_agg, SQLTypeInfo::is_geometry(), is_real_str_or_array(), kAVG, run_benchmark_import::result, and TargetInfo::sql_type.

                                                                          {
   auto result =
       advance_to_next_columnar_target_buff(target_ptr, query_mem_desc, slot_idx);
   if ((target_info.is_agg && target_info.agg_kind == kAVG) ||
       (is_real_str_or_array(target_info) && !separate_varlen_storage)) {
     return advance_to_next_columnar_target_buff(result, query_mem_desc, slot_idx + 1);
   } else if (target_info.sql_type.is_geometry() && !separate_varlen_storage) {
     // TODO: handle varlen projection
     for (auto i = 1; i < 2 * target_info.sql_type.get_physical_coord_cols(); ++i) {
       result = advance_to_next_columnar_target_buff(result, query_mem_desc, slot_idx + i);
     }
     return result;
   } else {
     return result;
   }
 }

Here is the call graph for this function:

template<class T >

T advance_target_ptr_row_wise	(	T	target_ptr,
		const TargetInfo &	target_info,
		const size_t	slot_idx,
		const QueryMemoryDescriptor &	query_mem_desc,
		const bool	separate_varlen_storage
	)

inline

Definition at line 150 of file ResultSetBufferAccessors.h.

References TargetInfo::agg_kind, SQLTypeInfo::get_physical_coord_cols(), QueryMemoryDescriptor::getPaddedSlotWidthBytes(), TargetInfo::is_agg, SQLTypeInfo::is_geometry(), is_real_str_or_array(), kAVG, run_benchmark_import::result, QueryMemoryDescriptor::slotIsVarlenOutput(), and TargetInfo::sql_type.

Referenced by ResultSet::RowWiseTargetAccessor::initializeOffsetsForStorage(), and ResultSetStorage::rewriteAggregateBufferOffsets().

                                                                          {
   auto result = target_ptr + query_mem_desc.getPaddedSlotWidthBytes(slot_idx);
   if ((target_info.is_agg && target_info.agg_kind == kAVG) ||
       ((!separate_varlen_storage || target_info.is_agg) &&
        is_real_str_or_array(target_info))) {
     return result + query_mem_desc.getPaddedSlotWidthBytes(slot_idx + 1);
   }
   const bool is_varlen_output_slot = query_mem_desc.slotIsVarlenOutput(slot_idx);
   if (target_info.sql_type.is_geometry() &&
       (!separate_varlen_storage || target_info.is_agg) && !is_varlen_output_slot) {
     for (auto i = 1; i < 2 * target_info.sql_type.get_physical_coord_cols(); ++i) {
       result += query_mem_desc.getPaddedSlotWidthBytes(slot_idx + i);
     }
   }
   return result;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

T advance_to_next_columnar_target_buff	(	T	target_ptr,
		const QueryMemoryDescriptor &	query_mem_desc,
		const size_t	target_slot_idx
	)

inline

Definition at line 110 of file ResultSetBufferAccessors.h.

References align_to_int64(), QueryMemoryDescriptor::getEntryCount(), and QueryMemoryDescriptor::getPaddedSlotWidthBytes().

Referenced by anonymous_namespace{ResultSetIteration.cpp}::advance_col_buff_to_slot(), advance_target_ptr_col_wise(), ResultSet::eachCellInColumn(), ResultSet::getTargetValueFromBufferColwise(), ResultSet::ColumnWiseTargetAccessor::initializeOffsetsForStorage(), ResultSet::makeGeoTargetValue(), and ResultSetStorage::reduceEntriesNoCollisionsColWise().

                                                                             {
   auto new_target_ptr = target_ptr;
   const auto column_size = query_mem_desc.getEntryCount() *
                            query_mem_desc.getPaddedSlotWidthBytes(target_slot_idx);
   new_target_ptr += align_to_int64(column_size);
 
   return new_target_ptr;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T >

T get_cols_ptr	(	T	buff,
		const QueryMemoryDescriptor &	query_mem_desc
	)

inline

Definition at line 122 of file ResultSetBufferAccessors.h.

References CHECK, QueryMemoryDescriptor::didOutputColumnar(), and QueryMemoryDescriptor::getColOffInBytes().

Referenced by anonymous_namespace{ResultSetIteration.cpp}::advance_col_buff_to_slot(), ResultSet::eachCellInColumn(), ResultSet::ColumnWiseTargetAccessor::initializeOffsetsForStorage(), and ResultSetStorage::reduceEntriesNoCollisionsColWise().

                                                                            {
   CHECK(query_mem_desc.didOutputColumnar());
   return buff + query_mem_desc.getColOffInBytes(0);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t get_key_bytes_rowwise ( const QueryMemoryDescriptor & query_mem_desc )

inline

Definition at line 127 of file ResultSetBufferAccessors.h.

References CHECK, QueryMemoryDescriptor::getEffectiveKeyWidth(), QueryMemoryDescriptor::getGroupbyColCount(), and QueryMemoryDescriptor::hasKeylessHash().

Referenced by ResultSet::eachCellInColumn(), get_row_bytes(), get_slot_off_quad(), ResultSet::getOneColRow(), ResultSetStorage::initializeRowWise(), ResultSetReductionJIT::reduceOneEntryNoCollisions(), and ResultSetStorage::rewriteAggregateBufferOffsets().

                                                                                  {
   if (query_mem_desc.hasKeylessHash()) {
     return 0;
   }
   auto consist_key_width = query_mem_desc.getEffectiveKeyWidth();
   CHECK(consist_key_width);
   return consist_key_width * query_mem_desc.getGroupbyColCount();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t get_row_bytes ( const QueryMemoryDescriptor & query_mem_desc )

inline

Definition at line 136 of file ResultSetBufferAccessors.h.

References align_to_int64(), get_key_bytes_rowwise(), QueryMemoryDescriptor::getRowWidth(), and run_benchmark_import::result.

Referenced by anonymous_namespace{ResultSetReduction.cpp}::get_row_qw_count(), ResultSetStorage::initializeRowWise(), ResultSetReductionJIT::reduceOneEntryBaselineIdx(), ResultSetReductionJIT::reduceOneEntryNoCollisionsIdx(), and row_ptr_rowwise().

                                                                          {
   size_t result = align_to_int64(get_key_bytes_rowwise(query_mem_desc));  // plus padding
   return result + query_mem_desc.getRowWidth();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t get_slot_off_quad ( const QueryMemoryDescriptor & query_mem_desc )

inline

Definition at line 193 of file ResultSetBufferAccessors.h.

References align_to_int64(), and get_key_bytes_rowwise().

Referenced by anonymous_namespace{ResultSetReduction.cpp}::fill_slots(), anonymous_namespace{ResultSetReduction.cpp}::get_matching_group_value_reduction(), and ResultSetReductionJIT::reduceOneEntryBaselineIdx().

                                                                              {
   return align_to_int64(get_key_bytes_rowwise(query_mem_desc)) / sizeof(int64_t);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t get_slots_for_geo_target	(	const TargetInfo &	target_info,
		const bool	separate_varlen_storage
	)

inline

Definition at line 44 of file ResultSetBufferAccessors.h.

References SQLTypeInfo::get_physical_coord_cols(), TargetInfo::is_agg, TargetInfo::is_varlen_projection, and TargetInfo::sql_type.

Referenced by advance_slot().

                                                                            {
   // Aggregates on geospatial types are serialized directly by rewriting the underlying
   // buffer. Even if separate varlen storage is valid, treat aggregates the same on
   // distributed and single node
   if (target_info.is_varlen_projection ||
       (separate_varlen_storage && !target_info.is_agg)) {
     return 1;
   } else {
     return 2 * target_info.sql_type.get_physical_coord_cols();
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t get_slots_for_target	(	const TargetInfo &	target_info,
		const bool	separate_varlen_storage
	)

inline

Definition at line 57 of file ResultSetBufferAccessors.h.

References TargetInfo::agg_kind, TargetInfo::is_agg, is_real_str_or_array(), and kAVG.

Referenced by advance_slot().

                                                                        {
   if (target_info.is_agg) {
     if (target_info.agg_kind == kAVG || is_real_str_or_array(target_info)) {
       return 2;
     } else {
       return 1;
     }
   } else {
     if (is_real_str_or_array(target_info) && !separate_varlen_storage) {
       return 2;
     } else {
       return 1;
     }
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

bool is_real_str_or_array ( const TargetInfo & target_info )

inline

Definition at line 37 of file ResultSetBufferAccessors.h.

References TargetInfo::agg_kind, SQLTypeInfo::get_compression(), TargetInfo::is_agg, SQLTypeInfo::is_array(), SQLTypeInfo::is_string(), kENCODING_NONE, kSAMPLE, and TargetInfo::sql_type.

Referenced by advance_target_ptr_col_wise(), advance_target_ptr_row_wise(), get_slots_for_target(), ResultSet::getTargetValueFromBufferColwise(), ResultSet::getTargetValueFromBufferRowwise(), ResultSet::RowWiseTargetAccessor::initializeOffsetsForStorage(), and ResultSet::ColumnWiseTargetAccessor::initializeOffsetsForStorage().

                                                                 {
   return (!target_info.is_agg || target_info.agg_kind == kSAMPLE) &&
          (target_info.sql_type.is_array() ||
           (target_info.sql_type.is_string() &&
            target_info.sql_type.get_compression() == kENCODING_NONE));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t key_offset_colwise	(	const size_t	entry_idx,
		const size_t	key_idx,
		const size_t	entry_count
	)

inline

Definition at line 103 of file ResultSetBufferAccessors.h.

Referenced by ResultSetStorage::fillOneEntryColWise(), ResultSetStorage::initializeColWise(), ResultSetStorage::moveOneEntryToBuffer(), and ResultSetStorage::reduceOneEntryBaseline().

                                                            {
   return key_idx * entry_count + entry_idx;
 }

Here is the caller graph for this function:

size_t key_offset_rowwise	(	const size_t	entry_idx,
		const size_t	key_count,
		const size_t	slot_count
	)

inline

Definition at line 97 of file ResultSetBufferAccessors.h.

Referenced by ResultSetStorage::fillOneEntryRowWise().

                                                           {
   return (key_count + slot_count) * entry_idx;
 }

Here is the caller graph for this function:

int64_t null_val_bit_pattern	(	const SQLTypeInfo &	ti,
		const bool	float_argument_input
	)

inline

Definition at line 231 of file ResultSetBufferAccessors.h.

References SQLTypeInfo::get_compression(), SQLTypeInfo::get_type(), inline_fp_null_val(), inline_int_null_val(), SQLTypeInfo::is_array(), SQLTypeInfo::is_fp(), SQLTypeInfo::is_geometry(), SQLTypeInfo::is_string(), kENCODING_NONE, kFLOAT, and NULL_FLOAT.

Referenced by anonymous_namespace{ResultSetSortImpl.cu}::baseline_sort_fp(), anonymous_namespace{ResultSetSortImpl.cu}::baseline_sort_int(), WindowFunctionContext::computeNullRangeOfSortedPartition(), anonymous_namespace{WindowContext.cpp}::fp_comparator_asc(), anonymous_namespace{WindowContext.cpp}::fp_comparator_desc(), result_set::initialize_target_values_for_storage(), ResultSet::isNull(), and pop_n_rows_from_merged_heaps_gpu().

                                                                      {
   if (ti.is_fp()) {
     if (float_argument_input && ti.get_type() == kFLOAT) {
       return shared::reinterpret_bits<int64_t>(NULL_FLOAT);  // 1<<23
     }
     const auto double_null_val = inline_fp_null_val(ti);
     return shared::reinterpret_bits<int64_t>(double_null_val);  // 0x381<<52 or 1<<52
   }
   if ((ti.is_string() && ti.get_compression() == kENCODING_NONE) || ti.is_array() ||
       ti.is_geometry()) {
     return 0;
   }
   return inline_int_null_val(ti);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

double pair_to_double	(	const std::pair< int64_t, int64_t > &	fp_pair,
		const SQLTypeInfo &	ti,
		const bool	float_argument_input
	)

inline

Definition at line 199 of file ResultSetBufferAccessors.h.

References CHECK, exp_to_scale(), logger::FATAL, SQLTypeInfo::get_scale(), SQLTypeInfo::get_type(), SQLTypeInfo::get_type_name(), SQLTypeInfo::is_decimal(), SQLTypeInfo::is_integer(), kDOUBLE, kFLOAT, LOG_IF, and NULL_DOUBLE.

Referenced by anonymous_namespace{ResultSetIteration.cpp}::make_avg_target_value(), and ResultSet::ResultSetComparator< BUFFER_ITERATOR_TYPE >::operator()().

                                                               {
   if (fp_pair.second == 0) {
     return NULL_DOUBLE;
   }
   double dividend{0.0};
   switch (ti.get_type()) {
     case kFLOAT:
       if (float_argument_input) {
         dividend = shared::reinterpret_bits<float>(fp_pair.first);
         break;
       }
     case kDOUBLE:
       dividend = shared::reinterpret_bits<double>(fp_pair.first);
       break;
     default:
 #ifndef __CUDACC__
       LOG_IF(FATAL, !(ti.is_integer() || ti.is_decimal()))
           << "Unsupported type for pair to double conversion: " << ti.get_type_name();
 #else
       CHECK(ti.is_integer() || ti.is_decimal());
 #endif
       dividend = static_cast<double>(fp_pair.first);
       break;
   }
   return ti.is_decimal() && ti.get_scale()
              ? dividend /
                    (static_cast<double>(fp_pair.second) * exp_to_scale(ti.get_scale()))
              : dividend / static_cast<double>(fp_pair.second);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

int64_t read_int_from_buff	(	const int8_t *	ptr,
		const int8_t	compact_sz
	)

inline

Definition at line 248 of file ResultSetBufferAccessors.h.

References UNREACHABLE.

Referenced by ResultSet::eachCellInColumn(), ResultSet::RowWiseTargetAccessor::getColumnInternal(), ResultSet::ColumnWiseTargetAccessor::getColumnInternal(), ResultSetStorage::isEmptyEntry(), ResultSetStorage::isEmptyEntryColumnar(), anonymous_namespace{ResultSetIteration.cpp}::make_avg_target_value(), ResultSet::makeGeoTargetValue(), ResultSet::makeTargetValue(), and ResultSet::makeVarlenTargetValue().

                                                                               {
   switch (compact_sz) {
     case 8: {
       return *reinterpret_cast<const int64_t*>(ptr);
     }
     case 4: {
       return *reinterpret_cast<const int32_t*>(ptr);
     }
     case 2: {
       return *reinterpret_cast<const int16_t*>(ptr);
     }
     case 1: {
       return *reinterpret_cast<const int8_t*>(ptr);
     }
     default:
       UNREACHABLE();
   }
   UNREACHABLE();
   return 0;
 }

Here is the caller graph for this function:

template<class T >

T row_ptr_rowwise	(	T	buff,
		const QueryMemoryDescriptor &	query_mem_desc,
		const size_t	entry_idx
	)

inline

Definition at line 142 of file ResultSetBufferAccessors.h.

References get_row_bytes().

Referenced by ResultSetStorage::binSearchRowCount(), ResultSet::eachCellInColumn(), ResultSet::getOneColRow(), ResultSet::getRowWiseBaselineEntryAt(), ResultSetStorage::isEmptyEntry(), and ResultSetStorage::rewriteAggregateBufferOffsets().

                                                  {
   const auto row_bytes = get_row_bytes(query_mem_desc);
   return buff + entry_idx * row_bytes;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

size_t slot_offset_colwise	(	const size_t	entry_idx,
		const size_t	slot_idx,
		const size_t	key_count,
		const size_t	entry_count
	)

inline

Definition at line 90 of file ResultSetBufferAccessors.h.

Referenced by anonymous_namespace{ResultSetReduction.cpp}::fill_slots(), ResultSetStorage::fillOneEntryColWise(), ResultSetStorage::initializeColWise(), and ResultSetStorage::reduceOneEntrySlotsBaseline().

                                                             {
   return (key_count + slot_idx) * entry_count + entry_idx;
 }

Here is the caller graph for this function:

size_t slot_offset_rowwise	(	const size_t	entry_idx,
		const size_t	slot_idx,
		const size_t	key_count,
		const size_t	slot_count
	)

inline

Definition at line 83 of file ResultSetBufferAccessors.h.

Referenced by ResultSetStorage::fillOneEntryRowWise().

                                                            {
   return (key_count + slot_count) * entry_idx + (key_count + slot_idx);
 }

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation