summaryrefslogtreecommitdiffstats
path: root/include/Thread.h
blob: f439a6a6ea3ed847ec85dc279456c305191d1764 (plain)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/*---------------------------------------------------------------
 * Copyright (c) 1999,2000,2001,2002,2003
 * The Board of Trustees of the University of Illinois
 * All Rights Reserved.
 *---------------------------------------------------------------
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software (Iperf) and associated
 * documentation files (the "Software"), to deal in the Software
 * without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute,
 * sublicense, and/or sell copies of the Software, and to permit
 * persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 *
 * Redistributions of source code must retain the above
 * copyright notice, this list of conditions and
 * the following disclaimers.
 *
 *
 * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following
 * disclaimers in the documentation and/or other materials
 * provided with the distribution.
 *
 *
 * Neither the names of the University of Illinois, NCSA,
 * nor the names of its contributors may be used to endorse
 * or promote products derived from this Software without
 * specific prior written permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE CONTIBUTORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * ________________________________________________________________
 * National Laboratory for Applied Network Research
 * National Center for Supercomputing Applications
 * University of Illinois at Urbana-Champaign
 * http://www.ncsa.uiuc.edu
 * ________________________________________________________________
 *
 * Thread.h
 * by Kevin Gibbs <kgibbs@nlanr.net>
 *
 * Based on:
 * Thread.hpp
 * by Mark Gates <mgates@nlanr.net>
 * -------------------------------------------------------------------
 * The thread subsystem is responsible for all thread functions. It
 * provides a thread implementation agnostic interface to Iperf. If
 * threads are not available (HAVE_THREAD is undefined), thread_start
 * does not start a new thread but just launches the specified object
 * in the current thread. Everything that defines a thread of
 * execution in Iperf is contained in an thread_Settings structure. To
 * start a thread simply pass one such structure into thread_start.
 * ------------------------------------------------------------------- */

#ifndef THREAD_H
#define THREAD_H

#ifdef __cplusplus
extern "C" {
#endif


#if   defined(HAVE_POSIX_THREAD)

/* Definitions for Posix Threads (pthreads) */
#include <pthread.h>

typedef pthread_t nthread_t;

#define HAVE_THREAD 1

#elif defined(HAVE_WIN32_THREAD)

/* Definitions for Win32 NT Threads */
typedef DWORD nthread_t;

#define HAVE_THREAD 1

#else

/* Definitions for no threads */
typedef int nthread_t;

#undef HAVE_THREAD

#endif

// Forward declaration
struct thread_Settings;

#include "Condition.h"
#include "Settings.hpp"

#if HAVE_THREAD_DEBUG
struct ReportHeader;
void reporttype_text(struct ReportHeader *reporthdr, char *rs);
void thread_debug(const char *format, ...);
extern Mutex thread_debug_mutex;
extern Mutex packetringdebug_mutex;
#endif
// initialize or destroy the thread subsystem
void thread_init();
void thread_destroy();

// start or stop a thread executing
void thread_start_all(struct thread_Settings* thread);
void thread_start(struct thread_Settings* thread);
void thread_stop(struct thread_Settings* thread);

/* wait for this or all threads to complete */
void thread_joinall(void);
int thread_numuserthreads(void);
int thread_numtrafficthreads(void);

// set a thread to be ignorable, so joinall won't wait on it
void thread_setignore(void);
void thread_unsetignore(void);

// Used for threads that may never terminate (ie Listener Thread)
void thread_register_nonterm(void);
void thread_unregister_nonterm(void);
int thread_release_nonterm(int interrupt);

/* -------------------------------------------------------------------
 * Return the current thread's ID.
 * ------------------------------------------------------------------- */
#if   defined(HAVE_POSIX_THREAD)
#define thread_getid() pthread_self()
#elif defined(HAVE_WIN32_THREAD)
#define thread_getid() GetCurrentThreadId()
#else
#define thread_getid() 0
#endif

int thread_equalid(nthread_t inLeft, nthread_t inRight);

nthread_t thread_zeroid(void);

#if   defined(HAVE_WIN32_THREAD)
DWORD WINAPI thread_run_wrapper(void* paramPtr);
#else
void*thread_run_wrapper(void* paramPtr);
#endif

#if HAVE_SCHED_SETSCHEDULER
void thread_setscheduler(struct thread_Settings *thread);
#endif

void thread_rest (void);

// defined in launch.cpp
void server_spawn(struct thread_Settings* thread);
void client_spawn(struct thread_Settings* thread);
void client_init(struct thread_Settings* clients);
void listener_spawn(struct thread_Settings* thread);
void listeners_init(struct thread_Settings* listeners);
void writeack_server_spawn(struct thread_Settings* thread);
void writeack_client_spawn(struct thread_Settings* thread);
int fullduplex_start_barrier(struct BarrierMutex *barrier);
int fullduplex_stop_barrier(struct BarrierMutex *barrier);

// defined in reporter.c
void reporter_spawn(struct thread_Settings* thread);

#ifdef __cplusplus
} /* end extern "C" */
#endif
#endif // THREAD_H