foedus::snapshot::BlockHeaderBase Struct Reference

All log blocks in mapper/reducers start with this header. More...

Detailed Description

All log blocks in mapper/reducers start with this header.

This base object MUST be within 8 bytes so that FillerBlockHeader is within 8 bytes. As logs are multiply of 8 bytes, 8-byte filler header can fill any gap.

Definition at line 93 of file log_reducer_impl.hpp.

#include <log_reducer_impl.hpp>

Inheritance diagram for foedus::snapshot::BlockHeaderBase:

Public Types
enum	Constants { kFullBlockHeaderMagicWord = 0xDEADBEEF, kFillerBlockHeaderMagicWord = 0x8BADF00D }

Public Member Functions
bool	is_full_block () const
bool	is_filler () const

Public Attributes
uint32_t	magic_word_
	This is used to identify the storage block is a dummy (filler) one or a full one. More...
BufferPosition	block_length_
	Length (in 8-bytes) of this block including the header. More...

Friends
std::ostream &	operator<< (std::ostream &o, const BlockHeaderBase &v)

Member Enumeration Documentation

enum foedus::snapshot::BlockHeaderBase::Constants

Enumerator
kFullBlockHeaderMagicWord	See also FullBlockHeader::magic_word_
kFillerBlockHeaderMagicWord	See also FillerBlockHeader::magic_word_

Definition at line 94 of file log_reducer_impl.hpp.

                 {
    kFullBlockHeaderMagicWord = 0xDEADBEEF,
    kFillerBlockHeaderMagicWord = 0x8BADF00D,
  };

Member Function Documentation

bool foedus::snapshot::BlockHeaderBase::is_filler ( ) const

inline

Definition at line 105 of file log_reducer_impl.hpp.

References ASSERT_ND, kFillerBlockHeaderMagicWord, kFullBlockHeaderMagicWord, and magic_word_.

                         {
    ASSERT_ND(magic_word_ == kFullBlockHeaderMagicWord
      || magic_word_ == kFillerBlockHeaderMagicWord);
    return magic_word_ == kFillerBlockHeaderMagicWord;
  }

bool foedus::snapshot::BlockHeaderBase::is_full_block ( ) const

inline

Definition at line 100 of file log_reducer_impl.hpp.

References ASSERT_ND, kFillerBlockHeaderMagicWord, kFullBlockHeaderMagicWord, and magic_word_.

                             {
    ASSERT_ND(magic_word_ == kFullBlockHeaderMagicWord
      || magic_word_ == kFillerBlockHeaderMagicWord);
    return magic_word_ == kFullBlockHeaderMagicWord;
  }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o, const BlockHeaderBase &  v  )

friend

Definition at line 925 of file log_reducer_impl.cpp.

                                                                {
  o << "<BlockHeader>"
    << "<magic_word_>" << assorted::Hex(v.magic_word_) << "</magic_word_>"
    << "<block_length_>" << v.block_length_ << "</block_length_>"
    << "</BlockHeader>";
  return o;
}

Member Data Documentation

BufferPosition foedus::snapshot::BlockHeaderBase::block_length_

Length (in 8-bytes) of this block including the header.

Definition at line 119 of file log_reducer_impl.hpp.

Referenced by foedus::snapshot::LogReducerRef::append_log_chunk(), and foedus::snapshot::operator<<().

uint32_t foedus::snapshot::BlockHeaderBase::magic_word_

This is used to identify the storage block is a dummy (filler) one or a full one.

This must be either kFullBlockHeaderMagicWord or kFillerBlockHeaderMagicWord.

Definition at line 117 of file log_reducer_impl.hpp.

Referenced by foedus::snapshot::LogReducerRef::append_log_chunk(), is_filler(), is_full_block(), and foedus::snapshot::operator<<().

---

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

• /home/shino/foedus_code/foedus-core/include/foedus/snapshot/log_reducer_impl.hpp