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

/*

 * Copyright (c) 2005,2006 INRIA

 *

 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#include "simulator.h"

#include "scheduler.h"

#include "event-impl.h"

#include "ns3/ptr.h"

#include "ns3/pointer.h"

#include "ns3/assert.h"

#include <math.h>

#include <fstream>

#include <list>

#include <vector>

#include <iostream>

#define noTRACE_SIMU 1

#ifdef TRACE_SIMU

#include <iostream>

# define TRACE(x) \

std::cout << "SIMU TRACE " << Simulator::Now () << " " << x << std::endl;

# define TRACE_S(x) \

std::cout << "SIMU TRACE " << x << std::endl;

#else /* TRACE_SIMU */

# define TRACE(format,...)

# define TRACE_S(format,...)

#endif /* TRACE_SIMU */

namespace ns3 {

class SimulatorPrivate : public Object

{

public:

  static TypeId GetTypeId (void);

  SimulatorPrivate ();

  ~SimulatorPrivate ();

  void Destroy ();

  void EnableLogTo (char const *filename);

  bool IsFinished (void) const;

  Time Next (void) const;

  void Stop (void);

  void StopAt (Time const &time);

  EventId Schedule (Time const &time, const Ptr<EventImpl> &event);

  EventId ScheduleNow (const Ptr<EventImpl> &event);

  EventId ScheduleDestroy (const Ptr<EventImpl> &event);

  void Remove (const EventId &ev);

  void Cancel (const EventId &ev);

  bool IsExpired (const EventId &ev) const;

  void Run (void);

  Time Now (void) const;

  Time GetDelayLeft (const EventId &id) const;

  Time GetMaximumSimulationTime (void) const;

  void SetScheduler (Ptr<Scheduler> scheduler);

  Ptr<Scheduler> GetScheduler (void) const;

private:

  void ProcessOneEvent (void);

  uint64_t NextTs (void) const;

  typedef std::list<EventId> DestroyEvents;

  DestroyEvents m_destroyEvents;

  uint64_t m_stopAt;

  bool m_stop;

  Ptr<Scheduler> m_events;

  uint32_t m_uid;

  uint32_t m_currentUid;

  uint64_t m_currentTs;

  std::ofstream m_log;

  std::ifstream m_inputLog;

  bool m_logEnable;

  // number of events that have been inserted but not yet scheduled,

  // not counting the "destroy" events; this is used for validation

  int m_unscheduledEvents;

};

TypeId

SimulatorPrivate::GetTypeId (void)

{

    .SetParent<Object> ()

    .AddConstructor<SimulatorPrivate> ()

    .AddAttribute ("Scheduler",

                   "XXX",

                   Pointer (),

                   // XXX: allow getting the scheduler too.

                   MakePointerAccessor (&SimulatorPrivate::SetScheduler),

                   MakePointerChecker<Scheduler> ())

    ;

  return tid;

}

SimulatorPrivate::SimulatorPrivate ()

{

  m_stop = false;

  m_stopAt = 0;

  // uids are allocated from 4.

  // uid 0 is "invalid" events

  // uid 1 is "now" events

  // uid 2 is "destroy" events

  m_uid = 4; 

  // before ::Run is entered, the m_currentUid will be zero

  m_currentUid = 0;

  m_logEnable = false;

  m_currentTs = 0;

  m_unscheduledEvents = 0;

}

SimulatorPrivate::~SimulatorPrivate ()

{

  while (!m_events->IsEmpty ())

    {

      EventId next = m_events->RemoveNext ();

    }

  m_events = 0;

}

void

SimulatorPrivate::Destroy ()

{

  while (!m_destroyEvents.empty ()) 

    {

      Ptr<EventImpl> ev = m_destroyEvents.front ().PeekEventImpl ();

      m_destroyEvents.pop_front ();

      TRACE ("handle destroy " << ev);

      if (!ev->IsCancelled ())

        {

          ev->Invoke ();

        }

    }

}

void

SimulatorPrivate::SetScheduler (Ptr<Scheduler> scheduler)

{

  if (m_events != 0)

    {

      while (!m_events->IsEmpty ())

        {

          EventId next = m_events->RemoveNext ();

          scheduler->Insert (next);

        }

    }

  m_events = scheduler;

}

Ptr<Scheduler>

SimulatorPrivate::GetScheduler (void) const

{

  return m_events;

}

void

SimulatorPrivate::EnableLogTo (char const *filename)

{

  m_log.open (filename);

  m_logEnable = true;

}

void

SimulatorPrivate::ProcessOneEvent (void)

{

  EventId next = m_events->RemoveNext ();

  NS_ASSERT (next.GetTs () >= m_currentTs);

  --m_unscheduledEvents;

  TRACE ("handle " << nextEv);

  m_currentTs = next.GetTs ();

  m_currentUid = next.GetUid ();

  if (m_logEnable) 

    {

      m_log << "e "<<next.GetUid () << " " << next.GetTs () << std::endl;

    }

  EventImpl *event = next.PeekEventImpl ();

  event->Invoke ();

}

bool 

SimulatorPrivate::IsFinished (void) const

{

  return m_events->IsEmpty ();

}

uint64_t

SimulatorPrivate::NextTs (void) const

{

  NS_ASSERT (!m_events->IsEmpty ());

  EventId id = m_events->PeekNext ();

  return id.GetTs ();

}

Time

SimulatorPrivate::Next (void) const

{

  return TimeStep (NextTs ());

}

void

SimulatorPrivate::Run (void)

{

  while (!m_events->IsEmpty () && !m_stop && 

         (m_stopAt == 0 || m_stopAt > NextTs ())) 

    {

      ProcessOneEvent ();

    }

  // If the simulator stopped naturally by lack of events, make a

  // consistency test to check that we didn't lose any events along the way.

  NS_ASSERT(!m_events->IsEmpty () || m_unscheduledEvents == 0);

  m_log.close ();

}

void 

SimulatorPrivate::Stop (void)

{

  m_stop = true;

}

void 

SimulatorPrivate::StopAt (Time const &at)

{

  NS_ASSERT (at.IsPositive ());

  m_stopAt = at.GetTimeStep ();

}

EventId

SimulatorPrivate::Schedule (Time const &time, const Ptr<EventImpl> &event)

{

  NS_ASSERT (time.IsPositive ());

  NS_ASSERT (time >= TimeStep (m_currentTs));

  uint64_t ts = (uint64_t) time.GetTimeStep ();

  EventId id (event, ts, m_uid);

  if (m_logEnable) 

    {

      m_log << "i "<<m_currentUid<<" "<<m_currentTs<<" "

            <<m_uid<<" "<<time.GetTimeStep () << std::endl;

    }

  m_uid++;

  ++m_unscheduledEvents;

  m_events->Insert (id);

  return id;

}

EventId

SimulatorPrivate::ScheduleNow (const Ptr<EventImpl> &event)

{

  EventId id (event, m_currentTs, m_uid);

  if (m_logEnable) 

    {

      m_log << "i "<<m_currentUid<<" "<<m_currentTs<<" "

            <<m_uid<<" "<<m_currentTs << std::endl;

    }

  m_uid++;

  ++m_unscheduledEvents;

  m_events->Insert (id);

  return id;

}

EventId

SimulatorPrivate::ScheduleDestroy (const Ptr<EventImpl> &event)

{

  EventId id (event, m_currentTs, 2);

  m_destroyEvents.push_back (id);

  if (m_logEnable) 

  {

    m_log << "id " << m_currentUid << " " << Now ().GetTimeStep () << " "

          << m_uid << std::endl;

  }

  m_uid++;

  return id;

}

Time

SimulatorPrivate::Now (void) const

{

  return TimeStep (m_currentTs);

}

Time 

SimulatorPrivate::GetDelayLeft (const EventId &id) const

{

  if (IsExpired (id))

    {

      return TimeStep (0);

    }

  else

    {

      return TimeStep (id.GetTs () - m_currentTs);

    }

}

void

SimulatorPrivate::Remove (const EventId &ev)

{

  if (ev.GetUid () == 2)

    {

      // destroy events.

      for (DestroyEvents::iterator i = m_destroyEvents.begin (); i != m_destroyEvents.end (); i++)

        {

          if (*i == ev)

            {

              m_destroyEvents.erase (i);

              break;

            }

         }

      return;

    }

  if (IsExpired (ev))

    {

      return;

    }

  m_events->Remove (ev);

  Cancel (ev);

  if (m_logEnable) 

    {

      m_log << "r " << m_currentUid << " " << m_currentTs << " "

            << ev.GetUid () << " " << ev.GetTs () << std::endl;

    }

  --m_unscheduledEvents;

}

void

SimulatorPrivate::Cancel (const EventId &id)

{

  if (!IsExpired (id))

    {

      id.PeekEventImpl ()->Cancel ();

    }

}

bool

SimulatorPrivate::IsExpired (const EventId &ev) const

{

  if (ev.GetUid () == 2)

    {

      // destroy events.

      for (DestroyEvents::const_iterator i = m_destroyEvents.begin (); i != m_destroyEvents.end (); i++)

        {

          if (*i == ev)

            {

              return false;

            }

         }

      return true;

    }

  if (ev.PeekEventImpl () == 0 ||

      ev.GetTs () < m_currentTs ||

      (ev.GetTs () == m_currentTs &&

       ev.GetUid () <= m_currentUid) ||

      ev.PeekEventImpl ()->IsCancelled ()) 

    {

      return true;

    }

  else

    {

      return false;

    }

}

Time 

SimulatorPrivate::GetMaximumSimulationTime (void) const

{

  // XXX: I am fairly certain other compilers use other non-standard

  // post-fixes to indicate 64 bit constants.

  return TimeStep (0x7fffffffffffffffLL);

}

}; // namespace ns3

#include "scheduler-list.h"

#include "scheduler-heap.h"

#include "scheduler-map.h"

namespace ns3 {

Ptr<SimulatorPrivate> Simulator::m_priv = 0;

void Simulator::SetScheduler (Ptr<Scheduler> scheduler)

{

  GetPriv ()->SetScheduler (scheduler);

}

void Simulator::EnableLogTo (char const *filename)

{

  GetPriv ()->EnableLogTo (filename);

}

Ptr<SimulatorPrivate>

Simulator::GetPriv (void)

{

  if (m_priv == 0) 

    {

      m_priv = CreateObject<SimulatorPrivate> ();

      Ptr<Scheduler> scheduler = CreateObject<SchedulerMap> ();

      m_priv->SetScheduler (scheduler);

    }

  TRACE_S ("priv " << m_priv);

  return m_priv;

}

void

Simulator::Destroy (void)

{

  if (m_priv == 0)

    {

      return;

    }

  m_priv->Destroy ();

  m_priv = 0;

}

bool 

Simulator::IsFinished (void)

{

  return GetPriv ()->IsFinished ();

}

Time

Simulator::Next (void)

{

  return GetPriv ()->Next ();

}

void 

Simulator::Run (void)

{

  GetPriv ()->Run ();

}

void 

Simulator::Stop (void)

{

  TRACE ("stop");

  GetPriv ()->Stop ();

}

void 

Simulator::StopAt (Time const &at)

{

  GetPriv ()->StopAt (at);

}

Time

Simulator::Now (void)

{

  return GetPriv ()->Now ();

}

Time

Simulator::GetDelayLeft (const EventId &id)

{

  return GetPriv ()->GetDelayLeft (id);

}

Ptr<EventImpl>

Simulator::MakeEvent (void (*f) (void))

{

    // zero arg version