OpenSS7 XTI/TLI Networking

OpenSS7 XTI/TLI Networking Installation and Reference Manual

About This Manual

This is Edition 11, last updated 2007-06-24, of The OpenSS7 XTI/TLI Networking Installation and Reference Manual, for Version 0.9.2 release 11 of the OpenSS7 XTI/TLI Networking 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 XTI/TLI 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 XTI/TLI 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 XTI/TLI 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 XTI/TLI 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 XTI/TLI Networking package, strxnet-0.9.2.11.²

Version Control

     
     strxnet.texi,v
     Revision 0.9.2.31  2007/02/28 06:31:42  brian
     - updates and corrections, #ifdef instead of #if
     
     Revision 0.9.2.30  2007/01/08 16:24:39  brian
     - final updates for release
     
     Revision 0.9.2.29  2007/01/03 12:33:12  brian
     - corrections
     
     Revision 0.9.2.28  2007/01/03 10:11:51  brian
     - documentation updates for release
     
     Revision 0.9.2.27  2006/10/02 11:32:23  brian
     - changes to get master builds working for RPM and DEB
     - added outside licenses to package documentation
     - added LICENSE automated release file
     - copy MANUAL to source directory
     - add and remove devices in -dev debian subpackages
     - get debian rules working better
     - release library version files
     - added notes to debian changelog
     - corrections for cooked manual pages in spec files
     - added release documentation to spec and rules files
     - copyright header updates
     - moved controlling tty checks in stream head
     - missing some defines for LiS build in various source files
     - added OSI headers to striso package
     - added includes and manual page paths to acincludes for various packages
     - added sunrpc, uidlpi, uinpi and uitpi licenses to documentation and release
       files
     - moved pragma weak statements ahead of declarations
     - changes for master build of RPMS and DEBS with LiS
     
     Revision 0.9.2.26  2006/09/18 01:07:25  brian
     - updated manuals and release texi docs
     
     Revision 0.9.2.25  2006/08/28 10:47:12  brian
     - correction
     
     Revision 0.9.2.24  2006/08/28 10:33:01  brian
     - updated references
     
     Revision 0.9.2.23  2006/08/27 12:27:17  brian
     - finalizing auto release files
     
     Revision 0.9.2.22  2006/08/26 09:20:06  brian
     - better release file generation
     
     Revision 0.9.2.21  2006/08/23 11:00:52  brian
     - added preface, corrections and updates for release
     
     Revision 0.9.2.20  2006/08/22 12:57:36  brian
     - updated documentation
     
     Revision 0.9.2.19  2006/03/22 10:02:08  brian
     - added makefile target index
     
     Revision 0.9.2.18  2006/03/03 11:35:17  brian
     - 32/64-bit compatibility
     
     Revision 0.9.2.17  2005/07/08 13:16:22  brian
     - updates to documentation
     
     Revision 0.9.2.16  2005/06/24 13:39:00  brian
     - added troubleshooting section to manuals
     
     Revision 0.9.2.15  2005/05/14 08:28:28  brian
     - copyright header correction
     
     Revision 0.9.2.14  2005/04/12 23:01:47  brian
     - correct docs
     
     Revision 0.9.2.13  2005/04/12 09:29:03  brian
     - corrections
     
     Revision 0.9.2.12  2005/04/11 20:48:42  brian
     - documentation updates and corrections
     
     Revision 0.9.2.11  2005/03/15 00:56:46  brian
     - Updated version numbering in texinfo files.
     
     Revision 0.9.2.10  2005/03/15 00:51:43  brian
     - Updated version numbering in texinfo files.
     
     Revision 0.9.2.9  2005/02/17 20:00:25  brian
     - Fixes for texi documentation.
     
     Revision 0.9.2.8  2005/01/24 11:57:58  brian
     - Updated texinfo headers.
     
     Revision 0.9.2.7  2004/12/19 15:15:21  brian
     - Corrected include position.
     
     Revision 0.9.2.6  2004/08/22 00:00:07  brian
     - Converted over to common files.
     
     Revision 0.9.2.5  2004/08/20 21:14:13  brian
     - Updated documentation.
     
     Revision 0.9.2.4  2004/08/17 11:51:00  brian
     - Updating documentation.
     
     Revision 0.9.2.3  2004/08/16 11:39:56  brian
     - Documetnation updates and copying options.
     
     Revision 0.9.2.2  2004/08/15 19:56:44  brian
     - Build and manual updates.
     
     Revision 0.9.2.1  2004/04/06 12:33:59  brian
     - Working up documentation.
     
     Revision 0.9  2004/04/03 22:37:07  brian
     - Initial cut of new strxnet rpm 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 XTI/TLI Networking package was provided in part by:

Additional funding for The OpenSS7 Project was provided by:

Contributors

The primary contributor to the OpenSS7 OpenSS7 XTI/TLI 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 XTI/TLI 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 XTI/TLI 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 XTI/TLI 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 XTI/TLI 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 XTI/TLI Networking

Package strxnet-0.9.2.11 was released under GPLv2 2007-06-24.

The OpenSS7 XTI/TLI Networking package for Linux Fast-STREAMS is an implementation of the X/Open Transport Interface or SVID Transport Layer Interface library in accordance with SUSv2 and XNS 5.2 standards. It consists of user-space libraries (libxnet) and a set of cooperating STREAMS modules (timod(4) and tirdwr(4)). The STREAMS module, timod(4), is pushed on any Stream implementing the Transport Provider Interface (TPI) Revision 1.5 or 2.0.0 service interface and provides XTI/TLI library access to the transport provider. Definitions for the Transport Provider Interface (TPI) Revision 2.0.0 are also provided by header files included in the package.

The package contains the following standard Open Systems Interconnect (OSI) conforming header files:

Note that the Data Link Provider Interface (DLPI) and Network Provider Interface are contained in the `strxns-0.9.2.6' package.

The package builds and installs the following STREAMS kernel modules and drivers:

timod(4)

a STREAMS XTI/TLI compatibility interface.

tirdwr(4)

a STREAMS XTI/TLI read write compatibility module.

The package builds and installs the following shared object and static libraries:

libxnet(3)

XNS 5.2 XTI/TLI Library (libxnet)

The OpenSS7 XTI/TLI 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 OpenSS7 XTI/TLI Networking 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 strxnet-0.9.2.11 package, released 2007-06-24. This `0.9.2.11' 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/strxnet-0.9.2.11.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 strxnet 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-strxnet 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 XTI/TLI 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.21);
   	− glibc2 or better.
   	− GNU info (for info files).
   	− GNU groff (for man pages).4

(Note: If you acquired strxnet 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.

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:

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

See README-make for additional specialized make targets.

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

Brief Installation Instructions

The OpenSS7 XTI/TLI Networking package is available from the downloads area of The OpenSS7 Project website using a command such as:

     $> wget http://www.openss7.org/tarballs/strxnet-0.9.2.11.tar.bz2

Unpack the tarball using a command such as:

     $> tar -xjvf strxnet-0.9.2.11.tar.bz2

The tarball will unpack into the relative subdirectory named after the package name: strxnet-0.9.2.11.

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
     $> ../strxnet-0.9.2.11/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 ../strxnet-0.9.2.11/INSTALL

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

     $> ../strxnet-0.9.2.11/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 strxnet-0.9.2.11
     $> rm -f strxnet-0.9.2.11.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 ../strxnet-0.9.2.11
     $> less doc/manual/strxnet.txt
     $> lynx doc/manual/strxnet.html
     $> info doc/manual/strxnet.info
     $> xpdf doc/manual/strxnet.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/strxnet_manual.html

1 Introduction

This manual documents the design, implementation, installation, operation and future development schedule of the OpenSS7 XTI/TLI Networking package.

1.1 Overview

This manual documents the design, implementation, installation, operation and future development of the OpenSS7 XTI/TLI Networking package.

The OpenSS7 XTI/TLI Networking package is an X/Open Transport Interface (XTI/TLI) package for Linux that can be used with Linux Fast-STREAMS⁷. It includes development tools, header files and manual pages for

• Transport Provider Interface
• OpenSS7 XTI/TLi Library

In addition, it provides STREAMS drivers and modules for DLPI including:

• Transport Interface Module (streams-timod.o), and
• Transport Interface Read-Write Modules (streams-tirdwr.o).

The OpenSS7 XTI/TLI Networking package is essential to the development and support of X/Open XTI/TLI modules and drivers and provides a fundamental set of X/Open header files and manual pages for such development.

The OpenSS7 XTI/TLI Networking does not provide the X/Open Network Services (XNS), Network Provider Interface (NPI) or Data Link Provider Interface (DLPI) components. See the OpenSS7 strxns⁸ 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

The OpenSS7 XTI/TLI Networking package is intended to provide compatibility with UNIX System V Release 4 networking components based on the Transport Provider Interface and the XTI/TLI interface described in X/Open Networking Services, in a single add-on package to Linux Fast-STREAMS. One purpose in achieving this compatibility is the porting of legacy applications from UNIX to Linux using the capabilities of STREAMS and Linux Fast-STREAMS.

Both the Transport Provider Interface and the XTI/TLI library APIs are designed to be transport provider neutral. Both the service primitive interface and function call interface are designed to be transport provider independent to as large a degree as possible. Therefore, this OpenSS7 XTI/TLI Networking package does not provide any transport providers of its own. It merely provides the Transport Provider Interface and the XTI/TLI library interface and applies them in a transport independent fashion to a wide range of specific transport protocols.

For transport providers based on the Internet Protocol suite, the strinet-0.9.2.6 package, strinet(5), provides TPI and XTI/TLI compatible transport providers; the strsctp-0.9.2.8 package, strsctp(5), provides a TPI and XTI compatible implementation of the Stream Control Transmission Protocol (SCTP) for Linux Fast-STREAMS. The striso-0.9.2.3 package, striso(5), provides TPI and XTI compliant transport providers for OSI/ISO protocols.

At the time that the OpenSS7 XTI/TLI Networking was being developed there existed an XTI implementation written by Ole Husgaard, but the tirdwr and timod modules were deeply flawed and the library itself was not thread-safe and did not support all functions and capabilities of XTI. Therefore, the OpenSS7 XTI/TLI Networking STREAMS modules and library were written from the start to be thread-safe and fully compliant with the XTI/TLI specifications in XNS 5.2.⁹

The result is a stable, production grade, 64-bit clean XTI/TLI library implementation for Linux Fast-STREAMS.

3 Reference

3.1 Files

STRXNET creates the following kernel modules files in the kernel modules directory, /lib/modules/2.4.20-28.7/:¹⁰

modules.strxnet

STRXNET installs the following kernel module files in the kernel modules directory, /lib/modules/2.4.20-28.7/strxnet/:¹¹

streams_tirdwr.ko

Contains the tirdwr(4) STREAMS module.

streams_timod.ko

Contains the timod(4) STREAMS module.

STRXNET installs the following header files in the system include directory, /usr/include/strxnet/:

STRXNET installs the following test programs in the system libexec directory, /usr/libexec/strxnet/:¹²

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 XTI/TLI 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.

test-tirdwr

test case exectutable.

test-timod

test case exectutable.

test-xnet

test case exectutable.

test-xnet_thr

test case exectutable.

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 XTI/TLI 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.

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

strxnet_mknod

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

STRXNET installs the following static and shared object libraries in the system library directory, /usr/lib/ (32-bit libraries) and /usr/lib64/ (64-bit libraries):

libxnet.so.0.0.0

libxnet.so.0

libxnet.so

libxnet.a

libxnet.la

STRXNET installs the following internationalization catalogues in the internationalization directory, /usr/share/locale/:

de/LC_MESSAGES/strxnet.mo

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

strxnet

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

strxnet.sh

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

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

strxnet.conf

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

modutils/strxnet

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

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

strxnet

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

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

strxnet.info

strxnet.info-1

strxnet.info-2

These files contain this manual in GNU info format.

libxnet.info

An incomplete info manual for the libxnet library. See the manual pages, libxnet(3), instead.

tpi.info

tpi_tcap.info

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

strxnet.macros

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

strxnet.refs

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

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

t_accept.3

t_addleaf.3

t_alloc.3

t_bind.3

t_close.3

t_connect.3

t_errlist.3

t_errno.3

t_error.3

t_errstr.3

t_free.3

t_getinfo.3

t_getprotaddr.3

t_getstate.3

t_listen.3

t_look.3

t_nerr.3

t_open.3

t_optmgmt.3

t_rcv.3

t_rcvconnect.3

t_rcvdis.3

t_rcvleafchange.3

t_rcvopt.3

t_rcvrel.3

t_rcvreldata.3

t_rcvudata.3

t_rcvuderr.3

t_rcvv.3

t_rcvvopt.3

t_rcvvudata.3

t_removeleaf.3

t_snd.3

t_snddis.3

t_sndopt.3

t_sndrel.3

t_sndreldata.3

t_sndudata.3

t_sndv.3

t_sndvopt.3

t_sndvudata.3

t_strerror.3

t_sync.3

t_sysconf.3

t_unbind.3

xnet.3

xti.3

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

timod.4

tirdwr.4

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

strxnet.5

manual page for the strxnet(5) package.

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

T_ADDR_ACK.7

T_addr_ack.7

T_ADDR_REQ.7

T_addr_req.7

T_BIND_ACK.7

T_bind_ack.7

T_BIND_REQ.7

T_bind_req.7

T_CAPABILITY_ACK.7

T_capability_ack.7

T_CAPABILITY_REQ.7

T_capability_req.7

T_CONN_CON.7

T_conn_con.7

T_CONN_IND.7

T_conn_ind.7

T_CONN_REQ.7

T_conn_req.7

T_CONN_RES.7

T_conn_res.7

T_DATA_IND.7

T_data_ind.7

T_DATA_REQ.7

T_data_req.7

T_DISCON_IND.7

T_discon_ind.7

T_DISCON_REQ.7

T_discon_req.7

T_ERROR_ACK.7

T_error_ack.7

T_EXDATA_IND.7

T_exdata_ind.7

T_EXDATA_REQ.7

T_exdata_req.7

T_INFO_ACK.7

T_info_ack.7

T_INFO_REQ.7

T_info_req.7

T_OK_ACK.7

T_ok_ack.7

T_OPTDATA_IND.7

T_optdata_ind.7

T_OPTDATA_REQ.7

T_optdata_req.7

T_OPTMGMT_ACK.7

T_optmgmt_ack.7

T_OPTMGMT_REQ.7

T_optmgmt_req.7

T_ORDREL_IND.7

T_ordrel_ind.7

T_ORDREL_REQ.7

T_ordrel_req.7

tpi.7

T_UDERROR_IND.7

T_uderror_ind.7

T_UNBIND_REQ.7

T_unbind_req.7

T_UNITDATA_IND.7

T_unitdata_ind.7

T_UNITDATA_REQ.7

T_unitdata_req.7

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

strxnet_mknod.8

Documentation for the strxnet_mknod(8) utility program.

test-timod.8

test-tirdwr.8

test-xnet.8

test-xnet_thr.8

3.2 Drivers

The OpenSS7 XTI/TLI Networking package does not provide any STREAMS drivers: only STREAMS modules.

3.3 Modules

The OpenSS7 XTI/TLI Networking package provides the following STREAMS modules:

3.3.1 Transport Interface Module

Licensing

The timod(4) module is licensed under the GPL Version 2 (see GNU Generic Public License). Other licensing terms are available from OpenSS7 Corporation.

3.3.2 Transport Interface Read-Write Module

Licensing

The tirdwr(4) module is licensed under the GPL Version 2 (see GNU Generic Public License). Other licensing terms are available from OpenSS7 Corporation.

3.4 Libraries

During the installation process of OpenSS7 XTI/TLI Networking a subroutine library is build and installed. For 64-bit systems that support 32-bit compatibility, two version of each library are build and installed: one 64-bit native library and one 32-bit compatibility library. 64-bit native libraries are installed to the /usr/lib64 subdirectory. 32-bit native and 32-bit compatibility libraries are installed to the /usr/lib subdirectory.

libxnet.so.0.0.0

libxnet.so.0

libxnet.so

Provides a shared object library for use by XTI/TLI applications programs.

libxnet.a

Provides a static library for use by XTI/TLI applications programs.

libxnet.la

Provides the libtool definitions for the libraries.

3.4.1 libxnet Library Routines

The following routines are present in the libxnet libraries. The routines in these libraries are standard XTI/TLI interface library calls documented in XNS 5.2.¹⁴ Refer to the associated manual pages for detailed information on these routines.

3.4.2 Using the Library

The use the OpenSS7 XTI/TLI Networking libraries, include the file xti.h in the application program source code. On the compiler command line, add the option `-I/usr/include/strxnet' to include the version of xti.h that is distributed with OpenSS7 XTI/TLI Networking.

When linking the application program, or performing final gcc to build an executable, include one of the following option on the gcc or ld command line:

`/usr/lib/libxnet.a'

`-lstreams -static'

Links against the static version of the library.

`-lstreams'

`-lstreams -shared'

Links against the shared object version of the library.

`/usr/lib/libxnet.la'

Used with libtool to link additional convenience libraries against the shared or static version of the library.

Failure to link the executable runtime path for libxnet will result in linker-loader errors specifying undefined symbols. See Development, for more information.

Licensing

The libxnet(3) library is licensed under the LGPL Version 2.1 (see GNU Lesser Public License). Other licensing terms are available from OpenSS7 Corporation.

3.5 Utilities

3.5.1 Init Scripts

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

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

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

System V Init Script for the XNET Subsystem. The strxnet(8) init script provides the ability to initialize, configure and mount the XN