sjero.net Git - iperf/blob - include/Thread.h

   1 /*---------------------------------------------------------------
   2  * Copyright (c) 1999,2000,2001,2002,2003
   3  * The Board of Trustees of the University of Illinois
   4  * All Rights Reserved.
   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:
  14  *
  15  *
  16  * Redistributions of source code must retain the above
  17  * copyright notice, this list of conditions and
  18  * the following disclaimers.
  19  *
  20  *
  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.
  25  *
  26  *
  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.
  31  *
  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  * ________________________________________________________________
  46  *
  47  * Thread.h
  48  * by Kevin Gibbs <kgibbs@nlanr.net>
  49  *
  50  * Based on:
  51  * Thread.hpp
  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  * ------------------------------------------------------------------- */
  62
  63 #ifndef THREAD_H
  64 #define THREAD_H
  65
  66 #ifdef __cplusplus
  67 extern "C" {
  68 #endif
  69
  70
  71 #if   defined( HAVE_POSIX_THREAD )
  72
  73 /* Definitions for Posix Threads (pthreads) */
  74     #include <pthread.h>
  75
  76 typedef pthread_t nthread_t;
  77
  78     #define HAVE_THREAD 1
  79
  80 #elif defined( HAVE_WIN32_THREAD )
  81
  82 /* Definitions for Win32 NT Threads */
  83 typedef DWORD nthread_t;
  84
  85     #define HAVE_THREAD 1
  86
  87 #else
  88
  89 /* Definitions for no threads */
  90 typedef int nthread_t;
  91
  92     #undef HAVE_THREAD
  93
  94 #endif
  95
  96     // Forward declaration
  97     struct thread_Settings;
  98
  99 #include "Condition.h"
 100 #include "Settings.hpp"
 101
 102     // initialize or destroy the thread subsystem
 103     void thread_init( );
 104     void thread_destroy( );
 105
 106     // start or stop a thread executing
 107     void thread_start( struct thread_Settings* thread );
 108     void thread_stop( struct thread_Settings* thread );
 109
 110     /* wait for this or all threads to complete */
 111     void thread_joinall( void );
 112
 113     int thread_numuserthreads( void );
 114
 115     // set a thread to be ignorable, so joinall won't wait on it
 116     void thread_setignore( void );
 117     void thread_unsetignore( void );
 118
 119     // Used for threads that may never terminate (ie Listener Thread)
 120     void thread_register_nonterm( void );
 121     void thread_unregister_nonterm( void );
 122     int thread_release_nonterm( int force );
 123
 124     /* -------------------------------------------------------------------
 125      * Return the current thread's ID.
 126      * ------------------------------------------------------------------- */
 127     #if   defined( HAVE_POSIX_THREAD )
 128         #define thread_getid() pthread_self()
 129     #elif defined( HAVE_WIN32_THREAD )
 130         #define thread_getid() GetCurrentThreadId()
 131     #else
 132         #define thread_getid() 0
 133     #endif
 134
 135     int thread_equalid( nthread_t inLeft, nthread_t inRight );
 136
 137     nthread_t thread_zeroid( void );
 138
 139 #if   defined( HAVE_WIN32_THREAD )
 140     DWORD WINAPI thread_run_wrapper( void* paramPtr );
 141 #else
 142     void*        thread_run_wrapper( void* paramPtr );
 143 #endif
 144
 145     void thread_rest ( void );
 146
 147     // defined in launch.cpp
 148     void server_spawn( struct thread_Settings* thread );
 149     void client_spawn( struct thread_Settings* thread );
 150     void client_init( struct thread_Settings* clients );
 151     void listener_spawn( struct thread_Settings* thread );
 152
 153     // defined in reporter.c
 154     void reporter_spawn( struct thread_Settings* thread );
 155
 156 #ifdef __cplusplus
 157 } /* end extern "C" */
 158 #endif
 159 #endif // THREAD_H