OpenSS7 STREAMS Network Services Library
OpenSS7 STREAMS Network Services Library Installation and Reference Manual
About This Manual
This is Edition 4, last updated 2008-10-31, of The
OpenSS7 STREAMS Network Services Library Installation and Reference Manual, for Version 0.9.2
release 4 of the OpenSS7 STREAMS Network Services Library package.
Preface
Notice
This package is released and distributed under the AGPL (see GNU Affero General Public License). Please note, however, that there are different licensing terms for the manual pages and
some of the documentation (derived from OpenGroup1
publications and other sources). Consult the permission notices contained in the documentation for
more information.
This manual is released under the FDL (see GNU Free Documentation License) with no
sections invariant.
Abstract
This manual provides a Installation and Reference Manual for OpenSS7 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.4.2
Version Control
strnsl.texi,v
Revision 0.9.2.12 2008-09-20 11:04:37 brian
- added package patchlevel
Revision 0.9.2.11 2008-08-03 06:03:38 brian
- protected agains texinfo commands in log entries
Revision 0.9.2.10 2008/07/27 08:49:34 brian
- no invariant sections, more libtool ignores
Revision 0.9.2.9 2008-04-28 22:11:47 brian
- updated headers for release
Revision 0.9.2.8 2008-04-25 11:50:53 brian
- updates to AGPLv3
Revision 0.9.2.7 2007/08/12 06:44:52 brian
- updated licenses in manuals
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:
| − Per Berquist
|
| − John Boyd
|
| − Chuck Winters
|
| − Peter Courtney
|
| − Tom Chandler
|
| − Gurol Ackman
|
| − Kutluk Testicioglu
|
| − John Wenker
|
| − Others
|
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.4 was released under AGPLv3 2008-10-31.
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:
- Network Selection, consisting of:
- 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:
| − <netconfig.h> Network Configuration
|
| − <sys/netconfig.h> Network Configuration
|
| − <netdir.h> Network Directory
|
Note that the XTI/TLI Library and Transport Provider Interface header files are
contained in the ‘strxnet-0.9.2.12’ 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.4 package, released 2008-10-31. This
‘0.9.2.4’ 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.4.tar.bz2
The release is available as an autoconf(1) tarball, src.rpm or dsc, as a
set of binary rpms or debs, or as a yum(8) or apt(8) repository.
See the download page for the autoconf(1)
tarballs, src.rpms, dscs, or repository access instructions. See the
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 3 of the GNU Affero Public License
which can be found in the file
COPYING.
Package specific licensing terms (if any) can be found in the file
LICENSES.
Please respect these licensing arrangements. If you are interested in different licensing terms,
please contact the copyright holder, or
OpenSS7 Corporation <sales@openss7.com>.
See
README-alpha
(if it exists) for alpha release information.
Prerequisites
The quickest and easiest way to ensure that all prerequisites are met is to download and install
this package from within the OpenSS7 Master Package,
openss7-0.9.2.G, instead of separately.
Prerequisites for the OpenSS7 STREAMS Network Services Library package are as follows:
- Linux distribution, somewhat Linux Standards Base compliant, with a 2.4 or 2.6 kernel
and the appropriate tool chain for compiling out-of-tree kernel modules. Most recent Linux
distributions are usable out of the box, but some development packages must be installed. For more
information, see Compatibility.
| −
A fairly LSB compliant GNU/Linux distribution.3
|
| −
Linux 2.4 kernel (2.4.10 - 2.4.27), or
|
| −
Linux 2.6 kernel (2.6.3 - 2.6.26);
|
| −
glibc2 or better.
|
| −
GNU groff (for man pages).4
|
| −
GNU texinfo (for info files).
|
(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.)
- OpenSS7 Linux Fast-STREAMS,
streams-0.9.2.4.
5
- OpenSS7 STREAMS Compatibility Modules,
strcompat-0.9.2.7.
- OpenSS7 STREAMS XNS,
strxns-0.9.2.7.
- OpenSS7 STREAMS XTI/TLI,
strxnet-0.9.2.12.
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.4/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.4.tar.bz2
$> tar -xjvf strnsl-0.9.2.4.tar.bz2
$> mkdir build
$> pushd build
$> ../strnsl-0.9.2.4/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.4
$> rm -f strnsl-0.9.2.4.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.6 Installation steps using the logging targets proceed as follows:
$> wget http://www.openss7.org/tarballs/strnsl-0.9.2.4.tar.bz2
$> tar -xjvf strnsl-0.9.2.4.tar.bz2
$> mkdir build
$> pushd build
$> ../strnsl-0.9.2.4/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.4
$> rm -f strnsl-0.9.2.4.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.4.tar.bz2
Unpack the tarball using a command such as:
$> tar -xjvf strnsl-0.9.2.4.tar.bz2
The tarball will unpack into the relative subdirectory named after the package name:
strnsl-0.9.2.4.
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.4/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.4/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.4/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.4
$> rm -f strnsl-0.9.2.4.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.4
$> 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-STREAMS7.
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
strxns8
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:
- Network Selection, consisting of:
- 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/:9
- 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/:10
- 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.7
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.4
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.4
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.4 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.4 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):
strnsl(5) – | OpenSS7 STREAMS Network Services Library package.
|
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 STREAMS11
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
STREAMS12
package for use with both Linux STREAMS13 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.G, instead of separately.
Prerequisites for the OpenSS7 STREAMS Network Services Library package are as follows:
- 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.26);
|
| −
glibc2 or better.
|
| −
GNU groff (for man pages).15
|
| −
GNU texinfo (for info files).
|
(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.)
- OpenSS7 Linux Fast-STREAMS,
streams-0.9.2.4.
16
- OpenSS7 STREAMS Compatibility Modules,
strcompat-0.9.2.7.
- OpenSS7 STREAMS XNS,
strxns-0.9.2.7.
- OpenSS7 STREAMS XTI/TLI,
strxnet-0.9.2.12.
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:17
- CentOS Enterprise Linux 3.4 (centos34) TBD
- CentOS Enterprise Linux 4.0 (centos4) TBD
- CentOS Enterprise Linux 4.92 (centos49) TBD
- CentOS Enterprise Linux 5.0 (centos5)
- CentOS Enterprise Linux 5.1 (centos51)
- CentOS Enterprise Linux 5.2 (centos52)
- Debian 3.0r2 Woody (deb3.0) TBD
- Debian 3.1r0a Sarge (deb3.1) TBD
- Debian 4.0r1 Etch (deb4.0)
- Debian 4.0r2 Etch (deb4.0)
- Debian 4.0r3 Etch (deb4.0)
- Fedora Core 1 (FC1) TBD
- Fedora Core 2 (FC2) TBD
- Fedora Core 3 (FC3) TBD
- Fedora Core 4 (FC4) TBD
- Fedora Core 5 (FC5) TBD
- Fedora Core 6 (FC6) TBD
- Fedora 7 (FC7)
- Fedora 8 (FC8)
- Fedora 9 (FC9)
- Gentoo 2006.1 (untested) TBD
- Gentoo 2007.1 (untested) TBD
- Lineox 4.026 (LEL4) TBD
- Lineox 4.053 (LEL4) TBD
- Mandrakelinux 9.2 (MDK92) TBD
- Mandrakelinux 10.0 (MDK100) TBD
- Mandrakelinux 10.1 (MDK101) TBD
- Mandriva Linux LE2005 (MDK102) TBD
- Mandriva Linux LE2006 (MDK103) TBD
- Mandriva One (untested)
- RedHat Linux 7.2 (RH7)
- RedHat Linux 7.3 (RH7)
- RedHat Linux 8.0 (RH8) TBD
- RedHat Linux 9 (RH9) TBD
- RedHat Enterprise Linux 3.0 (EL3) TBD
- RedHat Enterprise Linux 4 (EL4)
- RedHat Enterprise Linux 5 (EL5)
- SuSE 8.0 Professional (SuSE8.0) TBD
- SuSE 9.1 Personal (SuSE9.1) TBD
- SuSE 9.2 Professional (SuSE9.2) TBD
- SuSE OpenSuSE (SuSEOSS) TBD
- SuSE 10.0 (SuSE10.0) TBD
- SuSE 10.1 (SuSE10.1) TBD
- SuSE 10.2 (SuSE10.2) TBD
- SuSE 10.3 (SuSE10.3) TBD
- SuSE 11.0 (SuSE11.0)
- SLES 9 (SLES9) TBD
- SLES 9 SP2 (SLES9) TBD
- SLES 9 SP3 (SLES9) TBD
- SLES 10 (SLES10)
- Ubuntu 5.10 (ubu5.10) TBD
- Ubuntu 6.03 LTS (ubu6.03) TBD
- Ubuntu 6.10 (ubu6.10) TBD
- Ubuntu 7.04 (ubu7.04) TBD
- Ubuntu 7.10 (ubu7.10)
- Ubuntu 8.04 (ubu8.04)
- WhiteBox Enterprise Linux 3.0 (WBEL3) TBD
- WhiteBox Enterprise Linux 4 (WBEL4) TBD
When installing from the tarball (see Installing the Tar Ball), this distribution is probably
compatible with a much broader array of distributions than those listed above. These are the
distributions against which the current maintainer creates and tests builds.
6.2.2 Kernel
The OpenSS7 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.18 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.26
(with Fedora 9, openSUSE 11.0 and Ubuntu 8.04 patchsets). Please note that your mileage may vary if
you use a kernel more recent than 2.6.26.4: 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 was initially performed on UP machines, as well as on an Intel 3.0GHz Pentium IV 630 with
HyperThreading enabled (2x). Because HyperThreading is not as independent as multiple CPUs, SMP
validation testing was limited. Current releases have been tested on dual 1.8GHz Xeon HP servers
(2x) as well as dual quad-core SunFire (8x) servers.
It should be noted that, while the packages will configure, build and install against XEN kernels,
that problems running validation test suites against XEN kernels has been reported. XEN
kernels are explicitly not supported. This may change at some point in the future if someone
really requires running OpenSS7 under a XEN kernel.
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,19
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.7 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.4 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.4
This is the fourth separate OpenSS7 Project release 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 fourth alpha release and is part of the OpenSS7 Master Package
(openss7-0.9.2.G).
The release includes maintenance support for recent distributions and tool chain, but also includes
some performance and feature upgrades and inspection bug fixes.
It deprecates previous releases. Please upgrade before reporting bugs on previous releases.
Major features since the last public release are as follows:
- Minor documentation corrections.
- Kernel module license made explicit "GPL v2". And then changed back to "GPL".
- License upgrade to AGPL Version 3.
- Support for flex 2.5.33 in maintainer mode.
- Ability to strap out major documentation build and installation primarily for embedded targets.
- Improvements to common build process for embedded and cross-compile targets.
- Updated tool chain to m4-1.4.12, autoconf-2.63 and texinfo-4.13.
- Conversion of RPM spec files to common approach for major subpackages.
- Updated references database for manual pages and roff documents.
- Build system now builds
yum(8)
repositories for RPMs and apt-get(8)
repositories
for DEBs. Installation documentation has been updated to include details of repository install
sourcesref.
- Added
MODULE_VERSION
to all modules and drivers.
- Several important bug fixes for thread safety of the xnsl library: see
BUGS in the
release for more information.
This is a public alpha release of the package: it deprecates previous releases. Please
upgrade to the current release before reporting bugs. Please see README-alpha in the
release, or Maturity.
As with other OpenSS7 releases, this release configures, compiles, installs and builds RPMs and DEBs
for a wide range of Linux 2.4 and 2.6 RPM- and DPKG-based distributions, and can be used on
production kernels without patching or recompiling the kernel.
This package is publicly released under the GNU Affero General Public License Version 3. The
release is available as an autoconf tarball, SRPM, DSC, and set of binary RPMs and DEBs.
See the downloads page for the autoconf
tarballs, SRPMs and DSCs. For tarballs, SRPMs, DSCs and binary RPMs and DEBs, see the
strnsl package page.
See http://www.openss7.org/codefiles/strnsl-0.9.2.4/ChangeLog and
http://www.openss7.org/codefiles/strnsl-0.9.2.4/NEWS in the release for more
information. Also, see the strnsl.pdf manual in the release (also in html
http://www.openss7.org/strnsl_manual.html).
For the news release, see http://www.openss7.org/rel20081029_D.html.
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 third 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
This is the second 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 for Linux Fast-STREAMS and is part of
the OpenSS7 Master Package (openss7-0.9.2.E). The
release provides support for recent distributions and tool chains.
Major features since the last public release are as follows:
- Improvements to the common build environment with better support for standalone
package builds on 2.4 kernels.
- Support for autoconf 2.61, automake 1.10 and gettext 0.16.
- Support for Ubuntu 6.10 distribution and bug fixes for i386 kenels.
- The package now looks for other subpackages with a version number as unpacked by
separate tarball.
Major changes for release strnsl-0.9.2.1
This is the first 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 initial alpha release for Linux Fast-STREAMS and is part of
the OpenSS7 Master Package (openss7-0.9.2.G).
This release is the initial public release.
6.4 Maturity
The OpenSS7 Project adheres to the following release philosophy:
- pre-alpha release
- alpha release
- beta release
- gamma release
- production release
- unstable release
6.4.1 Pre-Alpha Releases
Pre-alpha releases are releases that have received no testing whatsoever. Code in the release
is not even known to configure or compile. The purpose of a pre-alpha release is to make code and
documentation available for inspection only, and to solicit comments on the design approach or other
characteristics of the software package.
Pre-alpha release packages ship containing warnings recommending that the user not even
execute the contained code.
6.4.2 Alpha Releases
Alpha releases are releases that have received little to no testing, or that have been tested
and contains known bugs or defects that make the package unsuitable even for testing. The purpose
for an alpha release are the same as for the pre-alpha release, with the additional purpose
that it is an early release of partially functional code that has problems that an external
developer might be willing to fix themselves and contribute back to the project.
Alpha release packages ship containing warnings that executing the code can crash machines and
might possibly do damage to systems upon which it is executed.
6.4.3 Beta Releases
Beta releases are releases that have received some testing, but the testing to date is not
exhaustive. Beta release packages do not ship with known defects. All known defects are
resolved before distribution; however, as exhaustive testing has not been performed, unknown
defects may exist. The purpose for a beta release is to provide a baseline for other
organizations to participate in the rigorous testing of the package.
Beta release packages ship containing warnings that the package has not been exhaustively
tested and that the package may cause systems to crash. Suitability of software in this category
for production use is not advised by the project; however, as always, is at the discretion of the
user of the software.
6.4.4 Gamma Releases
Gamma releases are releases that have received exhaustive testing within the project, but
external testing has been minimal. Gamma release packages do not ship with known defects. As
exhaustive internal testing has been performed, unknown defects should be few. Please remember that
there is NO WARRANTY on public release packages.
Gamma release packages typically resolve problems in previous beta releases, and might
not have had full regression testing performed. Suitability of software in this category for
production use is at the discretion of the user of the software. The OpenSS7 Project
recommends that the complete validation test suites provided with the package be performed and pass
on target systems before considering production use.
6.4.5 Production Releases
Production releases are releases that have received exhaustive testing within the project and
validated on specific distributions and architectures. Production release packages do not
ship with known defects. Please remember that there is NO WARRANTY on public release packages.
Production packages ship containing a list of validated distributions and architectures.
Full regression testing of any maintenance changes is performed. Suitability of software in this
category for production use on the specified target distributions and architectures is at the
discretion of the user. It should not be necessary to preform validation tests on the set of
supported target systems before considering production use.
6.4.6 Unstable Releases
Unstable releases are releases that have received extensive testing within the project and
validated on a a wide range of distributions and architectures; however, is has tested unstable and
found to be suffering from critical problems and issues that cannot be resolved. Maintenance of the
package has proved impossible. Unstable release packages ship with known defects (and loud
warnings). Suitability of software in this category for production use is at the discretion of the
user of the software. The OpenSS7 Project recommends that the problems and issues be closely
examined before this software is used even in a non-production environment. Each failing test
scenario should be completely avoided by the application. OpenSS7 beta software is more
stable that software in this category.
6.5 Bugs
6.5.1 Defect Notices
OpenSS7 STREAMS Network Services Library has unknown defects. This is an alpha release. Some defects could
be harmful. No validation testing whatsoever has been performed by the OpenSS7 Project on
this software. The software might fail to configure or compile on some systems. The OpenSS7
Project recommends that you do not use this software for purposes other than develoment or
evaluation, and then only with great care. Use at your own risk. Remember that there is NO
WARRANTY.20
This software is alpha software. As such, it can likely crash your kernel. Installation of
the software can irreparably mangle your header files or Linux distribution in such a way as to make
it unusable. Crashes could lock your system and rebooting the system might not repair the problem.
You can possibly lose all the data on your system. Because this software can crash your kernel,
the resulting unstable system could destroy computer hardware or peripherals making them unusable.
You could void the warranty on any system on which you run this software. YOU HAVE BEEN WARNED.
6.5.2 Known Defects
With the exception of packages not originally created by the OpenSS7 Project, the
OpenSS7 Project software does not ship with known bugs in any release stage except
pre-alpha. OpenSS7 STREAMS Network Services Library had no known bugs at the time of release.
6.5.3 Defect History
This section contains historical bugs that were encountered during development
and their resolutions. This list serves two purposes:
- It captures bugs encountered between releases during development that could possibly reoccur (and
the Moon is made of blue cheese). It therefore provides a place for users to look if they encounter
a problem.
- It provides a low overhead bug list between releases for developers to use as a TODO list.
Bugs
004. 2008-08-20T06:02:09+0000
-
To permit the xnsl library to be used on systems with the broken libtirpc package, we now place the
file in /etc/netconfig.xnsl instead of /etc/netconfig where the broken libtirpc package for
GNU/Linux expects a broken /etc/netconfig configuration file. The library has been adjusted to
first look for /etc/netconfig.xnsl before looking for /etc/netconfig.
*fixed* in strnsl-0.9.2.4.
003. 2008-08-17T03:42:23+0000
-
The
xnsl
library was discovered to contain a thread-safety bug caused by newer behaviour of pthread_once()
causing the library to core dump when used on recent implementations of pthreads (nptl).
*fixed* in strnsl-0.9.2.4.
002. 2007-06-20T15:22:19-0600
- The libtirpc package for current releases of GNU/Linux including NFS4 has usurped a broken
/etc/netconfig file for use by its broken implementation of TI-RPC. So when strnsl and more
importantly the strinet package installs its /etc/netconfig entries, the libtirpc package breaks.
To avoid this problem, I think that the best approach is to install a libtirpc entry (or a copy
of the broken /etc/netconfig) into the /etc/netconfig.d subdirectory when strnsl installs and
restore it to /etc/netconfig when strnsls removes.
Fixed in the current release: the actual fix involves not calculating the /etc/netconfig file from
the /etc/netconfig.d subdirectory entries when an /etc/netconfig file exists that we have not
generated.
001. 2007-03-05T01:21:21-0700
- RPMs built on 2.4 kernels install the ‘include strnsl’ line to modules.conf when there
is no such directory installed by any of the rpms. This means that depmod complains
loudly about the missing directory. This was fixed for the current release.
6.6 Schedule
Current Plan
Current plans are to just maintain this package for recent distributions, kernels and tool chains.
Although at some point the relation of this package to TI-RPC 2.8 needs to be worked out, when that
will happen is not currently on a schedule. I do not really know how much of a requirement there is
for ONC RPC running over other transports such as ISO transports and SCTP transports, although it
would surely be interesting to run NFS4 over SCTP.
This package is not currently a priority for the OpenSS7 Project, which is focussed on more
telecom-specific protocol stacks and capabilities. Nevertheless, if completion of this package is
important in your industry and your organization is able to fund further development or contribute
the missing items, contact us on the openss7-develop mailing list. Until funding or a mandate
surfaces, this package will likely continue as a proof-of-concept only. It will be maintained in a
compilable and installable package (that is, it will be updated for current Linux distributions and
kernels) on the same basis as other packages in the OpenSS7 master package.
Things to Do
6.7 History
For the latest developments with regard to history of changes, please see the ChangeLog file
in the release package.
7 Installation
7.1 Repositories
The OpenSS7 STREAMS Network Services Library package release can be accessed from the repositories of
The OpenSS7 Project. For rpm(1) based systems, the
package is available in a yum(8) repository based on repomd XML and may also be
accessed using zypper(8) or yast(8). For dpkg(1) based systems, the
package is available in a apt(8) repository.
By far the easiest (most repeatable and manageable) form for installing and using OpenSS7
packages is to install packages from the yum(8) or apt(8) repositories. If your
distribution does not support yum(8), zypper(8), yast(8) or
apt(8), then it is still possible to install the RPMs or DEBs from the repositories using
rpm(1), dpkg(1); or by using wget(1) and then installing them from RPM
or DEB using rpm(1) or dpkg(1) locally.
If binaries are not available for your distribution or specific kernel, but your distribution
supports rpm(1)
or dpkg(1)
, the next best method for installing and using
OpenSS7 packages is to download and rebuild the source RPMs or DSCs from the repository.
This can also be performed with yum(8), zypper(8), yast(8),
apt(8); or directly using wget(1), rpm(1) or dpkg(1).
If your architecture does not support rpm(1) or dpkg(1) at all, or you have
special needs (such as cross-compiling for embedded targets), the final resort method is to
download, configure, build and install from tarball. In this later case, the easiest way to build
and install OpenSS7 packages from tarball is to use the tarball for the OpenSS7 Master
Package, openss7-0.9.2.G.
7.1.1 Repositories for YUM
To install or upgrade from the OpenSS7 repomd repositories, you will need a file in
your /etc/yum.repo.d/ directory. This file can be obtained directly from the OpenSS7
repository, like so:
$> REPOS="http://www.openss7.org/repos/rpms"
$> wget $REPOS/centos/5.2/x86_64/repodata/openss7.repo
$> sudo cp -f openss7.repo /etc/yum.repo.d/
$> sudo yum makecache
This example assumes the the distribution is ‘centos’ and the distribution release is
‘5.2’ and the architecture requires is ‘x86_64’. Another example would be
$REPOS/i686/suse/11.0/i686/repodata/openss7.repo, for using yum(8) with SUSE.
Once the repository is set up, OpenSS7 includes a number of virtual package definitions that
eas the installation and removal of kernel modules, libraries and utilities. Downloading,
configuring, building and installation for a single-kernel distribution is as easy as:
$> sudo yum install strnsl
Removing the package is as easy as:
$> sudo yum remove strnsl
If you have difficulty downloading the openss7.repo file, edit the following information into
the file and place it into the /etc/yum.repo.d/openss7.repo file:
-| [openss7]
-| enabled = 1
-| name = OpenSS7 Repository
-| baseurl = http://www.openss7.org/repos/rpms/centos/5.2/x86_64
-| gpgcheck = 1
-| gpgkey = http://www.openss7.org/pubkey.asc
Note that it is also possible to point to these repositories as an additional installation source
when installing CentOS, RedHat, Fedora, or others. You will have an additional STREAMS
category from which to choose installation packages.
Some additional installation real or virtual package names and the installations they accomplish are
as follows:
- ‘strnsl’
-
This package can be used to install or remove the entire OpenSS7 STREAMS Network Services Library package. When
installing, kernel modules will be installed automatically for the highest version kernel on your
system. When removing, all corresponding kernel modules will also be removed.
- ‘strnsl-devel’
-
This package can be used to install or remove the development components of the
OpenSS7 STREAMS Network Services Library package. When installing, ‘strnsl’ and appropriate kernel
module and kernel module development and debug packages will also be installed. When removing, the
development package and all kernel module development and debug packages will also be removed.
- ‘strnsl-2.4.20-28.7’
-
This package can be used to install or remove the package for a specific kernel version. When
installing, the ‘strnsl’ package will also be installed if necessary. When removing
the last kernel module package, the ‘strnsl’ package will also be removed.
Note that the version ‘2.4.20-28.7’ is just an example. Use the version returned by
‘$(uname -r)’ for the kernel for which you wish to install or remove the packages.
- ‘strnsl-2.4.20-28.7-devel’
-
This package can be used to install or remove the development and debug packages for a specific
kernel version. When installing, the ‘strnsl’ and ‘strnsl-devel’
packages will also be installed if necessary. When removing the development and debug for kernel
modules for the last kernel, the ‘strnsl-devel’ package will also be removed.
Note that the version ‘2.4.20-28.7’ is just an example. Use the version returned by
‘$(uname -r)’ for the kernel for which you wish to install or remove the packages.
For assistance with specific RPMs, see Downloading the Binary RPM.
7.1.2 Repositories for APT
For assistance with specific DEBs, see Downloading the Debian DEB.
7.2 Downloading
The OpenSS7 STREAMS Network Services Library package releases can be downloaded from the downloads page of
The OpenSS7 Project.
The package is available as a binary RPM (for popular architectures) a source RPM, Debian binary DEB
and source DSC, or as a tar ball.
If you are using a browsable viewer, you can obtain the OpenSS7 release of
strnsl from the links in the sections that follow.
By far the easiest (most repeatable and manageable) form for installing and using OpenSS7
packages is to download and install individual packages from binary RPM or DEB. If binary RPMs or
DEBs are not available for your distribution, but your distribution supports rpm(1)
or
dpkg(1)
, the next best method for installing and using OpenSS7 packages is to
download and rebuild the source RPMs or DSCs.
If your architecture does not support rpm(1) or dpkg(1) at all, or you have
special needs (such as cross-compiling for embedded targets), the final resort method is to
download, configure, build and install from tarball. In this later case, the easiest way to build
and install OpenSS7 packages from tarball is to use the tarball for the
OpenSS7 Master Package, openss7-0.9.2.G.
7.2.1 Downloading with YUM
OpenSS7 repositories support yum(8)
and zypper(8)
in repomd XML format as well as
YaST and YaST2 formats.
OpenSS7 includes virtual packages that ease the installation and removal of kernel modules,
libraries and utilities.
Downloading, configuration, building and installation for a signle-kernel distribution installation
is as easy as:
% sudo yum install strnsl
|
This and additional packages for installation are detailed as follows:
- strnsl
- Install this package if you need the runtime strnsl package.
% sudo yum install strnsl
This will install the strnsl, strnsl-lib and
strnsl-KVERSION RPMs, where ‘KVERSION’ is the highest version number kernel on
your system.
Remove this package if you need to remove all vestages of the strnsl package.
% sudo yum remove strnsl
This will remove the strnsl, strnsl-lib,
strnsl-devel, strnsl-KVERSION and
strnsl-devel-KVERSION RPMs for all kernels on your system.
- strnsl-devel
- Install this package if you need the development strnsl package.
% sudo yum install strnsl-devel
This will install the strnsl, strnsl-lib,
strnsl-devel, strnsl-KVERSION and
strnsl-devel-KVERSION RPMs, where ‘KVERSION’ is the highest version number
kernel on your system.
Remove this package if you do not need development capabilities for the strnsl
package for any kernel.
% sudo yum remove strnsl-devel
This will remove the strnsl-devel and strnsl-devel-KVERSION
RPMs for all kernels on your system.
- strnsl-2.4.20-28.7
- Install this package if you need the runtime strnsl for kernel version
‘2.4.20-28.7’. The value ‘2.4.20-28.7’ is just an example. For the running
kernel, you can install the runtime strnsl components with:
% sudo yum install strnsl-$(uname -r)
This will install the strnsl, strnsl-lib and
strnsl-2.4.20-28.7 RPMs, where ‘2.4.20-28.7’ is the kernel version
specified.
Remove this package if you no longer need the runtime strnsl for kernel version
‘2.4.20-28.7’. The value ‘2.4.20-28.7’ is just an example. For the running
kernel, you can remove the runtime strnsl components with:
% sudo yum remove strnsl-$(uname -r)
This will remove the strnsl-2.4.20-28.7 and
strnsl-devel-2.4.20-28.7 RPMs, where ‘2.4.20-28.7’ is the kernel
version specified. Also, if this is the last kernel for which strnsl was installed,
the strnsl strnsl-lib and strnsl-devel RPMs will
also be removed.
Note that this is a virtual package name: the actual RPMs installed or removed from the system is a
kernel module package whose precise name will depend upon the system being used.
- strnsl-devel-2.4.20-28.7
- Install this package if you need the development strnsl package for kernel version
‘2.4.20-28.7’. The value ‘2.4.20-28.7’ is just an example. For the running
kernel, you can install the kernel development strnsl components with:
% sudo yum install strnsl-devel-$(uname -r)
This will install the strnsl, strnsl-lib,
strnsl-devel, strnsl-2.4.20-28.7 and
strnsl-devel-2.4.20-28.7 RPMs, where ‘2.4.20-28.7’ is the kernel
version specified.
Remove this package if you no longer need the development capabilities for the
strnsl package for kernel version ‘2.4.20-28.7’. The value
‘2.4.20-28.7’ is just an example. For the running kernel, you can remove the kernel
development strnsl components with:
% sudo yum remove strnsl-devel-$(uname -r)
This will remove the strnsl-devel-2.4.20-28.7 RPMs, where
‘2.4.20-28.7’ is the kernel version specified. Also, if this is the last kernel for
which strnsl was installed, the strnsl-devel RPMs will also be
removed.
Note that this is a virtual package name: the actual RPMs installed or removed from the system is a
kernel module package whose precise name will depend upon the system being used.
- strnsl-lib
- This package is an auxillary package that should be removed and inserted automatically by
yum(8)
. In rare instances you might need to remove or install this package explicitly.
7.2.2 Downloading with APT
OpenSS7 repositries support apt(8)
repositorie digests and signatures.
7.2.3 Downloading the Binary RPM
To install from binary RPM, you will need several of the RPM for a complete installation. Binary
RPM fall into several categories. To download and install a complete package requires the
appropriate RPM from each of the several categories below, as applicable. Some release packages do
not provide RPMs in each of the several categories.
To install from Binary RPM, you will need all of the following kernel
independent packages for your architecture, and one of the kernel-dependent
packages from the next section.
Independent RPM
Independent RPM are
dependent on neither the Linux kernel version, nor the STREAMS package.
For example, the
source package
‘strnsl-source-0.9.2.4-1.7.2.noarch.rpm’,
is not dependent on
kernel
nor STREAMS package.
All of the following kernel and STREAMS independent RPM are required for your architecture.
Binary RPMs listed here are for example only: additional binary RPMs are
available from the downloads site. If your architecture is not available, you
can build binary RPM from the source RPM (see see Building from the Source RPM).
Architecture Independent
- strnsl-dev-0.9.2.4-1.7.2.noarch.rpm
- The strnsl-dev package contains the device definitions necessary
to run applications programs developed for OpenSS7 STREAMS Network Services Library.21
- strnsl-doc-0.9.2.4-1.7.2.noarch.rpm
- The strnsl-doc package contains this manual in plain text,
postscript, pdf and html forms, along with the meta-information from the
strnsl package. It also contains all of the manual pages
necessary for developing OpenSS7 STREAMS Network Services Library applications and
OpenSS7 STREAMS Network Services Library STREAMS modules or drivers.
- strnsl-init-0.9.2.4-1.7.2.noarch.rpm
- The strnsl-init package contains the init scripts and provides
the ‘postinst’ scripts necessary to create kernel module preloads and modules
definitions for all kernel module ‘core’ subpackages.
- strnsl-source-0.9.2.4-1.7.2.noarch.rpm
- The strnsl-source package contains the source code necessary for
building the OpenSS7 STREAMS Network Services Library release. It includes the autoconf(1)
configuration utilities necessary to create and distribute tarballs, rpm and
deb/dsc.
22
Architecture Dependent
- strnsl-devel-0.9.2.4-1.7.2.i686.rpm
- The strnsl-devel package contains library archives for static
compilation, header files to develop OpenSS7 STREAMS Network Services Library modules and drivers.
This also includes the header files and static libraries required to compile
OpenSS7 STREAMS Network Services Library applications programs.
- strnsl-lib-0.9.2.4-1.7.2.i686.rpm
- The strnsl-lib package contains the run-time shared libraries
necessary to run application programs and utilities developed for the
strnsl package.
23
STREAMS-Dependent RPM
STREAMS-Dependent RPM are dependent upon the specific STREAMS package being
used, either Linux STREAMS or Linux Fast-STREAMS. Packages
dependent upon Linux STREAMS will have LiS in the package name.
Packages dependent upon Linux Fast-STREAMS will have streams in
the package name. Note that some STREAMS-Dependent RPM are also
Kernel-Dependent RPM as described below.
One of the following STREAMS-Dependent packages is required for your
architecture. If your architecture is not on the list, you can build binary RPM
from the source RPM (see see Building from the Source RPM).
- strnsl-LiS-util-0.9.2.4-1.7.2.i686.rpm
- The strnsl-LiS-util package provides administrative and
configuration test utilities and commands associated with the
OpenSS7 STREAMS Network Services Library package. Because this package must link a
STREAMS-specific library, it is a STREAMS-Dependent package. Use the
strnsl-LiS-util package if you have LiS installed.
- strnsl-streams-util-0.9.2.4-1.7.2.i686.rpm
- The strnsl-streams-util package provides administrative and
configuration test utilities and commands associated with the
OpenSS7 STREAMS Network Services Library package. Because this package must link a
STREAMS-specific library, it is a STREAMS-Dependent package. Use the
strnsl-streams-util package if you have streams installed.
Kernel-Dependent RPM
Kernel-Dependent RPM are dependent on specific Linux Kernel Binary RPM releases.
Packages are provided for popular released RedHat kernels. Packages
dependent upon RedHat or other kernel RPM will have the ‘_kversion’
kernel package version in the package name.
One of the following Kernel-Dependent packages is required for your architecture
and kernel version. If your architecture or kernel version is not on the list,
you can build binary RPM from the source RPM (see see Building from the Source RPM).24
- strnsl-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strnsl-core package contains the loadable kernel modules
that depend only on the kernel. This package is heavily tied to the kernel for
which it was compiled. This particular package applies to kernel version
‘2.4.20-28.7’.25
- strnsl-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strnsl-info package26 contains the
module symbol version information for the core subpackage, above. It is
possible to load this subpackage and compile modules that use the exported
symbols without loading the actual kernel modules (from the core
subpackage above). This package is heavily tied to the kernel for which it was
compiled. This particular package applies to kernel version
‘2.4.20-28.7’.27
- strnsl-LiS-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strnsl-LiS-core package contains the kernel modules that
provide the OpenSS7 STREAMS Network Services Library STREAMS modules and drivers. This package is
heavily tied to the STREAMS package and kernel for which it was compiled. This
particular package applies to LiS (Linux STREAMS) on kernel
version ‘2.4.20-28.7’.28
- strnsl-streams-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strnsl-streams-core package contains the kernel modules that
provide the OpenSS7 STREAMS Network Services Library STREAMS modules and drivers. This package is
heavily tied to the STREAMS package and kernel for which it was compiled. This
particular package applies to streams (Linux Fast-STREAMS) on
kernel version ‘2.4.20-28.7’.29
- strnsl-LiS-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strnsl-LiS-info package30 contains the module symbol version
information for the LiS-core subpackage, above. It is possible to load
this subpackage and compile modules that use the exported symbols without loaded
the actual kernel modules (from the LiS-core subpackage above). This
package is heavily tied to the STREAMS package and kernel for which it was
compiled. This particular package applies to LiS (Linux STREAMS)
on kernel version ‘2.4.20-28.7’.31
- strnsl-streams-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strnsl-streams-info package32 contains the module symbol version
information for the streams-core subpackage, above. It is possible to
load this subpackage and compile modules that use the exported symbols without
loaded the actual kernel modules (from the streams-core subpackage
above). This package is heavily tied to the STREAMS package and kernel for
which it was compiled. This particular package applies to streams
(Linux Fast-STREAMS) on kernel version
‘2.4.20-28.7’.33
Configuration and Installation
To configure, build and install the binary RPM, See Configuring the Binary RPM.
7.2.4 Downloading the Debian DEB
To install from binary DEB, you will need several of the DEB for a complete installation. Binary
DEB fall into several categories. To download and install a complete package requires the
appropriate DEB from each of the several categories below,
as applicable. Some release packages do not provide DEBs in each of the several categories.
To install from Binary DEB, you will need all of the following kernel
independent packages for your architecture,
and one of the kernel-dependent packages from the next section.
Independent DEB
Independent DEB are dependent on neither the Linux kernel version, nor the STREAMS package. For
example, the source package
‘strnsl-source_0.9.2.4-0_i386.deb’, is not
dependent on kernel nor STREAMS package.
All of the following kernel and STREAMS
independent DEB are required for your architecture.
Binary DEBs listed here are for example only: additional binary DEBs are available from the
downloads site. If your architecture is not available, you can build binary DEB from the Debian DSC
(see see Building from the Debian DSC).
Architecture Independent
- strnsl-dev_0.9.2.4-0_all.deb
- The strnsl-dev package contains the device definitions necessary to run
applications programs developed for OpenSS7 STREAMS Network Services Library. 34
- strnsl-doc_0.9.2.4-0_all.deb
- The strnsl-doc package contains this manual in plain text, postscript, pdf and html
forms, along with the meta-information from the strnsl package. It also
contains all of the manual pages necessary for developing OpenSS7 STREAMS Network Services Library applications and
OpenSS7 STREAMS Network Services Library STREAMS modules or drivers.
- strnsl-init_0.9.2.4-0_all.deb
- The strnsl-init package contains the init scripts and provides the postinst
scripts necessary to create kernel module preloads and modules definitions for all kernel module
‘core’ subpackages.
- strnsl-source_0.9.2.4-0_all.deb
- The strnsl-source package contains the source code necessary for
building the OpenSS7 STREAMS Network Services Library release. It includes the autoconf(1)
configuration utilities necessary to create and distribute tarballs, rpms and
deb/dscs.
35
Architecture Dependent
- strnsl-devel_0.9.2.4-0_i386.deb
- The strnsl-devel package contains library archives for static
compilation, header files to develop OpenSS7 STREAMS Network Services Library modules and drivers.
This also includes the header files and static libraries required to compile
OpenSS7 STREAMS Network Services Library applications programs.
- strnsl-lib_0.9.2.4-0_i386.deb
- The strnsl-lib package contains the run-time shared libraries
necessary to run application programs and utilities developed for the
strnsl package.
36
STREAMS-Dependent DEB
STREAMS-Dependent DEB are dependent upon the specific STREAMS package being
used, either Linux STREAMS or Linux Fast-STREAMS. Packages
dependent upon Linux STREAMS will have LiS in the package name.
Packages dependent upon Linux Fast-STREAMS will have streams in
the package name. Note that some STREAMS-Dependent DEB are also
Kernel-Dependent DEB as described below.
One of the following STREAMS-Dependent packages is required for your
architecture. If your architecture is not on the list, you can build binary DEB
from the Debian DSC (see see Building from the Debian DSC).
- strnsl-LiS-util_0.9.2.4-0_i386.deb
- The strnsl-LiS-util package provides administrative and
configuration test utilities and commands associated with the
OpenSS7 STREAMS Network Services Library package. Because this package must link a
STREAMS-specific library, it is a STREAMS-Dependent package. Use the
strnsl-LiS-util package if you have LiS installed.
- strnsl-streams-util_0.9.2.4-0_i386.deb
- The strnsl-streams-util package provides administrative and
configuration test utilities and commands associated with the
OpenSS7 STREAMS Network Services Library package. Because this package must link a
STREAMS-specific library, it is a STREAMS-Dependent package. Use the
strnsl-streams-util package if you have streams installed.
Kernel-Dependent DEB
Kernel-Dependent DEB are dependent on specific Linux Kernel Binary DEB releases.
Packages are provided for popular released Debian kernels. Packages
dependent upon Debian or other kernel DEB will have the ‘_kversion’
kernel package version in the package name.
One of the following Kernel-Dependent packages is required for your architecture
and kernel version. If your architecture or kernel version is not on the list,
you can build binary DEB from the source DEB (see see Building from the Debian DSC).37
- strnsl-core-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strnsl-core package contains the loadable kernel modules
that depend only on the kernel. This package is heavily tied to the kernel for
which it was compiled. This particular package applies to kernel version
‘2.4.20-28.7’.38
- strnsl-info-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strnsl-info package39 contains the
module symbol version information for the core subpackage, above. It is
possible to load this subpackage and compile modules that use the exported
symbols without loading the actual kernel modules (from the core
subpackage above). This package is heavily tied to the kernel for which it was
compiled. This particular package applies to kernel version
‘2.4.20-28.7’.40
- strnsl-LiS-core-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strnsl-LiS-core package contains the kernel modules that
provide the OpenSS7 STREAMS Network Services Library STREAMS modules and drivers. This package is
heavily tied to the STREAMS package and kernel for which it was compiled. This
particular package applies to LiS (Linux STREAMS) on kernel
version ‘2.4.20-28.7’.41
- strnsl-streams-core-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strnsl-streams-core package contains the kernel modules that
provide the OpenSS7 STREAMS Network Services Library STREAMS modules and drivers. This package is
heavily tied to the STREAMS package and kernel for which it was compiled. This
particular package applies to streams (Linux Fast-STREAMS) on
kernel version ‘2.4.20-28.7’.42
- strnsl-LiS-info-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strnsl-LiS-info package43 contains the module symbol version
information for the LiS-core subpackage, above. It is possible to load
this subpackage and compile modules that use the exported symbols without loaded
the actual kernel modules (from the LiS-core subpackage above). This
package is heavily tied to the STREAMS package and kernel for which it was
compiled. This particular package applies to LiS (Linux STREAMS)
on kernel version ‘2.4.20-28.7’.44
- strnsl-streams-info-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strnsl-streams-info package45 contains the module symbol version
information for the streams-core subpackage, above. It is possible to
load this subpackage and compile modules that use the exported symbols without
loaded the actual kernel modules (from the streams-core subpackage
above). This package is heavily tied to the STREAMS package and kernel for
which it was compiled. This particular package applies to streams
(Linux Fast-STREAMS) on kernel version
‘2.4.20-28.7’.46
Configuration and Installation
To configure, build and install the Debian DEB, See Configuring the Debian DEB.
7.2.5 Downloading the Source RPM
If you cannot obtain a binary RPM for your architecture, or would like to roll you own binary RPM,
download the following source RPM.
- strnsl-0.9.2.4-1.src.rpm
- This is the source RPM for the package. From this source RPM it is possible to build binary RPM for
any supported architecture and for any 2.4 or 2.6 kernel,
for either Linux STREAMS or Linux Fast-STREAMS.
Configuration
To configure the source RPM, See Configuring the Source RPM.
7.2.6 Downloading the Debian DSC
If you cannot obtain a binary DEB for your architecture, or would like to roll your own DEB,
download the following Debian DSC.
- strnsl_0.9.2.4-0.dsc
- strnsl_0.9.2.4-0.tar.gz
- This is the Debian DSC for the package. From this Debian DSC it is possible to build binary DEB for
any supported architecture and for any 2.4 or 2.6 kernel,
for either Linux STREAMS or Linux Fast-STREAMS.
Configuration
To configure the source RPM, See Configuring the Debian DSC.
7.2.7 Downloading the Tar Ball
For non-rpm(1) and non-dpkg(1) architectures,
download the tarball as follows:
- strnsl-0.9.2.4.tar.gz
- strnsl-0.9.2.4.tar.bz2
- These are the tar(1) balls for the release. These tar(1) balls contain the
autoconf(1) distribution which includes all the source necessary for building and
installing the package. These tarballs will even build Source RPM and Binary RPM on
rpm(1) architectures and Debian DSC and DEB on dpkg(1) architectures.
The tar ball may be downloaded easily with wget(1) as follows:
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.bz2
|
or
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.gz
|
Note that you will need an OpenSS7 Project user name and password to download release
candidates (which are only available to subscribers and sponsors of the OpenSS7 Project).
Unpacking the Archive
After downloading one of the tar balls, unpack the archive using one of the
following commands:
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.gz
% tar -xzvf strnsl-0.9.2.4.tar.gz
|
or
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.bz2
% tar -xjvf strnsl-0.9.2.4.tar.bz2
|
Either will create a subdirectory name
strnsl-0.9.2.4
containing all of the files and subdirectories for the
strnsl package.
Configuration
To configure and install the tar ball, See Configuring the Tar Ball.
7.2.8 Downloading from CVS
If you are a subscriber or sponsor of The OpenSS7 Project with CVS
archive access privileges then you can download release, mid-release or release candidate versions
of the strnsl package from the project CVS archive.
The OpenSS7 STREAMS Network Services Library package is located in the strnsl module of
/var/cvs. For release tag information, see Releases.
To access the archive from the project CVS pserver, use the following commands to check out a
version from the archive:
% export CVSROOT='-d:pserver:username@cvs.openss7.com:2401/var/cvs'
% cvs login
Password: *********
% cvs co -r strnsl_0.9.2.4 strnsl
% cvs logout
|
It is, of course, possible to check out by date or by other criteria. For more information, see
cvs(1)
.
Preparing the CVS Working Directory
Although public releases of the strnsl package do not require reconfiguration,
creating a configurable directory from the CVS archive requires tools not normally distributed with
the other releases.
The build host requires the following GNU tools:
- m4 1.4.12
- autoconf 2.63
- automake 1.10.1
- libtool 2.2.4
- gettext 0.17
- flex 2.5.33
- bison 2.3
Most desktop development GNU/Linux distributions wil have these tools; however, some non-development
or server-style installations might not and they must be installed separately.47
Also, these tools can be acquired from the FSF website in the free
software directory, and also at the following locations:
It should be stressed that, in particular, the autoconf(1), and automake(1),
must be at version releases 2.63 and 1.10.1. The versions normally
distributed in some mainstream GNU/Linux distributions are, in fact, much older than these
versions.48 GNU version of these packages configured and
installed to default directories will install in /usr/local/ allowing them to coexist with
distribution installed versions.
For building documentation, the build host also requires the following documentation tools:
- gs 6.51 or ghostscript 6.51, or newer.
- tetex 3.0 or texlive 2007, or newer.
- texinfo 4.13a or newer.
- transfig 3.2.3d or newer.
- imagemagick 5.3.8 or ImageMagick 5.3.8, or newer.
- groff 1.17.2 or newer.
- gnuplot 3.7 or newer.
- latex2html 1.62 or newer.
Most desktop GNU/Linux distributions will have these tools; however, some server-style installations
(e.g. Ubuntu-server, SLES 9 or Fedora 6 or 7) will not and they must be
installed separately.49
Note that texinfo 4.12 must not be used as it breaks the build process.
For uncooked manual pages, the entire groff(1) package is required on older Debian and
Ubuntu systems (the base package did not include grefer(1) which is used extensively by
uncooked manual pages). The following will get what you need on older systems:
Debian: % apt-get install groff_ext
Ubuntu: % apt-get install groff
|
On newer systems, simply:
In addition, the build host requires a complete tool chain for compiling for the target host,
including kernel tools such as genksyms(8)
and others.
If you wish to package rpms on an rpm(1) system, or debs on a
dpkg(1) system, you will need the appropriate tool chain. Systems based on
rpm(1)
typically have the necessary tool chain available, however, dpkg(1) systems do not. The
following on a Debian or Ubuntu system will get what you need:
% apt-get install debhelper
% apt-get install fakeroot
|
To generate a configuration script and the necessary scriptlets required by the GNU
autoconf(1) system, execute the following commands on the working directory:
where, strnsl is the name of the directory to where the working copy was
checked out under the previous step. This command generates the configure script and
other missing pieces that are normally distributed with the release Tar Balls, SRPMs and DSCs.
Make sure that ‘autoreconf --version’ returns ‘2.63’. Otherwise, you may need to perform
something like the following:
% PATH="/usr/local/bin:$PATH"
% autoreconf -fiv strnsl
|
After reconfiguring the directory, the package can then be configured and built using the same
instructions as are used for the Tar Ball, see Configuring the Tar Ball, and Building from the Tar Ball.
Do note, however, that make(1) will rebuild the documentation that is normally released
with the package. Additional tools may be necessary for building the documentation. To avoid
building and installing the documentation, use the --disable-devel or
--disable-docs option to configure described in Configuring the Tar Ball.
When configuring the package in a working directory and while working a change-compile-test cycle
that involves configuration macros or documentation, I find it of great advantage to invoke the GNU
configure options --enable-maintainer-mode, --enable-dependency-tracking
and --disable-devel. The first of these three options will add maintainer-specific targets
to any generated Makefile, the second option will invoke automatic dependency tracking within
the Makefile so rebuilds after changes to macro, source or documentation files will be
automatically rebuilt; and the last option will suppress rebuilding and reinstalling documentation
manual pages and header files. Header files will still be available under the /usr/src
directory.
7.3 Configuration
7.3.1 Configuring the Binary RPM
In general the binary RPM do not require any configuration, however, during installation it is
possible to relocate some of the installation directories. This allows some degree of
customization. Relocations that are available on the binary RPM are as follows:
- strnsl-LiS-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- strnsl-streams-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
-
- /lib/modules/2.4.20-28.7
- This relocatable directory contains the kernel modules that provide the
strnsl STREAMS core, drivers and modules.50
- strnsl-LiS-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- strnsl-streams-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
-
- /usr/include/strnsl/2.4.20-28.7
- This relocatable directory contains the kernel module exported symbol
information that allows other kernel modules to be compiled against the correct
version of the strnsl package.51
- strnsl-dev-0.9.2.4-1.7.2.i686.rpm
- (not relocatable)
- strnsl-devel-0.9.2.4-1.7.2.i686.rpm
-
- /usr/lib
- This relocatable directory contains strnsl libraries.
- /usr/include/strnsl
- This relocatable directory contains strnsl header files.
- strnsl-doc-0.9.2.4-1.7.2.i686.rpm
-
- /usr/share/doc
- This relocatable directory contains all package specific documentation
(including this manual). The subdirectory in this directory is the
strnsl-0.9.2.4 directory.
- /usr/share/info
- This relocatable directory contains info files (including the info version of
this manual).
- /usr/share/man
- This relocatable directory contains manual pages.
- strnsl-LiS-lib-0.9.2.4-1.7.2.i686.rpm
- strnsl-streams-lib-0.9.2.4-1.7.2.i686.rpm
-
- /usr/lib
- This relocatable directory contains the run-time shared libraries necessary to
run applications programs and utilities developed for OpenSS7 STREAMS Network Services Library.
- /usr/share/locale
- This relocatable directory contains the locale information for shared library
files.
- strnsl-source-0.9.2.4-1.7.2.i686.rpm
-
- /usr/src
- This relocatable directory contains the source code.
- strnsl-LiS-util-0.9.2.4-1.7.2.i686.rpm
- strnsl-streams-util-0.9.2.4-1.7.2.i686.rpm
-
- /usr/bin
- This relocatable directory contains binary programs and utilities.
- /usr/sbin
- This relocatable directory contains system binary programs and utilities.
- /usr/libexec
- This relocatable directory contains test programs.
- /etc
- This relocatable directory contains init scripts and configuration information.
Installation
To install the binary RPM, See Installing the Binary RPM.
7.3.2 Configuring the Debian DEB
In general the binary DEB do not require any configuration.
Installation
To install the Debian DEB, See Installing the Debian DEB.
7.3.3 Configuring the Source RPM
When building from the source RPM (see Building from the Source RPM), the rebuild process uses a
number of macros from the user's .rpmmacros file as described in rpm(8)
.
Following is an example of the ~/.rpmmacros file that I use for rebuilding RPMS:
#
# RPM macros for building rpms
#
%vendor OpenSS7 Corporation
%distribution OpenSS7
%disturl http://www.openss7.org/
%packager Brian Bidulock <bidulock@openss7.org>
%url http://www.openss7.org/
%_signature gpg
%_gpg_path /home/brian/.gnupg
%_gpg_name openss7@openss7.org
%_gpgbin /usr/bin/gpg
%_source_payload w9.bzdio
%_binary_payload w9.bzdio
%_unpackaged_files_terminate_build 1
%_missing_doc_files_terminate_build 1
%_use_internal_dependency_generator 0
%_repackage_all_erasures 0
%_rollback_transaction_on_failure 0
%configure2_5x %configure
%make make
|
When building from the source RPM (see Building from the Source RPM), it is possible to pass a
number of additional configuration options to the rpmbuild(1) process.
The additional configuration options are described below.
Note that distributions that use older versions of rpm do not have the --with or
--without options defined. To achieve the same effect as:
--with someparm=somearg
do:
--define "_with_someparm --with-someparm=somearg"
This is a generic description of common rpmbuild(1) options. Not all rpmbuild(1)
options are applicable to all SRPMs.
Options that are kernel module specific are only applicable to SRPMs that
build kernel modules.
STREAMS options are only applicable to SRPMs that provide or require
STREAMS.
--define "_kversion $PACKAGE_KVERSION"
- Specifies the kernel version other than the running kernel for which to build. If
_kversion is not defined when rebuilding, the environment variable PACKAGE_KVERSION
is used. If the environment variable PACKAGE_KVERSION is not defined, then the version of the
running kernel (i.e. discovered with ‘uname -r’) is used as the target version for
kernel-dependent packages. This option can also be defined in an .rpmspec file using the
macro name ‘_kversion’.
--with checks
--without checks
- Enable or disable preinstall checks. Each packages supports a number of preinstall checks that can
be performed by invoking the ‘check’ target with automake(1). These currently consist of
checking each kernel module for unresolved kernel symbols, checking for documentation for exported
kernel module symbols, checking for documentation for exported library symbols, checking for
standard options for build and installable programs, checking for documentation for built and
installable programs. Normally these checks are only run in maintainer mode, but can be enabled and
disabled with this option.
--with k-optimize=HOW
--without k-optimize
- Specify ‘HOW’ optimization, normal, size, speed or quick. size
compiles kernel modules
-Os
, speed compiles kernel modules -O3
, and quick
compiles kernel modules -O0
. The default is normal. Use with care.
--with cooked-manpages
--without cooked-manpages
- Some systems do not like grefer(1) references in manual pages.52 This option will cook
soelim(1), refer(1), tbl(1) and pic(1) commands from the manual pages and
also strip groff(1) comments. The default is to leave manual pages uncooked: they are actually
smaller that way.
--with public
--without public
- Release public packages or private packages. This option has no effect on the
strnsl package. The default is to release public packages.
--with k-debug
--without k-debug
- Specifies whether kernel debugging is to be performed on the build kernel modules. Mutually
exclusive with
test
and safe
below. This has the effect of removing static and inline
attributes from functions and invoking all debugging macros in the code. The default is to not
perform kernel debugging.
--with k-test
--without k-test
- Specifies whether kernel testing is to be performed. Mutually exclusive with
debug
above and
safe
below. This has the effect of removing static and inline attributes from functions and
invoking most debugging macros in the code. The default is to not perform kernel testing.
--with k-safe
--without k-safe
- Specifies whether kernel saftey is to be performed. Mutually exclusive with
debug
and
test
above. This has the effect of invoking some more pedantic assertion macros in the code.
The default is not to apply kernel safety.
--with k-inline
--without k-inline
- Specifies whether kernel
inline
functions are to be placed inline. This has the effect of
adding the -finline-functions flag to CFLAGS for compiling kernel modules. Linux 2.4
kernels are normally compiled -O2 which does not respect the inline
directive. This
compiles kernel modules with -finline-functions to get closer to -O3 optimization.
For better optimization controls, See Configuring the Tar Ball.
--with k-modversions
--without k-modversions
- Specifies whether kernel symbol versions are to be applied to symbols exported by package kernel
modules. The default is to version exported module symbols. This package does not export symbols
so this option has no effect.
--with devfs
--without devfs
- Specifies whether the build is for a device file system daemon enabled system with autoloading, or
not. The default is to build for devfsd(1) autoloading when CONFIG_DEVFS_FS is defined in the
target kernel. The ‘rebuild’ target uses this option to signal to the RPM spec file that the
‘dev’ subpackage need not be built. This option does not appear when the package has no
devices.
--with devel
--without devel
- Specifies whether to build development environment packages such as those that include header files,
static libraries, manual pages and texinfo(1) documentation. The default is to build development
environment packages. This option can be useful when building for an embedded target where only the
runtime components are desired.
--with docs
--without docs
- Specifies whether to build and install major documentation such manual pages and
texinfo(1) documentation. The default is to build and install documentation. This option
can be useful when building for an embedded target where only the runtime and static compile
components are desired, but not major documentation. This option does not override the setting of
--without devel
.
--with tools
--without tools
- Specifies whether user space packages are to be built. The default is to build user space packages.
This option can be useful when rebuilding for multiple architectures and target kernels. The
‘rebuild’ automake(1) target uses this feature when rebuilding for all available architectures
and kernels, to rebuild user packages once per architecture instead of once per kernel.
--with modules
--without modules
- Specifies whether kernel modules packages are to be built. The default is to build kernel module
packages. This option can be useful when rebuilding for multiple architectures and target kernels.
The ‘rebuild’ automake(1) target uses this feature to rebuild for all available architectures
and kernels.
--with lis
--without lis
- Specifies that the package is to be rebuilt against Linux STREAMS. The default is to
automatically identify whether LiS or streams is loaded on the build system and build
accordingly.
--with lfs
--without lfs
- Specifies that the package is to be rebuilt against Linux Fast-STREAMS. The default is to
automatically identify whether LiS or streams is loaded on the build system and build
accordingly.
In general, the default values of these options are sufficient for most purposes and no options need
be provided when rebuilding the Source RPMs.
Build
To build from the source RPM, See Building from the Source RPM.
7.3.4 Configuring the Debian DSC
The Debian DSC can be configured by passing options in the environment variable
BUILD_DEBOPTIONS. The options placed in this variable take the same form as those passed to
the configure script, See Configuring the Tar Ball. For an example, See Building from the Debian DSC.
Build
To build from the Debian DSC, See Building from the Debian DSC.
7.3.5 Configuring the Tar Ball
All of the normal GNU autoconf(1) configuration options and environment variables apply.
Additional options and environment variables are provided to tailor or customize the build and are
described below.
7.3.5.1 Configure Options
This is a generic description of common configure options that are in addition to those
provided by autoconf(1), automake(1), libtool(1) and gettext(1).
Not all configure options are applicable to all release packages.
Options that are kernel module specific are only applicable to release
packages that build kernel modules.
STREAMS options are only applicable to release packages that
provide or require STREAMS.
Following are the additional configure options, their meaning and use:
- --enable-checks
- --disable-checks
- Enable or disable preinstall checks. Each release package supports a number of preinstall
checks that can be performed by invoking the ‘check’ target with make(1). These
currently consist of checking each kernel module for unresolved kernel symbols, checking for
documentation for exported kernel module symbols, checking for documentation for exported library
symbols, checking for standard options for build and installable programs, checking for
documentation for built and installable programs. Normally these checks are only run in maintainer
mode, but can be enabled and disabled with this option.
- --enable-autotest
- --disable-autotest
- Enable or disable pre- and post-installation testing. Each release package supports a
number of autotest test suites that can be performed by invoking the ‘installcheck’
target with make(1). These currently consist of running installed modules, commands and
binaries against a number of specific test cases. Normally these checks are only run in maintainer
mode, but can be enabled and disabled with this option.
- --disable-compress-manpages
- Compress manual pages with ‘gzip -9’ or ‘bzip2 -9’ or leave them uncompressed. The default is
to compress manual pages with ‘gzip -9’ or ‘bzip2 -9’ if a single compressed manual page exists in
the target installation directory (--mandir). This disables automatic compression.
- --disable-public
- Disable public release. This option is not usable on public releases and only has a usable effect
on OpenSS7 STREAMS Network Services Library when the package is acquired from CVS. In particular, the STREAMS
SS7/VoIP/ISDN/SIGTRAN Stacks (strss7-0.9a.8) release package has a large
number of non-public components. Specifying this option will cause the package to build and install
all private release components in addition to the public release components. This option affects
all release packages. Most release packages do not have private release components.
- --disable-initscripts
- Disables the installation of init scripts.
The default is to configure and install init scripts and their associated
configuration files.
Although the default is to install init scripts, installation attempts to detect a System V init
script configuration, and if one is not found, the init scripts are installed into the appropriate
directories, but the symbolic links to the run level script directories are not generated and the
script is not invoked. Therefore, it is safe to leave this option unchanged, even on distributions
that do not support System V init script layout.
- --disable-32bit-libs
- Disables the build and install of 32-bit compatibility libraries and test binaries on 64-bit systems
that support 32-bit compatibility. The default is to build and install 32-bit compatibility
libraries and test binaries. This option can be usefule when configuring for an embedded target
where only native shared libraries and binaries are desired.
- --disable-devel
- Disables the installation of development environment components such as header files, static
libraries, manual pages and texinfo(1) documentation. The default is to install development
environment components. This option can be useful when configuring for an embedded target where
only the runtime components are desired, or when performing a edit-compile-test cycle.
- --disable-docs
- Disables the build and installation of major documentation such manual pages and
texinfo(1) documentation. The default is to build and install documentation. This option
can be useful when building for an embedded target where only the runtime and static compile
components are desired, but not major documentation. This option does not override the setting of
--disable-devel.
- --enable-tools
- Specifies whether user space programs and libraries are to be built and installed. The default is
to build and install user space programs and libraries. This option can be useful when rebuilding
for multiple architectures and target kernels, particularly under rpm(1) or
dpkg(1). The ‘rebuild’ automake(1) target uses this feature when rebuilding
RPMs for all available architectures and kernels, to rebuild user packages once per architecture
instead of once per kernel.
- --enable-modules
- Specifies whether kernel modules are to be built and installed. The default is to build and install
kernel modules. This option can be useful when rebuilding for multiple architectures and target
kernels, particularly under rpm(1) or dpkg(1). The ‘rebuild’
automake(1) target uses this feature to rebuild for all available architectures and
kernels.
This option has no effect for release packages that do not provide kernel modules.
- --enable-arch
- Specifies whether architectural dependent package components are to be built and installed. This
option can be useful when rebuilding for multiple architectures and target kernels, particularly
under dpkg(1). The default is to configure, build and install architecture dependent
package components.
This option has no effect for release packages that do not provide architecture dependent
components.
- --enable-indep
- Specifies whether architecture independent package components are to be built and installed. This
option can be useful when rebuilding for multiple architectures and target kernels, particularly
under dpkg(1). The default is to configure, build and install architecture independent
package components.
This options has no effect for release packages that do not provide architecture independent
components.
- --enable-k-inline
- Enable kernel inline functions. Most Linux kernels build without -finline-functions. This
option adds the -finline-functions and -Winline flags to the compilation of kernel
modules. Use with care.
This option has no effect for release packages that do not provide kernel modules.
- --enable-k-safe
- Enable kernel module run-time safety checks. Specifies whether kernel safety is to be performed.
This option is mutually exclusive with --enable-k-test and --enable-k-debug below.
This has the effect of invoking some more pedantic assertion macros in the code. The default is not
to apply kernel safety.
This option has no effect for release packages that have are no kernel modules.
- --enable-k-test
- Enable kernel module run-time testing. Specifies whether kernel testing is to be performed. This
option is mutually exclusive with --enable-k-safe above and --enable-k-debug
below. This has the effect of remove
static
and inline
attributes from functions and
invoking most non-performance affecting debugging macros in the code. The default is not to perform
kernel testing.
This option has no effect for release packages that do not provide kernel modules.
- --enable-k-debug
- Enable kernel module run-time debugging. Specifies whether kernel debugging is to be performed.
This option is mutually exclusive with --enable-k-safe and --enable-k-test above.
This has the effect of removing
static
and inline
attributes from functions and
invoking all debugging macros in the code (including performance-affecting debug macros). The
default is to not perform kernel debugging.
This option has no effect for release packages that do not provide kernel modules.
- --disable-k-modversions
- Disable module versions on strnsl symbols. Specifies whether kernel symbol
versions are to be used on symbols exported from built strnsl modules. The
default is to provide kernel symbol versions on all exported symbols.
This option has no effect for release packages that do not provide kernel modules.
- --enable-devfs
- --disable-devfs
- Specifies whether the build is for a device file system daemon enabled system with autoloading, or
not. The default is to build for devfsd(8) autoloading when CONFIG_DEVFS_FS is
defined in the target kernel. The ‘reuild’ automake(1) target uses this option to
signal to the RPM spec file that the ‘dev’ subpackage need not be built. This option has no
effect for release packages that do not provide devices.
- --with-gpg-user=GNUPGUSER
- Specify the
gpg(1)
‘GNUPGUSER’ for signing RPMs and tarballs. The default is the
content of the environment variable GNUPGUSER. If unspecified, the gpg(1) program
will normally use the user name of the account invoking the gpg(1) program. For building
source RPMs, the RPM macro ‘_gpg_name’ will override this setting.
- --with-gpg-home=GNUPGHOME
- Specify the ‘GNUPGHOME’ directory for signing RPMs and tarballs. The default is the user's
~/.gpg directory. For building source RPMs, the RPM macro ‘_gpg_path’ will override
this setting.
- --with-pkg-epoch=EPOCH
- Specifies the epoch for the package. This is neither used for rpm(1) nor
dpkg(1) packages, it applies to the tarball release as a whole. The default is the
contents of the .pkgepoch file in the release package source directory or, if that
file does not exist, zero (0).
- --with-pkg-release=RELEASE
- Specifies the release for the package. This is neither used for rpm(1) nor
dpkg(1) packages, it applies to the tarball release as a whole. The default is the
contents of the .pkgrelease file in the release package source directory or, if that
file does not exist, one (1). This is the number after the last point in the package version
number.
- --with-pkg-distdir=DIR
- Specifies the distribution directory for the package. This is used by the maintainer for building
distributions of tarballs. This is the directory into which archives are copied for distribution.
The default is the top build directory.
- --with-cooked-manpages
- Convert manual pages to remove macro dependencies and grefer(1) references. Some systems
do not like grefer(1) references in manual pages.53 This
option will cook soelim(1), refer(1), tbl(1) and pic(1)
commands from the manual pages and also strip groff(1) comments. The default is to leave
manual pages uncooked (they are actually smaller that way).
- --with-rpm-epoch=PACKAGE_EPOCH
- Specify the ‘PACKAGE_EPOCH’ for the RPM spec file. The default is to use the RPM epoch
contained in the release package file .rpmepoch.
- --with-rpm-release=PACKAGE_RPMRELEASE
- Specify the ‘PACKAGE_RPMRELEASE’ for the RPM spec file. The default is to use the RPM release
contained in the release package file .rpmrelease.
- --with-rpm-extra=PACKAGE_RPMEXTRA
- Specify the ‘PACKAGE_RPMEXTRA’ extra release information for the RPM spec file. The default is
to use the RPM extra release information contained in the release package file
.rpmextra. Otherwise, this value will be determined from automatic detection of the RPM
distribution.
- --with-rpm-topdir=PACKAGE_RPMTOPDIR
- Specify the ‘PACKAGE_RPMTOPDIR’ top directory for RPMs. If specified with a null
‘PACKAGE_RPMTOPDIR’, the default directory for the RPM distribution will be used. If this
option is not provided on the command line, the top build directory will be used as the RPM top
directory as well.
- --with-deb-epoch=EPOCH
- Specify the ‘PACKAGE_DEBEPOCH’ for the DEB control file. The default is to use the DEB epoch
contained in the release package file .debepoch.
- --with-deb-release=RELEASE
- Specify the ‘PACKAGE_DEBRELEASE’ for the DEB control file. The default is to use the DEB
release contained in the release package file .debrelease.
- --with-deb-topdir=DIR
- Specify the ‘PACKAGE_DEBTOPDIR’ top directory for DEBs. If specified with a null
‘PACKAGE_DEBTOPDIR’, the default directory for the DEB distribution will be used. If this
option is not provided on the command line, the top build directory will be used as the DEB top
directory as well.
- --with-k-release=PACKAGE_KRELEASE
- Specify the ‘PACKAGE_KRELEASE’ release of the Linux kernel for which the build is targeted.
When not cross compiling, if this option is not set, the build will be targeted at the kernel
running in the build environment (e.g., ‘uname -r’). When cross-compiling this option must be
specified or the configure script will generate an error and terminate.
- --with-k-linkage=PACKAGE_KLINKAGE
- Specify the ‘PACKAGE_KLINKAGE’ for kernel module linkage. This can be one of the following:
- ‘loadable’ – loadable kernel modules
- ‘linkable’ – linkable kernel objects
The default is to build loadable kernel modules.
- --with-k-modules=K-MODULES-DIR
- Specify the ‘K-MODULES-DIR’ directory to which kernel modules will be installed. The default
is based on the option --with-k-release, --with-k-prefix and
--with-k-rootdir. The default is DESTDIR/K-MODULES-DIR which is
typically DESTDIR/lib/modules/PACKAGE_KRELEASE/. This directory is
normally located by the configure script and need only be provided for special cross-build
environments or when requested by a configure script error message.
- --with-k-build=K-BUILD-DIR
- Specify the ‘K-BUILD-DIR’ base kernel build directory in which configured kernel source
resides. The default is DESTDIR/K-MODULES-DIR/build. This directory is
normally located by the configure script and need only be provided for special cross-build
environments or when requested by a configure script error message.
- --with-k-source=K-SOURCE-DIR
- Specify the ‘K-SOURCE-DIR’ base kernel build directory in which configured kernel source
resides. The default is DESTDIR/K-MODULES-DIR/source. This directory is
normally located by the configure script and need only be provided for special cross-build
environments or when requested by a configure script error message.
- --with-k-modver=K-MODVER-FILE
- Specify the ‘K-MODVER-FILE’ kernel module versions file. The default is
K-BUILD-DIR/Module.symvers. This file is normally located by the
configure script and need only be provided for special cross-build environments or when
requested by a configure script error message.
- --with-k-sysmap=K-SYSMAP-FILE
- Specify the ‘K-SYSMAP-FILE’ kernel system map file. The default is
K-BUILD-DIR/System.map. This file is normally located by the configure
script and need only be provided for special cross-build environments or when requested by a
configure script error message.
- --with-k-archdir=K-ARCHDIR
- Specify the ‘K-ARCHDIR’ kernel source architecture specific directory. The default is
DESTDIR/K-SOURCE-DIR/arch. This directory is normally located by the
configure script and need only be provided for special cross-build environments or when
requested by a configure script error message.
- --with-k-machdir=K-MACHDIR
- Specify the ‘K-MACHDIR’ kernel source machine specific directory. The default is
DESTDIR/K-SOURCE-DIR/target_cpu. This directory is normally
located by the configure script and need only be provided for special cross-build
environments or when requested by a configure script error message.
- --with-k-config=K-CONFIG
- Specify the ‘K-CONFIG’ kernel configuration file. The default is
BOOT/config-K-RELEASE. This configuration file is normally located by the
configure script and need only be provided for special cross-build environments or when
requested by a configure script error message.
- --with-k-optimize=HOW
- --without-k-optimize
- Specify ‘HOW’ optimization, normal, size, speed or quick. size
compiles kernel modules
-Os
, speed compiles kernel modules -O3
, and quick
compiles kernel modules -O0
. The default is normal. Use with care. The most common
use of this option is to specify --with-k-optimize=speed --disable-k-safe to compile for
maximum performance. Nevertheless, even these setting are ricing and the resulting kernel
modules will only be about 5% faster.
- --with-lis[=LIS-DIR]
- --without-lis
- Specify the ‘LIS-DIR’ directory in which to find LiS headers. Also specifies that the build is
to be made against Linux STREAMS. The default is /usr/include/LiS if it exists,
‘no’ otherwise. This directory is normally located by the configure script and need
only be provided for special cross-build environments or when requested by a configure
script error message. This option has no effect on release packages that do not use the
STREAMS subsystem.
- --with-lfs[=LFS-DIR]
- --without-lfs
- Specify the ‘LFS-DIR’ directory in which to find LfS headers. Also specifies that the build is
to be made against Linux Fast-STREAMS. The default is /usr/include/streams if it exists,
‘no’ otherwise. This directory is normally located by the configure script and need
only be provided for special cross-build environments or when requested by a configure
script error message. This option has no effect on release packages that do not use the
STREAMS subsystem.
- --with-strconf-master=STRCONF_CONFIG
- Specify the ‘STRCONF_CONFIG’ file name to which the configuration master file is written. The
default is Config.master.
This option has no effect on release packages that do not use the STREAMS subsystem
and the strconf scripts.
This option should not be specified when configuring the master package as the setting for all
add-on packages will conflict.
- --with-base-major=STRCONF_MAJBASE
- Start numbering for major devices at ‘STRCONF_MAJBASE’. The default is ‘230’.
This option has no effect on release packages that do not use the STREAMS subsystem
and the strconf scripts.
This option should not be specified when configuring the master package as the setting for all
add-on packages will conflict.
7.3.5.2 Environment Variables
Following are additional environment variables to configure, their meaning and use:
- GPG
- GPG signature command. This is used for signing distributions by the maintainer. By default,
configure will search for this tool.
- GNUPGUSER
- GPG user name. This is used for signing distributions by the maintainer.
- GNUPGHOME
- GPG home directory. This is used for signing distributions by the maintainer.
- GPGPASSWD
- GPG password for signing. This is used for signing distributions by the maintainer. This
environment variable is not maintained by the configure script and should only be used on
an isolated system.
- SOELIM
- Roff source elimination command,
soelim(1)
. This is only necessary when the option
--with-cooked-manpages has been specified and configure cannot find the proper
soelim(1) command. By default, configure will search for this tool.
- REFER
- Roff references command,
refer(1)
. This is only necessary when the option
--with-cooked-manpages has been specified and configure cannot find the proper
refer(1) command. By default, configure will search for this tool.
- TBL
- Roff table command,
tbl(1)
. This is only necessary when the option
--with-cooked-manpages has been specified and configure cannot find the proper
tbl(1) command. By default, configure will search for this tool.
- PIC
- Roff picture command,
pic(1)
. This is only necessary when the option
--with-cooked-manpages has been specified and configure cannot find the proper
pic(1) command. By default, configure will search for this tool.
- GZIP
- Default compression options provided to GZIP_CMD.
- GZIP_CMD
- Manpages (and kernel modules) compression commands,
gzip(1)
. This is only necessary when
the option --without-compressed-manpages has not been specified and
configure cannot find the proper gzip(1) command. By default,
configure will search for this tool.
- BZIP2
- Default compression options provided to BZIP2_CMD
- BZIP2_CMD
- Manpages compression commands,
bzip2(1)
. This is only necessary when the option
--without-compressed-manpages has not been specified and configure cannot
find the proper bzip2(1) command. By default, configure will search for this
tool.
- MAKEWHATIS
- Manpages apropros database rebuild command,
makewhatis(8)
. By default, configure
will search for this tool. By default, configure will search for this tool.
- CHKCONFIG
- Chkconfig command,
chkconfig(8)
. This was used for installation of init scripts. All
packages now come with init_install(8) and init_remove(8) scripts used to install and
remove init scripts on both RPM and Debian systems.
- RPM
- Rpm command,
rpm(1)
. This is only necessary for RPM builds. By default,
configure will search for this tool.
- RPMBUILD
- Build RPM command,
rpmbuild(1)
. This is only necessary for RPM builds. By default,
configure will search for this tool. rpm(1) will be used instead of
rpmbuild(1) only if rpmbuild(1) cannot be found.
- DPKG
- Dpkg comand,
dpkg(1)
. This command is used for building Debian packages. By default,
configure will search for this tool.
- DPKG_SOURCE
- Dpkg-source command,
dpkg-source(1)
. This command is used for building Debian dsc
packages. By default, configure will search for this tool.
- DPKG_BUILDPACKAGE
- Dpkg-buildpackage command,
dpkg-buildpackage(1)
. This command is used for building Debian
deb packages. By default, configure will search for this tool.
- DEB_BUILD_ARCH
- Debian build architecture.
This variable is used for building Debian packages.
The default is the autoconf build architecture.
- DEB_BUILD_GNU_CPU
- Debian build cpu.
This variable is used for building Debian packages.
The default is the autoconf build cpu.
- DEB_BUILD_GNU_SYSTEM
- Debian build os.
This variable is used for building Debian packages.
The default is the autoconf build os.
- DEB_BUILD_GNU_TYPE
- Debian build alias.
This variable is used for building Debian packages.
The default is the autoconf build alias.
- DEB_HOST_ARCH
- Debian host architecture.
This variable is used for building Debian packages.
The default is the autoconf host architecture.
- DEB_HOST_GNU_CPU
- Debian host cpu.
This variable is used for building Debian packages.
The default is the autoconf host cpu.
- DEB_HOST_GNU_SYSTEM
- Debian host os.
This variable is used for building Debian packages.
The default is the autoconf host os.
- DEB_HOST_GNU_TYPE
- Debian host alias.
This variable is used for building Debian packages.
The default is the autoconf host alias.
- LDCONFIG
- Configure loader command,
ldconfig(8)
. Command used to configure the loader when libraries
are installed. By default, configure will search for this tool.
- DESTDIR
- Cross build root directory. Specifies the root directory for build and installation.
- DEPMOD
- Build kernel module dependencies command,
depmod(8)
. This is used during installation of
kernel modules to a running kernel to rebuild the modules dependency database. By default,
configure will search for this tool.
- MODPROBE
- Probe kernel module dependencies command,
modprobe(8)
. This is used during installation of
kernel modules to a running kernel to remove old modules. By default, configure will
search for this tool.
- LSMOD
- List kernel modules command,
lsmod(8)
. This is used during installation of kernel modules
to a running kernel to detect old modules for removal. By default, configure will search
for this tool.
- LSOF
- List open files command,
lsof(1)
. This is used during installation of kernel modules to a
running kernel to detect old modules for removal. Processes owning the old kernel modules will be
killed and the module removed. If the process restarts, the new module will be demand loaded. By
default, configure will search for this tool.
- GENKSYMS
- Generate kernel symbols command,
genksyms(8)
. This is used for generating module symbol
versions during build. By default, configure will search for this tool.
- KGENKSYMS
- Linux 2.6 generate kernel symbols command,
genksyms(8)
. This is used for generating module
symbol version during build. By default, configure will search for this tool.
- OBJDUMP
- Object dumping command,
objdump(1)
. This is used for listing information about object
files. By default, configure will search for this tool.
- NM
- Object symbol listing command,
nm(1)
. This is used for listing information about object
files. By default, configure will search for this tool.
- MODPOST_CACHE
- Cache file for modpost(1). The version of the modpost.sh script that ships with each package
can cache information to a cache file to speed multiple builds. This environment variable is used
to specify a cache file.
- AUTOM4TE
- Autom4te command,
autom4te(1)
. This is the executable used by autotest for pre- and
post-installation checks. By default, configure will search for this tool.
- AUTOTEST
- Autotest macro build command, autom4te(1). This is the executable used by autotest for
pre- and post-installation checks. By default, configure will search for this tool.
7.3.5.3 Build
To build from the tar ball, See Building from the Tar Ball.
7.4 Building
7.4.1 Building from the Source RPM
If you have downloaded the necessary source RPM (see Downloading the Source RPM), then the
following instructions will rebuild the binary RPMs on your system. Once the binary RPMs are
rebuilt, you may install them as described above (see Installing the Binary RPM).
The source RPM is rebuilt to binary RPMs as follows:
% wget http://www.openss7.org/rpms/SRPMS/strnsl-0.9.2.4-1.src.rpm
% rpmbuild --rebuild -vv strnsl-0.9.2.4-1.src.rpm
|
The rebuild process can also recognize a number of options that can be used to tweak the resulting
binaries, See Configuring the Source RPM. These options are provided on the rpm(1)
command line. For example:
% rpmbuild --rebuild -vv --target athlon-redhat-linux \
--define "_kversion 2.4.20-28.7" \
--with lfs -- strnsl-0.9.2.4-1.src.rpm
|
will rebuild binary RPM
for the ‘2.4.20-28.7’ kernel
for the ‘athlon’ architecture against the Linux Fast-STREAMS STREAMS package.
54
Installation
To install the resulting binary RPM, See Installing the Binary RPM.
7.4.2 Building from the Debian DSC
If you have downloaded the necessary Debian DSC (see Downloading the Debian DSC), then the
following instructions will rebuild the binary DEBs on your system. Once the binary DEBs are
rebuilt, you may install them as described above (see Installing the Debian DEB).
The Debian DSC is rebuilt to binary DEBs as follows:
% wget http://www.openss7.org/debian/strnsl_0.9.2.4-0.dsc
% wget http://www.openss7.org/debian/strnsl_0.9.2.4-0.tar.gz
% dpkg-buildpackage -v strnsl_0.9.2.4-0.dsc
|
The rebuild process can also recognize a number of options that can be used to tweak the resulting
binaries, See Configuring the Debian DSC. These options are provided in the environment variable
BUILD_DPKGOPTIONS and have the same form as the options to configure,
See Configuring the Tar Ball. For example:
% BUILD_DEBOPTIONS='
--with-lfs
--with-k-release=2.4.20-28.7
--host=athlon-debian-linux-gnu'
dpkg-buildpackage -v \
strnsl_0.9.2.4-0.dsc
|
will rebuild binary DEB
for the ‘2.4.20-28.7’ kernel
for the ‘athlon’ architecture against the Linux Fast-STREAMS STREAMS package.
55
Installation
To install the resulting binary DEB, See Installing the Debian DEB.
7.4.3 Building from the Tar Ball
If you have downloaded the tar ball (see Downloading the Tar Ball), then the following
instructions will rebuild the package on your system. (Note that the build process does not
required root privilege.)
7.4.3.1 Native Build
Following is an example of a native build against the running kernel:
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.bz2
% tar -xjvf strnsl-0.9.2.4.tar.bz2
% pushd strnsl-0.9.2.4
% ./configure
% make
% popd
|
7.4.3.2 Cross-Build
Following is an example for a cross-build. The kernel release version must always be specified for
a cross-build.56 If you are
cross-building, specify the root for the build with environment variable DESTDIR. The
cross-compile host must also be specified if different from the build host. Either the compiler and
other tools must be in the usual places where GNU autoconf(1) can find them, or they must
be specified with declarations such as ‘CC=/usr/lib/ppc-linux/gcc’ on the
configure command line.
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.bz2
% tar -xjvf strnsl-0.9.2.4.tar.bz2
% pushd strnsl-0.9.2.4
% ./configure DESTDIR="/some/other/root" \
--with-k-release=2.4.18 --host sparc-linux
% make
% popd
|
7.5 Installing
7.5.1 Installing the Binary RPM
If you have downloaded the necessary binary RPMs (see Downloading the Binary RPM), or have
rebuilt binary RPMs using the source RPM (see Building from the Source RPM), then the following
instructions will install the RPMs on your system. For additional information on rpm(1), see
rpm(8)
.
% pushd RPMS/i686
% rpm -ihv strnsl-*-0.9.2.4-1.7.2.i686.rpm
|
You must have the correct binary RPMs downloaded or built for this to be successful.
Some of the packages are relocatable and can have final installation directories altered with the
--relocate option to rpm(1), see rpm(8)
.
For example, the following will relocate the documentation and info directories:
% pushd RPMS/i686
% rpm -ihv \
--relocate '/usr/share/doc=/usr/local/share/doc' \
--relocate '/usr/share/info=/usr/local/share/info' \
-- strnsl-doc-0.9.2.4-1.7.2.i686.rpm
|
The previous example will install the strnsl-doc package by will relocate the
documentation an info directory contents to the /usr/local version.
7.5.2 Installing the Debian DEB
If you have downloaded the necessary Debian DEBs (see Downloading the Debian DEB), or have
rebuild binary DEBs using the Debian DSC (see Building from the Debian DSC), then the following
instructions will install the DEBs on your system. For additional information see dpkg(8)
.
% pushd debian
% dpkg -iv strnsl-*_0.9.2.4-0_*.deb
|
You must have the correct .deb files downloaded or build for this to be successful.
7.5.3 Installing the Tar Ball
After the build process (see Building from the Tar Ball), installation only requires execution
of one of two automake(1) targets:
- ‘make install’
- The ‘install’ automake(1) target will install all the components of the package.
Root privilege is required to successfully invoke this target.
- ‘make install-strip’
- The ‘install-strip’ automake(1) target will install all the components of the
package, but will strip unnecessary information out of the objects and compress manual pages. Root
privilege is required to successfully invoke this target.
7.6 Removing
7.6.1 Removing the Binary RPM
To remove an installed version of the binary RPMs (whether obtained from the OpenSS7 binary RPM
releases, or whether created by the source RPM), execute the following command:
% rpm -evv `rpm -qa | grep '^strnsl-'`
|
For more information see rpm(1)
.
7.6.2 Removing the Debian DEB
To remove and installed version of the Debian DEB (whether obtained from the OpenSS7 binary DEB
releases, or whether created by the Debian DSC), execute the following command:
% dpkg -ev `dpkg -l | grep '^strnsl-'`
|
For more information see dpkg(8)
.
7.6.3 Removing the Source RPM
To remove all the installed binary RPM build from the source RPM, see Removing the Binary RPM.
Then simply remove the binary RPM package files and source RPM file. A command such as:
% find / -name 'strnsl-*.rpm' -type f -print0 | xargs --null rm -f
|
should remove all strnsl RPMs from your system.
7.6.4 Removing the Debian DSC
To remove all the installed binary DEB build from the Debian DSC, see Removing the Debian DEB.
Then simply remove the binary DEB package files and Debian DSC file. A command such as:
% find / \( -name 'strnsl-*.deb' \
-o -name 'strnsl-*.dsc' \
-o -name 'strnsl-*.tar.* \
\) -type f -print0 | xargs --null rm -f
|
should remove all strnsl DEBs, DSCs and TARs from your system.
7.6.5 Removing the Tar Ball
To remove a version installed from tar ball, change to the build directory where the package was
built and use the ‘uninstall’ automake(1) target as follows:
% cd /usr/src/strnsl
% make uninstall
% cd ..
% rm -fr strnsl-0.9.2.4
% rm -f strnsl-0.9.2.4.tar.gz
% rm -f strnsl-0.9.2.4.tar.bz2
|
If you have inadvertently removed the build directory and, therefore, no longer have a configured
directory from which to execute ‘make uninstall’, then perform all of the steps for
configuration and installation (see Installing the Tar Ball) except the final installation and
then perform the steps above.
7.7 Loading
7.7.1 Normal Module Loading
When OpenSS7 STREAMS Network Services Library installs, modules and drivers belonging to release packages are
normally configured for demand loading. The ‘install’ and ‘install-strip’
automake(1)
targets will make the necessary changes to the /etc/modules.conf file and place the
modules in an appropriate place in
/lib/modules/2.4.20-28.7/strnsl.
The ‘make install’ process should have copied the kernel module files streams-*.o to the
directory
/lib/modules/2.4.20-28.7/strnsl.
This means that to load any of these modules, you can simply execute, for example, ‘modprobe
stream-somedriver’.57
7.7.1.1 Linux Fast-STREAMS Module Loading
The strnsl demand load system supports both the old kerneld and the new
kmod mechanisms for demand loading kernel modules.
The convention for strnsl kernel loadable object files is:
- Their name start with "streams-".
- They are placed in /lib/modules/2.4.20-28.7/streams/, where ‘2.4.20-28.7’ is an example kernel version.
If your kernel has been built using the kerneld daemon, then strnsl
kernel modules will automatically load as soon as the STREAMS module is pushed or the driver
is opened. The ‘make install’ process makes the necessary changes to the
/etc/modules.conf file. After the install, you will see lines like the
following added to your /etc/modules.conf file:
prune modules.strnsl
if -f /lib/modules/`uname -r`/modules.strnsl
include /lib/modules/`uname -r`/modules.strnsl
endif
|
which will provide for demand loading of the modules if they have been built and installed for the
running kernel. The /lib/modules/`uname -r`/modules.strnsl file
looks like this:
alias char-major-245 streams-some_driver
alias char-major-246 streams-other_driver
|
Note that STREAMS modules are not listed in this file, but will be loaded by name using
kerneld if available.
Linux Fast-STREAMS has a wider range of kernel module loading mechanisms than is provided by
the deprecated LiS. For mechanisms used for kernel module loading under Linux
Fast-STREAMS, See About This Manual.
7.7.1.2 Linux STREAMS Module Loading
LiS is deprecated and this section has been deleted.
7.8 Maintenance
7.8.1 Makefile Targets
automake(1) has many targets, not all of which are obvious to the casual user. In
addition, OpenSS7 automake(1) files have additional rules added to make maintaining
and releasing a package somewhat easier. This list of targets provides some help with what targets
can be invoked, what they do, and what they hope to achieve. The available targets are as follows:
7.8.1.1 User Targets
The following are normal targets intended to be invoked by installers of the package. They are
concerned with compiling, checking the compile, installing, checking the installation, and
removing the package.
- ‘[all]’
- This is also the default target. It compiles the package and all release packages selected
by configure. This is performed after configuring the source with ‘configure’. A
Makefile stub is provided so that if the package has not had autoreconf(1) run
(such as when checked out from CVS, the package will attempt to run ‘autoreconf -fiv’.
All OpenSS7 Project packages are configured without maintainer mode and without dependency
tracking by default. This speeds compilation of the package for one-time builds. This also means
that if you are developing using the source package (edit-compile-test cycle), changes made to
source files will not cause the automatic rebuilding due to dependencies. There are two ways to
enable dependency tracking: specify --enable-maintainer-mode to configure; or,
specify --enable-dependency-tracking to configure. I use the former during my
edit-compile-test cycle.
This is a standard GNU automake(1) makefile target. This target does not require
root privilege.
- ‘check’
- All OpenSS7 Project release packages provide check scripts for the check target.
This step is performed after compiling the package and will run all of the ‘check’ programs
against the compiled binaries. Which checks are performed depends on whether
--enable-maintainer-mode was specified to configure. If in maintainer mode,
checks that assist with the release of the package will be run (such as checking that all manual
pages load properly and that they have required sections.) We recommend running the check stage
before installing, because it catches problems that might keep the installed package from
functioning properly.
Another way to enable the greater set of checks, without invoking maintainer mode, is to specify
--enable-checks to configure. For more information, see Pre-installation Checks.
This is a standard GNU automake(1) makefile target, although the functions
performed are customized for the OpenSS7 Project. This target does not require root
privilege.
- ‘install’
- ‘install-strip’
- The ‘install’ target installs the package by installing each release package. This
target also performs some actions similar to the pre- and post-install scripts used by packaging
tools such as rpm(1) or dpkg(1). The ‘install-strip’ target strips
unnecessary symbols from executables and kernel modules before installing.
This is a standard GNU automake(1) makefile target. This target requires root
privilege.
- ‘installcheck’
- All OpenSS7 Project packages provide test scripts for the ‘installcheck’ target. Test
scripts are created and run using autotest (part of the autoconf(1) package).
Which test suites are run and how extensive they are depends on whether
--enable-maintainer-mode was specified to configure. When in maintainer mode,
all test suites will be run. When not in maintainer mode, only a few post-install checks will be
performed, but the test suites themselves will be installed in
/usr/libexec/strnsl58 for later use.
This is a standard GNU automake(1) makefile target. This target might require root
privilege. Tests requiring root privilege will be skipped when run as a regular user. Tests
requiring regular account privileges will be skipped when run as root.
- ‘retest’
- To complement the ‘installcheck’ target above, all OpenSS7 Project packages provide the
‘retest’ target as a means to rerun failed conformance test suite test cases. The ‘retest’
target is provided because some test cases in the test suites have delicate timing considerations
that allow them to fail sporadically. Invoking this target will retest the failed cases until no
cases that are not expected failures remain.
This is an OpenSS7 Project specific makefile target. As with ‘installcheck’, this
target might require root privilege. Tests requiring root privilege will be skipped when run as a
regular user. Tests requiring regular account privileges will be skipped when run as root.
- ‘uninstall’
- This target will reverse the steps taken to install the package. This target also performs pre- and
post- erase scripts used by packaging tools such as rpm or dpkg. You need to have a
configured build directory from which to execute this target, however, you do not need to have
compiled any of the files in that build directory.59
The ‘uninstall’ target unfortunately removes add-on packages in the same order in which they
were installed. This is not good for the OpenSS7 Master Package, where the ‘remove’
target should be used instead.
This is a standard GNU automake(1) makefile target. This target requires root
privilege.
- ‘remove’
- This target is like ‘uninstall’ with the exception that it removes add-on packages in the
reverse order that installation was performed.60
This is an OpenSS7 Project specific makefile target. This target requires root privilege.
7.8.1.2 Maintainer Targets
The following targets are targets intended for use by maintainers of the package, or those
responsible for release and packaging of a derivative work of the package. Some of these targets
are only effective when maintainer mode has been invoked (--enable-maintainer-mode specified
to configure.)
- ‘dist’
- Creates a distribution package (tarball) in the top level build directory. OpenSS7 Project
packages distribute two archives: a ‘gzip tar’ archive and a ‘bzip tar’ archive. These
archives will have the name strnsl-0.9.2.4.tar.gz and
strnsl-0.9.2.4.tar.bz2.
This is a standard GNU automake(1) makefile target. This target does not require
root privilege.
- ‘distcheck’
- This target is intended for use when releasing the package. It creates the tar(1) archives
above and then unpacks the tarball in a source directory, configures in a separate build directory,
compiles the package, installs the package in a separate install directory, tests the install
package to ensure that some components work, and, finally, uses the unpacked source tree to build
another tarball. If you have added or removed files from the package, this is a good way to ensure
that everything is still stable for release.
This is a standard GNU automake(1) makefile target. This target does not require
root privilege.
7.8.1.3 Clean Targets
- ‘mostlyclean’
- Cleans out most of the files from the compile stage. This target is helpful if you have not enabled
dependency tracking and need to recompile with changes.
This is a standard GNU automake(1) makefile target.
This target does not require root privilege.
- ‘clean’
- Cleans all the files from the build directory generated during the ‘make [all]’ phase. It does
not, however, remove files from the directory left there from the configure run. Use the
‘distclean’ target to remove those too.
This is a standard GNU automake(1) makefile target. This target might require root
privilege if the ‘installcheck’ target or the testsuite was invoked with root
privilege (leaving files belonging to root).
- ‘distclean’
- This target cleans out the directories left behind by ‘distcheck’ and removes all the
configure and generated files from the build directory. This will effectively remove all
the files in the build directory, with the except of files that belong to you or some other process.
This is a standard GNU automake(1) makefile target. This target might require root
privilege if the ‘installcheck’ target or the testsuite was invoked with root
privilege (leaving files belonging to root).
- ‘maintainer-clean’
- This target not only removes files from the build directory, it removes generated files from the
source directory as well. Care should be taken when invoking this target, because it removes files
generated by the maintainer and distributed with the archive that might require special tools to
regenerate. These special tools might only be available to the maintainer.61
It also means that you probably need a full blown Linux system to rebuild the package. For more
information, see Downloading from CVS.
This is a standard GNU automake(1) makefile target. This target might require root
privilege if the ‘installcheck’ target or the testsuite was invoked with root
privilege (leaving files belonging to root).
- ‘check-clean’
- This target removes log files left behind by the ‘check’ target. By default, the check scripts
append to log files in the top level build directory. This target can be used to clean out those
log files before the next run.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
7.8.1.4 Manual Page Targets
The following targets are used to build, install and uninstall just the manual pages from the
distribution. These targets are good for creating a distribution of just the manual pages. When
building atop multiple packages, these targets recurse down through each package.
- ‘mans’
- Build all of the manual pages. This involves performing parameter substitution on manual pages and
optionally cooking the manual pages if --with-cooked-manpages was requested during
configuration.
- ‘install-mans’
- Installs the manual pages under DESTDIR. Specify DESTDIR to place the manual pages
wherever you see fit. If DESTDIR is not specified on the command line, the manual pages will
be installed in the normal installation directory.
- ‘uninstall-mans’
- Uninstalls the manual pages from DESTDIR. Specify DESTDIR to indicate where to remove
the manual pages from. If DESTDIR is not specified on the command line, the manual pages will
be removed from the normal installation directory.
7.8.1.5 Release Targets
The following are targets used to generate complete releases into the package distribution
directory. These are good for unattended and NFS builds, which is what I use them for. Also, when
building from atop multiple packages, these targets also recurse down through each package.
- ‘release’
- Build all of the things necessary to generate a release. On an rpm(1) system this is the
distribution archives, the source rpm, and the architecture dependent and architecture independent
binary rpms. All items are placed in the package distribution directory that can be specified with
the --with-pkg-distdir=DIR option to configure.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘forced-release’
- The ‘release’ target will not regenerate any files that already exist in the package
distribution directory. This forced target will.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘release-sign’
- You will be prompted for a password, unless to specify it to make with the GNUPGPASS variable.
For unattended or non-interactive builds with signing, you can do that as: ‘make
GNUPGPASS=mypasswd release-sign’
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘forced-release-sign’
- The ‘release-sign’ target will not regenerate any files that already exist in the package
distribution directory. This forced target will.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘release-clean’
- This target will remove all distribution files for the current package from the package distribution
directory.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
7.8.1.6 Logging Targets
For convenience, to log the output of a number of targets to a file, log targets are defined. The
log file itself is used as the target to make, but make invokes the target minus a .log
suffix. So, for example, to log the results of target ‘foo’, invoke the target ‘foo.log’.
The only target that this does not apply to is ‘compile.log’. When you invoke the target
‘compile.log’ a simple automake(1) is invoked and logged to the file compile.log.
The ‘foo.log’ rule applies to all other targets. This does not work for all targets, just a
selected few.62 Following are the logging targets:
Common Logging Targets
Common logging targets correspond to normal user automake(1) makefile targets as follows:
- ‘compile.log’
- This is an OpenSS7 Project specific makefile target,
but it invokes the standard GNU automake(1) makefile target
‘[all]’.
- ‘check.log’
- This is an OpenSS7 Project specific makefile target,
but it invokes the standard GNU automake(1) makefile target
‘check’.
- ‘install.log’
- This is an OpenSS7 Project specific makefile target,
but it invokes the standard GNU automake(1) makefile target
‘install’.
- ‘installcheck.log’
- This is an OpenSS7 Project specific makefile target,
but it invokes the standard GNU automake(1) makefile target
‘installcheck’.
- ‘uninstall.log’
- This is an OpenSS7 Project specific makefile target,
but it invokes the standard GNU automake(1) makefile target
‘uninstall’.
- ‘remove.log’
- This is an OpenSS7 Project specific makefile target,
that invokes the OpenSS7 Project
‘remove’
target.
Maintainer Logging Targets
Maintainer logging targets correspond to maintainer mode automake(1) makefile targets as
follows:
- ‘dist.log’
- This is an OpenSS7 Project specific makefile target,
but it invokes the standard GNU automake(1) makefile target
‘dist’.
- ‘distcheck.log’
- This is an OpenSS7 Project specific makefile target,
but it invokes the standard GNU automake(1) makefile target
‘distcheck’.
- ‘srpm.log’
- This is an OpenSS7 Project specific makefile target,
that invokes the OpenSS7 Project
‘srpm’
target.
- ‘rebuild.log’
- This is an OpenSS7 Project specific makefile target,
that invokes the OpenSS7 Project
‘rebuild’
target.
- ‘resign.log’
- This is an OpenSS7 Project specific makefile target,
that invokes the OpenSS7 Project
‘resign’
target.
- ‘release.log’
- This is an OpenSS7 Project specific makefile target,
that invokes the OpenSS7 Project
‘release’
target.
- ‘release-sign.log’
- This is an OpenSS7 Project specific makefile target,
that invokes the OpenSS7 Project
‘release-sign’
target.
If you want to add one, simply add it to LOGGING_TARGETS in Makefile.am.
7.8.1.7 Problem Report Targets
To ease problem report generation, all logging targets will automatically generate a problem report
suitable for mailing in the file target.pr for target ‘target.log’. This
problem report file is in the form of an email and can be sent using the included send-pr
script or by invoking the ‘send-pr’ makefile target.
There are two additional problem report targets:
- ‘pr’
- The ‘pr’ target is for independently generating a problem report outside of the build or
installation process. The target will automatically generate a problem report skeleton suitable for
editing and mailing in the file problem.pr. This problem report file is in the form of an
email and can be edited and sent directly, or sent using the included send-pr script or
by invoking the ‘send-pr’ target.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘send-pr’
- The ‘send-pr’ target is for finalizing and mailing a problem report generated either inside or
outside the build and installation process. The target will automatically finalize and mail the
problem.pr problem report if it has changed since the last time that ‘send-pr’ was
invoked.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege (unless the problem report file was generated as root).
7.8.1.8 Release Archive Targets
The following targets are used to generate and clean distribution archive and signature files.
Whereas the ‘dist’ target affects archives in the top build directory, the
‘release-archive’ targets affects archives in the package distribution directory (either the
top build directory or that specified with --with-pkg-distdir=DIR to configure).
You can change the directory to which packages are distributed by using the
--with-pkg-distdir=DIR option to configure. The default directory is the top build
directory.
- ‘release-archives’
- This target creates the distribution archive files if they have not already been created. This not
only runs the ‘dist’ target, but also copies the files to the distribution directory, which, by
default is the top build directory.
The files generated are named:
strnsl-0.9.2.4.tar.gz
and
strnsl-0.9.2.4.tar.bz2
You can change this distribution directory with the --with-pkg-distdir option to
configure. See ‘./configure --help’ for more details on options.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘release-sign-archives’
- This target is like ‘release-archives’, except that it also signs the archives using a
GPG detached signature. You will be prompted for a password unless you pass the
GNUPGPASS variable to make. For automated or unattended builds, pass the GNUPGPASS
variable like so:
‘make GNUPGPASS=mypasswd release-sign-archives’
Signature files will be named:
strnsl-0.9.2.4.tar.gz.asc
and
strnsl-0.9.2.4.tar.bz2.asc
These files will be moved to the package distribution directory with the plain text archives.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘release-clean-archives’
- This target will clean the release archives and signature files from the package distribution
directory.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
7.8.1.9 RPM Build Targets
On rpm(1) systems, or systems sporting rpm packaging tools, the following targets are used to
generate rpm(1) release packages. The epoch and release number can be controlled by the
contents of the .rpmepoch and .rpmrelease files, or with the
--with-rpm-epoch=EPOCH and --with-rpm-release=RELEASE options to configure.
See ‘configure --help’ for more information on options. We always use release number ‘1’.
You can use release numbers above ‘1’.
- ‘srpm’
- This target generates the source rpm for the package (without signing the source rpm). The source
rpm will be named: strnsl-0.9.2.4-1.srpm.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘rpms’
- This target is responsible for generating all of the package binary rpms for the architecture. The
binary rpms will be named:
strnsl-*-0.9.2.4-1.*.rpm
where the stars indicate the subpackage and the architecture. Both the architecture specific
subpackages (binary objects) and the architecture independent (.noarch) subpackages will be
built unless the the former was disabled with the option --disable-arch, or the later with
the option --disable-indep, passed to configure.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘sign’
- ‘srpm-sign’
- These two targets are the same. When invoked, they will add a signature to the source rpm file,
provided that the file does not already have a signature. You will be prompted for a password if a
signature is required. Automated or unattended builds can be achieved by using the emake
expect script, included in
${srcdir}/scripts/emake.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘rebuild’
- This target accepts searches out a list of kernel names from the ${DESTDIR}/lib/modules
directory and builds rpms for those kernels and for each of a set of architectures given in the
AM_RPMTARGETS variable to make. This is convenience target for building a group of rpms on a
given build machine.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘resign’
- This target will search out and sign, with a GPG signature, the source rpm, and all of the
binary rpms for this package that can be found in the package distribution directory. This target
will prompt for a GPG password. Automated or unattended builds can be achieved with the
emake expect script located here:
${srcdir}/scripts/emake.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
7.8.1.10 Debian Build Targets
On Debian systems, or systems sporting Debian packaging tools, the following targets are used to
generate Debian release packages. The release number can be controlled by the contents of the
.debrelease file, or with the --with-debrelease=RELEASENUMBER option to
configure. See ‘configure --help’ for more information on options.
- ‘dsc’
- This target will build the Debian source change package (.dsc file). We use release number
‘0’ so that the entire tarball is included in the dsc file. You can use release number
‘1’ for the same purposes. Release numbers above ‘1’ will not include the entire tarball.
The .dsc file will be named: strnsl_0.9.2.4-0.dsc.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘sigs’
- This target signs the .deb files. You will be prompted for a password, unless to specify it
to make with the GNUPGPASS variable.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘debs’
- This target will build the Debian binary package (.deb file) from the .dsc created
above. (This target will also create the .dsc if it has not been created already.) The
subpackage .deb files will be named: strnsl-*_0.9.2.4-0_*.deb, where
the stars indicate the subpackage and the architecture.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
- ‘csig’
- This target signs the .dsc file. You will be prompted for a password, unless to specify it
to make with the GNUPGPASS variable.
This is an OpenSS7 Project specific makefile target.
This target does not require root privilege.
7.8.1.11 Documentation Targets
On systems that have doxygen(1)
documentation tool, the following targets are used to
generate doxygen html documentation:
- ‘doxy’
- This target generates
doxygen(1)
documetnation from suitably marked sources. File
containing the necessary documentation marks are discovered automatically by configure.
Doxygen documentation can be generated bus is not distributed. Documentation is cerated in the
subdirectory doc/html.
8 Troubleshooting
8.1 Test Suites
8.1.1 Pre-installation Checks
Most OpenSS7 packages, including the OpenSS7 STREAMS Network Services Library package, ship with
pre-installation checks integral to the build system. Pre-installation checks include check scripts
that are shipped in the scripts subdirectory as well as specialized make targets
that perform the checks.
When building and installing the package from RPM or DEB source packages
(see Building from the Source RPM; and Building from the Debian DSC), a fundamental set of
post-compile, pre-installation checks are performed prior to building binary packages. This is
performed automatically and does not require any special actions on the part of the user creating
binary packages from source packages.
When building and installing the package from tarball (see Building from the Tar Ball; and
Installing the Tar Ball), however, pre-installation checks are only performed if specifically
invoked by the builder of the package. Pre-installation checks are invoked after building the
package and before installing the package. Pre-installation checks are performed by invoking the
‘check’ or ‘check.log’ target to make when building the package, as shown
in testsuite:ex0.
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.bz2
% tar -xjvf strnsl-0.9.2.4.tar.bz2
% pushd strnsl-0.9.2.4
% ./configure
% make
% make check # <------- invoke pre-installation checks
% popd
Example 8.1: Invoking Pre-Installation Checks
|
Pre-installation checks fall into two categories: System Checks and Maintenance Checks.
8.1.1.1 Pre-Installation System Checks
System Checks are post-compilation checks that can be performed before installing the package
that check to ensure that the compiled objects function and will be successfully installed. When
the --enable-maintainer-mode option has not been passed to configure, only
System Checks will be performed.
For example, the steps shown in testsuite:ex1 will perform System checks.
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.bz2
% tar -xjvf strnsl-0.9.2.4.tar.bz2
% pushd strnsl-0.9.2.4
% ./configure
% make
% make check # <------ invokes System pre-installation checks
% popd
Example 8.2: Invoking System Checks
|
8.1.1.2 Pre-Installation Maintenance Checks
Maintenance Checks include all System Checks, but also checks to ensure that the kernel
modules, applications programs, header files, development tools, test programs, documentation,
and manual pages conform to OpenSS7 standards. When the --enable-maintainer-mode
option has been passed to configure, Maintenance Checks will be performed.
For example, the steps shown in testsuite:ex2 will perform Maintenance checks.
% wget http://www.openss7.org/strnsl-0.9.2.4.tar.bz2
% tar -xjvf strnsl-0.9.2.4.tar.bz2
% pushd strnsl-0.9.2.4
% ./configure --enable-maintainer-mode
% make
% make check # <------ invokes Maintenance pre-installation checks
% popd
Example 8.3: Invoking Maintenance Checks
|
8.1.1.3 Specific Pre-Installation Checks
A number of check scripts are provided in the scripts subdirectory of the distribution that
perform both System and Maintenance checks. These are as follows:
- check_commands
-
This check performs both System and Maintenance checks.
When performing System tests, the following tests are performed:
Unless cross-compiling, or unless a program is included in AM_INSTALLCHECK_STD_OPTIONS_EXEMPT
every program in bin_PROGRAMS
, sbin_PROGRAMS
, and libexec_PROGRAMS
is tested to
ensure that the --help, --version, and --copying options are accepted.
When cross-compiling is is not possible to execute cross-compiled binaries, and these checks are
skipped in that case.
Script executables, on the other hand, can be executed on the build host, so, unless listed in
AM_INSTALLCHECK_STD_OPTIONS_EXEMPT
, every program in dist_bit_SCRIPTS
,
dist_sbin_SCRIPTS
, and pkglibexec_SCRIPTS
are tested to ensure that the
--help, --version, and --copying options are accepted.
When performing Maintenance tests, check_commands also checks to ensure that a
manual page exists in section 1 for every executable binary or script that will be installed from
bin_PROGRAMS
and dist_bin_SCRIPTS
. It also checks to ensure that a manual page exists
in section 8 for every executable binary or script that will be installed from sbin_PROGRAMS
,
dist_sbin_SCRIPTS
, libexec_PROGRAMS
, and pkglibexec_SCRIPTS
.
- check_decls
-
This check only performs Maintenance checks.
It collects the results from the check_libs
, check_modules
and check_headers
check scripts and tests to ensure every declaration of a function prototype or external variable
contained in installed header files has a corresponding exported symbol from either a to be
installed shared object library or a to be installed kernel module. Declarations are exempted from
this requirement if their identifiers have been explicitly added to the EXPOSED_SYMBOL
variable. If WARN_EXCESS
is set to ‘yes’, then the check script will only warn when
excess declarations exist (without a corresponding exported symbol); otherwise, the check script
will generate an error and the check will fail.
- check_headers
-
This check only performs Maintenance checks.
When performing Maintenance tests, it identifies all of the declarations included in to be
installed header files. It then checks to ensure that a manual page exists in sec