dead-nonce-list.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NFD_DAEMON_TABLE_DEAD_NONCE_LIST_HPP
#define NFD_DAEMON_TABLE_DEAD_NONCE_LIST_HPP

#include "common.hpp"
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include "core/scheduler.hpp"

namespace nfd {

class DeadNonceList : noncopyable
{
public:
  explicit
  DeadNonceList(const time::nanoseconds& lifetime = DEFAULT_LIFETIME);

  ~DeadNonceList();

  bool
  has(const Name& name, uint32_t nonce) const;

  void
  add(const Name& name, uint32_t nonce);

  size_t
  size() const;

  const time::nanoseconds&
  getLifetime() const;

private: // Entry and Index
  typedef uint64_t Entry;

  static Entry
  makeEntry(const Name& name, uint32_t nonce);

  typedef boost::multi_index_container<
    Entry,
    boost::multi_index::indexed_by<
      boost::multi_index::sequenced<>,
      boost::multi_index::hashed_non_unique<
        boost::multi_index::identity<Entry>
      >
    >
  > Index;

  typedef Index::nth_index<0>::type Queue;
  typedef Index::nth_index<1>::type Hashtable;

private: // actual lifetime estimation and capacity control
  size_t
  countMarks() const;

  void
  mark();

  void
  adjustCapacity();

  void
  evictEntries();

public:
  static const time::nanoseconds DEFAULT_LIFETIME;

  static const time::nanoseconds MIN_LIFETIME;

private:
  time::nanoseconds m_lifetime;
  Index m_index;
  Queue& m_queue;
  Hashtable& m_ht;

PUBLIC_WITH_TESTS_ELSE_PRIVATE: // actual lifetime estimation and capacity control

  // ---- current capacity and hard limits

  size_t m_capacity;

  static const size_t INITIAL_CAPACITY;

  static const size_t MIN_CAPACITY;

  static const size_t MAX_CAPACITY;

  // ---- actual entry lifetime estimation

  static const Entry MARK;

  static const size_t EXPECTED_MARK_COUNT;

  std::multiset<size_t> m_actualMarkCounts;

  time::nanoseconds m_markInterval;

  scheduler::EventId m_markEvent;

  // ---- capacity adjustments

  static const double CAPACITY_UP;

  static const double CAPACITY_DOWN;

  time::nanoseconds m_adjustCapacityInterval;

  scheduler::EventId m_adjustCapacityEvent;

  static const size_t EVICT_LIMIT;
};

inline const time::nanoseconds&
DeadNonceList::getLifetime() const
{
  return m_lifetime;
}

} // namespace nfd

#endif // NFD_DAEMON_TABLE_DEAD_NONCE_LIST_HPP