sjero.net Git - iperf/blob - include/Reporter.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  * Reporter.h
  48  * by Kevin Gibbs <kgibbs@nlanr.net>
  49  *
  50  * Since version 2.0 this handles all reporting.
  51  * ________________________________________________________________ */
  52
  53 #ifndef REPORTER_H
  54 #define REPORTER_H
  55
  56 #include "headers.h"
  57 #include "Mutex.h"
  58
  59 struct thread_Settings;
  60 struct server_hdr;
  61
  62 #include "Settings.hpp"
  63
  64 #define NUM_REPORT_STRUCTS 700
  65 #define NUM_MULTI_SLOTS    5
  66
  67 #ifdef __cplusplus
  68 extern "C" {
  69 #endif
  70
  71 /*
  72  * This struct contains all important information from the sending or
  73  * recieving thread.
  74  */
  75 typedef struct ReportStruct {
  76     int packetID;
  77     int packetLen;
  78     struct timeval packetTime;
  79     struct timeval sentTime;
  80 } ReportStruct;
  81
  82 /*
  83  * The type field of ReporterData is a bitmask
  84  * with one or more of the following
  85  */
  86 #define    TRANSFER_REPORT      0x00000001
  87 #define    SERVER_RELAY_REPORT  0x00000002
  88 #define    SETTINGS_REPORT      0x00000004
  89 #define    CONNECTION_REPORT    0x00000008
  90 #define    MULTIPLE_REPORT      0x00000010
  91
  92 typedef struct Transfer_Info {
  93     void *reserved_delay;
  94     int transferID;
  95     int groupID;
  96     int cntError;
  97     int cntOutofOrder;
  98     int cntDatagrams;
  99     // Hopefully int64_t's
 100     max_size_t TotalLen;
 101     double jitter;
 102     double startTime;
 103     double endTime;
 104     // chars
 105     char   mFormat;                 // -f
 106     u_char mTTL;                    // -T
 107     char   mUDP;
 108     char   free;
 109     char  *congAlgo;                // -A
 110 } Transfer_Info;
 111
 112 typedef struct Connection_Info {
 113     struct sockaddr_storage peer;
 114     struct sockaddr_storage local;
 115 } Connection_Info;
 116
 117 typedef struct ReporterData {
 118     char*  mHost;                   // -c
 119     char*  mLocalhost;              // -B
 120     // int's
 121     int type;
 122     int cntError;
 123     int lastError;
 124     int cntOutofOrder;
 125     int lastOutofOrder;
 126     int cntDatagrams;
 127     int lastDatagrams;
 128     int PacketID;
 129     int mBufLen;                    // -l
 130     int mMSS;                       // -M
 131     int mWinSize;                    // -w
 132     /*   flags is a BitMask of old bools
 133         bool   mBufLenSet;              // -l
 134         bool   mCompat;                 // -C
 135         bool   mDaemon;                 // -D
 136         bool   mDomain;                 // -V
 137         bool   mFileInput;              // -F or -I
 138         bool   mNodelay;                // -N
 139         bool   mPrintMSS;               // -m
 140         bool   mRemoveService;          // -R
 141         bool   mStdin;                  // -I
 142         bool   mStdout;                 // -o
 143         bool   mSuggestWin;             // -W
 144         bool   mUDP;
 145         bool   mMode_time;*/
 146     int flags;
 147     Protocol   mProtocol;
 148     // enums (which should be special int's)
 149     ThreadMode mThreadMode;         // -s or -c
 150     ReportMode mode;
 151     max_size_t TotalLen;
 152     max_size_t lastTotal;
 153     // doubles
 154     double lastTransit;
 155     // shorts
 156     unsigned short mPort;           // -p
 157     unsigned short mMcastIface;     // -j or -J
 158     // structs or miscellaneous
 159     Transfer_Info info;
 160     Connection_Info connection;
 161     struct timeval startTime;
 162     struct timeval packetTime;
 163     struct timeval nextTime;
 164     struct timeval intervalTime;
 165 } ReporterData;
 166
 167 typedef struct MultiHeader {
 168     int reporterindex;
 169     int agentindex;
 170     int groupID;
 171     int threads;
 172     ReporterData *report;
 173     Transfer_Info *data;
 174     Condition barrier;
 175     struct timeval startTime;
 176 } MultiHeader;
 177
 178 typedef struct ReportHeader {
 179     int reporterindex;
 180     int agentindex;
 181     ReporterData report;
 182     ReportStruct *data;
 183     MultiHeader *multireport;
 184     struct ReportHeader *next;
 185 } ReportHeader;
 186
 187 typedef void* (* report_connection)( Connection_Info*, int );
 188 typedef void (* report_settings)( ReporterData* );
 189 typedef void (* report_statistics)( Transfer_Info* );
 190 typedef void (* report_serverstatistics)( Connection_Info*, Transfer_Info* );
 191
 192 MultiHeader* InitMulti( struct thread_Settings *agent, int inID );
 193 ReportHeader* InitReport( struct thread_Settings *agent );
 194 void ReportPacket( ReportHeader *agent, ReportStruct *packet );
 195 void CloseReport( ReportHeader *agent, ReportStruct *packet );
 196 void EndReport( ReportHeader *agent );
 197 Transfer_Info* GetReport( ReportHeader *agent );
 198 void ReportServerUDP( struct thread_Settings *agent, struct server_hdr *server );
 199 void ReportSettings( struct thread_Settings *agent );
 200 void ReportConnections( struct thread_Settings *agent );
 201
 202 extern report_connection connection_reports[];
 203
 204 extern report_settings settings_reports[];
 205
 206 extern report_statistics statistics_reports[];
 207
 208 extern report_serverstatistics serverstatistics_reports[];
 209
 210 extern report_statistics multiple_reports[];
 211
 212 extern char buffer[64]; // Buffer for printing
 213
 214 #define rMillion 1000000
 215
 216 #define TimeDifference( left, right ) (left.tv_sec  - right.tv_sec) +   \
 217         (left.tv_usec - right.tv_usec) / ((double) rMillion)
 218
 219 #define TimeAdd( left, right )  do {                                    \
 220                                     left.tv_usec += right.tv_usec;      \
 221                                     if ( left.tv_usec > rMillion ) {    \
 222                                         left.tv_usec -= rMillion;       \
 223                                         left.tv_sec++;                  \
 224                                     }                                   \
 225                                     left.tv_sec += right.tv_sec;        \
 226                                 } while ( 0 )
 227 #ifdef __cplusplus
 228 } /* end extern "C" */
 229 #endif
 230
 231 #endif // REPORTER_H