xref: /iperf/src/iperf_error.c (revision b1bc12a2)
1 /*
2  * iperf, Copyright (c) 2014, 2015, 2016, 2017, The Regents of the University of
3  * California, through Lawrence Berkeley National Laboratory (subject
4  * to receipt of any required approvals from the U.S. Dept. of
5  * Energy).  All rights reserved.
6  *
7  * If you have questions about your rights to use or distribute this
8  * software, please contact Berkeley Lab's Technology Transfer
9  * Department at [email protected].
10  *
11  * NOTICE.  This software is owned by the U.S. Department of Energy.
12  * As such, the U.S. Government has been granted for itself and others
13  * acting on its behalf a paid-up, nonexclusive, irrevocable,
14  * worldwide license in the Software to reproduce, prepare derivative
15  * works, and perform publicly and display publicly.  Beginning five
16  * (5) years after the date permission to assert copyright is obtained
17  * from the U.S. Department of Energy, and subject to any subsequent
18  * five (5) year renewals, the U.S. Government is granted for itself
19  * and others acting on its behalf a paid-up, nonexclusive,
20  * irrevocable, worldwide license in the Software to reproduce,
21  * prepare derivative works, distribute copies to the public, perform
22  * publicly and display publicly, and to permit others to do so.
23  *
24  * This code is distributed under a BSD style license, see the LICENSE
25  * file for complete information.
26  */
27 #include <stdio.h>
28 #include <errno.h>
29 #include <netdb.h>
30 #include <string.h>
31 #include <stdlib.h>
32 #include <stdarg.h>
33 #include "iperf.h"
34 #include "iperf_api.h"
35 
36 /* Do a printf to stderr. */
37 void
38 iperf_err(struct iperf_test *test, const char *format, ...)
39 {
40     va_list argp;
41     char str[1000];
42 
43     va_start(argp, format);
44     vsnprintf(str, sizeof(str), format, argp);
45     if (test != NULL && test->json_output && test->json_top != NULL)
46 	cJSON_AddStringToObject(test->json_top, "error", str);
47     else
48 	if (test && test->outfile) {
49 	    fprintf(test->outfile, "iperf3: %s\n", str);
50 	}
51 	else {
52 	    fprintf(stderr, "iperf3: %s\n", str);
53 	}
54     va_end(argp);
55 }
56 
57 /* Do a printf to stderr or log file as appropriate, then exit. */
58 void
59 iperf_errexit(struct iperf_test *test, const char *format, ...)
60 {
61     va_list argp;
62     char str[1000];
63 
64     va_start(argp, format);
65     vsnprintf(str, sizeof(str), format, argp);
66     if (test != NULL && test->json_output && test->json_top != NULL) {
67 	cJSON_AddStringToObject(test->json_top, "error", str);
68 	iperf_json_finish(test);
69     } else
70 	if (test && test->outfile) {
71 	    fprintf(test->outfile, "iperf3: %s\n", str);
72 	}
73 	else {
74 	    fprintf(stderr, "iperf3: %s\n", str);
75 	}
76     va_end(argp);
77     if (test)
78         iperf_delete_pidfile(test);
79     exit(1);
80 }
81 
82 int i_errno;
83 
84 char *
85 iperf_strerror(int int_errno)
86 {
87     static char errstr[256];
88     int len, perr, herr;
89     perr = herr = 0;
90 
91     len = sizeof(errstr);
92     memset(errstr, 0, len);
93 
94     switch (int_errno) {
95         case IENONE:
96             snprintf(errstr, len, "no error");
97             break;
98         case IESERVCLIENT:
99             snprintf(errstr, len, "cannot be both server and client");
100             break;
101         case IENOROLE:
102             snprintf(errstr, len, "must either be a client (-c) or server (-s)");
103             break;
104         case IESERVERONLY:
105             snprintf(errstr, len, "some option you are trying to set is server only");
106             break;
107         case IECLIENTONLY:
108             snprintf(errstr, len, "some option you are trying to set is client only");
109             break;
110         case IEDURATION:
111             snprintf(errstr, len, "test duration too long (maximum = %d seconds)", MAX_TIME);
112             break;
113         case IENUMSTREAMS:
114             snprintf(errstr, len, "number of parallel streams too large (maximum = %d)", MAX_STREAMS);
115             break;
116         case IEBLOCKSIZE:
117             snprintf(errstr, len, "block size too large (maximum = %d bytes)", MAX_BLOCKSIZE);
118             break;
119         case IEBUFSIZE:
120             snprintf(errstr, len, "socket buffer size too large (maximum = %d bytes)", MAX_TCP_BUFFER);
121             break;
122         case IEINTERVAL:
123             snprintf(errstr, len, "invalid report interval (min = %g, max = %g seconds)", MIN_INTERVAL, MAX_INTERVAL);
124             break;
125         case IEBIND:
126             snprintf(errstr, len, "--bind must be specified to use --cport");
127             break;
128         case IEUDPBLOCKSIZE:
129             snprintf(errstr, len, "block size invalid (minimum = %d bytes, maximum = %d bytes)", MIN_UDP_BLOCKSIZE, MAX_UDP_BLOCKSIZE);
130             break;
131         case IEBADTOS:
132             snprintf(errstr, len, "bad TOS value (must be between 0 and 255 inclusive)");
133             break;
134         case IESETCLIENTAUTH:
135              snprintf(errstr, len, "you must specify username (max 20 chars), password (max 20 chars) and a path to a valid public rsa client to be used");
136             break;
137         case IESETSERVERAUTH:
138              snprintf(errstr, len, "you must specify path to a valid private rsa server to be used and a user credential file");
139             break;
140         case IEMSS:
141             snprintf(errstr, len, "TCP MSS too large (maximum = %d bytes)", MAX_MSS);
142             break;
143         case IENOSENDFILE:
144             snprintf(errstr, len, "this OS does not support sendfile");
145             break;
146         case IEOMIT:
147             snprintf(errstr, len, "bogus value for --omit");
148             break;
149         case IEUNIMP:
150             snprintf(errstr, len, "an option you are trying to set is not implemented yet");
151             break;
152         case IEFILE:
153             snprintf(errstr, len, "unable to open -F file");
154             perr = 1;
155             break;
156         case IEBURST:
157             snprintf(errstr, len, "invalid burst count (maximum = %d)", MAX_BURST);
158             break;
159         case IEENDCONDITIONS:
160             snprintf(errstr, len, "only one test end condition (-t, -n, -k) may be specified");
161             break;
162 	case IELOGFILE:
163 	    snprintf(errstr, len, "unable to open log file");
164 	    perr = 1;
165 	    break;
166 	case IENOSCTP:
167 	    snprintf(errstr, len, "no SCTP support available");
168 	    break;
169         case IENEWTEST:
170             snprintf(errstr, len, "unable to create a new test");
171             perr = 1;
172             break;
173         case IEINITTEST:
174             snprintf(errstr, len, "test initialization failed");
175             perr = 1;
176             break;
177         case IEAUTHTEST:
178             snprintf(errstr, len, "test authorization failed");
179             break;
180         case IELISTEN:
181             snprintf(errstr, len, "unable to start listener for connections");
182             perr = 1;
183             break;
184         case IECONNECT:
185             snprintf(errstr, len, "unable to connect to server");
186             perr = 1;
187             break;
188         case IEACCEPT:
189             snprintf(errstr, len, "unable to accept connection from client");
190             herr = 1;
191             perr = 1;
192             break;
193         case IESENDCOOKIE:
194             snprintf(errstr, len, "unable to send cookie to server");
195             perr = 1;
196             break;
197         case IERECVCOOKIE:
198             snprintf(errstr, len, "unable to receive cookie at server");
199             perr = 1;
200             break;
201         case IECTRLWRITE:
202             snprintf(errstr, len, "unable to write to the control socket");
203             perr = 1;
204             break;
205         case IECTRLREAD:
206             snprintf(errstr, len, "unable to read from the control socket");
207             perr = 1;
208             break;
209         case IECTRLCLOSE:
210             snprintf(errstr, len, "control socket has closed unexpectedly");
211             break;
212         case IEMESSAGE:
213             snprintf(errstr, len, "received an unknown control message");
214             break;
215         case IESENDMESSAGE:
216             snprintf(errstr, len, "unable to send control message");
217             perr = 1;
218             break;
219         case IERECVMESSAGE:
220             snprintf(errstr, len, "unable to receive control message");
221             perr = 1;
222             break;
223         case IESENDPARAMS:
224             snprintf(errstr, len, "unable to send parameters to server");
225             perr = 1;
226             break;
227         case IERECVPARAMS:
228             snprintf(errstr, len, "unable to receive parameters from client");
229             perr = 1;
230             break;
231         case IEPACKAGERESULTS:
232             snprintf(errstr, len, "unable to package results");
233             perr = 1;
234             break;
235         case IESENDRESULTS:
236             snprintf(errstr, len, "unable to send results");
237             perr = 1;
238             break;
239         case IERECVRESULTS:
240             snprintf(errstr, len, "unable to receive results");
241             perr = 1;
242             break;
243         case IESELECT:
244             snprintf(errstr, len, "select failed");
245             perr = 1;
246             break;
247         case IECLIENTTERM:
248             snprintf(errstr, len, "the client has terminated");
249             break;
250         case IESERVERTERM:
251             snprintf(errstr, len, "the server has terminated");
252             break;
253         case IEACCESSDENIED:
254             snprintf(errstr, len, "the server is busy running a test. try again later");
255             break;
256         case IESETNODELAY:
257             snprintf(errstr, len, "unable to set TCP/SCTP NODELAY");
258             perr = 1;
259             break;
260         case IESETMSS:
261             snprintf(errstr, len, "unable to set TCP/SCTP MSS");
262             perr = 1;
263             break;
264         case IESETBUF:
265             snprintf(errstr, len, "unable to set socket buffer size");
266             perr = 1;
267             break;
268         case IESETTOS:
269             snprintf(errstr, len, "unable to set IP TOS");
270             perr = 1;
271             break;
272         case IESETCOS:
273             snprintf(errstr, len, "unable to set IPv6 traffic class");
274             perr = 1;
275             break;
276         case IESETFLOW:
277             snprintf(errstr, len, "unable to set IPv6 flow label");
278             break;
279         case IEREUSEADDR:
280             snprintf(errstr, len, "unable to reuse address on socket");
281             perr = 1;
282             break;
283         case IENONBLOCKING:
284             snprintf(errstr, len, "unable to set socket to non-blocking");
285             perr = 1;
286             break;
287         case IESETWINDOWSIZE:
288             snprintf(errstr, len, "unable to set socket window size");
289             perr = 1;
290             break;
291         case IEPROTOCOL:
292             snprintf(errstr, len, "protocol does not exist");
293             break;
294         case IEAFFINITY:
295             snprintf(errstr, len, "unable to set CPU affinity");
296             perr = 1;
297             break;
298 	case IEDAEMON:
299 	    snprintf(errstr, len, "unable to become a daemon");
300 	    perr = 1;
301 	    break;
302         case IECREATESTREAM:
303             snprintf(errstr, len, "unable to create a new stream");
304             herr = 1;
305             perr = 1;
306             break;
307         case IEINITSTREAM:
308             snprintf(errstr, len, "unable to initialize stream");
309             herr = 1;
310             perr = 1;
311             break;
312         case IESTREAMLISTEN:
313             snprintf(errstr, len, "unable to start stream listener");
314             perr = 1;
315             break;
316         case IESTREAMCONNECT:
317             snprintf(errstr, len, "unable to connect stream");
318             herr = 1;
319             perr = 1;
320             break;
321         case IESTREAMACCEPT:
322             snprintf(errstr, len, "unable to accept stream connection");
323             perr = 1;
324             break;
325         case IESTREAMWRITE:
326             snprintf(errstr, len, "unable to write to stream socket");
327             perr = 1;
328             break;
329         case IESTREAMREAD:
330             snprintf(errstr, len, "unable to read from stream socket");
331             perr = 1;
332             break;
333         case IESTREAMCLOSE:
334             snprintf(errstr, len, "stream socket has closed unexpectedly");
335             break;
336         case IESTREAMID:
337             snprintf(errstr, len, "stream has an invalid id");
338             break;
339         case IENEWTIMER:
340             snprintf(errstr, len, "unable to create new timer");
341             perr = 1;
342             break;
343         case IEUPDATETIMER:
344             snprintf(errstr, len, "unable to update timer");
345             perr = 1;
346             break;
347         case IESETCONGESTION:
348             snprintf(errstr, len, "unable to set TCP_CONGESTION: "
349                                   "Supplied congestion control algorithm not supported on this host");
350             break;
351 	case IEPIDFILE:
352             snprintf(errstr, len, "unable to write PID file");
353             perr = 1;
354             break;
355 	case IEV6ONLY:
356 	    snprintf(errstr, len, "Unable to set/reset IPV6_V6ONLY");
357 	    perr = 1;
358 	    break;
359         case IESETSCTPDISABLEFRAG:
360             snprintf(errstr, len, "unable to set SCTP_DISABLE_FRAGMENTS");
361             perr = 1;
362             break;
363         case IESETSCTPNSTREAM:
364             snprintf(errstr, len, "unable to set SCTP_INIT num of SCTP streams\n");
365             perr = 1;
366             break;
367 	case IESETPACING:
368 	    snprintf(errstr, len, "unable to set socket pacing");
369 	    perr = 1;
370 	    break;
371 	case IESETBUF2:
372 	    snprintf(errstr, len, "socket buffer size not set correctly");
373 	    break;
374 
375     }
376 
377     if (herr || perr)
378         strncat(errstr, ": ", len - strlen(errstr) - 1);
379     if (errno && perr)
380         strncat(errstr, strerror(errno), len - strlen(errstr) - 1);
381 
382     return errstr;
383 }
384