OpenSS7 STREAMS SIGTRAN

OpenSS7 STREAMS SIGTRAN Installation and Reference Manual

About This Manual

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

Preface

Notice

This package is released and distributed under the GNU General Public License (see GPL). 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 SIGTRAN.

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

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 SIGTRAN 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 SIGTRAN 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 SIGTRAN package.

Version Control

     
     sigtran.texi,v
     Revision 0.9.2.4  2007/06/22 00:18:29  brian
     - mostly documentation updates for release, some netconfig workaround
     
     Revision 0.9.2.3  2007/02/28 06:30:32  brian
     - updates and corrections, #ifdef instead of #if
     
     Revision 0.9.2.2  2006/12/31 13:37:38  brian
     - documentation updates for release
     
     Revision 0.9.2.1  2006/10/16 10:42:45  brian
     - added new package files
     
     

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

Additional funding for The OpenSS7 Project was provided by:

Contributors

The primary contributor to the OpenSS7 OpenSS7 STREAMS SIGTRAN 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 SIGTRAN 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 SIGTRAN 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 SIGTRAN 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 SIGTRAN 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 SIGTRAN

Package sigtran-0.9.2.3 was released under GPLv2 2007-06-24.

The OpenSS7 STREAMS SIGTRAN package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of OpenSS7 STREAMS SIGTRAN applications for the SVR 4.2 STREAMS environment.

This package contains modules and drivers formerly only part of the Commercial releases of the strss7 package. These are commercial grade implementations that have only recently been released as open source.

The public release currently contains the following STREAMS drivers and modules:

streams-m2pa_sl

streams-m2ua_as

streams-m3ua_as

streams-sdl_sctp

streams-sdt_sctp

streams-sdt_tpi

streams-sl_tpi

m2pa_sl(4)

m2ua_as(4)

m3ua_as(4)

sdl_sctp(4)

sdt_sctp(4)

sdt_tpi(4)

sl_tpi(4)

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 sigtran-0.9.2.3 package, released 2007-06-24. This `0.9.2.3' 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/sigtran-0.9.2.3.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 sigtran 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-sigtran 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 SIGTRAN 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.21);
   	− glibc2 or better.
   	− GNU info (for info files).
   	− GNU groff (for man pages).3

(Note: If you acquired sigtran 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.
6. OpenSS7 STREAM Network Services Library, strnsl-0.9.2.3. (Optional.)
7. OpenSS7 STREAMS Sockets, strsock-0.9.2.3. (Optional.)
8. OpenSS7 STREAMS INET, strinet-0.9.2.6.
9. OpenSS7 STREAMS SCTP, strsctp-0.9.2.8.
10. OpenSS7 STREAMS Channels, striso-0.9.2.3.
11. OpenSS7 STREAMS ISO, striso-0.9.2.3.
12. OpenSS7 STREAMS ISDN, strisdn-0.9.2.3.
13. OpenSS7 STREAMS SS7, strss7-0.9a.7.

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:

     $> ../sigtran-0.9.2.3/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/sigtran-0.9.2.3.tar.bz2
     $> tar -xjvf sigtran-0.9.2.3.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../sigtran-0.9.2.3/configure --enable-autotest
     $> make
     $> make check
     $> sudo make install
     $> sudo make installcheck
     $> sudo make uninstall
     $> popd
     $> sudo rm -rf build
     $> rm -rf sigtran-0.9.2.3
     $> rm -f sigtran-0.9.2.3.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/sigtran-0.9.2.3.tar.bz2
     $> tar -xjvf sigtran-0.9.2.3.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../sigtran-0.9.2.3/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 sigtran-0.9.2.3
     $> rm -f sigtran-0.9.2.3.tar.bz2

See README-make for additional specialized make targets.

For custom applications, see the INSTALL and INSTALL-sigtran 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 SIGTRAN package is available from the downloads area of The OpenSS7 Project website using a command such as:

     $> wget http://www.openss7.org/tarballs/sigtran-0.9.2.3.tar.bz2

Unpack the tarball using a command such as:

     $> tar -xjvf sigtran-0.9.2.3.tar.bz2

The tarball will unpack into the relative subdirectory named after the package name: sigtran-0.9.2.3.

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
     $> ../sigtran-0.9.2.3/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 ../sigtran-0.9.2.3/INSTALL

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

     $> ../sigtran-0.9.2.3/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 sigtran-0.9.2.3
     $> rm -f sigtran-0.9.2.3.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 ../sigtran-0.9.2.3
     $> less doc/manual/sigtran.txt
     $> lynx doc/manual/sigtran.html
     $> info doc/manual/sigtran.info
     $> xpdf doc/manual/sigtran.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/sigtran_manual.html

1 Introduction

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

1.1 Overview

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

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

SIGTRAN creates the following kernel modules files in the kernel modules directory, /lib/modules/2.4.20-28.7/:⁶

modules.sigtran

SIGTRAN installs the following kernel module files in the kernel modules directory, /lib/modules/2.4.20-28.7/sigtran/:⁷

streams_m2pa_sl.ko

streams_m2ua_as.ko

streams_m3ua_as.ko

streams_sdl_sctp.ko

streams_sdt_sctp.ko

streams_sdt_tpi.ko

streams_sl_tpi.ko

SIGTRAN installs the following header files in the system include directory, /usr/include/sigtran/:

sys/sigtran/config.h

sys/sigtran/version.h

sys/dlpi_dua.h

sys/dlpi_gr303ua.h

sys/dlpi_iua.h

sys/dlpi_m2ua.h

sys/dlpi_v5ua.h

sys/dua_ioctl.h

sys/gr303ua_ioctl.h

sys/iua_ioctl.h

sys/m2pa_ioctl.h

sys/m2ua_ioctl.h

sys/m3ua.h

sys/m3ua_ioctl.h

sys/ua_ioctl.h

sys/ua_lm.h

sys/ua_lm_ioctl.h

sys/v5ua_ioctl.h

SIGTRAN installs the following test programs in the system libexec directory, /usr/libexec/sigtran/:⁸

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 SIGTRAN 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-sigtran

test case executable.

test-m2pa

test case executable.

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

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

sigtran_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 SIGTRAN drivers.

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

sigtran

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

sigtran.sh

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

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

sigtran.conf

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

modutils/sigtran

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

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

sigtran

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

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

sigtran.info

sigtran.info-1

sigtran.info-2

These files contain this manual in GNU info format.

SIGTRAN installs the following manual page macros and reference database files in the system man directory, /usr/share/man/:⁹

sigtran.macros

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

sigtran.refs

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

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

bua.4

bua_ioctl.4

dl_dua.4

dl_gr303ua.4

dl_iua.4

dl_v5ua.4

dua.4

dua_ioctl.4

gr303ua.4

gr303ua_ioctl.4

isua.4

isua_ioctl.4

iua.4

iua_ioctl.4

m2ua.4

m2ua_as.4

m2ua_ioctl.4

m3pa.4

m3tp.4

m3ua.4

m3ua_as.4

m3ua_ioctl.4

SIGTRAN.4

sua.4

sua-gtt.4

sua_ioctl.4

sua-mgmt.4

sua-npi.4

sua-sccpi.4

sua-tpi.4

tali.4

tali_ioctl.4

tali-isup.4

tali-mtp.4

tali-sccp.4

tua.4

tua_ioctl.4

ua_ioctl.4

v5ua.4

v5ua_ioctl.4

m2pa.4

m2pa_sl.4

m2tp.4

sdl_sctp.4

sdt_sctp.4

sdt_tpi.4

sl_sctp.4

sl_tpi.4

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

sigtran.5

manual page for the sigtran(5) package.

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

dlpi_dua.7

dlpi_gr303ua.7

dlpi_iua.7

dlpli_gr303ua.7

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

sigtran_mknod.8

Documentation for the sigtran_mknod(8) utility program.

bua.8

isua.8

iua.8

m2pa.8

m2tp.8

m2ua.8

m3tp.8

m3ua.8

sigtran.8

sua.8

tua.8

uaconfd.8

test-m2pa.8

test-sigtran.8

3.2 Drivers

The configuration of STREAMS drivers is performed when compiling the OpenSS7 STREAMS SIGTRAN subsystem. The SIGTRAN subsystem, core drivers are part of every OpenSS7 STREAMS SIGTRAN system.

Kernel modules are installed by the OpenSS7 STREAMS SIGTRAN package in the /lib/modules/2.4.20-28.7/sigtran/ directory, with either a `.o' or `.ko' extension.¹⁰

The following lists the core drivers, STREAMS kernel tunable parameters, and STREAMS configuration information:¹¹

3.3 Modules

The configuration of STREAMS modules is performed when compiling the OpenSS7 STREAMS SIGTRAN subsystem. The STREAMS subsystem, core modules are part of every OpenSS7 STREAMS SIGTRAN system.

Kernel modules are installed by the OpenSS7 STREAMS SIGTRAN package in the /lib/modules/2.4.20-28.7/sigtran/ directory, with either a `.o' or `.ko' extension.¹²

The following lists the core modules:¹³

m2pa_sl(4) (streams-m2pa_sl)

This module contains the M2PA STREAMS module. This module is pushed over an SCTP NPI Stream to form a complete SS7 signalling link implementation over IP providing the Signalling Link Interface (SLI). See m2pa_sl(4) for more information.

m2ua_as(4) (streams-m2ua_as)

This module contains the M2UA-AS STREAMS module. This module is pushed over an SCTP NPI Stream to form a complete SS7 signalling link implementation over IP providing the Signalling Link Interface (SLI). This is a simpler AS-side only implementation of M2UA. See m2ua_as(4) for more information.

m3ua_as(4) (streams-m3ua_as)

This module contains the M3UA-AS STREAMS module. This module is pushed over an SCTP NPI Stream to form a complete SS7 signalling link implementation over IP providing the Signalling Link Interface (SLI). This is a simpler AS-side only implementation of M3UA. See m3ua_as(4) for more information.

sdl_sctp(4) (streams-sdl_sctp)

This module contains an SCTP STREAMS module. This module is pushed over an SCTP NPI Stream to form a Signalling Data Link implementation over IP providing the Signalling Data Link Interface (SDLI). This is a non-standard but common approach to providing HDLC/DAED communication using SCTP and predates M2PA/M2UA. See sdl_sctp(4) for more information.

sdt_sctp(4) (streams-sdt_sctp)

This module contains an SCTP STREAMS module. This module is pushed over an SCTP NPI Stream to form a Signalling Data Terminal implementation over IP providing the Signalling Data Terminal Interface (SDTI). This is a non-standard but common approach to providing HDLC/DAED communication using SCTP and predates M2PA/M2UA. See sdt_sctp(4) for more information.

sdt_tpi(4) (streams-sdt_tpi)

This module contains an TPI STREAMS module. This module is pushed over any TPI transport Stream to form a Signalling Data Terminal implementation over IP providing the Signalling Data Terminal Interface (SDTI). This is a non-standard but common approach to providing HDLC/DAED communication using any TPI transport (e.g. UDP) and predates M2PA/M2UA. See sdt_tpi(4) for more information.

sl_tpi(4) (streams-sl_tpi)

This module contains an TPI STREAMS module. This module is pushed over any TPI transport Stream to form a Signalling Link implementation over IP providing the Signalling Link Interface (SLI). This is a non-standard but common approach to providing SS7 link communication using any TPI transport (e.g. UDP) and predates M2PA/M2UA. See sl_tpi(4) for more information.

3.4 Libraries

3.5 Utilities

3.5.1 Init Scripts

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

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

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

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

See sigtran(8) for more information.

3.5.2 User Utilities

Following are the user utilities for manipulating Streams:

3.5.3 Administrative Utilities

Following are the administrative utilities for manipulating and examining the SIGTRAN subsystem:

3.5.4 Performance Test Programs

Following are performance test programs:

3.5.5 Conformance Test Programs

Following are conformance test programs:

test-sigtran(8) (/usr/libexec/sigtran/test-sigtran)

The test-sigtran(8) C-language program is a conformance and validation test program, in the OpenSS7 Project style, for the sigtran(5) STREAMS package.

See test-sigtran(8) for more information.

test-m2pa(8) (/usr/libexec/sigtran/test-m2pa)

The test-m2pa(8) C-language program is a conformance and validation test program, in the OpenSS7 Project style, for the m2pa_sl(4) STREAMS module.

See test-m2pa(8) for more information.

For the proper way to execute these validation test programs in a conformance and validation test suite, see Running Test Suites.

3.6 Development

3.6.1 Header Files

Header files are installed, typically, in the /usr/include/sigtran subdirectory. To use the header files from the package, `-I/usr/include/sigtran' must be included in the gcc command line as a C preprocessor option. This is true regardless of whether user space or kernel space programs are being compiled.

In general, `-I' include 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/strvoip -I/usr/include/sigtran -I/usr/include/strss7 -I/usr/include/strisdn -I/usr/include/striso -I/usr/include/strchan -I/usr/include/strsctp -I/usr/include/strsctp -I/usr/include/strsock -I/usr/include/strnsl -I/usr/include/strxnet -I/usr/include/strxns -I/usr/include/strtty -I/usr/include/strcompat -I/usr/include/streams'.

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

sys/ua_lm.h

sys/ua_lm_ioctl.h

sys/ua_ioctl.h

These are the primary header files for all SIGTRAN(4) drivers and modules. They are normally only included by user space programs when interacting with a given SIGTRAN(4) driver or module. See SIGTRAN(4) for more information.

sys/dlpi_iua.h

sys/iua_ioctl.h

These are the primary header files for use with the iua(4) driver or iua_as(4) module. The sys/dlpi_iua.h file defines any extensions necessary to the Data Link Provider Interface (dlpi(7)) for the iua(4) driver or iua_as(4) module. The sys/iua_ioctl.h file defines any private input-output controls necessary for use by the iua(4) driver or iua_as(4) module. This later file is normally only included by user space programs when interacting with the iua(4) driver or iua_as(4) module. See iua(4) and iua_as(4) for more information.

sys/dlpi_dua.h

sys/dua_ioctl.h

These are the primary header files for use with the dua(4) driver or dua_as(4) module. The sys/dlpi_dua.h file defines any extensions necessary to the Data Link Provider Interface (dlpi(7)) for the dua(4) driver or dua_as(4) module. The sys/dua_ioctl.h file defines any private input-output controls necessary for use by the dua(4) driver or dua_as(4) module. This later file is normally only included by user space programs when interacting with the dua(4) driver or dua_as(4) module. See dua(4) and dua_as(4) for more information.

sys/dlpi_gr303ua.h

sys/gr303ua_ioctl.h

These are the primary header files for use with the gr303ua(4) driver or gr303ua_as(4) module. The sys/dlpi_gr303ua.h file defines any extensions necessary to the Data Link Provider Interface (dlpi(7)) for the gr303ua(4) driver or gr303ua_as(4) module. The sys/gr303ua_ioctl.h file defines any private input-output controls necessary for use by the gr303ua(4) driver or gr303ua_as(4) module. This later file is normally only included by user space programs when interacting with the gr303ua(4) driver or gr303ua_as(4) module. See gr303ua(4) and gr303ua_as(4) for more information.

sys/dlpi_v5ua.h

sys/v5ua_ioctl.h

These are the primary header files for use with the v5ua(4) driver or v5ua_as(4) module. The sys/dlpi_v5ua.h file defines any extensions necessary to the Data Link Provider Interface (dlpi(7)) for the v5ua(4) driver or v5ua_as(4) module. The sys/v5ua_ioctl.h file defines any private input-output controls necessary for use by the v5ua(4) driver or v5ua_as(4) module. This later file is normally only included by user space programs when interacting with the v5ua(4) driver or v5ua_as(4) module. See v5ua(4) and v5ua_as(4) for more information.

sys/m2pa_ioctl.h

These are the primary header files for use with the m2pa_sl(4) driver. The sys/m2pa_ioctl.h file defines any private input-output controls necessary for use by the m2pa_sl(4) driver. This file is normally only included by user space programs when interacting with the m2pa_sl(4) driver. See m2pa_sl(4) for more information.

sys/dlpi_m2ua.h

sys/m2ua_ioctl.h

These are the primary header files for use with the m2ua(4) driver or m2ua_as(4) module. The sys/dlpi_m2ua.h file defines any extensions necessary to the Data Link Provider Interface (dlpi(7)) for the m2ua(4) driver or m2ua_as(4) module. The sys/m2ua_ioctl.h file defines any private input-output controls necessary for use by the m2ua(4) driver or m2ua_as(4) module. This later file is normally only included by user space programs when interacting with the m2ua(4) driver or m2ua_as(4) module. See m2ua(4) and m2ua_as(4) for more information.

sys/m3ua.h

sys/m3ua_ioctl.h

These are the primary header files for use with the m3ua(4) driver. The sys/m3ua.h file defines any extensions necessary to the Message Transfer Part Interface (mtpi(7)) for the m3ua(4) driver. The sys/m3ua_ioctl.h file defines any private input-output controls necessary for use by the m3ua(4) driver. This later file is normally only included by user space programs when interacting with the m3ua(4) driver. See m3ua(4) for more information.

3.6.1.1 User Space Programs

Typical include files for interacting with SIGTRAN from user space include the stropts.h and sys/ua_ioctl.h header files. Additional header files for interacting with specific drivers or modules may also be required.

3.6.1.2 Kernel Space Drivers and Modules

Typical include files for writing STREAMS modules and drivers for kernel space include the sys/cmn_err.h, sys/kmem.h, sys/dki.h, sys/stream.h, sys/ddi.h, sys/strconf.h, sys/ua_lm.h header files. Additional header files for interacting with specific drivers or modules may also be required.

3.6.2 Libraries

Shared or static versions of the libstreams library must be linked when using the sigtran-0.9.2.3 package. This library must either be specified on the gcc command line as a shared library (e.g. `-lstreams') or as a static library (e.g. `/usr/lib/libstreams.a').

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

`-lstreams'

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

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

`/usr/lib/libstreams.a'

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

3.6.3 Kernel Modules

Developing STREAMS kernel modules is similar to user space programs with regard to header files. /usr/include/sigtran should be placed as an include directory to search in the gcc command line. The rules for compiling Linux kernel modules 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.
• The gcc command line must have the same compile flags that were used to compile the kernel.
• The gcc command line must define several important kernel defines including `-DLINUX', `-D__KERNEL__', as well as the base name of the module.
• The gcc command line must include several important include files directly on the command line such as `--include /lib/modules/2.4.20-28.7/build/include/linux/autoconf.h' and maybe even `--include /lib/modules/2.4.20-28.7/build/include/linux/modversions.h'.¹⁴

3.6.4 Manual Pages

The sigtran-0.9.2.3 package installs a number of manual pages. The number of manual pages installed totals several hundred manual pages and they will not be listed here.

4 Conformance

5 Releases