Data_Namespace::AbstractBuffer Class Reference

An AbstractBuffer is a unit of data management for a data manager. More...

#include <AbstractBuffer.h>

Inheritance diagram for Data_Namespace::AbstractBuffer:

Collaboration diagram for Data_Namespace::AbstractBuffer:

Public Member Functions
	AbstractBuffer (const int device_id)
	AbstractBuffer (const int device_id, const SQLTypeInfo sql_type)
virtual	~AbstractBuffer ()
virtual void	read (int8_t *const dst, const size_t num_bytes, const size_t offset=0, const MemoryLevel dst_buffer_type=CPU_LEVEL, const int dst_device_id=-1)=0
virtual void	write (int8_t *src, const size_t num_bytes, const size_t offset=0, const MemoryLevel src_buffer_type=CPU_LEVEL, const int src_device_id=-1)=0
virtual void	reserve (size_t num_bytes)=0
virtual void	append (int8_t *src, const size_t num_bytes, const MemoryLevel src_buffer_type=CPU_LEVEL, const int device_id=-1)=0
virtual int8_t *	getMemoryPtr ()=0
virtual size_t	pageCount () const =0
virtual size_t	pageSize () const =0
virtual size_t	size () const =0
virtual size_t	reservedSize () const =0
virtual int	getDeviceId () const
virtual MemoryLevel	getType () const =0
virtual int	pin ()
virtual int	unPin ()
virtual int	getPinCount ()
virtual bool	isDirty () const
virtual bool	isAppended () const
virtual bool	isUpdated () const
virtual void	setDirty ()
virtual void	setUpdated ()
virtual void	setAppended ()
void	setSize (const size_t size)
void	clearDirtyBits ()
void	initEncoder (const SQLTypeInfo tmp_sql_type)
void	syncEncoder (const AbstractBuffer *src_buffer)

Public Attributes
std::unique_ptr< Encoder >	encoder
bool	has_encoder
SQLTypeInfo	sql_type

Protected Attributes
size_t	size_
bool	is_dirty_
bool	is_appended_
bool	is_updated_
int	device_id_

Detailed Description

An AbstractBuffer is a unit of data management for a data manager.

Definition at line 47 of file AbstractBuffer.h.

Constructor & Destructor Documentation

Data_Namespace::AbstractBuffer::AbstractBuffer ( const int  device_id )

inline

Definition at line 49 of file AbstractBuffer.h.

      : has_encoder(false)
      , size_(0)
      , is_dirty_(false)
      , is_appended_(false)
      , is_updated_(false)
      , device_id_(device_id) {}

Data_Namespace::AbstractBuffer::AbstractBuffer ( const int  device_id, const SQLTypeInfo  sql_type  )

inline

Definition at line 56 of file AbstractBuffer.h.

References initEncoder().

      : size_(0)
      , is_dirty_(false)
      , is_appended_(false)
      , is_updated_(false)
      , device_id_(device_id) {
    initEncoder(sql_type);
  }

Here is the call graph for this function:

virtual Data_Namespace::AbstractBuffer::~AbstractBuffer ( )

inlinevirtual

Definition at line 64 of file AbstractBuffer.h.

{}

Member Function Documentation

virtual void Data_Namespace::AbstractBuffer::append ( int8_t *  src, const size_t  num_bytes, const MemoryLevel  src_buffer_type = CPU_LEVEL, const int  device_id = -1  )

pure virtual

Implemented in File_Namespace::FileBuffer, Buffer_Namespace::Buffer, and ForeignStorageBuffer.

Referenced by DateDaysEncoder< T, V >::appendData(), FixedLengthEncoder< T, V >::appendData(), NoneEncoder< T >::appendData(), StringNoneEncoder::appendData(), FixedLengthArrayNoneEncoder::appendData(), ArrayNoneEncoder::appendData(), File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

Here is the caller graph for this function:

void Data_Namespace::AbstractBuffer::clearDirtyBits ( )

inline

Definition at line 112 of file AbstractBuffer.h.

References is_appended_, is_dirty_, and is_updated_.

Referenced by File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

                        {
    is_appended_ = false;
    is_updated_ = false;
    is_dirty_ = false;
  }

Here is the caller graph for this function:

virtual int Data_Namespace::AbstractBuffer::getDeviceId ( ) const

inlinevirtual

Definition at line 87 of file AbstractBuffer.h.

References device_id_.

Referenced by Data_Namespace::DataMgr::copy(), File_Namespace::FileMgr::fetchBuffer(), Buffer_Namespace::BufferMgr::fetchBuffer(), Data_Namespace::DataMgr::free(), File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

{ return device_id_; }

Here is the caller graph for this function:

virtual int8_t* Data_Namespace::AbstractBuffer::getMemoryPtr ( )

pure virtual

Implemented in File_Namespace::FileBuffer, Buffer_Namespace::Buffer, and ForeignStorageBuffer.

Referenced by ThrustAllocator::allocate(), ThrustAllocator::allocateScopedBuffer(), Fragmenter_Namespace::ArrayChunkConverter::ArrayChunkConverter(), Chunk_NS::Chunk::begin_iterator(), Data_Namespace::DataMgr::copy(), Fragmenter_Namespace::DateChunkConverter< BUFFER_DATA_TYPE >::DateChunkConverter(), File_Namespace::FileMgr::fetchBuffer(), ForeignStorageBufferMgr::fetchBuffer(), Buffer_Namespace::BufferMgr::fetchBuffer(), Fragmenter_Namespace::FixedLenArrayChunkConverter::FixedLenArrayChunkConverter(), File_Namespace::FileMgr::putBuffer(), Buffer_Namespace::BufferMgr::putBuffer(), Fragmenter_Namespace::ScalarChunkConverter< BUFFER_DATA_TYPE, INSERT_DATA_TYPE >::ScalarChunkConverter(), and Fragmenter_Namespace::StringChunkConverter::StringChunkConverter().

Here is the caller graph for this function:

virtual int Data_Namespace::AbstractBuffer::getPinCount ( )

inlinevirtual

Reimplemented in Buffer_Namespace::Buffer.

Definition at line 93 of file AbstractBuffer.h.

{ return 0; }

virtual MemoryLevel Data_Namespace::AbstractBuffer::getType ( ) const

pure virtual

Implemented in File_Namespace::FileBuffer, ForeignStorageBuffer, Buffer_Namespace::CpuBuffer, and Buffer_Namespace::GpuCudaBuffer.

Referenced by RowSetMemoryOwner::addVarlenInputBuffer(), Data_Namespace::DataMgr::copy(), File_Namespace::FileMgr::fetchBuffer(), Buffer_Namespace::BufferMgr::fetchBuffer(), Data_Namespace::DataMgr::free(), File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

Here is the caller graph for this function:

void Data_Namespace::AbstractBuffer::initEncoder ( const SQLTypeInfo  tmp_sql_type )

inline

Definition at line 117 of file AbstractBuffer.h.

References Encoder::Create(), encoder, logger::FATAL, SQLTypeInfo::get_type_name(), has_encoder, LOG_IF, and sql_type.

Referenced by AbstractBuffer(), Chunk_NS::Chunk::init_encoder(), File_Namespace::FileBuffer::readMetadata(), and syncEncoder().

                                                   {
    has_encoder = true;
    sql_type = tmp_sql_type;
    encoder.reset(Encoder::Create(this, sql_type));
    LOG_IF(FATAL, encoder == nullptr)
        << "Failed to create encoder for SQL Type " << sql_type.get_type_name();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool Data_Namespace::AbstractBuffer::isAppended ( ) const

inlinevirtual

Definition at line 96 of file AbstractBuffer.h.

References is_appended_.

Referenced by File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

{ return is_appended_; }

Here is the caller graph for this function:

virtual bool Data_Namespace::AbstractBuffer::isDirty ( ) const

inlinevirtual

Reimplemented in File_Namespace::FileBuffer, and Buffer_Namespace::Buffer.

Definition at line 95 of file AbstractBuffer.h.

References is_dirty_.

Referenced by StringNoneEncoder::appendData(), FixedLengthArrayNoneEncoder::appendData(), ArrayNoneEncoder::appendData(), File_Namespace::FileMgr::fetchBuffer(), File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

{ return is_dirty_; }

Here is the caller graph for this function:

virtual bool Data_Namespace::AbstractBuffer::isUpdated ( ) const

inlinevirtual

Definition at line 97 of file AbstractBuffer.h.

References is_updated_.

Referenced by File_Namespace::FileMgr::fetchBuffer(), Buffer_Namespace::BufferMgr::fetchBuffer(), File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

{ return is_updated_; }

Here is the caller graph for this function:

virtual size_t Data_Namespace::AbstractBuffer::pageCount ( ) const

pure virtual

Implemented in File_Namespace::FileBuffer, Buffer_Namespace::Buffer, and ForeignStorageBuffer.

virtual size_t Data_Namespace::AbstractBuffer::pageSize ( ) const

pure virtual

Implemented in File_Namespace::FileBuffer, Buffer_Namespace::Buffer, and ForeignStorageBuffer.

virtual int Data_Namespace::AbstractBuffer::pin ( )

inlinevirtual

Reimplemented in Buffer_Namespace::Buffer.

Definition at line 91 of file AbstractBuffer.h.

Referenced by Buffer_Namespace::BufferMgr::fetchBuffer().

{ return 0; }

Here is the caller graph for this function:

virtual void Data_Namespace::AbstractBuffer::read ( int8_t *const  dst, const size_t  num_bytes, const size_t  offset = 0, const MemoryLevel  dst_buffer_type = CPU_LEVEL, const int  dst_device_id = -1  )

pure virtual

Implemented in File_Namespace::FileBuffer, Buffer_Namespace::Buffer, and ForeignStorageBuffer.

Referenced by StringNoneEncoder::appendData(), ArrayNoneEncoder::appendData(), File_Namespace::FileMgr::fetchBuffer(), and Buffer_Namespace::BufferMgr::fetchBuffer().

Here is the caller graph for this function:

virtual void Data_Namespace::AbstractBuffer::reserve ( size_t  num_bytes )

pure virtual

Implemented in Buffer_Namespace::Buffer, ForeignStorageBuffer, and File_Namespace::FileBuffer.

Referenced by StringNoneEncoder::appendData(), FixedLengthArrayNoneEncoder::appendData(), ArrayNoneEncoder::appendData(), File_Namespace::FileMgr::fetchBuffer(), ForeignStorageBufferMgr::fetchBuffer(), and Buffer_Namespace::BufferMgr::fetchBuffer().

Here is the caller graph for this function:

virtual size_t Data_Namespace::AbstractBuffer::reservedSize ( ) const

pure virtual

Implemented in File_Namespace::FileBuffer, Buffer_Namespace::Buffer, and ForeignStorageBuffer.

virtual void Data_Namespace::AbstractBuffer::setAppended ( )

inlinevirtual

Definition at line 106 of file AbstractBuffer.h.

References is_appended_, and is_dirty_.

                                    {
    is_appended_ = true;
    is_dirty_ = true;
  }

virtual void Data_Namespace::AbstractBuffer::setDirty ( )

inlinevirtual

Definition at line 99 of file AbstractBuffer.h.

References is_dirty_.

Referenced by StringNoneEncoder::appendData(), FixedLengthArrayNoneEncoder::appendData(), ArrayNoneEncoder::appendData(), and File_Namespace::FileMgr::init().

{ is_dirty_ = true; }

Here is the caller graph for this function:

void Data_Namespace::AbstractBuffer::setSize ( const size_t  size )

inline

Definition at line 111 of file AbstractBuffer.h.

References size(), and size_.

Referenced by File_Namespace::FileMgr::fetchBuffer(), ForeignStorageBufferMgr::fetchBuffer(), Buffer_Namespace::BufferMgr::fetchBuffer(), File_Namespace::FileMgr::init(), and File_Namespace::FileMgr::putBuffer().

{ size_ = size; }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void Data_Namespace::AbstractBuffer::setUpdated ( )

inlinevirtual

Definition at line 101 of file AbstractBuffer.h.

References is_dirty_, and is_updated_.

                                   {
    is_updated_ = true;
    is_dirty_ = true;
  }

virtual size_t Data_Namespace::AbstractBuffer::size ( ) const

pure virtual

Implemented in File_Namespace::FileBuffer, Buffer_Namespace::Buffer, and ForeignStorageBuffer.

Referenced by StringNoneEncoder::appendData(), ArrayNoneEncoder::appendData(), Chunk_NS::Chunk::begin_iterator(), Data_Namespace::DataMgr::copy(), File_Namespace::FileMgr::fetchBuffer(), Buffer_Namespace::BufferMgr::fetchBuffer(), Encoder::getMetadata(), File_Namespace::FileMgr::putBuffer(), Buffer_Namespace::BufferMgr::putBuffer(), and setSize().

Here is the caller graph for this function:

void Data_Namespace::AbstractBuffer::syncEncoder ( const AbstractBuffer *  src_buffer )

inline

Definition at line 125 of file AbstractBuffer.h.

References encoder, has_encoder, initEncoder(), and sql_type.

Referenced by File_Namespace::FileMgr::fetchBuffer(), ForeignStorageBufferMgr::fetchBuffer(), Buffer_Namespace::BufferMgr::fetchBuffer(), File_Namespace::FileMgr::init(), File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

                                                     {
    has_encoder = src_buffer->has_encoder;
    if (has_encoder) {
      if (!encoder) {  // Encoder not initialized
        initEncoder(src_buffer->sql_type);
      }
      encoder->copyMetadata(src_buffer->encoder.get());
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual int Data_Namespace::AbstractBuffer::unPin ( )

inlinevirtual

Reimplemented in Buffer_Namespace::Buffer.

Definition at line 92 of file AbstractBuffer.h.

Referenced by Buffer_Namespace::BufferMgr::fetchBuffer(), and Chunk_NS::Chunk::unpin_buffer().

{ return 0; }

Here is the caller graph for this function:

virtual void Data_Namespace::AbstractBuffer::write ( int8_t *  src, const size_t  num_bytes, const size_t  offset = 0, const MemoryLevel  src_buffer_type = CPU_LEVEL, const int  src_device_id = -1  )

pure virtual

Implemented in File_Namespace::FileBuffer, Buffer_Namespace::Buffer, and ForeignStorageBuffer.

Referenced by DateDaysEncoder< T, V >::appendData(), FixedLengthEncoder< T, V >::appendData(), NoneEncoder< T >::appendData(), Data_Namespace::DataMgr::copy(), File_Namespace::FileMgr::putBuffer(), and Buffer_Namespace::BufferMgr::putBuffer().

Here is the caller graph for this function:

Member Data Documentation

int Data_Namespace::AbstractBuffer::device_id_

protected

Definition at line 144 of file AbstractBuffer.h.

Referenced by getDeviceId(), Buffer_Namespace::GpuCudaBuffer::readData(), and Buffer_Namespace::GpuCudaBuffer::writeData().

std::unique_ptr<Encoder> Data_Namespace::AbstractBuffer::encoder

Definition at line 135 of file AbstractBuffer.h.

Referenced by Chunk_NS::Chunk::appendData(), Chunk_NS::Chunk::getChunkBuffer(), Chunk_NS::Chunk::getNumElemsForBytesInsertData(), Chunk_NS::Chunk::init_encoder(), initEncoder(), File_Namespace::FileBuffer::readMetadata(), syncEncoder(), and File_Namespace::FileBuffer::writeMetadata().

bool Data_Namespace::AbstractBuffer::has_encoder

Definition at line 136 of file AbstractBuffer.h.

Referenced by initEncoder(), File_Namespace::FileBuffer::readMetadata(), syncEncoder(), and File_Namespace::FileBuffer::writeMetadata().

bool Data_Namespace::AbstractBuffer::is_appended_

protected

Definition at line 142 of file AbstractBuffer.h.

Referenced by ForeignStorageBuffer::append(), Buffer_Namespace::Buffer::append(), File_Namespace::FileBuffer::append(), clearDirtyBits(), isAppended(), setAppended(), Buffer_Namespace::Buffer::write(), and File_Namespace::FileBuffer::write().

bool Data_Namespace::AbstractBuffer::is_dirty_

protected

Definition at line 141 of file AbstractBuffer.h.

Referenced by ForeignStorageBuffer::append(), Buffer_Namespace::Buffer::append(), File_Namespace::FileBuffer::append(), clearDirtyBits(), isDirty(), setAppended(), setDirty(), setUpdated(), Buffer_Namespace::Buffer::write(), and File_Namespace::FileBuffer::write().

bool Data_Namespace::AbstractBuffer::is_updated_

protected

Definition at line 143 of file AbstractBuffer.h.

Referenced by clearDirtyBits(), isUpdated(), setUpdated(), Buffer_Namespace::Buffer::write(), and File_Namespace::FileBuffer::write().

size_t Data_Namespace::AbstractBuffer::size_

protected

Definition at line 140 of file AbstractBuffer.h.

Referenced by ForeignStorageBuffer::append(), Buffer_Namespace::Buffer::append(), File_Namespace::FileBuffer::append(), Buffer_Namespace::Buffer::read(), File_Namespace::FileBuffer::readMetadata(), setSize(), ForeignStorageBuffer::size(), Buffer_Namespace::Buffer::write(), File_Namespace::FileBuffer::write(), and File_Namespace::FileBuffer::writeMetadata().

SQLTypeInfo Data_Namespace::AbstractBuffer::sql_type

Definition at line 137 of file AbstractBuffer.h.

Referenced by Encoder::getMetadata(), initEncoder(), FixedLengthArrayNoneEncoder::is_null(), ForeignStorageBuffer::read(), File_Namespace::FileBuffer::readMetadata(), syncEncoder(), FixedLengthArrayNoneEncoder::update_elem_stats(), ArrayNoneEncoder::update_elem_stats(), and File_Namespace::FileBuffer::writeMetadata().

---

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

• /home/jenkins-slave/workspace/core-os-doxygen/DataMgr/AbstractBuffer.h