sjero.net Git - iperf/blob - include/util.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  * util.h
  48  * by Mark Gates <mgates@nlanr.net>
  49  * -------------------------------------------------------------------
  50  * various C utility functions.
  51  * ------------------------------------------------------------------- */
  52
  53 #ifndef UTIL_H
  54 #define UTIL_H
  55
  56 #ifdef HAVE_CONFIG_H
  57     #include "config.h"
  58 #endif
  59
  60 #ifdef __cplusplus
  61 extern "C" {
  62 #endif
  63
  64 /* -------------------------------------------------------------------
  65  * set/getsockopt wrappers for SO_RCVBUF and SO_SNDBUF; TCP_MAXSEG
  66  * socket.c
  67  * ------------------------------------------------------------------- */
  68 int setsock_tcp_windowsize( int inSock, int inTCPWin, int inSend );
  69 int getsock_tcp_windowsize( int inSock, int inSend );
  70
  71 void setsock_tcp_mss( int inSock, int inTCPWin );
  72 int  getsock_tcp_mss( int inSock );
  73
  74 /* -------------------------------------------------------------------
  75  * signal handlers
  76  * signal.c
  77  * ------------------------------------------------------------------- */
  78 typedef void Sigfunc(int);
  79 void sig_exit( int inSigno );
  80
  81 typedef Sigfunc *SigfuncPtr;
  82
  83 SigfuncPtr my_signal( int inSigno, SigfuncPtr inFunc );
  84
  85 #ifdef WIN32
  86
  87 /* under windows, emulate unix signals */
  88 enum {
  89     SIGINT,
  90     SIGTERM,
  91     SIGPIPE,
  92     _NSIG
  93 };
  94
  95 BOOL WINAPI sig_dispatcher( DWORD type );
  96
  97 #endif
  98
  99 /* -------------------------------------------------------------------
 100  * error handlers
 101  * error.c
 102  * ------------------------------------------------------------------- */
 103 void warn      ( const char *inMessage, const char *inFile, int inLine );
 104 void warn_errno( const char *inMessage, const char *inFile, int inLine );
 105
 106 #if defined( HAVE_POSIX_THREAD ) || defined( HAVE_WIN32_THREAD)
 107 #define FAIL( cond, msg, settings )             \
 108   do {                                          \
 109     if ( cond ) {                               \
 110       warn( msg, __FILE__, __LINE__ );          \
 111       thread_stop(settings);                    \
 112     }                                           \
 113   } while( 0 )
 114 #else
 115 #define FAIL( cond, msg, settings )             \
 116   do {                                          \
 117     if ( cond ) {                               \
 118       warn( msg, __FILE__, __LINE__ );          \
 119       exit( 1 );                                \
 120     }                                           \
 121   } while( 0 )
 122 #endif
 123
 124 #define WARN( cond, msg )                       \
 125   do {                                          \
 126     if ( cond ) {                               \
 127       warn( msg, __FILE__, __LINE__ );          \
 128     }                                           \
 129   } while( 0 )
 130
 131 #if defined( HAVE_POSIX_THREAD ) || defined( HAVE_WIN32_THREAD)
 132 #define FAIL_errno( cond, msg, settings )       \
 133   do {                                          \
 134     if ( cond ) {                               \
 135       warn_errno( msg, __FILE__, __LINE__ );    \
 136       thread_stop(settings);                    \
 137     }                                           \
 138   } while( 0 )
 139 #else
 140 #define FAIL_errno( cond, msg, settings )       \
 141   do {                                          \
 142     if ( cond ) {                               \
 143       warn_errno( msg, __FILE__, __LINE__ );    \
 144       exit( 1 );                                \
 145     }                                           \
 146   } while( 0 )
 147 #endif
 148
 149 #define WARN_errno( cond, msg )                 \
 150   do {                                          \
 151     if ( cond ) {                               \
 152       warn_errno( msg, __FILE__, __LINE__ );    \
 153     }                                           \
 154   } while( 0 )
 155
 156 /* -------------------------------------------------------------------
 157  * initialize buffer to a pattern
 158  * ------------------------------------------------------------------- */
 159 void pattern( char *outBuf, int inBytes );
 160
 161 /* -------------------------------------------------------------------
 162  * input and output numbers, converting with kilo, mega, giga
 163  * stdio.c
 164  * ------------------------------------------------------------------- */
 165 double byte_atof( const char *inString );
 166 max_size_t byte_atoi( const char  *inString );
 167 void byte_snprintf( char* outString, int inLen, double inNum, char inFormat );
 168
 169 /* -------------------------------------------------------------------
 170  * redirect the stdout to a specified file
 171  * stdio.c
 172  * ------------------------------------------------------------------- */
 173 void redirect(const char *inOutputFileName);
 174
 175 /* -------------------------------------------------------------------
 176  * delete macro
 177  * ------------------------------------------------------------------- */
 178 #define DELETE_PTR( ptr )                       \
 179   do {                                          \
 180     if ( ptr != NULL ) {                        \
 181       delete ptr;                               \
 182       ptr = NULL;                               \
 183     }                                           \
 184   } while( false )
 185
 186 #define DELETE_ARRAY( ptr )                     \
 187   do {                                          \
 188     if ( ptr != NULL ) {                        \
 189       delete [] ptr;                            \
 190       ptr = NULL;                               \
 191     }                                           \
 192   } while( false )
 193
 194 #ifdef __cplusplus
 195 } /* end extern "C" */
 196 #endif
 197
 198 #endif /* UTIL_H */
 199