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 #include <stdarg.h>
  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  set_buffer_sock_size(int inSock, int inWinSize, bool inSend);
  70 int  get_buffer_sock_size(int inSock, int inSend);
  71
  72 void setsock_tcp_mss( int inSock, int inTCPWin );
  73 int  getsock_tcp_mss( int inSock );
  74
  75 int  getsock_dccp_mps( int inSock );
  76
  77 /* -------------------------------------------------------------------
  78  * signal handlers
  79  * signal.c
  80  * ------------------------------------------------------------------- */
  81 typedef void Sigfunc(int);
  82 void sig_exit( int inSigno );
  83
  84 typedef Sigfunc *SigfuncPtr;
  85
  86 SigfuncPtr my_signal( int inSigno, SigfuncPtr inFunc );
  87
  88 /* -------------------------------------------------------------------
  89  * error handlers
  90  * error.c
  91  * ------------------------------------------------------------------- */
  92 void die(const char *fmt, ...);
  93 void warn      ( const char *inMessage, const char *inFile, int inLine );
  94 void warn_errno( const char *inMessage, const char *inFile, int inLine );
  95
  96 #if defined( HAVE_POSIX_THREAD ) || defined( HAVE_WIN32_THREAD)
  97 #define FAIL( cond, msg, settings )             \
  98   do {                                          \
  99     if ( cond ) {                               \
 100       warn( msg, __FILE__, __LINE__ );          \
 101       thread_stop(settings);                    \
 102     }                                           \
 103   } while( 0 )
 104 #else
 105 #define FAIL( cond, msg, settings )             \
 106   do {                                          \
 107     if ( cond ) {                               \
 108       warn( msg, __FILE__, __LINE__ );          \
 109       exit( 1 );                                \
 110     }                                           \
 111   } while( 0 )
 112 #endif
 113
 114 #define WARN( cond, msg )                       \
 115   do {                                          \
 116     if ( cond ) {                               \
 117       warn( msg, __FILE__, __LINE__ );          \
 118     }                                           \
 119   } while( 0 )
 120
 121 #if defined( HAVE_POSIX_THREAD ) || defined( HAVE_WIN32_THREAD)
 122 #define FAIL_errno( cond, msg, settings )       \
 123   do {                                          \
 124     if ( cond ) {                               \
 125       warn_errno( msg, __FILE__, __LINE__ );    \
 126       thread_stop(settings);                    \
 127     }                                           \
 128   } while( 0 )
 129 #else
 130 #define FAIL_errno( cond, msg, settings )       \
 131   do {                                          \
 132     if ( cond ) {                               \
 133       warn_errno( msg, __FILE__, __LINE__ );    \
 134       exit( 1 );                                \
 135     }                                           \
 136   } while( 0 )
 137 #endif
 138
 139 #define WARN_errno( cond, msg )                 \
 140   do {                                          \
 141     if ( cond ) {                               \
 142       warn_errno( msg, __FILE__, __LINE__ );    \
 143     }                                           \
 144   } while( 0 )
 145
 146 /* -------------------------------------------------------------------
 147  * initialize buffer to a pattern
 148  * ------------------------------------------------------------------- */
 149 void pattern( char *outBuf, int inBytes );
 150
 151 /* -------------------------------------------------------------------
 152  * input and output numbers, converting with kilo, mega, giga
 153  * stdio.c
 154  * ------------------------------------------------------------------- */
 155 double byte_atof( const char *inString );
 156 max_size_t byte_atoi( const char  *inString );
 157 void byte_snprintf( char* outString, int inLen, double inNum, char inFormat );
 158
 159 /* -------------------------------------------------------------------
 160  * redirect the stdout to a specified file
 161  * stdio.c
 162  * ------------------------------------------------------------------- */
 163 void redirect(const char *inOutputFileName);
 164
 165 /* -------------------------------------------------------------------
 166  * delete macro
 167  * ------------------------------------------------------------------- */
 168 #define DELETE_PTR( ptr )                       \
 169   do {                                          \
 170     if ( ptr != NULL ) {                        \
 171       delete ptr;                               \
 172       ptr = NULL;                               \
 173     }                                           \
 174   } while( false )
 175
 176 #define DELETE_ARRAY( ptr )                     \
 177   do {                                          \
 178     if ( ptr != NULL ) {                        \
 179       delete [] ptr;                            \
 180       ptr = NULL;                               \
 181     }                                           \
 182   } while( false )
 183
 184 #ifdef __cplusplus
 185 } /* end extern "C" */
 186 #endif
 187 #endif /* UTIL_H */
 188