Major update/merge of POSIX manual.

This commit is contained in:
Joel Sherrill
1998-11-19 16:06:46 +00:00
parent d82f3e81a4
commit c4dddee3f5
19 changed files with 6731 additions and 732 deletions
-98
View File
@@ -1,98 +0,0 @@
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@ifinfo
@node Mutex Manager, Mutex Manager Introduction, Preface, Top
@end ifinfo
@chapter Mutex Manager
@ifinfo
@menu
* Mutex Manager Introduction::
* Mutex Manager Background::
* Mutex Manager Operations::
* Mutex Manager Directives::
@end menu
@end ifinfo
@ifinfo
@node Mutex Manager Introduction, Mutex Manager Background, Mutex Manager, Mutex Manager
@end ifinfo
@section Introduction
The mutex manager ...
The directives provided by the mutex manager are:
@itemize @bullet
@item @code{sigaddset} -
@item @code{sigdelset} -
@item @code{sigfillset} -
@item @code{sigismember} -
@item @code{sigemptyset} -
@item @code{sigaction} -
@item @code{pthread_kill} -
@item @code{pthread_sigmask} -
@item @code{kill} -
@item @code{sigwait} -
@end itemize
@ifinfo
@node Mutex Manager Background, Mutex Manager Operations, Mutex Manager Introduction, Mutex Manager
@end ifinfo
@section Background
@ifinfo
@node Mutex Manager Operations, Mutex Manager Directives, Mutex Manager Background, Mutex Manager
@end ifinfo
@section Operations
@ifinfo
@node Mutex Manager Directives, sigaddset, Mutex Manager Operations, Mutex Manager
@end ifinfo
@section Directives
@ifinfo
@menu
* sigaddset::
* sigdelset::
* sigfillset::
* sigismember::
* sigemptyset::
* sigaction::
* pthread_kill::
* pthread_sigmask::
* kill::
* sigwait::
@end menu
@end ifinfo
This section details the mutex manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@page
@ifinfo
@node sigaddset, sigdelset, Mutex Manager Directives, Mutex Manager Directives
@end ifinfo
@subsection sigaddset
@subheading CALLING SEQUENCE:
@example
int sigaddset(
sigset_t *set,
int signo
);
@end example
@subheading STATUS CODES:
@subheading DESCRIPTION:
@subheading NOTES:
@@ -6,22 +6,8 @@
@c $Id$
@c
@ifinfo
@node Clock Manager, Clock Manager Introduction, pthread_getspecific, Top
@end ifinfo
@chapter Clock Manager
@ifinfo
@menu
* Clock Manager Introduction::
* Clock Manager Background::
* Clock Manager Operations::
* Clock Manager Directives::
@end menu
@end ifinfo
@ifinfo
@node Clock Manager Introduction, Clock Manager Background, Clock Manager, Clock Manager
@end ifinfo
@section Introduction
The clock manager ...
@@ -32,45 +18,28 @@ The directives provided by the clock manager are:
@item @code{clock_gettime} -
@item @code{clock_settime} -
@item @code{clock_getres} -
@item @code{sleep} - Delay Process Execution
@item @code{nanosleep} -
@item @code{time} -
@item @code{gettimeofday} - Get the Time of Day
@item @code{time} - Get time in seconds
@end itemize
@ifinfo
@node Clock Manager Background, Clock Manager Operations, Clock Manager Introduction, Clock Manager
@end ifinfo
@section Background
@ifinfo
@node Clock Manager Operations, Clock Manager Directives, Clock Manager Background, Clock Manager
@end ifinfo
There is currently no text in this section.
@section Operations
@ifinfo
@node Clock Manager Directives, clock_gettime, Clock Manager Operations, Clock Manager
@end ifinfo
There is currently no text in this section.
@section Directives
@ifinfo
@menu
* clock_gettime::
* clock_settime::
* clock_getres::
* sleep::
* nanosleep::
* time::
@end menu
@end ifinfo
This section details the clock manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@page
@ifinfo
@node clock_gettime, clock_settime, Clock Manager Directives, Clock Manager Directives
@end ifinfo
@subsection clock_gettime
@subsection clock_gettime -
@subheading CALLING SEQUENCE:
@@ -99,11 +68,10 @@ The clock_id specified is invalid.
@subheading NOTES:
NONE
@page
@ifinfo
@node clock_settime, clock_getres, clock_gettime, Clock Manager Directives
@end ifinfo
@subsection clock_settime
@subsection clock_settime -
@subheading CALLING SEQUENCE:
@@ -135,12 +103,11 @@ The contents of the tp structure are invalid.
@subheading DESCRIPTION:
@subheading NOTES:
NONE
@page
@ifinfo
@node clock_getres, sleep, clock_settime, Clock Manager Directives
@end ifinfo
@subsection clock_getres
@subsection clock_getres -
@subheading CALLING SEQUENCE:
@@ -173,10 +140,7 @@ The clock_id specified is invalid.
If res is NULL, then the resolution is not returned.
@page
@ifinfo
@node sleep, nanosleep, clock_getres, Clock Manager Directives
@end ifinfo
@subsection sleep
@subsection sleep - Delay Process Execution
@subheading CALLING SEQUENCE:
@@ -194,15 +158,15 @@ This routine returns the number of unslept seconds.
@subheading DESCRIPTION:
The @code{sleep()} function delays the calling thread by the specified
number of @code{seconds}.
@subheading NOTES:
This call is interruptible by a signal.
@page
@ifinfo
@node nanosleep, time, sleep, Clock Manager Directives
@end ifinfo
@subsection nanosleep
@subsection nanosleep -
@subheading CALLING SEQUENCE:
@@ -239,10 +203,48 @@ field.
This call is interruptible by a signal.
@page
@ifinfo
@node time, Scheduler Manager, nanosleep, Clock Manager Directives
@end ifinfo
@subsection nanosleep
@subsection gettimeofday - Get the Time of Day
@subheading CALLING SEQUENCE:
@example
#include <sys/time.h>
#include <unistd.h>
int gettimeofday(
struct timeval *tp,
struct timezone *tzp
);
@end example
@subheading STATUS CODES:
On error, this routine returns -1 and sets @code{errno} as appropriate.
@table @b
@item EPERM
@code{settimeofdat} is called by someone other than the superuser.
@item EINVAL
Timezone (or something else) is invalid.
@item EFAULT
One of @code{tv} or @code{tz} pointed outside your accessible address
space
@end table
@subheading DESCRIPTION:
This routine returns the current time of day in the @code{tp} structure.
@subheading NOTES:
Currently, the timezone information is not supported. The @code{tzp}
argument is ignored.
@page
@subsection time - Get time in seconds
@subheading CALLING SEQUENCE:
@@ -259,6 +261,14 @@ int time(
This routine returns the number of seconds since the Epoch.
@subheading DESCRIPTION:
@code{time} returns the time since 00:00:00 GMT, January 1, 1970,
measured in seconds
If @code{tloc} in non null, the return value is also stored in the
memory pointed to by @code{t}.
@subheading NOTES:
NONE
@@ -6,22 +6,8 @@
@c $Id$
@c
@ifinfo
@node Condition Variable Manager, Condition Variable Manager Introduction, pthread_mutex_getprioceiling, Top
@end ifinfo
@chapter Condition Variable Manager
@ifinfo
@menu
* Condition Variable Manager Introduction::
* Condition Variable Manager Background::
* Condition Variable Manager Operations::
* Condition Variable Manager Directives::
@end menu
@end ifinfo
@ifinfo
@node Condition Variable Manager Introduction, Condition Variable Manager Background, Condition Variable Manager, Condition Variable Manager
@end ifinfo
@section Introduction
The condition variable manager ...
@@ -41,34 +27,15 @@ The directives provided by the condition variable manager are:
@item @code{pthread_cond_timedwait} -
@end itemize
@ifinfo
@node Condition Variable Manager Background, Condition Variable Manager Operations, Condition Variable Manager Introduction, Condition Variable Manager
@end ifinfo
@section Background
@ifinfo
@node Condition Variable Manager Operations, Condition Variable Manager Directives, Condition Variable Manager Background, Condition Variable Manager
@end ifinfo
There is currently no text in this section.
@section Operations
@ifinfo
@node Condition Variable Manager Directives, pthread_condattr_init, Condition Variable Manager Operations, Condition Variable Manager
@end ifinfo
There is currently no text in this section.
@section Directives
@ifinfo
@menu
* pthread_condattr_init::
* pthread_condattr_destroy::
* pthread_condattr_setpshared::
* pthread_condattr_getpshared::
* pthread_cond_init::
* pthread_cond_destroy::
* pthread_cond_signal::
* pthread_cond_broadcast::
* pthread_cond_wait::
* pthread_cond_timedwait::
@end menu
@end ifinfo
This section details the condition variable manager's directives.
A subsection is dedicated to each of this manager's directives
@@ -76,9 +43,6 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
@ifinfo
@node pthread_condattr_init, pthread_condattr_destroy, Condition Variable Manager Directives, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_condattr_init
@subheading CALLING SEQUENCE:
@@ -104,9 +68,6 @@ attributes object.
@subheading NOTES:
@page
@ifinfo
@node pthread_condattr_destroy, pthread_condattr_setpshared, pthread_condattr_init, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_condattr_destroy
@subheading CALLING SEQUENCE:
@@ -131,9 +92,6 @@ The attribute object specified is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_condattr_setpshared, pthread_condattr_getpshared, pthread_condattr_destroy, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_condattr_setpshared
@subheading CALLING SEQUENCE:
@@ -160,9 +118,6 @@ Invalid argument passed.
@subheading NOTES:
@page
@ifinfo
@node pthread_condattr_getpshared, pthread_cond_init, pthread_condattr_setpshared, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_condattr_getpshared
@subheading CALLING SEQUENCE:
@@ -190,9 +145,6 @@ Invalid argument passed.
@page
@ifinfo
@node pthread_cond_init, pthread_cond_destroy, pthread_condattr_getpshared, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_cond_init
@subheading CALLING SEQUENCE:
@@ -228,9 +180,6 @@ The specified attribute value is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_cond_destroy, pthread_cond_signal, pthread_cond_init, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_cond_destroy
@subheading CALLING SEQUENCE:
@@ -258,9 +207,6 @@ The specified condition variable is currently in use.
@subheading NOTES:
@page
@ifinfo
@node pthread_cond_signal, pthread_cond_broadcast, pthread_cond_destroy, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_cond_signal
@subheading CALLING SEQUENCE:
@@ -288,9 +234,6 @@ This routine should not be invoked from a handler from an asynchronous signal
handler or an interrupt service routine.
@page
@ifinfo
@node pthread_cond_broadcast, pthread_cond_wait, pthread_cond_signal, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_cond_broadcast
@subheading CALLING SEQUENCE:
@@ -318,9 +261,6 @@ This routine should not be invoked from a handler from an asynchronous signal
handler or an interrupt service routine.
@page
@ifinfo
@node pthread_cond_wait, pthread_cond_timedwait, pthread_cond_broadcast, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_cond_wait
@subheading CALLING SEQUENCE:
@@ -349,9 +289,6 @@ the mutex was not owned by the current thread at the time of the call.
@subheading NOTES:
@page
@ifinfo
@node pthread_cond_timedwait, Key Manager, pthread_cond_wait, Condition Variable Manager Directives
@end ifinfo
@subsection pthread_cond_timedwait
@subheading CALLING SEQUENCE:
File diff suppressed because it is too large Load Diff
+465
View File
@@ -0,0 +1,465 @@
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@chapter Device- and Class- Specific Functions Manager
@section Introduction
The device- and class- specific functions manager is ...
The directives provided by the device- and class- specific functions
manager are:
@itemize @bullet
@item @code{cfgetispeed} - Reads terminal input baud rate
@item @code{cfgetospeed} - Reads terminal output baud rate
@item @code{cfsetispeed} - Sets terminal input baud rate
@item @code{cfsetospeed} - Set terminal output baud rate
@item @code{tcgetattr} - Gets terminal attributes
@item @code{tcsetattr} - Set terminal attributes
@item @code{tcsendbreak} - Sends a break to a terminal
@item @code{tcdrain} - Waits for all output to be transmitted to the terminal
@item @code{tcflush} - Discards terminal data
@item @code{tcflow} - Suspends/restarts terminal output
@item @code{tcgetpgrp} - Gets foreground process group ID
@item @code{tcsetpgrp} - Sets foreground process group ID
@end itemize
@section Background
There is currently no text in this section.
@section Operations
There is currently no text in this section.
@section Directives
This section details the device- and class- specific functions manager's
directives. A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@page
@subsection cfgetispeed - Reads terminal input baud rate
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <termios.h>
int cfgetispeed(
const struct termios *p
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
The @code{cfgetispeed()} function returns a code for baud rate.
@subheading DESCRIPTION:
The @code{cfsetispeed()} function stores a code for the terminal speed
stored in a struct termios. The codes are defined in @code{<termios.h>}
by the macros BO, B50, B75, B110, B134, B150, B200, B300, B600, B1200,
B1800, B2400, B4800, B9600, B19200, and B38400.
The @code{cfsetispeed()} function does not do anything to the hardware.
It merely stores a value for use by @code{tcsetattr()}.
@subheading NOTES:
Baud rates are defined by symbols, such as B110, B1200, B2400. The actual
number returned for any given speed may change from system to system.
@page
@subsection cfgetospeed - Reads terminal output baud rate
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <termios.h>
int cfgetospeed(
const struct termios *p
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
The @code{cfgetospeed()} function returns the termios code for the baud rate.
@subheading DESCRIPTION:
The @code{cfgetospeed()} function returns a code for the terminal speed
stored in a @code{struct termios}. The codes are defined in @code{<termios.h>}
by the macros BO, B50, B75, B110, B134, B150, B200, B300, B600, B1200, B1800,
B2400, B4800, B9600, B19200, and B38400.
The @code{cfgetospeed()} function does not do anything to the hardware.
It merely returns the value stored by a previous call to @code{tcgetattr()}.
@subheading NOTES:
Baud rates are defined by symbols, such as B110, B1200, B2400. The actual
number returned for any given speed may change from system to system.
@page
@subsection cfsetispeed - Sets terminal input baud rate
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <termios.h>
int cfsetispeed(
struct termios *p,
speed_t speed
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
The @code{cfsetispeed()} function returns a zero when successful and
returns -1 when an error occurs.
@subheading DESCRIPTION:
The @code{cfsetispeed()} function stores a code for the terminal speed
stored in a struct termios. The codes are defined in @code{<termios.h>}
by the macros B0, B50, B75, B110, B134, B150, B200, B300, B600, B1200,
B1800, B2400, B4800, B9600, B19200, and B38400.
@subheading NOTES:
This function merely stores a value in the @code{termios} structure. It
does not change the terminal speed until a @code{tcsetattr()} is done.
It does not detect impossible terminal speeds.
@page
@subsection cfsetospeed - Sets terminal output baud rate
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <termios.h>
int cfsetospeed(
struct termios *p,
speed_t speed
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
The @code{cfsetospeed()} function returns a zero when successful and
returns -1 when an error occurs.
@subheading DESCRIPTION:
The @code{cfsetospeed()} function stores a code for the terminal speed stored
in a struct @code{termios}. The codes are defiined in @code{<termios.h>} by the
macros B0, B50, B75, B110, B134, B150, B200, B300, B600, B1200, B1800, B2400,
B4800, B9600, B19200, and B38400.
The @code{cfsetospeed()} function does not do anything to the hardware. It
merely stores a value for use by @code{tcsetattr()}.
@subheading NOTES:
This function merely stores a value in the @code{termios} structure.
It does not change the terminal speed until a @code{tcsetattr()} is done.
It does not detect impossible terminal speeds.
@page
@subsection tcgetattr - Gets terminal attributes
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <termios.h>
#include <unistd.h>
int tcgetattr(
int fildes,
struct termios *p
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item EBADF
Invalid file descriptor
@item ENOOTY
Terminal control function attempted for a file that is not a terminal.
@end table
@subheading DESCRIPTION:
The @code{tcgetattr()} gets the parameters associated with the terminal
referred to by @code{fildes} and stores them into the @code{termios()}
structure pointed to by @code{termios_p}.
@subheading NOTES:
NONE
@page
@subsection tcsetattr - Set terminal attributes
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <termios.h>
#include <unistd.h>
int tcsetattr(
int fildes,
int options,
const struct termios *tp
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection tcsendbreak - Sends a break to a terminal
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tcsendbreak(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
This routine is not currently supported by RTEMS but could be
in a future version.
@page
@subsection tcdrain - Waits for all output to be transmitted to the terminal.
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <termios.h>
#include <unistd.h>
int tcdrain(
int fildes
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item EBADF
Invalid file descriptor
@item EINTR
Function was interrupted by a signal
@item ENOTTY
Terminal control function attempted for a file that is not a terminal.
@end table
@subheading DESCRIPTION:
The @code{tcdrain()} function waits until all output written to
@code{fildes} has been transmitted.
@subheading NOTES:
NONE
@page
@subsection tcflush - Discards terminal data
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tcflush(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
This routine is not currently supported by RTEMS but could be
in a future version.
@page
@subsection tcflow - Suspends/restarts terminal output.
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tcflow(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
This routine is not currently supported by RTEMS but could be
in a future version.
@page
@subsection tcgetpgrp - Gets foreground process group ID
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tcgetpgrp(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
This routine is not currently supported by RTEMS but could be
in a future version.
@page
@subsection tcsetpgrp - Sets foreground process group ID
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tcsetpgrp(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
This routine is not currently supported by RTEMS but could be
in a future version.
File diff suppressed because it is too large Load Diff
+1085
View File
File diff suppressed because it is too large Load Diff
@@ -6,22 +6,8 @@
@c $Id$
@c
@ifinfo
@node Key Manager, Key Manager Introduction, pthread_cond_timedwait, Top
@end ifinfo
@chapter Key Manager
@ifinfo
@menu
* Key Manager Introduction::
* Key Manager Background::
* Key Manager Operations::
* Key Manager Directives::
@end menu
@end ifinfo
@ifinfo
@node Key Manager Introduction, Key Manager Background, Key Manager, Key Manager
@end ifinfo
@section Introduction
The key manager ...
@@ -35,28 +21,15 @@ The directives provided by the key manager are:
@item @code{pthread_getspecific} -
@end itemize
@ifinfo
@node Key Manager Background, Key Manager Operations, Key Manager Introduction, Key Manager
@end ifinfo
@section Background
@ifinfo
@node Key Manager Operations, Key Manager Directives, Key Manager Background, Key Manager
@end ifinfo
There is currently no text in this section.
@section Operations
@ifinfo
@node Key Manager Directives, pthread_key_create, Key Manager Operations, Key Manager
@end ifinfo
There is currently no text in this section.
@section Directives
@ifinfo
@menu
* pthread_key_create::
* pthread_key_delete::
* pthread_setspecific::
* pthread_getspecific::
@end menu
@end ifinfo
This section details the key manager's directives.
A subsection is dedicated to each of this manager's directives
@@ -64,9 +37,6 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
@ifinfo
@node pthread_key_create, pthread_key_delete, Key Manager Directives, Key Manager Directives
@end ifinfo
@subsection pthread_key_create
@subheading CALLING SEQUENCE:
@@ -92,9 +62,6 @@ Insufficient memory exists to create the key.
@end table
@page
@ifinfo
@node pthread_key_delete, pthread_setspecific, pthread_key_create, Key Manager Directives
@end ifinfo
@subsection pthread_key_delete
@subheading CALLING SEQUENCE:
@@ -120,9 +87,6 @@ The key was invalid
@subheading NOTES:
@page
@ifinfo
@node pthread_setspecific, pthread_getspecific, pthread_key_delete, Key Manager Directives
@end ifinfo
@subsection pthread_setspecific
@subheading CALLING SEQUENCE:
@@ -148,9 +112,6 @@ The specified key is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_getspecific, Clock Manager, pthread_setspecific, Key Manager Directives
@end ifinfo
@subsection pthread_getspecific
@subheading CALLING SEQUENCE:
+315
View File
@@ -0,0 +1,315 @@
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@chapter Memory Management Manager
@section Introduction
The
memory management manager is ...
The directives provided by the memory management manager are:
@itemize @bullet
@item @code{mlockall} -
@item @code{munlockall} -
@item @code{mlock} -
@item @code{munlock} -
@item @code{mmap} -
@item @code{munmap} -
@item @code{mprotect} -
@item @code{msync} -
@item @code{shm_open} -
@item @code{shm_unlink} -
@end itemize
@section Background
There is currently no text in this section.
@section Operations
There is currently no text in this section.
@section Directives
This section details the memory management manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@page
@subsection mlockall -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mlockall(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection munlockall -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int munlockall(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mlock -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mlock(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection munlock -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int munlock(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mmap -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mmap(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection munmap -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int munmap(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mprotect -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mprotect(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection msync -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int msync(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection shm_open -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int shm_open(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection shm_unlink -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int shm_unlink(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
+259
View File
@@ -0,0 +1,259 @@
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@chapter Message Passing Manager
@section Introduction
The
message passing manager is ...
The directives provided by the message passing manager are:
@itemize @bullet
@item @code{mq_open} -
@item @code{mq_close} -
@item @code{mq_unlink} -
@item @code{mq_send} -
@item @code{mq_receive} -
@item @code{mq_notify} -
@item @code{mq_setattr} -
@item @code{mq_getattr} -
@end itemize
@section Background
There is currently no text in this section.
@section Operations
There is currently no text in this section.
@section Directives
This section details the message passing manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@page
@subsection mq_open -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mq_open(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mq_close -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mq_close(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mq_unlink -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mq_unlink(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mq_send -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mq_send(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mq_receive -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mq_receive(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mq_notify -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mq_notify(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mq_setattr -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mq_setattr(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection mq_getattr -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int mq_getattr(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@@ -6,22 +6,8 @@
@c $Id$
@c
@ifinfo
@node Mutex Manager, Mutex Manager Introduction, alarm, Top
@end ifinfo
@chapter Mutex Manager
@ifinfo
@menu
* Mutex Manager Introduction::
* Mutex Manager Background::
* Mutex Manager Operations::
* Mutex Manager Directives::
@end menu
@end ifinfo
@ifinfo
@node Mutex Manager Introduction, Mutex Manager Background, Mutex Manager, Mutex Manager
@end ifinfo
@section Introduction
The mutex manager ...
@@ -47,40 +33,15 @@ The directives provided by the mutex manager are:
@item @code{pthread_mutex_getprioceiling} -
@end itemize
@ifinfo
@node Mutex Manager Background, Mutex Manager Operations, Mutex Manager Introduction, Mutex Manager
@end ifinfo
@section Background
@ifinfo
@node Mutex Manager Operations, Mutex Manager Directives, Mutex Manager Background, Mutex Manager
@end ifinfo
There is currently no text in this section.
@section Operations
@ifinfo
@node Mutex Manager Directives, pthread_mutexattr_init, Mutex Manager Operations, Mutex Manager
@end ifinfo
There is currently no text in this section.
@section Directives
@ifinfo
@menu
* pthread_mutexattr_init::
* pthread_mutexattr_destroy::
* pthread_mutexattr_setprotocol::
* pthread_mutexattr_getprotocol::
* pthread_mutexattr_setprioceiling::
* pthread_mutexattr_getprioceiling::
* pthread_mutexattr_setpshared::
* pthread_mutexattr_getpshared::
* pthread_mutex_init::
* pthread_mutex_destroy::
* pthread_mutex_lock::
* pthread_mutex_trylock::
* pthread_mutex_timedlock::
* pthread_mutex_unlock::
* pthread_mutex_setprioceiling::
* pthread_mutex_getprioceiling::
@end menu
@end ifinfo
This section details the mutex manager's directives.
A subsection is dedicated to each of this manager's directives
@@ -88,9 +49,6 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
@ifinfo
@node pthread_mutexattr_init, pthread_mutexattr_destroy, Mutex Manager Directives, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutexattr_init
@subheading CALLING SEQUENCE:
@@ -116,9 +74,6 @@ The attribute pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutexattr_destroy, pthread_mutexattr_setprotocol, pthread_mutexattr_init, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutexattr_destroy
@subheading CALLING SEQUENCE:
@@ -147,9 +102,6 @@ The attribute set is not initialized.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutexattr_setprotocol, pthread_mutexattr_getprotocol, pthread_mutexattr_destroy, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutexattr_setprotocol
@subheading CALLING SEQUENCE:
@@ -182,9 +134,6 @@ The protocol argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutexattr_getprotocol, pthread_mutexattr_setprioceiling, pthread_mutexattr_setprotocol, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutexattr_getprotocol
@subheading CALLING SEQUENCE:
@@ -217,9 +166,6 @@ The protocol pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutexattr_setprioceiling, pthread_mutexattr_getprioceiling, pthread_mutexattr_getprotocol, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutexattr_setprioceiling
@subheading CALLING SEQUENCE:
@@ -252,9 +198,6 @@ The prioceiling argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutexattr_getprioceiling, pthread_mutexattr_setpshared, pthread_mutexattr_setprioceiling, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutexattr_getprioceiling
@subheading CALLING SEQUENCE:
@@ -287,9 +230,6 @@ The prioceiling pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutexattr_setpshared, pthread_mutexattr_getpshared, pthread_mutexattr_getprioceiling, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutexattr_setpshared
@subheading CALLING SEQUENCE:
@@ -322,9 +262,6 @@ The pshared argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutexattr_getpshared, pthread_mutex_init, pthread_mutexattr_setpshared, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutexattr_getpshared
@subheading CALLING SEQUENCE:
@@ -357,9 +294,6 @@ The pshared pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutex_init, pthread_mutex_destroy, pthread_mutexattr_getpshared, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutex_init
@subheading CALLING SEQUENCE:
@@ -399,9 +333,6 @@ initialized, but not yet destroyed.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutex_destroy, pthread_mutex_lock, pthread_mutex_init, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutex_destroy
@subheading CALLING SEQUENCE:
@@ -431,9 +362,6 @@ referenced by another thread.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutex_lock, pthread_mutex_trylock, pthread_mutex_destroy, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutex_lock
@subheading CALLING SEQUENCE:
@@ -467,9 +395,6 @@ The current thread already owns the mutex.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutex_trylock, pthread_mutex_timedlock, pthread_mutex_lock, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutex_trylock
@subheading CALLING SEQUENCE:
@@ -503,9 +428,6 @@ The current thread already owns the mutex.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutex_timedlock, pthread_mutex_unlock, pthread_mutex_trylock, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutex_timedlock
@subheading CALLING SEQUENCE:
@@ -545,9 +467,6 @@ The current thread already owns the mutex.
@page
@ifinfo
@node pthread_mutex_unlock, pthread_mutex_setprioceiling, pthread_mutex_timedlock, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutex_unlock
@subheading CALLING SEQUENCE:
@@ -573,9 +492,6 @@ The specified mutex is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutex_setprioceiling, pthread_mutex_getprioceiling, pthread_mutex_unlock, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutex_setprioceiling
@subheading CALLING SEQUENCE:
@@ -609,9 +525,6 @@ The specified mutex is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_mutex_getprioceiling, Condition Variable Manager, pthread_mutex_setprioceiling, Mutex Manager Directives
@end ifinfo
@subsection pthread_mutex_getprioceiling
@subheading CALLING SEQUENCE:
-24
View File
@@ -1,24 +0,0 @@
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@ifinfo
@node Preface, Thread Manager, Top, Top
@end ifinfo
@unnumbered Preface
This is the user's guide for the POSIX API support for RTEMS.
We intend for this manual to only be a listing of the API. Please
refer to the ISO/IEC 9945-1 @i{Information Technology -
Portable Operating System Interface (POSIX) - Part 1: System
Application Program Interface (API) [C Language]} for the specific
functionality and behavior of the services.
In addition, much of the POSIX API standard is actually implemented
in the newlib ANSI C Library. Please refer to documentation on
newlib for more information on what it supplies.
File diff suppressed because it is too large Load Diff
+414
View File
@@ -0,0 +1,414 @@
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@chapter Process Creation and Execution Manager
@section Introduction
The process creation and execution manager is ...
The directives provided by the process creation and execution manager are:
@itemize @bullet
@item @code{fork} - Create a Process
@item @code{execl} - Execute a File
@item @code{execv} - Execute a File
@item @code{execle} - Execute a File
@item @code{execve} - Execute a File
@item @code{execlp} - Execute a File
@item @code{execvp} - Execute a File
@item @code{pthread_atfork} - Register Fork Handlers
@item @code{wait} - Wait for Process Termination
@item @code{waitpid} - Wait for Process Termination
@item @code{_exit} - Terminate a Process
@end itemize
@section Background
There is currently no text in this section.
@section Operations
There is currently no text in this section.
@section Directives
This section details the process creation and execution manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@page
@subsection fork - Create a Process
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <sys/types.h>
int fork( void );
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection execl - Execute a File
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int execl(
const char *path,
const char *arg,
...
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection execv - Execute a File
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int execv(
const char *path,
char const *argv[],
...
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection execle - Execute a File
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int execle(
const char *path,
const char *arg,
...
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection execve - Execute a File
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int execve(
const char *path,
char *const argv[],
char *const envp[]
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection execlp - Execute a File
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int execlp(
const char *file,
const char *arg,
...
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection execvp - Execute a File
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int execvp(
const char *file,
char *const argv[]
...
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection pthread_atfork - Register Fork Handlers
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <sys/types.h>
int pthread_atfork(
void (*prepare)(void),
void (*parent)(void),
void (*child)(void)
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection wait - Wait for Process Termination
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <sys/types.h>
#include <sys/wait.h>
int wait(
int *stat_loc
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection waitpid - Wait for Process Termination
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int wait(
pid_t pid,
int *stat_loc,
int options
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item ENOSYS
This routine is not supported by RTEMS.
@end table
@subheading DESCRIPTION:
This routine is not supported by RTEMS.
@subheading NOTES:
NONE
@page
@subsection _exit - Terminate a Process
@subheading CALLING SEQUENCE:
@ifset is-C
@example
void _exit(
int status
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
NONE
@subheading DESCRIPTION:
The @code{_exit()} function terminates the calling process.
@subheading NOTES:
In RTEMS, a process is equivalent to the entire application on a single
processor. Invoking this service terminates the application.
@@ -6,22 +6,8 @@
@c $Id$
@c
@ifinfo
@node Scheduler Manager, Scheduler Manager Introduction, time, Top
@end ifinfo
@chapter Scheduler Manager
@ifinfo
@menu
* Scheduler Manager Introduction::
* Scheduler Manager Background::
* Scheduler Manager Operations::
* Scheduler Manager Directives::
@end menu
@end ifinfo
@ifinfo
@node Scheduler Manager Introduction, Scheduler Manager Background, Scheduler Manager, Scheduler Manager
@end ifinfo
@section Introduction
The scheduler manager ...
@@ -35,20 +21,8 @@ The directives provided by the scheduler manager are:
@item @code{sched_yield} -
@end itemize
@ifinfo
@node Scheduler Manager Background, Priority, Scheduler Manager Introduction, Scheduler Manager
@end ifinfo
@section Background
@ifinfo
@menu
* Priority::
* Scheduling Policies::
@end menu
@end ifinfo
@ifinfo
@node Priority, Scheduling Policies, Scheduler Manager Background, Scheduler Manager Background
@end ifinfo
@subsection Priority
In the RTEMS implementation of the POSIX API, the priorities range from
@@ -56,9 +30,6 @@ the low priority of sched_get_priority_min() to the highest priority of
sched_get_priority_max(). Numerically higher values represent higher
priorities.
@ifinfo
@node Scheduling Policies, Scheduler Manager Operations, Priority, Scheduler Manager Background
@end ifinfo
@subsection Scheduling Policies
The following scheduling policies are available:
@@ -87,23 +58,11 @@ the thread resumes its initial priority and has its budget replenished.
@end table
@ifinfo
@node Scheduler Manager Operations, Scheduler Manager Directives, Scheduling Policies, Scheduler Manager
@end ifinfo
@section Operations
@ifinfo
@node Scheduler Manager Directives, sched_get_priority_min, Scheduler Manager Operations, Scheduler Manager
@end ifinfo
There is currently no text in this section.
@section Directives
@ifinfo
@menu
* sched_get_priority_min::
* sched_get_priority_max::
* sched_rr_get_interval::
* sched_yield::
@end menu
@end ifinfo
This section details the scheduler manager's directives.
A subsection is dedicated to each of this manager's directives
@@ -111,9 +70,6 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
@ifinfo
@node sched_get_priority_min, sched_get_priority_max, Scheduler Manager Directives, Scheduler Manager Directives
@end ifinfo
@subsection sched_get_priority_min
@subheading CALLING SEQUENCE:
@@ -141,9 +97,6 @@ The indicated policy is invalid.
@subheading NOTES:
@page
@ifinfo
@node sched_get_priority_max, sched_rr_get_interval, sched_get_priority_min, Scheduler Manager Directives
@end ifinfo
@subsection sched_get_priority_max
@subheading CALLING SEQUENCE:
@@ -171,9 +124,6 @@ The indicated policy is invalid.
@subheading NOTES:
@page
@ifinfo
@node sched_rr_get_interval, sched_yield, sched_get_priority_max, Scheduler Manager Directives
@end ifinfo
@subsection sched_rr_get_interval
@subheading CALLING SEQUENCE:
@@ -205,9 +155,6 @@ The specified interval pointer parameter is invalid.
@subheading NOTES:
@page
@ifinfo
@node sched_yield, Command and Variable Index, sched_rr_get_interval, Scheduler Manager Directives
@end ifinfo
@subsection sched_yield
@subheading CALLING SEQUENCE:
+287
View File
@@ -0,0 +1,287 @@
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@chapter Semaphores Manager
@section Introduction
The
semaphore manager is ...
The directives provided by the semaphore manager are:
@itemize @bullet
@item @code{sem_init} -
@item @code{sem_destroy} -
@item @code{sem_open} -
@item @code{sem_close} -
@item @code{sem_unlink} -
@item @code{sem_wait} -
@item @code{sem_trywait} -
@item @code{sem_post} -
@item @code{sem_getvalue} -
@end itemize
@section Background
There is currently no text in this section.
@section Operations
There is currently no text in this section.
@section Directives
This section details the semaphore manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@page
@subsection sem_init -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_init(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection sem_destroy -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_destroy(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection sem_open -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_open(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection sem_close -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_close(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection sem_unlink -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_unlink(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection sem_wait -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_wait(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection sem_trywait -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_trywait(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection sem_post -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_post(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection sem_getvalue -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sem_getvalue(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
File diff suppressed because it is too large Load Diff
+259
View File
@@ -0,0 +1,259 @@
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@chapter System Databases Manager
@section Introduction
The
system databases manager is ...
The directives provided by the system databases manager are:
@itemize @bullet
@item @code{getgrgid} -
@item @code{getgrgid_r} -
@item @code{getgrnam} -
@item @code{getgrnam_r} -
@item @code{getpwuid} -
@item @code{getpwuid_r} -
@item @code{getpwnam} -
@item @code{getpwnam_r} -
@end itemize
@section Background
There is currently no text in this section.
@section Operations
There is currently no text in this section.
@section Directives
This section details the system databases manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
@page
@subsection getgrgid -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int getgrgid(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection getgrgid_r -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int getgrgid_r(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection getgrnam -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int getgrnam(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection getgrnam_r -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int getgrnam_r(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection getpwuid -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int getpwuid(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection getpwuid_r -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int getpwuid_r(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection getpwnam -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int getpwnam(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@page
@subsection getpwnam_r -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int getpwnam_r(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@@ -6,22 +6,8 @@
@c $Id$
@c
@ifinfo
@node Thread Manager, Thread Manager Introduction, Preface, Top
@end ifinfo
@chapter Thread Manager
@ifinfo
@menu
* Thread Manager Introduction::
* Thread Manager Background::
* Thread Manager Operations::
* Thread Manager Directives::
@end menu
@end ifinfo
@ifinfo
@node Thread Manager Introduction, Thread Manager Background, Thread Manager, Thread Manager
@end ifinfo
@section Introduction
The thread manager ...
@@ -56,19 +42,8 @@ The directives provided by the thread manager are:
@item @code{pthread_getschedparam} -
@end itemize
@ifinfo
@node Thread Manager Background, Thread Attributes, Thread Manager Introduction, Thread Manager
@end ifinfo
@section Background
@ifinfo
@menu
* Thread Attributes::
@end menu
@end ifinfo
@ifinfo
@node Thread Attributes, Thread Manager Operations, Thread Manager Background, Thread Manager Background
@end ifinfo
@subsection Thread Attributes
Thread attributes are utilized only at thread creation time.
@@ -107,44 +82,11 @@ All policies utilize the thread priority parameter.
@end table
@ifinfo
@node Thread Manager Operations, Thread Manager Directives, Thread Attributes, Thread Manager
@end ifinfo
@section Operations
@ifinfo
@node Thread Manager Directives, pthread_attr_init, Thread Manager Operations, Thread Manager
@end ifinfo
There is currently no text in this section.
@section Directives
@ifinfo
@menu
* pthread_attr_init::
* pthread_attr_destroy::
* pthread_attr_setdetachstate::
* pthread_attr_getdetachstate::
* pthread_attr_setstacksize::
* pthread_attr_getstacksize::
* pthread_attr_setstackaddr::
* pthread_attr_getstackaddr::
* pthread_attr_setscope::
* pthread_attr_getscope::
* pthread_attr_setinheritsched::
* pthread_attr_getinheritsched::
* pthread_attr_setschedpolicy::
* pthread_attr_getschedpolicy::
* pthread_attr_setschedparam::
* pthread_attr_getschedparam::
* pthread_create::
* pthread_exit::
* pthread_detach::
* pthread_join::
* pthread_self::
* pthread_equal::
* pthread_once::
* pthread_setschedparam::
* pthread_getschedparam::
@end menu
@end ifinfo
This section details the thread manager's directives.
A subsection is dedicated to each of this manager's directives
@@ -152,9 +94,6 @@ and describes the calling sequence, related constants, usage,
and status codes.
@page
@ifinfo
@node pthread_attr_init, pthread_attr_destroy, Thread Manager Directives, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_init
@subheading CALLING SEQUENCE:
@@ -181,9 +120,6 @@ The attribute pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_destroy, pthread_attr_setdetachstate, pthread_attr_init, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_destroy
@subheading CALLING SEQUENCE:
@@ -212,9 +148,6 @@ The attribute set is not initialized.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_setdetachstate, pthread_attr_getdetachstate, pthread_attr_destroy, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_setdetachstate
@subheading CALLING SEQUENCE:
@@ -247,9 +180,6 @@ The detachstate argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_getdetachstate, pthread_attr_setstacksize, pthread_attr_setdetachstate, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_getdetachstate
@subheading CALLING SEQUENCE:
@@ -282,9 +212,6 @@ The detatchstate pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_setstacksize, pthread_attr_getstacksize, pthread_attr_getdetachstate, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_setstacksize
@subheading CALLING SEQUENCE:
@@ -317,9 +244,6 @@ If the specified stacksize is below the minimum required for this CPU, then
the stacksize will be set to the minimum for this CPU.
@page
@ifinfo
@node pthread_attr_getstacksize, pthread_attr_setstackaddr, pthread_attr_setstacksize, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_getstacksize
@subheading CALLING SEQUENCE:
@@ -352,9 +276,6 @@ The stacksize pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_setstackaddr, pthread_attr_getstackaddr, pthread_attr_getstacksize, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_setstackaddr
@subheading CALLING SEQUENCE:
@@ -384,9 +305,6 @@ The attribute set is not initialized.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_getstackaddr, pthread_attr_setscope, pthread_attr_setstackaddr, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_getstackaddr
@subheading CALLING SEQUENCE:
@@ -419,9 +337,6 @@ The stackaddr pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_setscope, pthread_attr_getscope, pthread_attr_getstackaddr, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_setscope
@subheading CALLING SEQUENCE:
@@ -457,9 +372,6 @@ The contention scope specified (PTHREAD_SCOPE_SYSTEM) is not supported.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_getscope, pthread_attr_setinheritsched, pthread_attr_setscope, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_getscope
@subheading CALLING SEQUENCE:
@@ -492,9 +404,6 @@ The contentionscope pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_setinheritsched, pthread_attr_getinheritsched, pthread_attr_getscope, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_setinheritsched
@subheading CALLING SEQUENCE:
@@ -527,9 +436,6 @@ The specified scheduler inheritance argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_getinheritsched, pthread_attr_setschedpolicy, pthread_attr_setinheritsched, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_getinheritsched
@subheading CALLING SEQUENCE:
@@ -561,9 +467,6 @@ The inheritsched pointer argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_setschedpolicy, pthread_attr_getschedpolicy, pthread_attr_getinheritsched, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_setschedpolicy
@subheading CALLING SEQUENCE:
@@ -595,9 +498,6 @@ The specified scheduler policy argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_getschedpolicy, pthread_attr_setschedparam, pthread_attr_setschedpolicy, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_getschedpolicy
@subheading CALLING SEQUENCE:
@@ -629,9 +529,6 @@ The specified scheduler policy argument pointer is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_setschedparam, pthread_attr_getschedparam, pthread_attr_getschedpolicy, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_setschedparam
@subheading CALLING SEQUENCE:
@@ -663,9 +560,6 @@ The specified scheduler parameter argument is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_attr_getschedparam, pthread_create, pthread_attr_setschedparam, Thread Manager Directives
@end ifinfo
@subsection pthread_attr_getschedparam
@subheading CALLING SEQUENCE:
@@ -697,9 +591,6 @@ The specified scheduler parameter argument pointer is invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_create, pthread_exit, pthread_attr_getschedparam, Thread Manager Directives
@end ifinfo
@subsection pthread_create
@subheading CALLING SEQUENCE:
@@ -761,9 +652,6 @@ Invalid argument passed.
@subheading NOTES:
@page
@ifinfo
@node pthread_exit, pthread_detach, pthread_create, Thread Manager Directives
@end ifinfo
@subsection pthread_exit
@subheading CALLING SEQUENCE:
@@ -787,9 +675,6 @@ void pthread_exit(
@subheading NOTES:
@page
@ifinfo
@node pthread_detach, pthread_join, pthread_exit, Thread Manager Directives
@end ifinfo
@subsection pthread_detach
@subheading CALLING SEQUENCE:
@@ -821,9 +706,6 @@ will remain joined with that thread. Any subsequent calls to pthread_join
on the specified thread will fail.
@page
@ifinfo
@node pthread_join, pthread_self, pthread_detach, Thread Manager Directives
@end ifinfo
@subsection pthread_join
@subheading CALLING SEQUENCE:
@@ -861,9 +743,6 @@ on the specified thread will fail.
If value_ptr is NULL, then no value is returned.
@page
@ifinfo
@node pthread_self, pthread_equal, pthread_join, Thread Manager Directives
@end ifinfo
@subsection pthread_self
@subheading CALLING SEQUENCE:
@@ -883,9 +762,6 @@ This routine returns the id of the calling thread.
@subheading NOTES:
@page
@ifinfo
@node pthread_equal, pthread_once, pthread_self, Thread Manager Directives
@end ifinfo
@subsection pthread_equal
@subheading CALLING SEQUENCE:
@@ -917,9 +793,6 @@ The thread ids are equal.
The behavior is undefined if the thread IDs are not valid.
@page
@ifinfo
@node pthread_once, pthread_setschedparam, pthread_equal, Thread Manager Directives
@end ifinfo
@subsection pthread_once
@subheading CALLING SEQUENCE:
@@ -944,9 +817,6 @@ NONE
@subheading NOTES:
@page
@ifinfo
@node pthread_setschedparam, pthread_getschedparam, pthread_once, Thread Manager Directives
@end ifinfo
@subsection pthread_setschedparam
@subheading CALLING SEQUENCE:
@@ -988,9 +858,6 @@ The thread indicated was invalid.
@subheading NOTES:
@page
@ifinfo
@node pthread_getschedparam, Signal Manager, pthread_setschedparam, Thread Manager Directives
@end ifinfo
@subsection pthread_getschedparam
@subheading CALLING SEQUENCE: