#include <FlatBuffer.h>

Classes
struct	DTypeMetadataSize

struct	DTypeMetadataSizeDictId

Public Types
enum	Status { Success = 0, IndexError, SizeError, ItemAlreadySpecifiedError, ItemUnspecifiedError, ValuesBufferTooSmallError, MemoryError, NotImplemnentedError, UnknownFormatError }

enum	VarlenArrayHeader { FORMAT_ID = 0, FLATBUFFER_SIZE, ITEMS_COUNT, DTYPE_METADATA_KIND, DTYPE_METADATA_BUFFER_SIZE, MAX_NOF_VALUES, STORAGE_COUNT, DTYPE_METADATA_BUFFER_OFFSET, VALUES_OFFSET, COMPRESSED_INDICES_OFFSET, STORAGE_INDICES_OFFSET, EOFHEADER }

enum	DTypeMetadataKind { SIZE = 1, SIZE_DICTID }

Public Member Functions
HOST DEVICE FlatBufferFormat	format () const

int64_t	flatbufferSize () const

HOST DEVICE DTypeMetadataKind	getDTypeMetadataKind () const

int8_t *	getDTypeMetadataBuffer ()

HOST DEVICE const int8_t *	getDTypeMetadataBuffer () const

void	setDTypeMetadataSize (int64_t size)

HOST DEVICE int64_t	getDTypeMetadataSize () const

void	setDTypeMetadataDictKey (int32_t db_id, int32_t dict_id)

int32_t	getDTypeMetadataDictDbId () const

int32_t	getDTypeMetadataDictId () const

void	initializeVarlenArray (int64_t items_count, int64_t max_nof_values, int64_t dtype_size, DTypeMetadataKind dtype_metadata_kind)

HOST DEVICE int64_t	itemsCount () const

HOST DEVICE int64_t	dtypeSize () const

int64_t	VarlenArray_max_nof_values () const

int64_t	VarlenArray_nof_values () const

int64_t	VarlenArray_values_buffer_size () const

int64_t &	VarlenArray_storage_count ()

int64_t &	VarlenArray_storage_count () const

HOST DEVICE int8_t *	VarlenArray_values ()

const int8_t *	VarlenArray_values () const

HOST DEVICE int64_t *	VarlenArray_compressed_indices ()

const int64_t *	VarlenArray_compressed_indices () const

HOST DEVICE int64_t *	VarlenArray_storage_indices ()

const int64_t *	VarlenArray_storage_indices () const

Status	setItem (int64_t index, const int8_t src, int64_t size, int8_t *dest=nullptr)

Status	setItemNoValidation (int64_t index, const int8_t src, int64_t size, int8_t *dest)

Status	setEmptyItemNoValidation (int64_t index, int64_t size, int8_t **dest)

Status	concatItem (int64_t index, const int8_t *src, int64_t size)

Status	setNull (int64_t index)

Status	setNullNoValidation (int64_t index)

Status	isNull (int64_t index, bool &is_null) const

HOST DEVICE Status	getItem (int64_t index, int64_t &size, int8_t *&dest, bool &is_null)

HOST DEVICE Status	getItem (int64_t index, size_t &size, int8_t *&dest, bool &is_null)

Static Public Member Functions
HOST static DEVICE bool	isFlatBuffer (const void *buffer)

static int64_t	getBufferSize (const void *buffer)

static int64_t	getDTypeMetadataBufferSize (DTypeMetadataKind kind)

static int64_t	get_VarlenArray_flatbuffer_size (int64_t items_count, int64_t max_nof_values, int64_t dtype_size, DTypeMetadataKind dtype_metadata_kind)

Public Attributes
int8_t *	buffer

Detailed Description

Definition at line 148 of file FlatBuffer.h.

Member Enumeration Documentation

enum FlatBufferManager::DTypeMetadataKind

Enumerator
SIZE
SIZE_DICTID

Definition at line 225 of file FlatBuffer.h.

                          {
     SIZE = 1,
     SIZE_DICTID,
   };

enum FlatBufferManager::Status

Enumerator
Success
IndexError
SizeError
ItemAlreadySpecifiedError
ItemUnspecifiedError
ValuesBufferTooSmallError
MemoryError
NotImplemnentedError
UnknownFormatError

Definition at line 149 of file FlatBuffer.h.

               {
     Success = 0,
     IndexError,
     SizeError,
     ItemAlreadySpecifiedError,
     ItemUnspecifiedError,
     ValuesBufferTooSmallError,
     MemoryError,
     NotImplemnentedError,
     UnknownFormatError
   };

enum FlatBufferManager::VarlenArrayHeader

Enumerator
FORMAT_ID
FLATBUFFER_SIZE
ITEMS_COUNT
DTYPE_METADATA_KIND
DTYPE_METADATA_BUFFER_SIZE
MAX_NOF_VALUES
STORAGE_COUNT
DTYPE_METADATA_BUFFER_OFFSET
VALUES_OFFSET
COMPRESSED_INDICES_OFFSET
STORAGE_INDICES_OFFSET
EOFHEADER

Definition at line 161 of file FlatBuffer.h.

                          {
     FORMAT_ID = 0,              // storage format id
     FLATBUFFER_SIZE,            // in bytes
     ITEMS_COUNT,                /* the number of items
                                    (e.g. the number of
                                    rows in a column) */
     DTYPE_METADATA_KIND,        /* the kind of dtype metadata */
     DTYPE_METADATA_BUFFER_SIZE, /* the size of dtype metadata buffer */
     MAX_NOF_VALUES,             /* the upper bound to the
                                    total number of values
                                    in all items */
     STORAGE_COUNT,              /* the number of specified
                                    items, incremented by
                                    one on each
                                    setNull/setItem call */
     DTYPE_METADATA_BUFFER_OFFSET,
     VALUES_OFFSET,
     COMPRESSED_INDICES_OFFSET,
     STORAGE_INDICES_OFFSET,
     EOFHEADER
   };

Member Function Documentation

Status FlatBufferManager::concatItem	(	int64_t	index,
		const int8_t *	src,
		int64_t	size
	)

inline

Definition at line 543 of file FlatBuffer.h.

References dtypeSize(), format(), IndexError, itemsCount(), MemoryError, NotImplemnentedError, setItem(), SizeError, Success, UnknownFormatError, VarlenArray, VarlenArray_compressed_indices(), VarlenArray_storage_count(), VarlenArray_storage_indices(), and VarlenArray_values().

                                                                     {
     if (format() == FlatBufferFormat::VarlenArray) {
       if (index < 0 || index >= itemsCount()) {
         return IndexError;
       }
       int64_t next_storage_count = VarlenArray_storage_count();
       int64_t storage_count = next_storage_count - 1;
       int64_t* compressed_indices = VarlenArray_compressed_indices();
       int64_t* storage_indices = VarlenArray_storage_indices();
       int8_t* values = VarlenArray_values();
       int64_t itemsize = dtypeSize();
       int64_t storage_index = storage_indices[index];
 
       if (storage_index == -1) {  // unspecified, so setting the item
         return setItem(index, src, size, nullptr);
       }
       if (size % itemsize != 0) {
         return SizeError;
       }
       if (storage_index != storage_count) {
         return IndexError;  // index does not correspond to the last set
                             // item, only the last item can be
                             // concatenated
       }
       if (compressed_indices[storage_index] < 0) {
         return NotImplemnentedError;  // todo: support concat to null when last
       }
       int64_t values_count =
           compressed_indices[next_storage_count] - compressed_indices[storage_index];
       int64_t extra_values_count = size / itemsize;
       compressed_indices[next_storage_count] += extra_values_count;
       int8_t* ptr = values + compressed_indices[storage_index] * itemsize;
       if (size > 0 && src != nullptr &&
           memcpy(ptr + values_count * itemsize, src, size) == nullptr) {
         return MemoryError;
       }
       return Success;
     }
     return UnknownFormatError;
   }

Here is the call graph for this function:

HOST DEVICE int64_t FlatBufferManager::dtypeSize ( ) const

inline

Definition at line 420 of file FlatBuffer.h.

References getDTypeMetadataSize().

Referenced by concatItem(), getItem(), setItem(), setItemNoValidation(), and VarlenArray_values_buffer_size().

420 { return getDTypeMetadataSize(); }

FlatBufferManager::getDTypeMetadataSize

HOST DEVICE int64_t getDTypeMetadataSize() const

Definition: FlatBuffer.h:282

Here is the call graph for this function:

Here is the caller graph for this function:

int64_t FlatBufferManager::flatbufferSize ( ) const

inline

Definition at line 219 of file FlatBuffer.h.

References buffer.

Referenced by TableFunctionExecutionContext::launchCpuCode(), and synthesize_metadata_table_function().

                                         {
     return ((const int64_t*)(buffer))[VarlenArrayHeader::FLATBUFFER_SIZE];
   }

Here is the caller graph for this function:

HOST DEVICE FlatBufferFormat FlatBufferManager::format ( ) const

inline

Definition at line 213 of file FlatBuffer.h.

References buffer.

Referenced by concatItem(), getItem(), isNull(), itemsCount(), setItem(), and setNull().

                                                      {
     return static_cast<FlatBufferFormat>(
         ((int64_t*)buffer)[VarlenArrayHeader::FORMAT_ID]);
   }

Here is the caller graph for this function:

static int64_t FlatBufferManager::get_VarlenArray_flatbuffer_size	(	int64_t	items_count,
		int64_t	max_nof_values,
		int64_t	dtype_size,
		DTypeMetadataKind	dtype_metadata_kind
	)

inlinestatic

Definition at line 343 of file FlatBuffer.h.

References _align_to_int64(), and getDTypeMetadataBufferSize().

Referenced by getVarlenArrayBufferSize(), and initializeVarlenArray().

                                                                                         {
     const int64_t VarlenArray_buffer_header_size =
         VarlenArrayHeader::EOFHEADER * sizeof(int64_t);
     const int64_t dtype_metadata_buffer_size =
         getDTypeMetadataBufferSize(dtype_metadata_kind);
     const int64_t values_buffer_size = _align_to_int64(dtype_size * max_nof_values);
     return (VarlenArray_buffer_header_size  // see above
             + dtype_metadata_buffer_size    // size of dtype metadata buffer in bytes,
                                             // aligned to int64
             + values_buffer_size            // size of values buffer, aligned to int64
             + (items_count + 1              // size of compressed_indices buffer
                + items_count                // size of storage_indices buffer
                + 1                          // footer format id
                ) * sizeof(int64_t));
   }

Here is the call graph for this function:

Here is the caller graph for this function:

static int64_t FlatBufferManager::getBufferSize ( const void * buffer )

inlinestatic

Definition at line 204 of file FlatBuffer.h.

References isFlatBuffer().

Referenced by ColumnFetcher::transferColumnIfNeeded().

                                                    {
     if (isFlatBuffer(buffer)) {
       return ((const int64_t*)(buffer))[VarlenArrayHeader::FLATBUFFER_SIZE];
     } else {
       return -1;
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

int8_t* FlatBufferManager::getDTypeMetadataBuffer ( )

inline

Definition at line 256 of file FlatBuffer.h.

References buffer.

Referenced by getDTypeMetadataDictDbId(), getDTypeMetadataDictId(), getDTypeMetadataSize(), setDTypeMetadataDictKey(), and setDTypeMetadataSize().

                                           {
     return buffer + ((int64_t*)buffer)[VarlenArrayHeader::DTYPE_METADATA_BUFFER_OFFSET];
   }

Here is the caller graph for this function:

HOST DEVICE const int8_t* FlatBufferManager::getDTypeMetadataBuffer ( ) const

inline

Definition at line 260 of file FlatBuffer.h.

References buffer.

                                                                   {
     return buffer +
            ((const int64_t*)buffer)[VarlenArrayHeader::DTYPE_METADATA_BUFFER_OFFSET];
   }

static int64_t FlatBufferManager::getDTypeMetadataBufferSize ( DTypeMetadataKind kind )

inlinestatic

Definition at line 240 of file FlatBuffer.h.

References _align_to_int64().

Referenced by get_VarlenArray_flatbuffer_size(), and initializeVarlenArray().

                                                                     {
     switch (kind) {
       case DTypeMetadataKind::SIZE:
         return _align_to_int64(sizeof(DTypeMetadataSize));
       case DTypeMetadataKind::SIZE_DICTID:
         return _align_to_int64(sizeof(DTypeMetadataSizeDictId));
       default:
         return 0;
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

int32_t FlatBufferManager::getDTypeMetadataDictDbId ( ) const

inline

Definition at line 314 of file FlatBuffer.h.

References FlatBufferManager::DTypeMetadataSizeDictId::db_id, getDTypeMetadataBuffer(), and getDTypeMetadataKind().

Referenced by Column< Array< T > >::getDictDbId().

                                            {
     switch (getDTypeMetadataKind()) {
       case DTypeMetadataKind::SIZE:
         break;
       case DTypeMetadataKind::SIZE_DICTID: {
         const DTypeMetadataSizeDictId* metadata =
             reinterpret_cast<const DTypeMetadataSizeDictId*>(getDTypeMetadataBuffer());
         return metadata->db_id;
       }
       default:;
     }
     return {};
   }

Here is the call graph for this function:

Here is the caller graph for this function:

int32_t FlatBufferManager::getDTypeMetadataDictId ( ) const

inline

Definition at line 328 of file FlatBuffer.h.

References FlatBufferManager::DTypeMetadataSizeDictId::dict_id, getDTypeMetadataBuffer(), and getDTypeMetadataKind().

Referenced by Column< Array< T > >::getDictId().

                                          {
     switch (getDTypeMetadataKind()) {
       case DTypeMetadataKind::SIZE:
         break;
       case DTypeMetadataKind::SIZE_DICTID: {
         const DTypeMetadataSizeDictId* metadata =
             reinterpret_cast<const DTypeMetadataSizeDictId*>(getDTypeMetadataBuffer());
         return metadata->dict_id;
       }
       default:;
     }
     return {};
   }

Here is the call graph for this function:

Here is the caller graph for this function:

HOST DEVICE DTypeMetadataKind FlatBufferManager::getDTypeMetadataKind ( ) const

inline

Definition at line 251 of file FlatBuffer.h.

References buffer.

Referenced by getDTypeMetadataDictDbId(), getDTypeMetadataDictId(), getDTypeMetadataSize(), setDTypeMetadataDictKey(), and setDTypeMetadataSize().

                                                                     {
     return static_cast<DTypeMetadataKind>(
         ((int64_t*)buffer)[VarlenArrayHeader::DTYPE_METADATA_KIND]);
   }

Here is the caller graph for this function:

HOST DEVICE int64_t FlatBufferManager::getDTypeMetadataSize ( ) const

inline

Definition at line 282 of file FlatBuffer.h.

References getDTypeMetadataBuffer(), getDTypeMetadataKind(), FlatBufferManager::DTypeMetadataSize::size, and FlatBufferManager::DTypeMetadataSizeDictId::size.

Referenced by dtypeSize().

                                                    {
     switch (getDTypeMetadataKind()) {
       case DTypeMetadataKind::SIZE: {
         const DTypeMetadataSize* metadata =
             reinterpret_cast<const DTypeMetadataSize*>(getDTypeMetadataBuffer());
         return metadata->size;
       }
       case DTypeMetadataKind::SIZE_DICTID: {
         const DTypeMetadataSizeDictId* metadata =
             reinterpret_cast<const DTypeMetadataSizeDictId*>(getDTypeMetadataBuffer());
         return metadata->size;
       }
       default:;
     }
     return 0;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

HOST DEVICE Status FlatBufferManager::getItem	(	int64_t	index,
		int64_t &	size,
		int8_t *&	dest,
		bool &	is_null
	)

inline

Definition at line 633 of file FlatBuffer.h.

References dtypeSize(), format(), IndexError, itemsCount(), ItemUnspecifiedError, Success, UnknownFormatError, VarlenArray, VarlenArray_compressed_indices(), VarlenArray_storage_indices(), and VarlenArray_values().

Referenced by getItem(), and VarlenArray_get_nth().

                                                                                          {
     if (format() == FlatBufferFormat::VarlenArray) {
       if (index < 0 || index >= itemsCount()) {
         return IndexError;
       }
       int8_t* values = VarlenArray_values();
       const int64_t* compressed_indices = VarlenArray_compressed_indices();
       const int64_t* storage_indices = VarlenArray_storage_indices();
       const int64_t storage_index = storage_indices[index];
       if (storage_index < 0) {
         return ItemUnspecifiedError;
       }
       const int64_t cindex = compressed_indices[storage_index];
       if (cindex < 0) {
         // null varlen array
         size = 0;
         dest = nullptr;
         is_null = true;
       } else {
         const int64_t dtypesize = dtypeSize();
         const int64_t next_cindex = compressed_indices[storage_index + 1];
         const int64_t length =
             (next_cindex < 0 ? -(next_cindex + 1) - cindex : next_cindex - cindex);
         size = length * dtypesize;
         dest = values + cindex * dtypesize;
         is_null = false;
       }
       return Success;
     } else {
       return UnknownFormatError;
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

HOST DEVICE Status FlatBufferManager::getItem	(	int64_t	index,
		size_t &	size,
		int8_t *&	dest,
		bool &	is_null
	)

inline

Definition at line 666 of file FlatBuffer.h.

References getItem().

                                                                                         {
     int64_t sz{0};
     Status status = getItem(index, sz, dest, is_null);
     size = sz;
     return status;
   }

Here is the call graph for this function:

void FlatBufferManager::initializeVarlenArray	(	int64_t	items_count,
		int64_t	max_nof_values,
		int64_t	dtype_size,
		DTypeMetadataKind	dtype_metadata_kind
	)

inline

Definition at line 363 of file FlatBuffer.h.

References _align_to_int64(), buffer, get_VarlenArray_flatbuffer_size(), getDTypeMetadataBufferSize(), setDTypeMetadataSize(), VarlenArray, VarlenArray_compressed_indices(), and VarlenArray_storage_indices().

Referenced by initializeVarlenArray().

                                                                     {
     const int64_t VarlenArray_buffer_header_size =
         VarlenArrayHeader::EOFHEADER * sizeof(int64_t);
     const int64_t values_buffer_size = _align_to_int64(dtype_size * max_nof_values);
     const int64_t compressed_indices_buffer_size = (items_count + 1) * sizeof(int64_t);
     const int64_t dtype_metadata_buffer_size =
         getDTypeMetadataBufferSize(dtype_metadata_kind);
     const int64_t flatbuffer_size = get_VarlenArray_flatbuffer_size(
         items_count, max_nof_values, dtype_size, dtype_metadata_kind);
     ((int64_t*)buffer)[VarlenArrayHeader::FORMAT_ID] =
         static_cast<int64_t>(FlatBufferFormat::VarlenArray);
     ((int64_t*)buffer)[VarlenArrayHeader::FLATBUFFER_SIZE] = flatbuffer_size;
     ((int64_t*)buffer)[VarlenArrayHeader::ITEMS_COUNT] = items_count;
     ((int64_t*)buffer)[VarlenArrayHeader::MAX_NOF_VALUES] = max_nof_values;
     ((int64_t*)buffer)[VarlenArrayHeader::DTYPE_METADATA_KIND] =
         static_cast<int64_t>(dtype_metadata_kind);
     ((int64_t*)buffer)[VarlenArrayHeader::DTYPE_METADATA_BUFFER_SIZE] =
         dtype_metadata_buffer_size;
     ((int64_t*)buffer)[VarlenArrayHeader::STORAGE_COUNT] = 0;
     ((int64_t*)buffer)[VarlenArrayHeader::DTYPE_METADATA_BUFFER_OFFSET] =
         VarlenArray_buffer_header_size;
     ((int64_t*)buffer)[VarlenArrayHeader::VALUES_OFFSET] =
         ((const int64_t*)buffer)[VarlenArrayHeader::DTYPE_METADATA_BUFFER_OFFSET] +
         dtype_metadata_buffer_size;
     ((int64_t*)buffer)[VarlenArrayHeader::COMPRESSED_INDICES_OFFSET] =
         ((const int64_t*)buffer)[VarlenArrayHeader::VALUES_OFFSET] + values_buffer_size;
     ((int64_t*)buffer)[VarlenArrayHeader::STORAGE_INDICES_OFFSET] =
         ((const int64_t*)buffer)[VarlenArrayHeader::COMPRESSED_INDICES_OFFSET] +
         compressed_indices_buffer_size;
 
     setDTypeMetadataSize(dtype_size);
 
     // initialize indices buffers
     int64_t* compressed_indices = VarlenArray_compressed_indices();
     int64_t* storage_indices = VarlenArray_storage_indices();
     for (int i = 0; i < items_count; i++) {
       compressed_indices[i] = 0;
       storage_indices[i] = -1;
     }
     compressed_indices[items_count] = 0;
     // store footer format id in the last 8-bytes of the flatbuffer:
     ((int64_t*)buffer)[flatbuffer_size / sizeof(int64_t) - 1] =
         static_cast<int64_t>(FlatBufferFormat::VarlenArray);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

HOST static DEVICE bool FlatBufferManager::isFlatBuffer ( const void * buffer )

inlinestatic

Definition at line 186 of file FlatBuffer.h.

References VarlenArray.

Referenced by ChunkIter_get_nth(), ChunkIter_get_nth_varlen(), ColumnarResults::ColumnarResults(), getBufferSize(), ResultSet::makeVarlenTargetValue(), synthesize_metadata_table_function(), ColumnFetcher::transferColumnIfNeeded(), and ColumnarResults::writeBackCell().

                                                            {
     if (buffer) {
       // warning: assume that buffer size is at least 8 bytes
       FlatBufferFormat header_format =
           static_cast<FlatBufferFormat>(((int64_t*)buffer)[VarlenArrayHeader::FORMAT_ID]);
       if (header_format == FlatBufferFormat::VarlenArray) {
         int64_t flatbuffer_size = ((int64_t*)buffer)[VarlenArrayHeader::FLATBUFFER_SIZE];
         if (flatbuffer_size > 0) {
           FlatBufferFormat footer_format = static_cast<FlatBufferFormat>(
               ((int64_t*)buffer)[flatbuffer_size / sizeof(int64_t) - 1]);
           return footer_format == header_format;
         }
       }
     }
     return false;
   }

Here is the caller graph for this function:

Status FlatBufferManager::isNull	(	int64_t	index,
		bool &	is_null
	)		const

inline

Definition at line 613 of file FlatBuffer.h.

References format(), IndexError, itemsCount(), ItemUnspecifiedError, Success, UnknownFormatError, VarlenArray, VarlenArray_compressed_indices(), and VarlenArray_storage_indices().

                                                     {
     if (format() == FlatBufferFormat::VarlenArray) {
       if (index < 0 || index >= itemsCount()) {
         return IndexError;
       }
       const int64_t* compressed_indices = VarlenArray_compressed_indices();
       const int64_t* storage_indices = VarlenArray_storage_indices();
       const int64_t storage_index = storage_indices[index];
       if (storage_index < 0) {
         return ItemUnspecifiedError;
       }
       is_null = (compressed_indices[storage_index] < 0);
       return Success;
     }
     return UnknownFormatError;
   }

Here is the call graph for this function:

HOST DEVICE int64_t FlatBufferManager::itemsCount ( ) const

inline

Definition at line 412 of file FlatBuffer.h.

References buffer, format(), and VarlenArray.

Referenced by concatItem(), getItem(), isNull(), setItem(), and setNull().

                                                 {
     if (format() == FlatBufferFormat::VarlenArray) {
       return ((int64_t*)buffer)[VarlenArrayHeader::ITEMS_COUNT];
     }
     return -1;  // invalid value
   }

Here is the call graph for this function:

Here is the caller graph for this function:

void FlatBufferManager::setDTypeMetadataDictKey	(	int32_t	db_id,
		int32_t	dict_id
	)

inline

Definition at line 300 of file FlatBuffer.h.

References FlatBufferManager::DTypeMetadataSizeDictId::db_id, FlatBufferManager::DTypeMetadataSizeDictId::dict_id, getDTypeMetadataBuffer(), and getDTypeMetadataKind().

Referenced by initializeVarlenArray().

                                                                {
     switch (getDTypeMetadataKind()) {
       case DTypeMetadataKind::SIZE:
         break;
       case DTypeMetadataKind::SIZE_DICTID: {
         DTypeMetadataSizeDictId* metadata =
             reinterpret_cast<DTypeMetadataSizeDictId*>(getDTypeMetadataBuffer());
         metadata->db_id = db_id;
         metadata->dict_id = dict_id;
       } break;
       default:;
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

void FlatBufferManager::setDTypeMetadataSize ( int64_t size )

inline

Definition at line 266 of file FlatBuffer.h.

References getDTypeMetadataBuffer(), getDTypeMetadataKind(), FlatBufferManager::DTypeMetadataSize::size, and FlatBufferManager::DTypeMetadataSizeDictId::size.

Referenced by initializeVarlenArray().

                                           {
     switch (getDTypeMetadataKind()) {
       case DTypeMetadataKind::SIZE: {
         DTypeMetadataSize* metadata =
             reinterpret_cast<DTypeMetadataSize*>(getDTypeMetadataBuffer());
         metadata->size = size;
       } break;
       case DTypeMetadataKind::SIZE_DICTID: {
         DTypeMetadataSizeDictId* metadata =
             reinterpret_cast<DTypeMetadataSizeDictId*>(getDTypeMetadataBuffer());
         metadata->size = size;
       } break;
       default:;
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Status FlatBufferManager::setEmptyItemNoValidation	(	int64_t	index,
		int64_t	size,
		int8_t **	dest
	)

inline

Definition at line 539 of file FlatBuffer.h.

References setItemNoValidation().

                                                                               {
     return setItemNoValidation(index, nullptr, size, dest);
   }

Here is the call graph for this function:

Status FlatBufferManager::setItem	(	int64_t	index,
		const int8_t *	src,
		int64_t	size,
		int8_t **	dest = `nullptr`
	)

inline

Definition at line 481 of file FlatBuffer.h.

References run_benchmark_import::dest, dtypeSize(), format(), IndexError, ItemAlreadySpecifiedError, itemsCount(), setItemNoValidation(), SizeError, UnknownFormatError, ValuesBufferTooSmallError, VarlenArray, VarlenArray_compressed_indices(), VarlenArray_storage_count(), VarlenArray_storage_indices(), and VarlenArray_values_buffer_size().

Referenced by concatItem().

                                           {
     if (format() == FlatBufferFormat::VarlenArray) {
       if (index < 0 || index >= itemsCount()) {
         return IndexError;
       }
       int64_t& storage_count = VarlenArray_storage_count();
       int64_t* compressed_indices = VarlenArray_compressed_indices();
       int64_t* storage_indices = VarlenArray_storage_indices();
       const int64_t itemsize = dtypeSize();
       if (size % itemsize != 0) {
         return SizeError;  // size must be multiple of itemsize. Perhaps size is not in
                            // bytes?
       }
       if (storage_indices[index] >= 0) {
         return ItemAlreadySpecifiedError;
       }
       const int64_t cindex = compressed_indices[storage_count];
       const int64_t values_buffer_size = VarlenArray_values_buffer_size();
       const int64_t csize = cindex * itemsize;
       if (csize + size > values_buffer_size) {
         return ValuesBufferTooSmallError;
       }
       return setItemNoValidation(index, src, size, dest);
     }
     return UnknownFormatError;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Status FlatBufferManager::setItemNoValidation	(	int64_t	index,
		const int8_t *	src,
		int64_t	size,
		int8_t **	dest
	)

inline

Definition at line 512 of file FlatBuffer.h.

References dtypeSize(), MemoryError, Success, VarlenArray_compressed_indices(), VarlenArray_storage_count(), VarlenArray_storage_indices(), and VarlenArray_values().

Referenced by setEmptyItemNoValidation(), and setItem().

                                             {
     int64_t& storage_count = VarlenArray_storage_count();
     int64_t* storage_indices = VarlenArray_storage_indices();
     int64_t* compressed_indices = VarlenArray_compressed_indices();
     int8_t* values = VarlenArray_values();
     const int64_t itemsize = dtypeSize();
     const int64_t values_count = size / itemsize;
     const int64_t cindex = compressed_indices[storage_count];
     const int64_t csize = cindex * itemsize;
     storage_indices[index] = storage_count;
     compressed_indices[storage_count + 1] = cindex + values_count;
     if (size > 0 && src != nullptr && memcpy(values + csize, src, size) == nullptr) {
       return MemoryError;
     }
     if (dest != nullptr) {
       *dest = values + csize;
     }
     storage_count++;
     return Success;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Status FlatBufferManager::setNull ( int64_t index )

inline

Definition at line 585 of file FlatBuffer.h.

References format(), IndexError, ItemAlreadySpecifiedError, itemsCount(), setNullNoValidation(), UnknownFormatError, VarlenArray, and VarlenArray_storage_indices().

Referenced by Column< Array< T > >::concatItem(), Column< Array< T > >::setItem(), and Column< Array< T > >::setNull().

                                 {
     if (format() == FlatBufferFormat::VarlenArray) {
       if (index < 0 || index >= itemsCount()) {
         return IndexError;
       }
       int64_t* storage_indices = VarlenArray_storage_indices();
       if (storage_indices[index] >= 0) {
         return ItemAlreadySpecifiedError;
       }
       return setNullNoValidation(index);
     }
     return UnknownFormatError;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Status FlatBufferManager::setNullNoValidation ( int64_t index )

inline

Definition at line 600 of file FlatBuffer.h.

References Success, VarlenArray_compressed_indices(), VarlenArray_storage_count(), and VarlenArray_storage_indices().

Referenced by setNull().

                                             {
     int64_t& storage_count = VarlenArray_storage_count();
     int64_t* storage_indices = VarlenArray_storage_indices();
     int64_t* compressed_indices = VarlenArray_compressed_indices();
     const int64_t cindex = compressed_indices[storage_count];
     storage_indices[index] = storage_count;
     compressed_indices[storage_count] = -(cindex + 1);
     compressed_indices[storage_count + 1] = cindex;
     storage_count++;
     return Success;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

HOST DEVICE int64_t* FlatBufferManager::VarlenArray_compressed_indices ( )

inline

Definition at line 458 of file FlatBuffer.h.

References buffer.

Referenced by concatItem(), getItem(), initializeVarlenArray(), isNull(), setItem(), setItemNoValidation(), setNullNoValidation(), and VarlenArray_nof_values().

                                                                {
     return reinterpret_cast<int64_t*>(
         buffer + ((const int64_t*)buffer)[VarlenArrayHeader::COMPRESSED_INDICES_OFFSET]);
   }

Here is the caller graph for this function:

const int64_t* FlatBufferManager::VarlenArray_compressed_indices ( ) const

inline

Definition at line 462 of file FlatBuffer.h.

References buffer.

                                                                {
     return reinterpret_cast<const int64_t*>(
         buffer + ((const int64_t*)buffer)[VarlenArrayHeader::COMPRESSED_INDICES_OFFSET]);
   }

int64_t FlatBufferManager::VarlenArray_max_nof_values ( ) const

inline

Definition at line 423 of file FlatBuffer.h.

References buffer.

Referenced by VarlenArray_values_buffer_size().

                                                     {
     return ((int64_t*)buffer)[VarlenArrayHeader::MAX_NOF_VALUES];
   }

Here is the caller graph for this function:

int64_t FlatBufferManager::VarlenArray_nof_values ( ) const

inline

Definition at line 428 of file FlatBuffer.h.

References VarlenArray_compressed_indices(), and VarlenArray_storage_count().

                                                 {
     const int64_t storage_count = VarlenArray_storage_count();
     const int64_t* compressed_indices = VarlenArray_compressed_indices();
     return compressed_indices[storage_count];
   }

Here is the call graph for this function:

int64_t& FlatBufferManager::VarlenArray_storage_count ( )

inline

Definition at line 440 of file FlatBuffer.h.

References buffer.

Referenced by concatItem(), setItem(), setItemNoValidation(), setNullNoValidation(), and VarlenArray_nof_values().

                                               {
     return ((int64_t*)buffer)[VarlenArrayHeader::STORAGE_COUNT];
   }

Here is the caller graph for this function:

int64_t& FlatBufferManager::VarlenArray_storage_count ( ) const

inline

Definition at line 444 of file FlatBuffer.h.

References buffer.

                                                     {
     return ((int64_t*)buffer)[VarlenArrayHeader::STORAGE_COUNT];
   }

HOST DEVICE int64_t* FlatBufferManager::VarlenArray_storage_indices ( )

inline

Definition at line 468 of file FlatBuffer.h.

References buffer.

Referenced by concatItem(), getItem(), initializeVarlenArray(), isNull(), setItem(), setItemNoValidation(), setNull(), and setNullNoValidation().

                                                             {
     return reinterpret_cast<int64_t*>(
         buffer + ((const int64_t*)buffer)[VarlenArrayHeader::STORAGE_INDICES_OFFSET]);
   }

Here is the caller graph for this function:

const int64_t* FlatBufferManager::VarlenArray_storage_indices ( ) const

inline

Definition at line 472 of file FlatBuffer.h.

References buffer.

                                                             {
     return reinterpret_cast<const int64_t*>(
         buffer + ((const int64_t*)buffer)[VarlenArrayHeader::STORAGE_INDICES_OFFSET]);
   }

HOST DEVICE int8_t* FlatBufferManager::VarlenArray_values ( )

inline

Definition at line 449 of file FlatBuffer.h.

References buffer.

Referenced by concatItem(), getItem(), and setItemNoValidation().

                                                   {
     return buffer + ((const int64_t*)buffer)[VarlenArrayHeader::VALUES_OFFSET];
   }

Here is the caller graph for this function:

const int8_t* FlatBufferManager::VarlenArray_values ( ) const

inline

Definition at line 453 of file FlatBuffer.h.

References buffer.

                                                   {
     return buffer + ((const int64_t*)buffer)[VarlenArrayHeader::VALUES_OFFSET];
   }

int64_t FlatBufferManager::VarlenArray_values_buffer_size ( ) const

inline

Definition at line 435 of file FlatBuffer.h.

References _align_to_int64(), dtypeSize(), and VarlenArray_max_nof_values().

Referenced by setItem().

                                                         {
     return _align_to_int64(dtypeSize() * VarlenArray_max_nof_values());
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

int8_t* FlatBufferManager::buffer

Definition at line 183 of file FlatBuffer.h.

Referenced by flatbufferSize(), format(), getDTypeMetadataBuffer(), getDTypeMetadataKind(), initializeVarlenArray(), itemsCount(), VarlenArray_compressed_indices(), VarlenArray_max_nof_values(), VarlenArray_storage_count(), VarlenArray_storage_indices(), and VarlenArray_values().

The documentation for this struct was generated from the following file:

/home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/Utils/FlatBuffer.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation