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,
79 static inline const char *protoName(const unsigned proto)
82 case kProto_TCP: return "TCP";
83 case kProto_DCCP: return "DCCP";
84 case kProto_UDP: return "UDP";
85 default: return "(unknown)";
89 static inline unsigned sockType(const Protocol p)
92 case kProto_TCP: return SOCK_STREAM;
93 case kProto_UDP: return SOCK_DGRAM;
94 case kProto_DCCP: return SOCK_DCCP;
98 static inline bool is_connectionless(const Protocol p)
100 return p == kProto_UDP;
103 // server/client mode
104 typedef enum ThreadMode {
113 typedef enum ReportMode {
121 typedef enum TestMode {
128 #include "Reporter.h"
130 * The thread_Settings is a structure that holds all
131 * options for a given execution of either a client
132 * or server. By using this structure rather than
133 * a global structure or class we can have multiple
134 * clients or servers running with different settings.
135 * In version 2.0 and above this structure contains
136 * all the information needed for a thread to execute
137 * and contains only C elements so it can be manipulated
138 * by either C or C++.
140 typedef struct thread_Settings {
142 char* mFileName; // -F
144 char* mLocalhost; // -B
145 char* mOutputFileName; // -o
146 FILE* Extractor_file;
147 ReportHeader* reporthdr;
148 MultiHeader* multihdr;
149 struct thread_Settings *runNow;
150 struct thread_Settings *runNext;
159 /* flags is a BitMask of old bools
160 bool mBufLenSet; // -l
164 bool mFileInput; // -F or -I
166 bool mPrintMSS; // -m
167 bool mRemoveService; // -R
170 bool mSuggestWin; // -W
173 bool mReportSettings;
175 bool mNoSettingsReport; // -x s
176 bool mNoConnectionReport; // -x c
177 bool mNoDataReport; // -x d
178 bool mNoServerReport; // -x
179 bool mNoMultReport; // -x m
180 bool mSinlgeClient; // -1 */
184 // enums (which should be special int's)
185 ThreadMode mThreadMode; // -s or -c
186 ReportMode mReportMode;
187 TestMode mMode; // -r or -d
188 // Hopefully int64_t's
189 max_size_t mDgramRate; // -b
190 max_size_t mAmount; // -n or -t
192 double mInterval; // -i
194 unsigned short mListenPort; // -L
195 unsigned short mPort; // -p
200 // structs or miscellaneous
203 iperf_sockaddr local;
204 Socklen_t size_local;
209 * Due to the use of thread_Settings in C and C++
210 * we are unable to use bool values. To provide
211 * the functionality of bools we use the following
212 * bitmask over an assumed 32 bit int. This will
213 * work fine on 64bit machines we will just be ignoring
216 * To add a flag simply define it as the next bit then
217 * add the 3 support functions below.
219 #define FLAG_BUFLENSET 0x00000001
220 #define FLAG_COMPAT 0x00000002
221 #define FLAG_DAEMON 0x00000004
222 #define FLAG_DOMAIN 0x00000008
223 #define FLAG_FILEINPUT 0x00000010
224 #define FLAG_NODELAY 0x00000020
225 #define FLAG_PRINTMSS 0x00000040
226 #define FLAG_REMOVESERVICE 0x00000080
227 #define FLAG_STDIN 0x00000100
228 #define FLAG_STDOUT 0x00000200
229 #define FLAG_SUGGESTWIN 0x00000400
230 #define FLAG_MODETIME 0x00001000
231 #define FLAG_REPORTSETTINGS 0x00002000
232 #define FLAG_MULTICAST 0x00004000
233 #define FLAG_NOSETTREPORT 0x00008000
234 #define FLAG_NOCONNREPORT 0x00010000
235 #define FLAG_NODATAREPORT 0x00020000
236 #define FLAG_NOSERVREPORT 0x00040000
237 #define FLAG_NOMULTREPORT 0x00080000
238 #define FLAG_SINGLECLIENT 0x00100000
239 #define FLAG_SINGLEUDP 0x00200000
240 #define FLAG_PACKETORIENTED 0x01000000
243 #define isBuflenSet(settings) ((settings->flags & FLAG_BUFLENSET) != 0)
244 #define isCompat(settings) ((settings->flags & FLAG_COMPAT) != 0)
245 #define isDaemon(settings) ((settings->flags & FLAG_DAEMON) != 0)
246 #define isIPV6(settings) ((settings->flags & FLAG_DOMAIN) != 0)
247 #define isFileInput(settings) ((settings->flags & FLAG_FILEINPUT) != 0)
248 #define isNoDelay(settings) ((settings->flags & FLAG_NODELAY) != 0)
249 #define isPrintMSS(settings) ((settings->flags & FLAG_PRINTMSS) != 0)
250 #define isRemoveService(settings) ((settings->flags & FLAG_REMOVESERVICE) != 0)
251 #define isSTDIN(settings) ((settings->flags & FLAG_STDIN) != 0)
252 #define isSTDOUT(settings) ((settings->flags & FLAG_STDOUT) != 0)
253 #define isSuggestWin(settings) ((settings->flags & FLAG_SUGGESTWIN) != 0)
254 #define isModeTime(settings) ((settings->flags & FLAG_MODETIME) != 0)
255 #define isReport(settings) ((settings->flags & FLAG_REPORTSETTINGS) != 0)
256 #define isMulticast(settings) ((settings->flags & FLAG_MULTICAST) != 0)
257 // Active Low for Reports
258 #define isSettingsReport(settings) ((settings->flags & FLAG_NOSETTREPORT) == 0)
259 #define isConnectionReport(settings) ((settings->flags & FLAG_NOCONNREPORT) == 0)
260 #define isDataReport(settings) ((settings->flags & FLAG_NODATAREPORT) == 0)
261 #define isServerReport(settings) ((settings->flags & FLAG_NOSERVREPORT) == 0)
262 #define isMultipleReport(settings) ((settings->flags & FLAG_NOMULTREPORT) == 0)
264 #define isSingleClient(settings) ((settings->flags & FLAG_SINGLECLIENT) != 0)
265 #define isSingleUDP(settings) ((settings->flags & FLAG_SINGLEUDP) != 0)
266 #define isConnectionLess(settings) is_connectionless((settings)->mProtocol)
267 #define isPacketOriented(settings) (((settings)->flags & FLAG_PACKETORIENTED) != 0)
269 #define setBuflenSet(settings) settings->flags |= FLAG_BUFLENSET
270 #define setCompat(settings) settings->flags |= FLAG_COMPAT
271 #define setDaemon(settings) settings->flags |= FLAG_DAEMON
272 #define setIPV6(settings) settings->flags |= FLAG_DOMAIN
273 #define setFileInput(settings) settings->flags |= FLAG_FILEINPUT
274 #define setNoDelay(settings) settings->flags |= FLAG_NODELAY
275 #define setPrintMSS(settings) settings->flags |= FLAG_PRINTMSS
276 #define setRemoveService(settings) settings->flags |= FLAG_REMOVESERVICE
277 #define setSTDIN(settings) settings->flags |= FLAG_STDIN
278 #define setSTDOUT(settings) settings->flags |= FLAG_STDOUT
279 #define setSuggestWin(settings) settings->flags |= FLAG_SUGGESTWIN
280 #define setModeTime(settings) settings->flags |= FLAG_MODETIME
281 #define setReport(settings) settings->flags |= FLAG_REPORTSETTINGS
282 #define setMulticast(settings) settings->flags |= FLAG_MULTICAST
283 #define setNoSettReport(settings) settings->flags |= FLAG_NOSETTREPORT
284 #define setNoConnReport(settings) settings->flags |= FLAG_NOCONNREPORT
285 #define setNoDataReport(settings) settings->flags |= FLAG_NODATAREPORT
286 #define setNoServReport(settings) settings->flags |= FLAG_NOSERVREPORT
287 #define setNoMultReport(settings) settings->flags |= FLAG_NOMULTREPORT
288 #define setSingleClient(settings) settings->flags |= FLAG_SINGLECLIENT
289 #define setSingleUDP(settings) settings->flags |= FLAG_SINGLEUDP
290 #define setPacketOriented(settings) settings->flags |= FLAG_PACKETORIENTED
292 #define unsetBuflenSet(settings) settings->flags &= ~FLAG_BUFLENSET
293 #define unsetCompat(settings) settings->flags &= ~FLAG_COMPAT
294 #define unsetDaemon(settings) settings->flags &= ~FLAG_DAEMON
295 #define unsetIPV6(settings) settings->flags &= ~FLAG_DOMAIN
296 #define unsetFileInput(settings) settings->flags &= ~FLAG_FILEINPUT
297 #define unsetNoDelay(settings) settings->flags &= ~FLAG_NODELAY
298 #define unsetPrintMSS(settings) settings->flags &= ~FLAG_PRINTMSS
299 #define unsetRemoveService(settings) settings->flags &= ~FLAG_REMOVESERVICE
300 #define unsetSTDIN(settings) settings->flags &= ~FLAG_STDIN
301 #define unsetSTDOUT(settings) settings->flags &= ~FLAG_STDOUT
302 #define unsetSuggestWin(settings) settings->flags &= ~FLAG_SUGGESTWIN
303 #define unsetModeTime(settings) settings->flags &= ~FLAG_MODETIME
304 #define unsetReport(settings) settings->flags &= ~FLAG_REPORTSETTINGS
305 #define unsetMulticast(settings) settings->flags &= ~FLAG_MULTICAST
306 #define unsetNoSettReport(settings) settings->flags &= ~FLAG_NOSETTREPORT
307 #define unsetNoConnReport(settings) settings->flags &= ~FLAG_NOCONNREPORT
308 #define unsetNoDataReport(settings) settings->flags &= ~FLAG_NODATAREPORT
309 #define unsetNoServReport(settings) settings->flags &= ~FLAG_NOSERVREPORT
310 #define unsetNoMultReport(settings) settings->flags &= ~FLAG_NOMULTREPORT
311 #define unsetSingleClient(settings) settings->flags &= ~FLAG_SINGLECLIENT
312 #define unsetSingleUDP(settings) settings->flags &= ~FLAG_SINGLEUDP
313 #define unsetPacketOriented(settings) settings->flags &= ~FLAG_PACKETORIENTED
316 #define HEADER_VERSION1 0x80000000
317 #define RUN_NOW 0x00000001
320 * Datagram record for record-oriented applications
321 * used to reference the 4 byte ID number we place in UDP datagrams
322 * use int32_t if possible, otherwise a 32 bit bitfield (e.g. on J90)
324 typedef struct dgram_record {
331 unsigned int tv_sec : 32;
332 unsigned int tv_usec : 32;
337 * The client_hdr structure is sent from clients
338 * to servers to alert them of things that need
339 * to happen. Order must be perserved in all
340 * future releases for backward compatibility.
341 * 1.7 has flags, numThreads, mPort, and bufferlen
343 typedef struct client_hdr {
348 * flags is a bitmap for different options
349 * the most significant bits are for determining
350 * which information is available. So 1.7 uses
351 * 0x80000000 and the next time information is added
352 * the 1.7 bit will be set and 0x40000000 will be
353 * set signifying additional information. If no
354 * information bits are set then the header is ignored.
355 * The lowest order diferentiates between dualtest and
356 * tradeoff modes, wheither the speaker needs to start
357 * immediately or after the audience finishes.
366 signed int flags : 32;
367 signed int numThreads : 32;
368 signed int mPort : 32;
369 signed int bufferlen : 32;
370 signed int mWinBand : 32;
371 signed int mAmount : 32;
376 * The server_hdr structure facilitates the server
377 * report of jitter and loss on the client side.
378 * It piggy_backs on the existing clear to close
381 typedef struct server_hdr {
386 * flags is a bitmap for different options
387 * the most significant bits are for determining
388 * which information is available. So 1.7 uses
389 * 0x80000000 and the next time information is added
390 * the 1.7 bit will be set and 0x40000000 will be
391 * set signifying additional information. If no
392 * information bits are set then the header is ignored.
400 int32_t outorder_cnt;
405 signed int flags : 32;
406 signed int total_len1 : 32;
407 signed int total_len2 : 32;
408 signed int stop_sec : 32;
409 signed int stop_usec : 32;
410 signed int error_cnt : 32;
411 signed int outorder_cnt : 32;
412 signed int datagrams : 32;
413 signed int jitter1 : 32;
414 signed int jitter2 : 32;
420 void Settings_Initialize( thread_Settings* main );
423 void Settings_Copy( thread_Settings* from, thread_Settings** into );
425 // free associated memory
426 void Settings_Destroy( thread_Settings *mSettings );
428 // parse settings from user's environment variables
429 void Settings_ParseEnvironment( thread_Settings *mSettings );
431 // parse settings from app's command line
432 void Settings_ParseCommandLine( int argc, char **argv, thread_Settings *mSettings );
434 // convert to lower case for [KMG]bits/sec
435 void Settings_GetLowerCaseArg(const char *,char *);
437 // convert to upper case for [KMG]bytes/sec
438 void Settings_GetUpperCaseArg(const char *,char *);
440 // generate settings for listener instance
441 void Settings_GenerateListenerSettings( thread_Settings *client, thread_Settings **listener);
443 // generate settings for speaker instance
444 void Settings_GenerateClientSettings( thread_Settings *server,
445 thread_Settings **client,
448 // generate client header for server
449 void Settings_GenerateClientHdr( thread_Settings *client, client_hdr *hdr );
452 } /* end extern "C" */