ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/users_53.htm

262 lines
9.2 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>pthread_mutexattr_gettype()--Get Mutex Type Attribute</title>
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Begin Header Records ========================================== -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!--File Edited November 2001 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>pthread_mutexattr_gettype()--Get Mutex Type Attribute</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax:
<pre> #include &lt;pthread.h&gt;
int pthread_mutexatttr_gettype(const pthread_mutexattr_t *attr,
int *type);</pre>
&nbsp;&nbsp;Service Program Name: QP0WPTHR<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE <br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Signal Safe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>pthread_mutexattr_gettype</strong>() function retrieves the <em>type</em> attribute from the mutex attributes object specified by <em>attr</em>. The mutex type attribute is used to create mutexes with different behaviors.</p>
<p>The type returned is one of <strong>PTHREAD_MUTEX_DEFAULT</strong>, <strong>PTHREAD_MUTEX_NORMAL</strong>, <strong>PTHREAD_MUTEX_RECURSIVE</strong>, <strong>PTHREAD_MUTEX_ERRORCHECK</strong>, or <strong>PTHREAD_MUTEX_OWNERTERM_NP</strong>.</p>
<p>The default mutex type (or <strong>PTHREAD_MUTEX_DEFAULT</strong>) is <strong>PTHREAD_MUTEX_NORMAL</strong>.</p>
<br>
<h3>Mutex Types</h3>
<p>A normal mutex cannot be locked repeatedly by the owner. Attempts by a thread to relock an already held mutex, or to lock a mutex that was held by another thread when that thread terminated, cause a deadlock condition.</p>
<p>A recursive mutex can be locked repeatedly by the owner. The mutex does not become unlocked until the owner has called <strong>pthread_mutex_unlock</strong>() for each successful lock request that it has outstanding on the mutex.</p>
<p>An errorcheck mutex checks for deadlock conditions that occur when a thread relocks an already held mutex. If a thread attempts to relock a mutex that it already holds, the lock request fails with the <strong>EDEADLK</strong> error.</p>
<p>An ownerterm mutex is an i5/OS extension to the errorcheck mutex type. An ownerterm mutex checks for deadlock conditions that occur when a thread relocks an already held mutex. If a thread attempts to relock a mutex that it already holds, the lock request fails with the <strong>EDEADLK</strong> error. An ownerterm mutex also checks for deadlock conditions that occur when a thread attempts to lock a mutex that was held by another thread when that thread terminated (an orphaned mutex). If a thread attempts to lock an orphaned mutex, the lock request fails with the <strong>EOWNERTERM</strong> error.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>attr</strong></dt>
<dd>(Input) Address of the mutex attributes object</dd>
<dt><strong>type</strong></dt>
<dd>(Output) Address of the variable to receive the type attribute</dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>0</strong></dt>
<dd><strong>pthread_mutexattr_gettype</strong>() was successful.</dd>
<dt><strong>value</strong></dt>
<dd><strong>pthread_mutexattr_gettype</strong>() was not successful. <em>value</em> is set to indicate the error condition.</dd>
</dl>
<br>
<h3>Error Conditions</h3>
<p>If <strong>pthread_mutexatttr_gettype</strong>() was not successful, the error condition returned usually indicates one of the following errors. Under some conditions, the value returned could indicate an error other than those listed here.</p>
<dl>
<dt><em>[EINVAL]</em></dt>
<dd><p>The value specified for the argument is not correct.</p></dd>
</dl>
<br>
<h3>Related Information</h3>
<ul>
<li>The &lt;<strong>pthread.h</strong>> header file. See <a href="rzah4hed.htm">Header files for Pthread functions</a>.<br><br></li>
<li><a href="users_54.htm">pthread_mutexattr_init()</a>--Initialize Mutex Attributes Object<br><br></li>
<li><a href="users_58.htm">pthread_mutexattr_settype()</a>--Set Mutex Type Attribute<br><br></li>
<li><a href="users_61.htm">pthread_mutex_init()</a>--Initialize Mutex</li>
</ul>
<br>
<h3><a name="370641">Example</a></h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<pre>#define _MULTI_THREADED
#include &lt;pthread.h&gt;
#include &lt;stdio.h&gt;
#include &quot;check.h&quot;
int showType(pthread_mutexattr_t *mta) {
int rc;
int type;
printf(&quot;Check type attribute\n&quot;);
rc = pthread_mutexattr_gettype(mta, &amp;type);
checkResults(&quot;pthread_mutexattr_gettype()\n&quot;, rc);
printf(&quot;The type attributed is: &quot;);
switch (type) {
case PTHREAD_MUTEX_NORMAL:
printf(&quot;PTHREAD_MUTEX_NORMAL (DEFAULT)\n&quot;);
break;
case PTHREAD_MUTEX_RECURSIVE:
printf(&quot;PTHREAD_MUTEX_RECURSIVE\n&quot;);
break;
case PTHREAD_MUTEX_ERRORCHECK:
printf(&quot;PTHREAD_MUTEX_ERRORCHECK\n&quot;);
break;
case PTHREAD_MUTEX_OWNERTERM_NP:
printf(&quot;PTHREAD_MUTEX_OWNERTERM_NP\n&quot;);
break;
default :
printf(&quot;! type Error type=%d !\n&quot;, type);
exit(1);
}
return type;
}
int main(int argc, char **argv)
{
int rc=0;
pthread_mutexattr_t mta;
int type=0;
pthread_mutex_t mutex;
struct timespec ts;
printf(&quot;Enter Testcase - %s\n&quot;, argv[0]);
printf(&quot;Create a default mutex attribute\n&quot;);
rc = pthread_mutexattr_init(&amp;mta);
checkResults(&quot;pthread_mutexattr_init()\n&quot;, rc);
printf(&quot;Change mutex type attribute to recursive\n&quot;);
rc = pthread_mutexattr_settype(&amp;mta, PTHREAD_MUTEX_RECURSIVE);
checkResults(&quot;pthread_mutexattr_settype()\n&quot;, rc);
showType(&amp;mta);
rc = pthread_mutexattr_setname_np(&amp;mta, &quot;RECURSIVE ONE&quot;);
checkResults(&quot;pthread_mutexattr_setname_np()\n&quot;, rc);
printf(&quot;Create the named, recursive mutex\n&quot;);
rc = pthread_mutex_init(&amp;mutex, &amp;mta);
checkResults(&quot;pthread_mutex_init()\n&quot;, rc);
printf(&quot;Lock the named, recursive mutex\n&quot;);
rc = pthread_mutex_lock(&amp;mutex);
checkResults(&quot;pthread_mutex_lock() 1\n&quot;, rc);
printf(&quot;ReLock the named, recursive mutex\n&quot;);
rc = pthread_mutex_lock(&amp;mutex);
checkResults(&quot;pthread_mutex_lock() 2\n&quot;, rc);
printf(&quot;Trylock the named, recursive mutex\n&quot;);
rc = pthread_mutex_trylock(&amp;mutex);
checkResults(&quot;pthread_mutex_trylock()\n&quot;, rc);
printf(&quot;Timedlock the named, recursive mutex\n&quot;);
ts.tv_sec = 5;
ts.tv_nsec = 0;
rc = pthread_mutex_timedlock_np(&amp;mutex, &amp;ts);
checkResults(&quot;pthread_mutex_timedlock_np()\n&quot;, rc);
printf(&quot;Sleeping for a short time holding the recurive mutex\n&quot;);
printf(&quot;Use DSPJOB, option 19 to see the held mutex\n&quot;);
sleep(30);
printf(&quot;Unlock the mutex 4 times\n&quot;);
rc = pthread_mutex_unlock(&amp;mutex);
checkResults(&quot;pthread_mutex_unlock() 1\n&quot;, rc);
rc = pthread_mutex_unlock(&amp;mutex);
checkResults(&quot;pthread_mutex_unlock() 2\n&quot;, rc);
rc = pthread_mutex_unlock(&amp;mutex);
checkResults(&quot;pthread_mutex_unlock() 3\n&quot;, rc);
rc = pthread_mutex_unlock(&amp;mutex);
checkResults(&quot;pthread_mutex_unlock() 4\n&quot;, rc);
printf(&quot;Cleanup\n&quot;);
rc = pthread_mutex_destroy(&amp;mutex);
checkResults(&quot;pthread_mutex_destroy()\n&quot;, rc);
rc = pthread_mutexattr_destroy(&amp;mta);
checkResults(&quot;pthread_mutexattr_destroy()\n&quot;, rc);
printf(&quot;Main completed\n&quot;);
return 0;
}</pre>
<p><strong>Output</strong></p>
<pre>Enter Testcase - QP0WTEST/TPMTXTYP0
Create a default mutex attribute
Change mutex type attribute to recursive
Check type attribute
The type attributed is: PTHREAD_MUTEX_RECURSIVE
Create the named, recursive mutex
Lock the named, recursive mutex
ReLock the named, recursive mutex
Trylock the named, recursive mutex
Timedlock the named, recursive mutex
Sleeping for a short time holding the recurive mutex
Use DSPJOB, option 19 to see the held mutex
Unlock the mutex 4 times
Cleanup
Main completed</pre>
<hr>
API introduced: V4R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> |
<a href="rzah4mst.htm">Pthread APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>