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

/*

 * Copyright (c) 2008 Florian Westphal

 *

 * 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: Florian Westphal <fw@strlen.de>

 */

#ifndef NODE_NSC_H

#define NODE_NSC_H

#include <string>

#include <list>

#include "ns3/callback.h"

#include "ns3/ptr.h"

#include "ns3/object.h"

#include "ns3/net-device.h"

#include "ns3/timer.h"

#include "nsc-sysctl.h"

#include "sim_interface.h"

/*

 * silly hack to switch betwwen NSC API revisions faster during development.

 * should be removed before erging with upstream ns3-dev.

 */

#if NSC_VERSION == 0x00500

#undef NSC_NEXT

#else

#define NSC_NEXT	1

#endif

namespace ns3 {

// IInterruptCallback and ISendCallback are NSC interfaces.

class NscGlue : public Object, IInterruptCallback, ISendCallback

{

public:

  static TypeId GetTypeId (void);

  NscGlue (void);

  void SetNode(Ptr<Node> n);

  void SetNscLibrary(const std::string &soname);

  std::string GetNscLibrary () const;

  // returns true if l3 protocol number can be handled by NSC.

  // currently only returns true for IPv4.

  bool IsNscProtocol (uint16_t proto);

  // passes packet on to NSC. NSC will see the packet arriving on

  // interface ifindex.

  void PassPacketToNsc (Ptr<const Packet> packet, int ifindex);

  // used to register the L4 wakeup call:

  // maybe it should directly be used to register individual

  // sockets?

  void RegisterWakeupCallback (Callback<void> cb);

  // HACK, make this private.

  // Socket implementations should not use m_nscStack-> methods

  // directly.

  INetStack* m_nscStack;

private:

  // IInterruptCallback methods: wakeup and gettime.

  // wakeup is called by the NSC stack whenever something of interest

  // has happened, e.g. when data arrives on a socket, a listen socket

  // has a new connection pending, etc.

  virtual void wakeup();

  // This is called by the Linux stack RNG initialization.

  // Its also used by the cradle code to add a timestamp to

  // printk/printf/debug output.

  virtual void gettime(unsigned int *, unsigned int *);

  // send_callback is invoked by NSCs 'ethernet driver' to re-inject

  // a packet (i.e. an octet soup consisting of an IP Header, TCP Header

  // and user payload, if any), into ns-3.

#ifdef NSC_NEXT

  void send_callback(int idx, const void* data, unsigned int datalen);

#else

  void send_callback(const void* data, unsigned int datalen);

#endif

  // internal helper. adds ipv4 addresses.

  // XXX: rethink. This really doesn't belong here.

  // NSC should also split up interface creation and address assignment.

  void AddIface(void);

  std::list<Callback<void> > m_wakeupCallbacks;

  void *m_dlopenHandle;

  Timer m_softTimer;

  // called by m_softTimer

  void SoftRtcInterrupt (void);

  std::string m_nscLibrary;

  Ptr<Node> m_node; // sigh...

};

} //namespace ns3

#endif /* NODE_NSC_H */