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 Mark Gates <mgates@nlanr.net>
49 * & Ajay Tirumala <tirumala@ncsa.uiuc.edu>
50 * -------------------------------------------------------------------
51 * Stores and parses the initial values for all the global variables.
52 * -------------------------------------------------------------------
57 * ------------------------------------------------------------------- */
65 /* -------------------------------------------------------------------
67 * ------------------------------------------------------------------- */
72 // Convention: odd=connection-oriented, even=connection-less
73 typedef enum Protocol {
74 kProto_TCP = IPPROTO_TCP,
75 kProto_DCCP = IPPROTO_DCCP,
76 kProto_UDP = IPPROTO_UDP,
77 kProto_UDPLITE = IPPROTO_UDPLITE,
80 static inline const char *protoName(const unsigned proto)
83 case kProto_TCP: return "TCP";
84 case kProto_DCCP: return "DCCP";
85 case kProto_UDP: return "UDP";
86 case kProto_UDPLITE: return "UDP-Lite";
87 default: return "(unknown)";
91 static inline unsigned sockType(const Protocol p)
94 case kProto_TCP: return SOCK_STREAM;
95 case kProto_UDPLITE: /* fall through */
96 case kProto_UDP: return SOCK_DGRAM;
97 case kProto_DCCP: return SOCK_DCCP;
101 static inline bool is_connectionless(const Protocol p)
103 return p == kProto_UDP || p == kProto_UDPLITE;
106 // server/client mode
107 typedef enum ThreadMode {
116 typedef enum ReportMode {
124 typedef enum TestMode {
131 #include "Reporter.h"
133 * The thread_Settings is a structure that holds all
134 * options for a given execution of either a client
135 * or server. By using this structure rather than
136 * a global structure or class we can have multiple
137 * clients or servers running with different settings.
138 * In version 2.0 and above this structure contains
139 * all the information needed for a thread to execute
140 * and contains only C elements so it can be manipulated
141 * by either C or C++.
143 typedef struct thread_Settings {
145 char* mFileName; // -F
147 char* mLocalhost; // -B
148 char* mOutputFileName; // -o
149 FILE* Extractor_file;
150 ReportHeader* reporthdr;
151 MultiHeader* multihdr;
152 struct thread_Settings *runNow;
153 struct thread_Settings *runNext;
157 int mSock; // socket descriptor
158 int mSockAF; // type of @mSock
163 /* flags is a BitMask of old bools
164 bool mBufLenSet; // -l
168 bool mFileInput; // -F or -I
170 bool mPrintMSS; // -m
171 bool mRemoveService; // -R
174 bool mSuggestWin; // -W
177 bool mReportSettings;
179 bool mNoSettingsReport; // -x s
180 bool mNoConnectionReport; // -x c
181 bool mNoDataReport; // -x d
182 bool mNoServerReport; // -x
183 bool mNoMultReport; // -x m
184 bool mSinlgeClient; // -1 */
188 // enums (which should be special int's)
189 ThreadMode mThreadMode; // -s or -c
190 ReportMode mReportMode;
191 TestMode mMode; // -r or -d
192 // Hopefully int64_t's
193 max_size_t mDgramRate; // -b
194 max_size_t mAmount; // -n or -t
196 double mInterval; // -i
198 unsigned short mListenPort; // -L
199 unsigned short mPort; // -p
200 unsigned short mMcastIface; // -j or -J
204 int cscov; // -u (partial csums)
205 char *congAlgo; // -A
207 // structs or miscellaneous
208 struct sockaddr_storage peer; // remote part of socket
209 struct sockaddr_storage local; // local part of socket
214 * Due to the use of thread_Settings in C and C++
215 * we are unable to use bool values. To provide
216 * the functionality of bools we use the following
217 * bitmask over an assumed 32 bit int. This will
218 * work fine on 64bit machines we will just be ignoring
221 * To add a flag simply define it as the next bit then
222 * add the 3 support functions below.
224 #define FLAG_BUFLENSET 0x00000001
225 #define FLAG_COMPAT 0x00000002
226 #define FLAG_DAEMON 0x00000004
227 #define FLAG_DOMAIN 0x00000008
228 #define FLAG_FILEINPUT 0x00000010
229 #define FLAG_NODELAY 0x00000020
230 #define FLAG_PRINTMSS 0x00000040
231 #define FLAG_REMOVESERVICE 0x00000080
232 #define FLAG_STDIN 0x00000100
233 #define FLAG_STDOUT 0x00000200
234 #define FLAG_SUGGESTWIN 0x00000400
235 #define FLAG_MODETIME 0x00001000
236 #define FLAG_REPORTSETTINGS 0x00002000
237 #define FLAG_MULTICAST 0x00004000
238 #define FLAG_NOSETTREPORT 0x00008000
239 #define FLAG_NOCONNREPORT 0x00010000
240 #define FLAG_NODATAREPORT 0x00020000
241 #define FLAG_NOSERVREPORT 0x00040000
242 #define FLAG_NOMULTREPORT 0x00080000
243 #define FLAG_SINGLECLIENT 0x00100000
244 #define FLAG_SINGLEUDP 0x00200000
245 #define FLAG_PACKETORIENTED 0x01000000
248 #define isBuflenSet(settings) ((settings->flags & FLAG_BUFLENSET) != 0)
249 #define isCompat(settings) ((settings->flags & FLAG_COMPAT) != 0)
250 #define isDaemon(settings) ((settings->flags & FLAG_DAEMON) != 0)
251 #define isIPV6(settings) ((settings->flags & FLAG_DOMAIN) != 0)
252 #define isFileInput(settings) ((settings->flags & FLAG_FILEINPUT) != 0)
253 #define isNoDelay(settings) ((settings->flags & FLAG_NODELAY) != 0)
254 #define isPrintMSS(settings) ((settings->flags & FLAG_PRINTMSS) != 0)
255 #define isRemoveService(settings) ((settings->flags & FLAG_REMOVESERVICE) != 0)
256 #define isSTDIN(settings) ((settings->flags & FLAG_STDIN) != 0)
257 #define isSTDOUT(settings) ((settings->flags & FLAG_STDOUT) != 0)
258 #define isSuggestWin(settings) ((settings->flags & FLAG_SUGGESTWIN) != 0)
259 #define isModeTime(settings) ((settings->flags & FLAG_MODETIME) != 0)
260 #define isReport(settings) ((settings->flags & FLAG_REPORTSETTINGS) != 0)
261 #define isMulticast(settings) ((settings->flags & FLAG_MULTICAST) != 0)
262 // Active Low for Reports
263 #define isSettingsReport(settings) ((settings->flags & FLAG_NOSETTREPORT) == 0)
264 #define isConnectionReport(settings) ((settings->flags & FLAG_NOCONNREPORT) == 0)
265 #define isDataReport(settings) ((settings->flags & FLAG_NODATAREPORT) == 0)
266 #define isServerReport(settings) ((settings->flags & FLAG_NOSERVREPORT) == 0)
267 #define isMultipleReport(settings) ((settings->flags & FLAG_NOMULTREPORT) == 0)
269 #define isSingleClient(settings) ((settings->flags & FLAG_SINGLECLIENT) != 0)
270 #define isSingleUDP(settings) ((settings->flags & FLAG_SINGLEUDP) != 0)
271 #define isConnectionLess(settings) is_connectionless((settings)->mProtocol)
272 #define isPacketOriented(settings) (((settings)->flags & FLAG_PACKETORIENTED) != 0)
274 #define setBuflenSet(settings) settings->flags |= FLAG_BUFLENSET
275 #define setCompat(settings) settings->flags |= FLAG_COMPAT
276 #define setDaemon(settings) settings->flags |= FLAG_DAEMON
277 #define setIPV6(settings) settings->flags |= FLAG_DOMAIN
278 #define setFileInput(settings) settings->flags |= FLAG_FILEINPUT
279 #define setNoDelay(settings) settings->flags |= FLAG_NODELAY
280 #define setPrintMSS(settings) settings->flags |= FLAG_PRINTMSS
281 #define setRemoveService(settings) settings->flags |= FLAG_REMOVESERVICE
282 #define setSTDIN(settings) settings->flags |= FLAG_STDIN
283 #define setSTDOUT(settings) settings->flags |= FLAG_STDOUT
284 #define setSuggestWin(settings) settings->flags |= FLAG_SUGGESTWIN
285 #define setModeTime(settings) settings->flags |= FLAG_MODETIME
286 #define setReport(settings) settings->flags |= FLAG_REPORTSETTINGS
287 #define setMulticast(settings) settings->flags |= FLAG_MULTICAST
288 #define setNoSettReport(settings) settings->flags |= FLAG_NOSETTREPORT
289 #define setNoConnReport(settings) settings->flags |= FLAG_NOCONNREPORT
290 #define setNoDataReport(settings) settings->flags |= FLAG_NODATAREPORT
291 #define setNoServReport(settings) settings->flags |= FLAG_NOSERVREPORT
292 #define setNoMultReport(settings) settings->flags |= FLAG_NOMULTREPORT
293 #define setSingleClient(settings) settings->flags |= FLAG_SINGLECLIENT
294 #define setSingleUDP(settings) settings->flags |= FLAG_SINGLEUDP
295 #define setPacketOriented(settings) settings->flags |= FLAG_PACKETORIENTED
297 #define unsetBuflenSet(settings) settings->flags &= ~FLAG_BUFLENSET
298 #define unsetCompat(settings) settings->flags &= ~FLAG_COMPAT
299 #define unsetDaemon(settings) settings->flags &= ~FLAG_DAEMON
300 #define unsetIPV6(settings) settings->flags &= ~FLAG_DOMAIN
301 #define unsetFileInput(settings) settings->flags &= ~FLAG_FILEINPUT
302 #define unsetNoDelay(settings) settings->flags &= ~FLAG_NODELAY
303 #define unsetPrintMSS(settings) settings->flags &= ~FLAG_PRINTMSS
304 #define unsetRemoveService(settings) settings->flags &= ~FLAG_REMOVESERVICE
305 #define unsetSTDIN(settings) settings->flags &= ~FLAG_STDIN
306 #define unsetSTDOUT(settings) settings->flags &= ~FLAG_STDOUT
307 #define unsetSuggestWin(settings) settings->flags &= ~FLAG_SUGGESTWIN
308 #define unsetModeTime(settings) settings->flags &= ~FLAG_MODETIME
309 #define unsetReport(settings) settings->flags &= ~FLAG_REPORTSETTINGS
310 #define unsetMulticast(settings) settings->flags &= ~FLAG_MULTICAST
311 #define unsetNoSettReport(settings) settings->flags &= ~FLAG_NOSETTREPORT
312 #define unsetNoConnReport(settings) settings->flags &= ~FLAG_NOCONNREPORT
313 #define unsetNoDataReport(settings) settings->flags &= ~FLAG_NODATAREPORT
314 #define unsetNoServReport(settings) settings->flags &= ~FLAG_NOSERVREPORT
315 #define unsetNoMultReport(settings) settings->flags &= ~FLAG_NOMULTREPORT
316 #define unsetSingleClient(settings) settings->flags &= ~FLAG_SINGLECLIENT
317 #define unsetSingleUDP(settings) settings->flags &= ~FLAG_SINGLEUDP
318 #define unsetPacketOriented(settings) settings->flags &= ~FLAG_PACKETORIENTED
321 #define HEADER_VERSION1 0x80000000
322 #define RUN_NOW 0x00000001
325 * Datagram record for record-oriented applications
326 * used to reference the 4 byte ID number we place in UDP datagrams
327 * use int32_t if possible, otherwise a 32 bit bitfield (e.g. on J90)
329 typedef struct dgram_record {
336 unsigned int tv_sec : 32;
337 unsigned int tv_usec : 32;
342 * The client_hdr structure is sent from clients
343 * to servers to alert them of things that need
344 * to happen. Order must be perserved in all
345 * future releases for backward compatibility.
346 * 1.7 has flags, numThreads, mPort, and bufferlen
348 typedef struct client_hdr {
353 * flags is a bitmap for different options
354 * the most significant bits are for determining
355 * which information is available. So 1.7 uses
356 * 0x80000000 and the next time information is added
357 * the 1.7 bit will be set and 0x40000000 will be
358 * set signifying additional information. If no
359 * information bits are set then the header is ignored.
360 * The lowest order diferentiates between dualtest and
361 * tradeoff modes, wheither the speaker needs to start
362 * immediately or after the audience finishes.
371 signed int flags : 32;
372 signed int numThreads : 32;
373 signed int mPort : 32;
374 signed int bufferlen : 32;
375 signed int mWinBand : 32;
376 signed int mAmount : 32;
381 * The server_hdr structure facilitates the server
382 * report of jitter and loss on the client side.
383 * It piggy_backs on the existing clear to close
386 typedef struct server_hdr {
391 * flags is a bitmap for different options
392 * the most significant bits are for determining
393 * which information is available. So 1.7 uses
394 * 0x80000000 and the next time information is added
395 * the 1.7 bit will be set and 0x40000000 will be
396 * set signifying additional information. If no
397 * information bits are set then the header is ignored.
405 int32_t outorder_cnt;
410 signed int flags : 32;
411 signed int total_len1 : 32;
412 signed int total_len2 : 32;
413 signed int stop_sec : 32;
414 signed int stop_usec : 32;
415 signed int error_cnt : 32;
416 signed int outorder_cnt : 32;
417 signed int datagrams : 32;
418 signed int jitter1 : 32;
419 signed int jitter2 : 32;
425 void Settings_Initialize( thread_Settings* main );
428 void Settings_Copy( thread_Settings* from, thread_Settings** into );
430 // free associated memory
431 void Settings_Destroy( thread_Settings *mSettings );
433 // parse settings from user's environment variables
434 void Settings_ParseEnvironment( thread_Settings *mSettings );
436 // parse settings from app's command line
437 void Settings_ParseCommandLine( int argc, char **argv, thread_Settings *mSettings );
439 // convert to lower case for [KMG]bits/sec
440 void Settings_GetLowerCaseArg(const char *,char *);
442 // convert to upper case for [KMG]bytes/sec
443 void Settings_GetUpperCaseArg(const char *,char *);
445 // generate settings for listener instance
446 void Settings_GenerateListenerSettings( thread_Settings *client, thread_Settings **listener);
448 // generate settings for speaker instance
449 void Settings_GenerateClientSettings( thread_Settings *server,
450 thread_Settings **client,
453 // generate client header for server
454 void Settings_GenerateClientHdr( thread_Settings *client, client_hdr *hdr );
457 } /* end extern "C" */