Create a new contrib module; move event-garbage-collector.{h,cc} to the contrib module.
authorGustavo J. A. M. Carneiro <gjc@inescporto.pt>
Thu, 06 Dec 2007 11:05:17 +0000
changeset 1878 f947cd18f0bb
parent 1877 b2ebc493cd58
child 1879 876026968947
Create a new contrib module; move event-garbage-collector.{h,cc} to the contrib module.
src/contrib/event-garbage-collector.cc
src/contrib/event-garbage-collector.h
src/contrib/wscript
src/routing/olsr/event-garbage-collector.cc
src/routing/olsr/event-garbage-collector.h
src/routing/olsr/olsr-agent-impl.h
src/routing/olsr/wscript
src/wscript
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/contrib/event-garbage-collector.cc	Thu Dec 06 11:05:17 2007 +0000
@@ -0,0 +1,153 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2007 INESC Porto
+ *
+ * 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: Gustavo J. A. M. Carneiro  <gjc@inescporto.pt>
+ */
+#include "event-garbage-collector.h"
+
+#define CLEANUP_CHUNK_MIN_SIZE 8
+#define CLEANUP_CHUNK_MAX_SIZE 128
+
+
+namespace ns3 {
+
+
+EventGarbageCollector::EventGarbageCollector () :
+  m_nextCleanupSize (CLEANUP_CHUNK_MIN_SIZE)
+{}
+
+void
+EventGarbageCollector::Track (EventId event)
+{
+  m_events.insert (event);
+  if (m_events.size () >= m_nextCleanupSize)
+    Cleanup ();
+}
+
+void
+EventGarbageCollector::Grow ()
+{
+  m_nextCleanupSize += (m_nextCleanupSize < CLEANUP_CHUNK_MAX_SIZE?
+                        m_nextCleanupSize : CLEANUP_CHUNK_MAX_SIZE);
+}
+
+void
+EventGarbageCollector::Shrink ()
+{
+  while (m_nextCleanupSize > m_events.size ())
+    m_nextCleanupSize >>= 1;
+  Grow ();
+}
+
+// Called when a new event was added and the cleanup limit was exceeded in consequence.
+void
+EventGarbageCollector::Cleanup ()
+{
+  for (EventList::iterator iter = m_events.begin (); iter != m_events.end ();)
+    {
+      if ((*iter).IsExpired ())
+        {
+          m_events.erase (iter++);
+        }
+      else
+        break; // EventIds are sorted by timestamp => further events are not expired for sure
+    }
+
+  // If after cleanup we are still over the limit, increase the limit.
+  if (m_events.size () >= m_nextCleanupSize)
+    Grow ();
+  else
+    Shrink ();
+}
+
+
+EventGarbageCollector::~EventGarbageCollector ()
+{
+  for (EventList::iterator event = m_events.begin ();
+       event != m_events.end (); event++)
+    {
+      Simulator::Cancel (*event);
+    }
+}
+
+}; // namespace ns3
+
+
+
+#ifdef RUN_SELF_TESTS
+
+#include "ns3/test.h"
+
+namespace ns3 {
+
+class EventGarbageCollectorTests : public Test
+{
+  int m_counter;
+  EventGarbageCollector *m_events;
+
+  void EventGarbageCollectorCallback ();
+
+public:
+
+  EventGarbageCollectorTests ();
+  virtual ~EventGarbageCollectorTests ();
+  virtual bool RunTests (void);
+};
+
+EventGarbageCollectorTests::EventGarbageCollectorTests ()
+  : Test ("EventGarbageCollector"), m_counter (0), m_events (0)
+{}
+
+EventGarbageCollectorTests::~EventGarbageCollectorTests ()
+{}
+
+void
+EventGarbageCollectorTests::EventGarbageCollectorCallback ()
+{
+  m_counter++;
+  if (m_counter == 50)
+    {
+      // this should cause the remaining (50) events to be cancelled
+      delete m_events;
+      m_events = 0;
+    }
+}
+
+bool EventGarbageCollectorTests::RunTests (void)
+{
+  bool result = true;
+
+  m_events = new EventGarbageCollector ();
+
+  for (int n = 0; n < 100; n++)
+    {
+      m_events->Track (Simulator::Schedule
+                       (Simulator::Now (),
+                        &EventGarbageCollectorTests::EventGarbageCollectorCallback,
+                        this));
+    }
+  Simulator::Run ();
+  NS_TEST_ASSERT_EQUAL (m_events, 0);
+  NS_TEST_ASSERT_EQUAL (m_counter, 50);
+  return result;
+}
+
+static EventGarbageCollectorTests g_eventCollectorTests;
+    
+};
+
+#endif /* RUN_SELF_TESTS */
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/contrib/event-garbage-collector.h	Thu Dec 06 11:05:17 2007 +0000
@@ -0,0 +1,71 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2007 INESC Porto
+ *
+ * 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: Gustavo J. A. M. Carneiro  <gjc@inescporto.pt>
+ */
+#ifndef EVENT_GARBAGE_COLLECTOR_H
+#define EVENT_GARBAGE_COLLECTOR_H
+
+#include <set>
+#include "ns3/event-id.h"
+#include "ns3/simulator.h"
+
+namespace ns3 {
+
+/**
+ * \brief An object that tracks scheduled events and automatically
+ * cancels them when it is destroyed.  It is useful in situations
+ * where multiple instances of the same type of event can
+ * simultaneously be scheduled, and when the events should be limited
+ * to the lifetime of a container object.
+ */
+class EventGarbageCollector
+{
+public:
+
+  EventGarbageCollector ();
+
+  /**
+   * \brief Tracks a new event
+   */
+  void Track (EventId event);
+
+  ~EventGarbageCollector ();
+
+private:
+
+  struct EventIdLessThanTs
+  {
+    bool operator () (const EventId &a, const EventId &b) const
+    {
+      return (a.GetTs () < b.GetTs ());
+    }
+  };
+
+  typedef std::multiset<EventId, EventIdLessThanTs> EventList;
+
+  EventList::size_type m_nextCleanupSize;
+  EventList m_events;
+
+  void Cleanup ();
+  void Grow ();
+  void Shrink ();
+};
+
+}; // namespace ns3
+
+#endif /* EVENT_GARBAGE_COLLECTOR_H */
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/contrib/wscript	Thu Dec 06 11:05:17 2007 +0000
@@ -0,0 +1,12 @@
+## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
+
+def build(bld):
+    module = bld.create_ns3_module('contrib', ['simulator'])
+    module.source = [
+        'event-garbage-collector.cc',
+        ]
+
+    headers = bld.create_obj('ns3header')
+    headers.source = [
+        'event-garbage-collector.h',
+        ]
--- a/src/routing/olsr/event-garbage-collector.cc	Wed Dec 05 11:51:10 2007 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,153 +0,0 @@
-/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/*
- * Copyright (c) 2007 INESC Porto
- *
- * 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: Gustavo J. A. M. Carneiro  <gjc@inescporto.pt>
- */
-#include "event-garbage-collector.h"
-
-#define CLEANUP_CHUNK_MIN_SIZE 8
-#define CLEANUP_CHUNK_MAX_SIZE 128
-
-
-namespace ns3 {
-
-
-EventGarbageCollector::EventGarbageCollector () :
-  m_nextCleanupSize (CLEANUP_CHUNK_MIN_SIZE)
-{}
-
-void
-EventGarbageCollector::Track (EventId event)
-{
-  m_events.insert (event);
-  if (m_events.size () >= m_nextCleanupSize)
-    Cleanup ();
-}
-
-void
-EventGarbageCollector::Grow ()
-{
-  m_nextCleanupSize += (m_nextCleanupSize < CLEANUP_CHUNK_MAX_SIZE?
-                        m_nextCleanupSize : CLEANUP_CHUNK_MAX_SIZE);
-}
-
-void
-EventGarbageCollector::Shrink ()
-{
-  while (m_nextCleanupSize > m_events.size ())
-    m_nextCleanupSize >>= 1;
-  Grow ();
-}
-
-// Called when a new event was added and the cleanup limit was exceeded in consequence.
-void
-EventGarbageCollector::Cleanup ()
-{
-  for (EventList::iterator iter = m_events.begin (); iter != m_events.end ();)
-    {
-      if ((*iter).IsExpired ())
-        {
-          m_events.erase (iter++);
-        }
-      else
-        break; // EventIds are sorted by timestamp => further events are not expired for sure
-    }
-
-  // If after cleanup we are still over the limit, increase the limit.
-  if (m_events.size () >= m_nextCleanupSize)
-    Grow ();
-  else
-    Shrink ();
-}
-
-
-EventGarbageCollector::~EventGarbageCollector ()
-{
-  for (EventList::iterator event = m_events.begin ();
-       event != m_events.end (); event++)
-    {
-      Simulator::Cancel (*event);
-    }
-}
-
-}; // namespace ns3
-
-
-
-#ifdef RUN_SELF_TESTS
-
-#include "ns3/test.h"
-
-namespace ns3 {
-
-class EventGarbageCollectorTests : public Test
-{
-  int m_counter;
-  EventGarbageCollector *m_events;
-
-  void EventGarbageCollectorCallback ();
-
-public:
-
-  EventGarbageCollectorTests ();
-  virtual ~EventGarbageCollectorTests ();
-  virtual bool RunTests (void);
-};
-
-EventGarbageCollectorTests::EventGarbageCollectorTests ()
-  : Test ("EventGarbageCollector"), m_counter (0), m_events (0)
-{}
-
-EventGarbageCollectorTests::~EventGarbageCollectorTests ()
-{}
-
-void
-EventGarbageCollectorTests::EventGarbageCollectorCallback ()
-{
-  m_counter++;
-  if (m_counter == 50)
-    {
-      // this should cause the remaining (50) events to be cancelled
-      delete m_events;
-      m_events = 0;
-    }
-}
-
-bool EventGarbageCollectorTests::RunTests (void)
-{
-  bool result = true;
-
-  m_events = new EventGarbageCollector ();
-
-  for (int n = 0; n < 100; n++)
-    {
-      m_events->Track (Simulator::Schedule
-                       (Simulator::Now (),
-                        &EventGarbageCollectorTests::EventGarbageCollectorCallback,
-                        this));
-    }
-  Simulator::Run ();
-  NS_TEST_ASSERT_EQUAL (m_events, 0);
-  NS_TEST_ASSERT_EQUAL (m_counter, 50);
-  return result;
-}
-
-static EventGarbageCollectorTests g_eventCollectorTests;
-    
-};
-
-#endif /* RUN_SELF_TESTS */
--- a/src/routing/olsr/event-garbage-collector.h	Wed Dec 05 11:51:10 2007 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,71 +0,0 @@
-/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/*
- * Copyright (c) 2007 INESC Porto
- *
- * 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: Gustavo J. A. M. Carneiro  <gjc@inescporto.pt>
- */
-#ifndef EVENT_GARBAGE_COLLECTOR_H
-#define EVENT_GARBAGE_COLLECTOR_H
-
-#include <set>
-#include "ns3/event-id.h"
-#include "ns3/simulator.h"
-
-namespace ns3 {
-
-/**
- * \brief An object that tracks scheduled events and automatically
- * cancels them when it is destroyed.  It is useful in situations
- * where multiple instances of the same type of event can
- * simultaneously be scheduled, and when the events should be limited
- * to the lifetime of a container object.
- */
-class EventGarbageCollector
-{
-public:
-
-  EventGarbageCollector ();
-
-  /**
-   * \brief Tracks a new event
-   */
-  void Track (EventId event);
-
-  ~EventGarbageCollector ();
-
-private:
-
-  struct EventIdLessThanTs
-  {
-    bool operator () (const EventId &a, const EventId &b) const
-    {
-      return (a.GetTs () < b.GetTs ());
-    }
-  };
-
-  typedef std::multiset<EventId, EventIdLessThanTs> EventList;
-
-  EventList::size_type m_nextCleanupSize;
-  EventList m_events;
-
-  void Cleanup ();
-  void Grow ();
-  void Shrink ();
-};
-
-}; // namespace ns3
-
-#endif /* EVENT_GARBAGE_COLLECTOR_H */
--- a/src/routing/olsr/olsr-agent-impl.h	Wed Dec 05 11:51:10 2007 +0000
+++ b/src/routing/olsr/olsr-agent-impl.h	Thu Dec 06 11:05:17 2007 +0000
@@ -37,7 +37,7 @@
 #include "ns3/packet.h"
 #include "ns3/node.h"
 #include "ns3/socket.h"
-#include "event-garbage-collector.h"
+#include "ns3/event-garbage-collector.h"
 #include "ns3/timer.h"
 #include "ns3/callback-trace-source.h"
 
--- a/src/routing/olsr/wscript	Wed Dec 05 11:51:10 2007 +0000
+++ b/src/routing/olsr/wscript	Thu Dec 06 11:05:17 2007 +0000
@@ -1,7 +1,7 @@
 ## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
 
 def build(bld):
-    module = bld.create_ns3_module('olsr', ['internet-node'])
+    module = bld.create_ns3_module('olsr', ['internet-node', 'contrib'])
     module.includes = '.'
     module.source = [
         'olsr-header.cc',
@@ -10,7 +10,6 @@
         'olsr-agent.cc',
         'olsr-agent-impl.cc',
         'olsr.cc',
-        'event-garbage-collector.cc',
         ]
 
     headers = bld.create_obj('ns3header')
--- a/src/wscript	Wed Dec 05 11:51:10 2007 +0000
+++ b/src/wscript	Thu Dec 06 11:05:17 2007 +0000
@@ -14,6 +14,7 @@
     'core',
     'common',
     'simulator',
+    'contrib',
     'node',
     'internet-node',
     'devices/point-to-point',