238 lines
6.3 KiB
HTML
238 lines
6.3 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_setspecific()--Set Thread Local Storage by Key</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_setspecific()--Set Thread Local Storage by Key</h2>
|
|
|
|
<div class="box" style="width: 65%;">
|
|
<br>
|
|
Syntax:
|
|
|
|
<pre>
|
|
#include <pthread.h>
|
|
int pthread_setspecific(pthread_key_t key, const void *value);
|
|
</pre>
|
|
Service Program Name: QP0WPTHR<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Signal Safe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>pthread_setspecific</strong>() function sets the thread local
|
|
storage <em>value</em> associated with a <em>key</em>. The
|
|
<strong>pthread_setspecific</strong>() function may be called fromwithin a data
|
|
destructor.</p>
|
|
|
|
<p>The thread local storage value is a variable of type void * that is local to
|
|
a thread, but global to all of the functions called within that thread. It is
|
|
accessed by the key.</p>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Parameters</h3>
|
|
|
|
<dl>
|
|
<dt><strong>key</strong></dt>
|
|
|
|
<dd>(Input) The thread local storage key returned from
|
|
<strong>pthread_key_create</strong>().<br><br></dd>
|
|
|
|
<dt><strong>value</strong></dt>
|
|
|
|
<dd>(Input) The pointer to store at the <em>key</em> location for the calling
|
|
thread.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>0</strong></dt>
|
|
|
|
<dd><strong>pthread_setspecific</strong>() was successful.<br><br></dd>
|
|
|
|
<dt><strong>value</strong></dt>
|
|
|
|
<dd><strong>pthread_setspecific</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_setspecific</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 key is not correct.</p></dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li>The <<strong>pthread.h</strong>> header file. See <a href=
|
|
"rzah4hed.htm">Header files for Pthread functions</a>.<br><br></li>
|
|
|
|
<li><a href="users_34.htm">pthread_getspecific()</a>--Get Thread Local Storage
|
|
Value by Key<br><br></li>
|
|
|
|
<li><a href="users_35.htm">pthread_key_create()</a>--Create Thread Local Storage
|
|
Key<br><br></li>
|
|
|
|
<li><a href="users_36.htm">pthread_key_delete()</a>--Delete Thread Local Storage
|
|
Key</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<h3>Example</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 <pthread.h>
|
|
#include <stdio.h>
|
|
#include "check.h"
|
|
|
|
#define NUMTHREADS 3
|
|
pthread_key_t tlsKey = 0;
|
|
|
|
void globalDestructor(void *value)
|
|
{
|
|
printf("In global destructor\n");
|
|
free(value);
|
|
pthread_setspecific(tlsKey, NULL);
|
|
}
|
|
|
|
|
|
void showGlobal(void)
|
|
{
|
|
void *global;
|
|
pthread_id_np_t tid;
|
|
|
|
global = pthread_getspecific(tlsKey);
|
|
pthread_getunique_np((pthread_t *)global, &tid);
|
|
printf("showGlobal: global data stored for thread 0x%.8x %.8x\n",
|
|
tid);
|
|
}
|
|
|
|
void *threadfunc(void *parm)
|
|
{
|
|
int rc;
|
|
int *myThreadDataStructure;
|
|
pthread_t me = pthread_self();
|
|
|
|
printf("Inside secondary thread\n");
|
|
|
|
myThreadDataStructure = malloc(sizeof(pthread_t) + sizeof(int) * 10);
|
|
memcpy(myThreadDataStructure, &me, sizeof(pthread_t));
|
|
pthread_setspecific(tlsKey, myThreadDataStructure);
|
|
showGlobal();
|
|
return NULL;
|
|
}
|
|
|
|
int main(int argc, char **argv)
|
|
{
|
|
pthread_t thread[NUMTHREADS];
|
|
int rc=0;
|
|
int i=0;
|
|
|
|
printf("Enter Testcase - %s\n", argv[0]);
|
|
|
|
printf("Create a thread local storage key\n");
|
|
rc = pthread_key_create(&tlsKey, globalDestructor);
|
|
checkResults("pthread_key_create()\n", rc);
|
|
/* The key can now be used from all threads */
|
|
|
|
printf("Create %d threads using joinable attributes\n",
|
|
NUMTHREADS);
|
|
for (i=0; i<NUMTHREADS; ++i) {
|
|
rc = pthread_create(&thread[i], NULL, threadfunc, NULL);
|
|
checkResults("pthread_create()\n", rc);
|
|
}
|
|
|
|
printf("Join to threads\n");
|
|
for (i=0; i<NUMTHREADS; ++i) {
|
|
rc = pthread_join(thread[i], NULL);
|
|
checkResults("pthread_join()\n", rc);
|
|
}
|
|
|
|
printf("Delete a thread local storage key\n");
|
|
rc = pthread_key_delete(tlsKey);
|
|
checkResults("pthread_key_delete()\n", rc);
|
|
/* The key and any remaining values are now gone. */
|
|
printf("Main completed\n");
|
|
return 0;
|
|
}
|
|
</pre>
|
|
|
|
<p><strong>Output:</strong></p>
|
|
|
|
<pre>
|
|
Enter Testcase - QP0WTEST/TPSETS0
|
|
Create a thread local storage key
|
|
Create 3 threads using joinable attributes
|
|
Join to threads
|
|
Inside secondary thread
|
|
showGlobal: global data stored for thread 0x00000000 0000011a
|
|
In global destructor
|
|
Inside secondary thread
|
|
showGlobal: global data stored for thread 0x00000000 0000011b
|
|
In global destructor
|
|
Inside secondary thread
|
|
showGlobal: global data stored for thread 0x00000000 0000011c
|
|
In global destructor
|
|
Delete a thread local storage key
|
|
Main completed
|
|
</pre>
|
|
<br>
|
|
<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>
|
|
|