Links

GitHub

Open HUB

Quick Links

Download

STREAMS

SIGTRAN

SS7

Hardware

SCTP

Related

Package

Manual

Status

FAQ

Manuals

sctp Manual

iperf Manual

SPG Manual

STREAMS Manual

strcompat Manual

strutil Manual

strbcm Manual

strtty Manual

strxns Manual

strxnet Manual

strsock Manual

strinet Manual

strsctp Manual

striso Manual

netperf Manual

strchan Manual

strx25 Manual

strisdn Manual

strss7 Manual

sigtran Manual

strvoip Manual

osr61 Manual

LiS Manual

Documentation

FAQ

SIGTRAN

Design

Conformance

Performance

References

Man Pages

Manuals

Papers

Home

Overview

Status

Documentation

Resources

About

News

iperf Manual

Description: OpenSS7 Online Manuals

A PDF version of this document is available here.

OpenSS7 IPERF Utility

OpenSS7 IPERF Utility Installation and Reference Manual

About This Manual

This is Edition 8, last updated 2008-10-31, of The OpenSS7 IPERF Utility Installation and Reference Manual, for Version 2.0 release 8 of the OpenSS7 IPERF Utility package.

Preface

Notice

This package is released and distributed under the AGPL (see GNU Affero General Public License). Please note, however, that there are different licensing terms for the manual pages and some of the documentation (derived from OpenGroup1 publications and other sources). Consult the permission notices contained in the documentation for more information.

Also note that portions of this software is derived from software developed by the University of Illinois covered under the UI License (see University of Illinois License).

This manual is released under the FDL (see GNU Free Documentation License) with no sections invariant.

Abstract

This manual provides a Installation and Reference Manual for OpenSS7 IPERF Utility.

Objective

The objective of this manual is to provide a guide for the network programmer when developing application programs for OpenSS7 IPERF Utility.

This guide provides information to developers on the use of the OpenSS7 IPERF Utility at user level.

Intent

The intent of this manual is to act as an introductory guide to the STREAMS programmer. It is intended to be read alone and is not intended to replace or supplement the OpenSS7 IPERF Utility manual pages. For a reference for writing code, the manual pages (see STREAMS(9)) provide a better reference to the programmer. Although this describes the features of the OpenSS7 IPERF Utility package, OpenSS7 Corporation is under no obligation to provide any software, system or feature listed herein.

Audience

This manual is intended for a highly technical audience. The reader should already be familiar with Linux network programming, the Linux file system, character devices, driver input and output, interrupts, software interrupt handling, scheduling, process contexts, multiprocessor locks, etc.

The guide is intended for network and systems programmers, who use the OpenSS7 IPERF Utility mechanism at user level for Linux and UNIX system communication services.

Readers of the guide are expected to possess prior knowledge of the Linux and UNIX system, programming, networking, and data communication.

Revisions

Take care that you are working with a current version of this manual: you will not be notified of updates. To ensure that you are working with a current version, contact the Author, or check The OpenSS7 Project website for a current version.

A current version of this manual is normally distributed with the OpenSS7 IPERF Utility package.

Version Control

     iperf.texi,v
     Revision 0.9.2.13  2008-09-20 11:04:24  brian
     - added package patchlevel
     
     Revision 0.9.2.12  2008-08-03 06:03:27  brian
     - protected agains texinfo commands in log entries
     
     Revision 0.9.2.11  2008/07/27 08:48:44  brian
     - no invariant sections, more libtool ignores
     
     Revision 0.9.2.10  2008-04-25 11:50:42  brian
     - updates to AGPLv3
     
     Revision 0.9.2.9  2007/08/12 06:43:41  brian
     - updated licenses in manuals
     
     Revision 0.9.2.8  2007/06/22 00:18:23  brian
     - mostly documentation updates for release, some netconfig workaround
     
     Revision 0.9.2.7  2007/02/28 06:30:18  brian
     - updates and corrections, #ifdef instead of #if
     
     Revision 0.9.2.6  2006/09/18 01:06:17  brian
     - updated manuals and release texi docs
     
     Revision 0.9.2.5  2006/08/28 10:46:53  brian
     - correction
     
     Revision 0.9.2.4  2006/08/28 10:32:44  brian
     - updated references
     
     Revision 0.9.2.3  2006/08/27 12:26:30  brian
     - finalizing auto release files
     
     Revision 0.9.2.2  2006/08/26 18:31:34  brian
     - handle long urls
     
     Revision 0.9.2.1  2006/08/26 14:41:37  brian
     - added manual
     

ISO 9000 Compliance

Only the TeX, texinfo, or roff source for this manual is controlled. An opaque (printed, postscript or portable document format) version of this manual is an UNCONTROLLED VERSION.

Disclaimer

OpenSS7 Corporation disclaims all warranties with regard to this documentation including all implied warranties of merchantability, fitness for a particular purpose, non-infringement, or title; that the contents of the manual are suitable for any purpose, or that the implementation of such contents will not infringe on any third party patents, copyrights, trademarks or other rights. In no event shall OpenSS7 Corporation be liable for any direct, indirect, special or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with any use of this manual or the performance or implementation of the contents thereof.

OpenSS7 Corporation reserves the right to revise this software and documentation for any reason, including but not limited to, conformity with standards promulgated by various agencies, utilization of advances in the state of the technical arts, or the reflection of changes in the design of any techniques, or procedures embodied, described, or referred to herein. OpenSS7 Corporation is under no obligation to provide any feature listed herein.

U.S. Government Restricted Rights

If you are licensing this Software on behalf of the U.S. Government ("Government"), the following provisions apply to you. If the Software is supplied by the Department of Defense ("DoD"), it is classified as "Commercial Computer Software" under paragraph 252.227-7014 of the DoD Supplement to the Federal Acquisition Regulations ("DFARS") (or any successor regulations) and the Government is acquiring only the license rights granted herein (the license rights customarily provided to non-Government users). If the Software is supplied to any unit or agency of the Government other than DoD, it is classified as "Restricted Computer Software" and the Government's rights in the Software are defined in paragraph 52.227-19 of the Federal Acquisition Regulations ("FAR") (or any successor regulations) or, in the cases of NASA, in paragraph 18.52.227-86 of the NASA Supplement to the FAR (or any successor regulations).

Acknowledgements

As with most open source projects, this project would not have been possible without the valiant efforts and productive software of the Free Software Foundation and the Linux Kernel Community.

Sponsors

Funding for completion of the OpenSS7 OpenSS7 IPERF Utility package was provided in part by:

OpenSS7 Corporation

Additional funding for The OpenSS7 Project was provided by:

OpenSS7 Corporation
Lockheed Martin Co.
Motorola
HOB International
Comverse Ltd.
Sonus Networks Inc.
France Telecom
SS8 Networks Inc.
Nortel Networks
Verisign
eServGlobal (NZ) Pty Ltd.
NetCentrex S. A.
SysMaster Corporation
GeoLink SA
AirNet Communications
TECORE
Tumsan Oy
Vodare Ltd.
Excel Telecommunications

Contributors

The primary contributor to the OpenSS7 OpenSS7 IPERF Utility package is Brian F. G. Bidulock. The following is a list of significant contributors to The OpenSS7 Project:

− Per Berquist
− John Boyd
− Chuck Winters
− Peter Courtney
− Tom Chandler
− Gurol Ackman
− Kutluk Testicioglu
− John Wenker
− Others

Additional thanks to:

• National Laboratory for Applied Network Research
• National Center for Supercomputing Applications
• University of Illinois at Urbana-Champaign

Authors

The authors of the OpenSS7 OpenSS7 IPERF Utility package include:

Brian Bidulock

See Author Index, for a complete listing and cross-index of authors to sections of this manual.

Maintainer

The maintainer of the OpenSS7 OpenSS7 IPERF Utility package is:

Brian Bidulock

Please send bug reports to bugs@openss7.org using the send-pr script included in the package, only after reading the BUGS file in the release, or See Problem Reports.

Web Resources

The OpenSS7 Project provides a website dedicated to the software packages released by the OpenSS7 Project.

Bug Reports

Please send bug reports to bugs@openss7.org using the send-pr script included in the OpenSS7 IPERF Utility package, only after reading the BUGS file in the release, or See Problem Reports. You can access the OpenSS7 GNATS database directly via the web, however, the preferred method for sending new bug reports is via mail with the send-pr script.

Mailing Lists

The OpenSS7 Project provides a number of general discussion Mailing Lists for discussion concerning the OpenSS7 OpenSS7 IPERF Utility package as well as other packages released by The OpenSS7 Project.

These are mailman mailing lists and so have convenient web interfaces for subscribers to control their settings. See http://www.openss7.org/mailinglist.html.

The mailing lists are as follows:

openss7
The openss7 mailing list is for general enquiries, information exchange and announcements regarding the OpenSS7 Project. This is our original mailing list and takes the highest amount of traffic.
openss7-announce
The openss7-announce mailing list is for announcements related to the OpenSS7 Project. This list will accept announcements posted by subscribers. Subscribe to this list if you are interested in announcements from the OpenSS7 Project, subscribers and sponsors, related to the OpenSS7 Project or STREAMS, SS7, SIGTRAN or SCTP in general.
openss7-cvs
The openss7-cvs mailing list is for automatic CVS log reporting. You must get permission of the owner to subscribe to this list. Subscribers are not allowed to post to this list, this is merely for distributing notification of changes to the CVS repository.h
openss7-develop
The openss7-develop mailing list is for email exchange related to the development projects under the OpenSS7 Project. This includes development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the OpenSS7 Project.
openss7-test
The openss7-test mailing list is for email exchange related to the testing of code under the OpenSS7 Project. This specifically relates to conformance testing, verification testing, interoperability testing and beta testing. Subscribe to this list if you are interested in participating in and receiving ongoing details of test activities under the OpenSS7 Project.
openss7-bugs
The openss7-bugs mailing list is specifically tailored to bug tracking. The mailing list takes a feed from the OpenSS7 GNATS bug tracking system and accepts posting of responses to bug reports, tracking and resolution. Subscribe to this list if you are interested in receiving detailed OpenSS7 release code bug tracking information. This list is not archived; for historical information on problem reports, see our GNATS databases.
openss7-updates
The openss7-updates mailing list provides updates on OpenSS7 Project code releases and ongoing activities. Subscribers are not allowed to post to this list; this list is for official OpenSS7 Project announcements only. Subscribe to this list if you are interested in receiving updates concerning official releases and activities of the OpenSS7 Project.
openss7-streams
The openss7-streams mailing list is for email exchange related to the STREAMS development projects under the OpenSS7 Project. This includes development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the OpenSS7 Project STREAMS components.
linux-streams
The linux-streams mailing list is for mail exchange related to Linux Fast-STREAMS or Linux STREAMS. This includes patches, development requests, proposals, requests for comment or proposal. Subscribe to this list if you are interested in ongoing development details regarding the STREAMS for Linux components. This is the the new (September 2006) home of the linux-streams list formerly of <gsyc.escet.urjc.es>.
Spam

To avoid spam being sent to the members of the OpenSS7 mailing list(s), we have blocked mail from non-subscribers. Please subscribe to the mailing list before attempting to post to them. (Attempts to post when not subscribed get bounced.)

As an additional measure against spam, subscriber lists for all OpenSS7 mailing lists are not accessible to non-subscribers; for most lists subscriber lists are only accessible to the list administrator. This keeps your mailing address from being picked off our website by bulk mailers.

Acceptable Use Policy

It is acceptable to post professional and courteous messages regarding the OpenSS7 package or any general information or questions concerning STREAMS, SS7, SIGTRAN, SCTP or telecommunications applications in general.

Large Attachments

The mailing list is blocked from messages of greater than 40k. If you have attachments (patches, test programs, etc.) and you mail them to the list, it will bounce to the list administrator. If you are interested in making your patches, test programs, test results or other large attachments available to the members of the mailing list, state in the message that you would like them posted and the list administrator will place them in the mail archives.

Quick Start Guide

OpenSS7 IPERF Utility

Package iperf-2.0.8 was released under AGPLv3 2008-10-31.

Iperf is a general purpose tool for measuring bandwidth and performance of the Internet Protocol suite. The OpenSS7 Modified OpenSS7 IPERF Utility package is an OpenSS7 Project release of the DAST iperf package configured to run with OpenSS7 Linux Native Stream Control Transmission Protocol (SCTP).

The OpenSS7 IPERF Utility package provides primarily the iperf(1), C++ Language program that acts as either an Iperf server or client for testing connections and networking. The iperf(1) program is executed on one host in server mode and then executed on another host in client mode. Characteristics of the connection or association can be altered when formed. Reporting formats and sample intervals can also be altered when the connection or association is formed.

This is a fork of the Iperf package released by the University of Illinois modified by the OpenSS7 Project for use with OpenSS7 SCTP (Stream Control Transmission Protocol). This OpenSS7 release of the package is based on the Iperf-2.0.0 release from the University of Illinois.

Modifications to the package are derived from the OpenSS7 SCTP implementation and are released under the GNU Affero General Public License (AGPL) Version 3. The Iperf tool itself is licensed under specific terms by the University of Illinois. Please see LICENSES for the University of Illinois Iperf copyright notices and licensing restrictions. The Iperf tool is:

Copyright 1999, 2000, 2001, 2002, 2003, 2004
The Board of Trustees of the University of Illinois
All rights reserved

See University of Illinois License in the LICENSES file for complete details.

Please note that this modified version of the Iperf package is not endorsed by the University of Illinois or DAST in any way and that neither the original copyright holders nor OpenSS7 Corporation will take any responsibility in it.

This distribution is only currently applicable to Linux 2.4 kernels and was targeted at ix86, x86_64, ppc and ppc64 architectures, but should build and install for other architectures as well.

Release

This is the iperf-2.0.8 package, released 2008-10-31. This ‘2.0.8’ release, and the latest version, can be obtained from the download area of The OpenSS7 Project website using a command such as:

     $> wget http://www.openss7.org/tarballs/iperf-2.0.8.tar.bz2

The release is available as an autoconf(1) tarball, src.rpm or dsc, as a set of binary rpms or debs, or as a yum(8) or apt(8) repository. See the download page for the autoconf(1) tarballs, src.rpms, dscs, or repository access instructions. See the iperf package page for tarballs, source and binary packages.

Please see the NEWS file for release notes and history of user visible changes for the current version, and the ChangeLog file for a more detailed history of implementation changes. The TODO file lists features not yet implemented and other outstanding items.

Please see the INSTALL, INSTALL-iperf and README-make, files (or see Installation) for installation instructions.

When working from cvs(1) or git(1), please see the README-cvs, file (or see Downloading from CVS). An abbreviated installation procedure that works for most applications appears below.

This release of the package is published strictly under Version 3 of the GNU Affero Public License which can be found in the file COPYING. Package specific licensing terms (if any) can be found in the file LICENSES. Please respect these licensing arrangements. If you are interested in different licensing terms, please contact the copyright holder, or OpenSS7 Corporation <sales@openss7.com>.

See README-alpha (if it exists) for alpha release information.

Prerequisites

The quickest and easiest way to ensure that all prerequisites are met is to download and install this package from within the OpenSS7 Master Package, openss7-0.9.2.G, instead of separately.

Prerequisites for the OpenSS7 IPERF Utility package are as follows:

  1. Linux distribution, somewhat Linux Standards Base compliant, with a 2.4 or 2.6 kernel and the appropriate tool chain for compiling out-of-tree kernel modules. Most recent Linux distributions are usable out of the box, but some development packages must be installed. For more information, see Compatibility.

    − A fairly LSB compliant GNU/Linux distribution.2
    − Linux 2.4 kernel (2.4.10 - 2.4.27), or
    − Linux 2.6 kernel (2.6.3 - 2.6.26);
    − glibc2 or better.
    − GNU groff (for man pages).3
    − GNU texinfo (for info files).

(Note that although the original University of Illinois DAST Iperf builds and installs on a number of operating systems, the OpenSS7 modified version only currently builds and installs on Linux.)

(Note: If you acquired iperf a part of the OpenSS7 Master Package, then the dependencies listed below will already have been met by unpacking the master package.)

  1. OpenSS7 Sockets SCTP, sctp-0.2.27. (Optional.)

When configuring and building multiple OpenSS7 Project release packages, place all of the source packages (unpacked tarballs) at the same directory level and all build directories at the same directory level (e.g. all source packages under /usr/src).

When installing packages that install as kernel modules, it is necessary to have the correct kernel development package installed. For the following distributions, use the following commands:

     Ubuntu:  $> apt-get install linux-headers
     Debian:  $> apt-get install kernel-headers
     Fedora:  $> yum install kernel-devel

You also need the same version of gcc(1) compiler with which the kernel was built. If it is not the default, add ‘CC=kgcc’ on the line after ‘./configure’, for example:

     $> ../iperf-2.0.8/configure CC='gcc-3.4'

Installation

The following commands will download, configure, build, check, install, validate, uninstall and remove the package:

     $> wget http://www.openss7.org/tarballs/iperf-2.0.8.tar.bz2
     $> tar -xjvf iperf-2.0.8.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../iperf-2.0.8/configure --enable-autotest
     $> make
     $> make check
     $> sudo make install
     $> sudo make installcheck
     $> sudo make uninstall
     $> popd
     $> sudo rm -rf build
     $> rm -rf iperf-2.0.8
     $> rm -f iperf-2.0.8.tar.bz2

If you have problems, try building with the logging targets instead. If the make of a logging target fails, an automatic problem report will be generated that can be mailed to The OpenSS7 Project.4 Installation steps using the logging targets proceed as follows:

     $> wget http://www.openss7.org/tarballs/iperf-2.0.8.tar.bz2
     $> tar -xjvf iperf-2.0.8.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../iperf-2.0.8/configure --enable-autotest
     $> make compile.log
     $> make check.log
     $> sudo make install.log
     $> sudo make installcheck.log
     $> sudo make uninstall.log
     $> popd
     $> sudo rm -rf build
     $> rm -rf iperf-2.0.8
     $> rm -f iperf-2.0.8.tar.bz2

See README-make for additional specialized make targets.

For custom applications, see the INSTALL and INSTALL-iperf files or the see Installation, as listed below. If you encounter troubles, see Troubleshooting, before issuing a bug report.

Brief Installation Instructions

The OpenSS7 IPERF Utility package is available from the downloads area of The OpenSS7 Project website using a command such as:

     $> wget http://www.openss7.org/tarballs/iperf-2.0.8.tar.bz2

Unpack the tarball using a command such as:

     $> tar -xjvf iperf-2.0.8.tar.bz2

The tarball will unpack into the relative subdirectory named after the package name: iperf-2.0.8.

The package builds using the GNU autoconf utilities and the configure script. To build the package, we recommend using a separate build directory as follows:

     $> mkdir build
     $> cd build
     $> ../iperf-2.0.8/configure

In general, the package configures and builds without adding any special options to the configure script. For general options to the configure script, see the GNU INSTALL file in the distribution:

     $> less ../iperf-2.0.8/INSTALL

For specific options to the configure script, see the INSTALL-iperf file in the distribution, or simply execute the configure script with the --help option like so:

     $> ../iperf-2.0.8/configure --help

After configuring the package, the package can be compiled simply by issuing the ‘make’ command:

     $> make

Some specialized makefile targets exists, see the README-make file in the distribution or simply invoke the ‘help’ target like so:

     $> make help | less

After successfully building the package, the package can be checked by invoking the ‘check’ make target like so:

     $> make check

After successfully checking the package, the package can be installed by invoking the ‘install’ make target (as root) like so:

     $> sudo make install

The test suites that ship with the package can be invoked after the package has been installed by invoking the ‘installcheck’ target. This target can either be invoked as root, or as a normal user, like so:

     $> make installcheck

(Note: you must add the --enable-autotest flag to configure, above for the test suites to be invoked with ‘make installcheck’.)

The package can be cleanly removed by invoking the ‘uninstall’ target (as root):

     $> sudo make uninstall

Then the build directory and tarball can be simply removed:

     $> cd ..
     $> rm -rf build
     $> rm -rf iperf-2.0.8
     $> rm -f iperf-2.0.8.tar.bz2

Detailed Installation Instructions

More detailed installation instructions can be found in the Installation, contained in the distribution in ‘text’, ‘info’, ‘html’ and ‘pdf’ formats:

     $> cd ../iperf-2.0.8
     $> less doc/manual/iperf.txt
     $> lynx doc/manual/iperf.html
     $> info doc/manual/iperf.info
     $> xpdf doc/manual/iperf.pdf

The ‘text’ version of the manual is always available in the MANUAL file in the release.

The current manual is also always available online from The OpenSS7 Project website at:

     $> lynx http://www.openss7.org/iperf_manual.html

1 Introduction

This manual documents the design, implementation, installation, operation and future development schedule of the OpenSS7 IPERF Utility package.

1.1 Overview

This manual documents the design, implementation, installation, operation and future development of the OpenSS7 IPERF Utility package.

1.2 Organization of this Manual

This manual is organized (loosely) into several sections as follows:

Introduction. This introduction
Objective. Objective of the package
Reference. Contents of the package
Conformance. Conformance of the package
Releases. Releases of the package
Installation. Installation of the package
Troubleshooting. Troubleshooting of the package

1.3 Conventions and Definitions

This manual uses texinfo typographic conventions.

2 Objective

3 Reference

3.1 Files

IPERF installs the following info files in the system info directory, /usr/share/info/:

iperf.info
iperf.info-1
iperf.info-2
iperf.info-3
iperf.info-4
These files contain this manual in GNU info format.

IPERF installs the following manunal page macros and reference database files in the system man directory, /usr/share/man/:5

iperf.macros
This file contains manual page macro definitions included by the manual pages included in the package.
iperf.refs
This file contains a reference database referenced by the manual pages included in the package.

3.2 Drivers

3.3 Modules

3.4 Libraries

3.5 Utilities

3.6 Development

4 Conformance

5 Releases

This is the OpenSS7 Release of the OpenSS7 IPERF Utility package, modified for use with OpenSS7 Stream Control Transmission Protocol (SCTP) Linux Native Kernel.

The purpose of providing a separate release of this package was to provide support for SCTP as well as providing the ability to use GNU autoconf tools for maintenance and binary RPM release of the package.

The following sections provide information on OpenSS7 IPERF Utility releases as well as compatibility information of OpenSS7 release to the original UI DAST releases of the OpenSS7 IPERF Utility package.

5.1 Prerequisites

The quickest and easiest way to ensure that all prerequisites are met is to download and install this package from within the OpenSS7 Master Package, openss7-0.9.2.G, instead of separately.

Prerequisites for the OpenSS7 IPERF Utility package are as follows:

  1. Linux distribution, somewhat Linux Standards Base compliant, with a 2.4 or 2.6 kernel and the appropriate tool chain for compiling out-of-tree kernel modules. Most recent Linux distributions are usable out of the box, but some development packages must be installed. For more information, see Compatibility.

    − A fairly LSB compliant GNU/Linux distribution.6
    − Linux 2.4 kernel (2.4.10 - 2.4.27), or
    − Linux 2.6 kernel (2.6.3 - 2.6.26);
    − glibc2 or better.
    − GNU groff (for man pages).7
    − GNU texinfo (for info files).

(Note that although the original University of Illinois DAST Iperf builds and installs on a number of operating systems, the OpenSS7 modified version only currently builds and installs on Linux.)

(Note: If you acquired iperf a part of the OpenSS7 Master Package, then the dependencies listed below will already have been met by unpacking the master package.)

  1. OpenSS7 Sockets SCTP, sctp-0.2.27. (Optional.)

If you need to rebuild the package from sources with modifications, you will need a larger GNU tool chain as described in See Downloading from CVS.

5.2 Compatibility

This section discusses compatibility with major prerequisites.

5.2.1 GNU/Linux Distributions

OpenSS7 IPERF Utility is compatible with the following Linux distributions:8

  • CentOS Enterprise Linux 3.4 (centos34) TBD
  • CentOS Enterprise Linux 4.0 (centos4) TBD
  • CentOS Enterprise Linux 4.92 (centos49) TBD
  • CentOS Enterprise Linux 5.0 (centos5)
  • CentOS Enterprise Linux 5.1 (centos51)
  • CentOS Enterprise Linux 5.2 (centos52)
  • Debian 3.0r2 Woody (deb3.0) TBD
  • Debian 3.1r0a Sarge (deb3.1) TBD
  • Debian 4.0r1 Etch (deb4.0)
  • Debian 4.0r2 Etch (deb4.0)
  • Debian 4.0r3 Etch (deb4.0)
  • Fedora Core 1 (FC1) TBD
  • Fedora Core 2 (FC2) TBD
  • Fedora Core 3 (FC3) TBD
  • Fedora Core 4 (FC4) TBD
  • Fedora Core 5 (FC5) TBD
  • Fedora Core 6 (FC6) TBD
  • Fedora 7 (FC7)
  • Fedora 8 (FC8)
  • Fedora 9 (FC9)
  • Gentoo 2006.1 (untested) TBD
  • Gentoo 2007.1 (untested) TBD
  • Lineox 4.026 (LEL4) TBD
  • Lineox 4.053 (LEL4) TBD
  • Mandrakelinux 9.2 (MDK92) TBD
  • Mandrakelinux 10.0 (MDK100) TBD
  • Mandrakelinux 10.1 (MDK101) TBD
  • Mandriva Linux LE2005 (MDK102) TBD
  • Mandriva Linux LE2006 (MDK103) TBD
  • Mandriva One (untested)
  • RedHat Linux 7.2 (RH7)
  • RedHat Linux 7.3 (RH7)
  • RedHat Linux 8.0 (RH8) TBD
  • RedHat Linux 9 (RH9) TBD
  • RedHat Enterprise Linux 3.0 (EL3) TBD
  • RedHat Enterprise Linux 4 (EL4)
  • RedHat Enterprise Linux 5 (EL5)
  • SuSE 8.0 Professional (SuSE8.0) TBD
  • SuSE 9.1 Personal (SuSE9.1) TBD
  • SuSE 9.2 Professional (SuSE9.2) TBD
  • SuSE OpenSuSE (SuSEOSS) TBD
  • SuSE 10.0 (SuSE10.0) TBD
  • SuSE 10.1 (SuSE10.1) TBD
  • SuSE 10.2 (SuSE10.2) TBD
  • SuSE 10.3 (SuSE10.3) TBD
  • SuSE 11.0 (SuSE11.0)
  • SLES 9 (SLES9) TBD
  • SLES 9 SP2 (SLES9) TBD
  • SLES 9 SP3 (SLES9) TBD
  • SLES 10 (SLES10)
  • Ubuntu 5.10 (ubu5.10) TBD
  • Ubuntu 6.03 LTS (ubu6.03) TBD
  • Ubuntu 6.10 (ubu6.10) TBD
  • Ubuntu 7.04 (ubu7.04) TBD
  • Ubuntu 7.10 (ubu7.10)
  • Ubuntu 8.04 (ubu8.04)
  • WhiteBox Enterprise Linux 3.0 (WBEL3) TBD
  • WhiteBox Enterprise Linux 4 (WBEL4) TBD

When installing from the tarball (see Installing the Tar Ball), this distribution is probably compatible with a much broader array of distributions than those listed above. These are the distributions against which the current maintainer creates and tests builds.

5.2.2 Architectures

The OpenSS7 IPERF Utility package compiles and installs on a wide range of architectures. Although it is believed that the package will work on all architectures supported by the Linux kernel being used, validation testing has only been performed with the following architectures:

  • ix86
  • x86_64
  • ppc (MPC 860)
  • ppc64

32-bit compatibility validation testing is performed on all 64-bit architectures supporting 32-bit compatibility. If you would like to validate an OpenSS7 package on a specific machine architecture, you are welcome to sponsor the project with a test machine.

5.2.3 UI Iperf

This section addresses compatibility issues between OpenSS7 and University of Illinois DAST releases of iperf.

iperf-2.0.8 and Iperf Compatibility

OpenSS7 modifications to support SCTP does not alter the data structures nor fundamental operation. New structures and test definitions have been added for SCTP that are largely consistent with those of TCP.

Specifically, an iperf-2.0 client should be able to connect and perform tests with an iperf-2.0.8 server. Also, an iperf-2.0.8 client should be able to connect and perform tests (other than SCTP) with an iperf-2.0 server.

iperf-2.0.8 and Option Compatibility

OpenSS7 releases provide all options compiled-in to the program. This obviates the need for editing makefiles and recompiling the program from source as is described in the University of Illinois DAST documentation. Additional options were provided to support SCTP.

iperf-2.0.8 and SCTP Compatibility

SCTP API tests are (likely) only compatible with the OpenSS7 Sockets implementations of SCTP. The reason for this is that the OpenSS7 Sockets implementations use the POSIX standard socket API rather than the non-standard socket API described in documents such as draft-stewart-tsvwg-sctpsocket-xx.txt.

5.3 Release Notes

The sections that follow provide information on OpenSS7 releases of the OpenSS7 IPERF Utility package as well as compatibility information of OpenSS7 releases to the original University of Illinois releases.

Major changes for release iperf-2.0.8

This is the eighth full release of the OpenSS7 IPERF Utility package. This is a stable, production grade release: it deprecates previous releases. Please upgrade to the most current release before reporting bugs.

This release is largely a maintenance release that provides support for more distributions an architectures as well as tracking feature updates on related packages (i.e. sctp-0.2.27).

Major features since the last public release are as follows:

  • Minor documentation corrections.
  • License upgrade to AGPL Version 3.
  • Support for flex 2.5.33 in maintainer mode.
  • Ability to strap out major documentation build and installation primarily for embedded targets.
  • Improvements to common build process for embedded and cross-compile targets.
  • Updated tool chain to m4-1.4.12, autoconf-2.63 and texinfo-4.13.
  • Conversion of RPM spec files to common approach for major subpackages.
  • Updated references database for manual pages and roff documents.
  • Build system now builds yum(8) repositories for RPMs and apt-get(8) repositories for DEBs. Installation documentation has been updated to include details of repository install sourcesref.
  • Added MODULE_VERSION to all modules and drivers.

This is a public stable production grade release of the package: it deprecates previous releases. Please upgrade to the current release before reporting bugs.

As with other OpenSS7 releases, this release configures, compiles, installs and builds RPMs and DEBs for a wide range of Linux 2.4 and 2.6 RPM- and DPKG-based distributions, and can be used on production kernels without patching or recompiling the kernel.

This package is publicly released under the GNU Affero General Public License Version 3 as well as the University of Illinois license (see LICENSE in the release for more information). The release is available as an autoconf tarball, SRPM, DSC, and set of binary RPMs and DEBs. See the downloads page for the autoconf tarballs, SRPMs and DSCs. For tarballs, SRPMs, DSCs and binary RPMs and DEBs, see the iperf package page.

See http://www.openss7.org/codefiles/iperf-2.0.8/ChangeLog and http://www.openss7.org/codefiles/iperf-2.0.8/NEWS in the release for more information. Also, see the iperf.pdf manual in the release (also in html http://www.openss7.org/iperf_manual.html).

For the news release, see http://www.openss7.org/rel20081029_1.html.

Major changes for release iperf-2.0.7

This is the seventh full release of the OpenSS7 IPERF Utility package. This is a stable, production grade release: it deprecates previous releases. Please upgrade to the most current release before reporting bugs.

This release is largely a maintenance release that provides support for more distributions an architectures as well as tracking feature updates on related packages (i.e. sctp-0.2.27).

Major features since the last public release are as follows:

  • Support build on openSUSE 10.2.
  • Support build on Fedora 7 with 2.6.21 kernel.
  • Support build on CentOS 5.0 (RHEL5).
  • Support build on Ubuntu 7.04.
  • Updated to gettext 0.16.1.
  • Supports build on Fedora Core 6.
  • Support for recent distributions and tool chains.

Major changes for release iperf-2.0.6

This is the sixth full release of the OpenSS7 IPERF Utility package. This is a stable, production grade release: it deprecates previous releases. Please upgrade to the most current release before reporting bugs.

This release is largely a maintenance release that provides support for more distributions an architectures as well as tracking feature updates on related packages (i.e. sctp-0.2.27).

Major features since the last public release are as follows:

  • Support for autoconf 2.61, automake 1.10 and gettext 0.16.
  • Support for Ubuntu 6.10 distribution and bug fixes for i386 kernels.
  • The package now looks for other subpackages with a version number as unpacked by separate tarball.

Major changes for release iperf-2.0.5

This is the fifth full release of the OpenSS7 IPERF Utility package. This is a stable, production grade release: it deprecates previous releases. Please upgrade to the most current release before reporting bugs.

This release is largely a maintenance release that provides support for more distributions an architectures as well as tracking feature updates on related packages (i.e. sctp-0.2.27).

Additional features include:

  • Added send-pr scripts for automatic problem report generation.
  • Added --disable-devel configure option to suppress building and installing development environment. This feature is for embedded or pure run-time targets that do not need the development environment (static libraries, manual pages, documentation).
  • Improved compiler flag generation and optimizations for recent gcc compilers and some idiosyncratic behaviour for some distributions (primarily SUSE).
  • Optimized compilation is now available also for user level programs in addition to kernel programs. Added new --with-optimize option to configure to accomplish this.
  • Better detection of SUSE distributions, release numbers and SLES distributions: support for additional SuSE distributions on ix86 as well as x86_64. Added distribution support includes SLES 9, SLES 9 SP2, SLES 9 SP3, SLES 10, SuSE 10.1.
  • Many documentation updates for all OpenSS7 packages. Automated release file generation making for vastly improved and timely text documentation present in the release directory.

Major changes for release iperf-2.0.5.rc3

Third release candidate. This is a maintenance release candidate. This release candidate includes:

  • Automated release file generation making for vastly improved and timely text documentation present in the release directory.
  • Many documentation updates for all OpenSS7 packages.
  • Changes made to the strsctp drivers at the 2006 SCTP Interop at the University of British Columbia. This version was interoperability tested with all implementations present.
  • Support for additional SuSE distributions on ix86 as well as x86_64. Added distribution support includes SLES 9, SLES 9 SP2, SLES 9 SP3, SLES 10, SuSE 10.1.
  • Better detection of SUSE distributions, release numbers and SLES distributions.
  • Optimized compilation for user level programs. New --with-optimize option to configure.
  • Now includes an Installation and Reference Manual (you are reading it).

This was an internal alpha test release candidate and was not released publicly. This release was only available to subscribers to and sponsors of the OpenSS7 Project.

Major changes for release iperf-2.0.5.rc2

Second release candidate. This is a maintenance release candidate. This release candidate includes:

  • Results of performance testing of the new second generation UDP driver (implemented completely in STREAMS instead of using an internal socket).
  • Support for SuSE 10.1.

This was an internal alpha test release candidate and was not released publicly. This release was only available to subscribers to and sponsors of the OpenSS7 Project.

Major changes for release iperf-2.0.5rc1

Release candidate for Mark Fugate. This is a maintenance release candidate. This release candidate includes:

  • Added --enable-devel configure option for embedded targets.
  • Added send-pr script for automatic problem report generation.

This was an internal alpha test release candidate and was not released publicly. This release was only available to subscribers to and sponsors of the OpenSS7 Project.

Major changes for release iperf-2.0.4

Corrections for and testing of 64-bit clean compile and test runs on x86_64 architecture. Some bug corrections resulting from gcc 4.0.2 compiler warnings.

Major changes for release iperf-2.0.3

Minor changes and bug fixes. Still remaining to do is merge in the latest upstream release of iperf.

Initial public release iperf-2.0.2

With this release version numbers were changed to reflect an upstream version only to be consistent with other OpenSS7 package releases. All RPM release numbers will be -1$(PACKAGE_RPMEXTRA) and all Debian release numbers will be _0. If you wish to apply patches and release the package, please bump up the release number and apply a suitable release suffix for your organization. We leave Debian release number _1 reserved for your use, so you can still bundle the source in the .dsc file.

Initial release iperf-2.0.1-1

Initial autoconf/rpm packaging release of Iperf.

This is an autoconf/rpm release of Iperf suitable for use with OpenSS7 Linux Native SCTP (Stream Control Transmission Protocol). It is usable for performance testing the SCTP application as well as supporting all other Iperf TCP and UDP testing.

Not publicly released.

5.4 Maturity

The OpenSS7 Project adheres to the following release philosophy:

  • pre-alpha release
  • alpha release
  • beta release
  • gamma release
  • production release
  • unstable release

5.4.1 Pre-Alpha Releases

Pre-alpha releases are releases that have received no testing whatsoever. Code in the release is not even known to configure or compile. The purpose of a pre-alpha release is to make code and documentation available for inspection only, and to solicit comments on the design approach or other characteristics of the software package.

Pre-alpha release packages ship containing warnings recommending that the user not even execute the contained code.

5.4.2 Alpha Releases

Alpha releases are releases that have received little to no testing, or that have been tested and contains known bugs or defects that make the package unsuitable even for testing. The purpose for an alpha release are the same as for the pre-alpha release, with the additional purpose that it is an early release of partially functional code that has problems that an external developer might be willing to fix themselves and contribute back to the project.

Alpha release packages ship containing warnings that executing the code can crash machines and might possibly do damage to systems upon which it is executed.

5.4.3 Beta Releases

Beta releases are releases that have received some testing, but the testing to date is not exhaustive. Beta release packages do not ship with known defects. All known defects are resolved before distribution; however, as exhaustive testing has not been performed, unknown defects may exist. The purpose for a beta release is to provide a baseline for other organizations to participate in the rigorous testing of the package.

Beta release packages ship containing warnings that the package has not been exhaustively tested and that the package may cause systems to crash. Suitability of software in this category for production use is not advised by the project; however, as always, is at the discretion of the user of the software.

5.4.4 Gamma Releases

Gamma releases are releases that have received exhaustive testing within the project, but external testing has been minimal. Gamma release packages do not ship with known defects. As exhaustive internal testing has been performed, unknown defects should be few. Please remember that there is NO WARRANTY on public release packages.

Gamma release packages typically resolve problems in previous beta releases, and might not have had full regression testing performed. Suitability of software in this category for production use is at the discretion of the user of the software. The OpenSS7 Project recommends that the complete validation test suites provided with the package be performed and pass on target systems before considering production use.

5.4.5 Production Releases

Production releases are releases that have received exhaustive testing within the project and validated on specific distributions and architectures. Production release packages do not ship with known defects. Please remember that there is NO WARRANTY on public release packages.

Production packages ship containing a list of validated distributions and architectures. Full regression testing of any maintenance changes is performed. Suitability of software in this category for production use on the specified target distributions and architectures is at the discretion of the user. It should not be necessary to preform validation tests on the set of supported target systems before considering production use.

5.4.6 Unstable Releases

Unstable releases are releases that have received extensive testing within the project and validated on a a wide range of distributions and architectures; however, is has tested unstable and found to be suffering from critical problems and issues that cannot be resolved. Maintenance of the package has proved impossible. Unstable release packages ship with known defects (and loud warnings). Suitability of software in this category for production use is at the discretion of the user of the software. The OpenSS7 Project recommends that the problems and issues be closely examined before this software is used even in a non-production environment. Each failing test scenario should be completely avoided by the application. OpenSS7 beta software is more stable that software in this category.

5.5 Bugs

5.5.1 Defect Notices

OpenSS7 IPERF Utility could contain unknown defects. This is a beta release. Some defects could be harmful. Validation testing has been performed by the OpenSS7 Project on this software for only a restricted set of systems. The software might fail to configure or compile on other systems. The OpenSS7 Project recommends that you do not use this software for purposes other than validation testing and evaluation, and then only with care. Use at your own risk. Remember that there is NO WARRANTY.9

This software is beta software. As such, it might crash your kernel. Installation of the software might mangle your header files or Linux distribution in such a way as to make it unusable. Crashes could lock your system and rebooting the system might not repair the problem. You can possibly lose all the data on your system. Because this software might crash your kernel, the resulting unstable system could possibly destroy computer hardware or peripherals making them unusable. You might void the warranty on any system on which you run this software. YOU HAVE BEEN WARNED.

5.5.2 Known Defects

With the exception of packages not originally created by the OpenSS7 Project, the OpenSS7 Project software does not ship with known bugs in any release stage except pre-alpha. OpenSS7 IPERF Utility had no known bugs at the time of release.

Nevertheless, the OpenSS7 Project does not validate the OpenSS7 IPERF Utility package, but simply uses it for benchmark performance testing. Following are some of the expected difficulties with the package that have not yet been discovered:

  1. No bug fixes from the original Iperf development stream have been rolled back into this release. Therefore, any bugs reported on the regular Iperf release package probably still exist unfixed in this release package.

5.5.3 Defect History

This section contains historical bugs that were encountered during development and their resolutions. This list serves two purposes:

  1. It captures bugs encountered between releases during development that could possibly reoccur (and the Moon is made of blue cheese). It therefore provides a place for users to look if they encounter a problem.
  2. It provides a low overhead bug list between releases for developers to use as a TODO list.
Bugs
(no items)

5.6 Schedule

Current Plan

There is no current plan for the iperf package beyond minor distribution maintenance. The package tests the OpenSS7 Linux Native Sockets version of sctp (‘sctp’ package) nicely, but that package only runs on 2.4 kernels. When the strsock package is complete for Linux Fast-STREAMS, the OpenSS7 Project will likely haul this back out and use it for testing the STREAMS versions of UDP, TCP and SCTP using the socklib interface. But, the strsock package completion itself is not planned, so you can only likely expect maintenance releases of this package. The package could be extended to test lksctp as well, however, comparisons between lksctp and sctp can only be done on 2.4 kernels for now. This type of work has been mooted by the current popularity of 2.6 kernels.

Things to Do
  • Write a texinfo manual for Iperf.

    *done*

    You are reading it.

  • Merge upstream changes from the latest University of Illinois release of the Iperf package into the OpenSS7 Modified version. It would really like to do this but don't have the time for it right now. If someone is willing to dive in and give this a try, send me the patches.
  • Iperf is capable of performing performance testing on lksctp as well. I would like to modify the OpenSS7 version of Iperf to support both so that performance comparison testing can be done between lkstcp (which sucks of course) and OpenSS7.

5.7 History

For the latest developments with regard to history of changes, please see the ChangeLog file in the release package.

6 Installation

6.1 Repositories

The OpenSS7 IPERF Utility package release can be accessed from the repositories of The OpenSS7 Project. For rpm(1) based systems, the package is available in a yum(8) repository based on repomd XML and may also be accessed using zypper(8) or yast(8). For dpkg(1) based systems, the package is available in a apt(8) repository.

By far the easiest (most repeatable and manageable) form for installing and using OpenSS7 packages is to install packages from the yum(8) or apt(8) repositories. If your distribution does not support yum(8), zypper(8), yast(8) or apt(8), then it is still possible to install the RPMs or DEBs from the repositories using rpm(1), dpkg(1); or by using wget(1) and then installing them from RPM or DEB using rpm(1) or dpkg(1) locally.

If binaries are not available for your distribution or specific kernel, but your distribution supports rpm(1) or dpkg(1), the next best method for installing and using OpenSS7 packages is to download and rebuild the source RPMs or DSCs from the repository. This can also be performed with yum(8), zypper(8), yast(8), apt(8); or directly using wget(1), rpm(1) or dpkg(1).

If your architecture does not support rpm(1) or dpkg(1) at all, or you have special needs (such as cross-compiling for embedded targets), the final resort method is to download, configure, build and install from tarball. In this later case, the easiest way to build and install OpenSS7 packages from tarball is to use the tarball for the OpenSS7 Master Package, openss7-0.9.2.G.

6.1.1 Repositories for YUM

To install or upgrade from the OpenSS7 repomd repositories, you will need a file in your /etc/yum.repo.d/ directory. This file can be obtained directly from the OpenSS7 repository, like so:

     $> REPOS="http://www.openss7.org/repos/rpms"
     $> wget $REPOS/centos/5.2/x86_64/repodata/openss7.repo
     $> sudo cp -f openss7.repo /etc/yum.repo.d/
     $> sudo yum makecache

This example assumes the the distribution is ‘centos’ and the distribution release is ‘5.2’ and the architecture requires is ‘x86_64’. Another example would be $REPOS/i686/suse/11.0/i686/repodata/openss7.repo, for using yum(8) with SUSE.

Once the repository is set up, OpenSS7 includes a number of virtual package definitions that eas the installation and removal of kernel modules, libraries and utilities. Downloading, configuring, building and installation for a single-kernel distribution is as easy as:

     $> sudo yum install iperf

Removing the package is as easy as:

     $> sudo yum remove iperf

If you have difficulty downloading the openss7.repo file, edit the following information into the file and place it into the /etc/yum.repo.d/openss7.repo file:

     -| [openss7]
     -| enabled = 1
     -| name = OpenSS7 Repository
     -| baseurl = http://www.openss7.org/repos/rpms/centos/5.2/x86_64
     -| gpgcheck = 1
     -| gpgkey = http://www.openss7.org/pubkey.asc

Note that it is also possible to point to these repositories as an additional installation source when installing CentOS, RedHat, Fedora, or others. You will have an additional STREAMS category from which to choose installation packages.

Some additional installation real or virtual package names and the installations they accomplish are as follows:

iperf
This package can be used to install or remove the entire OpenSS7 IPERF Utility package. When installing, kernel modules will be installed automatically for the highest version kernel on your system. When removing, all corresponding kernel modules will also be removed.
iperf-devel
This package can be used to install or remove the development components of the OpenSS7 IPERF Utility package. When installing, ‘iperf’ and appropriate kernel module and kernel module development and debug packages will also be installed. When removing, the development package and all kernel module development and debug packages will also be removed.
iperf-2.4.20-28.7
This package can be used to install or remove the package for a specific kernel version. When installing, the ‘iperf’ package will also be installed if necessary. When removing the last kernel module package, the ‘iperf’ package will also be removed.

Note that the version ‘2.4.20-28.7’ is just an example. Use the version returned by ‘$(uname -r)’ for the kernel for which you wish to install or remove the packages.

iperf-2.4.20-28.7-devel
This package can be used to install or remove the development and debug packages for a specific kernel version. When installing, the ‘iperf’ and ‘iperf-devel’ packages will also be installed if necessary. When removing the development and debug for kernel modules for the last kernel, the ‘iperf-devel’ package will also be removed.

Note that the version ‘2.4.20-28.7’ is just an example. Use the version returned by ‘$(uname -r)’ for the kernel for which you wish to install or remove the packages.

For assistance with specific RPMs, see Downloading the Binary RPM.

6.1.2 Repositories for APT

For assistance with specific DEBs, see Downloading the Debian DEB.

6.2 Downloading

The OpenSS7 IPERF Utility package releases can be downloaded from the downloads page of The OpenSS7 Project. The package is available as a binary RPM (for popular architectures) a source RPM, Debian binary DEB and source DSC, or as a tar ball. If you are using a browsable viewer, you can obtain the OpenSS7 release of Iperf from the links in the sections that follow.

By far the easiest (most repeatable and manageable) form for installing and using OpenSS7 packages is to download and install individual packages from binary RPM or DEB. If binary RPMs or DEBs are not available for your distribution, but your distribution supports rpm(1) or dpkg(1), the next best method for installing and using OpenSS7 packages is to download and rebuild the source RPMs or DSCs.

If your architecture does not support rpm(1) or dpkg(1) at all, or you have special needs (such as cross-compiling for embedded targets), the final resort method is to download, configure, build and install from tarball. In this later case, the easiest way to build and install OpenSS7 packages from tarball is to use the tarball for the OpenSS7 Master Package, openss7-0.9.2.G.

6.2.1 Downloading with YUM

OpenSS7 repositories support yum(8) and zypper(8) in repomd XML format as well as YaST and YaST2 formats.

OpenSS7 includes virtual packages that ease the installation and removal of kernel modules, libraries and utilities. Downloading, configuration, building and installation for a signle-kernel distribution installation is as easy as:

     % sudo yum install iperf

This and additional packages for installation are detailed as follows:

iperf
Install this package if you need the runtime iperf package.
          % sudo yum install iperf

This will install the iperf, iperf-lib and iperf-KVERSION RPMs, where ‘KVERSION’ is the highest version number kernel on your system.

Remove this package if you need to remove all vestages of the iperf package.

          % sudo yum remove iperf

This will remove the iperf, iperf-lib, iperf-devel, iperf-KVERSION and iperf-devel-KVERSION RPMs for all kernels on your system.

iperf-devel
Install this package if you need the development iperf package.
          % sudo yum install iperf-devel

This will install the iperf, iperf-lib, iperf-devel, iperf-KVERSION and iperf-devel-KVERSION RPMs, where ‘KVERSION’ is the highest version number kernel on your system.

Remove this package if you do not need development capabilities for the iperf package for any kernel.

          % sudo yum remove iperf-devel

This will remove the iperf-devel and iperf-devel-KVERSION RPMs for all kernels on your system.

iperf-2.4.20-28.7
Install this package if you need the runtime iperf for kernel version ‘2.4.20-28.7’. The value ‘2.4.20-28.7’ is just an example. For the running kernel, you can install the runtime iperf components with:
          % sudo yum install iperf-$(uname -r)

This will install the iperf, iperf-lib and iperf-2.4.20-28.7 RPMs, where ‘2.4.20-28.7’ is the kernel version specified.

Remove this package if you no longer need the runtime iperf for kernel version ‘2.4.20-28.7’. The value ‘2.4.20-28.7’ is just an example. For the running kernel, you can remove the runtime iperf components with:

          % sudo yum remove iperf-$(uname -r)

This will remove the iperf-2.4.20-28.7 and iperf-devel-2.4.20-28.7 RPMs, where ‘2.4.20-28.7’ is the kernel version specified. Also, if this is the last kernel for which iperf was installed, the iperf iperf-lib and iperf-devel RPMs will also be removed.

Note that this is a virtual package name: the actual RPMs installed or removed from the system is a kernel module package whose precise name will depend upon the system being used.

iperf-devel-2.4.20-28.7
Install this package if you need the development iperf package for kernel version ‘2.4.20-28.7’. The value ‘2.4.20-28.7’ is just an example. For the running kernel, you can install the kernel development iperf components with:
          % sudo yum install iperf-devel-$(uname -r)

This will install the iperf, iperf-lib, iperf-devel, iperf-2.4.20-28.7 and iperf-devel-2.4.20-28.7 RPMs, where ‘2.4.20-28.7’ is the kernel version specified.

Remove this package if you no longer need the development capabilities for the iperf package for kernel version ‘2.4.20-28.7’. The value ‘2.4.20-28.7’ is just an example. For the running kernel, you can remove the kernel development iperf components with:

          % sudo yum remove iperf-devel-$(uname -r)

This will remove the iperf-devel-2.4.20-28.7 RPMs, where ‘2.4.20-28.7’ is the kernel version specified. Also, if this is the last kernel for which iperf was installed, the iperf-devel RPMs will also be removed.

Note that this is a virtual package name: the actual RPMs installed or removed from the system is a kernel module package whose precise name will depend upon the system being used.

iperf-lib
This package is an auxillary package that should be removed and inserted automatically by yum(8). In rare instances you might need to remove or install this package explicitly.

6.2.2 Downloading with APT

OpenSS7 repositries support apt(8) repositorie digests and signatures.

6.2.3 Downloading the Binary RPM

To install from binary RPM, you will need several of the RPM for a complete installation. Binary RPM fall into several categories. To download and install a complete package requires the appropriate RPM from each of the several categories below, as applicable. Some release packages do not provide RPMs in each of the several categories.

To install from Binary RPM, you will need all of the following independent packages for your architecture.

Independent RPM

Independent RPM are not dependent on either the Linux kernel version, or the STREAMS package. For example, the source package ‘iperf-source-2.0.8-1.7.2.noarch.rpm’, is not dependent on kernel nor STREAMS package.

All of the following independent RPM are required for your architecture. Binary RPMs listed here are for example only: additional binary RPMs are available from the downloads site. If your architecture is not available, you can build binary RPM from the source RPM (see see Building from the Source RPM).

Architecture Independent
iperf-doc-2.0.8-1.7.2.noarch.rpm
The iperf-doc package contains this manual in plain text, postscript, pdf and html forms, along with the meta-information from the Iperf package. It also contains all of the manual pages necessary for developing OpenSS7 IPERF Utility applications and OpenSS7 IPERF Utility STREAMS modules or drivers.
iperf-source-2.0.8-1.7.2.noarch.rpm
The iperf-source package contains the source code necessary for building the OpenSS7 IPERF Utility release. It includes the autoconf(1) configuration utilities necessary to create and distribute tarballs, rpm and deb/dsc. 10
Architecture Dependent

The following Architecture Dependent packages are required for your architecture. If your architecture is not on the list, you can build binary RPM from the source RPM (see see Building from the Source RPM).

iperf-openss7-2.0.8-1.7.2.i686.rpm
The iperf-openss7 package contains the iperf(1) program compiled to work with the OpenSS7 Linux Native Sockets version of SCTP.
iperf-devel-2.0.8-1.7.2.i686.rpm
The iperf-devel package contains library archives for static compilation, header files to develop OpenSS7 IPERF Utility modules and drivers. This also includes the header files and static libraries required to compile OpenSS7 IPERF Utility applications programs.
iperf-lib-2.0.8-1.7.2.i686.rpm
The iperf-lib package contains the run-time shared libraries necessary to run application programs and utilities developed for the Iperf package. 11
Configuration and Installation

To configure, build and install the binary RPM, See Configuring the Binary RPM.

6.2.4 Downloading the Debian DEB

To install from binary DEB, you will need several of the DEB for a complete installation. Binary DEB fall into several categories. To download and install a complete package requires the appropriate DEB from each of the several categories below, as applicable. Some release packages do not provide DEBs in each of the several categories.

To install from Binary DEB, you will need all of the following independent packages for your architecture.

Independent DEB

Independent DEB are dependent on neither the Linux kernel version, nor the STREAMS package. For example, the source package ‘iperf-source_2.0.8-0_i386.deb’, is not dependent on kernel nor STREAMS package.

All of the following independent DEB are required for your architecture. Binary DEBs listed here are for example only: additional binary DEBs are available from the downloads site. If your architecture is not available, you can build binary DEB from the Debian DSC (see see Building from the Debian DSC).

Architecture Independent
iperf-doc_2.0.8-0_all.deb
The iperf-doc package contains this manual in plain text, postscript, pdf and html forms, along with the meta-information from the Iperf package. It also contains all of the manual pages necessary for developing OpenSS7 IPERF Utility applications and OpenSS7 IPERF Utility STREAMS modules or drivers.
iperf-source_2.0.8-0_all.deb
The iperf-source package contains the source code necessary for building the OpenSS7 IPERF Utility release. It includes the autoconf(1) configuration utilities necessary to create and distribute tarballs, rpms and deb/dscs. 12
Architecture Dependent

The following Architecture Dependent packages are required for your architecture. If your architecture is not on the list, you can build binary DEB from the Debian DSC (see see Building from the Debian DSC).

iperf-openss7_2.0.8-0_i386.deb
The iperf-openss7 package contains the iperf(1) program compiled to work with the OpenSS7 Linux Native Sockets version of SCTP.
iperf-devel_2.0.8-0_i386.deb
The iperf-devel package contains library archives for static compilation, header files to develop OpenSS7 IPERF Utility modules and drivers. This also includes the header files and static libraries required to compile OpenSS7 IPERF Utility applications programs.
iperf-lib_2.0.8-0_i386.deb
The iperf-lib package contains the run-time shared libraries necessary to run application programs and utilities developed for the Iperf package. 13
Configuration and Installation

To configure, build and install the Debian DEB, See Configuring the Debian DEB.

6.2.5 Downloading the Source RPM

If you cannot obtain a binary RPM for your architecture, or would like to roll you own binary RPM, download the following source RPM.

iperf-2.0.8-1.src.rpm
This is the source RPM for the package. From this source RPM it is possible to build binary RPM for any supported architecture and for any 2.4 kernel.
Configuration

To configure the source RPM, See Configuring the Source RPM.

6.2.6 Downloading the Debian DSC

If you cannot obtain a binary DEB for your architecture, or would like to roll your own DEB, download the following Debian DSC.

iperf_2.0.8-0.dsc
iperf_2.0.8-0.tar.gz
This is the Debian DSC for the package. From this Debian DSC it is possible to build binary DEB for any supported architecture and for any 2.4 kernel.
Configuration

To configure the source RPM, See Configuring the Debian DSC.

6.2.7 Downloading the Tar Ball

For non-rpm(1) and non-dpkg(1) architectures, download the tarball as follows:

iperf-2.0.8.tar.gz
iperf-2.0.8.tar.bz2
These are the tar(1) balls for the release. These tar(1) balls contain the autoconf(1) distribution which includes all the source necessary for building and installing the package. These tarballs will even build Source RPM and Binary RPM on rpm(1) architectures and Debian DSC and DEB on dpkg(1) architectures.

The tar ball may be downloaded easily with wget(1) as follows:

     % wget http://www.openss7.org/iperf-2.0.8.tar.bz2

or

     % wget http://www.openss7.org/iperf-2.0.8.tar.gz

Note that you will need an OpenSS7 Project user name and password to download release candidates (which are only available to subscribers and sponsors of the OpenSS7 Project).

Unpacking the Archive

After downloading one of the tar balls, unpack the archive using one of the following commands:

     % wget http://www.openss7.org/iperf-2.0.8.tar.gz
     % tar -xzvf iperf-2.0.8.tar.gz

or

     % wget http://www.openss7.org/iperf-2.0.8.tar.bz2
     % tar -xjvf iperf-2.0.8.tar.bz2

Either will create a subdirectory name iperf-2.0.8 containing all of the files and subdirectories for the Iperf package.

Configuration

To configure and install the tar ball, See Configuring the Tar Ball.

6.2.8 Downloading from CVS

If you are a subscriber or sponsor of The OpenSS7 Project with CVS archive access privileges then you can download release, mid-release or release candidate versions of the Iperf package from the project CVS archive.

The OpenSS7 IPERF Utility package is located in the iperf module of /var/cvs. For release tag information, see Releases.

To access the archive from the project CVS pserver, use the following commands to check out a version from the archive:

     % export CVSROOT='-d:pserver:username@cvs.openss7.com:2401/var/cvs'
     % cvs login
     Password: *********
     % cvs co -r iperf_2.0.8 iperf
     % cvs logout

It is, of course, possible to check out by date or by other criteria. For more information, see cvs(1).

Preparing the CVS Working Directory

Although public releases of the Iperf package do not require reconfiguration, creating a configurable directory from the CVS archive requires tools not normally distributed with the other releases.

The build host requires the following GNU tools:

  • m4 1.4.12
  • autoconf 2.63
  • automake 1.10.1
  • libtool 2.2.4
  • gettext 0.17
  • flex 2.5.33
  • bison 2.3

Most desktop development GNU/Linux distributions wil have these tools; however, some non-development or server-style installations might not and they must be installed separately.14

Also, these tools can be acquired from the FSF website in the free software directory, and also at the following locations:

It should be stressed that, in particular, the autoconf(1), and automake(1), must be at version releases 2.63 and 1.10.1. The versions normally distributed in some mainstream GNU/Linux distributions are, in fact, much older than these versions.15 GNU version of these packages configured and installed to default directories will install in /usr/local/ allowing them to coexist with distribution installed versions.

For building documentation, the build host also requires the following documentation tools:

  • gs 6.51 or ghostscript 6.51, or newer.
  • tetex 3.0 or texlive 2007, or newer.
  • texinfo 4.13a or newer.
  • transfig 3.2.3d or newer.
  • imagemagick 5.3.8 or ImageMagick 5.3.8, or newer.
  • groff 1.17.2 or newer.
  • gnuplot 3.7 or newer.
  • latex2html 1.62 or newer.

Most desktop GNU/Linux distributions will have these tools; however, some server-style installations (e.g. Ubuntu-server, SLES 9 or Fedora 6 or 7) will not and they must be installed separately.16

Note that texinfo 4.12 must not be used as it breaks the build process.

For uncooked manual pages, the entire groff(1) package is required on Debian and Ubuntu systems (the base package does not include grefer(1) which is used extensively by uncooked manual pages). The following will get what you need:

     Debian: % apt-get install groff_ext
     Ubuntu: % apt-get install groff

In addition, the build host requires a complete tool chain for compiling for the target host.

If you wish to package rpms on an rpm(1) system, or debs on a dpkg(1) system, you will need the appropriate tool chain. Systems based on rpm(1) typically have the necessary tool chain available, however, dpkg(1) systems do not. The following on a Debian or Ubuntu system will get what you need:

     % apt-get install debhelper
     % apt-get install fakeroot

To generate a configuration script and the necessary scriptlets required by the GNU autoconf(1) system, execute the following commands on the working directory:

     % autoreconf -fiv iperf

where, iperf is the name of the directory to where the working copy was checked out under the previous step. This command generates the configure script and other missing pieces that are normally distributed with the release Tar Balls, SRPMs and DSCs.

Make sure that ‘autoreconf --version’ returns ‘2.63’. Otherwise, you may need to perform something like the following:

     % PATH="/usr/local/bin:$PATH"
     % autoreconf -fiv iperf

After reconfiguring the directory, the package can then be configured and built using the same instructions as are used for the Tar Ball, see Configuring the Tar Ball, and Building from the Tar Ball.

Do note, however, that make(1) will rebuild the documentation that is normally released with the package. Additional tools may be necessary for building the documentation. To avoid building and installing the documentation, use the --disable-devel or --disable-docs option to configure described in Configuring the Tar Ball.

When configuring the package in a working directory and while working a change-compile-test cycle that involves configuration macros or documentation, I find it of great advantage to invoke the GNU configure options --enable-maintainer-mode, --enable-dependency-tracking and --disable-devel. The first of these three options will add maintainer-specific targets to any generated Makefile, the second option will invoke automatic dependency tracking within the Makefile so rebuilds after changes to macro, source or documentation files will be automatically rebuilt; and the last option will suppress rebuilding and reinstalling documentation manual pages and header files. Header files will still be available under the /usr/src directory.

6.3 Configuration

6.3.1 Configuring the Binary RPM

In general the binary RPM do not require any configuration, however, during installation it is possible to relocate some of the installation directories. This allows some degree of customization. Relocations that are available on the binary RPM are as follows:

iperf-devel-2.0.8-1.7.2.i686.rpm
/usr/lib
This relocatable directory contains iperf libraries.
/usr/include/iperf
This relocatable directory contains iperf header files.

iperf-doc-2.0.8-1.7.2.i686.rpm
/usr/share/doc
This relocatable directory contains all package specific documentation (including this manual). The subdirectory in this directory is the iperf-2.0.8 directory.
/usr/share/info
This relocatable directory contains info files (including the info version of this manual).
/usr/share/man
This relocatable directory contains manual pages.

iperf-lib-2.0.8-1.7.2.i686.rpm
/usr/lib
This relocatable directory contains the run-time shared libraries necessary to run applications programs and utilities developed for OpenSS7 IPERF Utility.
/usr/share/locale
This relocatable directory contains the locale information for shared library files.

iperf-source-2.0.8-1.7.2.i686.rpm
/usr/src
This relocatable directory contains the source code.

iperf-openss7-2.0.8-1.7.2.i686.rpm
/usr/bin
This relocatable directory contains binary programs and utilities.
Installation

To install the binary RPM, See Installing the Binary RPM.

6.3.2 Configuring the Debian DEB

In general the binary DEB do not require any configuration.

Installation

To install the Debian DEB, See Installing the Debian DEB.

6.3.3 Configuring the Source RPM

When building from the source RPM (see Building from the Source RPM), the rebuild process uses a number of macros from the user's .rpmmacros file as described in rpm(8).

Following is an example of the ~/.rpmmacros file that I use for rebuilding RPMS:

     #
     # RPM macros for building rpms
     #
     
     %vendor OpenSS7 Corporation
     %distribution OpenSS7
     %disturl http://www.openss7.org/
     %packager Brian Bidulock <bidulock@openss7.org>
     %url http://www.openss7.org/
     
     %_signature gpg
     %_gpg_path /home/brian/.gnupg
     %_gpg_name openss7@openss7.org
     %_gpgbin /usr/bin/gpg
     
     %_source_payload w9.bzdio
     %_binary_payload w9.bzdio
     
     %_unpackaged_files_terminate_build 1
     %_missing_doc_files_terminate_build 1
     %_use_internal_dependency_generator 0
     %_repackage_all_erasures 0
     %_rollback_transaction_on_failure 0
     
     %configure2_5x %configure
     %make make
     

When building from the source RPM (see Building from the Source RPM), it is possible to pass a number of additional configuration options to the rpmbuild(1) process.

The additional configuration options are described below.

Note that distributions that use older versions of rpm do not have the --with or --without options defined. To achieve the same effect as:

     --with someparm=somearg

do:

     --define "_with_someparm --with-someparm=somearg"

This is a generic description of common rpmbuild(1) options. Not all rpmbuild(1) options are applicable to all SRPMs.

--with checks
--without checks
Enable or disable preinstall checks. Each packages supports a number of preinstall checks that can be performed by invoking the ‘check’ target with automake(1). These currently consist of checking each kernel module for unresolved kernel symbols, checking for documentation for exported kernel module symbols, checking for documentation for exported library symbols, checking for standard options for build and installable programs, checking for documentation for built and installable programs. Normally these checks are only run in maintainer mode, but can be enabled and disabled with this option.
--with cooked-manpages
--without cooked-manpages
Some systems do not like grefer(1) references in manual pages.17 This option will cook soelim(1), refer(1), tbl(1) and pic(1) commands from the manual pages and also strip groff(1) comments. The default is to leave manual pages uncooked: they are actually smaller that way.
--with public
--without public
Release public packages or private packages. This option has no effect on the Iperf package. The default is to release public packages.
--with devel
--without devel
Specifies whether to build development environment packages such as those that include header files, static libraries, manual pages and texinfo(1) documentation. The default is to build development environment packages. This option can be useful when building for an embedded target where only the runtime components are desired.
--with docs
--without docs
Specifies whether to build and install major documentation such manual pages and texinfo(1) documentation. The default is to build and install documentation. This option can be useful when building for an embedded target where only the runtime and static compile components are desired, but not major documentation. This option does not override the setting of --without devel.

In addition, the following rpm options, specific to the OpenSS7 IPERF Utility package are available:

--without ipv6
--with ipv6
Disable ipv6 support. This option defaults to auto detection.
--without multicast
--with multicast
Disable multicast support. This option defaults to auto detection.
--without threads
--with threads
Disable thread support. This option defaults to auto detection.
--without web100
--with web100
Disable web100 support. This option defaults to auto detection.

In general, the default values of these options are sufficient for most purposes and no options need be provided when rebuilding the Source RPMs.

Build

To build from the source RPM, See Building from the Source RPM.

6.3.4 Configuring the Debian DSC

The Debian DSC can be configured by passing options in the environment variable BUILD_DEBOPTIONS. The options placed in this variable take the same form as those passed to the configure script, See Configuring the Tar Ball. For an example, See Building from the Debian DSC.

Build

To build from the Debian DSC, See Building from the Debian DSC.

6.3.5 Configuring the Tar Ball

All of the normal GNU autoconf(1) configuration options and environment variables apply. Additional options and environment variables are provided to tailor or customize the build and are described below.

6.3.5.1 Configure Options

This is a generic description of common configure options that are in addition to those provided by autoconf(1), automake(1), libtool(1) and gettext(1).

Not all configure options are applicable to all release packages.

Following are the additional configure options, their meaning and use:

--enable-checks
--disable-checks
Enable or disable preinstall checks. Each release package supports a number of preinstall checks that can be performed by invoking the ‘check’ target with make(1). These currently consist of checking each kernel module for unresolved kernel symbols, checking for documentation for exported kernel module symbols, checking for documentation for exported library symbols, checking for standard options for build and installable programs, checking for documentation for built and installable programs. Normally these checks are only run in maintainer mode, but can be enabled and disabled with this option.
--disable-compress-manpages
Compress manual pages with ‘gzip -9’ or ‘bzip2 -9’ or leave them uncompressed. The default is to compress manual pages with ‘gzip -9’ or ‘bzip2 -9’ if a single compressed manual page exists in the target installation directory (--mandir). This disables automatic compression.
--disable-public
Disable public release. This option is not usable on public releases and only has a usable effect on OpenSS7 IPERF Utility when the package is acquired from CVS. In particular, the STREAMS SS7/VoIP/ISDN/SIGTRAN Stacks (strss7-0.9a.8) release package has a large number of non-public components. Specifying this option will cause the package to build and install all private release components in addition to the public release components. This option affects all release packages. Most release packages do not have private release components.
--disable-devel
Disables the installation of development environment components such as header files, static libraries, manual pages and texinfo(1) documentation. The default is to install development environment components. This option can be useful when configuring for an embedded target where only the runtime components are desired, or when performing a edit-compile-test cycle.
--disable-docs
Disables the build and installation of major documentation such manual pages and texinfo(1) documentation. The default is to build and install documentation. This option can be useful when building for an embedded target where only the runtime and static compile components are desired, but not major documentation. This option does not override the setting of --disable-devel.
--enable-arch
Specifies whether architectural dependent package components are to be built and installed. This option can be useful when rebuilding for multiple architectures and target kernels, particularly under dpkg(1). The default is to configure, build and install architecture dependent package components. This option has no effect for release packages that do not provide architecture dependent components.
--enable-indep
Specifies whether architecture independent package components are to be built and installed. This option can be useful when rebuilding for multiple architectures and target kernels, particularly under dpkg(1). The default is to configure, build and install architecture independent package components. This options has no effect for release packages that do not provide architecture independent components.
--with-gpg-user=GNUPGUSER
Specify the gpg(1)GNUPGUSER’ for signing RPMs and tarballs. The default is the content of the environment variable GNUPGUSER. If unspecified, the gpg(1) program will normally use the user name of the account invoking the gpg(1) program. For building source RPMs, the RPM macro ‘_gpg_name’ will override this setting.
--with-gpg-home=GNUPGHOME
Specify the ‘GNUPGHOME’ directory for signing RPMs and tarballs. The default is the user's ~/.gpg directory. For building source RPMs, the RPM macro ‘_gpg_path’ will override this setting.
--with-pkg-epoch=EPOCH
Specifies the epoch for the package. This is neither used for rpm(1) nor dpkg(1) packages, it applies to the tarball release as a whole. The default is the contents of the .pkgepoch file in the release package source directory or, if that file does not exist, zero (0).
--with-pkg-release=RELEASE
Specifies the release for the package. This is neither used for rpm(1) nor dpkg(1) packages, it applies to the tarball release as a whole. The default is the contents of the .pkgrelease file in the release package source directory or, if that file does not exist, one (1). This is the number after the last point in the package version number.
--with-pkg-distdir=DIR
Specifies the distribution directory for the package. This is used by the maintainer for building distributions of tarballs. This is the directory into which archives are copied for distribution. The default is the top build directory.
--with-cooked-manpages
Convert manual pages to remove macro dependencies and grefer(1) references. Some systems do not like grefer(1) references in manual pages.18 This option will cook soelim(1), refer(1), tbl(1) and pic(1) commands from the manual pages and also strip groff(1) comments. The default is to leave manual pages uncooked (they are actually smaller that way).
--with-rpm-epoch=PACKAGE_EPOCH
Specify the ‘PACKAGE_EPOCH’ for the RPM spec file. The default is to use the RPM epoch contained in the release package file .rpmepoch.
--with-rpm-release=PACKAGE_RPMRELEASE
Specify the ‘PACKAGE_RPMRELEASE’ for the RPM spec file. The default is to use the RPM release contained in the release package file .rpmrelease.
--with-rpm-extra=PACKAGE_RPMEXTRA
Specify the ‘PACKAGE_RPMEXTRA’ extra release information for the RPM spec file. The default is to use the RPM extra release information contained in the release package file .rpmextra. Otherwise, this value will be determined from automatic detection of the RPM distribution.
--with-rpm-topdir=PACKAGE_RPMTOPDIR
Specify the ‘PACKAGE_RPMTOPDIR’ top directory for RPMs. If specified with a null ‘PACKAGE_RPMTOPDIR’, the default directory for the RPM distribution will be used. If this option is not provided on the command line, the top build directory will be used as the RPM top directory as well.
--with-deb-epoch=EPOCH
Specify the ‘PACKAGE_DEBEPOCH’ for the DEB control file. The default is to use the DEB epoch contained in the release package file .debepoch.
--with-deb-release=RELEASE
Specify the ‘PACKAGE_DEBRELEASE’ for the DEB control file. The default is to use the DEB release contained in the release package file .debrelease.
--with-deb-topdir=DIR
Specify the ‘PACKAGE_DEBTOPDIR’ top directory for DEBs. If specified with a null ‘PACKAGE_DEBTOPDIR’, the default directory for the DEB distribution will be used. If this option is not provided on the command line, the top build directory will be used as the DEB top directory as well.

In addition, the following configure options, specific to the OpenSS7 IPERF Utility package are available:

--disable-ipv6
Disable ipv6 support. This option defaults to auto detection.
--disable-multicast
Disable multicast support. This option defaults to auto detection.
--disable-threads
Disable thread support. This option defaults to auto detection.
--disable-web100
Disable web100 support. This option defaults to auto detection.

6.3.5.2 Environment Variables

Following are additional environment variables to configure, their meaning and use:

GPG
GPG signature command. This is used for signing distributions by the maintainer. By default, configure will search for this tool.
GNUPGUSER
GPG user name. This is used for signing distributions by the maintainer.
GNUPGHOME
GPG home directory. This is used for signing distributions by the maintainer.
GPGPASSWD
GPG password for signing. This is used for signing distributions by the maintainer. This environment variable is not maintained by the configure script and should only be used on an isolated system.
SOELIM
Roff source elimination command, soelim(1). This is only necessary when the option --with-cooked-manpages has been specified and configure cannot find the proper soelim(1) command. By default, configure will search for this tool.
REFER
Roff references command, refer(1). This is only necessary when the option --with-cooked-manpages has been specified and configure cannot find the proper refer(1) command. By default, configure will search for this tool.
TBL
Roff table command, tbl(1). This is only necessary when the option --with-cooked-manpages has been specified and configure cannot find the proper tbl(1) command. By default, configure will search for this tool.
PIC
Roff picture command, pic(1). This is only necessary when the option --with-cooked-manpages has been specified and configure cannot find the proper pic(1) command. By default, configure will search for this tool.
GZIP
Default compression options provided to GZIP_CMD.
GZIP_CMD
Manpages (and kernel modules) compression commands, gzip(1). This is only necessary when the option --without-compressed-manpages has not been specified and configure cannot find the proper gzip(1) command. By default, configure will search for this tool.
BZIP2
Default compression options provided to BZIP2_CMD
BZIP2_CMD
Manpages compression commands, bzip2(1). This is only necessary when the option --without-compressed-manpages has not been specified and configure cannot find the proper bzip2(1) command. By default, configure will search for this tool.
MAKEWHATIS
Manpages apropros database rebuild command, makewhatis(8). By default, configure will search for this tool. By default, configure will search for this tool.
RPM
Rpm command, rpm(1). This is only necessary for RPM builds. By default, configure will search for this tool.
RPMBUILD
Build RPM command, rpmbuild(1). This is only necessary for RPM builds. By default, configure will search for this tool. rpm(1) will be used instead of rpmbuild(1) only if rpmbuild(1) cannot be found.
DPKG
Dpkg comand, dpkg(1). This command is used for building Debian packages. By default, configure will search for this tool.
DPKG_SOURCE
Dpkg-source command, dpkg-source(1). This command is used for building Debian dsc packages. By default, configure will search for this tool.
DPKG_BUILDPACKAGE
Dpkg-buildpackage command, dpkg-buildpackage(1). This command is used for building Debian deb packages. By default, configure will search for this tool.
DEB_BUILD_ARCH
Debian build architecture. This variable is used for building Debian packages. The default is the autoconf build architecture.
DEB_BUILD_GNU_CPU
Debian build cpu. This variable is used for building Debian packages. The default is the autoconf build cpu.
DEB_BUILD_GNU_SYSTEM
Debian build os. This variable is used for building Debian packages. The default is the autoconf build os.
DEB_BUILD_GNU_TYPE
Debian build alias. This variable is used for building Debian packages. The default is the autoconf build alias.
DEB_HOST_ARCH
Debian host architecture. This variable is used for building Debian packages. The default is the autoconf host architecture.
DEB_HOST_GNU_CPU
Debian host cpu. This variable is used for building Debian packages. The default is the autoconf host cpu.
DEB_HOST_GNU_SYSTEM
Debian host os. This variable is used for building Debian packages. The default is the autoconf host os.
DEB_HOST_GNU_TYPE
Debian host alias. This variable is used for building Debian packages. The default is the autoconf host alias.
LDCONFIG
Configure loader command, ldconfig(8). Command used to configure the loader when libraries are installed. By default, configure will search for this tool.
DESTDIR
Cross build root directory. Specifies the root directory for build and installation.
OBJDUMP
Object dumping command, objdump(1). This is used for listing information about object files. By default, configure will search for this tool.
NM
Object symbol listing command, nm(1). This is used for listing information about object files. By default, configure will search for this tool.
6.3.5.3 Build

To build from the tar ball, See Building from the Tar Ball.

6.4 Building

6.4.1 Building from the Source RPM

If you have downloaded the necessary source RPM (see Downloading the Source RPM), then the following instructions will rebuild the binary RPMs on your system. Once the binary RPMs are rebuilt, you may install them as described above (see Installing the Binary RPM).

The source RPM is rebuilt to binary RPMs as follows:

     % wget http://www.openss7.org/rpms/SRPMS/iperf-2.0.8-1.src.rpm
     % rpmbuild --rebuild -vv iperf-2.0.8-1.src.rpm

The rebuild process can also recognize a number of options that can be used to tweak the resulting binaries, See Configuring the Source RPM. These options are provided on the rpm(1) command line. For example:

     % rpmbuild --rebuild -vv --target athlon-redhat-linux \
       --with lis -- iperf-2.0.8-1.src.rpm

will rebuild binary RPM for the ‘athlon’ architecture against the LiS STREAMS package.

Installation

To install the resulting binary RPM, See Installing the Binary RPM.

6.4.2 Building from the Debian DSC

If you have downloaded the necessary Debian DSC (see Downloading the Debian DSC), then the following instructions will rebuild the binary DEBs on your system. Once the binary DEBs are rebuilt, you may install them as described above (see Installing the Debian DEB).

The Debian DSC is rebuilt to binary DEBs as follows:

     % wget http://www.openss7.org/debian/iperf_2.0.8-0.dsc
     % wget http://www.openss7.org/debian/iperf_2.0.8-0.tar.gz
     % dpkg-buildpackage -v iperf_2.0.8-0.dsc

The rebuild process can also recognize a number of options that can be used to tweak the resulting binaries, See Configuring the Debian DSC. These options are provided in the environment variable BUILD_DPKGOPTIONS and have the same form as the options to configure, See Configuring the Tar Ball. For example:

     % BUILD_DEBOPTIONS='
             --with-lis
             --host=athlon-debian-linux-gnu'
       dpkg-buildpackage -v \
       iperf_2.0.8-0.dsc

will rebuild binary DEB for the ‘athlon’ architecture against the LiS STREAMS package.

Installation

To install the resulting binary DEB, See Installing the Debian DEB.

6.4.3 Building from the Tar Ball

If you have downloaded the tar ball (see Downloading the Tar Ball), then the following instructions will rebuild the package on your system. (Note that the build process does not required root privilege.)

6.4.3.1 Native Build

Following is an example of a native build against the running kernel:

     % wget http://www.openss7.org/iperf-2.0.8.tar.bz2
     % tar -xjvf iperf-2.0.8.tar.bz2
     % pushd iperf-2.0.8
     % ./configure
     % make
     % popd
6.4.3.2 Cross-Build

Following is an example for a cross-build. The kernel release version must always be specified for a cross-build.19 If you are cross-building, specify the root for the build with environment variable DESTDIR. The cross-compile host must also be specified if different from the build host. Either the compiler and other tools must be in the usual places where GNU autoconf(1) can find them, or they must be specified with declarations such as ‘CC=/usr/lib/ppc-linux/gcc’ on the configure command line.

     % wget http://www.openss7.org/iperf-2.0.8.tar.bz2
     % tar -xjvf iperf-2.0.8.tar.bz2
     % pushd iperf-2.0.8
     % ./configure DESTDIR="/some/other/root" \
     	--with-k-release=2.4.18 --host sparc-linux
     % make
     % popd

6.5 Installing

6.5.1 Installing the Binary RPM

If you have downloaded the necessary binary RPMs (see Downloading the Binary RPM), or have rebuilt binary RPMs using the source RPM (see Building from the Source RPM), then the following instructions will install the RPMs on your system. For additional information on rpm(1), see rpm(8).

     % pushd RPMS/i686
     % rpm -ihv iperf-*-2.0.8-1.7.2.i686.rpm

You must have the correct binary RPMs downloaded or built for this to be successful.

Some of the packages are relocatable and can have final installation directories altered with the --relocate option to rpm(1), see rpm(8). For example, the following will relocate the documentation and info directories:

     % pushd RPMS/i686
     % rpm -ihv \
             --relocate '/usr/share/doc=/usr/local/share/doc' \
             --relocate '/usr/share/info=/usr/local/share/info' \
             -- iperf-doc-2.0.8-1.7.2.i686.rpm

The previous example will install the iperf-doc package by will relocate the documentation an info directory contents to the /usr/local version.

6.5.2 Installing the Debian DEB

If you have downloaded the necessary Debian DEBs (see Downloading the Debian DEB), or have rebuild binary DEBs using the Debian DSC (see Building from the Debian DSC), then the following instructions will install the DEBs on your system. For additional information see dpkg(8).

     % pushd debian
     % dpkg -iv iperf-*_2.0.8-0_*.deb

You must have the correct .deb files downloaded or build for this to be successful.

6.5.3 Installing the Tar Ball

After the build process (see Building from the Tar Ball), installation only requires execution of one of two automake(1) targets:

make install
The ‘installautomake(1) target will install all the components of the package. Root privilege is required to successfully invoke this target.
make install-strip
The ‘install-stripautomake(1) target will install all the components of the package, but will strip unnecessary information out of the objects and compress manual pages. Root privilege is required to successfully invoke this target.

6.6 Removing

6.6.1 Removing the Binary RPM

To remove an installed version of the binary RPMs (whether obtained from the OpenSS7 binary RPM releases, or whether created by the source RPM), execute the following command:

     % rpm -evv `rpm -qa | grep '^iperf-'`

For more information see rpm(1).

6.6.2 Removing the Debian DEB

To remove and installed version of the Debian DEB (whether obtained from the OpenSS7 binary DEB releases, or whether created by the Debian DSC), execute the following command:

     % dpkg -ev `dpkg -l | grep '^iperf-'`

For more information see dpkg(8).

6.6.3 Removing the Source RPM

To remove all the installed binary RPM build from the source RPM, see Removing the Binary RPM. Then simply remove the binary RPM package files and source RPM file. A command such as:

     % find / -name 'iperf-*.rpm' -type f -print0 | xargs --null rm -f

should remove all Iperf RPMs from your system.

6.6.4 Removing the Debian DSC

To remove all the installed binary DEB build from the Debian DSC, see Removing the Debian DEB. Then simply remove the binary DEB package files and Debian DSC file. A command such as:

     % find / \( -name 'iperf-*.deb' \
              -o -name 'iperf-*.dsc' \
              -o -name 'iperf-*.tar.* \
              \) -type f -print0 | xargs --null rm -f

should remove all Iperf DEBs, DSCs and TARs from your system.

6.6.5 Removing the Tar Ball

To remove a version installed from tar ball, change to the build directory where the package was built and use the ‘uninstallautomake(1) target as follows:

     % cd /usr/src/iperf
     % make uninstall
     % cd ..
     % rm -fr iperf-2.0.8
     % rm -f iperf-2.0.8.tar.gz
     % rm -f iperf-2.0.8.tar.bz2

If you have inadvertently removed the build directory and, therefore, no longer have a configured directory from which to execute ‘make uninstall’, then perform all of the steps for configuration and installation (see Installing the Tar Ball) except the final installation and then perform the steps above.

6.6.5.1 Linux STREAMS Module Loading

LiS is deprecated and this section has been deleted.

6.7 Maintenance

6.7.1 Makefile Targets

automake(1) has many targets, not all of which are obvious to the casual user. In addition, OpenSS7 automake(1) files have additional rules added to make maintaining and releasing a package somewhat easier. This list of targets provides some help with what targets can be invoked, what they do, and what they hope to achieve. The available targets are as follows:

6.7.1.1 User Targets

The following are normal targets intended to be invoked by installers of the package. They are concerned with compiling, checking the compile, installing, checking the installation, and removing the package.

[all]
This is also the default target. It compiles the package and all release packages selected by configure. This is performed after configuring the source with ‘configure’. A Makefile stub is provided so that if the package has not had autoreconf(1) run (such as when checked out from CVS, the package will attempt to run ‘autoreconf -fiv’.

All OpenSS7 Project packages are configured without maintainer mode and without dependency tracking by default. This speeds compilation of the package for one-time builds. This also means that if you are developing using the source package (edit-compile-test cycle), changes made to source files will not cause the automatic rebuilding due to dependencies. There are two ways to enable dependency tracking: specify --enable-maintainer-mode to configure; or, specify --enable-dependency-tracking to configure. I use the former during my edit-compile-test cycle.

This is a standard GNU automake(1) makefile target. This target does not require root privilege.

check
All OpenSS7 Project release packages provide check scripts for the check target. This step is performed after compiling the package and will run all of the ‘check’ programs against the compiled binaries. Which checks are performed depends on whether --enable-maintainer-mode was specified to configure. If in maintainer mode, checks that assist with the release of the package will be run (such as checking that all manual pages load properly and that they have required sections.) We recommend running the check stage before installing, because it catches problems that might keep the installed package from functioning properly.

Another way to enable the greater set of checks, without invoking maintainer mode, is to specify --enable-checks to configure. For more information, see Pre-installation Checks.

This is a standard GNU automake(1) makefile target, although the functions performed are customized for the OpenSS7 Project. This target does not require root privilege.

install
install-strip
The ‘install’ target installs the package by installing each release package. This target also performs some actions similar to the pre- and post-install scripts used by packaging tools such as rpm(1) or dpkg(1). The ‘install-strip’ target strips unnecessary symbols from executables and kernel modules before installing.

This is a standard GNU automake(1) makefile target. This target requires root privilege.

installcheck
All OpenSS7 Project packages provide test scripts for the ‘installcheck’ target. Test scripts are created and run using autotest (part of the autoconf(1) package). Which test suites are run and how extensive they are depends on whether --enable-maintainer-mode was specified to configure. When in maintainer mode, all test suites will be run. When not in maintainer mode, only a few post-install checks will be performed, but the test suites themselves will be installed in /usr/libexec/iperf20 for later use.

This is a standard GNU automake(1) makefile target. This target might require root privilege. Tests requiring root privilege will be skipped when run as a regular user. Tests requiring regular account privileges will be skipped when run as root.

retest
To complement the ‘installcheck’ target above, all OpenSS7 Project packages provide the ‘retest’ target as a means to rerun failed conformance test suite test cases. The ‘retest’ target is provided because some test cases in the test suites have delicate timing considerations that allow them to fail sporadically. Invoking this target will retest the failed cases until no cases that are not expected failures remain.

This is an OpenSS7 Project specific makefile target. As with ‘installcheck’, this target might require root privilege. Tests requiring root privilege will be skipped when run as a regular user. Tests requiring regular account privileges will be skipped when run as root.

uninstall
This target will reverse the steps taken to install the package. This target also performs pre- and post- erase scripts used by packaging tools such as rpm or dpkg. You need to have a configured build directory from which to execute this target, however, you do not need to have compiled any of the files in that build directory.21

The ‘uninstall’ target unfortunately removes add-on packages in the same order in which they were installed. This is not good for the OpenSS7 Master Package, where the ‘remove’ target should be used instead.

This is a standard GNU automake(1) makefile target. This target requires root privilege.

remove
This target is like ‘uninstall’ with the exception that it removes add-on packages in the reverse order that installation was performed.22

This is an OpenSS7 Project specific makefile target. This target requires root privilege.

6.7.1.2 Maintainer Targets

The following targets are targets intended for use by maintainers of the package, or those responsible for release and packaging of a derivative work of the package. Some of these targets are only effective when maintainer mode has been invoked (--enable-maintainer-mode specified to configure.)

dist
Creates a distribution package (tarball) in the top level build directory. OpenSS7 Project packages distribute two archives: a ‘gzip tar’ archive and a ‘bzip tar’ archive. These archives will have the name iperf-2.0.8.tar.gz and iperf-2.0.8.tar.bz2.

This is a standard GNU automake(1) makefile target. This target does not require root privilege.

distcheck
This target is intended for use when releasing the package. It creates the tar(1) archives above and then unpacks the tarball in a source directory, configures in a separate build directory, compiles the package, installs the package in a separate install directory, tests the install package to ensure that some components work, and, finally, uses the unpacked source tree to build another tarball. If you have added or removed files from the package, this is a good way to ensure that everything is still stable for release.

This is a standard GNU automake(1) makefile target. This target does not require root privilege.

6.7.1.3 Clean Targets
mostlyclean
Cleans out most of the files from the compile stage. This target is helpful if you have not enabled dependency tracking and need to recompile with changes.

This is a standard GNU automake(1) makefile target. This target does not require root privilege.

clean
Cleans all the files from the build directory generated during the ‘make [all]’ phase. It does not, however, remove files from the directory left there from the configure run. Use the ‘distclean’ target to remove those too.

This is a standard GNU automake(1) makefile target. This target might require root privilege if the ‘installcheck’ target or the testsuite was invoked with root privilege (leaving files belonging to root).

distclean
This target cleans out the directories left behind by ‘distcheck’ and removes all the configure and generated files from the build directory. This will effectively remove all the files in the build directory, with the except of files that belong to you or some other process.

This is a standard GNU automake(1) makefile target. This target might require root privilege if the ‘installcheck’ target or the testsuite was invoked with root privilege (leaving files belonging to root).

maintainer-clean
This target not only removes files from the build directory, it removes generated files from the source directory as well. Care should be taken when invoking this target, because it removes files generated by the maintainer and distributed with the archive that might require special tools to regenerate. These special tools might only be available to the maintainer.23 It also means that you probably need a full blown Linux system to rebuild the package. For more information, see Downloading from CVS.

This is a standard GNU automake(1) makefile target. This target might require root privilege if the ‘installcheck’ target or the testsuite was invoked with root privilege (leaving files belonging to root).

check-clean
This target removes log files left behind by the ‘check’ target. By default, the check scripts append to log files in the top level build directory. This target can be used to clean out those log files before the next run.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

6.7.1.4 Manual Page Targets

The following targets are used to build, install and uninstall just the manual pages from the distribution. These targets are good for creating a distribution of just the manual pages. When building atop multiple packages, these targets recurse down through each package.

mans
Build all of the manual pages. This involves performing parameter substitution on manual pages and optionally cooking the manual pages if --with-cooked-manpages was requested during configuration.
install-mans
Installs the manual pages under DESTDIR. Specify DESTDIR to place the manual pages wherever you see fit. If DESTDIR is not specified on the command line, the manual pages will be installed in the normal installation directory.
uninstall-mans
Uninstalls the manual pages from DESTDIR. Specify DESTDIR to indicate where to remove the manual pages from. If DESTDIR is not specified on the command line, the manual pages will be removed from the normal installation directory.

6.7.1.5 Release Targets

The following are targets used to generate complete releases into the package distribution directory. These are good for unattended and NFS builds, which is what I use them for. Also, when building from atop multiple packages, these targets also recurse down through each package.

release
Build all of the things necessary to generate a release. On an rpm(1) system this is the distribution archives, the source rpm, and the architecture dependent and architecture independent binary rpms. All items are placed in the package distribution directory that can be specified with the --with-pkg-distdir=DIR option to configure.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

forced-release
The ‘release’ target will not regenerate any files that already exist in the package distribution directory. This forced target will.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

release-sign
You will be prompted for a password, unless to specify it to make with the GNUPGPASS variable. For unattended or non-interactive builds with signing, you can do that as: ‘make GNUPGPASS=mypasswd release-sign

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

forced-release-sign
The ‘release-sign’ target will not regenerate any files that already exist in the package distribution directory. This forced target will.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

release-clean
This target will remove all distribution files for the current package from the package distribution directory.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

6.7.1.6 Logging Targets

For convenience, to log the output of a number of targets to a file, log targets are defined. The log file itself is used as the target to make, but make invokes the target minus a .log suffix. So, for example, to log the results of target ‘foo’, invoke the target ‘foo.log’. The only target that this does not apply to is ‘compile.log’. When you invoke the target ‘compile.log’ a simple automake(1) is invoked and logged to the file compile.log. The ‘foo.log’ rule applies to all other targets. This does not work for all targets, just a selected few.24 Following are the logging targets:

Common Logging Targets

Common logging targets correspond to normal user automake(1) makefile targets as follows:

compile.log
This is an OpenSS7 Project specific makefile target, but it invokes the standard GNU automake(1) makefile target ‘[all]’.
check.log
This is an OpenSS7 Project specific makefile target, but it invokes the standard GNU automake(1) makefile target ‘check’.
install.log
This is an OpenSS7 Project specific makefile target, but it invokes the standard GNU automake(1) makefile target ‘install’.
installcheck.log
This is an OpenSS7 Project specific makefile target, but it invokes the standard GNU automake(1) makefile target ‘installcheck’.
uninstall.log
This is an OpenSS7 Project specific makefile target, but it invokes the standard GNU automake(1) makefile target ‘uninstall’.
remove.log
This is an OpenSS7 Project specific makefile target, that invokes the OpenSS7 Projectremove’ target.
Maintainer Logging Targets

Maintainer logging targets correspond to maintainer mode automake(1) makefile targets as follows:

dist.log
This is an OpenSS7 Project specific makefile target, but it invokes the standard GNU automake(1) makefile target ‘dist’.
distcheck.log
This is an OpenSS7 Project specific makefile target, but it invokes the standard GNU automake(1) makefile target ‘distcheck’.
srpm.log
This is an OpenSS7 Project specific makefile target, that invokes the OpenSS7 Projectsrpm’ target.
rebuild.log
This is an OpenSS7 Project specific makefile target, that invokes the OpenSS7 Projectrebuild’ target.
resign.log
This is an OpenSS7 Project specific makefile target, that invokes the OpenSS7 Projectresign’ target.
release.log
This is an OpenSS7 Project specific makefile target, that invokes the OpenSS7 Projectrelease’ target.
release-sign.log
This is an OpenSS7 Project specific makefile target, that invokes the OpenSS7 Projectrelease-sign’ target.

If you want to add one, simply add it to LOGGING_TARGETS in Makefile.am.

6.7.1.7 Problem Report Targets

To ease problem report generation, all logging targets will automatically generate a problem report suitable for mailing in the file target.pr for target ‘target.log’. This problem report file is in the form of an email and can be sent using the included send-pr script or by invoking the ‘send-pr’ makefile target.

There are two additional problem report targets:

pr
The ‘pr’ target is for independently generating a problem report outside of the build or installation process. The target will automatically generate a problem report skeleton suitable for editing and mailing in the file problem.pr. This problem report file is in the form of an email and can be edited and sent directly, or sent using the included send-pr script or by invoking the ‘send-pr’ target.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

send-pr
The ‘send-pr’ target is for finalizing and mailing a problem report generated either inside or outside the build and installation process. The target will automatically finalize and mail the problem.pr problem report if it has changed since the last time that ‘send-pr’ was invoked.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege (unless the problem report file was generated as root).

6.7.1.8 Release Archive Targets

The following targets are used to generate and clean distribution archive and signature files. Whereas the ‘dist’ target affects archives in the top build directory, the ‘release-archive’ targets affects archives in the package distribution directory (either the top build directory or that specified with --with-pkg-distdir=DIR to configure).

You can change the directory to which packages are distributed by using the --with-pkg-distdir=DIR option to configure. The default directory is the top build directory.

release-archives
This target creates the distribution archive files if they have not already been created. This not only runs the ‘dist’ target, but also copies the files to the distribution directory, which, by default is the top build directory.

The files generated are named:

iperf-2.0.8.tar.gz and iperf-2.0.8.tar.bz2

You can change this distribution directory with the --with-pkg-distdir option to configure. See ‘./configure --help’ for more details on options.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

release-sign-archives
This target is like ‘release-archives’, except that it also signs the archives using a GPG detached signature. You will be prompted for a password unless you pass the GNUPGPASS variable to make. For automated or unattended builds, pass the GNUPGPASS variable like so:

make GNUPGPASS=mypasswd release-sign-archives

Signature files will be named:

iperf-2.0.8.tar.gz.asc and iperf-2.0.8.tar.bz2.asc

These files will be moved to the package distribution directory with the plain text archives.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

release-clean-archives
This target will clean the release archives and signature files from the package distribution directory.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

6.7.1.9 RPM Build Targets

On rpm(1) systems, or systems sporting rpm packaging tools, the following targets are used to generate rpm(1) release packages. The epoch and release number can be controlled by the contents of the .rpmepoch and .rpmrelease files, or with the --with-rpm-epoch=EPOCH and --with-rpm-release=RELEASE options to configure. See ‘configure --help’ for more information on options. We always use release number ‘1’. You can use release numbers above ‘1’.

srpm
This target generates the source rpm for the package (without signing the source rpm). The source rpm will be named: iperf-2.0.8-1.srpm.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

rpms
This target is responsible for generating all of the package binary rpms for the architecture. The binary rpms will be named:

iperf-*-2.0.8-1.*.rpm

where the stars indicate the subpackage and the architecture. Both the architecture specific subpackages (binary objects) and the architecture independent (.noarch) subpackages will be built unless the the former was disabled with the option --disable-arch, or the later with the option --disable-indep, passed to configure.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

sign
srpm-sign
These two targets are the same. When invoked, they will add a signature to the source rpm file, provided that the file does not already have a signature. You will be prompted for a password if a signature is required. Automated or unattended builds can be achieved by using the emake expect script, included in ${srcdir}/scripts/emake.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

rebuild
This target accepts searches out a list of kernel names from the ${DESTDIR}/lib/modules directory and builds rpms for those kernels and for each of a set of architectures given in the AM_RPMTARGETS variable to make. This is convenience target for building a group of rpms on a given build machine.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

resign
This target will search out and sign, with a GPG signature, the source rpm, and all of the binary rpms for this package that can be found in the package distribution directory. This target will prompt for a GPG password. Automated or unattended builds can be achieved with the emake expect script located here: ${srcdir}/scripts/emake.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

6.7.1.10 Debian Build Targets

On Debian systems, or systems sporting Debian packaging tools, the following targets are used to generate Debian release packages. The release number can be controlled by the contents of the .debrelease file, or with the --with-debrelease=RELEASENUMBER option to configure. See ‘configure --help’ for more information on options.

dsc
This target will build the Debian source change package (.dsc file). We use release number ‘0’ so that the entire tarball is included in the dsc file. You can use release number ‘1’ for the same purposes. Release numbers above ‘1’ will not include the entire tarball. The .dsc file will be named: iperf_2.0.8-0.dsc.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

sigs
This target signs the .deb files. You will be prompted for a password, unless to specify it to make with the GNUPGPASS variable.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

debs
This target will build the Debian binary package (.deb file) from the .dsc created above. (This target will also create the .dsc if it has not been created already.) The subpackage .deb files will be named: iperf-*_2.0.8-0_*.deb, where the stars indicate the subpackage and the architecture.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

csig
This target signs the .dsc file. You will be prompted for a password, unless to specify it to make with the GNUPGPASS variable.

This is an OpenSS7 Project specific makefile target. This target does not require root privilege.

6.7.1.11 Documentation Targets

On systems that have doxygen(1) documentation tool, the following targets are used to generate doxygen html documentation:

doxy
This target generates doxygen(1) documetnation from suitably marked sources. File containing the necessary documentation marks are discovered automatically by configure. Doxygen documentation can be generated bus is not distributed. Documentation is cerated in the subdirectory doc/html.

7 Troubleshooting

7.1 Test Suites

7.1.1 Pre-installation Checks

Most OpenSS7 packages, including the OpenSS7 IPERF Utility package, ship with pre-installation checks integral to the build system. Pre-installation checks include check scripts that are shipped in the scripts subdirectory as well as specialized make targets that perform the checks.

When building and installing the package from RPM or DEB source packages (see Building from the Source RPM; and Building from the Debian DSC), a fundamental set of post-compile, pre-installation checks are performed prior to building binary packages. This is performed automatically and does not require any special actions on the part of the user creating binary packages from source packages.

When building and installing the package from tarball (see Building from the Tar Ball; and Installing the Tar Ball), however, pre-installation checks are only performed if specifically invoked by the builder of the package. Pre-installation checks are invoked after building the package and before installing the package. Pre-installation checks are performed by invoking the ‘check’ or ‘check.log’ target to make when building the package, as shown in testsuite:ex0.

     % wget http://www.openss7.org/iperf-2.0.8.tar.bz2
     % tar -xjvf iperf-2.0.8.tar.bz2
     % pushd iperf-2.0.8
     % ./configure
     % make
     % make check  # <------- invoke pre-installation checks
     % popd

Example 7.1: Invoking Pre-Installation Checks

Pre-installation checks fall into two categories: System Checks and Maintenance Checks.

7.1.1.1 Pre-Installation System Checks

System Checks are post-compilation checks that can be performed before installing the package that check to ensure that the compiled objects function and will be successfully installed. When the --enable-maintainer-mode option has not been passed to configure, only System Checks will be performed.

For example, the steps shown in testsuite:ex1 will perform System checks.

     % wget http://www.openss7.org/iperf-2.0.8.tar.bz2
     % tar -xjvf iperf-2.0.8.tar.bz2
     % pushd iperf-2.0.8
     % ./configure
     % make
     % make check  # <------ invokes System pre-installation checks
     % popd

Example 7.2: Invoking System Checks

7.1.1.2 Pre-Installation Maintenance Checks

Maintenance Checks include all System Checks, but also checks to ensure that the kernel modules, applications programs, header files, development tools, test programs, documentation, and manual pages conform to OpenSS7 standards. When the --enable-maintainer-mode option has been passed to configure, Maintenance Checks will be performed.

For example, the steps shown in testsuite:ex2 will perform Maintenance checks.

     % wget http://www.openss7.org/iperf-2.0.8.tar.bz2
     % tar -xjvf iperf-2.0.8.tar.bz2
     % pushd iperf-2.0.8
     % ./configure --enable-maintainer-mode
     % make
     % make check  # <------ invokes Maintenance pre-installation checks
     % popd

Example 7.3: Invoking Maintenance Checks

7.1.1.3 Specific Pre-Installation Checks

A number of check scripts are provided in the scripts subdirectory of the distribution that perform both System and Maintenance checks. These are as follows:

check_commands
This check performs both System and Maintenance checks.

When performing System tests, the following tests are performed:

Unless cross-compiling, or unless a program is included in AM_INSTALLCHECK_STD_OPTIONS_EXEMPT every program in bin_PROGRAMS, sbin_PROGRAMS, and libexec_PROGRAMS is tested to ensure that the --help, --version, and --copying options are accepted. When cross-compiling is is not possible to execute cross-compiled binaries, and these checks are skipped in that case.

Script executables, on the other hand, can be executed on the build host, so, unless listed in AM_INSTALLCHECK_STD_OPTIONS_EXEMPT, every program in dist_bit_SCRIPTS, dist_sbin_SCRIPTS, and pkglibexec_SCRIPTS are tested to ensure that the --help, --version, and --copying options are accepted.

When performing Maintenance tests, check_commands also checks to ensure that a manual page exists in section 1 for every executable binary or script that will be installed from bin_PROGRAMS and dist_bin_SCRIPTS. It also checks to ensure that a manual page exists in section 8 for every executable binary or script that will be installed from sbin_PROGRAMS, dist_sbin_SCRIPTS, libexec_PROGRAMS, and pkglibexec_SCRIPTS.

check_decls
This check only performs Maintenance checks.

It collects the results from the check_libs, check_modules and check_headers check scripts and tests to ensure every declaration of a function prototype or external variable contained in installed header files has a corresponding exported symbol from either a to be installed shared object library or a to be installed kernel module. Declarations are exempted from this requirement if their identifiers have been explicitly added to the EXPOSED_SYMBOL variable. If WARN_EXCESS is set to ‘yes’, then the check script will only warn when excess declarations exist (without a corresponding exported symbol); otherwise, the check script will generate an error and the check will fail.

check_headers
This check only performs Maintenance checks.

When performing Maintenance tests, it identifies all of the declarations included in to be installed header files. It then checks to ensure that a manual page exists in sections 2, 3, 7 or 9, as appropriate, for the type of declaration. It also checks to see if a manual page source file exists in the source directory for a declaration that has not been included in the distribution. Function or prototype declarations that do not have a manual page in sections 2, 3, or 9 will cause the check to fail. Other declarations (‘variable’, ‘externvar’, ‘macro’, ‘enumerate’, ‘enum’, ‘struct’, ‘union’, ‘typedef’, ‘member’, etc.) will only warn if a manual page does not exist, but will not fail the check.

check_libs
This check only performs Maintenance checks.

When performing Maintenance tests, it checks that each exported symbol in each to be installed shared object library has a manual page in section 3. It also checks that each exported symbol has a ‘function’, ‘prototype’ or ‘externvar’ declaration in the to be installed header files. A missing declaration or manual page will cause this check to fail.

check_mans
This check only performs Maintenance checks.

When performing Maintenance tests, it checks that to be install manual pages can be formatted for display without any errors or warnings from the build host man program. It also checks that required headings exist for manual pages according to the section in which the manual page will be installed. It warns if recommended headings are not included in the manual pages. Because some RPM distributions have manual pages that might conflict with the package manual pages, this check script also checks for conflicts with installed manual pages on the build host. This check script also checks to ensure that all to be installed manual pages are used in some fashion, that is, they have a declaration, or exported symbol, or are the name of a kernel module or STREAMS module or driver, possibly capitalized.

Note that checking for conflicts with the build host should probably be included in the System checks (because System checks are performed before the source RPM %install scriptlet).

check_modules
This check performs both System and Maintenance checks.

When performing System tests, it checks each to be installed kernel module to ensure that all undefined symbols can be resolved to either the kernel or another module. It also checks whether an exported or externally declared symbol conflicts with an exported or externally declared symbol present in the kernel or another module.25

When performing Maintenance tests, this check script tests that each to be installed kernel module has a manual page in section 9 and that each exported symbol that does not begin with an underscore, and that belongs to an exported function or exported variable, has a manual page in section 9. It also checks to ensure that each exported symbol that does not begin with an underscore, and that belongs to an exported function or exported variable, has a ‘function’, ‘prototype’ or ‘externvar’ declaration in the to be installed header files.

check_streams
This check performs only Maintenance checks.

When performing Maintenance tests, it checks that for each configured STREAMS module or driver, or device node, that a manual page exists in section 4 or section 7 as appropriate.

The output of the pre-installation tests are fairly self explanatory. Each check script saves some output to name.log, where name is the name of the check script as listed above. A summary of the results of the test are display to standard output and can also be captured to the check.log file if the ‘check.log’ target is used instead of the ‘check’ target to make.

Because the check scripts proliferate name.log files throughout the build directory, a ‘make check-cleanmake target has be provided to clean them out. ‘make check-clean’ should be run before each successive run of ‘make check’.

7.1.2 Post-installation Checks

Most OpenSS7 packages ship with a compatibility and conformance test suite built using the ‘autotest’ capabilities of ‘autoconf’. These test suites act as a wrapper for the compatibility and conformance test programs that are shipped with the package.

Unlike the pre-installation checks, the post-installation checks are always run complete. The only check that post-installation test scripts perform is to test whether they have been invoked with root privileges or not. When invoked as root, or as a plain user, some tests might be skipped that require root privileges, or that require plain user privileges, to complete successfully.

7.1.2.1 Running Test Suites

There are several ways of invoking the conformance test suites:

  1. The test suites can be run after installation of the package by invoking the ‘make installcheck’ or ‘make installcheck.log’ target. Some packages require that root privileges be acquired before invoking the package.
  2. The test suites can be run from the distribution subdirectory after installation of the package by invoking the testsuite shell script directly.
  3. The test suites can be run standalone from the libexec (/usr/libexec) installation directory by invoking the testsuite shell script directly.

Typical steps for invoking the test suites directly from make are shown in testsuite:ex3.

     % wget http://www.openss7.org/iperf-2.0.8.tar.bz2
     % tar -xjvf iperf-2.0.8.tar.bz2
     % pushd iperf-2.0.8
     % ./configure
     % make
     % make check  # <------ invokes System pre-installation checks
     % make install
     % sudo make installcheck # <------- invokes post-installation tests
     % popd

Example 7.4: Invoking System Checks

When performing post-installation checks for the purposes of generating a problem report, the checks should always be performed from the build directory, either with ‘make installcheck’ or by invoking testsuite directly from the tests subdirectory of the build directory. This ensures that all of the information known to configure and pertinent to the configuration of the system for which a test case failed, will be collected in the resulting testsuite.log file deposited upon test suite failure in the tests directory. This testsuite.log file can then be attached as part of the problem report and provides rich details to maintainers of the package. See also See Problem Reports, below.

Typical steps for invoking and installed testsuite standalone are shown in testsuite:ex4.

     % [sudo] /usr/libexec/iperf/testsuite

Example 7.5: Invoking testsuite Directly

When invoked directly, testsuite will generate a testsuite.log file in the current directory, and a testsuite.dir directory of failed tests cases and debugging scripts. For generating a problem report for failed test cases, see Stand Alone Problem Reports.

7.2 Problem Reports

7.2.1 Problem Report Guidelines

Problem reports in the following categories should include a log file as indicated in the table below:

./configure
A problem with the configuration process occurs that causes the ‘./configure’ command to fail. The problem report must include the config.log file that was generated by configure.
make compile.log
A problem with the build process occurs that causes the ‘make’ command to fail. Perform ‘make clean’ and then ‘make compile.log’ and attach the config.log and compile.log files to the problem report.
make check.log
A problem occurs with the ‘make check’ target that causes it to fail. Perform ‘make check-clean check.log’ and attach the config.log, compile.log and check.log files to the problem report.
sudo make install.log
A problem occurs with ‘sudo make install’ that causes it to fail. Perform ‘sudo make uninstall’ and ‘sudo make install.log’ and attach the config.log, compile.log, check.log, and install.log files to the problem report.
[sudo] make installcheck.log
A problem occurs with the ‘make installcheck’ target that causes the test suite to fail. Attach the resulting tests/testsuite.log and installcheck.log file to the problem report. There is no need to attach the other files as they are included in tests/testsuite.log.
[sudo] make uninstall.log
A problem occurs with the ‘make uninstall’ target that causes the test suite to fail. Perform ‘sudo make uninstall.log’ and attach the config.log, compile.log, check.log, install.log, installcheck.log, tests/testsuite.log and uninstall.log file to the problem report.
[sudo] make remove.log
A problem occurs with the ‘make remove’ target that causes the test suite to fail. Perform ‘sudo make remove.log’ and attach the config.log, compile.log, check.log, install.log, installcheck.log, tests/testsuite.log and remove.log file to the problem report.

For other problems that occur during the use of the OpenSS7 IPERF Utility package, please write a test case for the test suite that recreates the problem if one does not yet exist and provide a test program patch with the problem report. Also include whatever log files are generated by the kernel (cmn_err(9)) or by the strerr(8) or strace(1) facilities (strlog(9)).

7.2.2 Generating Problem Reports

The OpenSS7 Project uses the GNU GNATS system for problem reporting. Although the ‘send-pr’ tool from the GNU GNATS package can be used for bug reporting to the project's GNATS database using electronic mail, it is not always convenient to download and install the GNATS system to gain access to the ‘send-pr’ tool.

Therefore, the OpenSS7 IPERF Utility package provides the ‘send-pr’ shell script that can be used for problem reporting. The ‘send-pr’ shell script can invoked directly and is a work-alike for the GNUsend-pr’ tool.

The ‘send-pr’ tool takes the same flags and can be used in the same fashion, however, whereas ‘send-pr’ is an interactive tool26, ‘send-pr’ is also able to perform batch processing. Whereas ‘send-pr’ takes its field information from local databases or from using the ‘query-pr’ C-language program to query a remote database, the ‘send-pr’ tool has the field database internal to the tool.

Problem reports can be generate using make, See Problem Report Targets. An example of how simple it is to generate a problem report is illustrated in autopr:ex0.

     % make pr
     SEND-PR:
     SEND-PR: send-pr:  send-pr was invoked to generate an external report.  An
     SEND-PR: automated problem report has been created in the file named
     SEND-PR: 'problem.pr' in the current directory.  This problem report can
     SEND-PR: be sent to bugs@openss7.org by calling this script as
     SEND-PR: '/home/brian/os7/scripts/send-pr --file="problem.pr"'.
     SEND-PR:
     SEND-PR: It is possible to edit some of the fields before sending on the
     SEND-PR: problem report.  Please remember that there is NO WARRANTY.  See
     SEND-PR: the file 'COPYING' in the top level directory.
     SEND-PR:
     SEND-PR: Please do not send confidential information to the bug report
     SEND-PR: address.  Inspect the file 'problem.pr' for confidential
     SEND-PR: information before mailing.
     SEND-PR:
     % vim problem.pr  # <--- follow instructions at head of file
     % make send-pr

Example 7.6: Invoking Problem Report Generation

Using the ‘make pr’ target to generate a problem report has the advantages that it will assemble any available *.log files in the build directory and attach them to the problem report.

7.2.3 Automatic Problem Reports

The OpenSS7 IPERF Utility package also provides a feature for automatic problem report generation that meets the problem report submission guidelines detailed in the preceding sections.

Whenever a logging makefile target (see Logging Targets) is invoked, if the primary target fails, the send-pr shell script is invoked to automatically generate a problem report file suitable for the corresponding target (as described above under see Problem Report Guidelines). An example is shown in autopr:ex1.

     % make compile.log
     ...
     ...
     make[5]: *** [libXNSdrvs_a-ip.o] Error 1
     make[5]: Leaving directory `/u6/buildel4/strxns'
     make[4]: *** [all-recursive] Error 1
     make[4]: Leaving directory `/u6/buildel4/strxns'
     make[3]: *** [all] Error 2
     make[3]: Leaving directory `/u6/buildel4/strxns'
     make[2]: *** [all-recursive] Error 1
     make[2]: Leaving directory `/u6/buildel4'
     make[1]: *** [all] Error 2
     make[1]: Leaving directory `/u6/buildel4'
     SEND-PR:
     SEND-PR: send-pr:  Make target compile.log failed in the compile stage.  An
     SEND-PR: automated problem report has been created in the file named
     SEND-PR: 'problem.pr' in the current directory.  This problem report can
     SEND-PR: be sent to bugs@openss7.org by calling 'make send-pr'.
     SEND-PR:
     SEND-PR: It is possible to edit some of the fields before sending on the
     SEND-PR: problem report.  Please remember that there is NO WARRANTY.  See
     SEND-PR: the file 'COPYING' in the top level directory.
     SEND-PR:
     SEND-PR: Please do not send confidential information to the bug report
     SEND-PR: address.  Inspect the file 'problem.pr' for confidential
     SEND-PR: information before mailing.
     SEND-PR:
     % vim problem.pr  # <--- follow instructions at head of file
     % make send-pr

Example 7.7: Problem Report from Failed Logging Target

7.2.4 Stand Alone Problem Reports

The OpenSS7 IPERF Utility package installs the send-pr script and its configuration file send-pr.config in ${libexecdir}/iperf along with the validation testsuite, see See Test Suites. As with the testsuite, this allows the send-pr script to be used for problem report generation on an installed system that does not have a build directory.

An example of invoking the package testsuite and then generating a problem report for failed cases is shown in autopr:ex2.

     % [sudo] /usr/libexec/iperf/testsuite
     % # test cases failed...
     % /usr/libexec/iperf/send-pr
     SEND-PR:
     SEND-PR: send-pr:  send-pr was invoked to generate an external report.  An
     SEND-PR: automated problem report has been created in the file named
     SEND-PR: 'problem.pr' in the current directory.  This problem report can
     SEND-PR: be sent to bugs@openss7.org by calling this script as
     SEND-PR: '/usr/libexec/iperf/send-pr --file problem.pr'.
     SEND-PR:
     SEND-PR: It is possible to edit some of the fields before sending on the
     SEND-PR: problem report.  Please remember that there is NO WARRANTY.  See
     SEND-PR: the file 'COPYING' in the top level directory.
     SEND-PR:
     SEND-PR: Please do not send confidential information to the bug report
     SEND-PR: address.  Inspect the file 'problem.pr' for confidential
     SEND-PR: information before mailing.
     SEND-PR:
     % vim problem.pr  # <--- follow instructions at head of file
     % /usr/libexec/iperf/send-pr --file problem.pr

Example 7.8: Invoking send-pr Directly

The advantage of the approach shown in the example is that the send-pr script is capable of collecting the testsuite.log file and the failed test cases and debugging scripts from the testsuite.dir directory and including them in the problem report, as well as all package pertinent information from the installed send-pr.config.

7.3 Known Problems

The OpenSS7 Project does not ship software with known bugs. All bugs are unknown.

Verified behaviour is that behaviour that has been verified by conformance test suites that are shipped with the OpenSS7 IPERF Utility package.

Unverified behaviour may contain unknown bugs.

Please remember that there is NO WARRANTY.

See also Bugs, or file BUGS in the release directory.

Licenses

University of Illinois License



Distributed Applications Support Team
Iperf Copyright
Copyright © 1999, 2000, 2001, 2002, 2003, 2004 The Board of Trustees of
the University of Illinois
All Rights Reserved.
Mark Gates
Ajay Tirumala
Jim Ferguson
Jon Dugan
Feng Qin
Kevin Gibbs
National Laboratory for Applied Network Research
National Center for Supercomputing Applications
University of Illinois at Urbana-Champaign

Permission is hereby granted, free of charge, to any person obtaining a copy of this software (Iperf) and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimers in the documentation and/or other materials provided with the distribution.
  • Neither the names of the University of Illinois, NCSA, nor the names of its contributors may be used to endorse or promote products derived from this Software without specific prior written permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

dast@nlanr.net Last modified: Jan 5, 2004

GNU Affero General Public License



The GNU Affero General Public License.
Version 3, 19 November 2007
     Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/
     
     Everyone is permitted to copy and distribute verbatim copies of this
     license document, but changing it is not allowed.

Preamble

The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users.

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 them 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.

Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.

A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.

The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.

An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.

The precise terms and conditions for copying, distribution and modification follow.

TERMS AND CONDITIONS
  1. Definitions.

    “This License” refers to version 3 of the GNU Affero General Public License.

    “Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

    “The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

    To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

    A “covered work” means either the unmodified Program or a work based on the Program.

    To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

    To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

    An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

  2. Source Code.

    The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

    A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

    The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

    The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run t