This is Edition 7.20141001, last updated 2014-10-25, of The Linux Fast-STREAMS Porting Guide, for Version 1.1 release 7.20141001 of the OpenSS7 package.
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, the Linux Kernel Community, and the open source software movement at large.
Funding for completion of the OpenSS7 OpenSS7 package was provided in part by:
| • | Monavacon Limited | |
| • | OpenSS7 Corporation |
Additional funding for The OpenSS7 Project was provided by:
The primary contributor to the OpenSS7 OpenSS7 package is Brian F. G. Bidulock. The following is a list of notable contributors to The OpenSS7 Project:
| - Per Berquist | - Kutluk Testicioglu | ||
| - John Boyd | - John Wenker | ||
| - Chuck Winters | - Angel Diaz | ||
| - Peter Courtney | - Jérémy Compostella | ||
| - Tom Chandler | - Sylvain Chouleur | ||
| - Gurol Ackman | - Christophe Nolibos | ||
| - Pierre Crepieux | - Bryan Shupe | ||
| - Christopher Lydick | - D. Milanovic | ||
| - Omer Tunali | - Tony Abo | ||
| - John Hodgkinson | - Others |
Over the years a number of organizations have provided continued support in the form of assessment, inspection, testing, validation and certification.
| • | IEEE Computer Society | • | Ateb | ||
| • | ENST 4 | • | Mandexin Systems Corporation | ||
| • | HTW-Saarland 5 | ||||
| • | Kansas State University | • | Areva NP | ||
| • | University of North Carolina Charlotte | • | European Organization for Nuclear Research |
It would be difficult for the OpenSS7 Project to attain the conformance and certifications that it has without the free availability of specifications documents and standards from standards bodies and industry associations. In particular, the following:
Of these, ICAO, ISO, IEEE and EIA have made at least some documents publicly available. ANSI is notably missing from the list: at one time draft documents were available from ANSI (ATIS), but that was curtailed some years ago. Telecordia does not release any standards publicly. Hopefully these organizations will see the light and realize, as the others have, that to remain current as a standards organization in today’s digital economy requires providing individuals with free access to documents.
Although each of the manual pages of supported functions and structures provides compatibility and porting information, this document attempts to gather together pertinent information concerning porting from various UNIX operating system supporting STREAMS.
The porting information is organized by the operating system from which porting is being attempted. Note that, aside from configuration details, any system not listed here that is based on SVR 4.2 MP or on a another of the implementations, should start with that implementation’s portability information.
Porting information is organized into sections as follows:
OpenSS7 provides a complete set of base functions and utilities for STREAMS as defined in the SVR 4 Programmer’s Guide – STREAMS. These are the base set of functions with which the STREAMS module and driver writer is familiar.
OpenSS7 performs stricter message block, data block and
buffer alignment than most STREAMS implementations to maintain maximum
compatibility with other implementations. Message blocks, data blocks and data
buffers are always aligned at least to an SMP cache boundary, permitting DMA of
message blocks, data blocks and data buffers. ISA DMA capability is not ensured
for message blocks or data blocks, however, external data buffers can be so
allocated with Linux allocators and attached to a message and data buffer
with esballoc(9).
Data buffers of size less than the value FASTBUF are allocated of size FASTBUF and are internal to the data block. A FASTBUF is at least 64-bytes on 32-bit architectures and at least 128-bytes on 64-bit architectures. Internal data buffers of size FASTBUF are aligned to a 64-byte boundary on 32-bit architecture and to a 128-byte boundary on 64-bit architectures.
Data buffers of larger than a FASTBUF are allocated using general purpose
Linux allocators (i.e. kmem_alloc(9)). Linux always
allocates a memory extent of a power of two in size that fits the requested
number of bytes and always aligns the memory extent to the memory boundary that
is the same power of two as the resulting size. This is stricter in alignment
than the description of most UNIX memory allocators.
OpenSS7 also supports the BPRI_WAITOK priority to
allocb(9) that will allocate memory block, data block and data
buffer using KM_SLEEP and will block the calling process if either memory
block, data block or data buffer are not immediately available.
Following are the basic STREAMS message functions. Most portability issues concerning STREAMS message functions have to do with allocation, alignment of the data buffer, priority of allocation, disposition of unused message blocks, handling of NULL pointer arguments, buffer callback and message free routine handling.
adjmsg(9)Trim bytes from the front or back of a STREAMS message. Trimmed message blocks are not freed but simply have their b_wptr set to their b_rptr.
allocb(9)Allocate a STREAMS message and data block. This function also accepts the BPRI_WAITOK flag which allocates all parts of the message 3-tuple using KM_SLEEP allocation. Allocation of less than FASTBUF bytes will allocate a data buffer of size FASTBUF. FASTBUF sized data buffers are internal to the data block, and message block, data block and data buffer 3-types are allocated as a unit for speed. Data buffers are allocated on a memory boundary that is the same as the next power of two sized buffer.
bufcall(9)Install a buffer callback. OpenSS7 provides the additional assurance that the callback routine will not be called until the caller returns from the calling function block.
copyb(9)Copy a STREAMS message block. A NULL pointer passed as an argument will panic the kernel.
copymsg(9)Copy a STREAMS message. Performs a block-wise copy using copyb(9).
datamsg(9)Tests a STREAMS message type for data.
dupb(9)Duplicate a STREAMS message block. OpenSS7 uses a global lock to protect the db_refs member of the data block.
dupmsg(9)Duplicate a STREAMS message. Performs a block-wise duplication using dupb(9).
esballoc(9)Allocate a STREAMS message and data block with a caller supplied data buffer. This is the most portable method of allocating a data buffer that requires some particular alignment. The callback free routine is inherently unsafe when the function is provided by a module and modules are permitted to unload.
freeb(9)Frees a STREAMS message block.
freemsg(9)Frees a STREAMS message. Performs a block-wise free using freeb(9).
linkb(9)Link a message block to a STREAMS message. Panics if either argument is NULL.
msgdsize(9)Calculate the size of the data in a STREAMS message. Accepts a NULL pointer, in which case the function returns zero (‘0’).
msgpullup(9)Pull up bytes in a STREAMS message. Might allocate a new message to satisfy the request.
pcmsg(9)Test a data block message type for priority control.
pullupmsg(9)Pull up the bytes in a STREAMS message. Does not allocate a new initial message block, but may allocate a new initial data block and data buffer. The pointers ‘mp->b_wptr’ and ‘mp->b_rptr’ are potentially invalidated by the call.
rmvb(9)Remove a message block from a STREAMS message. The message block must exist in the message. Passing NULL pointers will panic the kernel.
testb(9)Test if a STREAMS message can be allocated. Because the test is not atomic, when this
function returns true, a subsequent call to allocb(9) could still fail.
unbufcall(9)Remove a STREAMS buffer callback. OpenSS7 provides the SVR 4 assurance that before the call returns the callback function will either have been cancelled or execution of the callback will be complete.
unlinkb(9)Unlink a message block from a STREAMS message.
Single processor queue functions are those functions that existed in SVR 4 before multi-processor support was added in SVR 4.1 MP and SVR 4.2. Most portability issues associated with these functions concern queue q_next pointer dereferencing and freezing of Streams when directly manipulating queues. OpenSS7 provides the added assurance that q_next pointers can always be reliably dereferenced from within a queue put, service, open, close or synchronized callback procedure.
backq(9)Find the upstream or downstream queue. OpenSS7 protects this pointer dereference when called from within a put, service, open, close or callback procedure.
bcanput(9)Test flow control on a STREAMS message queue. OpenSS7 follows SVR 4 semantics for queue enabling, queue flags and back-enabling.
canenable(9)Test whether a STREAMS message queue can be scheduled. This only effects normal priority messages as per SVR 4 semantics.
enableok(9)Allow a STREAMS message queue to be scheduled. This only effects normal priority messages as per SVR 4 semantics.
flushband(9)Flushes band STREAMS messages from a message queue. OpenSS7 provides a mechanism that efficiently flushes large numbers of messages from a queue: messages are unlinked from the queue and freed later by the STREAMS scheduler.
flushq(9)Flushes messages from a STREAMS message queue. OpenSS7 provides a mechanism that efficiently flushes large numbers of messages from a queue: messages are unlinked from the queue and freed later by the STREAMS scheduler.
getq(9)Gets a message from a STREAMS message queue. OpenSS7 follows SVR 4 semantics for queue enabling, queue flags and back-enabling.
insq(9)Inserts a message into a STREAMS message queue.
OpenSS7 recommends, but does not require, that the Stream
be first frozen by the caller with a call to
freezestr(9).6
noenable(9)Disable a STREAMS message queue from being scheduled. This only effects normal priority messages as per SVR 4 semantics.
OTHERQ(9)Return the other queue of a STREAMS queue pair.
putbq(9)Put a message back on a STREAMS message queue. OpenSS7 follows SVR 4 semantics for queue enabling, queue flags and back-enabling.
putctl(9)Put a control message on a STREAMS message queue.
putctl1(9)Put a 1 byte control message on a STREAMS message queue.
putq(9)Put a message on a STREAMS message queue. OpenSS7 follows SVR 4 semantics for queue enabling, queue flags and back-enabling.
qenable(9)Schedules a STREAMS message queue service routine.
qreply(9)Replies to a message from a STREAMS message queue.
qsize(9)Return the number of messages on a queue.
RD(9)Return the read queue of a STREAMS queue pair. Although
OpenSS7 accepts a read queue pointer as an argument, doing
so could panic some implementations. The macro _RD(9) is also
provided that has this stricter behaviour.
rmvq(9)Remove a message from a STREAMS message queue.
OpenSS7 recommends, but does not require, that the Stream
be first frozen by the caller with a call to
freezestr(9).7
SAMESTR(9)Test for STREAMS pipe or fifo.
WR(9)Return the write queue of a STREAMS queue pair. Although
OpenSS7 accepts a write queue pointer as an argument, doing
so could panic some implementations. The macro _WR(9) is also
provided that has this stricter behaviour.
When multiprocessing support was added to STREAMS in SVR 4.1 MP and SVR 4.2, it became necessary to enhance the STREAMS interface with a number of additional functions intended on easing multiprocessor implementation of STREAMS. Most portability issues with functions in this category involve queue pointer dereferencing, and queue manipulation.
OpenSS7 provides stronger assurances for q_next pointer dereferencing that are experienced on most other STREAMS implementations, to maintain maximum compatibility. OpenSS7 acquires a Stream head plumbing read lock before entering queue put, service, open, close and queue synchronous callback procedures within the Stream. This means that a function call such as ‘canput(q->q_next)’ and ‘canputnext(q)’ have identical effect within the synchronous procedure.
bcanputnext(9)Test flow control on a message queue.
OpenSS7 ensures the validity of q_next pointer
dereferencing for any queue in the queue pair for which a queue put, service,
open, close or synchronized callback procedure is the context of the
dereference. For other q_next dereferences (e.g. at a Stream end or
across a multiplexing driver), the bcanputnext(9) utility should
be used instead of the bcanput(9) utility. ‘bcanputnext(q,
band)’ should always be preferred over ‘bcanput(q->q_next, band)’.
canputnext(9)Test flow control on a message queue.
OpenSS7 ensures the validity of q_next pointer
dereferencing for any queue in the queue pair for which a queue put, service,
open, close or synchronized callback procedure is the context of the
dereference. For other q_next dereferences (e.g. at a Stream end or
across a multiplexing driver), the canputnext(9) utility should be
used instead of the canput(9) utility. ‘canputnext(q)’
should always be preferred over ‘canput(q->q_next)’.
freezestr(9)Freeze the state of a stream queue.
freezestr(9) was provided in the MP environment to behave in the
same fashion as spl(9) did in the UP environment. In the UP
environment it was a simply matter to suppress interrupts before directly
manipulating queue structures and then re-enable interrupts after queue
manipulation was complete.
put(9)Invoke the put procedure for a STREAMS module or driver with a STREAMS message.
In the UP environment, the queue at a Stream end could be called directly such
as ‘(*q->q_qinfo->qi_putp)(q, mp)’. In the MP environment, this would
circumvent the STREAMS synchronization model and the put(9)
utility function should be used instead.
putnext(9)Put a message on the downstream STREAMS message queue.
In the UP environment, the adjacent queue put procedure could be called directly
such as ‘(*q->q_next->q_qinfo->qi_putp)(q, mp)’. In the MP environment,
this would circumvent the STREAMS synchronization model and the
putnext(9) utility function should be used instead.
‘putnext(q, mp)’ should always be used in preference to
‘put(q->q_next, mp)’.
putnextctl1(9)Put a 1 byte control message on the downstream STREAMS message queue.
A q_next pointer dereferencing version of putctl1(9).
‘putnextctl1(q, type, param)’ should always be used in preference to
‘putctl1(q->q_next, type, param)’.
putnextctl(9)Put a control message on the downstream STREAMS message queue.
A q_next pointer dereferencing version of putctl(9).
‘putnextctl(q, type)’ should always be used in preference to
‘putctl(q->q_next, type)’.
qprocsoff(9)Disables STREAMS message queue processing for multi-processing.
qprocson(9)Enables STREAMS message queue processing for multi-processing.
In the UP environment, it was possible to prepare the queue service and put
procedures for proper operation before returning and permitting the queue to run
put or service procedures. In the MP environment, it became necessary to
indicate within the open procedure when queue procedures are to be permitted to
run before returning (or blocking). qprocson(9) was added to
accomplish this. SVR 4 says that this function must be cause before
returning from the queue open routine. OpenSS7 will invoke
the function implicitly if it is not called before the queue open routine
returns (but must still be called explicitly if the queue open routine blocks
awaiting an event on the queue).
strqget(9)Gets information about a STREAMS message queue.
In the UP environment, it was possible to directly manipulate streamtab or queue
structures after suppressing interrupts. The strqget(9) utility
provides a mechanism for manipulating these structures in the MP environment.
Some implementations conflict on whether a Stream must first be frozen with
freezestr(9) or not. OpenSS7 recommends that
the Stream be frozen across a call to strqget(9), but it is not
required.
strqset(9)Sets attributes of a STREAMS message queue.
In the UP environment, it was possible to directly manipulate streamtab or queue
structures after suppressing interrupts. The strqset(9) utility
provides a mechanism for manipulating these structures in the MP environment.
Some implementations conflict on whether a Stream must first be frozen with
freezestr(9) or not. OpenSS7 recommends that
the Stream be frozen across a call to strqset(9), but it is not
required.
unfreezestr(9)Thaw the state of a stream queue.
unfreezestr(9) was provided in the MP environment to behave in the
same fashion as splx(9) did in the UP environment.
Traditionally, SVR 4 provided some DDI/DKI (Device Driver Interface/Driver Kernel Interface) functions for use by device drivers, including STREAMS device drivers. Many of these function have survived into kernel/driver interfaces today in one form or another. Some implementations (particularly Solaris®) provide a wide array of additional DDI/DKI functions. Additional functions are supported by Compatibility Modules, and the base SVR 4 functions are provided by the base OpenSS7 package.
kmem_alloc(9)Allocate kernel memory.
kmem_free(9)Deallocates kernel memory.
kmem_zalloc(9)Allocate and zero kernel memory.
cmn_err(9)Print a kernel command error.
bcopy(9)Copy byte strings.
This is the basic BSD-style function for copying bytes. Traditionally STREAMS has used the
BSD-style function bcopy(9) instead of the SVR3-style
memcpy(9).8
bzero(9)Zero a byte string.
This is the basic BSD-style function for zeroing bytes. Traditionally STREAMS has used the
BSD-style function bzero(9) instead of the SVR3-style
memset(9).9
copyin(9)Copy user data in from user space to kernel space. In the UP environment, the top module put procedure was called in user context and it was possible to copy bytes directly from the user and block in this context. In the MP environment and with an MP STREAMS synchronization model, the top module put procedure could be called outside of the Stream head user context. Therefore, this function has little use under STREAMS.
copyout(9)Copy user data in from kernel space to user space. In the UP environment, the top module put procedure was called in user context and it was possible to copy bytes directly to the user and block in this context. In the MP environment and with an MP STREAMS synchronization model, the top module put procedure could be called outside of the Stream head user context. Therefore, this function has little use under STREAMS.
delay(9)Postpone the calling process for a number of clock ticks.
drv_getparm(9)Driver retrieve kernel parameter.
drv_hztomsec(9)Convert kernel tick time between microseconds or milliseconds.
drv_htztousec(9)Convert kernel tick time between microseconds or milliseconds.
drv_msectohz(9)Convert kernel tick time between microseconds or milliseconds.
drv_priv(9)Check if the current process is privileged.
drv_usectohz(9)Convert kernel tick time between microseconds or milliseconds.
drv_usecwait(9)Delay for a number of microseconds.
min(9)Determine the minimum of two integers.
max(9)Determine the maximum of two integers.
getmajor(9)Get the internal major device number for a device.
getminor(9)Get the extended minor device number for a device.
makedevice(9)Create a device from a major and minor device numbers.
strlog(9)Pass a message to the STREAMS logger.
timeout(9)Start a timer.
Although general purpose in nature, the timeout(9) and untimeout(9)
utilities were most often used for STREAMS modules and drivers. Some implementations only
support these functions for STREAMS.
untimeout(9)Stop a timer.
Although general purpose in nature, the timeout(9) and untimeout(9)
utilities were most often used for STREAMS modules and drivers. Some implementations only
support these functions for STREAMS.
mknod(9)Make block or character special files.
mount(9)Mount and unmount file systems.
umount(9)Mount and unmount file systems.
unlink(9)Remove a file.
One of the most common extension functions is the ability to put a control
message with two bytes as parameters. At some point the
M_ERROR(9) message was extended to include a separate error code
for the Stream head write and read side. Also, at some point the
M_FLUSH(9) message was extended to include a band number as well
as a flag byte. putctl2(9) and putnextctl2(9) were
provided to accept and generate two arguments instead of one as their
putctl1(9) and putnextctl1(9) counterparts provide.
OpenSS7 supports these functions as part of the base
package.
Another common extension of OSF/1 or Mentat derived STREAMS
implementations is the ability to weld two queues together in pipe- or FIFO-like
arrangements while maintaining queue synchronization. The two utilities
weldq(9) and unweldq(9) were often included to
provide this facility. OpenSS7 supports these functions as
part of the base package.
linkmsg(9)Link a message block to a STREAMS message.
putctl2(9)Put a two byte control message on a STREAMS message queue.
putnextctl2(9)Put a two byte control message on the downstream STREAMS message queue.
weldq(9)Weld two (or four) queues together.
unweldq(9)Unweld two (or four) queues.
OpenSS7 exposes some internal STREAMS functions that
are exposed by many STREAMS implementations but which are not documented
as available to the STREAMS module and driver writer. These functions are
exposed for the purpose of compatibility with other implementations as well as
providing some functions that are necessary to implement enhanced Stream heads,
specialized drivers or modules such as the clone(4) driver or
connld(4) module.
Following are some of the exposed functions that are typically exposed by other STREAMS implementations as well:
allocq(9)Allocate a STREAMS queue pair.
bcanget(9)Test for message arrival on a band on a stream.
canget(9)Test for message arrival on a stream.
freeq(9)Deallocate a STREAMS queue pair.
qattach(9)Attach a module onto a STREAMS file.
qclose(9)Close a STREAMS module or driver.
qdetach(9)Detach a module from a STREAMS file.
qopen(9)Call a STREAMS module or driver open routine.
setq(9)Set sizes and procedures associated with a STREAMS message queue.
appq(9)Append one STREAMS message after another.
esbbcall(9)Install a buffer callback for an extended STREAMS message block.
isdatablk(9)Test a STREAMS data block for data type.
isdatamsg(9)Test a STREAMS data block for data type.
kmem_zalloc_node(9)Allocate and zero a NUMA memory extent.
msgsize(9)Calculate the size of the message blocks in a STREAMS message.
qcountstrm(9)Add all counts on all STREAMS message queues in a stream.
xmsgsize(9)Calculate the size of message blocks in a STREAMS message.
Detailed portability information for porting STREAMS modules and drivers
from SVR 3.2 to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
svr3compat(9) manual page. The STREAMS Compatibility
Modules package also provides some SVR 3.2 specific compatibility
functions.
This section captures portability information for SVR 3.2 based systems. If the operating system from which you are porting more closely fits one of the other portability sections, please see that section.
For the most part, porting from SVR 3.2 to OpenSS7 is not much different than porting forward from SVR 3.2 to SVR 4.2 MP. If you wish to be able to access some backward compatible SVR 3.2 functions, use the SVR 3 Compatibility Module from the strcompat package.
Therefore, it is recommended that STREAMS modules and drivers for SVR 3.2 be ported forward to SVR 4.2 MP before being ported to OpenSS7.
The most significant different in SVR 3.2 and SVR 4 was the declaration of the queue open and close routine entry points. Some STREAMS implementations still support both SVR 3.2 entry point declarations as well as SVR 4 entry point declarations. OpenSS7 only supports the SVR 4 style entry points.
SVR 3.2 was not MP-safe. OpenSS7 is MP-safe.
A significant number of utilities were implemented in SVR 3.2 as architecture dependent macros. In SVR 4 these became architecture independent function calls.
In general, OpenSS7 is different from SVR 3.2 in any way that SVR 3.2 is different from SVR 4.2 MP.
In general, most of the STREAMS utility functions that were present in SVR 3.2 also made it into SVR 4 (with few exceptions). SVR 3.2 did not yet have the concept of a DDI/DKI, but the STREAMS functions present in SVR 3.2 appear in the SVR 4.2 MP DDI/DKI.
alloc_proto(9)Allocate control and data message blocks.
emajor(9)Get the external (real) major device number from the device number.
eminor(9)Get the external extended minor device number from the device number.
I have never seen a description of SVR 3.2 STREAMS configuration. I can only assume that it involved relinking the kernel in some fashion.
Detailed portability information for porting STREAMS modules and drivers
from SVR 4.2 MP to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
svr4compat(9) manual page. The STREAMS Compatibility
Modules package also provides some SVR 4.2 MP specific compatibility
functions.
This section captures portability information for SVR 4.2 MP based systems. If the operating system from which you are porting more closely fits one of the other portability sections, please see that section.
OpenSS7 has very few differences from SVR 4.2 MP. Not all SVR 4.2 MP functions are implemented in the base OpenSS7 kernel modules. Some functions are included in the SVR 4.2 MP Compatibility Module (streams_svr4compat.ko) from the strcompat package.
Linux has a different concept of priority levels than SVR 4.2 MP. Linux has basically 4 priority levels as follows:
At this priority level, software and hardware interrupts are enabled and the kernel is executing with preemption enabled. This means that the currently executing kernel thread could preempt and sleep in favour of another thread of kernel execution.
This priority level only exists on preemptive (mostly 2.6 and 3.x) kernels.
At this priority level, software and hardware interrupts are enabled and the kernel is executing with preemption disabled. This means that the currently executing kernel thread will only be interrupted by software or hardware interrupts.
This priority level exists in all kernels.
At this priority level, software interrupts are disabled and the kernel is executing with preemption disabled. This means that the currently executing kernel thread will only be interrupted by hardware interrupts.
This is the case when the executing thread is processing a software interrupt, or when the currently executing thread has disabled software interrupts.
This priority level exists in all kernels.
At this priority level, hardware interrupts are disabled and the kernel is executing with preemption disabled. This means that the currently executing kernel thread will not be interrupted.
This is the case when the executing thread is processing a hardware interrupt, or when the currently executing thread has disabled hardware interrupts.
This priority level exists in all kernels.
STREAMS locks are those that are mentioned in the SVR 4 Programmer’s Guide – STREAMS. These locks lock a queue or Stream head for exclusive access. OpenSS7 implements queue and Stream head locks as read-write locks, so these locks translate to taking a write lock on the queue or Stream head. These locks are not normally used by STREAMS modules and drivers and are therefore left in the SVR 4.2 MP Compatibility Module, streams_svr4compat.ko, from the STREAMS Compatibility Modules package, strcompat.
MPSTR_QLOCK(9)Release a queue from exclusive access.
MPSTR_QRELE(9)Acquire a queue for exclusive access.
MPSTR_STPLOCK(9)Acquire a stream head for exclusive access.
MPSTR_STPRELE(9)Release a stream head from exclusive access.
Basic locks are similar to Linux spin locks and can be used as an ABI replacement for Linux spin locks. It is rather typical for OpenSS7 Project STREAMS modules and drivers to use Linux spin locks directly instead of via these functions. Therefore these locks are left in the SVR 4.2 MP Compatibility Module, streams_svr4compat.ko, from the STREAMS Compatibility Modules package, strcompat.
LOCK(9)Lock a basic lock.
LOCK_ALLOC(9)Allocate a basic lock.
LOCK_DEALLOC(9)Deallocate a basic lock.
LOCK_OWNED(9)Determine whether a basic lock is head by the caller.
TRYLOCK(9)Try to lock a basic lock.
UNLOCK(9)Unlock a basic lock.
Read-write locks are similar to Linux read-write locks and can be used as an ABI replacement for Linux read-write locks.
RW_ALLOC(9)Allocate and initialize a read/write lock.
RW_DEALLOC(9)Deallocate a read/write lock.
RW_RDLOCK(9)Acquire a read/write lock in read mode.
RW_TRYRDLOCK(9)Attempt to acquire a read/write lock in read mode.
RW_TRYWRLOCK(9)Attempt to acquire a read/write lock in write mode.
RW_UNLOCK(9)Release a read/write lock.
RW_WRLOCK(9)Acquire a read/write lock in write mode.
Sleep locks are similar to Linux semaphores or mutexes.
SLEEP_ALLOC(9)Allocate a sleep lock.
SLEEP_DEALLOC(9)Deallocate a sleep lock.
SLEEP_LOCK(9)Acquire a sleep lock.
SLEEP_LOCKAVAIL(9)Determine whether a sleep lock is available.
SLEEP_LOCKOWNED(9)Determine whether a sleep lock is held by the caller.
SLEEP_LOCK_SIG(9)Acquire a sleep lock.
SLEEP_TRYLOCK(9)Attempt to acquire a sleep lock.
SLEEP_UNLOCK(9)Release a sleep lock.
Synchronization variables are similar to Linux wait queues.
SV_ALLOC(9)Allocate a basic condition variable.
SV_BROADCAST(9)Broadcast a basic condition variable.
SV_DEALLOC(9)Deallocate a basic condition variable.
SV_SIGNAL(9)Signal a basic condition variable.
SV_WAIT(9)Wait on a basic condition variable.
SV_WAIT_SIG(9)Interruptible wait on a basic condition variable.
Atomic Integers are similar to Linux atomic integers.
ATOMIC_INT_ADD(9)Add an integer value to an atomic integer.
ATOMIC_INT_ALLOC(9)Allocate and initalize an atomic integer.
ATOMIC_INT_DEALLOC(9)Deallocate an atomic integer.
ATOMIC_INT_DECR(9)Decrement and test an atomic integer.
ATOMIC_INT_INCR(9)Increment an atomic integer.
ATOMIC_INT_INIT(9)Initialize an atomic integer.
ATOMIC_INT_READ(9)Read an atomic integer.
ATOMIC_INT_SUB(9)Subtract and integer value from an atomic integer.
ATOMIC_INT_WRITE(9)Write an integer value to an atomic integer.
Processor levels are similar to Linux local irq or soft irq suppression.
spl0(9)Set priority level 0.
spl1(9)Set priority level 1.
spl2(9)Set priority level 2.
spl3(9)Set priority level 3.
spl4(9)Set priority level 4.
spl5(9)Set priority level 5.
spl6(9)Set priority level 6.
spl7(9)Set priority level 7.
spl(9)Set priority level.
splx(9)Set priority level x.
itimeout(9)Perform a timeout at an interrupt level.
lbolt(9)Time in ticks since reboot.
major(9)Get the internal major number of a device.
makedev(9)Make a device number from internal major and minor device numbers.
minor(9)Get the internal minor number of a device.
sleep(9)Put a process to sleep.
vtop(9)Convert virtual to physical address.
wakeup(9)Wake a process.
Detailed portability information for porting STREAMS modules and drivers
from AIX to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
aixcompat(9) manual page. The STREAMS Compatibility
Modules package also provides some AIX specific compatibility
functions.
Most of the STREAMS functions and DDI/DKI functions provided by AIX® are also provided by the OpenSS7 base package. Some utilities, however, are provided by the AIX Compatibility Module (streams_aixcompat.ko) from the STREAMS Compatibility Module package (strcompat).
The compatibility functions described below are described in the STREAMS module and driver documentation for AIX. Some of these functions are provided also with other implementations (such as OSF/1 or Mentat).
The following functions are typically also provided by most STREAMS implementations:
putctl2(9)Put a 2 byte control message on a STREAMS.
splstr(9)Set processor level for STREAMS.
splx(9)Set or restore processor level.
unweldq(9)Unweld two pairs of streams queues.
weldq(9)Weld together two pairs of streams queues.
The following functions are really just Mentat Portable STREAMS functions that made their way into AIX: (Portability considerations for Mentat Portable STREAMS functions is described in.)
mi_bufcall(9)Reliable alternative to buffcall(9).
This is really just a Mentat Portable STREAMS function that made
its way into AIX.
mi_close_comm(9)STREAMS common minor device close utility. This is really just a Mentat Portable STREAMS function that made its way into AIX.
mi_next_ptr(9)STREAMS minor device list traversal. This is really just a Mentat Portable STREAMS function that made its way into AIX.
mi_open_comm(9)STREAMS common minor device open utility. This is really just a Mentat Portable STREAMS function that made its way into AIX.
mi_prev_ptr(9)STREAMS minor device list traversal. This is really just a Mentat Portable STREAMS function that made its way into AIX.
The following functions are unique to AIX:
In particular, the wantio(9) and wantmsg(9)
facilities are incredibly convoluted and complex and only documented by
AIX. Although OpenSS7 implements these functions
(in the AIX Compatibility Module, streams_aixcompat.ko, from the
STREAMS Compatibility Module package, strcompat) as faithfully as
possible, their use should be completely avoided by portable programs.
wantio(9)Perform direct I/O from a STREAMS driver.
wantmsg(9)Provide a filter of wanted messages from a STREAMS module.
str_install(9)Install a STREAMS module or driver. Each implementation has a different mechanism for registration and deregistration of STREAMS modules and drivers. This is the mechanism used by AIX. It should be avoided by programs that are not being ported from AIX. AIX-style STREAMS registration and deregistration is implemented in the AIX Compatibility Module, streams_aixcompat.ko, from the STREAMS Compatibility Module package, strcompat.
Detailed portability information for porting STREAMS modules and drivers
from HP-UX to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
hpuxcompat(9) manual page. The STREAMS Compatibility
Modules package also provides some HP-UX specific compatibility
functions.
HP-UX stubs out the qprocson(9),
qprocsoff(9), freezestr(9) and
unfreezestr(9) utility functions. HP-UX expects that the
appropriate level of synchronization be used instead.10 Because of this, it is recommended that
HP-UX drivers and modules port directly to the
OpenSS7 environment, not be run at synchronization level
SQLVL_NOP. See str_install_HPUX(9).
The following compatibility functions are typical extensions and are also provided by the OpenSS7 base package:
putctl2(9)put a 2 byte control message on a STREAMS message queue
putnextctl2(9)put a 2 byte control message on the downstream STREAMS message queue
unweldq(9)unweld two pairs of streams queues
weldq(9)weld together two pairs of streams queues
The following compatibility functions are peculiar to HP-UX11 and are only part of the HP-UX compatibility module, streams_hpuxcompat.ko, from the STREAMS Compatibility Modules, strcompat, package:
get_sleep_lock(9)Provide access to the global sleep lock.
streams_get_sleep_lock(9)Provide access to the global sleep lock.
streams_mpsleep(9)Put a process to sleep.
streams_put(9)Invoke the put procedure for a STREAMS module or driver with a STREAMS message.
Installation, registration and deregistration of STREAMS modules and drivers is one of the least standardized mechanisms across the various STREAMS implementations. Each implementation has its own mechanism and HP-UX is no different. The following compatibility functions provide the HP-UX specific STREAMS driver installation, registration and deregistration style:
str_install(9)Install a STREAMS module or driver.
str_uninstall(9)Uninstall a STREAMS module or driver.
Detailed portability information for porting STREAMS modules and drivers
from OSF/1 to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
osfcompat(9) manual page. The STREAMS Compatibility
Modules package also provides some OSF/1 specific compatibility
functions.
unweldq(9)Unweld two pairs of streams queues.
weldq(9)Weld together two pairs of streams queues.
lbolt(9)Time in ticks since reboot.
puthere(9)Invoke the put procedure for a STREAMS module or driver with a STREAMS message.
streams_close_comm(9)Common minor device close utility.
streams_open_comm(9)Common minor device open utility.
streams_open_ocomm(9)Common minor device open utility.
time(9)(undoc)
strmod_add(9)Add a STREAMS module.
strmod_del(9)Delete a STREAMS module or driver from the kernel.
Detailed portability information for porting STREAMS modules and drivers
from UnixWare to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
uw7compat(9) manual page. The STREAMS Compatibility
Modules package also provides some UnixWare specific compatibility
functions.
The following compatibility functions are in addition to all SVR 4.2 compatibility functions.
allocb_physreq(9)Allocate a STREAMS message and data block.
emajor(9)Get the external (real) major device number from the device number.
eminor(9)Get the external extended minor device number from the device number.
etoimajor(9)Convert an external major device number to an internal major device number.
getemajor(9)Get the external (real) major device number.
geteminor(9)Get the external minor device number.
itoemajor(9)Convert an internal major device number to an external major device number.
msgphysreq(9)Cause a message block to meet physical requirements.
msgpullup_physreq(9)Pull up bytes in a STREAMS message.
msgscgth(9)(undoc)
strioccall(9)(undoc)
Detailed portability information for porting STREAMS modules and drivers
from Solaris to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
suncompat(9) manual page. The STREAMS Compatibility
Modules package also provides some Solaris specific compatibility
functions.
ddi_create_minor_node(9)Create a minor node for this device.
ddi_driver_major(9)Find the major device number associated with a driver.
ddi_driver_name(9)Return normalized driver name.
ddi_get_cred(9)Get a reference to the credentials of the current user.
ddi_getiminor(9)ddi_get_instance(9)Get device instance number.
ddi_get_lbolt(9)Get the current value of the system tick clock.
ddi_get_pid(9)ddi_get_soft_state(9)ddi_get_time(9)Get the current time in seconds since the epoch.
ddi_remove_minor_node(9)Remove a minor node for a device.
ddi_removing_power(9)ddi_soft_state(9)ddi_soft_state_fini(9)ddi_soft_state_free(9)ddi_soft_state_init(9)ddi_soft_state_zalloc(9)ddi_umem_alloc(9)Allocate page aligned kernel memory.
ddi_umem_free(9)power(9)Power a device attached to the system.
probe(9)qbufcall(9)Install a buffer callback.
qtimeout(9)Start a timer associated with a queue.
queclass(9)qunbufcall(9)quntimeout(9)qwait(9)Wait for a queue message.
qwait_sig(9)Wait for a queue message or signal.
qwriter(9)_fini(9)_info(9)_init(9)attach(9)Attach a device to the system or resume a suspended device.
detach(9)Detach a device from the system or suspend a device.
getinfo(9)identify(9)Determine if a driver is associated with a device.
install_driver(9)Install a device driver.
mod_info(9)Provides information on a loadable kernel module to the STREAMS executive.
mod_install(9)Installs a loadable kernel module in the STREAMS executive.
mod_remove(9)Removes a loadable module from the STREAMS executive.
Detailed portability information for porting STREAMS modules and drivers
from SUPER-UX to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
suxcompat(9) manual page. The STREAMS Compatibility
Modules package also provides some SUPER-UX specific compatibility
functions.
lbolt(9)Time in ticks since reboot.
Detailed portability information for porting STREAMS modules and drivers
from UXP/V to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
uxpcompat(9) manual page. The STREAMS Compatibility
Modules package also provides some UXP/V specific compatibility
functions.
Detailed portability information for porting STREAMS modules and drivers
from Mac Open Transport to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
maccompat(9) manual page. The STREAMS Compatibility
Modules package also provides some Mac Open Transport specific compatibility
functions.
Detailed portability information for porting STREAMS modules and drivers
from Mentat Portable STREAMS to OpenSS7 is contained the the
STREAMS Compatibility Modules package, strcompat, under the
mpscompat(9) manual page. The STREAMS Compatibility
Modules package also provides some Mentat Portable STREAMS specific compatibility
functions.
mi_alloc(9)Allocate and free kernel memory without later regard to size.
mi_allocq(9)allocq(9) replacement.
mi_alloc_sleep(9)kmem_alloc(9) replacement.
mi_attach(9)Associate instance data with a STREAMS queue.
mi_bcmp(9)bcmp(9) replacement.
mi_bufcall(9)Reliable alternative to bufcall(9).
mi_close_comm(9)STREAMS common minor device close utility.
mi_close_detached(9)Release instance data from the STREAMS queue and perform close cleanup.
mi_close_free(9)Free a STREAMS driver or module instance on close.
mi_copy_done(9)ioctl(2s) complete.
mi_copyin(9)Copy data to a user buffer.
mi_copyin_n(9)Copy data to a user buffer.
mi_copyout(9)Copy data from a user buffer.
mi_copyout_alloc(9)Allocate a buffer to be copied out using mi_copyout(9).
mi_copy_set_rval(9)Set return value for input-output control.
mi_copy_state(9)Current state of the input-output control process.
mi_detach(9)Disassociate instance data from the STREAMS queue.
mi_first_dev_ptr(9)Obtain first device instance pointer.
mi_first_ptr(9)Obtain first instance pointer.
mi_free(9)kmem_free(9) replacement.
mi_freeq(9)freeq(9) replacement.
mi_mpprintf(9)Print a formatted string to a message buffer.
mi_mpprintf_nr(9)Continue to print a formatted string to a message buffer.
mi_next_dev_ptr(9)Obtain next device instance pointer.
mi_next_ptr(9)STREAMS minor device list traversal.
mi_offset_param(9)Obtain parameter location within STREAMS message block.
mi_offset_paramc(9)Obtain parameter location within STREAMS message block chain.
mi_open_alloc(9)Allocate a STREAMS module or driver instance.
mi_open_alloc_sleep(9)Allocate a STREAMS module or driver instance (may sleep).
mi_open_comm(9)STREAMS common minor device open utility.
mi_open_detached(9)STREAMS create detached instance data.
mi_open_link(9)Link a STREAMS driver or module instance on open.
mi_prev_ptr(9)STREAMS minor list traversal.
mi_timer_q_switch(9)Switch STREAMS queues for a timer message.
mi_reallocb(9)Reallocated a STREAMS message block.
mi_reuse_proto(9)Reuse a STREAMS protocol message block.
mi_set_sth_copyopt(9)Set the STREAMS Stream head copy options.
mi_set_sth_hiwat(9)Set the STREAMS Stream head high water mark.
mi_set_sth_lowat(9)Set the STREAMS Stream head low water mark.
mi_set_sth_maxblk(9)Set the STREAMS Stream head maximum block size.
mi_set_sth_wroff(9)Set the STREAMS Stream head write offset.
mi_sprintf(9)sprintf(9) replacement.
mi_sprintf_putc(9)Put a character in a sprintf buffer.
mi_strcmp(9)strcmp(9) replacement.
mi_strlen(9)strlen(9) replacement.
mi_strlog(9)strlog(9) replacement.
mi_strtol(9)strtol(9) replacement.
mi_timer(9)Process a STREAMS timer.
mi_timer_alloc(9)Allocate a STREAMS timer.
mi_timer_cancel(9)Cancel a STREAMS timer.
mi_timer_free(9)Free a STREAMS timer.
mi_timer_move(9)Move a STREAMS timer.
mi_timer_q_switch(9)Switch queues for a STREAMS timer.
mi_timer_stop(9)Stop a STREAMS timer.
mi_timer_valid(9)Check a STREAMS timer.
mi_zalloc(9)kmem_zalloc(9) replacement.
mi_zalloc_sleep(9)kmem_zalloc(9) replacement.
mi_tpi_ack_alloc(9)Allocate a T_OK_ACK(7) or T_ERROR_ACK(7) primitive.
mi_tpi_conn_con(9)Generate a T_CONN_CON(7) primitive.
mi_tpi_conn_ind(9)Generate a T_CONN_IND(7) primitive.
mi_tpi_conn_req(9)Generate a T_CONN_REQ(7) primitive.
mi_tpi_data_ind(9)Generate a T_DATA_IND(7) primitive.
mi_tpi_data_req(9)Generate a T_DATA_REQ(7) primitive.
mi_tpi_discon_ind(9)Generate a T_DISCON_IND(7) primitive.
mi_tpi_discon_req(9)Generate a T_DISCON_REQ(7) primitive.
mi_tpi_err_ack_alloc(9)Generate a T_ERROR_ACK(7) primitive.
mi_tpi_exdata_ind(9)Generate a T_EXDATA_IND(7) primitive.
mi_tpi_exdata_req(9)Generate a T_EXDATA_REQ(7) primitive.
mi_tpi_info_req(9)Generate a T_INFO_REQ(7) primitive.
mi_tpi_ok_ack_alloc(9)Generate a T_OK_ACK(7) primitive.
mi_tpi_ordrel_ind(9)Generate a T_ORDREL_IND(7) primitive.
mi_tpi_ordrel_req(9)Generate a T_ORDREL_REQ(7) primitive.
mi_tpi_uderror_ind(9)Generate a T_UDERROR_IND(7) primitive.
mi_tpi_unitdata_ind(9)Generate a T_UNITDATA_IND(7) primitive.
mi_tpi_unitdata_req(9)Generate a T_UNITDATA_REQ(7) primitive.
In the process of creating the Linux Fast-STREAMS subsystem in such a way so as to facilitate portability of STREAMS drivers and modules from a wide range of UNIX operating system variants, a number of guidelines for the development of portable STREAMS drivers and modules have been developed. These guidelines, when adhered to, will allow the resulting driver or module to be ported to another STREAMS implementation with minimal effort. These portability guidelines are collected here.
Portable STREAMS modules and drivers will always allocate memory using the SVR4 memory allocators/deallocators: See (*manpages*)kmem_alloc(9), See (*manpages*)kmem_zalloc(9) and See (*manpages*)kmem_free(9).
Additional eligible allocators are:
See (*manpages*)rmallocmap(9) See (*manpages*)rmfreemap(9) See (*manpages*)rmalloc(9) See (*manpages*)rmalloc_wait(9) See (*manpages*)rmfree(9) See (*manpages*)rminit(9) See (*manpages*)rmsetwant(9) See (*manpages*)rmwanted(9)
Unfortunately, these resource map allocators are not available on AIX so, if portability to the AIX PSE is important, then do not use these allocators.
Additional eligible allocators are:
See (*manpages*)kmem_fast_alloc(9) See (*manpages*)kmem_fast_free(9)
Portable STREAMS modules and drivers will always call See (*manpages*)qprocson(9), before returning from its queue open procedure (see See (*manpages*)qopen(9).)
Portable STREAMS modules and drivers will always call See (*manpages*)qprocsoff(9), upon entering its queue close procedure (see See (*manpages*)qclose(9).)
Although buffer callbacks identifiers (see See (*manpages*)bufcall(9)), timeout identifiers (see See (*manpages*)timeout(9)), and multiplexing driver link identifiers (see I_LINK and I_PLINK under See (*manpages*)streamio(2)), are often illustrated as small integer numbers, with some STREAMS implementations, including Linux Fast-STREAMS, these identifiers are kernel addresses (pointers) and are never small integer values like 1, 2, or 3.
Also, there is no guarantee that the identifier will be positive. It is guaranteed that the returned identifier will not be zero (0). Zero is used by these function as a return value to indicate an error.
Portable STREAMS drivers and modules will not depend upon the returned identifier from See (*manpages*)bufcall(9), See (*manpages*)timeout(9) or See (*manpages*)streamio(2) as being any specific range of value. Portable drivers and modules will save any returned identifiers in data types that will not loose the precision of the identifier.
In versions of UNIX System V previous to Release 4, the major and minor device numbers were each 8 bit, and they were packed into a 16 bit word (usually a C Language short variable). Under UNIX System V Release 4, the device numbers are held in a ‘dev_t’ variable, which is often implemented as a 32 bit integer. The minor device number is held as 14 bits, and a further 8 bits are used for the major device number. ‘dev_t’ is ofter referred to as the "expanded device type", since it allows many more minor devices than before.
Many drivers were written for earlier releases, an may eventually be ported to UNIX System V Release 4. In earlier releases, some manufacturers got around the 256 minor device number limit by using multiple major device numbers for a device. Devices were created with different major device numbers (the external major device number) but they all mapped to the same device driver entry in the device switch tables (the internal device number). Even under this scheme, each major device could only support 256 minor devices, but the driver could support many more. This has been recognized in UNIX System V Release 4, and functions are provided to do this mapping; for example, the function
etoimajor() and so on, give a machine independent interface to the device number mapping. 12
Versions of the Linux kernel in the 2.4 kernel series and prior to 2.6 also provided an 8 bit major device number and an 8 bit minor device number grouped into a 16-bit combined device number. Linux 2.6 and 3.x kernels (and some patched 2.4 kernels) now have larger device numbers. These extended device numbers are 12 bits for major device number and 20 bits for minor device number, with 32 bits for the combined device number.
Linux Fast-STREAMS began with extended device numbering. The specfs shadow special character device file system used by Linux Fast-STREAMS uses the ‘inode’ number to hold the ‘dev_t’ device number instead of the ‘inode->i_rdev’, which on older kernels is only a 16-bit short.
In earlier versions of Linux Fast-STREAMS, the internal device numbering is 16-bits for major device number and 16-bits for minor device number. This will soon be changed to 12-bits for major device number and 20-bits for minor device number to accommodate the newer Linux scheme.
On 2.6 and 3.x Linux kernels that support the newer extended device numbers, external device numbers and internal device numbers will be the same. On 2.4 Linux kernels with the older 16-bit device numbers, external device number and internal device numbers will differ. In some situations, an internal device number can exists with no corresponding external device number (accessed only via a clone device or direct access to the mounted specfs shadow special character device file system).
etoimajor(9)change external to internal major device number
getemajor(9)get external major device number
geteminor(9)get external minor device number
itoemajor(9)change internal to external major device number
Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.
A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the program's name and a brief idea of what it does. Copyright (C) year name of author This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
program Copyright (C) year name of author This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’. This is free software, and you are welcome to redistribute it under certain conditions; type ‘show c’ for details.
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html.
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with
the Front-Cover Texts being list, and with the Back-Cover Texts
being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
| Jump to: | A B C D L M P S U |
|---|
| Jump to: | A B C D L M P S U |
|---|
| Jump to: | D |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| D | |||
dev_t: | Registration/Deregistration and Device Numbering | ||
dev_t: | Registration/Deregistration and Device Numbering | ||
dev_t: | Registration/Deregistration and Device Numbering | ||
| | |||
| Jump to: | D |
|---|
| Jump to: | I |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| I | |||
I_LINK: | Timeout Call Back and Link Identifiers | ||
I_PLINK: | Timeout Call Back and Link Identifiers | ||
| | |||
| Jump to: | I |
|---|
La Direction des Services de la Navigation Aérienne - La Direction Général de l’Aviation Civile
Deutsches Zentrum für Luft- unde Raumfarht
Federal Aviation Administration - William J. Hughes Technical Center
Ecole Nationale Supérieure des Télécommunications
Hochschule für Technik und Wirtschaft des Saarlandes
It is possible that the STREAMS
module or driver writer can make such assurances with mechanisms other than
freezestr(9). See the freezestr(9) manual page for
more information.
It is possible that the STREAMS
module or driver writer can make such assurances with mechanisms other than
freezestr(9). See the freezestr(9) manual page for
more information.
Perhaps this has something to do with STREAMS first being implemented on BSD 4.2.
Perhaps this has something to do with STREAMS first being implemented on BSD 4.2.
STREAMS/UX for the HP 9000 Reference Manual, 1995, (Palo Alto, California), Hewlett-Package Company, HP. http://docs.hp.com/
STREAMS/UX for the HP 9000 Reference Manual, 1995, (Palo Alto, California), Hewlett-Package Company, HP. http://docs.hp.com/
The Magic Garden Explained