OpenSS7 STREAMS Sockets
OpenSS7 STREAMS Sockets Installation and Reference Manual
About This Manual
This is Edition 4, last updated 2008-10-31, of The
OpenSS7 STREAMS Sockets Installation and Reference Manual, for Version 0.9.2
release 4 of the OpenSS7 STREAMS Sockets 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.
Also note that parts of this software, as identified in Possible BSD Sources, may be
derived from software developed by the University of California, Berkeley covered under the
Combined USL BSD License (see BSD/USL Combined License).
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 Sockets.
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 Sockets.
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 Sockets 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 Sockets 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 Sockets
package, strsock-0.9.2.4.2
Version Control
strsock.texi,v
Revision 0.9.2.16 2008-09-20 11:04:39 brian
- added package patchlevel
Revision 0.9.2.15 2008-08-03 06:03:38 brian
- protected agains texinfo commands in log entries
Revision 0.9.2.14 2008/07/27 08:49:41 brian
- no invariant sections, more libtool ignores
Revision 0.9.2.13 2008-04-28 22:33:30 brian
- updated headers for release
Revision 0.9.2.12 2008-04-25 11:50:54 brian
- updates to AGPLv3
Revision 0.9.2.11 2007/08/12 06:45:02 brian
- updated licenses in manuals
Revision 0.9.2.10 2007/06/23 01:38:27 brian
- updates for release
Revision 0.9.2.9 2007/02/28 06:31:28 brian
- updates and corrections, #ifdef instead of #if
Revision 0.9.2.8 2006/09/18 01:07:16 brian
- updated manuals and release texi docs
Revision 0.9.2.7 2006/09/01 08:55:40 brian
- added headers and working up code
Revision 0.9.2.6 2006/08/29 11:44:05 brian
- added manual pages, working up docs
Revision 0.9.2.5 2006/08/28 10:47:10 brian
- correction
Revision 0.9.2.4 2006/08/28 10:32:58 brian
- updated references
Revision 0.9.2.3 2006/08/27 12:27:12 brian
- finalizing auto release files
Revision 0.9.2.2 2006/08/26 09:19:22 brian
- better release file generation
Revision 0.9.2.1 2006/08/23 10:03:59 brian
- started STREAMS Sockets 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 Sockets package was
provided in part by:
Additional funding for The OpenSS7 Project was provided by:
Contributors
The primary contributor to the OpenSS7 OpenSS7 STREAMS Sockets 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 Sockets 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 Sockets 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 Sockets 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 Sockets 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 Sockets
Package strsock-0.9.2.4 was released under AGPLv3 2008-10-31.
The OpenSS7 STREAMS Sockets package provides STREAMS modules and drivers, libraries,
programs, initialization scripts, and daemons.
The OpenSS7 STREAMS Sockets package contains header files and a number of modules and drivers
and the associated documentation originally contained in the Linux Fast-STREAMS release, but
not contained in the Linux STREAMS (LiS) releases.
The package uses the following standard Open Systems Interconnect (OSI) conforming header
files from the strxnet package:
| − <sys/tiuser.h> Transport Provider Interface (TPI)
|
| − <sys/tihdr.h> Transport Provider Interface (TPI)
|
The package currently provides the following STREAMS modules and
drivers:
| − streams_sockmod.ko | module
|
| − streams_socksys.ko | /dev/socksys
|
sockmod(4)
The sockmod(4) module, when pushed on a TPI Stream, attempts to provide as
wide a range of support for traditional SVR 4.2 socket module and socket system support.
It does so by recognizing input-output controls from three sets:
sockmod(4)
input-output controls; socksys(4) input-output controls, and even socket(7)
system calls.
socksys(4)
The socksys(4) driver, when opened, provides a TPI Stream that attempts to
provide as wide a range of support for traditional SVR 4.2 socket module and socket system
support.
It does so by recognizing input-output controls from three sets:
sockmod(4)
input-output controls; socksys(4) input-output controls, and even socket(7)
system calls.
The package currently provides the following STREAMS libraries:
| − libsocket.so libsocket.a
|
| − libsocklib.so libsocklib.a
|
The libsocket library implements the following library calls:
The libsocket library only needs to implement the single library call because file
descriptors that are returned from the socket(3) call have been transformed into real
sockets (from the viewpoint of the system call interface) and standard glibc calls for the
remaining functions are used.
The libsocklib library implements the following library calls:
The libsocklib library is the older compatibility library approach to providing sockets for
STREAMS and implements the system calls as library calls for STREAMS devices, while
calling the glibc versions for true sockets.
The OpenSS7 STREAMS Sockets package includes kernel modules, SVR 4.2 STREAMS
drivers, modules, libraries, utilities, test programs, daemons, and development environment for the
development and execution of OpenSS7 STREAMS Sockets modules and drivers.
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 strsock-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/strsock-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
strsock 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-strsock
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 Sockets 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 strsock 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:
$> ../strsock-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/strsock-0.9.2.4.tar.bz2
$> tar -xjvf strsock-0.9.2.4.tar.bz2
$> mkdir build
$> pushd build
$> ../strsock-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 strsock-0.9.2.4
$> rm -f strsock-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/strsock-0.9.2.4.tar.bz2
$> tar -xjvf strsock-0.9.2.4.tar.bz2
$> mkdir build
$> pushd build
$> ../strsock-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 strsock-0.9.2.4
$> rm -f strsock-0.9.2.4.tar.bz2
See
README-make
for additional specialized make targets.
For custom applications, see the
INSTALL
and
INSTALL-strsock
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 Sockets package is available from the downloads area of The OpenSS7 Project website using a command such as:
$> wget http://www.openss7.org/tarballs/strsock-0.9.2.4.tar.bz2
Unpack the tarball using a command such as:
$> tar -xjvf strsock-0.9.2.4.tar.bz2
The tarball will unpack into the relative subdirectory named after the package name:
strsock-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
$> ../strsock-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 ../strsock-0.9.2.4/INSTALL
For specific options to the configure script, see the
INSTALL-strsock
file in
the distribution, or simply execute the configure script with the --help option like so:
$> ../strsock-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 strsock-0.9.2.4
$> rm -f strsock-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 ../strsock-0.9.2.4
$> less doc/manual/strsock.txt
$> lynx doc/manual/strsock.html
$> info doc/manual/strsock.info
$> xpdf doc/manual/strsock.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/strsock_manual.html
1 Introduction
This manual documents the design, implementation, installation, operation and future development
schedule of the OpenSS7 STREAMS Sockets package.
1.1 Overview
This manual documents the design, implementation, installation, operation and future development of
the OpenSS7 STREAMS Sockets package.
1.2 Organization of this Manual
This manual is organized (loosely) into several sections as follows:
1.3 Conventions and Definitions
This manual uses texinfo typographic conventions.
2 Objective
The objective of the OpenSS7 STREAMS Sockets package is to provide
Sockets capability for STREAMS in a similar manner as provided by
SVR 4.2 and later Solaris implementations. To accomplish this
there are three (3) approaches that can be taken to implementing Sockets
over STREAMS:
2.1 Socket Module
This approach implements the SVR 4.2 sockmod(4)
module and
cooperating libsocket(3)
library. The library and cooperating
STREAMS module behave in a similar fashion to the libxnet(3)
library and timod(4)
module for XTI.
There are a set of input-output controls defined for sockets (explicitly for
compatibility with SVR 4.2) that can be accepted by the
sockmod(4) module. These input-output controls permit direct
conversion between sockets function and kernel-space facilities.
The original
sockmod(4) approach keep much of the socket state in
user space in the fashion of xti(3)
; however, this approach is just
asking for trouble. Also, Linux also implements the SVR 4.2
input-output controls for native Sockets and the resulting
libsocket(3) library would then work for both STREAMS-based
sockets and Linux native sockets.
Socket input-output controls defined for SVR 4.2 are:
O_SI_GETUDATA |
|
SI_SHUTDOWN |
|
SI_LISTEN |
|
SI_SETMYNAME |
|
SI_SETPEERNAME |
|
SI_GETINTRANSIT |
|
SI_TCL_LINK |
|
SI_TCL_UNLINK |
|
SI_SOCKPARAMS |
|
SI_GETUDATA |
|
2.2 Socket System
This approach implements the SVR 4.2 socksys(4)
driver.
Opening Streams via the
socksys(4) driver causes them to be
transformed into native Sockets against which standard libc socket
system calls are sufficient. For compatibility with the
sockmod(4)
approach, the pushing the
sockmod(4) module can be made to cause the
same effect.
Before Linux Fast-STREAMS was developed, taking this approach was next
to impossible due to the obfuscated nature and non-standard behaviour of the
LiS Stream head. Now that LiS is completely deprecated,
this approach is now possible.
SVR 4.2 behaviour for the Stream head dictates that it respond to
both
termio(7) and
sockio(7) input-output controls in
addition to
streamio(7) controls. That is, each Stream head
can be a
fifo(4), a
pipe(4), a
tty(4), a
socket or a stream. LiS never followed this
behaviour: Linux Fast-STREAMS was built with it from the start.
Socket input-output controls recognized and intercepted by the Linux
Fast-STREAMS Stream head are:
SIOCATMARK
|
SIOCGPGRP
|
SIOCSPGRP
|
Additional Sockets input-output controls are passed to the Stream as
TRANSPARENT or I_STR(7) (see streamio(7))
input-output controls.
SIOCHIWAT | Set the high water mark. | TRANSPARENT
|
SIOGHIWAT | Get the high water mark. | TRANSPARENT
|
SIOCLOWAT | Set the low water mark. | TRANSPARENT
|
SIOGLOWAT | Get the low water mark. | TRANSPARENT
|
SIOCATMARK | Test whether at mark. | Stream head
|
SIOCGPGRP FIOCGPGRP | Get process group. | Stream head
|
SIOCSPGRP FIOCSPGRP | Set process group. | Stream head
|
FIONREAD TIOCINQ | Number of bytes to be read. | I_STR(7) (see streamio(7))
|
TIOOUTQ | Number of bytes to be sent. | I_STR(7) (see streamio(7))
|
FIONBIO | Set blocking i/o. | TRANSPARENT
|
SIOCPROTO | Set a new protocol entry. | TRANSPARENT
|
SIOCGETNAME | Get socket's name. | TRANSPARENT
|
SIOCGETPEER | Get socket's peer. | TRANSPARENT
|
SIOCXPROTO | Clear protocol entry table. | TRANSPARENT
|
SIOCSOCKSYS | (See table below.) | TRANSPARENT
|
2.3 Socket Integration
With this approach, Streams that are usable for sockets are given the
IF_SOCK attribute during registration. The Stream head is aware
of this and creates a socket structure for each Stream head opened for
the driver.
2.4 Solaris Approaches
The following is reprinted from an article in UNIX® Insider issue
‘3/9/01’ written by Jim Mauro.
Prior to Solaris 2.6, sockets were an abstraction that existed at the
library level. That is, much of the socket state and socket semantics support
were provided with the libsocket library. The kernel's view of a
process's socket connection entailed a file descriptor and linkage to a
Stream head, which provided the path to the underlying transport. The
disparity between the library socket state and the kernel's view was one of
several reasons a new implementation was introduced in Solaris 2.6.
To provide a relevant basis for comparison, we will start by looking at what
happens in the pre-Solaris 2.6 release (this is, releases up to and
including Solaris 2.5.1) when a socket is created. The major software
layers are shown in Figure XXX for reference.
The primary software components are the socket library and the
sockmod(4) STREAMS module. The specfs(5) layer is
shown for completeness and is part of the layering, due to the use of
pseudo-devices as an entry point into the networking layers. To digress for a
moment, the special file system, specfs(5) came out of SVR 4
UNIX® as a means of addressing the issue of device special files that
exist on UNIX® on-disk file systems (e.g. UFS).
UNIX® system have always abstracted I/O (input/output) devices
through device special files. The /dev directory name space stores
files that represent physical devices and pseudo-devices on the system. Using
device major numbers, those device files provide an entry point into the
appropriate device driver, and using minor numbers, they are able to uniquely
identify one of potentially many devices of the same type. (That is something
of an oversimplification, but it is sufficient for our purpose here in
describing specfs(5)).
The /dev directory resides on the root file system, which is an
instance of UFS. As such, references to the file system and its files
and directories are handed using the UFS file system operations and
UFS file operations. That is usually sufficient, but not desired
behaviour for device special files. I/O to a device special file requires
entry into a device driver. That is, issuing an open(2) system call
on /dev/rmt/0 means someone wishes to open the tape device represented
by /dev/rmt/0, thereby entering the appropriate driver's
xx_open() routine. As a file on a UFS file system, the
typical open routine called would be the ufs_open() code, but that
is not what we want for devices. The specfs(5) file system was
designed to address such situations; it provides a straightforward mechanism
for linking the underlying structures for file support in the kernel to the
required device driver interfaces. Like all file systems in Solaris
(and any SVR4-based UNIX®) it is based on the
VFS/vnode infrastructure. (See Solaris Internals and
UNIX® Internals in the Resources section for detailed information on
VFS.)
Getting back to sockets in Solaris 2.5.1, the specfs(5) layer
comes into play because the socket open ultimately results in an
open(2) system call issued on the tcp(4) or
udp(4) pseudo-device. More precisely, the socket library passes the
arguments given to the socket(3) call to a lookup function that
searches an internal (internal to libsocket.so) array to match the
domain argument and retrieve a corresponding character string. It then uses
the character string to find a match in the /etc/netconfig file, which
is used for transport selection and describes all the available transport
protocols in Solaris. (See netconfig(5)
.) This transport
selection mechanism is an essential part of a network programming
implementation; it allows for the interfaces to be protocol-independent, so
the programmer is not required to maintain a different source base for
Ethernet-based networks versus FDDI-based networks, etc.
A netconfig(5) data structure (defined in
/usr/include/sys/netconfig.h) is populated based on the line entries in
/etc/netconfig that match the domain (as per the character string
retrieved from the internal table), type, and protocol family specified in the
socket(3) call. Among the netconfig(5) parameters, a
device is defined that provides the entry point into the transport provider
kernel module. For example, a call to ‘socket(AF_INET, SOCK_STREAM, 0)’
indicates an Internet transport that provides reliable, connection-oriented
behaviour is desired. The TCP layer of the TCP/IP protocol
family provides such a service, and the /etc/netconfig entry defines
‘/dev/tcp’ as the device to open for entry into that transport layer.
The socket library code will issue an open(2) on ‘/dev/tcp’
accordingly. If one were developing a network-based application using the
X/Open Transport Interface (XTI) – a superset of what was the
Transport Layer Interface (TLI) – the t_open(3) call would
receive the ‘/dev/tcp’ argument explicitly for a connection using
TCP as a transport protocol.
The block sitting below the specfs(5) in Figure XXX, the Stream
head, is a generic part of a STREAMS-based communication path. The
Stream head is created when a STREAMS device is opened. In Figure
XXX, the open(2) to the ‘/dev/tcp’ transport layer, which is a
STREAMS device, resulted in the creation of the Stream head. The
Stream head translates the interface calls made by the socket library
into STREAMS messages (the STREAMS framework is message-based and
uses queues to move data downstream [from the user process to the
STREAMS driver] and upstream [from the driver to the user process]).
The STREAMS facility provides for the insertion (pushing) and removal
(popping) of STREAMS modules in the data flow, between the Stream
head and the underlying driver. Each module implements a set of queues – a
read queue and a write queue – for processing the data and messages. The
generic picture is shown in Figure YYY.
In the context of Solaris 2.5.1 sockets, the STREAMS module shown
in Figure YYY is a kernel sockmod(4) module (located in the
/kernel/strmod directory). sockmod(4) provides, in
conjunction with libsocket.so, support for socket semantics using the
STREAMS facility. That is, socket calls are handled initially by the
socket library, then passed down to the Stream head, which transforms
the calls into STREAMS messages and passes them down to
sockmod(4). Upstream messages are passed from the underlying device
driver and transport provider through sockmod(4) and back up to the
process. Thus, the functions contained in the sockmod(4) module
include STREAMS queue reading and writing in the form of queue
‘read put’ and ‘write put’ code for moving data up and down the
Stream as data is read and written from the socket. The
sockmod(4) module communicates with the underlying transport using
primitives and structures defines in the /usr/include/sys/tihdr.h
header file.
The socket state maintained at the library level is in the form of a
library-internal data structure, _si_user, which maintains various
bits of information about the socket, and is what the internal socket create
function returns on a socket call. Yes, it is the file descriptor that
represents the socket that is returned to the user code _si_user is
visible only to the library. You will find the structure definition for
_si_user and associated structures that it links to
(si_udata and si_sockparams) in
/usr/include/sys/sockmod.h. If you look at the structure definition,
you will see that the _si_user embeds the si_udata and
si_sockparams structures, which maintain stat information (e.g.
connected, bound), socket options (accept connection), information on the
transport provider (e.g. service type), and family, type, and protocol used
for the socket.
At the sockmod(4) layer, a socket is internally represented in the
so_so data structure. Fields of interest there include an embedded
ti_info structure (/usr/include/sys/tiuser.h) that manages
transport provider information, a network buffer (netbuf) for data
transfer, a si_udata structure that replicates the socket state
(among other things), and message blocks (mblk_t), which are the
basic unit of communication across STREAMS.
In Solaris 2.6, we did away with the sockmod(4) STREAMS
module and trimmed a lot of code from libsocket. Most of the
socket-related library interfaces result in system call traps into the kernel,
without any library-level code executing. A few of the interfaces
(socket(3) and sockpair(3)) execute some library-level
code before entering the kernel. However, all the state information is
maintained in the kernel, where it belongs. This creates a nice visibility
feature – we can now see file descriptors that represent sockets.
sunsys> uname -a
SunOS sunsys 5.8 Generic_108528-01 sun4u sparc SUNW, Ultra-60
sunsys> srv &
[1] 7153
Socket port: # 34940
Send bug: 16384, Rcv buf: 24576
sunsys> pfiles 7153
7153: srv
Current rlimit: 1024 file descriptors
0: S_IFCHR mode:0620 dev:32,0 ino:91176 uid:19822 gid:7 rdev:24,14
O_RDWR|O_LARGEFILE
1: S_IFCHR mode:0620 dev:32,0 ino:91176 uid:19822 gid:7 rdev:24,14
O_RDWR|O_LARGEFILE
2: S_IFCHR mode:0620 dev:32,0 ino:91176 uid:19822 gid:7 rdev:24,14
O_RDWR|O_LARGEFILE
3: S_IFSOCK mode:0666 dev:186,0 ino:63137 uid:0 gid:0 size:0
O_RDWR
sockname: AF_INET 0.0.0.0 port: 34940
sunsys>
In the above example, a simple TCP socket server process is started
(srv, PID 7153). (The ‘Socket port’ and ‘Send buf’ lines
are output from the srv process when it starts.) Using the
pfiles(1) command to dump the process's open file descriptors, we
see that the file descriptor is identified as a socket, and we even get the
socket type (AF_INET) and port number. (The freeware command,
lsof(1), is a great utility for extracting process file descriptor
information if you are on an older Sun OS that does not have
pfiles(1). You can get lsof(1) from
ftp://vic.cc.purdue.edu/pub/tools/unix/lsof/.)
The libsocket changes associated with sockfs(5) maintain the
documented interfaces. Both source and binary compatibility are maintained,
as socket code compiled on early version of Solaris should work without
recompilation on Solaris 6 and later releases. Source code should move
over and recompile with no changes as well.
The trimming down of the library-level socket code required providing a new
means to map the domain type passed as an argument to socket(3) to
facility lookup in /etc/netconfig. Recall that the Solaris
2.5.1 socket library did this using an internal table. In Solaris 6
and later, a new configuration file and command is introduced to provide that
functionality. The /etc/sock2path contains the necessary information
to map the socket(3) call parameters to the appropriate transport
provider and device. A new command, soconfig(8), is used to
maintain /etc/sock2path. It is executed automatically at boot time via
an entry in the /etc/inittab file. Reference the
sock2path(4) and soconfig(8) manual pages for specifics.
For most applications, the default entries in sock2path(5) are
sufficient.
As a file system (pseudo-file system), sockfs(5) implements the
generic VFS/vnode
related support structures and exports the
required file-system-specific functions. However, the entry into the
sockfs(5)-specific functions does not necessarily follow the typical
flow of a regular file open, which is vectored to the file-type-specific
function through the use of macros and an operations table. That is, the
issuing of an open(2) system call on a file enters a generic
vnode
code path and ultimately resolves through a VOP_OPEN()
macro to the appropriate file-system-specific open code (e.g. ufs_open
for a file an a UFS file system).
Sockets are created an opened using the socket(3) API. A call to
socket(3) from user code enters the libsocket library, which
handles the mapping to the transport provider device, then enters the
sockfs(5) kernel module through an internal so_create()
system call. The sock_open()
(file system specific open routine) is
invoked through the so_create()
call, which is how other necessary
create functions, such as an initialization function for the socket
Stream, are called.
Other conventional system calls, such as read(2) or
write(2) on a socket, are vectored into the sockfs(5)
specific read and write code (sock_read()
and sock_write()
)
through the standard VFS/vnode
mechanism. Once entered, the
sockfs(5) read/write code makes lower-level calls into the
sockfs(5) subsystem designed to interface with the transport
provider. For example, a read(2) system call on a socket vectors
into sock_read()
, which does some basic housekeeping and calls an
internal sorecvmsg()
(socket receive message) function. In
sorecvmsg()
, socket stat is tested and the request is moved downstream
via a call to the STREAMS get-message function.
The most compelling part of the sockfs(5) implementation is that
consolidation of all socket stat information is in a single structure,
maintained in one place: the kernel. Sockets are represented internally as a
sonode
, defined in /usr/include/sys/socketvar.h. All operations
on a sonode
take place within the kernel sockfs(5) subsystem,
isolating state changes and eliminating the need to replicate state for
consistency.
3 Reference
3.1 Files
STRSOCK creates the following kernel modules files in the kernel modules
directory, /lib/modules/2.4.20-28.7/:7
- modules.strsock
STRSOCK installs the following kernel module files in the kernel modules
directory, /lib/modules/2.4.20-28.7/strsock/:8
- streams_sockmod.ko
- streams_socksys.ko
STRSOCK installs the following header files in the system include directory,
/usr/include/strsock/:
- sys/strsock/config.h
- sys/strsock/version.h
- sys/sockio.h
- sys/sockmod.h
- sys/sockpath.h
- sys/socksys.h
- sys/socklib.h
- sockdb.h
- sockio.h
- sockmod.h
- socksys.h
STRSOCK installs the following test programs in the system libexec directory,
/usr/libexec/strsock/: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 Sockets 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-sockpath
- test case executable.
- test-socket
- test case executable.
- test-socklib
- test case executable.
- test-sockmod
- test case executable.
- test-socksys
- test case executable.
- 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 Sockets 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.
STRSOCK installs the following utility programs in the system binary
directory, /usr/sbin/:
- initsock
- soconfig
- strsock_mknod
- This utility can be used by init scripts or administrative users to create or remove device nodes in
the /dev directory for OpenSS7 STREAMS Sockets drivers.
STRSOCK installs the following static and shared object libraries in the
system library directory, /usr/lib/ (32-bit libraries) and /usr/lib64/
(64-bit libraries):
- libsockpath.so.0.0.0
- libsockpath.so.0
- libsockpath.so
- libsockpath.a
- libsockpath.la
- libsocket.a
- libsocket.la
- libsocklib.a
- libsocklib.la
STRSOCK installs the following init scripts in the system init directory,
/etc/rc.d/init.d/ (non-Debian) or /etc/init.d/ (Debian):
- strsock
- This is the name of the system init script on non-Debian based systems.
- strsock.sh
- This is the name of the system init script on Debian based systems.
STRSOCK installs the following system configuration files in the configuration
directory, /etc/:
- strsock.conf
- This file provided configuration information for any system controls affected by the
‘strsock’ package.
- modutils/strsock
- This file provides module definitions and demand loading aliases for the strsock
package. This file is really only applicable to older 2.4 kernels.
- sock2path
- This file provides the sock2path(5) definitions for the OpenSS7 STREAMS Sockets
drivers.
sock2path(5) definitions are used by the strsock package and the libsocket
library.
STRSOCK installs the following system configuration file in the system
configuration directory, /etc/sysconfig/ (non-Debian) or /etc/default/
(Debian):
- strsock
- This file provides system configuration information used by init scripts for the
‘strsock’ package. Some options of init script execution can be controlled by
this file.
STRSOCK installs the following info files in the system info directory,
/usr/share/info/:
- strsock.info
- strsock.info-1
- strsock.info-2
- These files contain this manual in GNU info format.
STRSOCK installs the following manual page macros and reference database files in
the system man directory, /usr/share/man/:10
- strsock.macros
- This file contains manual page macro definitions included by the manual pages included in the
package.
- strsock.refs
- This file contains a reference database referenced by the manual pages included in the package.
STRSOCK installs the following manual pages in the system man directory,
/usr/share/man/man3/:
- accept.3
- bind.3
- connect.3
- getpeername.3
- getsockname.3
- getsockopt.3
- libsocket.3
- listen.3
- recv.3
- recvfrom.3
- recvmsg.3
- send.3
- sendmsg.3
- sendto.3
- setsockopt.3
- shutdown.3
- socket.3
- socketpair.3
- sockets.3
- endsockpath.3
- freesockpathent.3
- getsockpath.3
- getsockpathent.3
- setsockpath.3
- sockpath.3
- sp_perror.3
- sp_sperror.3
- libsocklib.3
- socklib.3
STRSOCK installs the following manual pages in the system man directory,
/usr/share/man/man4/:
- sockmod.4
- socksys.4
STRSOCK installs the following manual pages in the system man directory,
/usr/share/man/man5/:
- strsock.5
- manual page for the strsock(5) package.
- sock2path.5
STRSOCK installs the following manual pages in the system man directory,
/usr/share/man/man8/:
- strsock_mknod.8
- Documentation for the strsock_mknod(8) utility program.
- initsock.8
- soconfig.8
- test-socket.8
- test-socklib.8
- test-sockmod.8
- test-sockpath.8
- test-socksys.8
3.2 Drivers
3.3 Modules
3.4 Libraries
3.5 Utilities
3.6 Development
4 Conformance
5 Releases
This is the OpenSS7 Release of the OpenSS7 STREAMS Sockets 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 Sockets 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 Sockets 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.
5.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 Sockets 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 strsock 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.
5.2 Compatibility
This section discusses compatibility with major prerequisites.
5.2.1 GNU/Linux Distributions
OpenSS7 STREAMS Sockets 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.
5.2.2 Kernel
The OpenSS7 STREAMS Sockets 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 Sockets 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.
5.2.3 Architectures
The OpenSS7 STREAMS Sockets 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.
5.2.4 Linux STREAMS
The OpenSS7 STREAMS Sockets package is currently compatible with
Linux STREAMS,19
however, to use the OpenSS7 STREAMS Sockets package with LiS requires use of the OpenSS7
release packages of LiS.
The OpenSS7 STREAMS Sockets 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.
5.2.5 Linux Fast-STREAMS
The OpenSS7 STREAMS Sockets package is currently compatible with Linux Fast-STREAMS
(LfS).
The OpenSS7 STREAMS Sockets package is compatible with the OpenSS7
streams-0.9.2.4 release
that is available from the The OpenSS7 Project Downloads Page.
5.3 Release Notes
The sections that follow provide information on OpenSS7 releases of the OpenSS7 STREAMS Sockets
package.
Major changes for release strsock-0.9.2.4
This is the fourth separate OpenSS7 Project release of the OpenSS7 STREAMS Sockets
package whose components were formerly part of the strss7, strxnet and streams
packages.
These networking modules provide the Sockets 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 socket 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
strsock package page.
See http://www.openss7.org/codefiles/strsock-0.9.2.4/ChangeLog and
http://www.openss7.org/codefiles/strsock-0.9.2.4/NEWS in the release for more
information. Also, see the strsock.pdf manual in the release (also in html
http://www.openss7.org/strsock_manual.html).
For the news release, see http://www.openss7.org/rel20081029_C.html.
Major changes for release strsock-0.9.2.3
This OpenSS7 Project release is the third separate release of the
OpenSS7 STREAMS Sockets package whose components were formerly part of the
strss7, strxnet and streams packages. These networking
modules provide the Sockets 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). This release is primarily a
maintenance release supporting recent distributions and tool chains.
Major features since the last public release are as follows:
- Support build on openSUSE 10.2.
- 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.
- Changes to support build on 2.6.20-1.2307.fc5 and 2.6.20-1.2933.fc6 kernel.
- Supports build on Fedora Core 6.
- Support for recent distributions and tool chains.
Major changes for release strsock-0.9.2.2
This OpenSS7 Project release is the second separate release of the
OpenSS7 STREAMS Sockets package whose components were formerly part of the
strss7, strxnet and streams packages. These networking
modules provide the Sockets 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). This
release is primarily a maintenance release supporting 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 strsock-0.9.2.1
This OpenSS7 Project release is the first separate release of the
OpenSS7 STREAMS Sockets package whose components were formerly part of the
strss7, strxnet and streams packages. These networking
modules provide the Sockets 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.D).
This release is the initial public release.
- Support for most recent 2.6.18 kernels (including Fedora Core 5 with inode diet
patchset).
5.4 Maturity
The OpenSS7 Project adheres to the following release philosophy:
- pre-alpha release
- alpha release
- beta release
- gamma release
- production release
- unstable release
5.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.
5.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.
5.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.
5.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.
5.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.
5.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.
5.5 Bugs
5.5.1 Defect Notices
OpenSS7 STREAMS Sockets 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.
5.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 Sockets had no known bugs at the time of release.
5.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
001. 2008-08-17T03:42:23+0000
-
The
socket, socklib and sockpath
libraries were discovered to contain a thread-safety bug caused by newer behaviour of pthread_once()
causing the libraries to core dump when used on recent implementations of pthreads (nptl).
*fixed* in strsock-0.9.2.4.
5.6 Schedule
Current Plan
This package is still incomplete. It is missing a fully functional Stream head socket library,
module or driver implementation. Also, performance testing of STREAMS INET drivers indicates that
STREAMS-based networking components could exhibit far superior performance to that exhibited by
legacy Linux sockets. To accomplish this requires fully implementing socklib(3)
,
sockmod(4)
module or socksys(4)
driver, creating validation test suites, and
performance analysis and comparison with legacy Linux mechanisms.
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 to your industry and your organization is able to fund further development or contribute
the missing items, contact us on the openss7-develop maling list. Until funding or a mandate
surfaces, this package will likely continue as a proof-of-concept only. It will be maintained ina
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
- Testing. This package is completely untested.
*todo*
- Create a
socksys(4)
Socket System STREAMS driver.
*todo*
- It would be interesting to perform some Netperf and Iperf performance tests against
STREAMS-based network drivers supporting Transport Provider Interface (TPI) and
Sockets using this socket system. Without sockmod(4) and libsocket it was
only possible to use Netperf for performance testing, and then only using the XTI tests.
*todo*
- Create the
socket(3)
libsocket shared library.
*todo*
- Create a
sockmod(4)
Socket Module STREAMS module.
*todo*
- Move already written code from the stacks or strss7 directories
into the src directory.
*todo*
- Create a skeleton directory and manual and place strsock as
a sub-package in the OpenSS7 Master Package.
- *done*
-
You are reading it.
The strsock package is currently incomplete.
The purpose of the package was to move STREAMS socket capabilities outside of the
STREAMS release package so as to allow them to be used with both LiS and Linux
Fast-STREAMS. As Linux Fast-STREAMS has already shown superior to LiS in terms of
both performance and conformance, it is no longer necessary to keep these packages separate and they
can be combined once again (or still) with Linux Fast-STREAMS.
5.7 History
For the latest developments with regard to history of changes, please see the ChangeLog file
in the release package.
6 Installation
6.1 Repositories
The OpenSS7 STREAMS Sockets 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.
6.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 strsock
Removing the package is as easy as:
$> sudo yum remove strsock
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:
- ‘strsock’
-
This package can be used to install or remove the entire OpenSS7 STREAMS Sockets 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.
- ‘strsock-devel’
-
This package can be used to install or remove the development components of the
OpenSS7 STREAMS Sockets package. When installing, ‘strsock’ 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.
- ‘strsock-2.4.20-28.7’
-
This package can be used to install or remove the package for a specific kernel version. When
installing, the ‘strsock’ package will also be installed if necessary. When removing
the last kernel module package, the ‘strsock’ 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.
- ‘strsock-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 ‘strsock’ and ‘strsock-devel’
packages will also be installed if necessary. When removing the development and debug for kernel
modules for the last kernel, the ‘strsock-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.
6.1.2 Repositories for APT
For assistance with specific DEBs, see Downloading the Debian DEB.
6.2 Downloading
The OpenSS7 STREAMS Sockets 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
strsock 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.
6.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 strsock
|
This and additional packages for installation are detailed as follows:
- strsock
- Install this package if you need the runtime strsock package.
% sudo yum install strsock
This will install the strsock, strsock-lib and
strsock-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 strsock package.
% sudo yum remove strsock
This will remove the strsock, strsock-lib,
strsock-devel, strsock-KVERSION and
strsock-devel-KVERSION RPMs for all kernels on your system.
- strsock-devel
- Install this package if you need the development strsock package.
% sudo yum install strsock-devel
This will install the strsock, strsock-lib,
strsock-devel, strsock-KVERSION and
strsock-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 strsock
package for any kernel.
% sudo yum remove strsock-devel
This will remove the strsock-devel and strsock-devel-KVERSION
RPMs for all kernels on your system.
- strsock-2.4.20-28.7
- Install this package if you need the runtime strsock 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 strsock components with:
% sudo yum install strsock-$(uname -r)
This will install the strsock, strsock-lib and
strsock-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 strsock 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 strsock components with:
% sudo yum remove strsock-$(uname -r)
This will remove the strsock-2.4.20-28.7 and
strsock-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 strsock was installed,
the strsock strsock-lib and strsock-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.
- strsock-devel-2.4.20-28.7
- Install this package if you need the development strsock 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 strsock components with:
% sudo yum install strsock-devel-$(uname -r)
This will install the strsock, strsock-lib,
strsock-devel, strsock-2.4.20-28.7 and
strsock-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
strsock 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 strsock components with:
% sudo yum remove strsock-devel-$(uname -r)
This will remove the strsock-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 strsock was installed, the strsock-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.
- strsock-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.
6.2.2 Downloading with APT
OpenSS7 repositries support apt(8)
repositorie digests and signatures.
6.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
‘strsock-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
- strsock-dev-0.9.2.4-1.7.2.noarch.rpm
- The strsock-dev package contains the device definitions necessary
to run applications programs developed for OpenSS7 STREAMS Sockets.21
- strsock-doc-0.9.2.4-1.7.2.noarch.rpm
- The strsock-doc package contains this manual in plain text,
postscript, pdf and html forms, along with the meta-information from the
strsock package. It also contains all of the manual pages
necessary for developing OpenSS7 STREAMS Sockets applications and
OpenSS7 STREAMS Sockets STREAMS modules or drivers.
- strsock-init-0.9.2.4-1.7.2.noarch.rpm
- The strsock-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.
- strsock-source-0.9.2.4-1.7.2.noarch.rpm
- The strsock-source package contains the source code necessary for
building the OpenSS7 STREAMS Sockets release. It includes the autoconf(1)
configuration utilities necessary to create and distribute tarballs, rpm and
deb/dsc.
22
Architecture Dependent
- strsock-devel-0.9.2.4-1.7.2.i686.rpm
- The strsock-devel package contains library archives for static
compilation, header files to develop OpenSS7 STREAMS Sockets modules and drivers.
This also includes the header files and static libraries required to compile
OpenSS7 STREAMS Sockets applications programs.
- strsock-lib-0.9.2.4-1.7.2.i686.rpm
- The strsock-lib package contains the run-time shared libraries
necessary to run application programs and utilities developed for the
strsock 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).
- strsock-LiS-util-0.9.2.4-1.7.2.i686.rpm
- The strsock-LiS-util package provides administrative and
configuration test utilities and commands associated with the
OpenSS7 STREAMS Sockets package. Because this package must link a
STREAMS-specific library, it is a STREAMS-Dependent package. Use the
strsock-LiS-util package if you have LiS installed.
- strsock-streams-util-0.9.2.4-1.7.2.i686.rpm
- The strsock-streams-util package provides administrative and
configuration test utilities and commands associated with the
OpenSS7 STREAMS Sockets package. Because this package must link a
STREAMS-specific library, it is a STREAMS-Dependent package. Use the
strsock-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
- strsock-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strsock-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
- strsock-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strsock-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
- strsock-LiS-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strsock-LiS-core package contains the kernel modules that
provide the OpenSS7 STREAMS Sockets 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
- strsock-streams-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strsock-streams-core package contains the kernel modules that
provide the OpenSS7 STREAMS Sockets 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
- strsock-LiS-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strsock-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
- strsock-streams-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- The strsock-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.
6.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
‘strsock-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
- strsock-dev_0.9.2.4-0_all.deb
- The strsock-dev package contains the device definitions necessary to run
applications programs developed for OpenSS7 STREAMS Sockets. 34
- strsock-doc_0.9.2.4-0_all.deb
- The strsock-doc package contains this manual in plain text, postscript, pdf and html
forms, along with the meta-information from the strsock package. It also
contains all of the manual pages necessary for developing OpenSS7 STREAMS Sockets applications and
OpenSS7 STREAMS Sockets STREAMS modules or drivers.
- strsock-init_0.9.2.4-0_all.deb
- The strsock-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.
- strsock-source_0.9.2.4-0_all.deb
- The strsock-source package contains the source code necessary for
building the OpenSS7 STREAMS Sockets release. It includes the autoconf(1)
configuration utilities necessary to create and distribute tarballs, rpms and
deb/dscs.
35
Architecture Dependent
- strsock-devel_0.9.2.4-0_i386.deb
- The strsock-devel package contains library archives for static
compilation, header files to develop OpenSS7 STREAMS Sockets modules and drivers.
This also includes the header files and static libraries required to compile
OpenSS7 STREAMS Sockets applications programs.
- strsock-lib_0.9.2.4-0_i386.deb
- The strsock-lib package contains the run-time shared libraries
necessary to run application programs and utilities developed for the
strsock 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).
- strsock-LiS-util_0.9.2.4-0_i386.deb
- The strsock-LiS-util package provides administrative and
configuration test utilities and commands associated with the
OpenSS7 STREAMS Sockets package. Because this package must link a
STREAMS-specific library, it is a STREAMS-Dependent package. Use the
strsock-LiS-util package if you have LiS installed.
- strsock-streams-util_0.9.2.4-0_i386.deb
- The strsock-streams-util package provides administrative and
configuration test utilities and commands associated with the
OpenSS7 STREAMS Sockets package. Because this package must link a
STREAMS-specific library, it is a STREAMS-Dependent package. Use the
strsock-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
- strsock-core-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strsock-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
- strsock-info-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strsock-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
- strsock-LiS-core-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strsock-LiS-core package contains the kernel modules that
provide the OpenSS7 STREAMS Sockets 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
- strsock-streams-core-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strsock-streams-core package contains the kernel modules that
provide the OpenSS7 STREAMS Sockets 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
- strsock-LiS-info-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strsock-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
- strsock-streams-info-2.4.20-28.7_0.9.2.4-0_i386.deb
- The strsock-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.
6.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.
- strsock-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.
6.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.
- strsock_0.9.2.4-0.dsc
- strsock_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.
6.2.7 Downloading the Tar Ball
For non-rpm(1) and non-dpkg(1) architectures,
download the tarball as follows:
- strsock-0.9.2.4.tar.gz
- strsock-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/strsock-0.9.2.4.tar.bz2
|
or
% wget http://www.openss7.org/strsock-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/strsock-0.9.2.4.tar.gz
% tar -xzvf strsock-0.9.2.4.tar.gz
|
or
% wget http://www.openss7.org/strsock-0.9.2.4.tar.bz2
% tar -xjvf strsock-0.9.2.4.tar.bz2
|
Either will create a subdirectory name
strsock-0.9.2.4
containing all of the files and subdirectories for the
strsock package.
Configuration
To configure and install the tar ball, See Configuring the Tar Ball.
6.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 strsock package from the project CVS archive.
The OpenSS7 STREAMS Sockets package is located in the strsock 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 strsock_0.9.2.4 strsock
% 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 strsock 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:
% autoreconf -fiv strsock
|
where, strsock 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 strsock
|
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.
6.3 Configuration
6.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:
- strsock-LiS-core-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- strsock-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
strsock STREAMS core, drivers and modules.50
- strsock-LiS-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
- strsock-streams-info-2.4.20-28.7-0.9.2.4-1.7.2.i686.rpm
-
- /usr/include/strsock/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 strsock package.51
- strsock-dev-0.9.2.4-1.7.2.i686.rpm
- (not relocatable)
- strsock-devel-0.9.2.4-1.7.2.i686.rpm
-
- /usr/lib
- This relocatable directory contains strsock libraries.
- /usr/include/strsock
- This relocatable directory contains strsock header files.
- strsock-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
strsock-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.
- strsock-LiS-lib-0.9.2.4-1.7.2.i686.rpm
- strsock-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 Sockets.
- /usr/share/locale
- This relocatable directory contains the locale information for shared library
files.
- strsock-source-0.9.2.4-1.7.2.i686.rpm
-
- /usr/src
- This relocatable directory contains the source code.
- strsock-LiS-util-0.9.2.4-1.7.2.i686.rpm
- strsock-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.
6.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.
6.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
strsock 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.
6.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.
6.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.
6.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 Sockets 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 strsock symbols. Specifies whether kernel symbol
versions are to be used on symbols exported from built strsock 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.
6.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.
6.3.5.3 Build
To build from the tar ball, See Building from the Tar Ball.
6.4 Building
6.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/strsock-0.9.2.4-1.src.rpm
% rpmbuild --rebuild -vv strsock-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 -- strsock-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.
6.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/strsock_0.9.2.4-0.dsc
% wget http://www.openss7.org/debian/strsock_0.9.2.4-0.tar.gz
% dpkg-buildpackage -v strsock_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 \
strsock_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.
6.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.)
6.4.3.1 Native Build
Following is an example of a native build against the running kernel:
% wget http://www.openss7.org/strsock-0.9.2.4.tar.bz2
% tar -xjvf strsock-0.9.2.4.tar.bz2
% pushd strsock-0.9.2.4
% ./configure
% make
% popd
|
6.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/strsock-0.9.2.4.tar.bz2
% tar -xjvf strsock-0.9.2.4.tar.bz2
% pushd strsock-0.9.2.4
% ./configure DESTDIR="/some/other/root" \
--with-k-release=2.4.18 --host sparc-linux
% make
% popd
|
6.5 Installing
6.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 strsock-*-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' \
-- strsock-doc-0.9.2.4-1.7.2.i686.rpm
|
The previous example will install the strsock-doc package by will relocate the
documentation an info directory contents to the /usr/local version.
6.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 strsock-*_0.9.2.4-0_*.deb
|
You must have the correct .deb files downloaded or build for this to be successful.
6.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.
6.6 Removing
6.6.1 Removing the Binary R