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

246 lines
7.6 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!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_rwlock_init()--Initialize Read/Write Lock</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_rwlock_init()--Initialize Read/Write Lock</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax:
<pre> #include &lt;pthread.h&gt;
int pthread_rwlock_init(pthread_rwlock_t *rwlock,
const pthread_rwlockattr_t *attr);</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_rwlock_init</strong>() function initializes a new read/write lock with the specified attributes for use. The new read/write lock may be used immediately for serializing critical resources. If <em>attr</em> is specified as <strong>NULL</strong>, all attributes are set to the default read/write lock attributes for the newly created read/write lock.</p>
<p>With these declarations and initializations:</p>
<pre>pthread_rwlock_t rwlock2;
pthread_rwlock_t rwlock3;
pthread_rwlockattr_t attr;
pthread_rwlockattr_init(&amp;attr);</pre>
<p>The following three read/write lock initialization mechanisms have equivalent function.</p>
<pre>pthread_rwlock_t rwlock1 = PTHREAD_RWLOCK_INITIALIZER;
pthread_rwlock_init(&amp;rwlock2, NULL);
pthread_rwlock_init(&amp;rwlock, &amp;attr);</pre>
<p>All three read/write locks are created with the default read/write lock attributes.</p>
<p>Every read/write lock must eventually be destroyed with <strong>pthread_rwlock_destroy</strong>(). Always use <strong>pthread_rwlock_destroy</strong>() before freeing or reusing read/write lock storage.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>rwlock</strong></dt>
<dd>(Output) The address of the variable to contain a read/write lock</dd>
<dt><strong>attr</strong></dt>
<dd>(Input) The address of the variable containing the read/write lock attributes object</dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>0</strong></dt>
<dd><strong>pthread_rwlock_init</strong>() was successful.</dd>
<dt><strong>value</strong></dt>
<dd><strong>pthread_rwlock_init</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_rwlock_init</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_83.htm">pthread_rwlockattr_init()</a>--Initialize Read/Write Lock Attribute<br><br></li>
<li><a href="users_85.htm">pthread_rwlock_destroy()</a>--Destroy Read/Write Lock</li>
</ul>
<br>
<h3><a name="372485">Example</a></h3>
<pre>#define _MULTI_THREADED
#include &lt;pthread.h&gt;
#include &lt;stdio.h&gt;
#include &quot;check.h&quot;
pthread_rwlock_t rwlock;
void *rdlockThread(void *arg)
{
int rc;
printf(&quot;Entered thread, getting read lock\n&quot;);
rc = pthread_rwlock_rdlock(&amp;rwlock);
checkResults(&quot;pthread_rwlock_rdlock()\n&quot;, rc);
printf(&quot;got the rwlock read lock\n&quot;);
sleep(5);
printf(&quot;unlock the read lock\n&quot;);
rc = pthread_rwlock_unlock(&amp;rwlock);
checkResults(&quot;pthread_rwlock_unlock()\n&quot;, rc);
printf(&quot;Secondary thread unlocked\n&quot;);
return NULL;
}
void *wrlockThread(void *arg)
{
int rc;
printf(&quot;Entered thread, getting write lock\n&quot;);
rc = pthread_rwlock_wrlock(&amp;rwlock);
checkResults(&quot;pthread_rwlock_wrlock()\n&quot;, rc);
printf(&quot;Got the rwlock write lock, now unlock\n&quot;);
rc = pthread_rwlock_unlock(&amp;rwlock);
checkResults(&quot;pthread_rwlock_unlock()\n&quot;, rc);
printf(&quot;Secondary thread unlocked\n&quot;);
return NULL;
}
int main(int argc, char **argv)
{
int rc=0;
pthread_t thread, thread1;
printf(&quot;Enter Testcase - %s\n&quot;, argv[0]);
printf(&quot;Main, initialize the read write lock\n&quot;);
rc = pthread_rwlock_init(&amp;rwlock, NULL);
checkResults(&quot;pthread_rwlock_init()\n&quot;, rc);
printf(&quot;Main, grab a read lock\n&quot;);
rc = pthread_rwlock_rdlock(&amp;rwlock);
checkResults(&quot;pthread_rwlock_rdlock()\n&quot;,rc);
printf(&quot;Main, grab the same read lock again\n&quot;);
rc = pthread_rwlock_rdlock(&amp;rwlock);
checkResults(&quot;pthread_rwlock_rdlock() second\n&quot;, rc);
printf(&quot;Main, create the read lock thread\n&quot;);
rc = pthread_create(&amp;thread, NULL, rdlockThread, NULL);
checkResults(&quot;pthread_create\n&quot;, rc);
printf(&quot;Main - unlock the first read lock\n&quot;);
rc = pthread_rwlock_unlock(&amp;rwlock);
checkResults(&quot;pthread_rwlock_unlock()\n&quot;, rc);
printf(&quot;Main, create the write lock thread\n&quot;);
rc = pthread_create(&amp;thread1, NULL, wrlockThread, NULL);
checkResults(&quot;pthread_create\n&quot;, rc);
sleep(5);
printf(&quot;Main - unlock the second read lock\n&quot;);
rc = pthread_rwlock_unlock(&amp;rwlock);
checkResults(&quot;pthread_rwlock_unlock()\n&quot;, rc);
printf(&quot;Main, wait for the threads\n&quot;);
rc = pthread_join(thread, NULL);
checkResults(&quot;pthread_join\n&quot;, rc);
rc = pthread_join(thread1, NULL);
checkResults(&quot;pthread_join\n&quot;, rc);
rc = pthread_rwlock_destroy(&amp;rwlock);
checkResults(&quot;pthread_rwlock_destroy()\n&quot;, rc);
printf(&quot;Main completed\n&quot;);
return 0;
}</pre>
<p><strong>Output:</strong></p>
<pre>Enter Testcase - QP0WTEST/TPRWLINI0
Main, initialize the read write lock
Main, grab a read lock
Main, grab the same read lock again
Main, create the read lock thread
Main - unlock the first read lock
Main, create the write lock thread
Entered thread, getting read lock
got the rwlock read lock
Entered thread, getting write lock
Main - unlock the second read lock
Main, wait for the threads
unlock the read lock
Secondary thread unlocked
Got the rwlock write lock, now unlock
Secondary thread unlocked
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>