xref: /relibc/pthreads-emb/pthread_key_delete.c (revision 062c5bc4dfeed2c1bed58ed4810dd27adb32c68d)
1*062c5bc4SJason Schmidlapp /*
2*062c5bc4SJason Schmidlapp  * pthread_key_delete.c
3*062c5bc4SJason Schmidlapp  *
4*062c5bc4SJason Schmidlapp  * Description:
5*062c5bc4SJason Schmidlapp  * POSIX thread functions which implement thread-specific data (TSD).
6*062c5bc4SJason Schmidlapp  *
7*062c5bc4SJason Schmidlapp  * --------------------------------------------------------------------------
8*062c5bc4SJason Schmidlapp  *
9*062c5bc4SJason Schmidlapp  *      Pthreads-embedded (PTE) - POSIX Threads Library for embedded systems
10*062c5bc4SJason Schmidlapp  *      Copyright(C) 2008 Jason Schmidlapp
11*062c5bc4SJason Schmidlapp  *
12*062c5bc4SJason Schmidlapp  *      Contact Email: jschmidlapp@users.sourceforge.net
13*062c5bc4SJason Schmidlapp  *
14*062c5bc4SJason Schmidlapp  *
15*062c5bc4SJason Schmidlapp  *      Based upon Pthreads-win32 - POSIX Threads Library for Win32
16*062c5bc4SJason Schmidlapp  *      Copyright(C) 1998 John E. Bossom
17*062c5bc4SJason Schmidlapp  *      Copyright(C) 1999,2005 Pthreads-win32 contributors
18*062c5bc4SJason Schmidlapp  *
19*062c5bc4SJason Schmidlapp  *      Contact Email: rpj@callisto.canberra.edu.au
20*062c5bc4SJason Schmidlapp  *
21*062c5bc4SJason Schmidlapp  *      The original list of contributors to the Pthreads-win32 project
22*062c5bc4SJason Schmidlapp  *      is contained in the file CONTRIBUTORS.ptw32 included with the
23*062c5bc4SJason Schmidlapp  *      source code distribution. The list can also be seen at the
24*062c5bc4SJason Schmidlapp  *      following World Wide Web location:
25*062c5bc4SJason Schmidlapp  *      http://sources.redhat.com/pthreads-win32/contributors.html
26*062c5bc4SJason Schmidlapp  *
27*062c5bc4SJason Schmidlapp  *      This library is free software; you can redistribute it and/or
28*062c5bc4SJason Schmidlapp  *      modify it under the terms of the GNU Lesser General Public
29*062c5bc4SJason Schmidlapp  *      License as published by the Free Software Foundation; either
30*062c5bc4SJason Schmidlapp  *      version 2 of the License, or (at your option) any later version.
31*062c5bc4SJason Schmidlapp  *
32*062c5bc4SJason Schmidlapp  *      This library is distributed in the hope that it will be useful,
33*062c5bc4SJason Schmidlapp  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
34*062c5bc4SJason Schmidlapp  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
35*062c5bc4SJason Schmidlapp  *      Lesser General Public License for more details.
36*062c5bc4SJason Schmidlapp  *
37*062c5bc4SJason Schmidlapp  *      You should have received a copy of the GNU Lesser General Public
38*062c5bc4SJason Schmidlapp  *      License along with this library in the file COPYING.LIB;
39*062c5bc4SJason Schmidlapp  *      if not, write to the Free Software Foundation, Inc.,
40*062c5bc4SJason Schmidlapp  *      59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
41*062c5bc4SJason Schmidlapp  */
42*062c5bc4SJason Schmidlapp 
43*062c5bc4SJason Schmidlapp #include <stdio.h>
44*062c5bc4SJason Schmidlapp #include <stdlib.h>
45*062c5bc4SJason Schmidlapp 
46*062c5bc4SJason Schmidlapp 
47*062c5bc4SJason Schmidlapp #include "pthread.h"
48*062c5bc4SJason Schmidlapp #include "implement.h"
49*062c5bc4SJason Schmidlapp 
50*062c5bc4SJason Schmidlapp 
51*062c5bc4SJason Schmidlapp int
pthread_key_delete(pthread_key_t key)52*062c5bc4SJason Schmidlapp pthread_key_delete (pthread_key_t key)
53*062c5bc4SJason Schmidlapp /*
54*062c5bc4SJason Schmidlapp  * ------------------------------------------------------
55*062c5bc4SJason Schmidlapp  * DOCPUBLIC
56*062c5bc4SJason Schmidlapp  *      This function deletes a thread-specific data key. This
57*062c5bc4SJason Schmidlapp  *      does not change the value of the thread specific data key
58*062c5bc4SJason Schmidlapp  *      for any thread and does not run the key's destructor
59*062c5bc4SJason Schmidlapp  *      in any thread so it should be used with caution.
60*062c5bc4SJason Schmidlapp  *
61*062c5bc4SJason Schmidlapp  * PARAMETERS
62*062c5bc4SJason Schmidlapp  *      key
63*062c5bc4SJason Schmidlapp  *              pointer to an instance of pthread_key_t
64*062c5bc4SJason Schmidlapp  *
65*062c5bc4SJason Schmidlapp  *
66*062c5bc4SJason Schmidlapp  * DESCRIPTION
67*062c5bc4SJason Schmidlapp  *      This function deletes a thread-specific data key. This
68*062c5bc4SJason Schmidlapp  *      does not change the value of the thread specific data key
69*062c5bc4SJason Schmidlapp  *      for any thread and does not run the key's destructor
70*062c5bc4SJason Schmidlapp  *      in any thread so it should be used with caution.
71*062c5bc4SJason Schmidlapp  *
72*062c5bc4SJason Schmidlapp  * RESULTS
73*062c5bc4SJason Schmidlapp  *              0               successfully deleted the key,
74*062c5bc4SJason Schmidlapp  *              EINVAL          key is invalid,
75*062c5bc4SJason Schmidlapp  *
76*062c5bc4SJason Schmidlapp  * ------------------------------------------------------
77*062c5bc4SJason Schmidlapp  */
78*062c5bc4SJason Schmidlapp {
79*062c5bc4SJason Schmidlapp   int result = 0;
80*062c5bc4SJason Schmidlapp 
81*062c5bc4SJason Schmidlapp   if (key != NULL)
82*062c5bc4SJason Schmidlapp     {
83*062c5bc4SJason Schmidlapp       if (key->threads != NULL &&
84*062c5bc4SJason Schmidlapp           key->destructor != NULL &&
85*062c5bc4SJason Schmidlapp           pthread_mutex_lock (&(key->keyLock)) == 0)
86*062c5bc4SJason Schmidlapp         {
87*062c5bc4SJason Schmidlapp           ThreadKeyAssoc *assoc;
88*062c5bc4SJason Schmidlapp           /*
89*062c5bc4SJason Schmidlapp            * Run through all Thread<-->Key associations
90*062c5bc4SJason Schmidlapp            * for this key.
91*062c5bc4SJason Schmidlapp            *
92*062c5bc4SJason Schmidlapp            * While we hold at least one of the locks guarding
93*062c5bc4SJason Schmidlapp            * the assoc, we know that the assoc pointed to by
94*062c5bc4SJason Schmidlapp            * key->threads is valid.
95*062c5bc4SJason Schmidlapp            */
96*062c5bc4SJason Schmidlapp           while ((assoc = (ThreadKeyAssoc *) key->threads) != NULL)
97*062c5bc4SJason Schmidlapp             {
98*062c5bc4SJason Schmidlapp               pte_thread_t * thread = assoc->thread;
99*062c5bc4SJason Schmidlapp 
100*062c5bc4SJason Schmidlapp               if (assoc == NULL)
101*062c5bc4SJason Schmidlapp                 {
102*062c5bc4SJason Schmidlapp                   /* Finished */
103*062c5bc4SJason Schmidlapp                   break;
104*062c5bc4SJason Schmidlapp                 }
105*062c5bc4SJason Schmidlapp 
106*062c5bc4SJason Schmidlapp               if (pthread_mutex_lock (&(thread->threadLock)) == 0)
107*062c5bc4SJason Schmidlapp                 {
108*062c5bc4SJason Schmidlapp                   /*
109*062c5bc4SJason Schmidlapp                    * Since we are starting at the head of the key's threads
110*062c5bc4SJason Schmidlapp                    * chain, this will also point key->threads at the next assoc.
111*062c5bc4SJason Schmidlapp                    * While we hold key->keyLock, no other thread can insert
112*062c5bc4SJason Schmidlapp                    * a new assoc via pthread_setspecific.
113*062c5bc4SJason Schmidlapp                    */
114*062c5bc4SJason Schmidlapp                   pte_tkAssocDestroy (assoc);
115*062c5bc4SJason Schmidlapp                   (void) pthread_mutex_unlock (&(thread->threadLock));
116*062c5bc4SJason Schmidlapp                 }
117*062c5bc4SJason Schmidlapp               else
118*062c5bc4SJason Schmidlapp                 {
119*062c5bc4SJason Schmidlapp                   /* Thread or lock is no longer valid? */
120*062c5bc4SJason Schmidlapp                   pte_tkAssocDestroy (assoc);
121*062c5bc4SJason Schmidlapp                 }
122*062c5bc4SJason Schmidlapp             }
123*062c5bc4SJason Schmidlapp           pthread_mutex_unlock (&(key->keyLock));
124*062c5bc4SJason Schmidlapp         }
125*062c5bc4SJason Schmidlapp 
126*062c5bc4SJason Schmidlapp       pte_osTlsFree (key->key);
127*062c5bc4SJason Schmidlapp       if (key->destructor != NULL)
128*062c5bc4SJason Schmidlapp         {
129*062c5bc4SJason Schmidlapp           /* A thread could be holding the keyLock */
130*062c5bc4SJason Schmidlapp           while (EBUSY == (result = pthread_mutex_destroy (&(key->keyLock))))
131*062c5bc4SJason Schmidlapp             {
132*062c5bc4SJason Schmidlapp               pte_osThreadSleep(1); // Ugly.
133*062c5bc4SJason Schmidlapp             }
134*062c5bc4SJason Schmidlapp         }
135*062c5bc4SJason Schmidlapp 
136*062c5bc4SJason Schmidlapp       free (key);
137*062c5bc4SJason Schmidlapp     }
138*062c5bc4SJason Schmidlapp 
139*062c5bc4SJason Schmidlapp   return (result);
140*062c5bc4SJason Schmidlapp }
141