OpenSS7 STREAMS SCTP

OpenSS7 STREAMS SCTP Installation and Reference Manual

About This Manual

This is Edition 8, last updated 2007-06-24, of The OpenSS7 STREAMS SCTP Installation and Reference Manual, for Version 0.9.2 release 8 of the OpenSS7 STREAMS SCTP package.

Preface

Notice

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

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

Abstract

This manual provides a Installation and Reference Manual for OpenSS7 STREAMS SCTP.

Objective

The objective of this manual is to provide a guide for the STREAMS programmer when developing STREAMS modules, drivers and application programs for OpenSS7 STREAMS SCTP.

This guide provides information to developers on the use of the STREAMS mechanism at user and kernel levels.

STREAMS was incorporated in UNIX System V Release 3 to augment the character input/output (I/O) mechanism and to support development of communication services.

STREAMS provides developers with integral functions, a set of utility routines, and facilities that expedite software design and implementation.

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 STREAMS SCTP 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 STREAMS SCTP 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 kernel 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 STREAMS mechanism at user and kernel levels 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 STREAMS SCTP package, strsctp-0.9.2.8.²

Version Control

     
     strsctp.texi,v
     Revision 0.9.2.26  2007/02/28 06:31:25  brian
     - updates and corrections, #ifdef instead of #if
     
     Revision 0.9.2.25  2007/01/05 06:25:06  brian
     - doc updates
     
     Revision 0.9.2.24  2007/01/03 14:18:06  brian
     - updated documentation for release
     
     Revision 0.9.2.23  2006/10/19 12:52:09  brian
     - added ETSI TS 102 144 PICS
     
     Revision 0.9.2.22  2006/09/18 01:07:11  brian
     - updated manuals and release texi docs
     
     Revision 0.9.2.21  2006/08/28 10:47:09  brian
     - correction
     
     Revision 0.9.2.20  2006/08/28 10:32:57  brian
     - updated references
     
     Revision 0.9.2.19  2006/08/27 12:27:09  brian
     - finalizing auto release files
     
     Revision 0.9.2.18  2006/08/26 09:19:09  brian
     - better release file generation
     
     Revision 0.9.2.17  2006/08/23 11:00:49  brian
     - added preface, corrections and updates for release
     
     Revision 0.9.2.16  2006/08/22 12:57:30  brian
     - updated documentation
     
     Revision 0.9.2.15  2006/03/22 10:02:06  brian
     - added makefile target index
     
     Revision 0.9.2.14  2006/03/03 11:46:59  brian
     - 32/64-bit compatibility
     
     Revision 0.9.2.13  2005/07/08 13:16:18  brian
     - updates to documentation
     
     Revision 0.9.2.12  2005/06/24 13:38:59  brian
     - added troubleshooting section to manuals
     
     Revision 0.9.2.11  2005/05/14 08:29:14  brian
     - copyright header correction
     
     Revision 0.9.2.10  2005/04/12 09:29:02  brian
     - corrections
     
     Revision 0.9.2.9  2005/04/11 20:48:41  brian
     - documentation updates and corrections
     
     Revision 0.9.2.8  2005/03/15 00:56:48  brian
     - Updated version numbering in texinfo files.
     
     Revision 0.9.2.7  2005/03/15 00:51:45  brian
     - Updated version numbering in texinfo files.
     
     Revision 0.9.2.6  2005/02/17 20:00:22  brian
     - Fixes for texi documentation.
     
     Revision 0.9.2.5  2005/01/24 11:57:58  brian
     - Updated texinfo headers.
     
     Revision 0.9.2.4  2004/12/19 15:15:17  brian
     - Corrected include position.
     
     Revision 0.9.2.3  2004/08/22 04:42:03  brian
     - Converted to common files.
     
     Revision 0.9.2.2  2004/08/21 11:04:32  brian
     - Checking in merge on new branch.
     
     Revision 0.9.2.1  2004/08/21 10:53:55  brian
     - Force checkin on branch.
     
     Revision 1.4  2004/08/20 21:14:14  brian
     - Updated documentation.
     
     Revision 1.3  2004/08/18 10:30:54  brian
     - Documentation embelleshments.
     
     Revision 1.2  2004/08/16 11:42:45  brian
     - Documentation updates.
     
     Revision 0.9  2004/06/20 20:35:34  brian
     branches:  0.9.2;
     - Working up separate sctp release.
     
     

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 STREAMS SCTP package was provided in part by:

Additional funding for The OpenSS7 Project was provided by:

Contributors

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

Authors

The authors of the OpenSS7 OpenSS7 STREAMS SCTP package include:

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

Maintainer

The maintainer of the OpenSS7 OpenSS7 STREAMS SCTP package is:

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 STREAMS SCTP 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 STREAMS SCTP 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 STREAMS SCTP

Package strsctp-0.9.2.8 was released under GPLv2 2007-06-24.

OpenSS7 STREAMS SCTP (strsctp) is an OpenSS7 Project implementation of Stream Control Transmission Protocol (SCTP - RFC 2960) for Linux Fast-STREAMS. It is based on the same protocol engine core as the OpenSS7 Linux Native (Sockets) version of OpenSS7 SCTP. The package provides a STREAMS SCTP driver for use with SIGTRAN components of the OpenSS7 stack.

This package is a separate release of the OpenSS7 STREAMS SCTP package that was formerly present in the strss7 package. The networking driver, sctp(4), is provided, as well as NPI, TPI and XTI header files for SCTP operation. The package contains the necessary manual pages and other documentation for SCTP components in a separate autoconf tarball. This release is also part of the OpenSS7 Master Package (openss7-0.9.2.F).

The package currently includes the following STREAMS kernel modules and drivers:

sctp(4)

The sctp(4) STREAMS driver is the primary STREAMS pseudo-device driver that implements the Stream Control Transmission Protocol (SCTP) described in RFC 2960 and RFC 4460.

tpiperf(4)

The tpiperf(4) STREAMS module contains the TPI performance test module. This STREAMS module is primarily for performance testing of the TPI interface of the sctp(4) driver.

The OpenSS7 STREAMS SCTP package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of Stream Control Transmission Protocol (SCTP) protocol stack components and applications for the Linux Fast-STREAMS environment.

This distribution is only currently applicable to Linux 2.4 and 2.6 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 strsctp-0.9.2.8 package, released 2007-06-24. This `0.9.2.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/strsctp-0.9.2.8.tar.bz2

The release is available as an autoconf(1) tarball, src.rpm or dsc, or as a set of binary rpms or debs. See the download page for the autoconf(1) tarballs, src.rpms or dscs. See the strsctp 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-strsctp 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 2 of the GNU 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.F, instead of separately.

Prerequisites for the OpenSS7 STREAMS SCTP 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.3
   	− Linux 2.4 kernel (2.4.10 - 2.4.27), or
   	− Linux 2.6 kernel (2.6.3 - 2.6.21);
   	− glibc2 or better.
   	− GNU info (for info files).
   	− GNU groff (for man pages).4

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

2. OpenSS7 Linux Fast-STREAMS, streams-0.9.2.3. ⁵
3. OpenSS7 STREAMS Compatibility Modules, strcompat-0.9.2.6.
4. OpenSS7 STREAMS XNS, strxns-0.9.2.6.
5. OpenSS7 STREAMS XTI/TLI, strxnet-0.9.2.11.

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:

     $> ../strsctp-0.9.2.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/strsctp-0.9.2.8.tar.bz2
     $> tar -xjvf strsctp-0.9.2.8.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../strsctp-0.9.2.8/configure --enable-autotest
     $> make
     $> make check
     $> sudo make install
     $> sudo make installcheck
     $> sudo make uninstall
     $> popd
     $> sudo rm -rf build
     $> rm -rf strsctp-0.9.2.8
     $> rm -f strsctp-0.9.2.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.⁶ Installation steps using the logging targets proceed as follows:

     $> wget http://www.openss7.org/tarballs/strsctp-0.9.2.8.tar.bz2
     $> tar -xjvf strsctp-0.9.2.8.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../strsctp-0.9.2.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 strsctp-0.9.2.8
     $> rm -f strsctp-0.9.2.8.tar.bz2

See README-make for additional specialized make targets.

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

Brief Installation Instructions

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

     $> wget http://www.openss7.org/tarballs/strsctp-0.9.2.8.tar.bz2

Unpack the tarball using a command such as:

     $> tar -xjvf strsctp-0.9.2.8.tar.bz2

The tarball will unpack into the relative subdirectory named after the package name: strsctp-0.9.2.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
     $> ../strsctp-0.9.2.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 ../strsctp-0.9.2.8/INSTALL

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

     $> ../strsctp-0.9.2.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 strsctp-0.9.2.8
     $> rm -f strsctp-0.9.2.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 ../strsctp-0.9.2.8
     $> less doc/manual/strsctp.txt
     $> lynx doc/manual/strsctp.html
     $> info doc/manual/strsctp.info
     $> xpdf doc/manual/strsctp.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/strsctp_manual.html

1 Introduction

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

1.1 Overview

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

The OpenSS7 STREAMS SCTP package is an implementation of the Stream Transmission Control Protocol (SCTP) for Linux as described in RFC 2960 and subsequent RFCs, that can be used with Linux Fast-STREAMS⁷. It includes development tools, header files and manual pages for OpenSS7 STREAMS SCTP.

1.2 Organization of this Manual

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

1.3 Conventions and Definitions

This manual uses texinfo typographic conventions.

2 Objective

3 Reference

3.1 Files

STRSCTP creates the following kernel modules files in the kernel modules directory, /lib/modules/2.4.20-28.7/:⁸

modules.strsctp

STRSCTP installs the following kernel module files in the kernel modules directory, /lib/modules/2.4.20-28.7/strsctp/:⁹

streams_sctp.ko

This kernel module contains the Stream Control Transmission Protocol (SCTP) driver.

streams_tpiperf.ko

This kernel module contains the Transport Provider Interface (TPI) performance test module.

STRSCTP installs the following header files in the system include directory, /usr/include/strsctp/:

sys/npi_sctp.h

This file contains Network Provider Interface (NPI) definitions for Stream Control Transmission Protocol (SCTP).

sys/tpi_sctp.h

This file contains Transport Provider Interface (TPI) definitions for Stream Control Transmission Protocol (SCTP).

sys/xti_sctp.h

This file contains X/Open Transport Interface/Transport Layer Interface (XTI/TLI) definitions for Stream Control Transmission Protocol (SCTP).

sys/strsctp/version.h

This file contains kernel and system tailoring information for the `OpenSS7 STREAMS SCTP' kernel modules.

2.4.20-28.7/i686/sys/strsctp/modversions.h

This file contains module and symbol version information for the `OpenSS7 STREAMS SCTP' kernel modules. This file is only applicable to Linux kernels in the 2.4 series. ¹⁰

STRSCTP installs the following test programs in the system libexec directory, /usr/libexec/strsctp/:¹¹

send-pr

send-pr.config

The send-pr stand-alone shell script can be used for the automatic generation of problem reports for the OpenSS7 STREAMS SCTP package. The send-pr.config file provides localized definitions used by the send-pr program. For more information on problem reports, See Problem Reports, and, in particular, See Stand Alone Problem Reports.

test-sctp

This binary from a C-language program contains a test program for the SCTP driver. For more information on test-sctp see the corresponding manual page: test-sctp(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

test-sctp_n

This binary from a C-language program contains a test program for the SCTP driver. This particular test program tests the historical Network Provider Interface (NPI) to the Stream Control Transmission Protocol (SCTP) driver: streams-sctp. For more information on test-sctp_n see the corresponding manual page: test-sctp_n(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

test-sctp_n2

This binary from a C-language program contains a test program for the SCTP driver. This particular test program tests the neo-classical Network Provider Interface (NPI) to the Stream Control Transmission Protocol (SCTP) driver: streams-sctp. For more information on test-sctp_n2 see the corresponding manual page: test-sctp_n2(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

test-sctp_nc

This binary from a C-language program contains a test program for the SCTP driver. For more information on test-sctp_nc see the corresponding manual page: test-sctp_nc(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

test-sctp_ns

This binary from a C-language program contains a test program for the SCTP driver. For more information on test-sctp_ns see the corresponding manual page: test-sctp_ns(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

test-sctp_t

This binary from a C-language program contains a test program for the SCTP driver. This particular test program tests the neo-classical Transport Provider Interface (TPI) to the Stream Control Transmission Protocol (SCTP) driver: streams-sctp. For more information on test-sctp_t see the corresponding manual page: test-sctp_t(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

test-etsi_n

This binary from a C-language program contains a test program for the SCTP driver. For more information on test-etsi_n see the corresponding manual page: test-etsi_n(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

test-etsi_t

This binary from a C-language program contains a test program for the SCTP driver. For more information on test-etsi_t see the corresponding manual page: test-etsi_t(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

test-interop

This binary from a C-language program contains a test program for the SCTP driver. For more information on test-interop see the corresponding manual page: test-interop(8). Test programs are normally invoked on a test case by test case basis by the validation test suite, testsuite.

testsuite

atlocal

The testsuite stand-alone shell script invokes test cases in the test programs above as compiled into a comprehensive regression, troubleshooting and validation test suite for the OpenSS7 STREAMS SCTP drivers. The atlocal file provides localized definitions used by the testsuite program. For more information on test suites, See Test Suites, and, in particular, See Running Test Suites.

STRSCTP installs the following utility programs in the system binary directory, /usr/sbin/:

strsctp_mknod

This utility can be used by init scripts or administrative users to create or remove device nodes in the /dev directory for OpenSS7 STREAMS SCTP drivers.

STRSCTP installs the following init scripts in the system init directory, /etc/rc.d/init.d/ (non-Debian) or /etc/init.d/ (Debian):

strsctp

This is the name of the system init script on non-Debian based systems.

strsctp.sh

This is the name of the system init script on Debian based systems.

STRSCTP installs the following system configuration files in the configuration directory, /etc/:

strsctp.conf

This file provided configuration information for any system controls affected by the `strsctp' package.

modutils/strsctp

This file provides module definitions and demand loading aliases for the strsctp package. This file is really only applicable to older 2.4 kernels.

netconfig.d/strsctp

This file provides the netconfig(5) definitions for the OpenSS7 STREAMS SCTP drivers. netconfig(5) definitions are used by the strnsl package and the libxnsl library.

sock2path.d/strsctp

This file provides the sock2path(5) definitions for the OpenSS7 STREAMS SCTP drivers. sock2path(5) definitions are used by the strsock package and the libsocket library.

STRSCTP installs the following system configuration file in the system configuration directory, /etc/sysconfig/ (non-Debian) or /etc/default/ (Debian):

strsctp

This file provides system configuration information used by init scripts for the `strsctp' package. Some options of init script execution can be controlled by this file.

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

strsctp.info

strsctp.info-1

strsctp.info-2

These files contain this manual in GNU info format.

STRSCTP installs the following manual page macros and reference database files in the system man directory, /usr/share/man/:¹²

strsctp.macros

This file contains manual page macro definitions included by the manual pages included in the package.

strsctp.refs

This file contains a reference database referenced by the manual pages included in the package.

STRSCTP installs the following manual pages in the system man directory, /usr/share/man/man3/:

xti_sctp.3.gz

Documentation of the SCTP specific options and primitive formats for the X/Open Transport Interface/Transport Layer Interface (XTI/TLI) for the Stream Control Transmission Protocol (SCTP) driver.

STRSCTP installs the following manual pages in the system man directory, /usr/share/man/man4/:

sctp.4.gz

This manual page provides an overview of the Stream Control Transmission Protocol (SCTP) driver and is a good starting point when referencing the manual pages.

sctp_n.4.gz

This manual page provides an overview of the Network Provider Interface (NPI) and the Stream Control Transmission Protocol (SCTP) driver and is a good staring point when referencing the manual pages.

sctp_t.4.gz

This manual page provides an overview of the Transport Provider Interface (TPI) and the Stream Control Transmission Protocol (SCTP) driver and is a good staring point when referencing the manual pages.

STRSCTP installs the following manual pages in the system man directory, /usr/share/man/man5/:

strsctp.5

manual page for the strsctp(5) package.

STRSCTP installs the following manual pages in the system man directory, /usr/share/man/man7/:

npi_sctp.7.gz

Documentation of the SCTP specific options and primitive formats for the Network Provider Interface (NPI) for the Stream Control Transmission Protocol (SCTP) driver.

tpi_sctp.7.gz

Documentation of the SCTP specific options and primitive formats for the Transport Provider Interface (TPI) for the Stream Control Transmission Protocol (SCTP) driver.

STRSCTP installs the following manual pages in the system man directory, /usr/share/man/man8/:

strsctp_mknod.8

Documentation for the strsctp_mknod(8) utility program.

test-sctp.8

Documentation for the test-sctp test program. This manual pages documents all of the options a operation of the test-sctp program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp. See the program source for detailed information on specific test cases.

test-sctp_n.8

Documentation for the test-sctp_n test program. This manual pages documents all of the options a operation of the test-sctp_n program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp_n. See the program source for detailed information on specific test cases.

test-sctp_nc.8

Documentation for the test-sctp_nc test program. This manual pages documents all of the options a operation of the test-sctp_nc program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp_nc. See the program source for detailed information on specific test cases.

test-sctp_ns.8

Documentation for the test-sctp_ns test program. This manual pages documents all of the options a operation of the test-sctp_ns program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp_ns. See the program source for detailed information on specific test cases.

test-sctp_t.8

Documentation for the test-sctp_t test program. This manual pages documents all of the options a operation of the test-sctp_t program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp_t. See the program source for detailed information on specific test cases.

test-etsi_n.8

Documentation for the test-etsi_n test program. This manual pages documents all of the options a operation of the test-etsi_n program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-etsi_n. See the program source for detailed information on specific test cases.

test-etsi_t.8

Documentation for the test-etsi_t test program. This manual pages documents all of the options a operation of the test-etsi_t program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-etsi_t. See the program source for detailed information on specific test cases.

3.2 Drivers

The OpenSS7 STREAMS SCTP package provides the following STREAMS drivers:

streams-sctp

This is the primary STREAMS psuedo-device driver that implements the Stream Control Tramission Protocol (SCTP) described in RFC 2960 and RFC 4460.

3.3 Modules

The OpenSS7 STREAMS SCTP package provides the following STREAMS modules:

streams-tpiperf

This STREAMS module is primarily for performance testing of the TPI interface of the streams-sctp driver.¹³

3.4 Libraries

The OpenSS7 STREAMS SCTP package provides the following shared object and static libraries:

The OpenSS7 STREAMS SCTP package does not currently provide any libraries.

3.5 Utilities

3.5.1 Init Scripts

Following are System V Init Scripts that are installed by the package:

strsctp(8) (/etc/init.d/strsctp)

strsctp.sh(8) (/etc/init.d/strsctp.sh)

System V Init Script for the SCTP Subsystem. The strsctp(8) init script provides the ability to initialize, configure and mount the SCTP subsystem, strxnet(5). The strsctp(8) script provides the RedHat-style init script, whereas the strsctp.sh(8) script provides the Debian-style init script.

See strsctp(8) for more information.

3.5.2 Administrative Utilities

Following are user utilities for manipulating INET:

The OpenSS7 STREAMS SCTP package builds and installs the following utilities:

strsctp_mknod

This is a C-language program that can be used by startup scripts to create device nodes for the `strsctp' package. This utility is normally installed in the /usr/sbin directory. See strsctp_mknod(8) for more information.

strsctp

This is a RedHat-style System V init script that is installed and used to start and stop the `strsctp' package. Starting consists of creating SCTP device nodes using strsctp_mknod and installing the streams-sctp and streams-tpiperf modules in the running kernel. This init script is normally installed in the /etc/init.d directory.

strsctp.sh

This is a Debian-style System V init script that is installed and used to start and stop the `strsctp' package in a similar fashion to the strsctp script, but in the Debian style. This init script is normally installed in the /etc/rc.d/init.d directory.

3.5.3 Performance Test Programs

Following are performance test programs:

The OpenSS7 STREAMS SCTP package does not yet contain any performance programs. For performance testing of various transport providers, see the netperf-2.3.6 package.

3.5.4 Conformance Test Programs

Following are conformance and validation test programs included in the package:

The OpenSS7 STREAMS SCTP package builds and installs the following test programs:

test-etsi_n

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-etsi_n test program, see test-etsi_n(8).

test-etsi_t

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-etsi_t test program, see test-etsi_t(8).

test-sctp

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-sctp test program, see test-sctp(8).

test-sctp_n

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-sctp_n test program, see test-sctp_n(8).

test-sctp_n2

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-sctp_n2 test program, see test-sctp_n2(8).

test-sctp_t

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-sctp_t test program, see test-sctp_t(8).

test-interop

test-interop is similar to test-sctp_t; however, the program has been modified to permit just the initiating or responding side of the test case to be executed so that it can be run against other implementations. This test program was used in the 2006 SCTP Interop at the University of British Columbia in July/August 2006. This program is provided for historical purposes.

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-interop test program, see test-interop(8).

testsuite

When executed, this bash script executes test cases from the above test programs to form a complete testsuite of the SCTP implementation.

This test script normally installs in directory /usr/libexec/strsctp.

test-sctp_nc

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-sctp_nc test program, see test-sctp_nc(8).

test-sctp_ns

This test program normally installs in directory /usr/libexec/strsctp. For more information on the test-sctp_ns test program, see test-sctp_ns(8).

For more information on the use of the problem reporting scripts, see Generating Problem Reports.

4 Development

OpenSS7 STREAMS SCTP provides all of the header files, shared object and static libraries, manual pages and documentation necessary for the development of both user space applications programs and kernel space STREAMS modules and drivers based on the package. The sections that follow describe these development facilities.

4.1 Header Files

Header files are installed, typically, in the /usr/include/strsctp/ subdirectory. To use the header files from the package, `-I/usr/include/strsctp' must be included in the gcc command line as a preprocessor option.

In general, `-I' include preprocessor directives on the gcc command line should be ordered in the reverse order of the dependencies between packages. So, for example, if the include files from all add-on packages are required, the order of these directives would be: `-I/usr/include/strsctp' `-I/usr/include/strxns' `-I/usr/include/strcompat' `-I/usr/include/streams'.

Following are the user visible header files provided by the strsctp-0.9.2.8 package in the directory /usr/include/strsctp:

4.1.1 User Space Programs

Typical include files for interacting with Transport providers from user space include the xti.h header file. Additional header files for interacting with specific drivers or modules may also be required. The xti.h header file is for interacting with the XTI library.

4.1.2 Kernel Space Drivers and Modules

Typeical include files for writing STREAMS module and drivers implementing transport providers in kernels space include xti.h and xti_sctp.h. The header files provide access to definitions for the TPI interface and additional XTI definitions for use by STREAMS drivers and modules. Additional header files for interacting with specific drivers or modules may also be required.

Aside from including this header files, the general procedures for compiling STREAMS modules and drivers also apply to STREAMS modules and drivers written to the Transport Provider Interface.

4.2 Libraries

Shared or static version of the libxnet library may be linked when using the strsctp-0.9.2.8 package.¹⁴ The library may either be specified on the gcc command line as a shared library (e.g. `-lxnet') or as a static library (e.g. `/usr/lib/libxnet.a').

If the shared object library is linked, include the following options on the gcc command line:

`-lxnet'

Link to the /usr/lib/libxnet.so shared library.

If the static library is linked, include the following options on the gcc command line:

`/usr/lib/libxnet.a'

Link to the /usr/lib/libxnet.a static library.

4.3 Kernel Modules

Developing TPI kernel modules is similar to user space programs with regard to header files. /usr/include/strxnet should be placed as an include directory to search on the gcc command line. The rules for compiling Linux kernel modules and the rules for compiling STREAMS modules and drivers should be followed. In particular, several important intricacies should be considered:

• The gcc compiler used to compile the kernel modules must be the same version of compiler that was used to compile the kernel and STREAMS base package.
• The gcc command line must have the same compile flags that were used to compile the kernel and STREAMS base package. kbuild can be used to accomplish this.
• The gcc command line must define several important kernel defines including `-DLINUX', `-D__KERNEL__', as well as the base name of the module. Again, kbuild can be used to accomplish this.
• The gcc command line must include several important files directly on the command line, such as, `--include /lib/modules/2.4.20-28.7/build/include/linux/autoconf.h' and `--include /lib/modules/2.4.20-28.7/build/include/linux/modversions.h'.¹⁵

4.4 Manual Pages

To assist in the development of user programs and STREAMS driver or modules using the OpenSS7 STREAMS SCTP protocol module, the following manual pages are provided:

The strsctp-0.9.2.8 package installs a number of manual pages in the /usr/share/man directory as follows:

The following manual pages are installed in Section 3 of the manual (in the subdirectory /usr/share/man/man3):

npi_sctp(7)

The npi_sctp(7) manual page describes the differences between the generic Network Provider Interface (NPI) specification and the options and primitive formats specific to the Stream Control Transmission Protocol (SCTP).

tpi_sctp(7)

The tpi_sctp(7) manual page describes the differences between the generic Transport Provider Interface (TPI) specification and the options and primitive formats specific to the Stream Control Transmission Protocol (SCTP).

xti_sctp(3)

The xti_sctp(3) manual page describes the differences between the generic X/Open Transport Interface/Transport Layer Interface (XTI/TLI) interface and the options and formats specific to the Stream Control Transmission Protocol (SCTP).

sctp(4)

Provides an overview of the Streams Control Transmission Protocol (SCTP) driver.

sctp_n(4)

Provides an overview description of the Network Provider Interface (NPI) service interface to the Stream Control Transmission Protocol (SCTP) driver.

sctp_t(4)

Provides an overview description of the Transport Provider Interface (TPI) service interface to the Stream Control Transmission Protocol (SCTP) driver.

strsctp_mknod(8)

Provides a description of the strsctp_mknod(8) command.

test-sctp(8)

Provides a description of the test-sctp(8) test program. This manual pages documents all of the options a operation of the test-sctp program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp. See the program source for detailed information on specific test cases.

test-sctp_n(8)

Provides a description of the test-sctp_n(8) test program. This manual pages documents all of the options a operation of the test-sctp_n program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp_n. See the program source for detailed information on specific test cases.

test-sctp_nc(8)

Provides a description of the test-sctp_nc(8) test program. This manual pages documents all of the options a operation of the test-sctp_nc program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp_nc. See the program source for detailed information on specific test cases.

test-sctp_ns(8)

Provides a description of the test-sctp_ns(8) test program. This manual pages documents all of the options a operation of the test-sctp_ns program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp_ns. See the program source for detailed information on specific test cases.

test-sctp_t(8)

Provides a description of the test-sctp_t(8) test program. This manual pages documents all of the options a operation of the test-sctp_t program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-sctp_t. See the program source for detailed information on specific test cases.

test-etsi_n(8)

Provides a description of the test-etsi_n(8) test program. This manual pages documents all of the options a operation of the test-etsi_n program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-etsi_n. See the program source for detailed information on specific test cases.

test-etsi_t(8)

Provides a description of the test-etsi_t(8) test program. This manual pages documents all of the options a operation of the test-etsi_t program but does not delve into the test cases themselves. Descriptions of the test cases can be printed using the `--list' option to test-etsi_t. See the program source for detailed information on specific test cases.

To assist in the development of user programs and STREAMS driver or modules using the OpenSS7 STREAMS SCTP protocol module, the following header files are provided: