File: threads.h

package info (click to toggle)
openmpi 5.0.8-4
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 201,684 kB
  • sloc: ansic: 613,078; makefile: 42,353; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (139 lines) | stat: -rw-r--r-- 5,494 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2021 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  All rights
 *                         reserved.
 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2005 The Regents of the University of California.
 *                         All rights reserved.
 * Copyright (c) 2010      Cisco Systems, Inc. All rights reserved.
 * Copyright (c) 2010      Oracle and/or its affiliates.  All rights reserved.
 * Copyright (c) 2015-2017 Research Organization for Information Science
 *                         and Technology (RIST). All rights reserved.
 * Copyright (c) 2017      Intel, Inc. All rights reserved.
 * Copyright (c) 2019      Sandia National Laboratories.  All rights reserved.
 *
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 */

#ifndef OPAL_MCA_THREADS_THREADS_H
#define OPAL_MCA_THREADS_THREADS_H

#include "opal_config.h"

#include "opal/class/opal_object.h"
#if OPAL_ENABLE_DEBUG
#    include "opal/util/output.h"
#endif

#include "condition.h"
#include "mutex.h"

BEGIN_C_DECLS

typedef void *(*opal_thread_fn_t)(opal_object_t *);

#define OPAL_THREAD_CANCELLED ((void *) 1);

#include MCA_threads_base_include_HEADER

struct opal_thread_t {
    opal_object_t super;
    opal_thread_fn_t t_run;
    void *t_arg;
    pthread_t t_handle;
};

typedef struct opal_thread_t opal_thread_t;

OBJ_CLASS_DECLARATION(opal_thread_t);

#if OPAL_ENABLE_DEBUG
OPAL_DECLSPEC extern bool opal_debug_threads;
#endif

OPAL_DECLSPEC OBJ_CLASS_DECLARATION(opal_thread_t);

#if OPAL_ENABLE_DEBUG
#    define OPAL_ACQUIRE_THREAD(lck, cnd, act)                                  \
        do {                                                                    \
            OPAL_THREAD_LOCK((lck));                                            \
            if (opal_debug_threads) {                                           \
                opal_output(0, "Waiting for thread %s:%d", __FILE__, __LINE__); \
            }                                                                   \
            while (*(act)) {                                                    \
                opal_condition_wait((cnd), (lck));                              \
            }                                                                   \
            if (opal_debug_threads) {                                           \
                opal_output(0, "Thread obtained %s:%d", __FILE__, __LINE__);    \
            }                                                                   \
            *(act) = true;                                                      \
        } while (0);
#else
#    define OPAL_ACQUIRE_THREAD(lck, cnd, act)     \
        do {                                       \
            OPAL_THREAD_LOCK((lck));               \
            while (*(act)) {                       \
                opal_condition_wait((cnd), (lck)); \
            }                                      \
            *(act) = true;                         \
        } while (0);
#endif

#if OPAL_ENABLE_DEBUG
#    define OPAL_RELEASE_THREAD(lck, cnd, act)                                \
        do {                                                                  \
            if (opal_debug_threads) {                                         \
                opal_output(0, "Releasing thread %s:%d", __FILE__, __LINE__); \
            }                                                                 \
            *(act) = false;                                                   \
            opal_condition_broadcast((cnd));                                  \
            OPAL_THREAD_UNLOCK((lck));                                        \
        } while (0);
#else
#    define OPAL_RELEASE_THREAD(lck, cnd, act) \
        do {                                   \
            *(act) = false;                    \
            opal_condition_broadcast((cnd));   \
            OPAL_THREAD_UNLOCK((lck));         \
        } while (0);
#endif

#define OPAL_WAKEUP_THREAD(cnd, act)     \
    do {                                 \
        *(act) = false;                  \
        opal_condition_broadcast((cnd)); \
    } while (0);

/* provide a macro for forward-proofing the shifting
 * of objects between libevent threads - at some point, we
 * may revamp that threading model */

/* post an object to another thread - for now, we
 * only have a memory barrier */
#define OPAL_POST_OBJECT(o) opal_atomic_wmb()

/* acquire an object from another thread - for now,
 * we only have a memory barrier */
#define OPAL_ACQUIRE_OBJECT(o) opal_atomic_rmb()

OPAL_DECLSPEC int opal_thread_start(opal_thread_t *);
OPAL_DECLSPEC int opal_thread_join(opal_thread_t *, void **thread_return);
OPAL_DECLSPEC bool opal_thread_self_compare(opal_thread_t *);
OPAL_DECLSPEC opal_thread_t *opal_thread_get_self(void);
OPAL_DECLSPEC void opal_thread_kill(opal_thread_t *, int sig);
OPAL_DECLSPEC void opal_thread_set_main(void);

static inline void opal_thread_yield(void);

END_C_DECLS

#endif /* OPAL_MCA_THREADS_THREADS_H */