1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
|
.. include:: replace.txt
..
========================================================================================
Translated for portuguese by the students of the inter-institutional doctorate program of IME-USP/UTFPR-CM.
Traduzido para o portugus pelos alunos do programa de doutorado inter institucional do Instituto de Matemtica e Estatstica da Universidade de So Paulo --- IME-USP em parceria com a Universidade Tecnolgica Federal do Paran - Campus Campo Mouro --- UTFPR-CM:
* Frank Helbert (frank@ime.usp.br);
* Luiz Arthur Feitosa dos Santos (luizsan@ime.usp.br);
* Rodrigo Campiolo (campiolo@ime.usp.br).
========================================================================================
.. Conceptual Overview
Viso Conceitual
----------------
..
The first thing we need to do before actually starting to look at or write
|ns3| code is to explain a few core concepts and abstractions in the
system. Much of this may appear transparently obvious to some, but we
recommend taking the time to read through this section just to ensure you
are starting on a firm foundation.
Antes de escrever cdigos no |ns3| extremamente importante entender um pouco dos conceitos e abstraes do sistema. Muitos conceitos podero parecer bvios, mas a recomendao geral que esta seo seja lida por completo para assegurar que o leitor inicie com uma base slida.
.. Key Abstractions
Principais Abstraes
*********************
..
In this section, we'll review some terms that are commonly used in
networking, but have a specific meaning in |ns3|.
Nesta seo, so revistos alguns termos que so comumente usados por profissionais de redes de computadores, mas que tem um significado especfico no |ns3|.
N (`Node`)
+++++++++++
..
In Internet jargon, a computing device that connects to a network is called
a *host* or sometimes an *end system*. Because |ns3| is a
*network* simulator, not specifically an *Internet* simulator, we
intentionally do not use the term host since it is closely associated with
the Internet and its protocols. Instead, we use a more generic term also
used by other simulators that originates in Graph Theory --- the *node*.
No jargo da Internet, um dispositivo computacional que conecta-se a uma rede chamado de *host* ou em alguns casos de *terminal*. Devido ao fato do |ns3| ser um simulador de *rede*, e no um simulador da *Internet*, o termo `host` intencionalmente no utilizado, pois est intimamente associado com a Internet e seus protocolos. Ao invs disso, utilizado o termo *node* --- em portugus, *n* --- que um termo mais genrico e tambm usado por outros simuladores que tem suas origens na Teoria dos Grafos.
..
In |ns3| the basic computing device abstraction is called the
node. This abstraction is represented in C++ by the class ``Node``. The
``Node`` class provides methods for managing the representations of
computing devices in simulations.
A abstrao de um dispositivo computacional bsico chamado ento de n. Essa abstrao representada em C++ pela classe ``Node``. Esta classe fornece mtodos para gerenciar as representaes de dispositivos computacionais nas simulaes.
..
You should think of a ``Node`` as a computer to which you will add
functionality. One adds things like applications, protocol stacks and
peripheral cards with their associated drivers to enable the computer to do
useful work. We use the same basic model in |ns3|.
O n deve ser pensado como um computador no qual se adicionam funcionalidades, tal como aplicativos, pilhas de protocolos e perifricos com seus `drivers` associados que permitem ao computador executar tarefas teis. No |ns3| utilizado este mesmo conceito bsico.
.. Application
Aplicaes (`Application`)
++++++++++++++++++++++++++
..
Typically, computer software is divided into two broad classes. *System
Software* organizes various computer resources such as memory, processor
cycles, disk, network, etc., according to some computing model. System
software usually does not use those resources to complete tasks that directly
benefit a user. A user would typically run an *application* that acquires
and uses the resources controlled by the system software to accomplish some
goal.
Normalmente, programas de computador so divididos em duas classes. *Programas de sistema* organizam recursos do computador, tais como: memria, processador, disco, rede, etc., de acordo com algum modelo computacional. Tais programas normalmente no so utilizados diretamente pelos usurios. Na maioria das vezes, os usurios fazem uso de *aplicaes*, que usam os recursos controlados pelos programas de sistema para atingir seus objetivos.
..
Often, the line of separation between system and application software is made
at the privilege level change that happens in operating system traps.
In |ns3| there is no real concept of operating system and especially
no concept of privilege levels or system calls. We do, however, have the
idea of an application. Just as software applications run on computers to
perform tasks in the "real world," |ns3| applications run on
|ns3| ``Nodes`` to drive simulations in the simulated world.
Geralmente, a separao entre programas de sistema e aplicaes de usurios feita pela mudana no nvel de privilgios que acontece na troca de contexto feita pelo sistema operacional. No |ns3|, no existe um conceito de sistema operacional real, no h o conceito de nveis de privilgios nem chamadas de sistema. H apenas aplicaes que so executadas nos ns para uma determinada simulao.
..
In |ns3| the basic abstraction for a user program that generates some
activity to be simulated is the application. This abstraction is represented
in C++ by the class ``Application``. The ``Application`` class provides
methods for managing the representations of our version of user-level
applications in simulations. Developers are expected to specialize the
``Application`` class in the object-oriented programming sense to create new
applications. In this tutorial, we will use specializations of class
``Application`` called ``UdpEchoClientApplication`` and
``UdpEchoServerApplication``. As you might expect, these applications
compose a client/server application set used to generate and echo simulated
network packets
No |ns3|, a abstrao bsica para um programa de usurio que gera alguma atividade a ser simulada a aplicao. Esta abstrao representada em C++ pela classe ``Application``, que fornece mtodos para gerenciar a representao de suas verses de aplicaes a serem simuladas. Os desenvolvedores devem especializar a classe ``Application`` para criar novas aplicaes. Neste tutorial sero utilizadas duas especializaes da classe ``Application``, chamadas ``UdpEchoClientApplication`` e ``UdpEchoServerApplication``. Estas aplicaes compem um modelo cliente/servidor usado para gerar pacotes simulados de eco na rede.
.. Channel
Canal de Comunicao (`Channel`)
++++++++++++++++++++++++++++++++
..
In the real world, one can connect a computer to a network. Often the media
over which data flows in these networks are called *channels*. When
you connect your Ethernet cable to the plug in the wall, you are connecting
your computer to an Ethernet communication channel. In the simulated world
of |ns3|, one connects a ``Node`` to an object representing a
communication channel. Here the basic communication subnetwork abstraction
is called the channel and is represented in C++ by the class ``Channel``.
No mundo real, computadores esto conectados em uma rede. Normalmente, o meio sobre o qual os dados trafegam chamada de canal (*channel*). Quando um cabo Ethernet ligado ao conector na parede, na verdade est se conectando a um canal de comunicao Ethernet. No mundo simulado do |ns3|, um n conectado a um objeto que representa um canal de comunicao. A abstrao de canal de comunicao representada em C++ pela classe ``Channel``.
..
The ``Channel`` class provides methods for managing communication
subnetwork objects and connecting nodes to them. ``Channels`` may also be
specialized by developers in the object oriented programming sense. A
``Channel`` specialization may model something as simple as a wire. The
specialized ``Channel`` can also model things as complicated as a large
Ethernet switch, or three-dimensional space full of obstructions in the case
of wireless networks.
A classe ``Channel`` fornece mtodos para gerenciar objetos de comunicao de sub-redes e ns conectados a eles. Os ``Channels`` tambm podem ser especializados por desenvolvedores (no sentido de programao orientada a objetos). Uma especializao de ``Channel`` pode ser algo como um simples fio. Pode tambm ser algo mais complexo, como um comutador Ethernet ou ainda ser uma rede sem fio (`wireless`) em um espao tridimensional com obstculos.
..
We will use specialized versions of the ``Channel`` called
``CsmaChannel``, ``PointToPointChannel`` and ``WifiChannel`` in this
tutorial. The ``CsmaChannel``, for example, models a version of a
communication subnetwork that implements a *carrier sense multiple
access* communication medium. This gives us Ethernet-like functionality.
Neste tutorial, so utilizadas verses especializadas de ``Channel`` chamadas ``CsmaChannel``, ``PointToPointChannel`` e ``WifiChannel``. O ``CsmaChannel``, por exemplo, uma verso do modelo de rede que implementa controle de acesso ao meio CSMA (*Carrier Sense Multiple Access*). Ele fornece uma funcionalidade similar a uma rede Ethernet.
.. Net Device
Dispositivos de Rede (`Net Device`)
+++++++++++++++++++++++++++++++++++
..
It used to be the case that if you wanted to connect a computers to a network,
you had to buy a specific kind of network cable and a hardware device called
(in PC terminology) a *peripheral card* that needed to be installed in
your computer. If the peripheral card implemented some networking function,
they were called Network Interface Cards, or *NICs*. Today most
computers come with the network interface hardware built in and users don't
see these building blocks.
No passado, para conectar computadores em uma rede, era necessrio comprar o cabo especfico e um dispositivo chamado (na terminologia dos PCs) de *perifrico*, que precisava ser instalado no computador. Se a placa implementava funes de rede, era chamada de interface de rede (`Network Interface Card` - NIC). Atualmente, a maioria dos computadores vm com a placa de rede integrada placa me (`on-board`) e os usurios no vem o computador como uma juno de partes.
..
A NIC will not work without a software driver to control the hardware. In
Unix (or Linux), a piece of peripheral hardware is classified as a
*device*. Devices are controlled using *device drivers*, and network
devices (NICs) are controlled using *network device drivers*
collectively known as *net devices*. In Unix and Linux you refer
to these net devices by names such as *eth0*.
Uma placa de rede no funciona sem o `driver` que a controle. No Unix (ou Linux), um perifrico (como a placa de rede) classificado como um dispositivo (*device*). Dispositivos so controlados usando drivers de dispositivo (*device drivers*) e as placas de rede so controladas atravs de drivers de dispositivo de rede (*network device drivers*), tambm chamadas de dispositivos de rede (*net devices*). No Unix e Linux estes dispositivos de rede levam nomes como *eth0*.
..
In |ns3| the *net device* abstraction covers both the software
driver and the simulated hardware. A net device is "installed" in a
``Node`` in order to enable the ``Node`` to communicate with other
``Nodes`` in the simulation via ``Channels``. Just as in a real
computer, a ``Node`` may be connected to more than one ``Channel`` via
multiple ``NetDevices``.
No |ns3| a abstrao do *dispositivo de rede* cobre tanto o hardware quanto o software (`drive`). Um dispositivo de rede "instalado" em um n para permitir que este se comunique com outros na simulao, usando os canais de comunicao (`channels`). Assim como em um computador real, um n pode ser conectado a mais que um canal via mltiplos dispositivos de rede.
..
The net device abstraction is represented in C++ by the class ``NetDevice``.
The ``NetDevice`` class provides methods for managing connections to
``Node`` and ``Channel`` objects; and may be specialized by developers
in the object-oriented programming sense. We will use the several specialized
versions of the ``NetDevice`` called ``CsmaNetDevice``,
``PointToPointNetDevice``, and ``WifiNetDevice`` in this tutorial.
Just as an Ethernet NIC is designed to work with an Ethernet network, the
``CsmaNetDevice`` is designed to work with a ``CsmaChannel``; the
``PointToPointNetDevice`` is designed to work with a
``PointToPointChannel`` and a ``WifiNetNevice`` is designed to work with
a ``WifiChannel``.
A abstrao do dispositivo de rede representado em C++ pela classe ``NetDevice``, que fornece mtodos para gerenciar conexes para objetos ``Node`` e ``Channel``. Os dispositivos, assim como os canais e as aplicaes, tambm podem ser especializados. Vrias verses do ``NetDevice`` so utilizadas neste tutorial, tais como: ``CsmaNetDevice``, ``PointToPointNetDevice`` e ``WifiNetDevice``. Assim como uma placa de rede Ethernet projetada para trabalhar em uma rede Ethernet, um ``CsmaNetDevice`` projetado para trabalhar com um ``CsmaChannel``. O ``PointToPointNetDevice`` deve trabalhar com um ``PointToPointChannel`` e o ``WifiNetNevice`` com um ``WifiChannel``.
.. Topology Helpers
Assistentes de Topologia (`Topology Helpers`)
+++++++++++++++++++++++++++++++++++++++++++++
..
In a real network, you will find host computers with added (or built-in)
NICs. In |ns3| we would say that you will find ``Nodes`` with
attached ``NetDevices``. In a large simulated network you will need to
arrange many connections between ``Nodes``, ``NetDevices`` and
``Channels``.
Em redes reais, os computadores possuem placas de rede, sejam elas integradas ou no. No |ns3|, teremos ns com dispositivos de rede. Em grandes simulaes, ser necessrio arranjar muitas conexes entre ns, dispositivos e canais de comunicao.
..
Since connecting ``NetDevices`` to ``Nodes``, ``NetDevices``
to ``Channels``, assigning IP addresses, etc., are such common tasks
in |ns3|, we provide what we call *topology helpers* to make
this as easy as possible. For example, it may take many distinct
|ns3| core operations to create a NetDevice, add a MAC address,
install that net device on a ``Node``, configure the node's protocol stack,
and then connect the ``NetDevice`` to a ``Channel``. Even more
operations would be required to connect multiple devices onto multipoint
channels and then to connect individual networks together into internetworks.
We provide topology helper objects that combine those many distinct operations
into an easy to use model for your convenience.
Visto que conectar dispositivos a ns e a canais, atribuir endereos IP, etc., so todas tarefas rotineiras no |ns3|, so fornecidos os Assistentes de Topologia (*topology helpers*). Por exemplo, podem ser necessrias muitas operaes distintas para criar um dispositivo, atribuir um endereo MAC a ele, instalar o dispositivo em um n, configurar a pilha de protocolos no n em questo e por fim, conectar o dispositivo ao canal. Ainda mais operaes podem ser necessrias para conectar mltiplos dispositivos em canais multiponto e ento fazer a interconexo das vrias redes. Para facilitar o trabalho, so disponibilizados objetos que so Assistentes de Topologia, que combinam estas operaes distintas em um modelo fcil e conveniente.
.. A First ns-3 Script
O primeiro cdigo no ns-3
*************************
..
If you downloaded the system as was suggested above, you will have a release
of |ns3| in a directory called ``repos`` under your home
directory. Change into that release directory, and you should find a
directory structure something like the following:
Se o sistema foi baixado como sugerido, uma verso do |ns3| estar em um diretrio chamado ``repos`` dentro do diretrio `home`. Entrando no diretrio dessa verso, dever haver uma estrutura parecida com a seguinte:
::
AUTHORS examples scratch utils waf.bat*
bindings LICENSE src utils.py waf-tools
build ns3 test.py* utils.pyc wscript
CHANGES.html README testpy-output VERSION wutils.py
doc RELEASE_NOTES testpy.supp waf* wutils.pyc
..
Change into the ``examples/tutorial`` directory. You should see a file named
``first.cc`` located there. This is a script that will create a simple
point-to-point link between two nodes and echo a single packet between the
nodes. Let's take a look at that script line by line, so go ahead and open
``first.cc`` in your favorite editor.
Entrando no diretrio ``examples/tutorial``, vai haver um arquivo chamado ``first.cc``. Este um cdigo que criar uma conexo ponto-a-ponto entre dois ns e enviar um pacote de eco entre eles. O arquivo ser analisado linha a linha, para isto, o leitor pode abri-lo em seu editor de textos favorito.
..
Boilerplate
Padronizao
++++++++++++
..
The first line in the file is an emacs mode line. This tells emacs about the
formatting conventions (coding style) we use in our source code.
A primeira linha do arquivo uma linha de modo emacs, que informa sobre a conveno de formatao (estilo de codificao) que ser usada no cdigo fonte.
::
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
..
This is always a somewhat controversial subject, so we might as well get it
out of the way immediately. The |ns3| project, like most large
projects, has adopted a coding style to which all contributed code must
adhere. If you want to contribute your code to the project, you will
eventually have to conform to the |ns3| coding standard as described
in the file ``doc/codingstd.txt`` or shown on the project web page
`here
<http://www.nsnam.org/developers/contributing-code/coding-style/>`_.
Este sempre um assunto um tanto quanto controverso. O projeto |ns3|, tal como a maioria dos projetos de grande porte, adotou um estilo de codificao, para o qual todo o cdigo deve conformar. Se o leitor quiser contribuir com o projeto, dever estar em conformidade com a codificao que est descrita no arquivo ``doc/codingstd.txt`` ou no `stio <http://www.nsnam.org/developers/contributing-code/coding-style/>`_.
..
We recommend that you, well, just get used to the look and feel of |ns3|
code and adopt this standard whenever you are working with our code. All of
the development team and contributors have done so with various amounts of
grumbling. The emacs mode line above makes it easier to get the formatting
correct if you use the emacs editor.
A equipe do |ns3| recomenda aos novos usurios que adotem o padro quando estiverem tralhando com o cdigo. Tanto eles, quanto todos os que contribuem, tiveram que fazer isto em algum momento. Para aqueles que utilizam o editor Emacs, a linha de modo torna mais facil seguir o padro corretamente.
..
The |ns3| simulator is licensed using the GNU General Public
License. You will see the appropriate GNU legalese at the head of every file
in the |ns3| distribution. Often you will see a copyright notice for
one of the institutions involved in the |ns3| project above the GPL
text and an author listed below.
O |ns3| licenciado usando a `GNU General Public License` - GPL. No cabealho de todo aquivo da distribuio h as questes legais associadas licena. Frequentemente, haver tambm informaes sobre os direitos de cpia de uma das instituies envolvidas no projeto e o autor do arquivo.
::
/*
* 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
*/
.. Module Includes
Incluso de Mdulos
+++++++++++++++++++
..
The code proper starts with a number of include statements.
O cdigo realmente comea pelo carregamento de mdulos atravs da incluso dos arquivos:
::
#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"
..
To help our high-level script users deal with the large number of include
files present in the system, we group includes according to relatively large
modules. We provide a single include file that will recursively load all of
the include files used in each module. Rather than having to look up exactly
what header you need, and possibly have to get a number of dependencies right,
we give you the ability to load a group of files at a large granularity. This
is not the most efficient approach but it certainly makes writing scripts much
easier.
Os arquivos a serem includos so agrupados em mdulos relativamente grandes, de forma a ajudar os usurios. Tambm possvel fazer referncia a um nico arquivo que ir recursivamente carregar todas as bibliotecas de cada mdulo. Ao invs de procurar pelo arquivo exato, e provavelmente, ter que resolver dependncias, possvel carregar um grupo de arquivos de uma vez. Esta com certeza no a abordagem mais eficiente, mas permite escrever cdigos de forma bem mais fcil.
..
Each of the |ns3| include files is placed in a directory called
``ns3`` (under the build directory) during the build process to help avoid
include file name collisions. The ``ns3/core-module.h`` file corresponds
to the ns-3 module you will find in the directory ``src/core`` in your
downloaded release distribution. If you list this directory you will find a
large number of header files. When you do a build, Waf will place public
header files in an ``ns3`` directory under the appropriate
``build/debug`` or ``build/optimized`` directory depending on your
configuration. Waf will also automatically generate a module include file to
load all of the public header files.
Durante a construo, cada um dos arquivos includos copiado para o diretrio chamado ``ns3`` (dentro do diretrio ``build``), o que ajuda a evitar conflito entre os nomes dos arquivos de bibliotecas. O arquivo ``ns3/core-module.h``, por exemplo, corresponde ao mdulo que est no diretrio ``src/core``. H um grande nmero de arquivos neste diretrio. No momento em que o Waf est construindo o projeto, copia os arquivos para o diretrio ``ns3``, no subdiretrio apropriado --- ``build/debug`` ou ``build/optimized`` --- dependendo da configurao utilizada.
..
Since you are, of course, following this tutorial religiously, you will
already have done a
Considerando que o leitor esteja seguindo este tutorial, j ter feito:
::
./waf -d debug --enable-examples --enable-tests configure
..
in order to configure the project to perform debug builds that include
examples and tests. You will also have done a
Tambm j ter feito
::
./waf
..
to build the project. So now if you look in the directory
``../../build/debug/ns3`` you will find the four module include files shown
above. You can take a look at the contents of these files and find that they
do include all of the public include files in their respective modules.
para construir o projeto. Ento, no diretrio ``../../build/debug/ns3`` dever haver os quatro mdulos includos anteriormente. Olhando para o contedo destes arquivos, possvel observar que eles incluem todos os arquivos pblicos dos seus respectivos mdulos.
Ns3 `Namespace`
+++++++++++++++
..
The next line in the ``first.cc`` script is a namespace declaration.
A prxima linha no cdigo ``first.cc`` a declarao do `namespace`.
::
using namespace ns3;
..
The |ns3| project is implemented in a C++ namespace called
``ns3``. This groups all |ns3|-related declarations in a scope
outside the global namespace, which we hope will help with integration with
other code. The C++ ``using`` statement introduces the |ns3|
namespace into the current (global) declarative region. This is a fancy way
of saying that after this declaration, you will not have to type ``ns3::``
scope resolution operator before all of the |ns3| code in order to use
it. If you are unfamiliar with namespaces, please consult almost any C++
tutorial and compare the ``ns3`` namespace and usage here with instances of
the ``std`` namespace and the ``using namespace std;`` statements you
will often find in discussions of ``cout`` and streams.
O projeto |ns3| implementado em um `namespace` chamado `ns3`. Isto agrupa todas as declaraes relacionadas ao projeto em um escopo fora do global, que ajuda na integrao com outros cdigos. A declarao ``using`` do C++ insere o `namespace` |ns3| no escopo global, evitando que se tenha que ficar digitando ``ns3::`` antes dos cdigos |ns3|. Se o leitor no esta familiarizado com `namesapaces`, consulte algum tutorial de C++ e compare o `namespace` ``ns3`` e o `namespace` ``std``, usado com frequncia em C++, principalmente com ``cout`` e ``streams``.
.. Logging
Registro (`Logging`)
++++++++++++++++++++
..
The next line of the script is the following,
A prxima linha do cdigo o seguinte,
::
NS_LOG_COMPONENT_DEFINE ("FirstScriptExample");
..
We will use this statement as a convenient place to talk about our Doxygen
documentation system. If you look at the project web site,
`ns-3 project
<http://www.nsnam.org>`_, you will find a link to "Documentation" in the navigation bar. If you select this link, you will be
taken to our documentation page. There
is a link to "Latest Release" that will take you to the documentation
for the latest stable release of |ns3|.
If you select the "API Documentation" link, you will be
taken to the |ns3| API documentation page.
Ns iremos utilizar esta declarao em um lugar conveniente para conversar com o sistema de documentao Doxygen. Se voc procurar no `web site` do `projeto ns-3 <http://www.nsnam.org>`_, voc encontrar um `link` para a documentao (`Documentation`) na barra de navegao. Se selecionarmos este `link`, veremos a pgina de documentao. L tem um `link` para as ltimas `releases` (`Latest Release`) que iro apresentar a documentao da ltima `release` do |ns3|. Se voc tambm pode selecionar o `link` para a documentao das APIs (`API Documentation`).
..
Along the left side, you will find a graphical representation of the structure
of the documentation. A good place to start is the ``NS-3 Modules``
"book" in the |ns3| navigation tree. If you expand ``Modules``
you will see a list of |ns3| module documentation. The concept of
module here ties directly into the module include files discussed above. The |ns3| logging subsystem is discussed in the ``C++ Constructs Used by All Modules``
section, so go ahead and expand that documentation node. Now, expand the
``Debugging`` book and then select the ``Logging`` page.
Do lado esquerdo, voc achar uma representao grfica da estrutura da documentao. Um bom lugar para comear com o livro de mdulos do NS-3 (``NS-3 Modules``) na rvore de navegao, voc pode expandir para ver a lista de documentao de mdulos do |ns3|. O conceito de mdulo aqui est diretamente ligado com a incluso de bibliotecas apresentadas anteriormente. O sistema de registro (`logging`) discutido na seo ``C++ Constructs Used by All Modules``, v em frente e expanda a documentao. Agora expanda o livro da depurao (``Debugging``) e selecione a pgina de ``Logging``.
..
You should now be looking at the Doxygen documentation for the Logging module.
In the list of ``#define``s at the top of the page you will see the entry
for ``NS_LOG_COMPONENT_DEFINE``. Before jumping in, it would probably be
good to look for the "Detailed Description" of the logging module to get a
feel for the overall operation. You can either scroll down or select the
"More..." link under the collaboration diagram to do this.
Agora voc deve procurar na documentao Doxygen pelo mdulo de ``Logging``. Na lista de ``#define`` bem no topo da pgina voc ver uma entrada para ``NS_LOG_COMPONENT_DEFINE``. Antes de ir para l, d uma boa olhada na descrio detalhada (`Detailed Description`) do mdulo de `logging`.
..
Once you have a general idea of what is going on, go ahead and take a look at
the specific ``NS_LOG_COMPONENT_DEFINE`` documentation. I won't duplicate
the documentation here, but to summarize, this line declares a logging
component called ``FirstScriptExample`` that allows you to enable and
disable console message logging by reference to the name.
Uma vez que voc tem uma ideia geral, prossiga e olhe a documentao de ``NS_LOG_COMPONENT_DEFINE``. No esperamos duplicar a documentao, mas para resumir esta linha declara o componente de `logging` chamado ``FirstScriptExample`` que permite habilitar e desabilitar mensagens de `logging` referenciando pelo nome.
.. Main Function
Funo Principal
++++++++++++++++
..
The next lines of the script you will find are,
As prximas linhas do cdigo so,
::
int
main (int argc, char *argv[])
{
..
This is just the declaration of the main function of your program (script).
Just as in any C++ program, you need to define a main function that will be
the first function run. There is nothing at all special here. Your
|ns3| script is just a C++ program.
Esta a declarao da funo principal (``main``) do programa. Assim como em qualquer programa em C++, voc precisa definir uma funo principal que a primeira funo que ser executada no programa. No h nada de especial e seu cdigo |ns3| apenas um programa C++.
..
The next two lines of the script are used to enable two logging components that
are built into the Echo Client and Echo Server applications:
As prximas duas linhas do cdigo so usadas para habilitar dois componentes de registro que so construdos com as aplicaes de `Echo Client` e `Echo Server`:
::
LogComponentEnable("UdpEchoClientApplication", LOG_LEVEL_INFO);
LogComponentEnable("UdpEchoServerApplication", LOG_LEVEL_INFO);
..
If you have read over the Logging component documentation you will have seen
that there are a number of levels of logging verbosity/detail that you can
enable on each component. These two lines of code enable debug logging at the
INFO level for echo clients and servers. This will result in the application
printing out messages as packets are sent and received during the simulation.
Se voc leu a documentao do componente de `logging` voc viu que existem vrios nveis de detalhamento de `logging` e que voc pode habilit-los para cada componente. Essas duas linhas de cdigo habilitam a depurao de `logging` com o nvel ``INFO`` para o cliente e servidor. Isto ira fazer com que as aplicaes mostrem as mensagens dos pacotes sendo enviados e recebidos durante a simulao.
..
Now we will get directly to the business of creating a topology and running
a simulation. We use the topology helper objects to make this job as
easy as possible.
Agora ns iremos direto ao ponto, criando uma topologia e executando uma simulao. Ns usaremos o Assistente de Topologia para fazer isto da forma mais simples possvel.
.. Topology Helpers
Assistentes de Topologia
++++++++++++++++++++++++
.. NodeContainer
Contineres de ns (`NodeContainer`)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
The next two lines of code in our script will actually create the
|ns3| ``Node`` objects that will represent the computers in the
simulation.
As prximas duas linhas de cdigo cria os objetos do tipo ``Node`` que representaro os computadores na simulao.
::
NodeContainer nodes;
nodes.Create (2);
..
Let's find the documentation for the ``NodeContainer`` class before we
continue. Another way to get into the documentation for a given class is via
the ``Classes`` tab in the Doxygen pages. If you still have the Doxygen
handy, just scroll up to the top of the page and select the ``Classes``
tab. You should see a new set of tabs appear, one of which is
``Class List``. Under that tab you will see a list of all of the
|ns3| classes. Scroll down, looking for ``ns3::NodeContainer``.
When you find the class, go ahead and select it to go to the documentation for
the class.
Antes de continuar vamos pesquisar a documentao da classe ``NodeContainer``. Outra forma de obter a documentao atravs aba ``Classes`` na pgina do Doxygen. No Doxygen, v at o topo da pgina e selecione ``Classes``. Ento, voc ver um novo conjunto de opes aparecendo, uma delas ser a sub-aba ``Class List``. Dentro desta opo voc ver uma lista com todas as classes do |ns3|. Agora procure por ``ns3::NodeContainer``. Quando voc achar a classe, selecione e veja a documentao da classe.
..
You may recall that one of our key abstractions is the ``Node``. This
represents a computer to which we are going to add things like protocol stacks,
applications and peripheral cards. The ``NodeContainer`` topology helper
provides a convenient way to create, manage and access any ``Node`` objects
that we create in order to run a simulation. The first line above just
declares a NodeContainer which we call ``nodes``. The second line calls the
``Create`` method on the ``nodes`` object and asks the container to
create two nodes. As described in the Doxygen, the container calls down into
the |ns3| system proper to create two ``Node`` objects and stores
pointers to those objects internally.
Lembre-se que uma de nossas abstraes o n. Este representa um computador, ao qual iremos adicionar coisas, como protocolos, aplicaes e perifricos. O assistente ``NodeContainer`` fornece uma forma conveniente de criar, gerenciar e acessar qualquer objeto ``Node`` que criamos para executar a simulao. A primeira linha declara um ``NodeContainer`` que chamamos de ``nodes``. A segunda linha chama o mtodo ``Create`` sobre o objeto ``nodes`` e pede para criar dois ns.
..
The nodes as they stand in the script do nothing. The next step in
constructing a topology is to connect our nodes together into a network.
The simplest form of network we support is a single point-to-point link
between two nodes. We'll construct one of those links here.
Os ns, como esto no cdigo, no fazem nada. O prximo passo montar uma topologia para conect-los em uma rede. Uma forma simples de conectar dois computadores em uma rede com um enlace ponto-a-ponto.
PointToPointHelper
~~~~~~~~~~~~~~~~~~
..
We are constructing a point to point link, and, in a pattern which will become
quite familiar to you, we use a topology helper object to do the low-level
work required to put the link together. Recall that two of our key
abstractions are the ``NetDevice`` and the ``Channel``. In the real
world, these terms correspond roughly to peripheral cards and network cables.
Typically these two things are intimately tied together and one cannot expect
to interchange, for example, Ethernet devices and wireless channels. Our
Topology Helpers follow this intimate coupling and therefore you will use a
single ``PointToPointHelper`` to configure and connect |ns3|
``PointToPointNetDevice`` and ``PointToPointChannel`` objects in this
script.
Construiremos um enlace ponto-a-ponto e para isto usaremos um assistente para configurar o nvel mais baixo da rede. Lembre-se que duas abstraes bsicas so ``NetDevice`` e ``Channel``. No mundo real, estes termos correspondem, a grosso modo, placa de rede e ao cabo. Normalmente, estes dois esto intimamente ligados e no normal ficar trocando. Por exemplo, no comum placas Ethernet conectadas em canais sem fio. O assistente de topologia acopla estes dois conceitos em um simples ``PointToPointHelper`` para configurar e conectar objetos ``PointToPointNetDevice`` e ``PointToPointChannel`` em nosso cdigo.
..
The next three lines in the script are,
As prximas trs linhas no cdigo so,
::
PointToPointHelper pointToPoint;
pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));
..
The first line,
A primeira linha,
::
PointToPointHelper pointToPoint;
..
instantiates a ``PointToPointHelper`` object on the stack. From a
high-level perspective the next line,
instancia o objeto ``PointToPointHelper`` na pilha. De forma mais superficial a prxima linha,
::
pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
..
tells the ``PointToPointHelper`` object to use the value "5Mbps"
(five megabits per second) as the "DataRate" when it creates a
``PointToPointNetDevice`` object.
diz ao objeto ``PointToPointHelper`` para usar o valor de "5Mbps" (cinco `megabits` por segundo) como "DataRate" (taxa de transferncia) quando criarmos um objeto ``PointToPointNetDevice``.
..
From a more detailed perspective, the string "DataRate" corresponds
to what we call an ``Attribute`` of the ``PointToPointNetDevice``.
If you look at the Doxygen for class ``ns3::PointToPointNetDevice`` and
find the documentation for the ``GetTypeId`` method, you will find a list
of ``Attributes`` defined for the device. Among these is the "DataRate"
``Attribute``. Most user-visible |ns3| objects have similar lists of
``Attributes``. We use this mechanism to easily configure simulations without
recompiling as you will see in a following section.
De uma perspectiva mais detalhada, a palavra "DataRate" corresponde ao que ns chamamos de atributo (``Attribute``) do ``PointToPointNetDevice``. Se voc olhar no Doxygen na classe ``ns3::PointToPointNetDevice`` e procurar a documentao para o mtodo ``GetTypeId``, voc achar uma lista de atributos definidos por dispositivos. Dentro desses est o atributo "DataRate". A maioria dos objetos do |ns3| tem uma lista similar de atributos. Ns usamos este mecanismo para facilitar a configurao das simulaes sem precisar recompilar, veremos isto na seo seguinte.
..
Similar to the "DataRate" on the ``PointToPointNetDevice`` you will find a
"Delay" ``Attribute`` associated with the ``PointToPointChannel``. The
final line,
Parecido com o "DataRate" no ``PointToPointNetDevice`` voc achar o atributo "Delay" (atraso) associado com o ``PointToPointChannel``. O final da linha,
::
pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));
..
tells the ``PointToPointHelper`` to use the value "2ms" (two milliseconds)
as the value of the transmission delay of every point to point channel it
subsequently creates.
diz ao ``PointToPointHelper`` para usar o valor de "2ms" (dois milissegundos) como valor de atraso de transmisso para o canal ponto-a-ponto criado.
NetDeviceContainer
~~~~~~~~~~~~~~~~~~
..
At this point in the script, we have a ``NodeContainer`` that contains
two nodes. We have a ``PointToPointHelper`` that is primed and ready to
make ``PointToPointNetDevices`` and wire ``PointToPointChannel`` objects
between them. Just as we used the ``NodeContainer`` topology helper object
to create the ``Nodes`` for our simulation, we will ask the
``PointToPointHelper`` to do the work involved in creating, configuring and
installing our devices for us. We will need to have a list of all of the
NetDevice objects that are created, so we use a NetDeviceContainer to hold
them just as we used a NodeContainer to hold the nodes we created. The
following two lines of code,
At agora no cdigo, temos um ``NodeContainer`` que contm dois ns. Tambm temos ``PointToPointHelper`` que carrega e prepara os objetos ``PointToPointNetDevices`` e ``PointToPointChannel``. Depois, usamos o assistente ``NodeContainer`` para criar os ns para a simulao. Iremos pedir ao ``PointToPointHelper`` para criar, configurar e instalar nossos dispositivos. Iremos necessitar de uma lista de todos os objetos `NetDevice` que so criados, ento ns usamos um `NetDeviceContainer` para agrupar os objetos criados, tal como usamos o `NodeContainer` para agrupar os ns que criamos. Nas duas linhas de cdigo seguintes,
::
NetDeviceContainer devices;
devices = pointToPoint.Install (nodes);
..
will finish configuring the devices and channel. The first line declares the
device container mentioned above and the second does the heavy lifting. The
``Install`` method of the ``PointToPointHelper`` takes a
``NodeContainer`` as a parameter. Internally, a ``NetDeviceContainer``
is created. For each node in the ``NodeContainer`` (there must be exactly
two for a point-to-point link) a ``PointToPointNetDevice`` is created and
saved in the device container. A ``PointToPointChannel`` is created and
the two ``PointToPointNetDevices`` are attached. When objects are created
by the ``PointToPointHelper``, the ``Attributes`` previously set in the
helper are used to initialize the corresponding ``Attributes`` in the
created objects.
vamos terminar configurando os dispositivos e o canal. A primeira linha declara o continer de dispositivos mencionado anteriormente e o segundo faz o trabalho pesado. O mtodo ``Install`` do ``PointToPointHelper`` utiliza um ``NodeContainer`` como parmetro. Internamente, um ``NetDeviceContainer`` criado. Para cada n no ``NodeContainer`` (devem existir dois para um enlace ponto-a-ponto) um ``PointToPointNetDevice`` criado e salvo no continer do dispositivo. Um ``PointToPointChannel`` criado e dois ``PointToPointNetDevices`` so conectados. Quando os objetos so criados pelo ``PointToPointHelper``, os atributos, passados anteriormente, so configurados pelo assistente (`Helper`).
..
After executing the ``pointToPoint.Install (nodes)`` call we will have
two nodes, each with an installed point-to-point net device and a single
point-to-point channel between them. Both devices will be configured to
transmit data at five megabits per second over the channel which has a two
millisecond transmission delay.
Depois de executar a chamada ``pointToPoint.Install (nodes)`` iremos ter dois ns, cada qual instalado na rede ponto-a-ponto e um nico canal ponto-a-ponto ligando os dois. Ambos os dispositivos sero configurados para ter uma taxa de transferncia de dados de cinco megabits por segundo, que por sua vez tem um atraso de transmisso de dois milissegundos.
InternetStackHelper
~~~~~~~~~~~~~~~~~~~
..
We now have nodes and devices configured, but we don't have any protocol stacks
installed on our nodes. The next two lines of code will take care of that.
Agora temos os ns e dispositivos configurados, mas no temos qualquer pilha de protocolos instalada em nossos ns. As prximas duas linhas de cdigo iro cuidar disso.
::
InternetStackHelper stack;
stack.Install (nodes);
..
The ``InternetStackHelper`` is a topology helper that is to internet stacks
what the ``PointToPointHelper`` is to point-to-point net devices. The
``Install`` method takes a ``NodeContainer`` as a parameter. When it is
executed, it will install an Internet Stack (TCP, UDP, IP, etc.) on each of
the nodes in the node container.
O ``InternetStackHelper`` um assistente de topologia inter-rede. O mtodo ``Install`` utiliza um ``NodeContainer`` como parmetro. Quando isto executado, ele ir instalar a pilha de protocolos da Internet (TCP, UDP, IP, etc) em cada n do continer.
Ipv4AddressHelper
~~~~~~~~~~~~~~~~~
..
Next we need to associate the devices on our nodes with IP addresses. We
provide a topology helper to manage the allocation of IP addresses. The only
user-visible API is to set the base IP address and network mask to use when
performing the actual address allocation (which is done at a lower level
inside the helper).
Agora precisamos associar os dispositivos dos ns a endereos IP. Ns fornecemos um assistente de topologia para gerenciar a alocao de endereos IP's. A nica API de usurio visvel serve para configurar o endereo IP base e a mscara de rede, usado para alocao de endereos.
..
The next two lines of code in our example script, ``first.cc``,
As prximas duas linhas de cdigo,
::
Ipv4AddressHelper address;
address.SetBase ("10.1.1.0", "255.255.255.0");
..
declare an address helper object and tell it that it should begin allocating IP
addresses from the network 10.1.1.0 using the mask 255.255.255.0 to define
the allocatable bits. By default the addresses allocated will start at one
and increase monotonically, so the first address allocated from this base will
be 10.1.1.1, followed by 10.1.1.2, etc. The low level |ns3| system
actually remembers all of the IP addresses allocated and will generate a
fatal error if you accidentally cause the same address to be generated twice
(which is a very hard to debug error, by the way).
declara um assistente de endereamento e diz para ele iniciar a alocao de IP's na rede 10.1.1.0 usando a mscara 255.255.255.0. Por padro, os endereos alocados iro iniciar do primeiro endereo IP disponvel e sero incrementados um a um. Ento, o primeiro endereo IP alocado ser o 10.1.1.1, seguido pelo 10.1.1.2, etc. Em um nvel mais baixo, o |ns3| mantm todos os endereos IP's alocados e gera um erro fatal se voc acidentalmente usar o mesmo endereo duas vezes (esse um erro muito difcil de depurar).
..
The next line of code,
A prxima linha de cdigo,
::
Ipv4InterfaceContainer interfaces = address.Assign (devices);
..
performs the actual address assignment. In |ns3| we make the
association between an IP address and a device using an ``Ipv4Interface``
object. Just as we sometimes need a list of net devices created by a helper
for future reference we sometimes need a list of ``Ipv4Interface`` objects.
The ``Ipv4InterfaceContainer`` provides this functionality.
realiza efetivamente o endereamento. No |ns3| ns fazemos a associao entre endereos IP e dispositivos usando um objeto ``Ipv4Interface``. As vezes precisamos de uma lista dos dispositivos de rede criados pelo assistente de topologia para consultas futuras. O ``Ipv4InterfaceContainer`` fornece esta funcionalidade.
..
Now we have a point-to-point network built, with stacks installed and IP
addresses assigned. What we need at this point are applications to generate
traffic.
Agora que ns temos uma rede ponto-a-ponto funcionando, com pilhas de protocolos instaladas e endereos IP's configurados. O que ns precisamos so aplicaes para gerar o trfego de rede.
..
Applications
Aplicaes
++++++++++
..
Another one of the core abstractions of the ns-3 system is the
``Application``. In this script we use two specializations of the core
|ns3| class ``Application`` called ``UdpEchoServerApplication``
and ``UdpEchoClientApplication``. Just as we have in our previous
explanations, we use helper objects to help configure and manage the
underlying objects. Here, we use ``UdpEchoServerHelper`` and
``UdpEchoClientHelper`` objects to make our lives easier.
Outra abstrao do ncleo do |ns3| so as aplicaes (``Application``). Neste cdigo so utilizadas duas especializaes da classe ``Application`` chamadas ``UdpEchoServerApplication`` e ``UdpEchoClientApplication``. Assim como nas explicaes anteriores que ns utilizamos assistentes para configurar e gerenciar outros objetos, ns usaremos os objetos ``UdpEchoServerHelper`` e ``UdpEchoClientHelper`` para deixar a nossa vida mais fcil.
UdpEchoServerHelper
~~~~~~~~~~~~~~~~~~~
..
The following lines of code in our example script, ``first.cc``, are used
to set up a UDP echo server application on one of the nodes we have previously
created.
As linhas seguintes do cdigo do exemplo ``first.cc``, so usadas para configurar uma aplicao de eco (`echo`) UDP em um dos ns criados anteriormente.
::
UdpEchoServerHelper echoServer (9);
ApplicationContainer serverApps = echoServer.Install (nodes.Get (1));
serverApps.Start (Seconds (1.0));
serverApps.Stop (Seconds (10.0));
..
The first line of code in the above snippet declares the
``UdpEchoServerHelper``. As usual, this isn't the application itself, it
is an object used to help us create the actual applications. One of our
conventions is to place *required* ``Attributes`` in the helper constructor.
In this case, the helper can't do anything useful unless it is provided with
a port number that the client also knows about. Rather than just picking one
and hoping it all works out, we require the port number as a parameter to the
constructor. The constructor, in turn, simply does a ``SetAttribute``
with the passed value. If you want, you can set the "Port" ``Attribute``
to another value later using ``SetAttribute``.
Um fragmento da primeira linha do cdigo declara o ``UdpEchoServerHelper``. Esta no a prpria aplicao, o objeto usado para ajudar na criao da aplicao. Uma de nossas convenes colocar os atributos *obrigatrios* no construtor do assistente de topologia. Neste caso, o assistente no pode fazer nada se no colocarmos um nmero de porta que o cliente conhece. O construtor, por sua vez, configura o atributo "Port" usando ``SetAttribute``.
..
Similar to many other helper objects, the ``UdpEchoServerHelper`` object
has an ``Install`` method. It is the execution of this method that actually
causes the underlying echo server application to be instantiated and attached
to a node. Interestingly, the ``Install`` method takes a
``NodeContainter`` as a parameter just as the other ``Install`` methods
we have seen. This is actually what is passed to the method even though it
doesn't look so in this case. There is a C++ *implicit conversion* at
work here that takes the result of ``nodes.Get (1)`` (which returns a smart
pointer to a node object --- ``Ptr<Node>``) and uses that in a constructor
for an unnamed ``NodeContainer`` that is then passed to ``Install``.
If you are ever at a loss to find a particular method signature in C++ code
that compiles and runs just fine, look for these kinds of implicit conversions.
De forma semelhante aos outros assistentes, o ``UdpEchoServerHelper`` tem o mtodo ``Install``. este mtodo que instancia a aplicao de servidor de eco (``echo server``) e a associa ao n. O mtodo ``Install`` tem como parmetro um ``NodeContainter``, assim como o outro mtodo ``Install`` visto. Isto o que passado para o mtodo, mesmo que no seja visvel. H uma *converso implcita* em C++, que pega o resultado de ``nodes.Get (1)`` (o qual retorna um ponteiro para o objeto `node` --- ``Ptr<Node>``) e o usa em um construtor de um ``NodeContainer`` sem nome, que ento passado para o mtodo ``Install``.
..
We now see that ``echoServer.Install`` is going to install a
``UdpEchoServerApplication`` on the node found at index number one of the
``NodeContainer`` we used to manage our nodes. ``Install`` will return
a container that holds pointers to all of the applications (one in this case
since we passed a ``NodeContainer`` containing one node) created by the
helper.
Agora vemos que o ``echoServer.Install`` instala um ``UdpEchoServerApplication`` no primeiro n do ``NodeContainer``. O ``Install`` ir retornar um continer que armazena os ponteiros de todas as aplicaes (neste caso passamos um ``NodeContainer`` contendo um n) criadas pelo assistente de topologia.
..
Applications require a time to "start" generating traffic and may take an
optional time to "stop". We provide both. These times are set using the
``ApplicationContainer`` methods ``Start`` and ``Stop``. These
methods take ``Time`` parameters. In this case, we use an *explicit*
C++ conversion sequence to take the C++ double 1.0 and convert it to an
|ns3| ``Time`` object using a ``Seconds`` cast. Be aware that
the conversion rules may be controlled by the model author, and C++ has its
own rules, so you can't always just assume that parameters will be happily
converted for you. The two lines,
As aplicaes requerem um tempo para "iniciar" a gerao de trfego de rede e podem ser opcionalmente "desligadas". Estes tempos podem ser configurados usando o ``ApplicationContainer`` com os mtodos ``Start`` e ``Stop``, respectivamente. Esses mtodos possuem o parmetro ``Time``. Em nosso exemplo, ns usamos uma conveno explicita do C++ para passar 1.0 e converter em um objeto ``Time`` usando segundos. Esteja ciente que as regras de converso podem ser controladas pelo autor do modelo e o C++ tem suas prprias regras, desta forma, voc no pode assumir que o parmetro sempre vai ser convertido para voc. As duas linhas,
::
serverApps.Start (Seconds (1.0));
serverApps.Stop (Seconds (10.0));
..
will cause the echo server application to ``Start`` (enable itself) at one
second into the simulation and to ``Stop`` (disable itself) at ten seconds
into the simulation. By virtue of the fact that we have declared a simulation
event (the application stop event) to be executed at ten seconds, the simulation
will last *at least* ten seconds.
iro iniciar (``Start``) a aplicao de servidor de eco um segundo aps o incio da simulao e depois desligar (``Stop``) em dez segundos. Em virtude de termos declarado que um evento de simulao (o evento de desligamento da aplicao) deve ser executado por dez segundos, a simulao vai durar pelo menos dez segundos.
UdpEchoClientHelper
~~~~~~~~~~~~~~~~~~~
..
The echo client application is set up in a method substantially similar to
that for the server. There is an underlying ``UdpEchoClientApplication``
that is managed by an ``UdpEchoClientHelper``.
A aplicao cliente de eco configurada de forma muito similar ao servidor. H o ``UdpEchoClientApplication`` que gerenciado por um ``UdpEchoClientHelper``.
::
UdpEchoClientHelper echoClient (interfaces.GetAddress (1), 9);
echoClient.SetAttribute ("MaxPackets", UintegerValue (1));
echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.)));
echoClient.SetAttribute ("PacketSize", UintegerValue (1024));
ApplicationContainer clientApps = echoClient.Install (nodes.Get (0));
clientApps.Start (Seconds (2.0));
clientApps.Stop (Seconds (10.0));
..
For the echo client, however, we need to set five different ``Attributes``.
The first two ``Attributes`` are set during construction of the
``UdpEchoClientHelper``. We pass parameters that are used (internally to
the helper) to set the "RemoteAddress" and "RemotePort" ``Attributes``
in accordance with our convention to make required ``Attributes`` parameters
in the helper constructors.
Para o cliente de eco, precisamos configurar cinco diferentes atributos. Os dois primeiros so configurados durante a construo do ``UdpEchoClientHelper``. Passamos os parmetros que so usados (internamente pelo Assistente) para configurar os atributos "RemoteAddress" (endereo remoto) e "RemotePort" (porta remota).
..
Recall that we used an ``Ipv4InterfaceContainer`` to keep track of the IP
addresses we assigned to our devices. The zeroth interface in the
``interfaces`` container is going to correspond to the IP address of the
zeroth node in the ``nodes`` container. The first interface in the
``interfaces`` container corresponds to the IP address of the first node
in the ``nodes`` container. So, in the first line of code (from above), we
are creating the helper and telling it so set the remote address of the client
to be the IP address assigned to the node on which the server resides. We
also tell it to arrange to send packets to port nine.
Lembre-se que usamos um ``Ipv4InterfaceContainer`` para configurar o endereo IP em nossos dispositivos. A interface zero (primeira) no continer corresponde ao endereo IP do n zero no continer de ns. A primeira interface corresponde ao endereo IP do primeiro n. Ento, na primeira linha do cdigo anterior, ns criamos um assistente e dizemos ao n para configurar o endereo remoto do cliente conforme o IP do servidor. Ns dizemos tambm para enviar pacotes para a porta nove.
..
The "MaxPackets" ``Attribute`` tells the client the maximum number of
packets we allow it to send during the simulation. The "Interval"
``Attribute`` tells the client how long to wait between packets, and the
"PacketSize" ``Attribute`` tells the client how large its packet payloads
should be. With this particular combination of ``Attributes``, we are
telling the client to send one 1024-byte packet.
O atributo "MaxPackets" diz ao cliente o nmero mximo de pacotes que so permitidos para envio durante a simulao. O atributo "Interval" diz ao cliente quanto tempo esperar entre os pacotes e o "PacketSize" informa ao cliente qual o tamanho da rea de dados do pacote. Com esta combinao de atributos que ns fizemos teremos clientes enviando pacotes de 1024 bytes.
..
Just as in the case of the echo server, we tell the echo client to ``Start``
and ``Stop``, but here we start the client one second after the server is
enabled (at two seconds into the simulation).
Assim como no caso do servidor de eco, ns dizemos para o cliente de eco iniciar e parar, mas aqui ns iniciamos o cliente um segundo depois que o servidor estiver funcionando (com dois segundos de simulao).
.. Simulator
Simulador (`Simulator`)
+++++++++++++++++++++++
..
What we need to do at this point is to actually run the simulation. This is
done using the global function ``Simulator::Run``.
O que ns precisamos agora executar o simulador. Isto feito usando a funo global ``Simulator::Run``.
::
Simulator::Run ();
..
When we previously called the methods,
Quando ns chamamos os mtodos
::
serverApps.Start (Seconds (1.0));
serverApps.Stop (Seconds (10.0));
...
clientApps.Start (Seconds (2.0));
clientApps.Stop (Seconds (10.0));
..
we actually scheduled events in the simulator at 1.0 seconds, 2.0 seconds and
two events at 10.0 seconds. When ``Simulator::Run`` is called, the system
will begin looking through the list of scheduled events and executing them.
First it will run the event at 1.0 seconds, which will enable the echo server
application (this event may, in turn, schedule many other events). Then it
will run the event scheduled for t=2.0 seconds which will start the echo client
application. Again, this event may schedule many more events. The start event
implementation in the echo client application will begin the data transfer phase
of the simulation by sending a packet to the server.
agendamos os eventos no simulador em 1 segundo, 2 segundos e dois eventos em 10 segundos. Quando chamamos ``Simulator::Run``, o sistema verificar a lista de eventos agendados e os executar no momento apropriado. Primeiramente, ele vai executar o evento de 1 segundo que inicia a aplicao de servidor de eco. Depois executa o evento agendado com dois segundos (t=2,0) que iniciar a aplicao do cliente de eco. Estes eventos podem agendar muitos outros eventos. O evento `start` do cliente ir iniciar a fase de transferncia de dados na simulao enviando pacotes ao servidor.
..
The act of sending the packet to the server will trigger a chain of events
that will be automatically scheduled behind the scenes and which will perform
the mechanics of the packet echo according to the various timing parameters
that we have set in the script.
O ato de enviar pacotes para o servidor vai disparar uma cadeia de eventos que sero automaticamente escalonados e executaro a mecnica do envio de pacotes de eco de acordo com os vrios parmetros de tempo que configuramos no cdigo.
..
Eventually, since we only send one packet (recall the ``MaxPackets``
``Attribute`` was set to one), the chain of events triggered by
that single client echo request will taper off and the simulation will go
idle. Once this happens, the remaining events will be the ``Stop`` events
for the server and the client. When these events are executed, there are
no further events to process and ``Simulator::Run`` returns. The simulation
is then complete.
Considerando que enviamos somente um pacote (lembre-se que o atributo ``MaxPackets`` foi definido com um), uma cadeia de eventos ser disparada por este nico pedido de eco do cliente at cessar e o simulador ficar ocioso. Uma vez que isto ocorra, os eventos restantes sero o ``Stop`` do servidor e do cliente. Quando estes eventos forem executados, no havendo mais eventos para processar, o ``Simulator::Run`` retorna. A simulao est completa.
..
All that remains is to clean up. This is done by calling the global function
``Simulator::Destroy``. As the helper functions (or low level
|ns3| code) executed, they arranged it so that hooks were inserted in
the simulator to destroy all of the objects that were created. You did not
have to keep track of any of these objects yourself --- all you had to do
was to call ``Simulator::Destroy`` and exit. The |ns3| system
took care of the hard part for you. The remaining lines of our first
|ns3| script, ``first.cc``, do just that:
Tudo que resta limpar. Isto feito chamando uma funo global chamada ``Simulator::Destroy``. Uma das funes dos assistentes (ou do cdigo de baixo nvel do |ns3|) agrupar todos os objetos que foram criados e destru-los. Voc no precisa tratar estes objetos --- tudo que precisa fazer chamar ``Simulator::Destroy`` e sair. O |ns3| cuidar desta difcil tarefa para voc. As linhas restantes do cdigo fazem isto:
::
Simulator::Destroy ();
return 0;
}
.. Building Your Script
Construindo o cdigo
++++++++++++++++++++
..
We have made it trivial to build your simple scripts. All you have to do is
to drop your script into the scratch directory and it will automatically be
built if you run Waf. Let's try it. Copy ``examples/tutorial/first.cc`` into
the ``scratch`` directory after changing back into the top level directory.
trivial construir (criar os binrios de) seu cdigo. Tudo que tem a fazer copiar seu cdigo para dentro do diretrio ``scratch`` e ele ser construdo automaticamente quando executar o Waf. Copie ``examples/tutorial/first.cc`` para o diretrio ``scratch`` e depois volte ao diretrio principal.
::
cd ../..
cp examples/tutorial/first.cc scratch/myfirst.cc
..
Now build your first example script using waf:
Agora construa seu primeiro exemplo usando o Waf:
::
./waf
..
You should see messages reporting that your ``myfirst`` example was built
successfully.
Voc deve ver mensagens reportando que o seu exemplo ``myfirst`` foi construdo com sucesso.
::
Waf: Entering directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
[614/708] cxx: scratch/myfirst.cc -> build/debug/scratch/myfirst_3.o
[706/708] cxx_link: build/debug/scratch/myfirst_3.o -> build/debug/scratch/myfirst
Waf: Leaving directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
'build' finished successfully (2.357s)
..
You can now run the example (note that if you build your program in the scratch
directory you must run it out of the scratch directory):
Voc agora pode executar o exemplo (note que se voc construiu seu programa no diretrio ``scratch``, ento deve executar o comando fora deste diretrio):
::
./waf --run scratch/myfirst
..
You should see some output:
Voc dever ver algumas sadas:
::
Waf: Entering directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
Waf: Leaving directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
'build' finished successfully (0.418s)
Sent 1024 bytes to 10.1.1.2
Received 1024 bytes from 10.1.1.1
Received 1024 bytes from 10.1.1.2
..
Here you see that the build system checks to make sure that the file has been
build and then runs it. You see the logging component on the echo client
indicate that it has sent one 1024 byte packet to the Echo Server on
10.1.1.2. You also see the logging component on the echo server say that
it has received the 1024 bytes from 10.1.1.1. The echo server silently
echoes the packet and you see the echo client log that it has received its
packet back from the server.
O sistema verifica se os arquivos foram construdos e ento executa-os. Atravs do componente de registro vemos que o cliente enviou 1024 bytes para o servidor atravs do IP 10.1.1.2. Tambm podemos ver que o servidor diz ter recebido 1024 bytes do IP 10.1.1.1 e ecoa o pacote para o cliente, que registra o seu recebimento.
.. Ns-3 Source Code
Cdigo fonte do Ns-3
********************
..
Now that you have used some of the |ns3| helpers you may want to
have a look at some of the source code that implements that functionality.
The most recent code can be browsed on our web server at the following link:
http://code.nsnam.org/ns-3-dev. There, you will see the Mercurial
summary page for our |ns3| development tree.
Agora que voc j utilizou alguns assistentes do |ns3|, podemos dar uma olhada no cdigo fonte que implementa estas funcionalidades. Pode-se navegar o cdigo mais recente no seguinte endereo: http://code.nsnam.org/ns-3-dev. L voc ver a pgina de sumrio do Mercurial para a rvore de desenvolvimento do |ns3|.
..
At the top of the page, you will see a number of links,
No incio da pgina, voc ver vrios `links`,
::
summary | shortlog | changelog | graph | tags | files
..
Go ahead and select the ``files`` link. This is what the top-level of
most of our *repositories* will look:
selecione ``files``. Aparecer o primeiro nvel do repositrio:
::
drwxr-xr-x [up]
drwxr-xr-x bindings python files
drwxr-xr-x doc files
drwxr-xr-x examples files
drwxr-xr-x ns3 files
drwxr-xr-x scratch files
drwxr-xr-x src files
drwxr-xr-x utils files
-rw-r--r-- 2009-07-01 12:47 +0200 560 .hgignore file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 1886 .hgtags file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 1276 AUTHORS file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 30961 CHANGES.html file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 17987 LICENSE file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 3742 README file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 16171 RELEASE_NOTES file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 6 VERSION file | revisions | annotate
-rwxr-xr-x 2009-07-01 12:47 +0200 88110 waf file | revisions | annotate
-rwxr-xr-x 2009-07-01 12:47 +0200 28 waf.bat file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 35395 wscript file | revisions | annotate
-rw-r--r-- 2009-07-01 12:47 +0200 7673 wutils.py file | revisions | annotate
..
Our example scripts are in the ``examples`` directory. If you click on ``examples``
you will see a list of subdirectories. One of the files in ``tutorial`` subdirectory is ``first.cc``. If
you click on ``first.cc`` you will find the code you just walked through.
Os cdigos exemplo esto no diretrio ``examples``. Se voc clicar ver uma lista de subdiretrios. Um dos arquivos no subdiretrio ``tutorial`` o ``first.cc``. Clicando nele voc encontrar o cdigo que acabamos de analisar.
..
The source code is mainly in the ``src`` directory. You can view source
code either by clicking on the directory name or by clicking on the ``files``
link to the right of the directory name. If you click on the ``src``
directory, you will be taken to the listing of the ``src`` subdirectories. If you
then click on ``core`` subdirectory, you will find a list of files. The first file
you will find (as of this writing) is ``abort.h``. If you click on the
``abort.h`` link, you will be sent to the source file for ``abort.h`` which
contains useful macros for exiting scripts if abnormal conditions are detected.
O cdigo fonte mantido no diretrio ``src``. Voc pode v-lo clicando sobre o nome do diretrio ou clicando no item ``files`` a direita do nome. Clicando no diretrio ``src``, obter uma lista de subdiretrios. Clicando no subdiretrio ``core``, encontrar um lista de arquivos. O primeiro arquivo o ``abort.h``, que contm macros caso condies anormais sejam encontradas.
..
The source code for the helpers we have used in this chapter can be found in the
``src/applications/helper`` directory. Feel free to poke around in the directory tree to
get a feel for what is there and the style of |ns3| programs.
O cdigo fonte para os assistentes utilizados neste captulo podem ser encontrados no diretrio ``src/applications/helper``. Sinta-se vontade para explorar a rvore de diretrios e ver o estilo de cdigo do |ns3|.
|