OpenSS7 X.25 Networking

OpenSS7 X.25 Networking Installation and Reference Manual

About This Manual

This is Edition 1, last updated 2008-10-31, of The OpenSS7 X.25 Networking Installation and Reference Manual, for Version 0.9.2 release 1 of the OpenSS7 X.25 Networking 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 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 no sections invariant.

Abstract

This manual provides a Installation and Reference Manual for OpenSS7 X.25 Networking.

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 X.25 Networking.

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 X.25 Networking 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 X.25 Networking 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 X.25 Networking package, strx25-0.9.2.1.²

Version Control

     strx25.texi,v
     Revision 0.9.2.4  2008-09-20 11:04:41  brian
     - added package patchlevel
     
     Revision 0.9.2.3  2008-08-03 06:03:41  brian
     - protected agains texinfo commands in log entries
     
     Revision 0.9.2.2  2008/07/27 08:49:53  brian
     - no invariant sections, more libtool ignores
     
     Revision 0.9.2.1  2008-05-03 10:46:37  brian
     - added 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 X.25 Networking package was provided in part by:

Additional funding for The OpenSS7 Project was provided by:

Contributors

The primary contributor to the OpenSS7 OpenSS7 X.25 Networking 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 X.25 Networking 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 X.25 Networking 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 X.25 Networking 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 X.25 Networking 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 X.25 Networking

Package strx25-0.9.2.1 was released under AGPLv3 2008-10-31.

OpenSS7 X.25 Networking (strx25) is an OpenSS7 Project implementation of various X.25 networking components for Linux Fast-STREAMS.

This release is the first separate release of the OpenSS7 X.25 Networking package. Some of the components in this package were formerly present in the strss7 package. Various networking drivers are provided as well as CDI, DLPI, NPI, TPI and XTI header files for X.25 operation. The package contains the necessary manual pages and other documentation for X.25 components in a separate autoconf tarball.

The package uses the following standard Open Systems Interconnect (OSI) conforming header files from the strxns package:

The package uses the following standard Open Systems Interconnect (OSI) conforming header files from the strxnet package:

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

• x223(4) driver provides CONS and CLNS services in accordance with the ISO/OSI Network Protocol X.223;
• x224(4) driver provides OSI Transport Protocol services in accordance with the ISO/OSI Transport Protocol X.224;
• isot(4) driver and module provides ISO Transport over TCP/IP as specified in RFC 1006/STD 35;
• lpp(4) driver and module provides ISO Transport over TCP/IP as specified in RFC 1085;
• cmot(4) driver and modules provides ISO Common Management Information Protocol (CMIP) over TCP/IP as specified in RFC 1095;
• itot(4) module provides ISO Transport over TCP as specified in RFC 2126; and,
• itos(4) module provides ISO Transport over SCTP.

The OpenSS7 X.25 Networking package includes kernel modules, SVR 4.2 STREAMS drivers, modules, libraries, utilities, test programs, daemons, and development environment for the development and execution of X/Open Network Services (ISO) protocol stack components and applications for the SVR 4.2 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 strx25-0.9.2.1 package, released 2008-10-31. This ‘0.9.2.1’ 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/strx25-0.9.2.1.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 strx25 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-strx25 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

2.6.26exinfo -*- vim: ft=texinfo

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 X.25 Networking 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.26);
   	− glibc2 or better.
   	− GNU groff (for man pages).4
   	− GNU texinfo (for info files).
   	− GNU bison and flex (for config programs).
   	− net-snmp (for SNMP agents).5

(Note: If you acquired strx25 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.4. ⁶
3. OpenSS7 STREAMS Compatibility Modules, strcompat-0.9.2.7.
4. OpenSS7 STREAMS XNS, strxns-0.9.2.7.
5. OpenSS7 STREAMS XTI/TLI, strxnet-0.9.2.12.
6. OpenSS7 STREAM Network Services Library, strnsl-0.9.2.4. (Optional.)
7. OpenSS7 STREAMS Sockets, strsock-0.9.2.4. (Optional.)
8. OpenSS7 STREAMS INET, strinet-0.9.2.7.
9. OpenSS7 STREAMS SCTP, strsctp-0.9.2.9.
10. OpenSS7 STREAMS Channels, strchan-0.9.2.4.

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:

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

See README-make for additional specialized make targets.

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

Brief Installation Instructions

The OpenSS7 X.25 Networking package is available from the downloads area of The OpenSS7 Project website using a command such as:

     $> wget http://www.openss7.org/tarballs/strx25-0.9.2.1.tar.bz2

Unpack the tarball using a command such as:

     $> tar -xjvf strx25-0.9.2.1.tar.bz2

The tarball will unpack into the relative subdirectory named after the package name: strx25-0.9.2.1.

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
     $> ../strx25-0.9.2.1/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 ../strx25-0.9.2.1/INSTALL

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

     $> ../strx25-0.9.2.1/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 strx25-0.9.2.1
     $> rm -f strx25-0.9.2.1.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 ../strx25-0.9.2.1
     $> less doc/manual/strx25.txt
     $> lynx doc/manual/strx25.html
     $> info doc/manual/strx25.info
     $> xpdf doc/manual/strx25.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/strx25_manual.html

1 Introduction

This manual documents the design, implementation, installation, operation and future development schedule of the OpenSS7 X.25 Networking package.

1.1 Overview

This manual documents the design, implementation, installation, operation and future development of the OpenSS7 X.25 Networking package.

The OpenSS7 X.25 Networking package is a STREAMS X25 Networking (X25) package for Linux that can be used with Linux Fast-STREAMS⁸. It includes development tools, header files and manual pages for OpenSS7 X.25 Networking.

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

STRX25 creates the following kernel modules files in the kernel modules directory, /lib/modules/2.4.20-28.7/:⁹

modules.strx25

STRX25 installs the following kernel module files in the kernel modules directory, /lib/modules/2.4.20-28.7/strx25/:¹⁰

streams_cmot.ko

This kernel module contains the STREAMS cmot(4) module.

streams_isot.ko

This kernel module contains the STREAMS isot(4) module.

streams_itot.ko

This kernel module contains the STREAMS itot(4) module.

streams_lpp.ko

This kernel module contains the STREAMS lpp(4) module.

streams_tcpns.ko

This kernel module contains the STREAMS tcpns(4) module.

streams_xot.ko

This kernel module contains the STREAMS xot(4) module.

streams_clns.ko

This kernel module contains the STREAMS clns(4) driver.

streams_x25-lapb.ko

This kernel module contains the STREAMS lapb(4) driver.

streams_x25-plp.ko

This kernel module contains the STREAMS plp(4) driver.

STRX25 installs the following header files in the system include directory, /usr/include/strx25/:

xti.h

xti_osi.h

sys/xti_osi.h

xti_mosi.h

sys/xti_mosi.h

sys/strx25/config.h

sys/strx25/version.h

This file contains kernel and system tailoring information for the ‘OpenSS7 X.25 Networking’ kernel modules.

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

This file contains module and symbol version information for the ‘OpenSS7 X.25 Networking’ kernel modules. This file is only applicable to Linux kernels in the 2.4 series. ¹¹

STRX25 installs the following test programs in the system libexec directory, /usr/libexec/strx25/:¹²

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 X.25 Networking 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.

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 X.25 Networking 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.

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

strx25_mknod

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

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

strx25

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

strx25.sh

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

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

strx25.conf

This file provided configuration information for any system controls affected by the ‘strx25’ package.

modutils/strx25

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

netconfig.d/strx25

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

sock2path.d/strx25

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

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

strx25

This file provides system configuration information used by init scripts for the ‘strx25’ package. Some options of init script execution can be controlled by this file.

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

strx25.info

strx25.info-1

strx25.info-2

These files contain this manual in GNU info format.

STRX25 installs the following manpage macros and reference database files in the system man directory, /usr/share/man/:¹³

strx25.macros

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

strx25.refs

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

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

clns.4

cmot.4

iso-ip.4

isos.4

isot.4

iso-lan.4

iso-udp.4

itos.4

itot.4

lapb.4

lpp.4

ns-tcp.4

plp.4

tcpns.4

tp0.4

tp1.4

tp2.4

tp3.4

tp4.4

tp.4

x25-lapb.4

x25-plp.4

x25_lapb.4

x25_plp.4

xol.4

xot.4

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

strx25.5

manual page for the strx25(5) package.

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

npi_osi.7

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

strx25_mknod.8

Documentation for the strx25_mknod(8) utility program.

3.2 Drivers

The OpenSS7 X.25 Networking package provides the following STREAMS drivers:

clns(4) (streams_clns.ko)

Contains the clns(4) driver.

lapb(4) (streams_x25-lapb.ko)

Contains the lapb(4) driver.

plp(4) (streams_x25-plp.ko)

Contains the plp(4) driver.

3.3 Modules

The OpenSS7 X.25 Networking package provides the following STREAMS modules:

cmot(4) (streams_cmot.ko)

Contains the cmot(4) module.

isot(4) (streams_isot.ko)

Contains the isot(4) module.

itot(4) (streams_itot.ko)

Contains the itot(4) module.

lpp(4) (streams_lpp.ko)

Contains the lpp(4) module.

tcpns(4) (streams_tcpns.ko)

Contains the tcpns(4) module.

xot(4) (streams_xot.ko)

Contains the xot(4) module.

3.4 Libraries

The OpenSS7 X.25 Networking package provides the following shared object and static libraries:

The OpenSS7 X.25 Networking 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:

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

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

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

See strx25(8) for more information.

3.5.2 Administrative Utilities

Following are user utilities for manipulating INET:

The OpenSS7 X.25 Networking package builds and installs the following utilities:

strx25_mknod

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

strx25

This is a RedHat-style System V init script that is installed and used to start and stop the ‘strx25’ package. Starting consists of creating X.25 device nodes using strx25_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.

strx25.sh

This is a Debian-style System V init script that is installed and used to start and stop the ‘strx25’ package in a similar fashion to the strx25 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 X.25 Networking package does not yet contain any performance programs. For performance testing of various transport providers, see the netperf-2.3.7 package.

3.5.4 Conformance Test Programs

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

The OpenSS7 X.25 Networking package builds and installs the following test programs:

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

4 Development

OpenSS7 X.25 Networking 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/strx25/ subdirectory. To use the header files from the package, ‘-I/usr/include/strx25’ 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/strx25’ ‘-I/usr/include/strxns’ ‘-I/usr/include/strcompat’ ‘-I/usr/include/streams’.

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

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

Typical 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 strx25-0.9.2.1 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 X.25 Networking protocol module, the following manual pages are provided:

The strx25-0.9.2.1 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):

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

5 Conformance

Although OpenSS7 Project software is of high quality, and untested behaviour is often correct behaviour, the principle of the OpenSS7 Project is to test all functional requirements against the behaviour of the package in a repeatable validation test suite that can be used to perform regression, target architecture validation and trouble shooting, (see Maturity, and see Test Suites).

5.1 NPI Interface Conformance

The OpenSS7 X.25 Networking drivers conform to the Network Provider Interface (NPI) Revision 2.0.0 as released by UNIX International. A copy of the original document is available from The OpenSS7 Project Website. A reprint of the document specifying this version of the protocol is available as part of the ‘strxns’ package available on line in PDF format, or also in simple HTML format.

5.2 TPI Interface Conformance

The OpenSS7 X.25 Networking drivers conform to the Transport Provider Interface (TPI) Revision 2.0.0 as released by UNIX International. A copy of the original document is available from The OpenSS7 Project Website. A reprint of the document specifying this version of the protocol is available as part of the ‘strxnet’ package available on line in PDF format, or also in simple HTML format.

5.3 XTI Interface Conformance

The OpenSS7 X.25 Networking drivers conform to the X/Open Transport Interface/Transport Layer Interface (XTI/TLI) X/Open Networking Services (XNS) Revision 5.2 as released by The OpenGroup. A copy of the original document is available from The OpenGroup website. Reprints of the document are not available from The OpenSS7 Project website due to copyright restrictions. Similar information is available in the manual pages that accompany the ‘strxnet’ package. These can be viewed on line starting at XTI/TLI manpage.

5.4 IETF Conformance

6 Releases

This is the OpenSS7 Release of the OpenSS7 X.25 Networking tools, drivers and modules used with the Linux Fast-STREAMS or Linux STREAMS¹⁶ SVR 4.2 STREAMS releases.

The purpose of providing a separate release of this package was to separate the OpenSS7 X.25 Networking tools, headers, drivers and modules from the Linux STREAMS¹⁷ package for use with both Linux STREAMS¹⁸ and Linux Fast-STREAMS in preparation for replacement of the former by the later.

The following sections provide information on OpenSS7 X.25 Networking releases as well as compatibility information of OpenSS7 release to the original GCOM releases of these modules and drivers, as well as Linux kernel compatibility.

6.1 Prerequisites

2.6.26exinfo -*- vim: ft=texinfo

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 X.25 Networking 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.19
   	− 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).20
   	− GNU texinfo (for info files).
   	− GNU bison and flex (for config programs).
   	− net-snmp (for SNMP agents).21

(Note: If you acquired strx25 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.4. ²²
3. OpenSS7 STREAMS Compatibility Modules, strcompat-0.9.2.7.
4. OpenSS7 STREAMS XNS, strxns-0.9.2.7.
5. OpenSS7 STREAMS XTI/TLI, strxnet-0.9.2.12.
6. OpenSS7 STREAM Network Services Library, strnsl-0.9.2.4. (Optional.)
7. OpenSS7 STREAMS Sockets, strsock-0.9.2.4. (Optional.)
8. OpenSS7 STREAMS INET, strinet-0.9.2.7.
9. OpenSS7 STREAMS SCTP, strsctp-0.9.2.9.
10. OpenSS7 STREAMS Channels, strchan-0.9.2.4.

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.

6.2 Compatibility

This section discusses compatibility with major prerequisites.

6.2.1 GNU/Linux Distributions

OpenSS7 X.25 Networking is compatible with the following Linux distributions:²³

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

6.2.2 Kernel

The OpenSS7 X.25 Networking package compiles as a Linux kernel module. It is not necessary to patch the Linux kernel to build or use the package.²⁴ Nor do you have to recompile your kernel to build or use the package. OpenSS7 packages use autoconf scripts to adapt the package source to your existing kernel. The package builds and runs nicely against production kernels from the distributions listed above. Rather than relying on kernel versions, the