OpenSS7 STREAMS Compatibility

OpenSS7 STREAMS Compatibility Installation and Reference Manual

About This Manual

This is Edition 6, last updated 2007-06-24, of The OpenSS7 STREAMS Compatibility Installation and Reference Manual, for Version 0.9.2 release 6 of the OpenSS7 STREAMS Compatibility 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 Compatibility.

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

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

Version Control

     
     strcompat.texi,v
     Revision 0.9.2.15  2007/02/28 06:30:45  brian
     - updates and corrections, #ifdef instead of #if
     
     Revision 0.9.2.14  2007/01/03 14:57:17  brian
     - documentation updates for release
     
     Revision 0.9.2.13  2006/12/29 12:18:28  brian
     - old rpms hate nested ifs, release updates
     
     Revision 0.9.2.12  2006/10/21 10:01:12  brian
     - updated streams release number
     
     Revision 0.9.2.11  2006/09/18 01:06:34  brian
     - updated manuals and release texi docs
     
     Revision 0.9.2.10  2006/08/28 10:46:56  brian
     - correction
     
     Revision 0.9.2.9  2006/08/28 10:32:53  brian
     - updated references
     
     Revision 0.9.2.8  2006/08/27 12:26:42  brian
     - finalizing auto release files
     
     Revision 0.9.2.7  2006/08/26 09:17:54  brian
     - better release file generation
     
     Revision 0.9.2.6  2006/08/23 11:00:32  brian
     - added preface, corrections and updates for release
     
     Revision 0.9.2.5  2006/08/22 12:57:09  brian
     - updated documentation
     
     Revision 0.9.2.4  2006/03/22 10:02:03  brian
     - added makefile target index
     
     Revision 0.9.2.3  2006/03/03 11:11:14  brian
     - 64-bit compatibility, fixes, updates for release
     
     Revision 0.9.2.2  2005/07/08 13:15:59  brian
     - updates to documentation
     
     Revision 0.9.2.1  2005/07/04 19:28:53  brian
     - first cut at streams compatibility package
     
     Revision 0.9  2005/07/04 19:28:53  brian
     file strcompat.texi was initially added on branch OpenSS7-0_9_2.
     

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

Additional funding for The OpenSS7 Project was provided by:

Contributors

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

Package strcompat-0.9.2.6 was released under GPLv2 2007-06-24.

The OpenSS7 STREAMS Compatibility package provides the ability for Linux Fast-STREAMS to exhibit source level compatibility with a wide range of UNIX STREAMS implementations. Also, it provides LiS source, and some 2.18.0 binary, compatibility for Linux Fast-STREAMS. The objective of the package is to provide source level compatibility with a wide range of UNIX STREAMS implementations permitting drivers and modules to port easily to Linux Fast-STREAMS from any other STREAMS implementation, making it possible to release drivers and modules from a single UNIX code base with minimal localisms for Linux.

These compatibility modules provide source level compatibility with AIX, HPUX, OSF/1, MacOT, Mentat, SUX, Solaris, SUPER/UX, IRIX, LiS, UnixWare, UXP/V and SVR 4.2 STREAMS. The package contains all the necessary manual pages and other documentation in an autoconf tarball.

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

The OpenSS7 STREAMS Compatibility package provides compatibility with the following STREAMS implementations:

These compatibility modules compile as kernel modules and will be demand loaded into the kernel when used by a specific STREAMS module or driver. The compatibility modules ease porting of STREAMS modules and drivers from other Operating Systems to Linux.

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 strcompat-0.9.2.6 package, released 2007-06-24. This `0.9.2.6' 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/strcompat-0.9.2.6.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 strcompat 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-strcompat 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 Compatibility 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 strcompat 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. ⁵

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:

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

See README-make for additional specialized make targets.

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

     $> wget http://www.openss7.org/tarballs/strcompat-0.9.2.6.tar.bz2

Unpack the tarball using a command such as:

     $> tar -xjvf strcompat-0.9.2.6.tar.bz2

The tarball will unpack into the relative subdirectory named after the package name: strcompat-0.9.2.6.

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
     $> ../strcompat-0.9.2.6/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 ../strcompat-0.9.2.6/INSTALL

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

     $> ../strcompat-0.9.2.6/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 strcompat-0.9.2.6
     $> rm -f strcompat-0.9.2.6.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 ../strcompat-0.9.2.6
     $> less doc/manual/strcompat.txt
     $> lynx doc/manual/strcompat.html
     $> info doc/manual/strcompat.info
     $> xpdf doc/manual/strcompat.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/strcompat_manual.html

1 Introduction

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

1.1 Overview

This manual documents the design, implementation, installation, operation and future development of the OpenSS7 STREAMS Compatibility 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 STREAMS Compatibility package is intended to provide maximum compatibility between Linux STREAMS (LiS) or Linux Fast-STREAMS (LfS) and other STREAMS implementations on major UNIX operating systems, for the purpose of porting existing STREAMS modules and drivers from those operating system to Linux.

Also, the OpenSS7 STREAMS Compatibility package aims to provide compatibility between Linux STREAMS (LiS) and Linux Fast-STREAMS to ease the porting of STREAMS modules and drivers from LiS to Linux Fast-STREAMS with minimal effort.

To meet that objective, OpenSS7 STREAMS Compatibility aims to support the STREAMS DDI/DKI and registration functions of the following STREAMS implementations:

• UNIX System V Release 3.2
• UNIX System V Release 4 MP
• UNIX System V Release 4.0 MP
• UNIX System V Release 4.2 MP
• Mentat Portable Streams (MPS)
• Linux STREAMS LiS 2.16
• Linux STREAMS LiS 2.18
• Linux Fast-STREAMS 0.7a
• Linux Fast-STREAMS 0.9.2
• AIX 5L Version 5.1 Portable STREAMS Environment (PSE)
• HP-UX 11.0i v2 STREAMS/UX
• OSF/1.2 - Digital UNIX STREAMS
• UnixWare 7.1.3 (OpenUnix 8) STREAMS
• Solaris 9/SunOS 5.9 (OpenSolaris) STREAMS
• Mac OS 9 OpenTransport 1.5r2
• IRIX 6.5.17 STREAMS
• SUPER-UX Release 9.2
• UXP/V V10L10 STREAMS V10

The OpenSS7 STREAMS Compatibility package contains compatibility modules that were originally part of the Linux Fast-STREAMS package. They have been separated into an package independent from Linux Fast-STREAMS for the purpose of provide some of the same capabilities to Linux STREAMS (LiS) in advance of production releases of Linux Fast-STREAMS.

2.1 Rationale

The OpenSS7 STREAMS Compatibility package is designed and implemented to be compatible with as many SVR 4.2 MP based implementations of STREAMSa s possible. This is done for several reasons:

1. Porting legacy drivers to Linux:

   Many legacy STREAMS drivers have been written and developed for SVR 4.2 MP or UNIX systems based on SVR 4.2 MP. Remaining compatible with as many implementations as possible permits these legacy drivers to be easily ported from their native UNIX variant to the Linux Fast-STREAMS environment, thus quickly porting these legacy drivers to Linux.

2. Leverage of knowledge base:

   Many developers are familiar with one or another of the mainstream UNIX implementations of SVR 4.2 MP STREAMS. By remaining as compatible as possible with all these implementations of STREAMS permits knowledge and expertise in the UNIX variant of STREAMS to be transferred and applied to Linux Fast-STREAMS on Linux.

3. Reverse portability:

   Because it is compatible as possible with other STREAMS implementations, STREAMS drivers and modules developed on Linux Fast-STREAMS can easily be ported to other implementations if a set of compatibility and portability guidelines are followed. This allows STREAMS driver and modules developed on the Linux operating system to be used on branded UNIX systems with minimal porting and modification.

4. Multiple baselines:

   Because the source code developed for Linux Fast-STREAMS can remain quite close to that for other mainstream UNIX implementations of SVR 4.2 MP STREAMS, it is possible to have multiple baselines for different architectures in the same source code files. This eases the maintenance of STREAMS drivers and modules across Linux Fast-STREAMS and other UNIX systems.

5. Standardization:

   By being as compatible as possible with many STREAMS implementations as possible, Linux Fast-STREAMS implements an ipso facto standard. Unfortunately, the OpenGroup and POSIX have been very lacking in the standardization of internal kernel interfaces such as STREAMS. Maximum compatibility moves close to providing a standard for such interfaces.

6. Licensing and Technology Binding

   By implementing an ipso facto standard, independent STREAMS drivers and modules written to the technical interface avoid being impinged upon by the GNU Public License under which Linux STREAMS and Linux Fast-STREAMS are distributed.

2.2 Use with Linux STREAMS

The OpenSS7 STREAMS Compatibility package was originally part of the Linux Fast-STREAMS base package, streams. The purpose for separating the package was originally to support both LiS and Linux Fast-STREAMS until such time as Linux Fast-STREAMS was a suitable production replacement for LiS. With release streams-0.9.2.3, Linux Fast-STREAMS is a far superior production replacement for LiS and LiS is now deprecated. Although, at one time, the OpenSS7 STREAMS Compatibility package worked with LiS, it is no longer supported on LiS and is only tested and validated for Linux Fast-STREAMS. Even when it was supported, LiS has so many bugs, deficiencies and incompatibilities in the Stream head, that it was not possible to obtain usable compatibility in conjunction with LiS. Linux Fast-STREAMS does not have these problems.

2.3 Use with Linux Fast-STREAMS

The OpenSS7 STREAMS Compatibility package functions much better with the Linux Fast-STREAMS implementation with which it was originally intended to function. Linux Fast-STREAMS provides a superset of the capabilities of SVR 4.2 MP intended to provide compatibility across as many mainstream UNIX implementations of STREAMS as possible. Also, Linux Fast-STREAMS does not have the bugs, races, deficiencies, and other difficulties present in the LiS package.⁷

3 Reference

3.1 Files

The following sections provide a manifest of the files that are installed by the OpenSS7 STREAMS Compatibility package:

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

modules.strcompat

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

streams_os7compat.ko

OpenSS7 compatibility module.

streams_svr3compat.ko

SVR 3 compatibility module.

streams_svr4compat.ko

SVR 4.2 MP compatibility module.

streams_mpscompat.ko

MPS compatibility module.

streams_suncompat.ko

Solaris compatibility module.

streams_uw7compat.ko

UnixWare compatibility module.

streams_osfcompat.ko

OSF/1 compatibility module.

streams_aixcompat.ko

AIX compatibility module.

streams_hpuxcompat.ko

HP-UX compatibility module.

streams_irixcompat.ko

IRIX compatibility module.

streams_liscompat.ko

LiS compatibility module.

streams_maccompat.ko

Mac OT compatibility module.

STRCOMPAT installs the following header files in the system include directory, /usr/include/strcompat/:

sys/strcompat/config.h

Contains configuration defines for the strcompat package.

sys/strcompat/version.h

Contains module versions (on 2.4 kernels) for the strcompat package.

sys/os7/allocb.h

Contains declarations of OpenSS7 buffer allocation helper functions.

sys/os7/bufpool.h

Contains declarations of OpenSS7 buffer pool helper functions.

sys/os7/bufq.h

Contains declarations of OpenSS7 private buffer queue helper functions.

sys/os7/compat.h

Contains declarations of OpenSS7 compatibility defines and includes. This is the only header file that needs to be included for a STREAMS module or driver that needs to be compatible with both LiS and Linux Fast-STREAMS.

sys/os7/debug.h

Contains declarations of OpenSS7 debugging macros.

sys/os7/lock.h

Contains declarations of OpenSS7 queue locking helper functions.

sys/os7/priv.h

Contains declarations of OpenSS7 queue private structure helper functions.

sys/os7/queue.h

Contains declarations of OpenSS7 queue put and service procedure helper functions.

sys/os7/timer.h

Contains declarations of OpenSS7 timer helper functions.

sys/os7/ddi.h

Contains declarations of OpenSS7 additional helper functions.

sys/os7/strconf.h

Contains declarations of OpenSS7 STREAMS configuration helper functions.

sys/os7/stream.h

Contains declarations of OpenSS7 STREAMS helper functions.

sys/stream.h

Contains a main header file providing STREAMS utility function declarations. Depending on defines when including this file, this file may include stream.h files for specific implementations.

sys/strconf.h

Contains a main header file providing STREAMS configuration function declarations. Depending on defines when including this file, this file may include stream.h files for specific implementations.

sys/ddi.h

Contains a main header file providing STREAMS DDI/DKI function declarations. Depending on defines when including this file, this file may include stream.h files for specific implementations.

sys/aix/stream.h

Contains declarations of STREAMS functions unique to AIX.

sys/aix/strconf.h

Contains declarations of STREAMS configuration functions unique to AIX.

sys/aix/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to AIX.

sys/hpux/stream.h

Contains declarations of STREAMS functions unique to HP-UX.

sys/hpux/strconf.h

Contains declarations of STREAMS configuration functions unique to HP-UX.

sys/hpux/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to HP-UX.

sys/irix/stream.h

Contains declarations of STREAMS functions unique to IRIX.

sys/irix/strconf.h

Contains declarations of STREAMS configuration functions unique to IRIX.

sys/irix/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to IRIX.

sys/lis/stream.h

Contains declarations of STREAMS functions unique to LiS.

sys/lis/strconf.h

Contains declarations of STREAMS configuration functions unique to LiS.

sys/lis/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to LiS.

sys/mac/stream.h

Contains declarations of STREAMS functions unique to Mac OT.

sys/mac/strconf.h

Contains declarations of STREAMS configuration functions unique to Mac OT.

sys/mac/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to Mac OT.

sys/mps/stream.h

Contains declarations of STREAMS functions unique to MPS.

sys/mps/strconf.h

Contains declarations of STREAMS configuration functions unique to MPS.

sys/mps/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to MPS.

sys/osf/stream.h

Contains declarations of STREAMS functions unique to OSF/1.

sys/osf/strconf.h

Contains declarations of STREAMS configuration functions unique to OSF/1.

sys/osf/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to OSF/1.

sys/sun/stream.h

Contains declarations of STREAMS functions unique to Solaris.

sys/sun/strconf.h

Contains declarations of STREAMS configuration functions unique to Solaris.

sys/sun/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to Solaris.

sys/sun/strsun.h

Contains specific declarations for Solaris helper functions.

sys/sunddi.h

Main header file used to include Solaris DDI/DKI function declarations.

sys/strsun.h

Main header file used to include Solaris Solaris function declarations.

sys/svr3/stream.h

Contains declarations of STREAMS functions unique to SVR 3.

sys/svr3/strconf.h

Contains declarations of STREAMS configuration functions unique to SVR 3.

sys/svr3/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to SVR 3.

sys/svr4/stream.h

Contains declarations of STREAMS functions unique to SVR 4.2 MP.

sys/svr4/strconf.h

Contains declarations of STREAMS configuration functions unique to SVR 4.2 MP.

sys/svr4/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to SVR 4.2 MP.

sys/uw7/stream.h

Contains declarations of STREAMS functions unique to UnixWare.

sys/uw7/strconf.h

Contains declarations of STREAMS configuration functions unique to UnixWare.

sys/uw7/ddi.h

Contains declarations of STREAMS DDI/DKI functions unique to UnixWare.

STRCOMPAT installs the following test programs in the system libexec directory, /usr/libexec/strcompat/:¹⁰

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 Compatibility 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 STREAMS Compatibility 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.

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

strcompat

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

strcompat.sh

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

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

strcompat.conf

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

modutils/strcompat

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

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

strcompat

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

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

strcompat.info

strcompat.info-1

strcompat.info-2

These files contain this manual in GNU info format.

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

strcompat.macros

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

strcompat.refs

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

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

strcompat.5

manual page for the strcompat(5) package.

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

strcompat_mknod.8

Documentation for the strcompat_mknod(8) utility program.

STRCOMPAT installs the following manual pages in the system man directory, /usr/share/man/man9/:

The OpenSS7 STREAMS Compatibility package installs several hundred manual pages that are too many to list here. Following are just the primary manual pages. Begin with any of these manual pages to obtain references to the remaining pages.

man9/os7compat.9

os7compat(9)

man9/svr3compat.9

svr3compat(9)

man9/svr4compat.9

svr4compat(9)

man9/mpscompat.9

mpscompat(9)

man9/suncompat.9

suncompat(9)

man9/uw7compat.9

uw7compat(9)

man9/osfcompat.9

osfcompat(9)

man9/aixcompat.9

aixcompat(9)

man9/hpuxcompat.9

hpuxcompat(9)

man9/irixcompat.9

irixcompat(9)

man9/liscompat.9

liscompat(9)

man9/maccompat.9

maccompat(9)

3.2 Drivers

The OpenSS7 STREAMS Compatibility package only includes drivers for the purpose of providing examples of the use of the utility functions included in the package, as well as to provide loadable drivers for the purpose of test suite execution. If you are not interested in test suite execution, these drivers can be removed.

STREAMS drivers included in the package are as follows:

streams_aixdrv.ko

an example driver for testing AIX 5L Version 5.1 Portable STREAMS Environment (PSE) compatibility.

streams_hpuxdrv.ko

an example driver for testing HP-UX 11.0i v2 STREAMS/UX compatibility.

streams_irixdrv.ko

an example driver for testing IRIX 6.5.17 STREAMS compatibility.

streams_lfsdrv.ko

an example driver for testing Linux Fast-STREAMS 0.9.2.3 compatibility.

streams_lisdrv.ko

an example driver for testing Linux STREAMS LiS 2.16 and LiS 2.18 compatibility.

streams_macdrv.ko

an example driver for testing Mac OS 9 OpenTransport 1.5r2 compatibility.

streams_mpsdrv.ko

an example driver for testing Mentat Portable Streams (MPS) compatibility.

streams_osfdrv.ko

an example driver for testing OSF/1.2 - Digital UNIX STREAMS compatibility.

streams_sundrv.ko

an example driver for testing Solaris 9/SunOS 5.9 (OpenSolaris) STREAMS compatibility.

streams_suxdrv.ko

an example driver for testing SUPER-UX Release 9.2 compatibility.

streams_svr3drv.ko

an example driver for testing UNIX System V Release 3.2 compatibility.

streams_svr4drv.ko

an example driver for testing UNIX System V Release 4.2 MP compatibility.

streams_uw7drv.ko

an example driver for testing UnixWare 7.1.3 (OpenUnix 8) STREAMS compatibility.

streams_uxpdrv.ko

an example driver for testing UXP/V V10L10 STREAMS V10 compatibility.

3.3 Modules

The OpenSS7 STREAMS Compatibility package only includes modules for the purpose of providing examples of the use of the utility functions included in the package, as well as to provide loadable modules for the purpose of test suite execution. If you are not interested in test suite execution, these modules can be removed.

STREAMS modules included in the package are as follows:

streams_aixmod.ko

an example module for testing AIX 5L Version 5.1 Portable STREAMS Environment (PSE) compatibility.

streams_hpuxmod.ko

an example module for testing HP-UX 11.0i v2 STREAMS/UX compatibility.

streams_irixmod.ko

an example module for testing IRIX 6.5.17 STREAMS compatibility.

streams_lfsmod.ko

an example module for testing Linux Fast-STREAMS 0.9.2.3 compatibility.

streams_lismod.ko

an example module for testing Linux STREAMS LiS 2.16 and LiS 2.18 compatibility.

streams_macmod.ko

an example module for testing Mac OS 9 OpenTransport 1.5r2 compatibility.

streams_mpsmod.ko

an example module for testing Mentat Portable Streams (MPS) compatibility.

streams_osfmod.ko

an example module for testing OSF/1.2 - Digital UNIX STREAMS compatibility.

streams_sunmod.ko

an example module for testing Solaris 9/SunOS 5.9 (OpenSolaris) STREAMS compatibility.

streams_suxmod.ko

an example module for testing SUPER-UX Release 9.2 compatibility.

streams_svr3mod.ko

an example module for testing UNIX System V Release 3.2 compatibility.

streams_svr4mod.ko

an example module for testing UNIX System V Release 4.2 MP compatibility.

streams_uw7mod.ko

an example module for testing UnixWare 7.1.3 (OpenUnix 8) STREAMS compatibility.

streams_uxpmod.ko

an example module for testing UXP/V V10L10 STREAMS V10 compatibility.

3.4 Libraries

3.5 Utilities

The OpenSS7 STREAMS Compatibility package does not provide any system utilities of its own. For a set of system utilities that are compatible across the same wide range of operating systems, use the OpenSS7 STREAMS Utilities package.

What the OpenSS7 STREAMS Compatibility package does provide is a set of kernel modules that provide compatibility utilities to the STREAMS module or driver developer. These kernel modules are as follows:

streams_aixcompat.ko

STREAMS module writer utilities for AIX 5L Version 5.1 Portable STREAMS Environment (PSE) compatibility.

streams_hpuxcompat.ko

STREAMS module writer utilities for HP-UX 11.0i v2 STREAMS/UX compatibility.

streams_irixcompat.ko

STREAMS module writer utilities for IRIX 6.5.17 STREAMS compatibility.

streams_lfscompat.ko

STREAMS module writer utilities for Linux Fast-STREAMS 0.9.2.3 compatibility.

streams_liscompat.ko

STREAMS module writer utilities for Linux STREAMS LiS 2.16 and LiS 2.18 compatibility.

streams_maccompat.ko

STREAMS module writer utilities for Mac OS 9 OpenTransport 1.5r2 compatibility.

streams_mpscompat.ko

STREAMS module writer utilities for Mentat Portable Streams (MPS) compatibility.

streams_osfcompat.ko

STREAMS module writer utilities for OSF/1.2 - Digital UNIX STREAMS compatibility.

streams_suncompat.ko

STREAMS module writer utilities for Solaris 9/SunOS 5.9 (OpenSolaris) STREAMS compatibility.

streams_suxcompat.ko

STREAMS module writer utilities for SUPER-UX Release 9.2 compatibility.

streams_svr3compat.ko

STREAMS module writer utilities for UNIX System V Release 3.2 compatibility.

streams_svr4compat.ko

STREAMS module writer utilities for UNIX System V Release 4.2 MP compatibility.

streams_uw7compat.ko

STREAMS module writer utilities for UnixWare 7.1.3 (OpenUnix 8) STREAMS compatibility.

streams_uxpcompat.ko

STREAMS module writer utilities for UXP/V V10L10 STREAMS V10 compatibility.

3.5.1 AIX Utilities

3.5.2 HP-UX Utilities

3.5.3 IRIX Utilities

3.5.4 LfS Utilities

3.5.5 LiS Utilities

3.5.6 MacOT Utilities

3.5.7 MPS Utilities

3.5.8 OSF Utilities

3.5.9 Solaris Utilities

3.5.10 SUPER-UX Utilities

3.5.11 SVR3 Utilities

3.5.12 SVR4 Utilities

3.5.13 UnixWare Utilities

3.5.14 UXP/V Utilities

3.6 Development

The OpenSS7 STREAMS Compatibility package contains the necessary header files, shared and static libraries, manuals and manual pages, necessary for the development of kernel modules, STREAMS modules and drivers, and applications programs based on the OpenSS7 STREAMS Compatibility package.

3.6.1 Header Files

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

In general, `-I' include directives on the gcc command line should be ordered in the reverse order of the dependencies between add-on packages. So, for example, if the include files from all add-on packages are required, the order of the