#include <PassThroughBuffer.h>

Inheritance diagram for foreign_storage::PassThroughBuffer:

Collaboration diagram for foreign_storage::PassThroughBuffer:

Public Member Functions
	PassThroughBuffer (const int8_t *data, const size_t data_byte_size)

	PassThroughBuffer ()=delete

void	read (int8_t *const destination, const size_t num_bytes, const size_t offset=0, const MemoryLevel destination_buffer_type=CPU_LEVEL, const int destination_device_id=-1) override

void	write (int8_t *source, const size_t num_bytes, const size_t offset=0, const MemoryLevel source_buffer_type=CPU_LEVEL, const int source_device_id=-1) override

void	reserve (size_t additional_num_bytes) override

void	append (int8_t *source, const size_t num_bytes, const MemoryLevel source_buffer_type=CPU_LEVEL, const int device_id=-1) override

int8_t *	getMemoryPtr () override

size_t	pageCount () const override

size_t	pageSize () const override

size_t	reservedSize () const override

MemoryLevel	getType () const override

Public Member Functions inherited from Data_Namespace::AbstractBuffer
	AbstractBuffer (const int device_id)

	AbstractBuffer (const int device_id, const SQLTypeInfo sql_type)

virtual	~AbstractBuffer ()

virtual void	setMemoryPtr (int8_t *new_ptr)

virtual int	pin ()

virtual int	unPin ()

virtual int	getPinCount ()

size_t	size () const

int	getDeviceId () const

bool	isDirty () const

bool	isAppended () const

bool	isUpdated () const

bool	hasEncoder () const

SQLTypeInfo	getSqlType () const

void	setSqlType (const SQLTypeInfo &sql_type)

Encoder *	getEncoder () const

void	setDirty ()

void	setUpdated ()

void	setAppended ()

void	setSize (const size_t size)

void	clearDirtyBits ()

void	initEncoder (const SQLTypeInfo &tmp_sql_type)

void	syncEncoder (const AbstractBuffer *src_buffer)

void	copyTo (AbstractBuffer *destination_buffer, const size_t num_bytes=0)

void	resetToEmpty ()

Private Attributes
int8_t *	data_ptr_

size_t	data_byte_size_

Additional Inherited Members
Protected Attributes inherited from Data_Namespace::AbstractBuffer
std::unique_ptr< Encoder >	encoder_

SQLTypeInfo	sql_type_

size_t	size_

int	device_id_

Detailed Description

PassThroughBuffer wraps a pointer with specifed data size. This class does not take ownership of the pointer. The underlying buffer is never intended to be modified only read, hence the constructor takes a const pointer.

Definition at line 31 of file PassThroughBuffer.h.

Constructor & Destructor Documentation

foreign_storage::PassThroughBuffer::PassThroughBuffer	(	const int8_t *	data,
		const size_t	data_byte_size
	)

Definition at line 21 of file PassThroughBuffer.cpp.

References data_byte_size_, and Data_Namespace::AbstractBuffer::setSize().

     : AbstractBuffer(0)
     , data_ptr_(const_cast<int8_t*>(data))
     , data_byte_size_(data_byte_size) {
   setSize(data_byte_size_);
 }

Here is the call graph for this function:

foreign_storage::PassThroughBuffer::PassThroughBuffer ( )

delete

Member Function Documentation

void foreign_storage::PassThroughBuffer::append	(	int8_t *	source,
		const size_t	num_bytes,
		const MemoryLevel	source_buffer_type = `CPU_LEVEL`,
		const int	device_id = `-1`
	)

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 41 of file PassThroughBuffer.cpp.

References UNREACHABLE.

                                                     {
   UNREACHABLE() << " unexpected call to purposefully unimplemented function in "
                    "PassThroughBuffer";
 }

int8_t * foreign_storage::PassThroughBuffer::getMemoryPtr ( )

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 49 of file PassThroughBuffer.cpp.

References data_ptr_.

                                         {
   return data_ptr_;
 }

MemoryLevel foreign_storage::PassThroughBuffer::getType ( ) const

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 59 of file PassThroughBuffer.cpp.

References Data_Namespace::CPU_LEVEL.

                                              {
   return CPU_LEVEL;
 }

size_t foreign_storage::PassThroughBuffer::pageCount ( ) const

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 72 of file PassThroughBuffer.cpp.

References UNREACHABLE.

                                           {
   UNREACHABLE() << " unexpected call to purposefully unimplemented function in "
                    "PassThroughBuffer";
   return 0;  // Added to avoid "no return statement" compiler warning
 }

size_t foreign_storage::PassThroughBuffer::pageSize ( ) const

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 78 of file PassThroughBuffer.cpp.

References UNREACHABLE.

                                          {
   UNREACHABLE() << " unexpected call to purposefully unimplemented function in "
                    "PassThroughBuffer";
   return 0;  // Added to avoid "no return statement" compiler warning
 }

void foreign_storage::PassThroughBuffer::read	(	int8_t *const	destination,
		const size_t	num_bytes,
		const size_t	offset = `0`,
		const MemoryLevel	destination_buffer_type = `CPU_LEVEL`,
		const int	destination_device_id = `-1`
	)

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 28 of file PassThroughBuffer.cpp.

References data_ptr_.

                                                               {
   memcpy(destination, data_ptr_ + offset, num_bytes);
 }

void foreign_storage::PassThroughBuffer::reserve ( size_t additional_num_bytes )

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 36 of file PassThroughBuffer.cpp.

References UNREACHABLE.

                                                            {
   UNREACHABLE() << " unexpected call to purposefully unimplemented function in "
                    "PassThroughBuffer";
 }

size_t foreign_storage::PassThroughBuffer::reservedSize ( ) const

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 53 of file PassThroughBuffer.cpp.

References UNREACHABLE.

                                              {
   UNREACHABLE() << " unexpected call to purposefully unimplemented function in "
                    "PassThroughBuffer";
   return 0;
 }

void foreign_storage::PassThroughBuffer::write	(	int8_t *	source,
		const size_t	num_bytes,
		const size_t	offset = `0`,
		const MemoryLevel	source_buffer_type = `CPU_LEVEL`,
		const int	source_device_id = `-1`
	)

overridevirtual

Implements Data_Namespace::AbstractBuffer.

Definition at line 63 of file PassThroughBuffer.cpp.

References UNREACHABLE.

                                                           {
   UNREACHABLE() << " unexpected call to purposefully unimplemented function in "
                    "PassThroughBuffer";
 }

Member Data Documentation

size_t foreign_storage::PassThroughBuffer::data_byte_size_

private

Definition at line 63 of file PassThroughBuffer.h.

Referenced by PassThroughBuffer().

int8_t* foreign_storage::PassThroughBuffer::data_ptr_

private

Definition at line 62 of file PassThroughBuffer.h.

Referenced by getMemoryPtr(), and read().

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

/home/jenkins-slave/workspace/core-os-doxygen/DataMgr/ForeignStorage/PassThroughBuffer.h
/home/jenkins-slave/workspace/core-os-doxygen/DataMgr/ForeignStorage/PassThroughBuffer.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation