/* Copyright (C) 2005 Free Software Foundation, Inc.
|
/* Copyright (C) 2005 Free Software Foundation, Inc.
|
Contributed by Richard Henderson <rth@redhat.com>.
|
Contributed by Richard Henderson <rth@redhat.com>.
|
|
|
This file is part of the GNU OpenMP Library (libgomp).
|
This file is part of the GNU OpenMP Library (libgomp).
|
|
|
Libgomp is free software; you can redistribute it and/or modify it
|
Libgomp is free software; you can redistribute it and/or modify it
|
under the terms of the GNU Lesser General Public License as published by
|
under the terms of the GNU Lesser General Public License as published by
|
the Free Software Foundation; either version 2.1 of the License, or
|
the Free Software Foundation; either version 2.1 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
|
Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
|
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
|
more details.
|
more details.
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
You should have received a copy of the GNU Lesser General Public License
|
along with libgomp; see the file COPYING.LIB. If not, write to the
|
along with libgomp; see the file COPYING.LIB. If not, write to the
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
MA 02110-1301, USA. */
|
MA 02110-1301, USA. */
|
|
|
/* As a special exception, if you link this library with other files, some
|
/* As a special exception, if you link this library with other files, some
|
of which are compiled with GCC, to produce an executable, this library
|
of which are compiled with GCC, to produce an executable, this library
|
does not by itself cause the resulting executable to be covered by the
|
does not by itself cause the resulting executable to be covered by the
|
GNU General Public License. This exception does not however invalidate
|
GNU General Public License. This exception does not however invalidate
|
any other reasons why the executable file might be covered by the GNU
|
any other reasons why the executable file might be covered by the GNU
|
General Public License. */
|
General Public License. */
|
|
|
/* This file handles the maintainence of threads in response to team
|
/* This file handles the maintainence of threads in response to team
|
creation and termination. */
|
creation and termination. */
|
|
|
#include "libgomp.h"
|
#include "libgomp.h"
|
#include <stdlib.h>
|
#include <stdlib.h>
|
#include <string.h>
|
#include <string.h>
|
|
|
/* This array manages threads spawned from the top level, which will
|
/* This array manages threads spawned from the top level, which will
|
return to the idle loop once the current PARALLEL construct ends. */
|
return to the idle loop once the current PARALLEL construct ends. */
|
static struct gomp_thread **gomp_threads;
|
static struct gomp_thread **gomp_threads;
|
static unsigned gomp_threads_size;
|
static unsigned gomp_threads_size;
|
static unsigned gomp_threads_used;
|
static unsigned gomp_threads_used;
|
|
|
/* This attribute contains PTHREAD_CREATE_DETACHED. */
|
/* This attribute contains PTHREAD_CREATE_DETACHED. */
|
pthread_attr_t gomp_thread_attr;
|
pthread_attr_t gomp_thread_attr;
|
|
|
/* This barrier holds and releases threads waiting in gomp_threads. */
|
/* This barrier holds and releases threads waiting in gomp_threads. */
|
static gomp_barrier_t gomp_threads_dock;
|
static gomp_barrier_t gomp_threads_dock;
|
|
|
/* This is the libgomp per-thread data structure. */
|
/* This is the libgomp per-thread data structure. */
|
#ifdef HAVE_TLS
|
#ifdef HAVE_TLS
|
__thread struct gomp_thread gomp_tls_data;
|
__thread struct gomp_thread gomp_tls_data;
|
#else
|
#else
|
pthread_key_t gomp_tls_key;
|
pthread_key_t gomp_tls_key;
|
#endif
|
#endif
|
|
|
|
|
/* This structure is used to communicate across pthread_create. */
|
/* This structure is used to communicate across pthread_create. */
|
|
|
struct gomp_thread_start_data
|
struct gomp_thread_start_data
|
{
|
{
|
struct gomp_team_state ts;
|
struct gomp_team_state ts;
|
void (*fn) (void *);
|
void (*fn) (void *);
|
void *fn_data;
|
void *fn_data;
|
bool nested;
|
bool nested;
|
};
|
};
|
|
|
|
|
/* This function is a pthread_create entry point. This contains the idle
|
/* This function is a pthread_create entry point. This contains the idle
|
loop in which a thread waits to be called up to become part of a team. */
|
loop in which a thread waits to be called up to become part of a team. */
|
|
|
static void *
|
static void *
|
gomp_thread_start (void *xdata)
|
gomp_thread_start (void *xdata)
|
{
|
{
|
struct gomp_thread_start_data *data = xdata;
|
struct gomp_thread_start_data *data = xdata;
|
struct gomp_thread *thr;
|
struct gomp_thread *thr;
|
void (*local_fn) (void *);
|
void (*local_fn) (void *);
|
void *local_data;
|
void *local_data;
|
|
|
#ifdef HAVE_TLS
|
#ifdef HAVE_TLS
|
thr = &gomp_tls_data;
|
thr = &gomp_tls_data;
|
#else
|
#else
|
struct gomp_thread local_thr;
|
struct gomp_thread local_thr;
|
thr = &local_thr;
|
thr = &local_thr;
|
pthread_setspecific (gomp_tls_key, thr);
|
pthread_setspecific (gomp_tls_key, thr);
|
#endif
|
#endif
|
gomp_sem_init (&thr->release, 0);
|
gomp_sem_init (&thr->release, 0);
|
|
|
/* Extract what we need from data. */
|
/* Extract what we need from data. */
|
local_fn = data->fn;
|
local_fn = data->fn;
|
local_data = data->fn_data;
|
local_data = data->fn_data;
|
thr->ts = data->ts;
|
thr->ts = data->ts;
|
|
|
thr->ts.team->ordered_release[thr->ts.team_id] = &thr->release;
|
thr->ts.team->ordered_release[thr->ts.team_id] = &thr->release;
|
|
|
if (data->nested)
|
if (data->nested)
|
{
|
{
|
gomp_barrier_wait (&thr->ts.team->barrier);
|
gomp_barrier_wait (&thr->ts.team->barrier);
|
local_fn (local_data);
|
local_fn (local_data);
|
gomp_barrier_wait (&thr->ts.team->barrier);
|
gomp_barrier_wait (&thr->ts.team->barrier);
|
}
|
}
|
else
|
else
|
{
|
{
|
gomp_threads[thr->ts.team_id] = thr;
|
gomp_threads[thr->ts.team_id] = thr;
|
|
|
gomp_barrier_wait (&gomp_threads_dock);
|
gomp_barrier_wait (&gomp_threads_dock);
|
do
|
do
|
{
|
{
|
struct gomp_team *team;
|
struct gomp_team *team;
|
|
|
local_fn (local_data);
|
local_fn (local_data);
|
|
|
/* Clear out the team and function data. This is a debugging
|
/* Clear out the team and function data. This is a debugging
|
signal that we're in fact back in the dock. */
|
signal that we're in fact back in the dock. */
|
team = thr->ts.team;
|
team = thr->ts.team;
|
thr->fn = NULL;
|
thr->fn = NULL;
|
thr->data = NULL;
|
thr->data = NULL;
|
thr->ts.team = NULL;
|
thr->ts.team = NULL;
|
thr->ts.work_share = NULL;
|
thr->ts.work_share = NULL;
|
thr->ts.team_id = 0;
|
thr->ts.team_id = 0;
|
thr->ts.work_share_generation = 0;
|
thr->ts.work_share_generation = 0;
|
thr->ts.static_trip = 0;
|
thr->ts.static_trip = 0;
|
|
|
gomp_barrier_wait (&team->barrier);
|
gomp_barrier_wait (&team->barrier);
|
gomp_barrier_wait (&gomp_threads_dock);
|
gomp_barrier_wait (&gomp_threads_dock);
|
|
|
local_fn = thr->fn;
|
local_fn = thr->fn;
|
local_data = thr->data;
|
local_data = thr->data;
|
}
|
}
|
while (local_fn);
|
while (local_fn);
|
}
|
}
|
|
|
return NULL;
|
return NULL;
|
}
|
}
|
|
|
|
|
/* Create a new team data structure. */
|
/* Create a new team data structure. */
|
|
|
static struct gomp_team *
|
static struct gomp_team *
|
new_team (unsigned nthreads, struct gomp_work_share *work_share)
|
new_team (unsigned nthreads, struct gomp_work_share *work_share)
|
{
|
{
|
struct gomp_team *team;
|
struct gomp_team *team;
|
size_t size;
|
size_t size;
|
|
|
size = sizeof (*team) + nthreads * sizeof (team->ordered_release[0]);
|
size = sizeof (*team) + nthreads * sizeof (team->ordered_release[0]);
|
team = gomp_malloc (size);
|
team = gomp_malloc (size);
|
gomp_mutex_init (&team->work_share_lock);
|
gomp_mutex_init (&team->work_share_lock);
|
|
|
team->work_shares = gomp_malloc (4 * sizeof (struct gomp_work_share *));
|
team->work_shares = gomp_malloc (4 * sizeof (struct gomp_work_share *));
|
team->generation_mask = 3;
|
team->generation_mask = 3;
|
team->oldest_live_gen = work_share == NULL;
|
team->oldest_live_gen = work_share == NULL;
|
team->num_live_gen = work_share != NULL;
|
team->num_live_gen = work_share != NULL;
|
team->work_shares[0] = work_share;
|
team->work_shares[0] = work_share;
|
|
|
team->nthreads = nthreads;
|
team->nthreads = nthreads;
|
gomp_barrier_init (&team->barrier, nthreads);
|
gomp_barrier_init (&team->barrier, nthreads);
|
|
|
gomp_sem_init (&team->master_release, 0);
|
gomp_sem_init (&team->master_release, 0);
|
team->ordered_release[0] = &team->master_release;
|
team->ordered_release[0] = &team->master_release;
|
|
|
return team;
|
return team;
|
}
|
}
|
|
|
|
|
/* Free a team data structure. */
|
/* Free a team data structure. */
|
|
|
static void
|
static void
|
free_team (struct gomp_team *team)
|
free_team (struct gomp_team *team)
|
{
|
{
|
free (team->work_shares);
|
free (team->work_shares);
|
gomp_mutex_destroy (&team->work_share_lock);
|
gomp_mutex_destroy (&team->work_share_lock);
|
gomp_barrier_destroy (&team->barrier);
|
gomp_barrier_destroy (&team->barrier);
|
gomp_sem_destroy (&team->master_release);
|
gomp_sem_destroy (&team->master_release);
|
free (team);
|
free (team);
|
}
|
}
|
|
|
|
|
/* Launch a team. */
|
/* Launch a team. */
|
|
|
void
|
void
|
gomp_team_start (void (*fn) (void *), void *data, unsigned nthreads,
|
gomp_team_start (void (*fn) (void *), void *data, unsigned nthreads,
|
struct gomp_work_share *work_share)
|
struct gomp_work_share *work_share)
|
{
|
{
|
struct gomp_thread_start_data *start_data;
|
struct gomp_thread_start_data *start_data;
|
struct gomp_thread *thr, *nthr;
|
struct gomp_thread *thr, *nthr;
|
struct gomp_team *team;
|
struct gomp_team *team;
|
bool nested;
|
bool nested;
|
unsigned i, n, old_threads_used = 0;
|
unsigned i, n, old_threads_used = 0;
|
|
|
thr = gomp_thread ();
|
thr = gomp_thread ();
|
nested = thr->ts.team != NULL;
|
nested = thr->ts.team != NULL;
|
|
|
team = new_team (nthreads, work_share);
|
team = new_team (nthreads, work_share);
|
|
|
/* Always save the previous state, even if this isn't a nested team.
|
/* Always save the previous state, even if this isn't a nested team.
|
In particular, we should save any work share state from an outer
|
In particular, we should save any work share state from an outer
|
orphaned work share construct. */
|
orphaned work share construct. */
|
team->prev_ts = thr->ts;
|
team->prev_ts = thr->ts;
|
|
|
thr->ts.team = team;
|
thr->ts.team = team;
|
thr->ts.work_share = work_share;
|
thr->ts.work_share = work_share;
|
thr->ts.team_id = 0;
|
thr->ts.team_id = 0;
|
thr->ts.work_share_generation = 0;
|
thr->ts.work_share_generation = 0;
|
thr->ts.static_trip = 0;
|
thr->ts.static_trip = 0;
|
|
|
if (nthreads == 1)
|
if (nthreads == 1)
|
return;
|
return;
|
|
|
i = 1;
|
i = 1;
|
|
|
/* We only allow the reuse of idle threads for non-nested PARALLEL
|
/* We only allow the reuse of idle threads for non-nested PARALLEL
|
regions. This appears to be implied by the semantics of
|
regions. This appears to be implied by the semantics of
|
threadprivate variables, but perhaps that's reading too much into
|
threadprivate variables, but perhaps that's reading too much into
|
things. Certainly it does prevent any locking problems, since
|
things. Certainly it does prevent any locking problems, since
|
only the initial program thread will modify gomp_threads. */
|
only the initial program thread will modify gomp_threads. */
|
if (!nested)
|
if (!nested)
|
{
|
{
|
old_threads_used = gomp_threads_used;
|
old_threads_used = gomp_threads_used;
|
|
|
if (nthreads <= old_threads_used)
|
if (nthreads <= old_threads_used)
|
n = nthreads;
|
n = nthreads;
|
else if (old_threads_used == 0)
|
else if (old_threads_used == 0)
|
{
|
{
|
n = 0;
|
n = 0;
|
gomp_barrier_init (&gomp_threads_dock, nthreads);
|
gomp_barrier_init (&gomp_threads_dock, nthreads);
|
}
|
}
|
else
|
else
|
{
|
{
|
n = old_threads_used;
|
n = old_threads_used;
|
|
|
/* Increase the barrier threshold to make sure all new
|
/* Increase the barrier threshold to make sure all new
|
threads arrive before the team is released. */
|
threads arrive before the team is released. */
|
gomp_barrier_reinit (&gomp_threads_dock, nthreads);
|
gomp_barrier_reinit (&gomp_threads_dock, nthreads);
|
}
|
}
|
|
|
/* Not true yet, but soon will be. We're going to release all
|
/* Not true yet, but soon will be. We're going to release all
|
threads from the dock, and those that aren't part of the
|
threads from the dock, and those that aren't part of the
|
team will exit. */
|
team will exit. */
|
gomp_threads_used = nthreads;
|
gomp_threads_used = nthreads;
|
|
|
/* Release existing idle threads. */
|
/* Release existing idle threads. */
|
for (; i < n; ++i)
|
for (; i < n; ++i)
|
{
|
{
|
nthr = gomp_threads[i];
|
nthr = gomp_threads[i];
|
nthr->ts.team = team;
|
nthr->ts.team = team;
|
nthr->ts.work_share = work_share;
|
nthr->ts.work_share = work_share;
|
nthr->ts.team_id = i;
|
nthr->ts.team_id = i;
|
nthr->ts.work_share_generation = 0;
|
nthr->ts.work_share_generation = 0;
|
nthr->ts.static_trip = 0;
|
nthr->ts.static_trip = 0;
|
nthr->fn = fn;
|
nthr->fn = fn;
|
nthr->data = data;
|
nthr->data = data;
|
team->ordered_release[i] = &nthr->release;
|
team->ordered_release[i] = &nthr->release;
|
}
|
}
|
|
|
if (i == nthreads)
|
if (i == nthreads)
|
goto do_release;
|
goto do_release;
|
|
|
/* If necessary, expand the size of the gomp_threads array. It is
|
/* If necessary, expand the size of the gomp_threads array. It is
|
expected that changes in the number of threads is rare, thus we
|
expected that changes in the number of threads is rare, thus we
|
make no effort to expand gomp_threads_size geometrically. */
|
make no effort to expand gomp_threads_size geometrically. */
|
if (nthreads >= gomp_threads_size)
|
if (nthreads >= gomp_threads_size)
|
{
|
{
|
gomp_threads_size = nthreads + 1;
|
gomp_threads_size = nthreads + 1;
|
gomp_threads
|
gomp_threads
|
= gomp_realloc (gomp_threads,
|
= gomp_realloc (gomp_threads,
|
gomp_threads_size
|
gomp_threads_size
|
* sizeof (struct gomp_thread_data *));
|
* sizeof (struct gomp_thread_data *));
|
}
|
}
|
}
|
}
|
|
|
start_data = gomp_alloca (sizeof (struct gomp_thread_start_data)
|
start_data = gomp_alloca (sizeof (struct gomp_thread_start_data)
|
* (nthreads-i));
|
* (nthreads-i));
|
|
|
/* Launch new threads. */
|
/* Launch new threads. */
|
for (; i < nthreads; ++i, ++start_data)
|
for (; i < nthreads; ++i, ++start_data)
|
{
|
{
|
pthread_t pt;
|
pthread_t pt;
|
int err;
|
int err;
|
|
|
start_data->ts.team = team;
|
start_data->ts.team = team;
|
start_data->ts.work_share = work_share;
|
start_data->ts.work_share = work_share;
|
start_data->ts.team_id = i;
|
start_data->ts.team_id = i;
|
start_data->ts.work_share_generation = 0;
|
start_data->ts.work_share_generation = 0;
|
start_data->ts.static_trip = 0;
|
start_data->ts.static_trip = 0;
|
start_data->fn = fn;
|
start_data->fn = fn;
|
start_data->fn_data = data;
|
start_data->fn_data = data;
|
start_data->nested = nested;
|
start_data->nested = nested;
|
|
|
err = pthread_create (&pt, &gomp_thread_attr,
|
err = pthread_create (&pt, &gomp_thread_attr,
|
gomp_thread_start, start_data);
|
gomp_thread_start, start_data);
|
if (err != 0)
|
if (err != 0)
|
gomp_fatal ("Thread creation failed: %s", strerror (err));
|
gomp_fatal ("Thread creation failed: %s", strerror (err));
|
}
|
}
|
|
|
do_release:
|
do_release:
|
gomp_barrier_wait (nested ? &team->barrier : &gomp_threads_dock);
|
gomp_barrier_wait (nested ? &team->barrier : &gomp_threads_dock);
|
|
|
/* Decrease the barrier threshold to match the number of threads
|
/* Decrease the barrier threshold to match the number of threads
|
that should arrive back at the end of this team. The extra
|
that should arrive back at the end of this team. The extra
|
threads should be exiting. Note that we arrange for this test
|
threads should be exiting. Note that we arrange for this test
|
to never be true for nested teams. */
|
to never be true for nested teams. */
|
if (nthreads < old_threads_used)
|
if (nthreads < old_threads_used)
|
gomp_barrier_reinit (&gomp_threads_dock, nthreads);
|
gomp_barrier_reinit (&gomp_threads_dock, nthreads);
|
}
|
}
|
|
|
|
|
/* Terminate the current team. This is only to be called by the master
|
/* Terminate the current team. This is only to be called by the master
|
thread. We assume that we must wait for the other threads. */
|
thread. We assume that we must wait for the other threads. */
|
|
|
void
|
void
|
gomp_team_end (void)
|
gomp_team_end (void)
|
{
|
{
|
struct gomp_thread *thr = gomp_thread ();
|
struct gomp_thread *thr = gomp_thread ();
|
struct gomp_team *team = thr->ts.team;
|
struct gomp_team *team = thr->ts.team;
|
|
|
gomp_barrier_wait (&team->barrier);
|
gomp_barrier_wait (&team->barrier);
|
|
|
thr->ts = team->prev_ts;
|
thr->ts = team->prev_ts;
|
|
|
free_team (team);
|
free_team (team);
|
}
|
}
|
|
|
|
|
/* Constructors for this file. */
|
/* Constructors for this file. */
|
|
|
static void __attribute__((constructor))
|
static void __attribute__((constructor))
|
initialize_team (void)
|
initialize_team (void)
|
{
|
{
|
struct gomp_thread *thr;
|
struct gomp_thread *thr;
|
|
|
#ifndef HAVE_TLS
|
#ifndef HAVE_TLS
|
static struct gomp_thread initial_thread_tls_data;
|
static struct gomp_thread initial_thread_tls_data;
|
|
|
pthread_key_create (&gomp_tls_key, NULL);
|
pthread_key_create (&gomp_tls_key, NULL);
|
pthread_setspecific (gomp_tls_key, &initial_thread_tls_data);
|
pthread_setspecific (gomp_tls_key, &initial_thread_tls_data);
|
#endif
|
#endif
|
|
|
#ifdef HAVE_TLS
|
#ifdef HAVE_TLS
|
thr = &gomp_tls_data;
|
thr = &gomp_tls_data;
|
#else
|
#else
|
thr = &initial_thread_tls_data;
|
thr = &initial_thread_tls_data;
|
#endif
|
#endif
|
gomp_sem_init (&thr->release, 0);
|
gomp_sem_init (&thr->release, 0);
|
}
|
}
|
|
|
