Commit 1bfe4085 authored by Sampo Saaristo's avatar Sampo Saaristo

Initial revision

parents
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
Appendix: How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) 19yy <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
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.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19yy name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
RUDE and CRUDE
==============
This project is distributed under the terms of GNU General Public License
Version 2, which can be found e.g. in the file COPYING that is located
in this very same directory. Read it for more detailed information.
The copyright is owned by the authors:
(C) 1999 Juha Laine and Sampo Saaristo
INTRODUCTION (very short):
--------------------------
* RUDE [Real-time UDP Data Emitter]
As the name says, this piece of program can generate UDP traffic
to the network. Read more from "README.rude".
* CRUDE [Collector for RUDE]
This program can log the traffic that is generated with the RUDE
for later processing. Read more from "README.crude".
COMPILATION AND INSTALLATION INSTRUCTIONS:
------------------------------------------
1. This package you have received should contain the automatic 'configure'
script in the source code root directory. If this is true you can jump
into the step 4. Otherwise read also the steps 2. and 3. that explain
the procedure how to create the configure script with the GNU autoconf
utilities.
2. So you have the very clean version. Alright. Before you can compile
the program you should make the configuration script(s) and other
files with the GNU autoconf utilities. In other words you require
properly installed 'autoheader' and 'autoconf' programs. At least
version 2.13 of the GNU autoconf tools seems to work fine.
[ After those programs are installed you can move on.... ]
3. You need to generate some header file(s) and the configuration script
with the following commands (you must be in the program's source code
root directory):
autoheader -l ./autoconf
autoconf autoconf/configure.in > configure
chmod 755 configure
4. Now you are ready to go on and configure this software package. As
usual, you can say './configure --help' to get the full list of
configuring switches. Here are only the usually required options:
--prefix=PREFIX = Installation directory root (/usr/local/)
--enable-debug = Enable compiler option -g
--enable-wall = Enable compiler option -Wall (gcc only)
--with-debug-lvl=[0-7] = Set program debugging output level
RECOMMENDED CONFIGURATION COMMAND IS:
-------------------------------------
./configure --enable-wall --with-debug-lvl=3
5. 'make all'
So far this program is tested on Linux and Solaris2.6 OS's and
seems to compile/operate without any major drawbacks. Your mileage
may vary...
6. 'make install'
USE MANUAL INSTALLATION IF THIS FAILS. SORRY 'BOUT THAT :)
Only ROOT can successfully execute this command.
...and that's it.
EXAMPLES AND SOME HELPER APPLICATIONS
-------------------------------------
** You can find well-commented example script for the rude in this
directory under name "example.cfg". Read also the "README.rude" file.
** There are some example scripts (made with Perl) that can manipulate
the decoded output from CRUDE. They are located in the "scripts"
directory. They parse the decoded/text output from the crude and
produce somewhat more informatic output e.g. to use with gnuplot
program.
BEFORE EXECUTING, CHECK THAT THE FIRST LINE OF THOSE SCRIPTS MATCH
YOUR CONFIGURATION - i.e. the correct path to the Perl, which must
be installed in your system.
crude_jitter.pl produces N output files (one for each detected flow)
under names "jitter.<flow ID>". These files contain 2 columns.
- 1st = column lists the packet sequence numbers
- 2nd = column lists the time between this and the previous packet
So it is not actually "jitter" but if plotted it can be easily observed.
If the packet was lost the script skips to the next packet and marks
the error into the 3rd usually invisible column with negative error
index...
crude_parse.pl produces also N output files (one for each detected flow)
under names "data.<flow ID>". These files contain 6 columns.
- 1st = flow ID
- 2nd = timeslot ("sample time")
- 3rd = average bandwith usage during this timeslot
- 4th = total number of sent bytes for this flow
- 5th = received packet INDEX
- 6th = stamped packet sequence number
Both of these scripts understand the "-h" command line option that
prints out the short usage/command line switch instructions. The
input file should be the decoded (text formatted) file produced by
the crude utility.
Use with care - they are still under construction :)
HOW TO ADD/CREATE NEW TRAFFIC CLASS
-----------------------------------
Here will be short (step by step) instructions for programmers that
wish to add own traffic/flow types to rude.
-=* THIS SECTION IS STILL UNDER CONSTRUCTION, SO IT GIVES JUST AN *=-
-=* OVERVIEW AND SOME IMPORTANT STEPS ARE PROPABLY MISSING :) *=-
1) Add your flow type to the 'enum f_type' in "../include/rude.h"
2) Create the private struct for this flows parameters in
"../include/rude.h"
3) Add the new struct to the 'union params' in 'struct flow_cfg'
in "../include/rude.h"
4) Add the name->f_type conversion in the function 'check_type()'
in "../rude/parse.c"
5) Add the flow transmission function in to "../rude/flow_txmit.c"
6) Add the parsing to the function 'flow_on()' in "../rude/parse.c"
7) Add the parsing to the function 'flow_modify()' in "../rude/parse.c"
8) Add the case that checks the maximum packet size to the end of
'read_cfg()' in "../rude/parse.c"
9) Add necessary commands to free acquired memory (if required) in
'clean_up()' in "../rude/flow_cntl.c"
<...Here should be more info when the implementation gets more stable...>
CRUDE - version 0.60
-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_
From Webster's Revised Unabridged Dictionary (1913) [web1913]:
Crude \Crude\ (kr[udd]d), a.
Unripe; not mature or perfect; immature.
I come to pluck your berries harsh and crude.
--Milton.
-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_
CRUDE is the receiver and logging utility for flows that are generated
with the RUDE tool. In the default operation mode CRUDE prints the
information to standard output, so you'll have to redirect it to
file if you like to process it later on.
Our recommendation is to log the data into file with the '-l' option.
This reduces I/O operations because the data is logged in binary
format and soforth improves performance. You can decode the file
later on with the option '-d'.
BUGs and feature wishes should be reported into one of the following
E-mail addresses:
james@cs.tut.fi
sambo@cc.tut.fi
rprior@inescporto.pt
-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_
Commandline syntax:
crude [ -h | -v | -d <file> | [-p <port>] [-i <add>] [-l <file>] [-n #] ]
-h Print short help.
-v Print version information
-d <file> Use this option to decode the binary
formatted file which was generated from
the capture with the '-l' option.
-p <port> Set the UDP port to listen to. The
default port is 10001.
-i <add> Set the physical interface to listen
from. The <add> argument is the IP
addres for the specific interface in
numerical dotted notation (a.b.c.d).
If this is not set, the program will
use the INADDR_ANY address :)
-l <file> Log the results into file <file> in
binary format. The default behaviour is
to print out the decoded info to stdout.
-n # Set the number of packets to capture. The
default vaulue is 0, which means until
interrupted with CTRL+C.
-s #[,#...] Instead of logging results to a file
calculate some statistics on-the-fly.
-P <priority> Set the process real-time priority.
Only root can do that. Be carefull -
this might lock up your computer !!!
-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_
RUDE - version 0.60
-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_
From Jargon File (4.0.0/24 July 1996) [jargon]:
rude [WPI] /adj./
1. (of a program) Badly written.
2. Functionally poor, e.g., a program that is very difficult to
use because of gratuitously poor (random?) design decisions.
Oppose {cuspy}.
3. Anything that manipulates a shared resource without regard for
its other users in such a way as to cause a (non-fatal) problem.
Examples: programs that change tty modes without resetting them
on exit, or windowing programs that keep forcing themselves to
the top of the window stack. Compare {all-elbows}.
-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_
Commandline syntax:
rude [ -h | -v | -s <script file> ] [ -p <priority level ]
-h Print short help.
-v Print version information
-s <script file> Use this option to point out the correct
script file that describes the flows. This
option is compulsory if you want to generate
traffic.
-P <priority> Set the process real-time priority.
Only root can do that. Be carefull -
this might lock up your computer !!!
-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_
Configuration file:
Every configuration file should contain at least three (3) commands:
the START, one flow ON and one flow OFF command. If that requirement is
not met or the parser can not recognize all the given commands in the file,
the configuration file will be considered corrupted and the program will
exit without any further action.
Lines starting with '#' or empty lines are treated as comments (i.e. are
not processed). Configuration file can hold any number of comment lines
anywhere in the file.
The START command must be the 1st command in the configuration file.
It may be preceded with comment lines, but nothing else. If your config
file has more than one (1) START command, the parsing will fail and the
program will exit with error.
Configuration file should hold at least two commands for each flow:
the ON and OFF commands. Between the ON and OFF commands can be
random/any number of MODIFY commands, which alter the flow behaviour.
Note that MODIFY commands are not available for every flow type.
Commands for each flow must be ordered according to the time - i.e.
the ON command must be the 1st command for the specific flow and the
MODIFY commands must be ordered by the time-field. The OFF command
must be the last command for the flow. The commands for each flow can
be "mixed" or each flow can have their configuration on different segment
in the file.
See also the well-commented configuration file "example.cfg".
------------------------------------------------------------------------------
------------------------------------------------------------------------------
START <time>
o <time> = { NOW | HH:MM:SS }
- HH = { 0,...,23 } , MM = { 0,...,59 } , SS = { 0,...,59 }
- This must be the 1st action line in the configuration file. The <time>
can be respresented as a symbolic value "NOW" or an absolute time with
the universal 24h notation "hours:minutes:seconds".
- Only/exactly one START command is required/expected.
- Parser tests only 9 characters, so little typos do not affect. In
other words "START NOW\n" = OK and "START NOW \n" = OK and
"START NOWADAYS" = OK ;)
------------------------------------------------------------------------------
<stime> <id> ON <sport> <dst.add>:<dst.port> <type> [type parameters]
o <stime> = { integer }
- Relative time (in milliseconds) to the START TIME when the
flow <id> should be activated (i.e. value 1000 = 1 second).
Must be > 0.
o <id> = { integer } - Unique identifier for this flow.
o <sport> = { integer } - Source UDP port for this flow. Must be > 1024.
o <dst.add> = { string }
- Destination addres either in dotted decimal notation or DNS name.
Must be followed with colon ':' and the destination port number.
o <dst.port> = { integer } - Destination UDP port.
o <type> = { string }
- Flow type. Can be one of the following with type specific parameters:
* CONSTANT <rate> <psize>
o <rate> = { integer } - packets per second. Must be >= 0. If the rate
is equal to zero (rate = 0) the flow will be
silent (= not transmitting) during this
timeslot.
o <psize> = { integer } - packet size. This sets the size of the UDP
data field. It must be between 20 and 32768
bytes. The actual transmitted packet size
depends on the used network interface
encapsulation. For example Ethernet packet
size can be calculated with the following
formula (UDP packet size = 1000 bytes):
<data> + <UDP> + <IP> + <ETH> = <TOTAL>
1000 + 8 + 20 + 18 = 1046 bytes
* TRACE <trace_file>
o <trace_file> = [path +] filename to the trace file
------------------------------------------------------------------------------
TOS <id> <value>
* This optional command allows for the setting of the TOS byte of the
IP header. Some values may only be used by root. If rude fails to
set the specified TOS it uses the default instead.
------------------------------------------------------------------------------
<mtime> <id> MODIFY <type> [type parameters]
* This command is valid only for the following flow type(s):
- CONSTANT
o <mtime> = { integer } - relative time from START to this action
o <id> = { integer } - flow identifier
o <type> = { string } - flow type with parameters (see ON command)
------------------------------------------------------------------------------
<otime> <id> OFF
o <otime> = { integer } - relative time from START to this command
o <id> = { integer } - flow identifier
------------------------------------------------------------------------------
-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_
Available flow types:
* CONSTANT
This flow simulates stream that looks like constant bitrate traffic.
You may change the flow parameters (packet size and packet rate) with
the MODIFY command. If the generated stream is not "stable" enough, you
should try to run the rude in priviledged priority (-p option).
* TRACE
This flow simulates pre-defined traffic. The trace of the traffic is
given on separate text file which must look like this (2 columns,
where the 1st column describes the packet size and the 2nd column time
to wait for the _next_ transmission):
512 0.040
255 1.1
762 0.000001
Maximum line length (terminated with '\n') is set to 255 characters,
including the terminating newline-character. !!! THERE IS NO NEED TO
EXCEED THIS, SO BE CAREFUL WHEN CREATING YOUR OWN TRACE FILES !!!
The first column sets the size of data field in UDP packet. The second
column is interpreted as a floating point value, which tells us the
time to wait until the next packet/line can be processed. The "maximum"
resolution to the time value is 1 microsecond (= 6 digits after the
comma), although it is very unlikely that the kernel/this program can
process the packets with so high resolution...
If the TRACE flow is configured to STOP before all packets from the
trace file can be processed, no harm is done - "unprocessed" packets
won't be sent. On the other hand, if you configure the flow to
last longer than the trace file describes, rude will start from the