First step of refactoring code (ccnx prefix => ndn prefix)
diff --git a/model/pit/ndn-pit-impl.cc b/model/pit/ndn-pit-impl.cc
new file mode 100644
index 0000000..dcf6ada
--- /dev/null
+++ b/model/pit/ndn-pit-impl.cc
@@ -0,0 +1,429 @@
+/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
+/*
+ * Copyright (c) 2011 University of California, Los Angeles
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation;
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
+ */
+
+#include "ndn-pit-impl.h"
+
+#include "ns3/ndn-interest-header.h"
+#include "ns3/ndn-content-object-header.h"
+#include "ns3/ndn-forwarding-strategy.h"
+
+#include "../../utils/empty-policy.h"
+#include "../../utils/persistent-policy.h"
+#include "../../utils/random-policy.h"
+#include "../../utils/lru-policy.h"
+
+#include "ns3/log.h"
+#include "ns3/string.h"
+#include "ns3/uinteger.h"
+#include "ns3/simulator.h"
+
+#include <boost/lambda/bind.hpp>
+#include <boost/lambda/lambda.hpp>
+
+NS_LOG_COMPONENT_DEFINE ("NdnPitImpl");
+
+using namespace boost::tuples;
+using namespace boost;
+namespace ll = boost::lambda;
+using namespace ndnSIM;
+
+#define NS_OBJECT_ENSURE_REGISTERED_TEMPL(type, templ) \
+ static struct X ## type ## templ ## RegistrationClass \
+ { \
+ X ## type ## templ ## RegistrationClass () { \
+ ns3::TypeId tid = type<templ>::GetTypeId (); \
+ tid.GetParent (); \
+ } \
+ } x_ ## type ## templ ## RegistrationVariable
+
+namespace ns3 {
+
+template<>
+TypeId
+NdnPitImpl<persistent_policy_traits>::GetTypeId ()
+{
+ static TypeId tid = TypeId ("ns3::NdnPit")
+ .SetGroupName ("Ndn")
+ .SetParent<NdnPit> ()
+ .AddConstructor< NdnPitImpl< persistent_policy_traits > > ()
+ .AddAttribute ("MaxSize",
+ "Set maximum number of entries in PIT. If 0, limit is not enforced",
+ StringValue ("0"),
+ MakeUintegerAccessor (&NdnPitImpl< persistent_policy_traits >::GetMaxSize,
+ &NdnPitImpl< persistent_policy_traits >::SetMaxSize),
+ MakeUintegerChecker<uint32_t> ())
+ ;
+
+ return tid;
+}
+
+template<>
+TypeId
+NdnPitImpl<random_policy_traits>::GetTypeId ()
+{
+ static TypeId tid = TypeId ("ns3::NdnPitRandom")
+ .SetGroupName ("Ndn")
+ .SetParent<NdnPit> ()
+ .AddConstructor< NdnPitImpl< random_policy_traits > > ()
+ .AddAttribute ("MaxSize",
+ "Set maximum number of entries in PIT. If 0, limit is not enforced",
+ StringValue ("0"),
+ MakeUintegerAccessor (&NdnPitImpl< random_policy_traits >::GetMaxSize,
+ &NdnPitImpl< random_policy_traits >::SetMaxSize),
+ MakeUintegerChecker<uint32_t> ())
+ ;
+
+ return tid;
+}
+
+template<>
+TypeId
+NdnPitImpl<lru_policy_traits>::GetTypeId ()
+{
+ static TypeId tid = TypeId ("ns3::NdnPitLru")
+ .SetGroupName ("Ndn")
+ .SetParent<NdnPit> ()
+ .AddConstructor< NdnPitImpl< lru_policy_traits > > ()
+ .AddAttribute ("MaxSize",
+ "Set maximum number of entries in PIT. If 0, limit is not enforced",
+ StringValue ("0"),
+ MakeUintegerAccessor (&NdnPitImpl< lru_policy_traits >::GetMaxSize,
+ &NdnPitImpl< lru_policy_traits >::SetMaxSize),
+ MakeUintegerChecker<uint32_t> ())
+ ;
+
+ return tid;
+}
+
+// template<class Policy>
+// TypeId
+// NdnPitImpl<Policy>::GetTypeId ()
+// {
+// static TypeId tid = TypeId ("ns3::UnknownPitPolicy");
+
+// return tid;
+// }
+
+// NdnPitEntryImpl::NdnPitEntryImpl (NdnPit &pit,
+// Ptr<const NdnInterestHeader> header,
+// Ptr<NdnFibEntry> fibEntry)
+// : NdnPitEntry (pit, header, fibEntry)
+// , item_ (0)
+// {
+// static_cast<NdnPitImpl&> (m_container).i_time.insert (*this);
+// }
+
+// NdnPitEntryImpl::~NdnPitEntryImpl ()
+// {
+// static_cast<NdnPitImpl&> (m_container).i_time.erase (*this);
+// }
+
+// TypeId
+// NdnPitImpl::GetTypeId ()
+// {
+// static TypeId tid = TypeId ("ns3::NdnPit")
+// .SetGroupName ("Ndn")
+// .SetParent<NdnPit> ()
+// .AddConstructor<NdnPitImpl> ()
+// .AddAttribute ("MaxSize",
+// "Set maximum number of entries in PIT. If 0, limit is not enforced",
+// StringValue ("0"),
+// MakeUintegerAccessor (&NdnPitImpl::GetMaxSize, &NdnPitImpl::SetMaxSize),
+// MakeUintegerChecker<uint32_t> ())
+// ;
+
+// return tid;
+// }
+
+
+// template<class AcceptanceAndReplacementPolicy>
+// TypeId
+// NdnPitImpl::GetTypeId ()
+// {
+// #error "Not specialized version is not supported"
+// // static TypeId tid = TypeId ("ns3::NdnPit")
+// // .SetGroupName ("Ndn")
+// // .SetParent<NdnPit> ()
+// // .AddConstructor<NdnPitImpl> ()
+// // .AddAttribute ("MaxSize",
+// // "Set maximum number of entries in PIT. If 0, limit is not enforced",
+// // StringValue ("0"),
+// // MakeUintegerAccessor (&NdnPitImpl::GetMaxSize, &NdnPitImpl::SetMaxSize),
+// // MakeUintegerChecker<uint32_t> ())
+// // ;
+
+// return Typeid ();
+// }
+
+template<class Policy>
+NdnPitImpl<Policy>::NdnPitImpl ()
+{
+}
+
+template<class Policy>
+NdnPitImpl<Policy>::~NdnPitImpl ()
+{
+}
+
+template<class Policy>
+uint32_t
+NdnPitImpl<Policy>::GetMaxSize () const
+{
+ return super::getPolicy ().get_max_size ();
+}
+
+template<class Policy>
+void
+NdnPitImpl<Policy>::SetMaxSize (uint32_t maxSize)
+{
+ super::getPolicy ().set_max_size (maxSize);
+}
+
+template<class Policy>
+void
+NdnPitImpl<Policy>::NotifyNewAggregate ()
+{
+ if (m_fib == 0)
+ {
+ m_fib = GetObject<NdnFib> ();
+ }
+ if (m_forwardingStrategy == 0)
+ {
+ m_forwardingStrategy = GetObject<NdnForwardingStrategy> ();
+ }
+
+ NdnPit::NotifyNewAggregate ();
+}
+
+template<class Policy>
+void
+NdnPitImpl<Policy>::DoDispose ()
+{
+ super::clear ();
+
+ m_forwardingStrategy = 0;
+ m_fib = 0;
+
+ NdnPit::DoDispose ();
+}
+
+template<class Policy>
+void
+NdnPitImpl<Policy>::RescheduleCleaning ()
+{
+ m_cleanEvent.Cancel ();
+ if (i_time.empty ())
+ {
+ // NS_LOG_DEBUG ("No items in PIT");
+ return;
+ }
+
+ Time nextEvent = i_time.begin ()->GetExpireTime () - Simulator::Now ();
+ if (nextEvent <= 0) nextEvent = Seconds (0);
+
+ // NS_LOG_DEBUG ("Schedule next cleaning in " <<
+ // nextEvent.ToDouble (Time::S) << "s (at " <<
+ // i_time.begin ()->GetExpireTime () << "s abs time");
+
+ m_cleanEvent = Simulator::Schedule (nextEvent,
+ &NdnPitImpl<Policy>::CleanExpired, this);
+}
+
+template<class Policy>
+void
+NdnPitImpl<Policy>::CleanExpired ()
+{
+ NS_LOG_LOGIC ("Cleaning PIT. Total: " << i_time.size ());
+ Time now = Simulator::Now ();
+
+ // uint32_t count = 0;
+ while (!i_time.empty ())
+ {
+ typename time_index::iterator entry = i_time.begin ();
+ if (entry->GetExpireTime () <= now) // is the record stale?
+ {
+ m_forwardingStrategy->WillErasePendingInterest (entry->to_iterator ()->payload ());
+ super::erase (entry->to_iterator ());
+ // count ++;
+ }
+ else
+ break; // nothing else to do. All later records will not be stale
+ }
+
+ if (super::getPolicy ().size ())
+ {
+ NS_LOG_DEBUG ("Size: " << super::getPolicy ().size ());
+ NS_LOG_DEBUG ("i_time size: " << i_time.size ());
+ }
+ RescheduleCleaning ();
+}
+
+template<class Policy>
+Ptr<NdnPitEntry>
+NdnPitImpl<Policy>::Lookup (const NdnContentObjectHeader &header)
+{
+ /// @todo use predicate to search with exclude filters
+ typename super::iterator item = super::longest_prefix_match (header.GetName ());
+
+ if (item == super::end ())
+ return 0;
+ else
+ return item->payload (); // which could also be 0
+}
+
+template<class Policy>
+Ptr<NdnPitEntry>
+NdnPitImpl<Policy>::Lookup (const NdnInterestHeader &header)
+{
+ // NS_LOG_FUNCTION (header.GetName ());
+ NS_ASSERT_MSG (m_fib != 0, "FIB should be set");
+ NS_ASSERT_MSG (m_forwardingStrategy != 0, "Forwarding strategy should be set");
+
+ typename super::iterator foundItem, lastItem;
+ bool reachLast;
+ boost::tie (foundItem, reachLast, lastItem) = super::getTrie ().find (header.GetName ());
+
+ if (!reachLast || lastItem == super::end ())
+ return 0;
+ else
+ return lastItem->payload (); // which could also be 0
+}
+
+template<class Policy>
+Ptr<NdnPitEntry>
+NdnPitImpl<Policy>::Create (Ptr<const NdnInterestHeader> header)
+{
+ Ptr<NdnFibEntry> fibEntry = m_fib->LongestPrefixMatch (*header);
+ if (fibEntry == 0)
+ return 0;
+
+ // NS_ASSERT_MSG (fibEntry != 0,
+ // "There should be at least default route set" <<
+ // " Prefix = "<< header->GetName() << ", NodeID == " << m_fib->GetObject<Node>()->GetId() << "\n" << *m_fib);
+
+ Ptr< entry > newEntry = ns3::Create< entry > (boost::ref (*this), header, fibEntry);
+ std::pair< typename super::iterator, bool > result = super::insert (header->GetName (), newEntry);
+ if (result.first != super::end ())
+ {
+ if (result.second)
+ {
+ newEntry->SetTrie (result.first);
+ return newEntry;
+ }
+ else
+ {
+ // should we do anything?
+ // update payload? add new payload?
+ return result.first->payload ();
+ }
+ }
+ else
+ return 0;
+}
+
+
+template<class Policy>
+void
+NdnPitImpl<Policy>::MarkErased (Ptr<NdnPitEntry> item)
+{
+ // entry->SetExpireTime (Simulator::Now () + m_PitEntryPruningTimout);
+ super::erase (StaticCast< entry > (item)->to_iterator ());
+}
+
+
+template<class Policy>
+void
+NdnPitImpl<Policy>::Print (std::ostream& os) const
+{
+ // !!! unordered_set imposes "random" order of item in the same level !!!
+ typename super::parent_trie::const_recursive_iterator item (super::getTrie ()), end (0);
+ for (; item != end; item++)
+ {
+ if (item->payload () == 0) continue;
+
+ os << item->payload ()->GetPrefix () << "\t" << *item->payload () << "\n";
+ }
+}
+
+template<class Policy>
+uint32_t
+NdnPitImpl<Policy>::GetSize () const
+{
+ return super::getPolicy ().size ();
+}
+
+template<class Policy>
+Ptr<NdnPitEntry>
+NdnPitImpl<Policy>::Begin ()
+{
+ typename super::parent_trie::recursive_iterator item (super::getTrie ()), end (0);
+ for (; item != end; item++)
+ {
+ if (item->payload () == 0) continue;
+ break;
+ }
+
+ if (item == end)
+ return End ();
+ else
+ return item->payload ();
+}
+
+template<class Policy>
+Ptr<NdnPitEntry>
+NdnPitImpl<Policy>::End ()
+{
+ return 0;
+}
+
+template<class Policy>
+Ptr<NdnPitEntry>
+NdnPitImpl<Policy>::Next (Ptr<NdnPitEntry> from)
+{
+ if (from == 0) return 0;
+
+ typename super::parent_trie::recursive_iterator
+ item (*StaticCast< entry > (from)->to_iterator ()),
+ end (0);
+
+ for (item++; item != end; item++)
+ {
+ if (item->payload () == 0) continue;
+ break;
+ }
+
+ if (item == end)
+ return End ();
+ else
+ return item->payload ();
+}
+
+
+// explicit instantiation and registering
+template class NdnPitImpl<persistent_policy_traits>;
+template class NdnPitImpl<random_policy_traits>;
+template class NdnPitImpl<lru_policy_traits>;
+
+NS_OBJECT_ENSURE_REGISTERED_TEMPL(NdnPitImpl, persistent_policy_traits);
+NS_OBJECT_ENSURE_REGISTERED_TEMPL(NdnPitImpl, random_policy_traits);
+NS_OBJECT_ENSURE_REGISTERED_TEMPL(NdnPitImpl, lru_policy_traits);
+
+
+} // namespace ns3