1062c5bc4SJason Schmidlapp /*
2062c5bc4SJason Schmidlapp * pthread_join.c
3062c5bc4SJason Schmidlapp *
4062c5bc4SJason Schmidlapp * Description:
5062c5bc4SJason Schmidlapp * This translation unit implements functions related to thread
6062c5bc4SJason Schmidlapp * synchronisation.
7062c5bc4SJason Schmidlapp *
8062c5bc4SJason Schmidlapp * --------------------------------------------------------------------------
9062c5bc4SJason Schmidlapp *
10062c5bc4SJason Schmidlapp * Pthreads-embedded (PTE) - POSIX Threads Library for embedded systems
11062c5bc4SJason Schmidlapp * Copyright(C) 2008 Jason Schmidlapp
12062c5bc4SJason Schmidlapp *
13062c5bc4SJason Schmidlapp * Contact Email: jschmidlapp@users.sourceforge.net
14062c5bc4SJason Schmidlapp *
15062c5bc4SJason Schmidlapp *
16062c5bc4SJason Schmidlapp * Based upon Pthreads-win32 - POSIX Threads Library for Win32
17062c5bc4SJason Schmidlapp * Copyright(C) 1998 John E. Bossom
18062c5bc4SJason Schmidlapp * Copyright(C) 1999,2005 Pthreads-win32 contributors
19062c5bc4SJason Schmidlapp *
20062c5bc4SJason Schmidlapp * Contact Email: rpj@callisto.canberra.edu.au
21062c5bc4SJason Schmidlapp *
22062c5bc4SJason Schmidlapp * The original list of contributors to the Pthreads-win32 project
23062c5bc4SJason Schmidlapp * is contained in the file CONTRIBUTORS.ptw32 included with the
24062c5bc4SJason Schmidlapp * source code distribution. The list can also be seen at the
25062c5bc4SJason Schmidlapp * following World Wide Web location:
26062c5bc4SJason Schmidlapp * http://sources.redhat.com/pthreads-win32/contributors.html
27062c5bc4SJason Schmidlapp *
28062c5bc4SJason Schmidlapp * This library is free software; you can redistribute it and/or
29062c5bc4SJason Schmidlapp * modify it under the terms of the GNU Lesser General Public
30062c5bc4SJason Schmidlapp * License as published by the Free Software Foundation; either
31062c5bc4SJason Schmidlapp * version 2 of the License, or (at your option) any later version.
32062c5bc4SJason Schmidlapp *
33062c5bc4SJason Schmidlapp * This library is distributed in the hope that it will be useful,
34062c5bc4SJason Schmidlapp * but WITHOUT ANY WARRANTY; without even the implied warranty of
35062c5bc4SJason Schmidlapp * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
36062c5bc4SJason Schmidlapp * Lesser General Public License for more details.
37062c5bc4SJason Schmidlapp *
38062c5bc4SJason Schmidlapp * You should have received a copy of the GNU Lesser General Public
39062c5bc4SJason Schmidlapp * License along with this library in the file COPYING.LIB;
40062c5bc4SJason Schmidlapp * if not, write to the Free Software Foundation, Inc.,
41062c5bc4SJason Schmidlapp * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
42062c5bc4SJason Schmidlapp */
43062c5bc4SJason Schmidlapp
44062c5bc4SJason Schmidlapp #include <pte_osal.h>
45062c5bc4SJason Schmidlapp
46062c5bc4SJason Schmidlapp #include "pthread.h"
47062c5bc4SJason Schmidlapp #include "implement.h"
48062c5bc4SJason Schmidlapp
49062c5bc4SJason Schmidlapp #include <stdio.h>
50062c5bc4SJason Schmidlapp
51062c5bc4SJason Schmidlapp int
pthread_join(pthread_t thread,void ** value_ptr)52062c5bc4SJason Schmidlapp pthread_join (pthread_t thread, void **value_ptr)
53062c5bc4SJason Schmidlapp /*
54062c5bc4SJason Schmidlapp * ------------------------------------------------------
55062c5bc4SJason Schmidlapp * DOCPUBLIC
56062c5bc4SJason Schmidlapp * This function waits for 'thread' to terminate and
57062c5bc4SJason Schmidlapp * returns the thread's exit value if 'value_ptr' is not
58062c5bc4SJason Schmidlapp * NULL. This also detaches the thread on successful
59062c5bc4SJason Schmidlapp * completion.
60062c5bc4SJason Schmidlapp *
61062c5bc4SJason Schmidlapp * PARAMETERS
62062c5bc4SJason Schmidlapp * thread
63062c5bc4SJason Schmidlapp * an instance of pthread_t
64062c5bc4SJason Schmidlapp *
65062c5bc4SJason Schmidlapp * value_ptr
66062c5bc4SJason Schmidlapp * pointer to an instance of pointer to void
67062c5bc4SJason Schmidlapp *
68062c5bc4SJason Schmidlapp *
69062c5bc4SJason Schmidlapp * DESCRIPTION
70062c5bc4SJason Schmidlapp * This function waits for 'thread' to terminate and
71062c5bc4SJason Schmidlapp * returns the thread's exit value if 'value_ptr' is not
72062c5bc4SJason Schmidlapp * NULL. This also detaches the thread on successful
73062c5bc4SJason Schmidlapp * completion.
74062c5bc4SJason Schmidlapp * NOTE: detached threads cannot be joined or canceled
75062c5bc4SJason Schmidlapp *
76062c5bc4SJason Schmidlapp * RESULTS
77062c5bc4SJason Schmidlapp * 0 'thread' has completed
78062c5bc4SJason Schmidlapp * EINVAL thread is not a joinable thread,
79062c5bc4SJason Schmidlapp * ESRCH no thread could be found with ID 'thread',
80062c5bc4SJason Schmidlapp * ENOENT thread couldn't find it's own valid handle,
81062c5bc4SJason Schmidlapp * EDEADLK attempt to join thread with self
82062c5bc4SJason Schmidlapp *
83062c5bc4SJason Schmidlapp * ------------------------------------------------------
84062c5bc4SJason Schmidlapp */
85062c5bc4SJason Schmidlapp {
86062c5bc4SJason Schmidlapp int result;
87062c5bc4SJason Schmidlapp pthread_t self;
88*a12978ccSJeremy Soller pte_thread_t * tp = (pte_thread_t *) thread;
89062c5bc4SJason Schmidlapp
90062c5bc4SJason Schmidlapp
91062c5bc4SJason Schmidlapp pte_osMutexLock (pte_thread_reuse_lock);
92062c5bc4SJason Schmidlapp
93*a12978ccSJeremy Soller if (NULL == tp)
94062c5bc4SJason Schmidlapp {
95062c5bc4SJason Schmidlapp result = ESRCH;
96062c5bc4SJason Schmidlapp }
97062c5bc4SJason Schmidlapp else if (PTHREAD_CREATE_DETACHED == tp->detachState)
98062c5bc4SJason Schmidlapp {
99062c5bc4SJason Schmidlapp result = EINVAL;
100062c5bc4SJason Schmidlapp }
101062c5bc4SJason Schmidlapp else
102062c5bc4SJason Schmidlapp {
103062c5bc4SJason Schmidlapp result = 0;
104062c5bc4SJason Schmidlapp }
105062c5bc4SJason Schmidlapp
106062c5bc4SJason Schmidlapp pte_osMutexUnlock(pte_thread_reuse_lock);
107062c5bc4SJason Schmidlapp
108062c5bc4SJason Schmidlapp if (result == 0)
109062c5bc4SJason Schmidlapp {
110062c5bc4SJason Schmidlapp /*
111062c5bc4SJason Schmidlapp * The target thread is joinable and can't be reused before we join it.
112062c5bc4SJason Schmidlapp */
113062c5bc4SJason Schmidlapp self = pthread_self();
114062c5bc4SJason Schmidlapp
115*a12978ccSJeremy Soller if (NULL == self)
116062c5bc4SJason Schmidlapp {
117062c5bc4SJason Schmidlapp result = ENOENT;
118062c5bc4SJason Schmidlapp }
119062c5bc4SJason Schmidlapp else if (pthread_equal (self, thread))
120062c5bc4SJason Schmidlapp {
121062c5bc4SJason Schmidlapp result = EDEADLK;
122062c5bc4SJason Schmidlapp }
123062c5bc4SJason Schmidlapp else
124062c5bc4SJason Schmidlapp {
125062c5bc4SJason Schmidlapp /*
126062c5bc4SJason Schmidlapp * Pthread_join is a cancelation point.
127062c5bc4SJason Schmidlapp * If we are canceled then our target thread must not be
128062c5bc4SJason Schmidlapp * detached (destroyed). This is guarranteed because
129062c5bc4SJason Schmidlapp * pthreadCancelableWait will not return if we
130062c5bc4SJason Schmidlapp * are canceled.
131062c5bc4SJason Schmidlapp */
132062c5bc4SJason Schmidlapp
133062c5bc4SJason Schmidlapp result = pte_osThreadWaitForEnd(tp->threadId);
134062c5bc4SJason Schmidlapp
135062c5bc4SJason Schmidlapp if (PTE_OS_OK == result)
136062c5bc4SJason Schmidlapp {
137062c5bc4SJason Schmidlapp if (value_ptr != NULL)
138062c5bc4SJason Schmidlapp {
139062c5bc4SJason Schmidlapp *value_ptr = tp->exitStatus;
140062c5bc4SJason Schmidlapp }
141062c5bc4SJason Schmidlapp
142062c5bc4SJason Schmidlapp /*
143062c5bc4SJason Schmidlapp * The result of making multiple simultaneous calls to
144062c5bc4SJason Schmidlapp * pthread_join() or pthread_detach() specifying the same
145062c5bc4SJason Schmidlapp * target is undefined.
146062c5bc4SJason Schmidlapp */
147062c5bc4SJason Schmidlapp result = pthread_detach (thread);
148062c5bc4SJason Schmidlapp }
149062c5bc4SJason Schmidlapp else if (result == PTE_OS_INTERRUPTED)
150062c5bc4SJason Schmidlapp {
151062c5bc4SJason Schmidlapp /* Call was cancelled, but still return success (per spec) */
152062c5bc4SJason Schmidlapp result = 0;
153062c5bc4SJason Schmidlapp }
154062c5bc4SJason Schmidlapp else
155062c5bc4SJason Schmidlapp {
156062c5bc4SJason Schmidlapp result = ESRCH;
157062c5bc4SJason Schmidlapp }
158062c5bc4SJason Schmidlapp }
159062c5bc4SJason Schmidlapp }
160062c5bc4SJason Schmidlapp
161062c5bc4SJason Schmidlapp return (result);
162062c5bc4SJason Schmidlapp
163062c5bc4SJason Schmidlapp } /* pthread_join */
164