XrdEc::WrtBuff Class Reference

#include <XrdEcWrtBuff.hh>

Collaboration diagram for XrdEc::WrtBuff:

Public Member Functions
	WrtBuff (const ObjCfg &objcfg)
	WrtBuff (WrtBuff &&wrtbuff)
	Move constructor.
	~WrtBuff ()
bool	Complete ()
	True if the buffer if full, false otherwise.
bool	Empty ()
	True if there are no data in the buffer, false otherwise.
void	Encode ()
	Calculate the parity for the data stripes and the crc32cs.
uint32_t	GetBlkSize ()
	Get size of the data in the buffer.
uint32_t	GetCrc32c (size_t strpnb)
char *	GetStrpBuff (uint8_t strpnb)
uint32_t	GetStrpSize (uint8_t strp)
void	Pad (uint32_t size)
uint32_t	Write (uint32_t size, const char *buffer)

Detailed Description

Write cache, accumulates full block and then calculates parity and all of it to the storage

Definition at line 132 of file XrdEcWrtBuff.hh.

Constructor & Destructor Documentation

WrtBuff() [1/2]

XrdEc::WrtBuff::WrtBuff ( const ObjCfg & objcfg )

inline

Constructor

Parameters

objcfg

: data object configuration

Definition at line 140 of file XrdEcWrtBuff.hh.

                                      : objcfg( objcfg ),
                                        wrtbuff( BufferPool::Instance().Create( objcfg ) )
      {
        stripes.reserve( objcfg.nbchunks );
        memset( wrtbuff.GetBuffer(), 0, wrtbuff.GetSize() );
      }

References Create.

Referenced by WrtBuff().

Here is the caller graph for this function:

WrtBuff() [2/2]

XrdEc::WrtBuff::WrtBuff ( WrtBuff && wrtbuff )

inline

Move constructor.

Definition at line 149 of file XrdEcWrtBuff.hh.

                                    : objcfg( wrtbuff.objcfg ),
                                      wrtbuff( std::move( wrtbuff.wrtbuff ) ),
                                      stripes( std::move( wrtbuff.stripes ) ),
                                      cksums( std::move( wrtbuff.cksums ) )
      {
      }

References WrtBuff().

Here is the call graph for this function:

~WrtBuff()

XrdEc::WrtBuff::~WrtBuff ( )

inline

Definition at line 158 of file XrdEcWrtBuff.hh.

      {
        BufferPool::Instance().Recycle( std::move( wrtbuff ) );
      }

References XrdEc::BufferPool::Instance(), and XrdEc::BufferPool::Recycle().

Here is the call graph for this function:

Member Function Documentation

Complete()

bool XrdEc::WrtBuff::Complete ( )

inline

True if the buffer if full, false otherwise.

Definition at line 243 of file XrdEcWrtBuff.hh.

      {
        return wrtbuff.GetCursor() == objcfg.datasize;
      }

Empty()

bool XrdEc::WrtBuff::Empty ( )

inline

True if there are no data in the buffer, false otherwise.

Definition at line 250 of file XrdEcWrtBuff.hh.

      {
        return ( wrtbuff.GetSize() == 0 || wrtbuff.GetCursor() == 0 );
      }

Encode()

void XrdEc::WrtBuff::Encode ( )

inline

Calculate the parity for the data stripes and the crc32cs.

Definition at line 257 of file XrdEcWrtBuff.hh.

      {
        // first calculate the parity
        uint8_t i ;
        for( i = 0; i < objcfg.nbchunks; ++i )
          stripes.emplace_back( wrtbuff.GetBuffer( i * objcfg.chunksize ), i < objcfg.nbdata );
        Config &cfg = Config::Instance();
        cfg.GetRedundancy( objcfg ).compute( stripes );
        // then calculate the checksums
        cksums.reserve( objcfg.nbchunks );
        for( uint8_t strpnb = 0; strpnb < objcfg.nbchunks; ++strpnb )
        {
          size_t chunksize = GetStrpSize( strpnb );
          std::future<uint32_t> ftr = ThreadPool::Instance().Execute( objcfg.digest, 0, stripes[strpnb].buffer, chunksize );
          cksums.emplace_back( std::move( ftr ) );
        }
      }

References XrdEc::RedundancyProvider::compute(), XrdEc::ThreadPool::Execute(), XrdEc::Config::GetRedundancy(), GetStrpSize(), XrdEc::Config::Instance(), and XrdEc::ThreadPool::Instance().

Here is the call graph for this function:

GetBlkSize()

uint32_t XrdEc::WrtBuff::GetBlkSize ( )

inline

Get size of the data in the buffer.

Definition at line 236 of file XrdEcWrtBuff.hh.

      {
        return wrtbuff.GetCursor();
      }

GetCrc32c()

uint32_t XrdEc::WrtBuff::GetCrc32c ( size_t strpnb )

inline

Calculate the crc32c for given data stripe

Parameters

strpnb

: number of the stripe

Returns

: the crc32c of the data stripe

Definition at line 280 of file XrdEcWrtBuff.hh.

      {
        return cksums[strpnb].get();
      }

GetStrpBuff()

char * XrdEc::WrtBuff::GetStrpBuff ( uint8_t strpnb )

inline

Return buffer corresponding to given stripe

Parameters

strpnb

: number of the stripe

Definition at line 202 of file XrdEcWrtBuff.hh.

      {
        return stripes[strpnb].buffer;
      }

GetStrpSize()

uint32_t XrdEc::WrtBuff::GetStrpSize ( uint8_t strp )

inline

Return size of the data in the given stripe

Parameters

strp	: number of the stripe

Definition at line 211 of file XrdEcWrtBuff.hh.

      {
        // Check if it is a data chunk?
        if( strp < objcfg.nbdata )
        {
          // If the cursor is at least at the expected size
          // it means we have the full chunk.
          uint64_t expsize = ( strp + 1) * objcfg.chunksize;
          if( expsize <= wrtbuff.GetCursor() )
            return objcfg.chunksize;
          // If the cursor is of by less than the chunk size
          // it means we have a partial chunk
          uint64_t delta = expsize - wrtbuff.GetCursor();
          if( delta < objcfg.chunksize )
            return objcfg.chunksize - delta;
          // otherwise we are handling an empty chunk
          return 0;
        }
        // It is a parity chunk so its size has  to be equal
        // to the size of the first chunk
        return GetStrpSize( 0 );
      }

References GetStrpSize().

Referenced by Encode(), and GetStrpSize().

Here is the call graph for this function:

Here is the caller graph for this function:

Pad()

void XrdEc::WrtBuff::Pad ( uint32_t size )

inline

Pad the buffer with zeros.

Parameters

size	: number of zeros to be written into the buffer

Definition at line 183 of file XrdEcWrtBuff.hh.

      {
        // if the buffer exist we only need to move the cursor
        if( wrtbuff.GetSize() != 0 )
        {
          wrtbuff.AdvanceCursor( size );
          return;
        }
        // otherwise we allocate the buffer and set the cursor
        wrtbuff.Allocate( objcfg.datasize );
        memset( wrtbuff.GetBuffer(), 0, wrtbuff.GetSize() );
        wrtbuff.SetCursor( size );
        return;
      }

Write()

uint32_t XrdEc::WrtBuff::Write ( uint32_t size, const char * buffer )

inline

Write data into the buffer

Parameters

size	: number of bytes to be written
buffer	: buffer with data to be written

Returns

: number of bytes accepted by the buffer

Definition at line 169 of file XrdEcWrtBuff.hh.

      {
        uint64_t bytesAccepted = size; // bytes accepted by the buffer
        if( wrtbuff.GetCursor() + bytesAccepted > objcfg.datasize )
          bytesAccepted = objcfg.datasize - wrtbuff.GetCursor();
        memcpy( wrtbuff.GetBufferAtCursor(), buffer, bytesAccepted );
        wrtbuff.AdvanceCursor( bytesAccepted );
        return bytesAccepted;
      }

---

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

• XrdEcWrtBuff.hh