Robust mutexes merged from devel branchpost_merge_with_ROBUST_MUTEXES

author: rpj <rpj> 2011-05-06 02:11:50 +0000
committer: rpj <rpj> 2011-05-06 02:11:50 +0000
commit: 2fe8aba6a8a4ce09f353f34881c77f93a9c01ca3 (patch)
tree: fd7f179b1abaa525ec55e34bef23b12f8fd89021 /manual/pthread_mutexattr_init.html
parent: 941d7cf87c60b55342b51e0b0fcd748589b76167 (diff)
1 files changed, 111 insertions, 61 deletions
diff --git a/manual/pthread_mutexattr_init.html b/manual/pthread_mutexattr_init.html
index f3df993..f69599b 100644
--- a/manual/pthread_mutexattr_init.html
+++ b/manual/pthread_mutexattr_init.html
@@ -3,22 +3,32 @@
 <HEAD>
 	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
 	<TITLE>PTHREAD_MUTEXATTR(3) manual page</TITLE>
-	<META NAME="GENERATOR" CONTENT="OpenOffice.org 1.1.3  (Linux)">
+	<META NAME="GENERATOR" CONTENT="OpenOffice.org 3.2  (Linux)">
 	<META NAME="CREATED" CONTENT="20050504;23040500">
-	<META NAME="CHANGED" CONTENT="20050505;18370400">
+	<META NAME="CHANGEDBY" CONTENT="Ross Johnson">
+	<META NAME="CHANGED" CONTENT="20110326;13190500">
 	<!-- manual page source format generated by PolyglotMan v3.2, -->
 	<!-- available at http://polyglotman.sourceforge.net/ -->
+	<STYLE TYPE="text/css">
+	<!--
+		H4.cjk { font-family: "AR PL UMing CN" }
+		H4.ctl { font-family: "Lohit Devanagari" }
+		H2.cjk { font-family: "AR PL UMing CN" }
+		H2.ctl { font-family: "Lohit Devanagari" }
+	-->
+	</STYLE>
 </HEAD>
 <BODY LANG="en-GB" BGCOLOR="#ffffff" DIR="LTR">
-<H4>POSIX Threads for Windows – REFERENCE - <A HREF="http://sources.redhat.com/pthreads-win32">Pthreads-w32</A></H4>
+<H4 CLASS="western">POSIX Threads for Windows – REFERENCE -
+<A HREF="http://sources.redhat.com/pthreads-win32">Pthreads-w32</A></H4>
 <P><A HREF="index.html">Reference Index</A></P>
 <P><A HREF="#toc">Table of Contents</A></P>
-<H2><A HREF="#toc0" NAME="sect0">Name</A></H2>
+<H2 CLASS="western"><A HREF="#toc0" NAME="sect0">Name</A></H2>
 <P>pthread_mutexattr_init, pthread_mutexattr_destroy,
 pthread_mutexattr_settype, pthread_mutexattr_gettype - mutex creation
 attributes 
 </P>
-<H2><A HREF="#toc1" NAME="sect1">Synopsis</A></H2>
+<H2 CLASS="western"><A HREF="#toc1" NAME="sect1">Synopsis</A></H2>
 <P><B>#include &lt;pthread.h&gt;</B> 
 </P>
 <P><B>int pthread_mutexattr_init(pthread_mutexattr_t *</B><I>attr</I><B>);</B>
@@ -37,7 +47,13 @@ int </B><I>type</I><B>);</B>
 <P><B>int pthread_mutexattr_getkind_np(const pthread_mutexattr_t
 *</B><I>attr</I><B>, int *</B><I>type</I><B>);</B> 
 </P>
-<H2><A HREF="#toc2" NAME="sect2">Description</A></H2>
+<P><B>int pthread_mutexattr_setrobust(pthread_mutexattr_t *</B><I>attr</I><B>,
+int</B><SPAN STYLE="font-weight: normal"> </SPAN><I><SPAN STYLE="font-weight: normal">robust</SPAN></I><B>);</B>
+</P>
+<P><B>int pthread_mutexattr_getrobust(pthread_mutexattr_t *</B><I>attr</I><B>,
+int</B><SPAN STYLE="font-weight: normal"> </SPAN><B>*</B><I><SPAN STYLE="font-weight: normal">robust</SPAN></I><B>);</B>
+</P>
+<H2 CLASS="western"><A HREF="#toc2" NAME="sect2">Description</A></H2>
 <P>Mutex attributes can be specified at mutex creation time, by
 passing a mutex attribute object as second argument to
 <A HREF="pthread_mutex_init.html"><B>pthread_mutex_init</B>(3)</A> .
@@ -50,12 +66,27 @@ attributes.
 </P>
 <P><B>pthread_mutexattr_destroy</B> destroys a mutex attribute
 object, which must not be reused until it is reinitialized.</P>
+<P><B>pthread_mutexattr_settype</B> sets the mutex type attribute in
+<I>attr</I> to the value specified by <I>type</I>. 
+</P>
+<P><B>pthread_mutexattr_gettype</B> retrieves the current value of
+the mutex kind attribute in <I>attr</I> and stores it in the location
+pointed to by <I>type</I>. 
+</P>
+<P><B>Pthreads-w32</B> also recognises the following equivalent
+functions that are used in Linux:</P>
+<P><B>pthread_mutexattr_setkind_np</B> is an alias for
+<B>pthread_mutexattr_settype</B>. 
+</P>
+<P STYLE="font-weight: normal"><B>pthread_mutexattr_getkind_np</B> is
+an alias for <B>pthread_mutexattr_gettype</B>. 
+</P>
 <P>The following mutex types are supported:</P>
-<P STYLE="margin-left: 2cm"><B>PTHREAD_MUTEX_NORMAL</B> - for
+<P STYLE="margin-left: 0.79in"><B>PTHREAD_MUTEX_NORMAL</B> - for
 ‘‘fast’’ mutexes.</P>
-<P STYLE="margin-left: 2cm"><B>PTHREAD_MUTEX_RECURSIVE</B> - for
+<P STYLE="margin-left: 0.79in"><B>PTHREAD_MUTEX_RECURSIVE</B> - for
 ‘‘recursive’’ mutexes.</P>
-<P STYLE="margin-left: 2cm"><B>PTHREAD_MUTEX_ERRORCHECK</B> - for
+<P STYLE="margin-left: 0.79in"><B>PTHREAD_MUTEX_ERRORCHECK</B> - for
 ‘‘error checking’’ mutexes.</P>
 <P>The mutex type determines what happens if a thread attempts to
 lock a mutex it already owns with <A HREF="pthread_mutex_lock.html"><B>pthread_mutex_lock</B>(3)</A>
@@ -75,83 +106,102 @@ state.
 <P>The default mutex type is <B>PTHREAD_MUTEX_NORMAL</B></P>
 <P><B>Pthreads-w32</B> also recognises the following equivalent types
 that are used by Linux:</P>
-<P STYLE="margin-left: 2cm; font-weight: medium"><B>PTHREAD_MUTEX_FAST_NP</B>
+<P STYLE="margin-left: 0.79in; font-weight: normal"><B>PTHREAD_MUTEX_FAST_NP</B>
 – equivalent to <B>PTHREAD_MUTEX_NORMAL</B></P>
-<P STYLE="margin-left: 2cm"><B>PTHREAD_MUTEX_RECURSIVE_NP</B></P>
-<P STYLE="margin-left: 2cm"><B>PTHREAD_MUTEX_ERRORCHECK_NP</B></P>
-<P><B>pthread_mutexattr_settype</B> sets the mutex type attribute in
-<I>attr</I> to the value specified by <I>type</I>. 
-</P>
-<P><B>pthread_mutexattr_gettype</B> retrieves the current value of
-the mutex kind attribute in <I>attr</I> and stores it in the location
-pointed to by <I>type</I>. 
-</P>
-<P><B>Pthreads-w32</B> also recognises the following equivalent
-functions that are used in Linux:</P>
-<P><B>pthread_mutexattr_setkind_np</B> is an alias for
-<B>pthread_mutexattr_settype</B>. 
-</P>
-<P STYLE="font-weight: medium"><B>pthread_mutexattr_getkind_np</B> is
-an alias for <B>pthread_mutexattr_gettype</B>. 
-</P>
-<H2><A HREF="#toc3" NAME="sect3">Return Value</A></H2>
-<P><B>pthread_mutexattr_init</B>, <B>pthread_mutexattr_destroy</B>
-and <B>pthread_mutexattr_gettype</B> always return 0. 
-</P>
-<P><B>pthread_mutexattr_settype</B> returns 0 on success and a
-non-zero error code on error. 
-</P>
-<H2><A HREF="#toc4" NAME="sect4">Errors</A></H2>
-<P>On error, <B>pthread_mutexattr_settype</B> returns the following
-error code: 
-</P>
+<P STYLE="margin-left: 0.79in"><B>PTHREAD_MUTEX_RECURSIVE_NP</B></P>
+<P STYLE="margin-left: 0.79in"><B>PTHREAD_MUTEX_ERRORCHECK_NP</B></P>
+<P><B>pthread_mutexattr_setrobust</B><SPAN STYLE="font-weight: normal">
+sets the robustness attribute to the value given by </SPAN><I><SPAN STYLE="font-weight: normal">robust</SPAN></I><SPAN STYLE="font-weight: normal">.</SPAN></P>
+<P><B>pthread_mutexattr_getrobust</B><SPAN STYLE="font-weight: normal">
+returns the current robustness value to the location given by
+*</SPAN><I><SPAN STYLE="font-weight: normal">robust</SPAN></I><SPAN STYLE="font-weight: normal">.</SPAN></P>
+<P><SPAN STYLE="font-weight: normal">The possible values for </SPAN><I><SPAN STYLE="font-weight: normal">robust</SPAN></I><SPAN STYLE="font-weight: normal">
+are:</SPAN></P>
+<P STYLE="margin-left: 0.79in"><B>PTHREAD_MUTEX_STALLED</B><SPAN STYLE="font-weight: normal">
+- when the owner of the mutex terminates without unlocking the mutex,
+all subsequent calls
+ to pthread_mutex_*lock() are blocked from
+progress in an unspecified manner.</SPAN></P>
+<P STYLE="margin-left: 0.79in"><B>PTHREAD_MUTEX_ROBUST</B><SPAN STYLE="font-weight: normal">
+- when the owner of the mutex terminates without unlocking the mutex,
+the mutex is
+ unlocked. The next owner of this mutex acquires the
+mutex with an error return of
+EOWNERDEAD.</SPAN></P>
+<H2 CLASS="western"><A HREF="#toc3" NAME="sect3">Return Value</A></H2>
+<P><SPAN STYLE="font-weight: normal">On success all functions return
+0, otherwise they return an error code as follows:</SPAN></P>
+<P><B>pthread_mutexattr_init</B></P>
+<P STYLE="margin-left: 0.79in"><B>ENOMEM</B><SPAN STYLE="font-weight: normal">
+- insufficient memory for </SPAN><I><SPAN STYLE="font-weight: normal">attr</SPAN></I><SPAN STYLE="font-weight: normal">.</SPAN></P>
+<P><B>pthread_mutexattr_destroy</B></P>
+<P STYLE="margin-left: 0.79in"><B>EINVAL</B><SPAN STYLE="font-weight: normal">
+- </SPAN><I><SPAN STYLE="font-weight: normal">attr</SPAN></I><SPAN STYLE="font-weight: normal">
+is invalid.</SPAN></P>
+<P><B>pthread_mutexattr_gettype</B></P>
+<P STYLE="margin-left: 0.79in"><B>EINVAL</B><SPAN STYLE="font-weight: normal">
+- </SPAN><I><SPAN STYLE="font-weight: normal">attr</SPAN></I><SPAN STYLE="font-weight: normal">
+is invalid.</SPAN></P>
+<P><B>pthread_mutexattr_settype</B></P>
 <DL>
-	<DT><B>EINVAL</B> 
-	</DT><DD STYLE="margin-bottom: 0.5cm">
-	<I>type</I> is none of:<BR><B>PTHREAD_MUTEX_NORMAL</B>,
-	<B>PTHREAD_MUTEX_FAST_NP</B>,<BR><B>PTHREAD_MUTEX_RECURSIVE</B>,
-	<B>PTHREAD_MUTEX_RECURSIVE_NP,<BR>PTHREAD_MUTEX_ERRORCHECK</B>,
-	<B>PTHREAD_MUTEX_ERRORCHECK_NP</B> 
+	<DL>
+		<DL>
+			<DT><B>EINVAL</B><SPAN STYLE="font-weight: normal"> - </SPAN><I><SPAN STYLE="font-weight: normal">attr</SPAN></I><SPAN STYLE="font-weight: normal">
+			is invalid or </SPAN><I><SPAN STYLE="font-weight: normal">type</SPAN></I><SPAN STYLE="font-weight: normal">
+			is none of:</SPAN></DT><DL>
+				<DL>
+					<DT>
+					<B>PTHREAD_MUTEX_NORMAL<BR>PTHREAD_MUTEX_FAST_NP<BR>PTHREAD_MUTEX_RECURSIVE<BR>PTHREAD_MUTEX_RECURSIVE_NP<BR>PTHREAD_MUTEX_ERRORCHECK<BR>PTHREAD_MUTEX_ERRORCHECK_NP</B></DT></DL>
+			</DL>
+		</DL>
+	</DL>
+	<DD STYLE="margin-left: 0in">
+	<BR>
 	</DD></DL>
-<H2>
-<A HREF="#toc5" NAME="sect5">Author</A></H2>
+<P>
+<B>pthread_mutexattr_getrobust</B></P>
+<P STYLE="margin-left: 0.79in"><B>EINVAL</B><SPAN STYLE="font-weight: normal">
+– </SPAN><I><SPAN STYLE="font-weight: normal">attr</SPAN></I><SPAN STYLE="font-weight: normal">
+or </SPAN><I><SPAN STYLE="font-weight: normal">robust</SPAN></I><SPAN STYLE="font-weight: normal">
+is invalid.</SPAN></P>
+<P><B>pthread_mutexattr_setrobust</B></P>
+<P STYLE="margin-left: 0.79in"><B>EINVAL</B><SPAN STYLE="font-weight: normal">
+– </SPAN><I><SPAN STYLE="font-weight: normal">attr</SPAN></I><SPAN STYLE="font-weight: normal">
+or </SPAN><I><SPAN STYLE="font-weight: normal">robust</SPAN></I><SPAN STYLE="font-weight: normal">
+is invalid.</SPAN></P>
+<H2 CLASS="western"><A HREF="#toc5" NAME="sect5">Author</A></H2>
 <P>Xavier Leroy &lt;Xavier.Leroy@inria.fr&gt; 
 </P>
 <P>Modified by Ross Johnson for use with <A HREF="http://sources.redhat.com/pthreads-win32">Pthreads-w32</A>.</P>
-<H2><A HREF="#toc6" NAME="sect6">See Also</A></H2>
+<H2 CLASS="western"><A HREF="#toc6" NAME="sect6">See Also</A></H2>
 <P><A HREF="pthread_mutex_init.html"><B>pthread_mutex_init</B>(3)</A>
 , <A HREF="pthread_mutex_lock.html"><B>pthread_mutex_lock</B>(3)</A>
 , <A HREF="pthread_mutex_unlock.html"><B>pthread_mutex_unlock</B>(3)</A>
 . 
 </P>
-<H2><A HREF="#toc7" NAME="sect7"><U><FONT COLOR="#000080">Notes</FONT></U></A></H2>
+<H2 CLASS="western"><A HREF="#toc7" NAME="sect7"><FONT COLOR="#000080"><U>Notes</U></FONT></A></H2>
 <P>For speed, <B>Pthreads-w32</B> never checks the thread ownership
-of mutexes of type <B>PTHREAD_MUTEX_NORMAL</B> (or
+of non-robust mutexes of type <B>PTHREAD_MUTEX_NORMAL</B> (or
 <B>PTHREAD_MUTEX_FAST_NP</B>) when performing operations on the
 mutex. It is therefore possible for one thread to lock such a mutex
 and another to unlock it.</P>
-<P><SPAN STYLE="font-weight: medium">When developing code, it is a
-common precaution to substitute the error checking type, and drop in
-the normal type for release if the extra performance is required.</SPAN></P>
+<P STYLE="font-weight: normal">When developing code, it is a common
+precaution to substitute the error checking type, then drop in the
+normal type for release if the extra performance is required.</P>
 <HR>
 <P><A NAME="toc"></A><B>Table of Contents</B></P>
 <UL>
-	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect0" NAME="toc0">Name</A>
+	<LI><P STYLE="margin-bottom: 0in"><A HREF="#sect0" NAME="toc0">Name</A>
 		</P>
-	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect1" NAME="toc1">Synopsis</A>
+	<LI><P STYLE="margin-bottom: 0in"><A HREF="#sect1" NAME="toc1">Synopsis</A>
 		</P>
-	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect2" NAME="toc2">Description</A>
+	<LI><P STYLE="margin-bottom: 0in"><A HREF="#sect2" NAME="toc2">Description</A>
 		</P>
-	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect3" NAME="toc3">Return
+	<LI><P STYLE="margin-bottom: 0in"><A HREF="#sect3" NAME="toc3">Return
 	Value</A> 
 	</P>
-	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect4" NAME="toc4">Errors</A>
-		</P>
-	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect5" NAME="toc5">Author</A>
+	<LI><P STYLE="margin-bottom: 0in"><A HREF="#sect5" NAME="toc5">Author</A>
 		</P>
-	<LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect6" NAME="toc6">See
+	<LI><P STYLE="margin-bottom: 0in"><A HREF="#sect6" NAME="toc6">See
 	Also</A></P>
 	<LI><P><A HREF="#sect7" NAME="toc7">Notes</A></P>
 </UL>
 </BODY>
-</HTML>
+</HTML>
+\ No newline at end of file
author	rpj <rpj>	2011-05-06 02:11:50 +0000
committer	rpj <rpj>	2011-05-06 02:11:50 +0000
commit	2fe8aba6a8a4ce09f353f34881c77f93a9c01ca3 (patch)
tree	fd7f179b1abaa525ec55e34bef23b12f8fd89021 /manual/pthread_mutexattr_init.html
parent	941d7cf87c60b55342b51e0b0fcd748589b76167 (diff)