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 static inline int read_all(int f, void *buf, size_t len) {
64 if((res=read(f, buf, len)) <=0) {
65 snprintf(errstr, errstr_len, "Read failed: %s", strerror(errno));
75 #define READ_ALL_ERRCHK(f, buf, len, whereto, errmsg...) if((read_all(f, buf, len))<=0) { snprintf(errstr, errstr_len, ##errmsg); goto whereto; }
76 #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; }
78 int setup_connection(gchar *hostname, int port, gchar* name, CONNECTION_TYPE ctype) {
81 struct sockaddr_in addr;
83 uint64_t mymagic = (name ? opts_magic : cliserv_magic);
88 if(ctype<CONNECTION_TYPE_CONNECT)
90 if((sock=socket(PF_INET, SOCK_STREAM, IPPROTO_TCP))<0) {
91 strncpy(errstr, strerror(errno), errstr_len);
95 if(!(host=gethostbyname(hostname))) {
96 strncpy(errstr, strerror(errno), errstr_len);
99 addr.sin_family=AF_INET;
100 addr.sin_port=htons(port);
101 addr.sin_addr.s_addr=*((int *) host->h_addr);
102 if((connect(sock, (struct sockaddr *)&addr, sizeof(addr))<0)) {
103 strncpy(errstr, strerror(errno), errstr_len);
106 if(ctype<CONNECTION_TYPE_INIT_PASSWD)
108 READ_ALL_ERRCHK(sock, buf, strlen(INIT_PASSWD), err_open, "Could not read INIT_PASSWD: %s", strerror(errno));
110 snprintf(errstr, errstr_len, "Server closed connection");
113 if(strncmp(buf, INIT_PASSWD, strlen(INIT_PASSWD))) {
114 snprintf(errstr, errstr_len, "INIT_PASSWD does not match");
117 if(ctype<CONNECTION_TYPE_CLISERV)
119 READ_ALL_ERRCHK(sock, &tmp64, sizeof(tmp64), err_open, "Could not read cliserv_magic: %s", strerror(errno));
121 if(tmp64 != mymagic) {
122 strncpy(errstr, "mymagic does not match", errstr_len);
125 if(ctype<CONNECTION_TYPE_FULL)
128 READ_ALL_ERRCHK(sock, &size, sizeof(size), err_open, "Could not read size: %s", strerror(errno));
130 READ_ALL_ERRCHK(sock, buf, 128, err_open, "Could not read data: %s", strerror(errno));
134 READ_ALL_ERRCHK(sock, buf, sizeof(uint16_t), err_open, "Could not read flags: %s", strerror(errno));
136 write(sock, &tmp32, sizeof(tmp32));
138 tmp64 = htonll(opts_magic);
139 write(sock, &tmp64, sizeof(tmp64));
141 tmp32 = htonl(NBD_OPT_EXPORT_NAME);
142 write(sock, &tmp32, sizeof(tmp32));
143 tmp32 = htonl((uint32_t)strlen(name));
144 write(sock, &tmp32, sizeof(tmp32));
145 write(sock, name, strlen(name));
146 READ_ALL_ERRCHK(sock, &size, sizeof(size), err_open, "Could not read size: %s", strerror(errno));
148 READ_ALL_ERRCHK(sock, buf, sizeof(uint16_t)+124, err_open, "Could not read reserved zeroes: %s", strerror(errno));
158 int close_connection(int sock, CLOSE_TYPE type) {
159 struct nbd_request req;
163 case CONNECTION_CLOSE_PROPERLY:
164 req.magic=htonl(NBD_REQUEST_MAGIC);
165 req.type=htonl(NBD_CMD_DISC);
166 memcpy(&(req.handle), &(counter), sizeof(counter));
170 if(write(sock, &req, sizeof(req))<0) {
171 snprintf(errstr, errstr_len, "Could not write to socket: %s", strerror(errno));
174 case CONNECTION_CLOSE_FAST:
176 snprintf(errstr, errstr_len, "Could not close socket: %s", strerror(errno));
181 g_critical("Your compiler is on crack!"); /* or I am buggy */
187 int read_packet_check_header(int sock, size_t datasize, long long int curhandle) {
188 struct nbd_reply rep;
192 READ_ALL_ERR_RT(sock, &rep, sizeof(rep), end, -1, "Could not read reply header: %s", strerror(errno));
193 rep.magic=ntohl(rep.magic);
194 rep.error=ntohl(rep.error);
195 if(rep.magic!=NBD_REPLY_MAGIC) {
196 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", curhandle, curhandle, *((u64*)rep.handle), *((u64*)rep.handle), (long unsigned int)rep.magic, (long unsigned int)NBD_REPLY_MAGIC);
201 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)), *((u64*)rep.handle));
205 READ_ALL_ERR_RT(sock, &buf, datasize, end, -1, "Could not read data: %s", strerror(errno));
211 int oversize_test(gchar* hostname, int port, char* name, int sock, char sock_is_open, char close_sock) {
213 struct nbd_request req;
214 struct nbd_reply rep;
217 pid_t mypid = getpid();
218 char buf[((1024*1024)+sizeof(struct nbd_request)/2)<<1];
221 /* This should work */
223 if((sock=setup_connection(hostname, port, name, CONNECTION_TYPE_FULL))<0) {
224 g_warning("Could not open socket: %s", errstr);
229 req.magic=htonl(NBD_REQUEST_MAGIC);
230 req.type=htonl(NBD_CMD_READ);
231 req.len=htonl(1024*1024);
232 memcpy(&(req.handle),&i,sizeof(i));
234 write(sock, &req, sizeof(req));
235 printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
236 READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
237 READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
239 snprintf(errstr, errstr_len, "Received unexpected error: %d", rep.error);
245 /* This probably should not work */
246 i++; req.from=htonll(i);
247 req.len = htonl(ntohl(req.len) + sizeof(struct nbd_request) / 2);
248 write(sock, &req, sizeof(req));
249 printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
250 READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
251 READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
253 printf("Received expected error\n");
259 /* ... unless this works, too */
260 i++; req.from=htonll(i);
261 req.len = htonl(ntohl(req.len) << 1);
262 write(sock, &req, sizeof(req));
263 printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
264 READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
265 READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
271 if((rep.error && !got_err) || (!rep.error && got_err)) {
272 printf("Received unexpected error\n");
279 int throughput_test(gchar* hostname, int port, char* name, int sock, char sock_is_open, char close_sock) {
282 struct nbd_request req;
286 struct timeval start;
290 char speedchar[2] = { '\0', '\0' };
293 signed int do_write=TRUE;
294 pid_t mypid = getpid();
298 if((sock=setup_connection(hostname, port, name, CONNECTION_TYPE_FULL))<0) {
299 g_warning("Could not open socket: %s", errstr);
304 req.magic=htonl(NBD_REQUEST_MAGIC);
305 req.type=htonl(NBD_CMD_READ);
307 if(gettimeofday(&start, NULL)<0) {
309 snprintf(errstr, errstr_len, "Could not measure start time: %s", strerror(errno));
312 for(i=0;i+1024<=size;i+=1024) {
314 memcpy(&(req.handle),&i,sizeof(i));
316 write(sock, &req, sizeof(req));
317 printf("%d: Requests(+): %d\n", (int)mypid, ++requests);
324 select(sock+1, &set, NULL, NULL, &tv);
325 if(FD_ISSET(sock, &set)) {
326 /* Okay, there's something ready for
328 if(read_packet_check_header(sock, 1024, i)<0) {
332 printf("%d: Requests(-): %d\n", (int)mypid, --requests);
334 } while FD_ISSET(sock, &set);
335 /* Now wait until we can write again or until a second have
336 * passed, whichever comes first*/
341 do_write=select(sock+1,NULL,&set,NULL,&tv);
342 if(!do_write) printf("Select finished\n");
344 snprintf(errstr, errstr_len, "select: %s", strerror(errno));
349 /* Now empty the read buffer */
355 select(sock+1, &set, NULL, NULL, &tv);
356 if(FD_ISSET(sock, &set)) {
357 /* Okay, there's something ready for
359 read_packet_check_header(sock, 1024, i);
360 printf("%d: Requests(-): %d\n", (int)mypid, --requests);
363 if(gettimeofday(&stop, NULL)<0) {
365 snprintf(errstr, errstr_len, "Could not measure end time: %s", strerror(errno));
368 timespan=(float)(stop.tv_sec-start.tv_sec+(stop.tv_usec-start.tv_usec))/(float)1000000;
369 speed=(int)(size/timespan);
382 g_message("%d: Throughput test complete. Took %.3f seconds to complete, %d%siB/s", (int)getpid(), timespan,speed,speedchar);
386 close_connection(sock, CONNECTION_CLOSE_PROPERLY);
392 typedef int (*testfunc)(gchar*, int, char*, int, char, char);
394 int main(int argc, char**argv) {
400 bool want_port = TRUE;
402 testfunc test = throughput_test;
405 g_message("%d: Not enough arguments", (int)getpid());
406 g_message("%d: Usage: %s <hostname> <port>", (int)getpid(), argv[0]);
407 g_message("%d: Or: %s <hostname> -N <exportname>", (int)getpid(), argv[0]);
411 while((c=getopt(argc, argv, "-N:o"))>=0) {
416 hostname=g_strdup(optarg);
421 p=(strtol(argv[2], NULL, 0));
422 if(p==LONG_MIN||p==LONG_MAX) {
423 g_critical("Could not parse port number: %s", strerror(errno));
430 name=g_strdup(optarg);
440 if(test(hostname, (int)p, name, sock, FALSE, TRUE)<0) {
441 g_warning("Could not run test: %s", errstr);