lib/libthr/thread/thr_join.c

   1 /*
   2  * Copyright (c) 2005, David Xu <davidxu@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #include <errno.h>
  30 #include <pthread.h>
  31
  32 #include "thr_private.h"
  33
  34 static int join_common(pthread_t, void **, const struct timespec *);
  35
  36 __weak_reference(_pthread_join, pthread_join);
  37 __weak_reference(_pthread_timedjoin_np, pthread_timedjoin_np);
  38
  39 static void backout_join(void *arg)
  40 {
  41         struct pthread *curthread = _get_curthread();
  42         struct pthread *pthread = (struct pthread *)arg;
  43
  44         THREAD_LIST_LOCK(curthread);
  45         pthread->joiner = NULL;
  46         THREAD_LIST_UNLOCK(curthread);
  47 }
  48
  49 int
  50 _pthread_join(pthread_t pthread, void **thread_return)
  51 {
  52         return (join_common(pthread, thread_return, NULL));
  53 }
  54
  55 int
  56 _pthread_timedjoin_np(pthread_t pthread, void **thread_return,
  57         const struct timespec *abstime)
  58 {
  59         if (abstime == NULL || abstime->tv_sec < 0 || abstime->tv_nsec < 0 ||
  60             abstime->tv_nsec >= 1000000000)
  61                 return (EINVAL);
  62
  63         return (join_common(pthread, thread_return, abstime));
  64 }
  65
  66 static int
  67 join_common(pthread_t pthread, void **thread_return,
  68         const struct timespec *abstime)
  69 {
  70         struct pthread *curthread = _get_curthread();
  71         struct timespec ts, ts2, *tsp;
  72         void *tmp;
  73         long tid;
  74         int oldcancel;
  75         int ret = 0;
  76
  77         if (pthread == NULL)
  78                 return (EINVAL);
  79
  80         if (pthread == curthread)
  81                 return (EDEADLK);
  82
  83         THREAD_LIST_LOCK(curthread);
  84         if ((ret = _thr_find_thread(curthread, pthread, 1)) != 0) {
  85                 ret = ESRCH;
  86         } else if ((pthread->tlflags & TLFLAGS_DETACHED) != 0) {
  87                 ret = EINVAL;
  88         } else if (pthread->joiner != NULL) {
  89                 /* Multiple joiners are not supported. */
  90                 ret = ENOTSUP;
  91         }
  92         if (ret) {
  93                 THREAD_LIST_UNLOCK(curthread);
  94                 return (ret);
  95         }
  96         /* Set the running thread to be the joiner: */
  97         pthread->joiner = curthread;
  98
  99         THREAD_LIST_UNLOCK(curthread);
 100
 101         THR_CLEANUP_PUSH(curthread, backout_join, pthread);
 102         oldcancel = _thr_cancel_enter(curthread);
 103
 104         tid = pthread->tid;
 105         while (pthread->tid != TID_TERMINATED) {
 106                 if (abstime != NULL) {
 107                         clock_gettime(CLOCK_REALTIME, &ts);
 108                         TIMESPEC_SUB(&ts2, abstime, &ts);
 109                         if (ts2.tv_sec < 0) {
 110                                 ret = ETIMEDOUT;
 111                                 break;
 112                         }
 113                         tsp = &ts2;
 114                 } else
 115                         tsp = NULL;
 116                 ret = _thr_umtx_wait(&pthread->tid, tid, tsp);
 117                 if (ret == ETIMEDOUT)
 118                         break;
 119         }
 120
 121         _thr_cancel_leave(curthread, oldcancel);
 122         THR_CLEANUP_POP(curthread, 0);
 123
 124         if (ret == ETIMEDOUT) {
 125                 THREAD_LIST_LOCK(curthread);
 126                 pthread->joiner = NULL;
 127                 THREAD_LIST_UNLOCK(curthread);
 128         } else {
 129                 ret = 0;
 130                 tmp = pthread->ret;
 131                 THREAD_LIST_LOCK(curthread);
 132                 pthread->tlflags |= TLFLAGS_DETACHED;
 133                 pthread->joiner = NULL;
 134                 THR_GCLIST_ADD(pthread);
 135                 THREAD_LIST_UNLOCK(curthread);
 136
 137                 if (thread_return != NULL)
 138                         *thread_return = tmp;
 139         }
 140         return (ret);
 141 }