emu-net-device.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008 University of Washington
 *
 * 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
 */

#ifndef EMU_NET_DEVICE_H
#define EMU_NET_DEVICE_H

#include <cstring>

#include "ns3/address.h"
#include "ns3/net-device.h"
#include "ns3/node.h"
#include "ns3/callback.h"
#include "ns3/packet.h"
#include "ns3/traced-callback.h"
#include "ns3/event-id.h"
#include "ns3/nstime.h"
#include "ns3/data-rate.h"
#include "ns3/ptr.h"
#include "ns3/mac48-address.h"
#include "ns3/system-thread.h"
#include "ns3/system-mutex.h"

namespace ns3 {

class Queue;

class EmuNetDevice : public NetDevice 
{
public:
  static TypeId GetTypeId (void);

  enum EncapsulationMode {
    ILLEGAL,     
    DIX,         
    LLC,         
  };

  EmuNetDevice ();

  virtual ~EmuNetDevice ();

  void SetDataRate (DataRate bps);

  void Start (Time tStart);

  void Stop (Time tStop);

  void SetQueue (Ptr<Queue> queue);

  Ptr<Queue> GetQueue (void) const;


//
// Pure virtual methods inherited from NetDevice we must implement.
//
  virtual void SetIfIndex (const uint32_t index);
  virtual uint32_t GetIfIndex (void) const;

  virtual Ptr<Channel> GetChannel (void) const;

  virtual void SetAddress (Address address);
  virtual Address GetAddress (void) const;

  virtual bool SetMtu (const uint16_t mtu);
  virtual uint16_t GetMtu (void) const;

  virtual bool IsLinkUp (void) const;

  virtual void AddLinkChangeCallback (Callback<void> callback);

  virtual bool IsBroadcast (void) const;
  virtual Address GetBroadcast (void) const;

  virtual bool IsMulticast (void) const;

  virtual Address GetMulticast (Ipv4Address multicastGroup) const;

  virtual Address GetMulticast (Ipv6Address addr) const;

  virtual bool IsPointToPoint (void) const;

  virtual bool IsBridge (void) const;

  virtual bool Send (Ptr<Packet> packet, const Address &dest, uint16_t protocolNumber);

  virtual bool SendFrom (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber);

  virtual Ptr<Node> GetNode (void) const;
  virtual void SetNode (Ptr<Node> node);

  virtual bool NeedsArp (void) const;

  virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb);
  virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb);

  virtual bool SupportsSendFrom (void) const;

  void SetEncapsulationMode (EmuNetDevice::EncapsulationMode mode);

  EmuNetDevice::EncapsulationMode  GetEncapsulationMode (void) const;

private:
  EmuNetDevice (const EmuNetDevice &);
  EmuNetDevice & operator= (const EmuNetDevice &);

  virtual void DoDispose (void);

  void CreateSocket (void);

  std::string FindCreator (std::string creatorName);

  void StartDevice (void);

  void StopDevice (void);

  void ReadThread (void);

  void ForwardUp (uint8_t *buf, uint32_t len);

  void AddHeader (Ptr<Packet> p, uint16_t protocolNumber);

  bool ProcessHeader (Ptr<Packet> p, uint16_t& param);

  bool TransmitStart (Ptr<Packet> p);

  void NotifyLinkUp (void);

  Ptr<Queue> m_queue;

  TracedCallback<Ptr<const Packet> > m_macTxTrace;

  TracedCallback<Ptr<const Packet> > m_macTxDropTrace;

  TracedCallback<Ptr<const Packet> > m_macPromiscRxTrace;

  TracedCallback<Ptr<const Packet> > m_macRxTrace;

  TracedCallback<Ptr<const Packet> > m_macRxDropTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxDropTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxDropTrace;

  TracedCallback<Ptr<const Packet> > m_snifferTrace;

  TracedCallback<Ptr<const Packet> > m_promiscSnifferTrace;

  Time m_tStart;

  Time m_tStop;

  EventId m_startEvent;
  EventId m_stopEvent;

  int32_t m_sock;

  Ptr<SystemThread> m_readThread;

  Ptr<Node> m_node;

  Mac48Address m_address;

  NetDevice::ReceiveCallback m_rxCallback;

  NetDevice::PromiscReceiveCallback m_promiscRxCallback;

  uint32_t m_ifIndex;

  int32_t m_sll_ifindex;

  EncapsulationMode m_encapMode;

  bool m_linkUp;

  bool m_isBroadcast;

  bool m_isMulticast;

  TracedCallback<> m_linkChangeCallbacks;

  std::string m_deviceName;

  uint8_t *m_packetBuffer;

  /*
   * a copy of the node id so the read thread doesn't have to GetNode() in
   * in order to find the node ID.  Thread unsafe reference counting in 
   * multithreaded apps is not a good thing.
   */
  uint32_t m_nodeId;

  uint32_t m_maxPendingReads;
  uint32_t m_pendingReadCount;
  SystemMutex m_pendingReadMutex;
};

} // namespace ns3

#endif /* EMU_NET_DEVICE_H */