sysio::chain::protocol_feature_set Class Reference

#include <protocol_feature_manager.hpp>

Collaboration diagram for sysio::chain::protocol_feature_set:

Classes
class	const_iterator

Public Types
enum class	recognized_t { unrecognized , disabled , too_early , ready }
using	const_reverse_iterator = std::reverse_iterator<const_iterator>

Public Member Functions
	protocol_feature_set ()
recognized_t	is_recognized (const digest_type &feature_digest, time_point now) const
std::optional< digest_type >	get_builtin_digest (builtin_protocol_feature_t feature_codename) const
const protocol_feature &	get_protocol_feature (const digest_type &feature_digest) const
bool	validate_dependencies (const digest_type &feature_digest, const std::function< bool(const digest_type &)> &validator) const
const protocol_feature &	add_feature (const builtin_protocol_feature &f)
const_iterator	cbegin () const
const_iterator	begin () const
const_iterator	cend () const
const_iterator	end () const
const_reverse_iterator	crbegin () const
const_reverse_iterator	rbegin () const
const_reverse_iterator	crend () const
const_reverse_iterator	rend () const
bool	empty () const
std::size_t	size () const
std::size_t	max_size () const
template<typename K >
const_iterator	find (const K &x) const
template<typename K >
const_iterator	lower_bound (const K &x) const
template<typename K >
const_iterator	upper_bound (const K &x) const

Static Public Member Functions
static builtin_protocol_feature	make_default_builtin_protocol_feature (builtin_protocol_feature_t codename, const std::function< digest_type(builtin_protocol_feature_t dependency)> &handle_dependency)

Protected Types
using	protocol_feature_set_type = std::set< protocol_feature, std::less<> >

Protected Attributes
protocol_feature_set_type	_recognized_protocol_features
vector< protocol_feature_set_type::const_iterator >	_recognized_builtin_protocol_features

Friends
class	protocol_feature_manager

Detailed Description

Definition at line 131 of file protocol_feature_manager.hpp.

Member Typedef Documentation

const_reverse_iterator

using sysio::chain::protocol_feature_set::const_reverse_iterator = std::reverse_iterator<const_iterator>

Definition at line 224 of file protocol_feature_manager.hpp.

protocol_feature_set_type

using sysio::chain::protocol_feature_set::protocol_feature_set_type = std::set< protocol_feature, std::less<> >

protected

Definition at line 133 of file protocol_feature_manager.hpp.

Member Enumeration Documentation

recognized_t

enum class sysio::chain::protocol_feature_set::recognized_t

strong

Enumerator
unrecognized
disabled
too_early
ready

Definition at line 138 of file protocol_feature_manager.hpp.

                           {
      unrecognized,
      disabled,
      too_early,
      ready
   };

Constructor & Destructor Documentation

protocol_feature_set()

sysio::chain::protocol_feature_set::protocol_feature_set

(

)

Definition at line 410 of file protocol_feature_manager.cpp.

   {
      _recognized_builtin_protocol_features.reserve( builtin_protocol_feature_codenames.size() );
   }

Member Function Documentation

add_feature()

const protocol_feature & sysio::chain::protocol_feature_set::add_feature

(

const builtin_protocol_feature &

f

)

Definition at line 491 of file protocol_feature_manager.cpp.

                                                                                                {
      auto builtin_itr = builtin_protocol_feature_codenames.find( f._codename );
      SYS_ASSERT( builtin_itr != builtin_protocol_feature_codenames.end(), protocol_feature_validation_exception,
                  "Builtin protocol feature has unsupported builtin_protocol_feature_t: ${codename}",
                  ("codename", static_cast<uint32_t>( f._codename )) );
 
      uint32_t indx = static_cast<uint32_t>( f._codename );
 
      if( indx < _recognized_builtin_protocol_features.size() ) {
         SYS_ASSERT( _recognized_builtin_protocol_features[indx] == _recognized_protocol_features.end(),
                     protocol_feature_exception,
                     "builtin protocol feature with codename '${codename}' already added",
                     ("codename", f.builtin_feature_codename) );
      }
 
      auto feature_digest = f.digest();
 
      const auto& expected_builtin_dependencies = builtin_itr->second.builtin_dependencies;
      flat_set<builtin_protocol_feature_t> satisfied_builtin_dependencies;
      satisfied_builtin_dependencies.reserve( expected_builtin_dependencies.size() );
 
      for( const auto& d : f.dependencies ) {
         auto itr = _recognized_protocol_features.find( d );
         SYS_ASSERT( itr != _recognized_protocol_features.end(), protocol_feature_exception,
            "builtin protocol feature with codename '${codename}' and digest of ${digest} has a dependency on a protocol feature with digest ${dependency_digest} that is not recognized",
            ("codename", f.builtin_feature_codename)
            ("digest",  feature_digest)
            ("dependency_digest", d )
         );
 
         if( itr->builtin_feature
             && expected_builtin_dependencies.find( *itr->builtin_feature )
                  != expected_builtin_dependencies.end() )
         {
            satisfied_builtin_dependencies.insert( *itr->builtin_feature );
         }
      }
 
      if( expected_builtin_dependencies.size() > satisfied_builtin_dependencies.size() ) {
         flat_set<builtin_protocol_feature_t> missing_builtins;
         missing_builtins.reserve( expected_builtin_dependencies.size() - satisfied_builtin_dependencies.size() );
         std::set_difference( expected_builtin_dependencies.begin(), expected_builtin_dependencies.end(),
                              satisfied_builtin_dependencies.begin(), satisfied_builtin_dependencies.end(),
                              end_inserter( missing_builtins )
         );
 
         vector<string> missing_builtins_with_names;
         missing_builtins_with_names.reserve( missing_builtins.size() );
         for( const auto& builtin_codename : missing_builtins ) {
            auto itr = builtin_protocol_feature_codenames.find( builtin_codename );
            SYS_ASSERT( itr != builtin_protocol_feature_codenames.end(),
                        protocol_feature_exception,
                        "Unexpected error"
            );
            missing_builtins_with_names.emplace_back( itr->second.codename );
         }
 
         SYS_THROW(  protocol_feature_validation_exception,
                     "Not all the builtin dependencies of the builtin protocol feature with codename '${codename}' and digest of ${digest} were satisfied.",
                     ("missing_dependencies", missing_builtins_with_names)
         );
      }
 
      auto res = _recognized_protocol_features.insert( protocol_feature{
         feature_digest,
         f.description_digest,
         f.dependencies,
         f.subjective_restrictions.earliest_allowed_activation_time,
         f.subjective_restrictions.preactivation_required,
         f.subjective_restrictions.enabled,
         f._codename
      } );
 
      SYS_ASSERT( res.second, protocol_feature_exception,
                  "builtin protocol feature with codename '${codename}' has a digest of ${digest} but another protocol feature with the same digest has already been added",
                  ("codename", f.builtin_feature_codename)("digest", feature_digest) );
 
      if( indx >= _recognized_builtin_protocol_features.size() ) {
         for( auto i =_recognized_builtin_protocol_features.size(); i <= indx; ++i ) {
            _recognized_builtin_protocol_features.push_back( _recognized_protocol_features.end() );
         }
      }
 
      _recognized_builtin_protocol_features[indx] = res.first;
      return *res.first;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

begin()

const_iterator sysio::chain::protocol_feature_set::begin ( ) const

inline

Definition at line 227 of file protocol_feature_manager.hpp.

{ return cbegin(); }

Here is the call graph for this function:

cbegin()

const_iterator sysio::chain::protocol_feature_set::cbegin ( ) const

inline

Definition at line 226 of file protocol_feature_manager.hpp.

{ return const_iterator( _recognized_protocol_features.cbegin() ); }

Here is the caller graph for this function:

cend()

const_iterator sysio::chain::protocol_feature_set::cend ( ) const

inline

Definition at line 229 of file protocol_feature_manager.hpp.

{ return const_iterator( _recognized_protocol_features.cend() ); }

Here is the caller graph for this function:

crbegin()

const_reverse_iterator sysio::chain::protocol_feature_set::crbegin ( ) const

inline

Definition at line 232 of file protocol_feature_manager.hpp.

{ return std::make_reverse_iterator( cend() ); }

Here is the call graph for this function:

Here is the caller graph for this function:

crend()

const_reverse_iterator sysio::chain::protocol_feature_set::crend ( ) const

inline

Definition at line 235 of file protocol_feature_manager.hpp.

{ return std::make_reverse_iterator( cbegin() ); }

Here is the call graph for this function:

Here is the caller graph for this function:

empty()

bool sysio::chain::protocol_feature_set::empty ( ) const

inline

Definition at line 238 of file protocol_feature_manager.hpp.

{ return _recognized_protocol_features.empty(); }

end()

const_iterator sysio::chain::protocol_feature_set::end ( ) const

inline

Definition at line 230 of file protocol_feature_manager.hpp.

{ return cend(); }

Here is the call graph for this function:

Here is the caller graph for this function:

find()

template<typename K >

const_iterator sysio::chain::protocol_feature_set::find ( const K & x ) const

inline

Definition at line 243 of file protocol_feature_manager.hpp.

                                          {
      return const_iterator( _recognized_protocol_features.find( x ) );
   }

Here is the caller graph for this function:

get_builtin_digest()

std::optional< digest_type > sysio::chain::protocol_feature_set::get_builtin_digest

(

builtin_protocol_feature_t

feature_codename

)

const

Definition at line 432 of file protocol_feature_manager.cpp.

                                                                                                                       {
      uint32_t indx = static_cast<uint32_t>( feature_codename );
 
      if( indx >= _recognized_builtin_protocol_features.size() )
         return {};
 
      if( _recognized_builtin_protocol_features[indx] == _recognized_protocol_features.end() )
         return {};
 
      return _recognized_builtin_protocol_features[indx]->feature_digest;
   }

Here is the caller graph for this function:

get_protocol_feature()

const protocol_feature & sysio::chain::protocol_feature_set::get_protocol_feature

(

const digest_type &

feature_digest

)

const

Definition at line 444 of file protocol_feature_manager.cpp.

                                                                                                              {
      auto itr = _recognized_protocol_features.find( feature_digest );
 
      SYS_ASSERT( itr != _recognized_protocol_features.end(), protocol_feature_exception,
                  "unrecognized protocol feature with digest: ${digest}",
                  ("digest", feature_digest)
      );
 
      return *itr;
   }

is_recognized()

protocol_feature_set::recognized_t sysio::chain::protocol_feature_set::is_recognized	(	const digest_type &	feature_digest,
		time_point	now ) const

Definition at line 417 of file protocol_feature_manager.cpp.

                                                                                               {
      auto itr = _recognized_protocol_features.find( feature_digest );
 
      if( itr == _recognized_protocol_features.end() )
         return recognized_t::unrecognized;
 
      if( !itr->enabled )
         return recognized_t::disabled;
 
      if( itr->earliest_allowed_activation_time > now )
         return recognized_t::too_early;
 
      return recognized_t::ready;
   }

lower_bound()

template<typename K >

const_iterator sysio::chain::protocol_feature_set::lower_bound ( const K & x ) const

inline

Definition at line 248 of file protocol_feature_manager.hpp.

                                                 {
      return const_iterator( _recognized_protocol_features.lower_bound( x ) );
   }

make_default_builtin_protocol_feature()

builtin_protocol_feature sysio::chain::protocol_feature_set::make_default_builtin_protocol_feature ( builtin_protocol_feature_t codename, const std::function< digest_type(builtin_protocol_feature_t dependency)> & handle_dependency )

static

Definition at line 471 of file protocol_feature_manager.cpp.

     {
      auto itr = builtin_protocol_feature_codenames.find( codename );
 
      SYS_ASSERT( itr != builtin_protocol_feature_codenames.end(), protocol_feature_validation_exception,
                  "Unsupported builtin_protocol_feature_t: ${codename}",
                  ("codename", static_cast<uint32_t>(codename)) );
 
      flat_set<digest_type> dependencies;
      dependencies.reserve( itr->second.builtin_dependencies.size() );
 
      for( const auto& d : itr->second.builtin_dependencies ) {
         dependencies.insert( handle_dependency( d ) );
      }
 
      return {itr->first, itr->second.description_digest, std::move(dependencies), itr->second.subjective_restrictions};
   }

Here is the caller graph for this function:

max_size()

std::size_t sysio::chain::protocol_feature_set::max_size ( ) const

inline

Definition at line 240 of file protocol_feature_manager.hpp.

{ return _recognized_protocol_features.max_size(); }

rbegin()

const_reverse_iterator sysio::chain::protocol_feature_set::rbegin ( ) const

inline

Definition at line 233 of file protocol_feature_manager.hpp.

{ return crbegin(); }

Here is the call graph for this function:

rend()

const_reverse_iterator sysio::chain::protocol_feature_set::rend ( ) const

inline

Definition at line 236 of file protocol_feature_manager.hpp.

{ return crend(); }

Here is the call graph for this function:

size()

std::size_t sysio::chain::protocol_feature_set::size ( ) const

inline

Definition at line 239 of file protocol_feature_manager.hpp.

{ return _recognized_protocol_features.size(); }

upper_bound()

template<typename K >

const_iterator sysio::chain::protocol_feature_set::upper_bound ( const K & x ) const

inline

Definition at line 253 of file protocol_feature_manager.hpp.

                                                 {
      return const_iterator( _recognized_protocol_features.upper_bound( x ) );
   }

validate_dependencies()

bool sysio::chain::protocol_feature_set::validate_dependencies	(	const digest_type &	feature_digest,
		const std::function< bool(const digest_type &)> &	validator ) const

Definition at line 455 of file protocol_feature_manager.cpp.

          {
      auto itr = _recognized_protocol_features.find( feature_digest );
 
      if( itr == _recognized_protocol_features.end() ) return false;
 
      for( const auto& d : itr->dependencies ) {
         if( !validator(d) ) return false;
      }
 
      return true;
   }

Friends And Related Symbol Documentation

protocol_feature_manager

friend class protocol_feature_manager

friend

Definition at line 257 of file protocol_feature_manager.hpp.

Member Data Documentation

_recognized_builtin_protocol_features

vector<protocol_feature_set_type::const_iterator> sysio::chain::protocol_feature_set::_recognized_builtin_protocol_features

protected

Definition at line 261 of file protocol_feature_manager.hpp.

_recognized_protocol_features

protocol_feature_set_type sysio::chain::protocol_feature_set::_recognized_protocol_features

protected

Definition at line 260 of file protocol_feature_manager.hpp.

---

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

• libraries/chain/include/sysio/chain/protocol_feature_manager.hpp
• libraries/chain/protocol_feature_manager.cpp