VII. A new protocol for ns

VII. 新しいプロトコルの追加

[Previous section] [Back to the index] [Next section]

In this section I will give you an example for a new protocol that could be implemented in ns. You should probably become fairly familiar with ns before you try this yourself, and some C++ knowledge is definitely necessary. You should also read at least the chapters 3.1-3.3 from "ns Notes and Documentation" (now renamed ns Manual) to understand the interaction between Tcl and C++.

この節では, ns上に新たなプロトコルを実装する際の例について説明していきます. この節の内容を自分で試す前に, たぶん十分nsに慣れ親しんでる 必要があると思いますし, ちょっとしたC++の知識は間違いなく必要です. あとはtclとC++間のやりとりを理解するためにns Manualの3.1-3.3節を 読んどいてください.

The code in this section implements some sort of simple 'ping' protocol (inspired by the 'ping requestor' in chapter 9.6 of the "ns Notes and Documentation" (now renamed ns Manual), but fairly different). One node will be able to send a packet to another node which will return it immediately, so that the round-trip-time can be calculated.

この節のコードはある種の単純な`ping'プロトコルを実装するものです (ns Manualの9.6章にある`ping requestor'に触発されたもんです). 1つのノードはパケットを他のノードに送信することができて, 受信側の ノードはすぐに返事をするというものです. つまり往復時間(RTT)が計算できるわけです.

I understand that the code presented here might not be the best possible implementation, and I am sure it can be improved, though I hope it is easy to understand, which is the main priority here. However, suggestions can be sent here.

私はこの節のコードが最善の実装じゃないだろうってことは理解してますし, 改善されうるもんだということを認識してます. でも, ここでの一番重要なことは, 簡単に理解できるってことだと思ってます. とは言っても, 良いコメントがあったらここへ送ってください.

You can download the full header file here (I suggest you do that and take a quick look at it, since the code that was presented here isn't totally complete).

完全なヘッダファイルをここからダウンロードできます. (ここで示しているコードは完全なものじゃないので, ちらっとみるだけに しておいた方が良いと思います).

VII.2. The C++ code
First the linkage between the C++ code and Tcl code has to be defined. It is not necessary that you fully understand this code, but it would help you to read the chapters 3.1-3.3 in the "ns Manual" if you haven't done that yet to understand it.

C++のコードとtclのコード間の結合を最初に定義しなくちゃいけません. このコードを完全に理解する必要はないけど, もしまだ理解してないのだったら, ns Manualの3.1-3.3章を読むと助けになると思います.

static class PingHeaderClass : public PacketHeaderClass { public: PingHeaderClass() : PacketHeaderClass("PacketHeader/Ping", sizeof(hdr_ping)) {} } class_pinghdr; static class PingClass : public TclClass { public: PingClass() : TclClass("Agent/Ping") {} TclObject* create(int, const char*const*) { return (new PingAgent()); } } class_ping;

The next piece of code is the constructor for the class 'PingAgent'. It binds the variables which have to be accessed both in Tcl and C++.

次のコードはclass `PingAgent'のコンストラクタです. TclとC++の両方でアクセスされる変数を関係づける(bind?)ものです.

PingAgent::PingAgent() : Agent(PT_PING) { bind("packetSize_", &size_); bind("off_ping_", &off_ping_); }

The function 'command()' is called when a Tcl command for the class 'PingAgent' is executed. In our case that would be '$pa send' (assuming 'pa' is an instance of the Agent/Ping class), because we want to send ping packets from the Agent to another ping agent. You basically have to parse the command in the 'command()' function, and if no match is found, you have to pass the command with its arguments to the 'command()' function of the base class (in this case 'Agent::command()'). The code might look very long because it's commented heavily.

関数`command()'はclass `PingAgent()'のためのtclコードが実行される 時に呼び出されます. 今回の場合, エージェントから他のエージェントへ pingパケットを送信したいので, 呼び出しは'$pa send' (`pa'がAgent/Ping classのインスタンスだと仮定してます)の際に なるでしょう. 基本的には, command()関数内の命令(command)をパースしなければいけなくて, もしマッチするものがなければ, その命令は引数ごと, 基本クラスの`command()'関数(この場合`Agent::command()')にわたされなければ なりません. 大量のコメントがあるせいでコードはとっても長く見えるかもしれません.

int PingAgent::command(int argc, const char*const* argv) { if (argc == 2) { if (strcmp(argv[1], "send") == 0) { // Create a new packet Packet* pkt = allocpkt(); // Access the Ping header for the new packet: hdr_ping* hdr = (hdr_ping*)pkt->access(off_ping_); // Set the 'ret' field to 0, so the receiving node knows // that it has to generate an echo packet hdr->ret = 0; // Store the current time in the 'send_time' field hdr->send_time = Scheduler::instance().clock(); // Send the packet send(pkt, 0); // return TCL_OK, so the calling function knows that the // command has been processed return (TCL_OK); } } // If the command hasn't been processed by PingAgent()::command, // call the command() function for the base class return (Agent::command(argc, argv)); }

The function 'recv()' defines the actions to be taken when a packet is received. If the 'ret' field is 0, a packet with the same value for the 'send_time' field, but with the 'ret' field set to 1 has to be returned. If 'ret' is 1, a Tcl function (which has to be defined by the user in Tcl) is called and processed the event (Important note to users of the ns version 2.1b2: 'Address::instance().NodeShift_[1]' has to be replaced with 'NODESHIFT' to get the example to work under ns 2.1b2).

関数`recv()'はパケットが受信された際に取られる動作を定義します. もし`ret'フィールドが0だったら, 受信したパケットの `send_time'フィールドの値を新たなパケットの`send_time'フィールドにセットし, `ret'フィールドを1にしたものが送信者に送り返されます. もし`ret'が1の場合(これは送信者がecho replyを受け取った場合), Tclの関数 (これはユーザによってtclで定義されなければならない)が呼び出されて (対応する?)イベントが処理されます. (ns 2.1b2のユーザへの重要なお知らせ: ns 2.1b2でこの例題を正しく動作させるには 'Address::instance().NodeShift_[1]'を `NODESHIFT'に置き換えなくてはいけません.)

void PingAgent::recv(Packet* pkt, Handler*) { // Access the IP header for the received packet: hdr_ip* hdrip = (hdr_ip*)pkt->access(off_ip_); // Access the Ping header for the received packet: hdr_ping* hdr = (hdr_ping*)pkt->access(off_ping_); // Is the 'ret' field = 0 (i.e. the receiving node is being pinged)? if (hdr->ret == 0) { // Send an 'echo'. First save the old packet's send_time double stime = hdr->send_time; // Discard the packet Packet::free(pkt); // Create a new packet Packet* pktret = allocpkt(); // Access the Ping header for the new packet: hdr_ping* hdrret = (hdr_ping*)pktret->access(off_ping_); // Set the 'ret' field to 1, so the receiver won't send another echo hdrret->ret = 1; // Set the send_time field to the correct value hdrret->send_time = stime; // Send the packet send(pktret, 0); } else { // A packet was received. Use tcl.eval to call the Tcl // interpreter with the ping results. // Note: In the Tcl code, a procedure 'Agent/Ping recv {from rtt}' // has to be defined which allows the user to react to the ping // result. char out[100]; // Prepare the output to the Tcl interpreter. Calculate the round // trip time sprintf(out, "%s recv %d %3.1f", name(), hdrip->src_.addr_ >> Address::instance().NodeShift_[1], (Scheduler::instance().clock()-hdr->send_time) * 1000); Tcl& tcl = Tcl::instance(); tcl.eval(out); // Discard the packet Packet::free(pkt); } }

You can download the full file here. The most interesting part should be the 'tcl.eval()' function where a Tcl function 'recv' is called, with the id of the pinged node and the round-trip-time (in miliseconds) as parameters. It will be shown in Section VII.4 how the code for this function has to be written. But first of all, some other files have to be edited before ns can be recompiled.

ここからファイルをダウンロードできます. もっとも面白い部分は, Tclの関数`recv'で呼び出され, pingノードのidとRTT(ms表記)をパラメータとする `tcl.eval()'関数 でしょう. この関数のコードがどう書かれるかについてはVII.4節で示すとして, まずnsを再コンパイルする前に他のいくつかのファイルを編集しなくちゃいけません.

You should be able to recompile ns now simply by typing 'make' in the ns directory. If you are having any problems, please email ns-users.

さあ, nsディレクトリで単純にmakeとたたけば再コンパイル可能なはずです. もし何か問題があったらns-usersにメールしてください.

VII.4. The Tcl code
I'm not going to present the full code for a Tcl example for the Ping agent now. You can download a full example here. But I will show you how to write the 'recv' procedure that is called from the 'recv()' function in the C++ code when a ping 'echo' packet is received.

今のところ, Pingエージェントのtclのコードの全てを説明するつもりはありません. 完全なファイルはここからダウンロードしてください. だけど, ping 'echo'パケットが受け取られた時の, C++のrecv()関数から呼ばれる tclのecv手続きをどのように書くかのみを説明します.

Agent/Ping instproc recv {from rtt} { $self instvar node_ puts "node [$node_ id] received ping answer from \ $from with round-trip-time $rtt ms." }

This code should be fairly easy to understand. The only new thing is that it accesses the member variable 'node_' of the base class 'Agent' to get the node id for the node the agent is attached to.

このコードはほんとに簡単に理解できるでしょう. 単に新しいことは, エージェントが接続されている ノードのnode idを得るには, 基本クラス'Agent'のメンバ変数'node_'を アクセスすれば良いということだけです.

Now you can try some experiments of your own. A very simple experiment would be to not set the 'ret' field in the packets to 1. You can probably guess what is going to happen. You can also try to add some code that allows the user to send ping packets with '$pa send $node' (where 'pa' is a ping agent and 'node' a node) without having to connect the agent 'pa' with the ping agent on 'node' first, though that might be a little bit more complicated than it sounds at first. You can also read the chapter 9.6 from the "ns Manual" to learn more about creating your own agents. Good luck.

これで自分自身でいろいろ実験できるでしょ. とても簡単な実験は, パケットの'ret'フィールドを1にセットすることじゃ ないですよ. この場合何が起きるか予想できるでしょ? あとは, pingエージェントをノードにつなげないで ユーザがpingパケットをノードに(直接) '$pa send $node'でpingパケットを 送れるようにするってのもできるよね. だけど, 最初にやるにしてはちょっと複雑すぎるかもしれない. 自分でエージェントを作ることに関しては, ns Manualの9.6章を読むのが 良いのでは.

[Previous section] [Back to the index] [Next section]

日本語に関しての文句などは,