OpenSS7 STREAMS Network Services Library

OpenSS7 STREAMS Network Services Library Installation and Reference Manual

About This Manual

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

Preface

Notice

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

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

Abstract

This manual provides a Installation and Reference Manual for OpenSS7 STREAMS Network Services Library.

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 Network Services Library.

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 Network Services Library 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 Network Services Library 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 Network Services Library package, strnsl-0.9.2.3.²

Version Control

     
     strnsl.texi,v
     Revision 0.9.2.6  2007/06/22 00:18:56  brian
     - mostly documentation updates for release, some netconfig workaround
     
     Revision 0.9.2.5  2007/02/28 06:31:22  brian
     - updates and corrections, #ifdef instead of #if
     
     Revision 0.9.2.4  2007/01/08 16:24:22  brian
     - final updates for release
     
     Revision 0.9.2.3  2007/01/05 06:19:33  brian
     - documentation updates for release
     
     Revision 0.9.2.2  2006/10/02 11:31:53  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.1  2006/09/25 12:30:52  brian
     - added files for new strnsl package
     
     

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 Network Services Library package was provided in part by:

Additional funding for The OpenSS7 Project was provided by:

Contributors

The primary contributor to the OpenSS7 OpenSS7 STREAMS Network Services Library 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 Network Services Library 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 Network Services Library 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 Network Services Library 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 Network Services Library 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 Network Services Library

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

UNIX has traditionally provided three components of the Network Services Library, libnsl, two of which are associated with the X/Open Transport Interface/Transport Layer Interface (XTI/TLI), libxnet, the Transport Provider Interface (TPI), and STREAMS network pseudo-device drivers. Two components provide the TI (Transport Independent) interface, whereas the other provides the TS (Transport Sockets) interface. The TI components provide the Transport Independent RPC services (TI-RPC) pioneered by Sun Microsystems and subsequently standardized by the IETF.

GNU/Linux glibc provides (among other things) the RPC interface library and the TS-RPC and BSD 4.3 sockets address translation facilities in libc, and provides NIS capabilities in libnsl. STREAMS related components that are not currently part of the Linux Network Services Library (libnsl) are:

1. Network Selection, consisting of:
   • Network Configuration database access, netconfig(3), and,
   • Network Path access, netpath(3).
2. Name-to-Address Translation, netdir(3).

These are often referred to as the Network Selection facility of the Network Services Library. The OpenSS7 STREAMS Network Services Library package provides a library, renamed libxnsl, that provides the missing Network Selection and Name-to-Address mapping facilities designed to work with xti(3).

The OpenSS7 STREAMS Network Services Library package contains header files and the associated documentation that were originally contained in the strxnet package. This library was quickly removed from the strxnet distribution and placed in its own add-on package.

The package contains the following standard SVR 4.2 conforming header files:

Note that the XTI/TLI Library and Transport Provider Interface header files are contained in the `strxnet-0.9.2.11' package.

The package builds and installs the following shared object libraries:

xnsl(3)

This is the X/Open Network Services Library that contains the Network Selection facility for the Network Services Library.

The OpenSS7 STREAMS Network Services Library package includes SVR 4.2 STREAMS libraries, utilities, test programs, daemons, and development environment for the development and execution of OpenSS7 STREAMS Network Services Library 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 strnsl-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/strnsl-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 strnsl 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-strnsl 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 Network Services Library 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 strnsl a part of the OpenSS7 Master Package, then the dependencies listed below will already have been met by unpacking the master package.)

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

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

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

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

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

     $> ../strnsl-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/strnsl-0.9.2.3.tar.bz2
     $> tar -xjvf strnsl-0.9.2.3.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../strnsl-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 strnsl-0.9.2.3
     $> rm -f strnsl-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/strnsl-0.9.2.3.tar.bz2
     $> tar -xjvf strnsl-0.9.2.3.tar.bz2
     $> mkdir build
     $> pushd build
     $> ../strnsl-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 strnsl-0.9.2.3
     $> rm -f strnsl-0.9.2.3.tar.bz2

See README-make for additional specialized make targets.

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

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

Unpack the tarball using a command such as:

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

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

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

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

1 Introduction

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

1.1 Overview

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

The OpenSS7 STREAMS Network Services Library 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 STREAMS Network Services Library 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 STREAMS Network Services Library 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

UNIX® has traditionally provided three components of the Network Services Library, libnsl, two of which are associated with the X/Open Transport Interface/Transport Layer Interface (XTI/TLI), xti(3), the Transport Provider Interface (TPI), tpi(7), and STREAMS network pseudo-device drivers. Two components provide the TI (Transport Independent) interface, whereas the other provides the TS (Transport Sockets) interface. The TI components provide the Transport Independent RPC services (TI-RPC) pioneered by Sun Microsystems and standardized by the IETF.

GNU/Linux glicb provides (amoung other things) the RPC Interface Library and the TS-RPC and BSD 4.3 socket address translation facilities in libc, and provides NIS capabilities in libnsl.

STREAMS-related components that are not currently part of the Linux Network Services Library (libnsl) are:

1. Network Selection, consisting of:
   • Network Configuration database access, netconfig(3),
   • Network Path access, netpath(3).
2. Name-to-Address Translation, netdir(3).

These are often collectively referred to as the Network Selection facility of the Network Services Library.

The OpenSS7 STREAMS Network Services Library package provides a library, renamed libxnsl, that provides the missing Network Selection and Name-to-Address mapping facilities designed to work with xti(3) from the strxnet(5) package.

The objective for providing this library and missing capabilities was to provide a mechanism whereby the strsock(5) package and the libsockets library could set socket options independent of transport provider. As a secondary objective, this package could support a full port of the TIRPCSRC 2.8 transport-independent RPC source to Linux and also provide the rpcbind service missing from Linux. This would also permit additional source such as NFS 4 to be rapidly ported to Linux.

3 Reference

3.1 Files

STRNSL installs the following header files in the system include directory, /usr/include/strnsl/:

sys/strnsl/config.h

sys/strnsl/version.h

netconfig.h

sys/netconfig.h

netdir.h

STRNSL installs the following test programs in the system libexec directory, /usr/libexec/strnsl/:⁹

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 Network Services Library 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-xnsl

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

test-xnsl_thr

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

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 Network Services Library 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.

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

libxnsl.so.0.0.0

libxnsl.so.0

libxnsl.so

libxnsl.la

libxnsl.a

inetaddr.so

inetaddr.a

inetaddr.la

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

de/LC_MESSAGES/strnsl.mo

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

strnsl.info

strnsl.info-1

strnsl.info-2

These files contain this manual in GNU info format.

libxnsl.info

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

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

strnsl.macros

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

strnsl.refs

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

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

endnetconfig.3

endnetpath.3

freenetconfigent.3

getnetconfig.3

getnetconfigent.3

getnetpath.3

libxnsl.3

nc_perror.3

nc_sperror.3

_nderror.3

netbuf.3

netconfig.3

netdir.3

netdir_free.3

netdir_getbyaddr.3

netdir_getbyname.3

netdir_options.3

netdir_perror.3

netdir_sperror.3

netpath.3

setnetconfig.3

setnetpath.3

taddr2uaddr.3

uaddr2taddr.3

xnsl.3

inetaddr.3

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

strnsl.5

manual page for the strnsl(5) package.

netconfig.5

netdir.5

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

test-xnsl.8

test-xnsl_thr.8

3.2 Drivers

The OpenSS7 STREAMS Network Services Library package does not provide any STREAMS drivers or modules.

3.3 Modules

The OpenSS7 STREAMS Network Services Library package does not provide any STREAMS drivers or modules.

3.4 Libraries

3.5 Utilities

3.5.1 Init Scripts

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

3.5.2 Administrative Utilities

Following are user utilities for manipulating NSL:

The OpenSS7 STREAMS Network Services Library package does not yet contain any administrative utilities. Eventually an xtitrace(8) facility will be provided.

3.5.3 Performance Test Programs

Following are performance test programs:

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

3.5.4 Conformance Test Programs

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

/usr/libexec/strnsl/testsuite

/usr/libexec/strnsl/atlocal

The OpenSS7 Project style autotest test suite. This test suite can be run stand-alone as described under Running Test Suites. The atlocal file provides localized definitions for the test suite.

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

3.5.5 Problem Report Scripts

The OpenSS7 STREAMS Network Services Library package installs customized problem reporting scripts for reporting problems associated with test suite execution and other difficulties. This problem reporting script is installed in the /usr/libexec/strnsl/ subdirectory as follows:

/usr/libexec/strnsl/send-pr

/usr/libexec/strnsl/send-pr.config

This is the problem reporting script tailored for the strnsl-0.9.2.3 package. The send-pr file is the script proper and the send-pr.config file contains localized configuration information.

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

4 Development

OpenSS7 STREAMS Network Services Library 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/strnsl/ subdirectory. To use the header files from the package, `-I/usr/include/strnsl' 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/strnsl' `-I/usr/include/strxns' `-I/usr/include/strcompat' `-I/usr/include/streams'.

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

sys/strnsl/config.h

Configuration defines for the package.

sys/strnsl/version.h

Module versions for the package (on 2.4 systems).

netconfig.h

sys/netconfig.h

Definitions for the network configuration database.

netdir.h

Definitions for the name-to-address translation facilities.

4.1.1 User Space Programs

Typical include files for interacting with Transport providers from user space include the netconfig.h or netdir.h header files. Additional header files for interacting with specific drivers or modules may also be required. The netconfig.h header file is used for interacting with the Network Configuration database. The netdir.h header file is for interacting with the Name-to-Address translation services.

4.2 Libraries

Shared or static version of the libxnsl library must be linked when using the strnsl-0.9.2.3 package. The library must either be specified on the gcc command line as a shared library (e.g. `-lxnsl') or as a static library (e.g. `/usr/lib/libxnsl.a').

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

`-lxnsl'

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

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

`/usr/lib/libxnsl.a'

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

4.3 Manual Pages

The strnsl-0.9.2.3 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):

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

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

5 Conformance

6 Releases

This is the OpenSS7 Release of the OpenSS7 STREAMS Network Services Library 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 STREAMS Network Services Library 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 STREAMS Network Services Library releases as well as compatibility information of OpenSS7 release to mainstream UNIX releases of the core, modules and drivers, as well as Linux kernel compatibility.

6.1 Prerequisites

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

Prerequisites for the OpenSS7 STREAMS Network Services Library 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.14
   	− 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).15

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

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 STREAMS Network Services Library is compatible with the following Linux distributions:¹⁷

• CentOS Enterprise Linux 3.4 (centos34)
• CentOS Enterprise Linux 4.0 (centos4)
• CentOS Enterprise Linux 4.92 (centos48)
• CentOS Enterprise Linux 5.0 (centos5)
• Debian 3.0r2 Woody (deb3.0) – TBD
• Debian 3.1r0a Sarge (deb3.1)
• Debian 4.0r1 Etch (deb4.0) (untested)
• Fedora Core 1 (FC1) – TBD
• Fedora Core 2 (FC2) – TBD
• Fedora Core 3 (FC3) – TBD
• Fedora Core 4 (FC4) – TBD
• Fedora Core 5 (FC5)
• Fedora Core 6 (FC6)
• Fedora 7 (FC7)
• Gentoo 2006.1 (untested)
• Lineox 4.026 (LEL4) – TBD
• Lineox 4.053 (LEL4)
• Mandrakelinux 9.2 (MDK92) – TBD
• Mandrakelinux 10.0 (MDK100) – TBD
• Mandrakelinux 10.1 (MDK101) – TBD
• Mandriva Linux LE2005 (MDK102) – TBD
• Mandriva Linux LE2006 (MDK103)
• Mandriva One (untested)
• Performance Technlogies NexusWare24 – TBD
• Performance Technologies NexusWare 8.0
• 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)
• 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)
• SuSE 10.0 (SuSE10.0)
• SuSE 10.1 (SuSE10.1)
• SuSE 10.2 (SuSE10.2)
• SLES 9 (SLES9)
• SLES 9 SP2 (SLES9)
• SLES 9 SP3 (SLES9)
• SLES 10 (SLES10)
• Ubuntu 5.10 (ubu5.10)
• Ubuntu 6.03 LTS (ubu6.03)
• Ubuntu 6.10 (ubu6.10)
• Ubuntu 7.04 (ubu7.04)
• WhiteBox Enterprise Linux 3.0 (WBEL3)
• WhiteBox Enterprise Linux 4 (WBEL4)

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 STREAMS Network Services Library 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 autoconf scripts interrogate the kernel for specific features and variants to better adapt to distribution production kernels that have had patches applied over the official kernel.org sources.

The OpenSS7 STREAMS Network Services Library package is compatible with 2.4 kernel series after 2.4.10 and has been tested up to and including 2.4.27. It has been tested from 2.6.3 up to and including 2.6.21 (with Fedora 7 patchsets). Please note that your mileage may vary if you use a kernel more recent than 2.6.21: it is difficult to anticipate changes that kernel developers will make in the future. Many kernels in the 2.6 series now vary widely by release version and if you encounter problems, try a kernel within the supported series.

UP validation testing for kernels is performed on all supported architectures. SMP validation testing is performed on UP machines, as well as on an Intel 3.0GHz Pentium IV 630 with HyperThreading enabled. Because HyperThreading is not as independent as multiple CPUs, SMP validation testing is limited.

6.2.3 Architectures

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

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

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

6.2.4 Linux STREAMS

The OpenSS7 STREAMS Network Services Library package is currently compatible with Linux STREAMS,¹⁹ however, to use the OpenSS7 STREAMS Network Services Library package with LiS requires use of the OpenSS7 release packages of LiS. The OpenSS7 STREAMS Network Services Library package is compatible with the OpenSS7 LiS-2.18.6 release that is available from the The OpenSS7 Project Downloads Page. But, do not use LiS: it is buggy, unsupported and deprecated. Use Linux Fast-STREAMS instead.

6.2.5 Linux Fast-STREAMS

The OpenSS7 STREAMS Network Services Library package is currently compatible with Linux Fast-STREAMS (LfS). The OpenSS7 STREAMS Network Services Library package is compatible with the OpenSS7 streams-0.9.2.3 release that is available from the The OpenSS7 Project Downloads Page.

6.3 Release Notes

The sections that follow provide information on OpenSS7 releases of the
OpenSS7 STREAMS Network Services Library package.

Major changes for release strnsl-0.9.2.3

This is the third separate release from The OpenSS7 Project of the OpenSS7 STREAMS Network Services Library package. This package provides the libxnsl library providing the Network Selection Facility for the Network Services Library. The package contains all the necessary manual pages and other documentation. The package is packaged as an OpenSS7 style autoconf tarball.

This is the second alpha release and is part of the OpenSS7 Master Package (openss7-0.9.2.F). The release provides support for recent distributions and tool chains.

Major features since the last public release are as follows:

• Support build on openSUSE 10.2.
• Fixed problems with conflicting /etc/netconfig file definitions between libtirpc and this implementation of the network configuration utilities.
• Support build on Fedora 7 with 2.6.21 kernel.
• Support build on CentOS 5.0 (RHEL5).
• Support build on Ubuntu 7.04.
• Updated to gettext 0.16.1.
• Supports build on Fedora Core 6.
• Support for recent distributions and tool chains.

Major changes for release strnsl-0.9.2.2

T