1 /*---------------------------------------------------------------
2 * Copyright (c) 1999,2000,2001,2002,2003
3 * The Board of Trustees of the University of Illinois
5 *---------------------------------------------------------------
6 * Permission is hereby granted, free of charge, to any person
7 * obtaining a copy of this software (Iperf) and associated
8 * documentation files (the "Software"), to deal in the Software
9 * without restriction, including without limitation the
10 * rights to use, copy, modify, merge, publish, distribute,
11 * sublicense, and/or sell copies of the Software, and to permit
12 * persons to whom the Software is furnished to do
13 * so, subject to the following conditions:
16 * Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and
18 * the following disclaimers.
21 * Redistributions in binary form must reproduce the above
22 * copyright notice, this list of conditions and the following
23 * disclaimers in the documentation and/or other materials
24 * provided with the distribution.
27 * Neither the names of the University of Illinois, NCSA,
28 * nor the names of its contributors may be used to endorse
29 * or promote products derived from this Software without
30 * specific prior written permission.
32 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
33 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
34 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
35 * NONINFRINGEMENT. IN NO EVENT SHALL THE CONTIBUTORS OR COPYRIGHT
36 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
37 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
38 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE
39 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 * ________________________________________________________________
41 * National Laboratory for Applied Network Research
42 * National Center for Supercomputing Applications
43 * University of Illinois at Urbana-Champaign
44 * http://www.ncsa.uiuc.edu
45 * ________________________________________________________________
48 * by Kevin Gibbs <kgibbs@nlanr.net>
52 * by Mark Gates <mgates@nlanr.net>
53 * -------------------------------------------------------------------
54 * The thread subsystem is responsible for all thread functions. It
55 * provides a thread implementation agnostic interface to Iperf. If
56 * threads are not available (HAVE_THREAD is undefined), thread_start
57 * does not start a new thread but just launches the specified object
58 * in the current thread. Everything that defines a thread of
59 * execution in Iperf is contained in an thread_Settings structure. To
60 * start a thread simply pass one such structure into thread_start.
61 * ------------------------------------------------------------------- */
71 #if defined( HAVE_POSIX_THREAD )
73 /* Definitions for Posix Threads (pthreads) */
76 typedef pthread_t nthread_t;
82 /* Definitions for no threads */
83 typedef int nthread_t;
89 // Forward declaration
90 struct thread_Settings;
92 #include "Condition.h"
93 #include "Settings.hpp"
95 // initialize or destroy the thread subsystem
97 void thread_destroy( );
99 // start or stop a thread executing
100 void thread_start( struct thread_Settings* thread );
101 void thread_stop( struct thread_Settings* thread );
103 /* wait for this or all threads to complete */
104 void thread_joinall( void );
106 int thread_numuserthreads( void );
108 // set a thread to be ignorable, so joinall won't wait on it
109 void thread_setignore( void );
110 void thread_unsetignore( void );
112 // Used for threads that may never terminate (ie Listener Thread)
113 void thread_register_nonterm( void );
114 void thread_unregister_nonterm( void );
115 int thread_release_nonterm( int force );
117 /* -------------------------------------------------------------------
118 * Return the current thread's ID.
119 * ------------------------------------------------------------------- */
120 #if defined( HAVE_POSIX_THREAD )
121 #define thread_getid() pthread_self()
123 #define thread_getid() 0
126 int thread_equalid( nthread_t inLeft, nthread_t inRight );
128 nthread_t thread_zeroid( void );
130 void* thread_run_wrapper( void* paramPtr );
132 void thread_rest ( void );
134 // defined in launch.cpp
135 void server_spawn( struct thread_Settings* thread );
136 void client_spawn( struct thread_Settings* thread );
137 void client_init( struct thread_Settings* clients );
138 void listener_spawn( struct thread_Settings* thread );
140 // defined in reporter.c
141 void reporter_spawn( struct thread_Settings* thread );
144 } /* end extern "C" */