2 * Test client to test the NBD server. Doesn't do anything useful, except
3 * checking that the server does, actually, work.
5 * Note that the only 'real' test is to check the client against a kernel. If
6 * it works here but does not work in the kernel, then that's most likely a bug
7 * in this program and/or in nbd-server.
9 * Copyright(c) 2006 Wouter Verhelst
11 * This program is Free Software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the Free
13 * Software Foundation, in version 2.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
20 * You should have received a copy of the GNU General Public License along with
21 * this program; if not, write to the Free Software Foundation, Inc., 51
22 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
29 #include <sys/types.h>
30 #include <sys/socket.h>
35 #define MY_NAME "nbd-tester-client"
38 #include <netinet/in.h>
41 static gchar errstr[1024];
42 const static int errstr_len=1024;
48 CONNECTION_TYPE_CONNECT,
49 CONNECTION_TYPE_INIT_PASSWD,
50 CONNECTION_TYPE_CLISERV,
55 CONNECTION_CLOSE_PROPERLY,
56 CONNECTION_CLOSE_FAST,
59 #define TEST_WRITE (1<<0)
60 #define TEST_FLUSH (1<<1)
62 int timeval_subtract (struct timeval *result, struct timeval *x,
64 if (x->tv_usec < y->tv_usec) {
65 int nsec = (y->tv_usec - x->tv_usec) / 1000000 + 1;
66 y->tv_usec -= 1000000 * nsec;
70 if (x->tv_usec - y->tv_usec > 1000000) {
71 int nsec = (x->tv_usec - y->tv_usec) / 1000000;
72 y->tv_usec += 1000000 * nsec;
76 result->tv_sec = x->tv_sec - y->tv_sec;
77 result->tv_usec = x->tv_usec - y->tv_usec;
79 return x->tv_sec < y->tv_sec;
82 double timeval_diff_to_double (struct timeval * x, struct timeval * y) {
84 timeval_subtract(&r, x, y);
85 return r.tv_sec * 1.0 + r.tv_usec/1000000.0;
88 static inline int read_all(int f, void *buf, size_t len) {
93 if((res=read(f, buf, len)) <=0) {
94 snprintf(errstr, errstr_len, "Read failed: %s", strerror(errno));
104 static inline int write_all(int f, void *buf, size_t len) {
109 if((res=write(f, buf, len)) <=0) {
110 snprintf(errstr, errstr_len, "Write failed: %s", strerror(errno));
120 #define READ_ALL_ERRCHK(f, buf, len, whereto, errmsg...) if((read_all(f, buf, len))<=0) { snprintf(errstr, errstr_len, ##errmsg); goto whereto; }
121 #define READ_ALL_ERR_RT(f, buf, len, whereto, rval, errmsg...) if((read_all(f, buf, len))<=0) { snprintf(errstr, errstr_len, ##errmsg); retval = rval; goto whereto; }
123 #define WRITE_ALL_ERRCHK(f, buf, len, whereto, errmsg...) if((write_all(f, buf, len))<=0) { snprintf(errstr, errstr_len, ##errmsg); goto whereto; }
124 #define WRITE_ALL_ERR_RT(f, buf, len, whereto, rval, errmsg...) if((write_all(f, buf, len))<=0) { snprintf(errstr, errstr_len, ##errmsg); retval = rval; goto whereto; }
126 int setup_connection(gchar *hostname, int port, gchar* name, CONNECTION_TYPE ctype, int* serverflags) {
128 struct hostent *host;
129 struct sockaddr_in addr;
131 uint64_t mymagic = (name ? opts_magic : cliserv_magic);
136 if(ctype<CONNECTION_TYPE_CONNECT)
138 if((sock=socket(PF_INET, SOCK_STREAM, IPPROTO_TCP))<0) {
139 strncpy(errstr, strerror(errno), errstr_len);
143 if(!(host=gethostbyname(hostname))) {
144 strncpy(errstr, strerror(errno), errstr_len);
147 addr.sin_family=AF_INET;
148 addr.sin_port=htons(port);
149 addr.sin_addr.s_addr=*((int *) host->h_addr);
150 if((connect(sock, (struct sockaddr *)&addr, sizeof(addr))<0)) {
151 strncpy(errstr, strerror(errno), errstr_len);
154 if(ctype<CONNECTION_TYPE_INIT_PASSWD)
156 READ_ALL_ERRCHK(sock, buf, strlen(INIT_PASSWD), err_open, "Could not read INIT_PASSWD: %s", strerror(errno));
158 snprintf(errstr, errstr_len, "Server closed connection");
161 if(strncmp(buf, INIT_PASSWD, strlen(INIT_PASSWD))) {
162 snprintf(errstr, errstr_len, "INIT_PASSWD does not match");
165 if(ctype<CONNECTION_TYPE_CLISERV)
167 READ_ALL_ERRCHK(sock, &tmp64, sizeof(tmp64), err_open, "Could not read cliserv_magic: %s", strerror(errno));
169 if(tmp64 != mymagic) {
170 strncpy(errstr, "mymagic does not match", errstr_len);
173 if(ctype<CONNECTION_TYPE_FULL)
176 READ_ALL_ERRCHK(sock, &size, sizeof(size), err_open, "Could not read size: %s", strerror(errno));
178 READ_ALL_ERRCHK(sock, buf, 128, err_open, "Could not read data: %s", strerror(errno));
182 READ_ALL_ERRCHK(sock, buf, sizeof(uint16_t), err_open, "Could not read reserved field: %s", strerror(errno));
184 WRITE_ALL_ERRCHK(sock, &tmp32, sizeof(tmp32), err_open, "Could not write reserved field: %s", strerror(errno));
186 tmp64 = htonll(opts_magic);
187 WRITE_ALL_ERRCHK(sock, &tmp64, sizeof(tmp64), err_open, "Could not write magic: %s", strerror(errno));
189 tmp32 = htonl(NBD_OPT_EXPORT_NAME);
190 WRITE_ALL_ERRCHK(sock, &tmp32, sizeof(tmp32), err_open, "Could not write option: %s", strerror(errno));
191 tmp32 = htonl((uint32_t)strlen(name));
192 WRITE_ALL_ERRCHK(sock, &tmp32, sizeof(tmp32), err_open, "Could not write name length: %s", strerror(errno));
193 WRITE_ALL_ERRCHK(sock, name, strlen(name), err_open, "Could not write name:: %s", strerror(errno));
194 READ_ALL_ERRCHK(sock, &size, sizeof(size), err_open, "Could not read size: %s", strerror(errno));
197 READ_ALL_ERRCHK(sock, &flags, sizeof(uint16_t), err_open, "Could not read flags: %s", strerror(errno));
198 flags = ntohs(flags);
199 *serverflags = flags;
200 g_warning("Server flags are: %08x", flags);
201 READ_ALL_ERRCHK(sock, buf, 124, err_open, "Could not read reserved zeroes: %s", strerror(errno));
211 int close_connection(int sock, CLOSE_TYPE type) {
212 struct nbd_request req;
216 case CONNECTION_CLOSE_PROPERLY:
217 req.magic=htonl(NBD_REQUEST_MAGIC);
218 req.type=htonl(NBD_CMD_DISC);
219 memcpy(&(req.handle), &(counter), sizeof(counter));
223 if(write(sock, &req, sizeof(req))<0) {
224 snprintf(errstr, errstr_len, "Could not write to socket: %s", strerror(errno));
227 case CONNECTION_CLOSE_FAST:
229 snprintf(errstr, errstr_len, "Could not close socket: %s", strerror(errno));
234 g_critical("Your compiler is on crack!"); /* or I am buggy */
240 int read_packet_check_header(int sock, size_t datasize, long long int curhandle) {
241 struct nbd_reply rep;
245 READ_ALL_ERR_RT(sock, &rep, sizeof(rep), end, -1, "Could not read reply header: %s", strerror(errno));
246 rep.magic=ntohl(rep.magic);
247 rep.error=ntohl(rep.error);
248 if(rep.magic!=NBD_REPLY_MAGIC) {
249 snprintf(errstr, errstr_len, "Received package with incorrect reply_magic. Index of sent packages is %lld (0x%llX), received handle is %lld (0x%llX). Received magic 0x%lX, expected 0x%lX", (long long int)curhandle, (long long unsigned int)curhandle, (long long int)*((u64*)rep.handle), (long long unsigned int)*((u64*)rep.handle), (long unsigned int)rep.magic, (long unsigned int)NBD_REPLY_MAGIC);
254 snprintf(errstr, errstr_len, "Received error from server: %ld (0x%lX). Handle is %lld (0x%llX).", (long int)rep.error, (long unsigned int)rep.error, (long long int)(*((u64*)rep.handle)), (long long unsigned int)*((u64*)rep.handle));
259 READ_ALL_ERR_RT(sock, &buf, datasize, end, -1, "Could not read data: %s", strerror(errno));
265 int oversize_test(gchar* hostname, int port, char* name, int sock,
266 char sock_is_open, char close_sock, int testflags) {
268 struct nbd_request req;
269 struct nbd_reply rep;
273 pid_t mypid = getpid();
274 char buf[((1024*1024)+sizeof(struct nbd_request)/2)<<1];
277 /* This should work */
279 if((sock=setup_connection(hostname, port, name, CONNECTION_TYPE_FULL, &serverflags))<0) {
280 g_warning("Could not open socket: %s", errstr);
285 req.magic=htonl(NBD_REQUEST_MAGIC);
286 req.type=htonl(NBD_CMD_READ);
287 req.len=htonl(1024*1024);
288 memcpy(&(req.handle),&i,sizeof(i));
290 WRITE_ALL_ERR_RT(sock, &req, sizeof(req), err, -1, "Could not write request: %s", strerror(errno));
291 printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
292 READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
293 READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
295 snprintf(errstr, errstr_len, "Received unexpected error: %d", rep.error);
301 /* This probably should not work */
302 i++; req.from=htonll(i);
303 req.len = htonl(ntohl(req.len) + sizeof(struct nbd_request) / 2);
304 WRITE_ALL_ERR_RT(sock, &req, sizeof(req), err, -1, "Could not write request: %s", strerror(errno));
305 printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
306 READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
307 READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
309 printf("Received expected error\n");
315 /* ... unless this works, too */
316 i++; req.from=htonll(i);
317 req.len = htonl(ntohl(req.len) << 1);
318 WRITE_ALL_ERR_RT(sock, &req, sizeof(req), err, -1, "Could not write request: %s", strerror(errno));
319 printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
320 READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
321 READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
327 if((rep.error && !got_err) || (!rep.error && got_err)) {
328 printf("Received unexpected error\n");
335 int throughput_test(gchar* hostname, int port, char* name, int sock,
336 char sock_is_open, char close_sock, int testflags) {
340 struct nbd_request req;
344 struct timeval start;
348 char speedchar[2] = { '\0', '\0' };
352 signed int do_write=TRUE;
353 pid_t mypid = getpid();
356 if (!(testflags & TEST_WRITE))
357 testflags &= ~TEST_FLUSH;
359 memset (writebuf, 'X', sizeof(1024));
362 if((sock=setup_connection(hostname, port, name, CONNECTION_TYPE_FULL, &serverflags))<0) {
363 g_warning("Could not open socket: %s", errstr);
368 if ((testflags & TEST_FLUSH) && ((serverflags & (NBD_FLAG_SEND_FLUSH | NBD_FLAG_SEND_FUA))
369 != (NBD_FLAG_SEND_FLUSH | NBD_FLAG_SEND_FUA))) {
370 snprintf(errstr, errstr_len, "Server did not supply flush capability flags");
374 req.magic=htonl(NBD_REQUEST_MAGIC);
376 if(gettimeofday(&start, NULL)<0) {
378 snprintf(errstr, errstr_len, "Could not measure start time: %s", strerror(errno));
381 for(i=0;i+1024<=size;i+=1024) {
383 int sendfua = (testflags & TEST_FLUSH) && ((i & 15) == 3);
384 int sendflush = (testflags & TEST_FLUSH) && ((i & 15) == 11);
385 req.type=htonl((testflags & TEST_WRITE)?NBD_CMD_WRITE:NBD_CMD_READ);
387 req.type = htonl(NBD_CMD_WRITE | NBD_CMD_FLAG_FUA);
388 memcpy(&(req.handle),&i,sizeof(i));
390 if (write_all(sock, &req, sizeof(req)) <0) {
394 if (testflags & TEST_WRITE) {
395 if (write_all(sock, writebuf, 1024) <0) {
400 printf("%d: Requests(+): %d\n", (int)mypid, ++requests);
402 long long int j = i ^ (1LL<<63);
403 req.type = htonl(NBD_CMD_FLUSH);
404 memcpy(&(req.handle),&j,sizeof(j));
406 if (write_all(sock, &req, sizeof(req)) <0) {
410 printf("%d: Requests(+): %d\n", (int)mypid, ++requests);
418 select(sock+1, &set, NULL, NULL, &tv);
419 if(FD_ISSET(sock, &set)) {
420 /* Okay, there's something ready for
422 if(read_packet_check_header(sock, (testflags & TEST_WRITE)?0:1024, i)<0) {
426 printf("%d: Requests(-): %d\n", (int)mypid, --requests);
428 } while FD_ISSET(sock, &set);
429 /* Now wait until we can write again or until a second have
430 * passed, whichever comes first*/
435 do_write=select(sock+1,NULL,&set,NULL,&tv);
436 if(!do_write) printf("Select finished\n");
438 snprintf(errstr, errstr_len, "select: %s", strerror(errno));
443 /* Now empty the read buffer */
449 select(sock+1, &set, NULL, NULL, &tv);
450 if(FD_ISSET(sock, &set)) {
451 /* Okay, there's something ready for
453 read_packet_check_header(sock, (testflags & TEST_WRITE)?0:1024, i);
454 printf("%d: Requests(-): %d\n", (int)mypid, --requests);
457 if(gettimeofday(&stop, NULL)<0) {
459 snprintf(errstr, errstr_len, "Could not measure end time: %s", strerror(errno));
462 timespan=timeval_diff_to_double(&stop, &start);
476 g_message("%d: Throughput %s test complete. Took %.3f seconds to complete, %.3f%sib/s", (int)getpid(), (testflags & TEST_WRITE)?"write":"read", timespan, speed, speedchar);
480 close_connection(sock, CONNECTION_CLOSE_PROPERLY);
486 typedef int (*testfunc)(gchar*, int, char*, int, char, char, int);
488 int main(int argc, char**argv) {
494 bool want_port = TRUE;
497 testfunc test = throughput_test;
500 g_message("%d: Not enough arguments", (int)getpid());
501 g_message("%d: Usage: %s <hostname> <port>", (int)getpid(), argv[0]);
502 g_message("%d: Or: %s <hostname> -N <exportname>", (int)getpid(), argv[0]);
506 while((c=getopt(argc, argv, "-N:owf"))>=0) {
511 hostname=g_strdup(optarg);
516 p=(strtol(argv[2], NULL, 0));
517 if(p==LONG_MIN||p==LONG_MAX) {
518 g_critical("Could not parse port number: %s", strerror(errno));
525 name=g_strdup(optarg);
533 testflags|=TEST_WRITE;
536 testflags|=TEST_FLUSH;
541 if(test(hostname, (int)p, name, sock, FALSE, TRUE, testflags)<0) {
542 g_warning("Could not run test: %s", errstr);