quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize > Class Template Reference

#include "packed_backtrace.hpp"

Inheritance diagram for quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >:

Classes
class	iterator
	The iterator type. More...

Public Types
using	value_type = FramePtrType
	The type stored in the container.
using	const_value_type = typename detail::constify< FramePtrType >::type
	The const type stored in the container.
using	size_type = size_t
	The size type.
using	difference_type = ptrdiff_t
	The difference type.
using	reference = FramePtrType
	The reference type.
using	const_reference = const FramePtrType
	The const reference type.
using	pointer = FramePtrType *
	The pointer type.
using	const_pointer = const FramePtrType *
	The const pointer type.
using	const_iterator = iterator
	The const iterator type.
using	reverse_iterator = std::reverse_iterator< iterator >
	The reverse iterator type.
using	const_reverse_iterator = std::reverse_iterator< const_iterator >
	The const reverse iterator type.

Public Member Functions
bool	empty () const noexcept
	Returns true if the index is empty.
size_type	size () const noexcept
	Returns the number of items in the backtrace.
size_type	max_size () const noexcept
	Returns the maximum number of items in the backtrace.
iterator	begin () noexcept
	Returns an iterator to the first item in the backtrace.
const_iterator	begin () const noexcept
	Returns an iterator to the first item in the backtrace.
const_iterator	cbegin () const noexcept
	Returns an iterator to the first item in the backtrace.
iterator	end () noexcept
	Returns an iterator to the item after the last in the backtrace.
const_iterator	end () const noexcept
	Returns an iterator to the item after the last in the backtrace.
const_iterator	cend () const noexcept
	Returns an iterator to the item after the last in the backtrace.
value_type	operator[] (size_type i) const noexcept
	Returns the specified element, unchecked.
value_type	at (size_type i) const
	Returns the specified element, checked.
void	swap (packed_backtrace &o) noexcept
	Swaps with another instance.
void	assign (span::span< const_value_type > input) noexcept
	Assigns a raw stack backtrace to the packed storage.

Protected Member Functions
	packed_backtrace (span::span< const char > storage)
	packed_backtrace (span::span< char > storage, std::nullptr_t)

Friends
class	iterator

Member Typedef Documentation

value_type

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::value_type = FramePtrType

The type stored in the container.

const_value_type

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::const_value_type = typename detail::constify<FramePtrType>::type

The const type stored in the container.

size_type

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::size_type = size_t

The size type.

difference_type

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::difference_type = ptrdiff_t

The difference type.

reference

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::reference = FramePtrType

The reference type.

const_reference

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::const_reference = const FramePtrType

The const reference type.

pointer

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::pointer = FramePtrType *

The pointer type.

const_pointer

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::const_pointer = const FramePtrType *

The const pointer type.

const_iterator

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::const_iterator = iterator

The const iterator type.

reverse_iterator

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::reverse_iterator = std::reverse_iterator<iterator>

The reverse iterator type.

const_reverse_iterator

template<class FramePtrType , size_t FrameTypeSize>

using quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::const_reverse_iterator = std::reverse_iterator<const_iterator>

The const reverse iterator type.

Constructor & Destructor Documentation

packed_backtrace() [1/2]

template<class FramePtrType , size_t FrameTypeSize>

quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::packed_backtrace ( span::span< const char >  storage )

inlineexplicitprotected

          : _storage(reinterpret_cast<uint8_t *>(const_cast<char *>(storage.data())), storage.size())
          , _count(_decode_count())
      {
      }

packed_backtrace() [2/2]

template<class FramePtrType , size_t FrameTypeSize>

quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::packed_backtrace ( span::span< char >  storage, std::nullptr_t    )

inlineexplicitprotected

          : _storage(reinterpret_cast<uint8_t *>(storage.data()), storage.size())
          , _count(0)
      {
      }

Member Function Documentation

empty()

template<class FramePtrType , size_t FrameTypeSize>

bool quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::empty ( ) const

inlinenoexcept

Returns true if the index is empty.

{ return _storage.empty(); }

size()

template<class FramePtrType , size_t FrameTypeSize>

size_type quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::size ( ) const

inlinenoexcept

Returns the number of items in the backtrace.

{ return _count; }

max_size()

template<class FramePtrType , size_t FrameTypeSize>

size_type quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::max_size ( ) const

inlinenoexcept

Returns the maximum number of items in the backtrace.

{ return _count; }

begin() [1/2]

template<class FramePtrType , size_t FrameTypeSize>

iterator quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::begin ( )

inlinenoexcept

Returns an iterator to the first item in the backtrace.

{ return iterator(this); }

begin() [2/2]

template<class FramePtrType , size_t FrameTypeSize>

const_iterator quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::begin ( ) const

inlinenoexcept

Returns an iterator to the first item in the backtrace.

{ return iterator(this); }

cbegin()

template<class FramePtrType , size_t FrameTypeSize>

const_iterator quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::cbegin ( ) const

inlinenoexcept

Returns an iterator to the first item in the backtrace.

{ return iterator(this); }

end() [1/2]

template<class FramePtrType , size_t FrameTypeSize>

iterator quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::end ( )

inlinenoexcept

Returns an iterator to the item after the last in the backtrace.

{ return iterator(); }

end() [2/2]

template<class FramePtrType , size_t FrameTypeSize>

const_iterator quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::end ( ) const

inlinenoexcept

Returns an iterator to the item after the last in the backtrace.

{ return iterator(); }

cend()

template<class FramePtrType , size_t FrameTypeSize>

const_iterator quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::cend ( ) const

inlinenoexcept

Returns an iterator to the item after the last in the backtrace.

{ return iterator(); }

operator[]()

template<class FramePtrType , size_t FrameTypeSize>

value_type quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::operator[] ( size_type  i ) const

inlinenoexcept

Returns the specified element, unchecked.

      {
        uintptr_type out = 0;
        size_t idx = 0;
        for(size_type n = 0; n <= i; n++)
        {
          if(!_decode(out, idx))
            return nullptr;
        }
        return reinterpret_cast<value_type>(out);
      }

at()

template<class FramePtrType , size_t FrameTypeSize>

value_type quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::at ( size_type  i ) const

inline

Returns the specified element, checked.

      {
        uintptr_type out = 0;
        size_t idx = 0;
        for(size_type n = 0; n <= i; n++)
        {
          if(!_decode(out, idx))
          {
            abort();  // out of range
          }
        }
        return reinterpret_cast<value_type>(out);
      }

swap()

template<class FramePtrType , size_t FrameTypeSize>

void quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::swap ( packed_backtrace< FramePtrType, FrameTypeSize > &  o )

inlinenoexcept

Swaps with another instance.

      {
        using std::swap;
        swap(_storage, o._storage);
        swap(_count, o._count);
      }

assign()

template<class FramePtrType , size_t FrameTypeSize>

void quickcpplib::_xxx::packed_backtrace::impl::packed_backtrace< FramePtrType, FrameTypeSize >::assign ( span::span< const_value_type >  input )

inlinenoexcept

Assigns a raw stack backtrace to the packed storage.

      {
        uintptr_type out = 0;
        size_t idx = 0;
        memset(_storage.data(), 0, _storage.size());
        _count = 0;
        for(const auto &_i : input)
        {
          size_t startidx = idx;
          uintptr_type i = reinterpret_cast<uintptr_type>(_i);
          uintptr_type delta = i & bits63_43;
          if((out & bits63_43) != delta)
          {
            if(idx > _storage.size() - 3)
              return;
            // std::cout << "For entry " << _i << " encoding bits 63-43: " << (void *) delta << std::endl;
            _storage[idx++] = 0xc0 | ((delta >> 59) & 0x3f);
            _storage[idx++] = (delta >> 51) & 0xff;
            _storage[idx++] = (delta >> 43) & 0xff;
            out &= bits42_0;
            out |= delta;
          }
          delta = i & bits42_21;
          if((out & bits42_21) != delta)
          {
            if(idx > _storage.size() - 3)
            {
              memset(_storage.data() + startidx, 0, idx - startidx);
              return;
            }
            // std::cout << "For entry " << _i << " encoding bits 42-21: " << (void *) delta << std::endl;
            _storage[idx++] = 0x80 | ((delta >> 37) & 0x3f);
            _storage[idx++] = (delta >> 29) & 0xff;
            _storage[idx++] = (delta >> 21) & 0xff;
            out &= bits63_43;
            out |= bit20;
            out |= delta;
          }
          if(i - out >= (1 << 13) && out - i >= (1 << 13))
          {
            if(idx > _storage.size() - 3)
            {
              memset(_storage.data() + startidx, 0, idx - startidx);
              return;
            }
            delta = static_cast<uintptr_type>(i - out);
            // std::cout << "For entry " << _i << " with diff " << (intptr_t) delta << " encoding three byte delta: " << (void *) delta << std::endl;
            _storage[idx++] = 0x40 | ((delta >> 16) & 0x3f);
            _storage[idx++] = (delta >> 8) & 0xff;
            _storage[idx++] = (delta >> 0) & 0xff;
            out = i;
          }
          else
          {
            if(idx > _storage.size() - 2)
            {
              memset(_storage.data() + startidx, 0, idx - startidx);
              return;
            }
            delta = static_cast<uintptr_type>(i - out);
            // std::cout << "For entry " << _i << " with diff " << (intptr_t) delta << " encoding two byte delta: " << (void *) delta << std::endl;
            _storage[idx++] = (delta >> 8) & 0x3f;
            _storage[idx++] = (delta >> 0) & 0xff;
            out = i;
          }
          _count++;
        }
      }

Friends And Related Symbol Documentation

iterator

template<class FramePtrType , size_t FrameTypeSize>

friend class iterator

friend

---

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

• include/quickcpplib/packed_backtrace.hpp