fifth.c 예제 파일 설명(1)

Fifth example scenario(1)

5번째 scenario 부터는 코드도 길고 내용도 많아져서 2번의 포스팅으로 나누어 진행하려고 합니다. 오늘은 fifth.cc 예제 파일의 첫번째 포스팅으로 사용자가 어플리케이션을 만드는 방법을 소개하도록 하겠습니다. first.cc ~ third.cc 까지는 ns-3에서 제공하는 어플리케이션인 UdpEchoClient, UdpEchoServer를 사용하였습니다.

위 어플리케이션은 단순하게 클라이언트가 서버로 패킷을 보내면 서버는 클라이언트로부터 받은 패킷을 클라이언트로 다시 보내는 기능을 했습니다. 그러나 상황에 따라서 다양한 어플리케이션이 필요할 수 있습니다. 예를 들어 기존 TCP/IP를 사용했을 때 카카오톡과 같은 IM(Instant Messenger)의 성능과 자체 개발한 프로토콜을 사용했을 때 성능을 비교하고 싶다면 IM과 비슷한 기능을 하는 어플리케이션이 필요합니다. 그러나 ns-3는 그러한 어플리케이션을 제공하고 있지 않습니다. 이런 경우 사용자가 비슷한 어플리케이션을 만들어 시뮬레이션에 사용할 수 있습니다. 이번 포스팅에서는 위와 같은 경우, 사용자가 어떻게 새로운 어플리케이션을 만들 수 있는지 알아보도록 하겠습니다.

ns-3에서 어플리케이션은 객체로 구성되어있습니다. 지금까지 써온 UdpEchoClient나 UdpEchoServer도 클래스로 선언되어 객체를 만들어 사용합니다. ns-3에서 2개의 어플리케이션을 어떻게 정의했는지 살펴보도록 하겠습니다.

class UdpEchoClient : public Application
{
  ...
}

class UdpEchoServer : public Application
{
  ...
}

위와 같이 특정 어플리케이션 클래스가 Application이라는 클래스를 상속함으로써 ns-3 시뮬레이션에서 어플리케이션의 역할을 할 수 있도록 해줍니다. 따라서 사용자가 직접 어플리케이션을 만들고 싶다면 Application 클래스를 상속받는 클래스를 정의하면 됩니다.

사용자는 Application 클래스를 상속받는 클래스를 정의하고 필요한 기능을 함수로 구현하므로써 사용자의 목적에 맞는 어플리케이션을 만들 수 있습니다. IM의 경우 Application을 상속받도록 하고 IM이 제공하는 기능을 함수로 구현하면 특정 IM 어플리케이션도 ns-3로 시뮬레이션이 가능해집니다.

Source Code

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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
 */

#include <fstream>
#include "ns3/core-module.h"
#include "ns3/network-module.h"
#include "ns3/internet-module.h"
#include "ns3/point-to-point-module.h"
#include "ns3/applications-module.h"

using namespace ns3;

NS_LOG_COMPONENT_DEFINE ("FifthScriptExample");

// ===========================================================================
//
//         node 0                 node 1
//   +----------------+    +----------------+
//   |    ns-3 TCP    |    |    ns-3 TCP    |
//   +----------------+    +----------------+
//   |    10.1.1.1    |    |    10.1.1.2    |
//   +----------------+    +----------------+
//   | point-to-point |    | point-to-point |
//   +----------------+    +----------------+
//           |                     |
//           +---------------------+
//                5 Mbps, 2 ms
//
//
// We want to look at changes in the ns-3 TCP congestion window.  We need
// to crank up a flow and hook the CongestionWindow attribute on the socket
// of the sender.  Normally one would use an on-off application to generate a
// flow, but this has a couple of problems.  First, the socket of the on-off
// application is not created until Application Start time, so we wouldn't be
// able to hook the socket (now) at configuration time.  Second, even if we
// could arrange a call after start time, the socket is not public so we
// couldn't get at it.
//
// So, we can cook up a simple version of the on-off application that does what
// we want.  On the plus side we don't need all of the complexity of the on-off
// application.  On the minus side, we don't have a helper, so we have to get
// a little more involved in the details, but this is trivial.
//
// So first, we create a socket and do the trace connect on it; then we pass
// this socket into the constructor of our simple application which we then
// install in the source node.
// ===========================================================================
//

class MyApp : public Application // 새로운 MyApp 어플리케이션이 Application 클래스를 상속받도록 한다.
{
public:

  MyApp ();
  virtual ~MyApp();

  void Setup (Ptr<Socket> socket, Address address, uint32_t packetSize, uint32_t nPackets, DataRate dataRate);

private:
  virtual void StartApplication (void); // StartApplication은 Application 클래스를 상속받았을 때 반드시 구현해줘야 하는 함수이다.
  virtual void StopApplication (void); // StopApplication은 Application 클래스를 상속받았을 때 반드시 구현해줘야 하는 함수이다.

  void ScheduleTx (void);
  void SendPacket (void);

  Ptr<Socket>     m_socket;     // MyApp 어플리케이션에서 사용할 소켓
  Address         m_peer;       // MyApp 어플리케이션이 보내는 패킷의 목적지
  uint32_t        m_packetSize; // MyApp 어플리케이션이 보내는 패킷의 크기  
  uint32_t        m_nPackets;   // MyApp 어플리케이션이 보내는 패킷의 수  
  DataRate        m_dataRate;   // MyApp 어플리케이션이 보내는 패킷의 속도
  EventId         m_sendEvent;
  bool            m_running;    // MyApp 어플리케이션이 실행중인지 여부  
  uint32_t        m_packetsSent;// MyApp 어플리케이션이 이미 보낸 패킷의 수  
};

// MyApp 어플리케이션의 생성자로 property를 default값으로 설정한다.  
MyApp::MyApp ()
  : m_socket (0),
    m_peer (),
    m_packetSize (0),
    m_nPackets (0),
    m_dataRate (0),
    m_sendEvent (),
    m_running (false),
    m_packetsSent (0)
{
}

// MyApp 어플리케이션의 소멸자
MyApp::~MyApp()
{
  m_socket = 0;
}

// MyApp 어플리케이션의 property 값들을 설정한다.
void
MyApp::Setup (Ptr<Socket> socket, Address address, uint32_t packetSize, uint32_t nPackets, DataRate dataRate)
{
  m_socket = socket;
  m_peer = address;
  m_packetSize = packetSize;
  m_nPackets = nPackets;
  m_dataRate = dataRate;
}

// MyApp 어플리케이션이 실행될 때, 어플리케이션의 상태를 실행중으로 변경하고
// MyApp 어플리케이션 소켓과 다른 어플리케이션간 connection을 맺는다.
// SendPacket 함수를 호출한다.
void
MyApp::StartApplication (void)
{
  m_running = true;
  m_packetsSent = 0;
  m_socket->Bind ();
  m_socket->Connect (m_peer);
  SendPacket ();
}

// MyApp 어플리케이션이 종료될 때, 어플리케이션의 상태를 종료됨으로 변경하고
// MyApp 어플리케이션이 패킷을 전송하는 중이었으면, 패킷 전송을 취소한다.
// MyApp 어플리케이션과 다른 어플리케이션간의 connection을 종료한다.
void
MyApp::StopApplication (void)
{
  m_running = false;

  if (m_sendEvent.IsRunning ())
    {
      Simulator::Cancel (m_sendEvent);
    }

  if (m_socket)
    {
      m_socket->Close ();
    }
}

// 새로운 패킷을 생성한다.
// 생성된 패킷을 MyApp 어플리케이션의 소켓을 이용하여 다른 어플리케이션에 전달한다.
// 만약 미리 설정된 최대 패킷 수보다 보낸 패킷 수가 작다면 ScheduleTx를 호출한다.
void
MyApp::SendPacket (void)
{
  Ptr<Packet> packet = Create<Packet> (m_packetSize);
  m_socket->Send (packet);

  if (++m_packetsSent < m_nPackets)
    {
      ScheduleTx ();
    }
}

// 만약 MyApp 어플리케이션이 실행중이면
// DataRate를 바탕으로 다음 패킷 전송까지 interval을 계산하고
// interval이 지나고 다시 SendPacket을 호출한다.
void
MyApp::ScheduleTx (void)
{
  if (m_running)
    {
      Time tNext (Seconds (m_packetSize * 8 / static_cast<double> (m_dataRate.GetBitRate ())));
      m_sendEvent = Simulator::Schedule (tNext, &MyApp::SendPacket, this);  // Simulator::Schedule은 일정시간 후 함수를 호출하기 위해 사용하는 명령어이다. 3개의 파라미터를 받는다. 1번째는 몇초뒤에 함수를 호출할 것인지 time interval을 나타내고, 2번째는 CallBack 함수이며, 마지막은 어떤 클래스가 CallBack 함수를 호출하는 것인지를 나타낸다.
    }
}

결과

이번 포스트는 네트워크 시뮬레이션을 작성한 것이 아니라 네트워크 시뮬레이션에서 사용할 어플리케이션을 만들어 보았습니다. 어플리케이션 만 가지고서는 시뮬레이션을 실행시킬 수 없기 때문에 시뮬레이션 결과는 없습니다. 다음 포스트에서 이번에 만든 어플리케이션을 이용한 시나리오를 소개하도록 하겠습니다.