posix/src/pthreadjoin.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup POSIXAPI
0007  *
0008  * @brief Suspends Execution of Calling Thread until Target Thread Terminates
0009  */
0010
0011 /*
0012  *  16.1.3 Wait for Thread Termination, P1003.1c/Draft 10, p. 147
0013  *
0014  *  COPYRIGHT (c) 1989-2014.
0015  *  On-Line Applications Research Corporation (OAR).
0016  *
0017  *  Copyright (c) 2016 embedded brains GmbH & Co. KG
0018  *
0019  * Redistribution and use in source and binary forms, with or without
0020  * modification, are permitted provided that the following conditions
0021  * are met:
0022  * 1. Redistributions of source code must retain the above copyright
0023  *    notice, this list of conditions and the following disclaimer.
0024  * 2. Redistributions in binary form must reproduce the above copyright
0025  *    notice, this list of conditions and the following disclaimer in the
0026  *    documentation and/or other materials provided with the distribution.
0027  *
0028  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0029  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0030  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0031  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0032  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0033  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0034  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0035  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0036  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0037  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0038  * POSSIBILITY OF SUCH DAMAGE.
0039  */
0040
0041 #ifdef HAVE_CONFIG_H
0042 #include "config.h"
0043 #endif
0044
0045 #include <pthread.h>
0046 #include <errno.h>
0047
0048 #include <rtems/posix/threadsup.h>
0049 #include <rtems/posix/posixapi.h>
0050 #include <rtems/score/threadimpl.h>
0051 #include <rtems/score/statesimpl.h>
0052
0053 static int _POSIX_Threads_Join( pthread_t thread, void **value_ptr )
0054 {
0055   Thread_Control       *the_thread;
0056   Thread_queue_Context  queue_context;
0057   Thread_Control       *executing;
0058   Status_Control        status;
0059
0060   _Thread_queue_Context_initialize( &queue_context );
0061   the_thread = _Thread_Get( thread, &queue_context.Lock_context.Lock_context );
0062
0063   if ( the_thread == NULL ) {
0064     return ESRCH;
0065   }
0066
0067   _Thread_State_acquire_critical(
0068     the_thread,
0069     &queue_context.Lock_context.Lock_context
0070   );
0071
0072   if ( !_Thread_Is_joinable( the_thread ) ) {
0073     _Thread_State_release( the_thread, &queue_context.Lock_context.Lock_context );
0074     return EINVAL;
0075   }
0076
0077   executing = _Thread_Executing;
0078   status = _Thread_Join(
0079     the_thread,
0080     STATES_INTERRUPTIBLE_BY_SIGNAL | STATES_WAITING_FOR_JOIN,
0081     executing,
0082     &queue_context
0083   );
0084
0085   if ( status != STATUS_SUCCESSFUL ) {
0086     return _POSIX_Get_error( status );
0087   }
0088
0089   if ( value_ptr != NULL ) {
0090     *value_ptr = executing->Wait.return_argument;
0091   }
0092
0093   return 0;
0094 }
0095
0096 int pthread_join( pthread_t thread, void **value_ptr )
0097 {
0098   int error;
0099
0100   do {
0101     error = _POSIX_Threads_Join( thread, value_ptr );
0102   } while ( error == EINTR );
0103
0104   return error;
0105 }