tools/tools/netrate/README

   1 Netsend and Netreceive
   2 ----------------------
   3
   4 This pair of binaries is used to fixed rate UDP performance testing.
   5
   6 The netreceive tool consists solely of a UDP packet sink bound to a
   7 specified UDP port.  Packets received on its port are copied to user space
   8 and discarded.
   9
  10 The netsend tool acts as a packet source, generating packets of the
  11 specified size at the specified rate to a target IP address and port
  12 number:
  13
  14    netsend [ip] [port] [payloadsize] [rate] [duration]
  15
  16 The payloadsize field specifies the size of the UDP payload, not the total
  17 packet size, which will also include a variety of headers (typically,
  18 ethernet, IP, and UDP).
  19
  20 The rate indicates the number of packets/second to attempt to deliver.
  21
  22 The duration is the duration of the run in seconds.
  23
  24 The netsend tool will wait for around two seconds to synchronize with the
  25 wall clock for timing purposes.  It will then busy-wait between packet
  26 transmits.
  27
  28 The netsend/netreceive tools are under the following copyright and
  29 license:
  30
  31 /*-
  32  * Copyright (c) 2004 Robert N. M. Watson
  33  * All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  *
  44  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  45  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  47  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  48  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  53  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  54  * SUCH DAMAGE.
  55  */
  56
  57 $FreeBSD$