nbd-tester-client.c

   1 /*
   2  * Test client to test the NBD server. Doesn't do anything useful, except
   3  * checking that the server does, actually, work.
   4  *
   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.
   8  *
   9  * Copyright(c) 2006  Wouter Verhelst
  10  *
  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.
  14  *
  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
  18  * more details.
  19  *
  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
  23  */
  24 #include <stdlib.h>
  25 #include <stdio.h>
  26 #include <stdbool.h>
  27 #include <string.h>
  28 #include <sys/time.h>
  29 #include <sys/types.h>
  30 #include <sys/socket.h>
  31 #include <syslog.h>
  32 #include <unistd.h>
  33 #include "config.h"
  34 #include "lfs.h"
  35 #define MY_NAME "nbd-tester-client"
  36 #include "cliserv.h"
  37
  38 #include <netinet/in.h>
  39 #include <glib.h>
  40
  41 static gchar errstr[1024];
  42 const static int errstr_len=1024;
  43
  44 static uint64_t size;
  45
  46 typedef enum {
  47         CONNECTION_TYPE_NONE,
  48         CONNECTION_TYPE_CONNECT,
  49         CONNECTION_TYPE_INIT_PASSWD,
  50         CONNECTION_TYPE_CLISERV,
  51         CONNECTION_TYPE_FULL,
  52 } CONNECTION_TYPE;
  53
  54 typedef enum {
  55         CONNECTION_CLOSE_PROPERLY,
  56         CONNECTION_CLOSE_FAST,
  57 } CLOSE_TYPE;
  58
  59 static inline int read_all(int f, void *buf, size_t len) {
  60         ssize_t res;
  61         size_t retval=0;
  62
  63         while(len>0) {
  64                 if((res=read(f, buf, len)) <=0) {
  65                         snprintf(errstr, errstr_len, "Read failed: %s", strerror(errno));
  66                         return -1;
  67                 }
  68                 len-=res;
  69                 buf+=res;
  70                 retval+=res;
  71         }
  72         return retval;
  73 }
  74
  75 static inline int write_all(int f, void *buf, size_t len) {
  76         ssize_t res;
  77         size_t retval=0;
  78
  79         while(len>0) {
  80                 if((res=write(f, buf, len)) <=0) {
  81                         snprintf(errstr, errstr_len, "Write failed: %s", strerror(errno));
  82                         return -1;
  83                 }
  84                 len-=res;
  85                 buf+=res;
  86                 retval+=res;
  87         }
  88         return retval;
  89 }
  90
  91 #define READ_ALL_ERRCHK(f, buf, len, whereto, errmsg...) if((read_all(f, buf, len))<=0) { snprintf(errstr, errstr_len, ##errmsg); goto whereto; }
  92 #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; }
  93
  94 #define WRITE_ALL_ERRCHK(f, buf, len, whereto, errmsg...) if((write_all(f, buf, len))<=0) { snprintf(errstr, errstr_len, ##errmsg); goto whereto; }
  95 #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; }
  96
  97 int setup_connection(gchar *hostname, int port, gchar* name, CONNECTION_TYPE ctype) {
  98         int sock;
  99         struct hostent *host;
 100         struct sockaddr_in addr;
 101         char buf[256];
 102         uint64_t mymagic = (name ? opts_magic : cliserv_magic);
 103         u64 tmp64;
 104         uint32_t tmp32 = 0;
 105
 106         sock=0;
 107         if(ctype<CONNECTION_TYPE_CONNECT)
 108                 goto end;
 109         if((sock=socket(PF_INET, SOCK_STREAM, IPPROTO_TCP))<0) {
 110                 strncpy(errstr, strerror(errno), errstr_len);
 111                 goto err;
 112         }
 113         setmysockopt(sock);
 114         if(!(host=gethostbyname(hostname))) {
 115                 strncpy(errstr, strerror(errno), errstr_len);
 116                 goto err_open;
 117         }
 118         addr.sin_family=AF_INET;
 119         addr.sin_port=htons(port);
 120         addr.sin_addr.s_addr=*((int *) host->h_addr);
 121         if((connect(sock, (struct sockaddr *)&addr, sizeof(addr))<0)) {
 122                 strncpy(errstr, strerror(errno), errstr_len);
 123                 goto err_open;
 124         }
 125         if(ctype<CONNECTION_TYPE_INIT_PASSWD)
 126                 goto end;
 127         READ_ALL_ERRCHK(sock, buf, strlen(INIT_PASSWD), err_open, "Could not read INIT_PASSWD: %s", strerror(errno));
 128         if(strlen(buf)==0) {
 129                 snprintf(errstr, errstr_len, "Server closed connection");
 130                 goto err_open;
 131         }
 132         if(strncmp(buf, INIT_PASSWD, strlen(INIT_PASSWD))) {
 133                 snprintf(errstr, errstr_len, "INIT_PASSWD does not match");
 134                 goto err_open;
 135         }
 136         if(ctype<CONNECTION_TYPE_CLISERV)
 137                 goto end;
 138         READ_ALL_ERRCHK(sock, &tmp64, sizeof(tmp64), err_open, "Could not read cliserv_magic: %s", strerror(errno));
 139         tmp64=ntohll(tmp64);
 140         if(tmp64 != mymagic) {
 141                 strncpy(errstr, "mymagic does not match", errstr_len);
 142                 goto err_open;
 143         }
 144         if(ctype<CONNECTION_TYPE_FULL)
 145                 goto end;
 146         if(!name) {
 147                 READ_ALL_ERRCHK(sock, &size, sizeof(size), err_open, "Could not read size: %s", strerror(errno));
 148                 size=ntohll(size);
 149                 READ_ALL_ERRCHK(sock, buf, 128, err_open, "Could not read data: %s", strerror(errno));
 150                 goto end;
 151         }
 152         /* flags */
 153         READ_ALL_ERRCHK(sock, buf, sizeof(uint16_t), err_open, "Could not read reserved field: %s", strerror(errno));
 154         /* reserved field */
 155         WRITE_ALL_ERRCHK(sock, &tmp32, sizeof(tmp32), err_open, "Could not write reserved field: %s", strerror(errno));
 156         /* magic */
 157         tmp64 = htonll(opts_magic);
 158         WRITE_ALL_ERRCHK(sock, &tmp64, sizeof(tmp64), err_open, "Could not write magic: %s", strerror(errno));
 159         /* name */
 160         tmp32 = htonl(NBD_OPT_EXPORT_NAME);
 161         WRITE_ALL_ERRCHK(sock, &tmp32, sizeof(tmp32), err_open, "Could not write option: %s", strerror(errno));
 162         tmp32 = htonl((uint32_t)strlen(name));
 163         WRITE_ALL_ERRCHK(sock, &tmp32, sizeof(tmp32), err_open, "Could not write name length: %s", strerror(errno));
 164         WRITE_ALL_ERRCHK(sock, name, strlen(name), err_open, "Could not write name:: %s", strerror(errno));
 165         READ_ALL_ERRCHK(sock, &size, sizeof(size), err_open, "Could not read size: %s", strerror(errno));
 166         size = ntohll(size);
 167         uint16_t flags;
 168         READ_ALL_ERRCHK(sock, buf, sizeof(uint16_t), err_open, "Could not read flags: %s", strerror(errno));
 169         flags = ntohs(flags);
 170         READ_ALL_ERRCHK(sock, buf, 124, err_open, "Could not read reserved zeroes: %s", strerror(errno));
 171         goto end;
 172 err_open:
 173         close(sock);
 174 err:
 175         sock=-1;
 176 end:
 177         return sock;
 178 }
 179
 180 int close_connection(int sock, CLOSE_TYPE type) {
 181         struct nbd_request req;
 182         u64 counter=0;
 183
 184         switch(type) {
 185                 case CONNECTION_CLOSE_PROPERLY:
 186                         req.magic=htonl(NBD_REQUEST_MAGIC);
 187                         req.type=htonl(NBD_CMD_DISC);
 188                         memcpy(&(req.handle), &(counter), sizeof(counter));
 189                         counter++;
 190                         req.from=0;
 191                         req.len=0;
 192                         if(write(sock, &req, sizeof(req))<0) {
 193                                 snprintf(errstr, errstr_len, "Could not write to socket: %s", strerror(errno));
 194                                 return -1;
 195                         }
 196                 case CONNECTION_CLOSE_FAST:
 197                         if(close(sock)<0) {
 198                                 snprintf(errstr, errstr_len, "Could not close socket: %s", strerror(errno));
 199                                 return -1;
 200                         }
 201                         break;
 202                 default:
 203                         g_critical("Your compiler is on crack!"); /* or I am buggy */
 204                         return -1;
 205         }
 206         return 0;
 207 }
 208
 209 int read_packet_check_header(int sock, size_t datasize, long long int curhandle) {
 210         struct nbd_reply rep;
 211         int retval=0;
 212         char buf[datasize];
 213
 214         READ_ALL_ERR_RT(sock, &rep, sizeof(rep), end, -1, "Could not read reply header: %s", strerror(errno));
 215         rep.magic=ntohl(rep.magic);
 216         rep.error=ntohl(rep.error);
 217         if(rep.magic!=NBD_REPLY_MAGIC) {
 218                 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);
 219                 retval=-1;
 220                 goto end;
 221         }
 222         if(rep.error) {
 223                 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));
 224                 retval=-1;
 225                 goto end;
 226         }
 227         if (datasize)
 228                 READ_ALL_ERR_RT(sock, &buf, datasize, end, -1, "Could not read data: %s", strerror(errno));
 229
 230 end:
 231         return retval;
 232 }
 233
 234 int oversize_test(gchar* hostname, int port, char* name, int sock,
 235                   char sock_is_open, char close_sock, int write) {
 236         int retval=0;
 237         struct nbd_request req;
 238         struct nbd_reply rep;
 239         int request=0;
 240         int i=0;
 241         pid_t mypid = getpid();
 242         char buf[((1024*1024)+sizeof(struct nbd_request)/2)<<1];
 243         bool got_err;
 244
 245         /* This should work */
 246         if(!sock_is_open) {
 247                 if((sock=setup_connection(hostname, port, name, CONNECTION_TYPE_FULL))<0) {
 248                         g_warning("Could not open socket: %s", errstr);
 249                         retval=-1;
 250                         goto err;
 251                 }
 252         }
 253         req.magic=htonl(NBD_REQUEST_MAGIC);
 254         req.type=htonl(NBD_CMD_READ);
 255         req.len=htonl(1024*1024);
 256         memcpy(&(req.handle),&i,sizeof(i));
 257         req.from=htonll(i);
 258         WRITE_ALL_ERR_RT(sock, &req, sizeof(req), err, -1, "Could not write request: %s", strerror(errno));
 259         printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
 260         READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
 261         READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
 262         if(rep.error) {
 263                 snprintf(errstr, errstr_len, "Received unexpected error: %d", rep.error);
 264                 retval=-1;
 265                 goto err;
 266         } else {
 267                 printf("OK\n");
 268         }
 269         /* This probably should not work */
 270         i++; req.from=htonll(i);
 271         req.len = htonl(ntohl(req.len) + sizeof(struct nbd_request) / 2);
 272         WRITE_ALL_ERR_RT(sock, &req, sizeof(req), err, -1, "Could not write request: %s", strerror(errno));
 273         printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
 274         READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
 275         READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
 276         if(rep.error) {
 277                 printf("Received expected error\n");
 278                 got_err=true;
 279         } else {
 280                 printf("OK\n");
 281                 got_err=false;
 282         }
 283         /* ... unless this works, too */
 284         i++; req.from=htonll(i);
 285         req.len = htonl(ntohl(req.len) << 1);
 286         WRITE_ALL_ERR_RT(sock, &req, sizeof(req), err, -1, "Could not write request: %s", strerror(errno));
 287         printf("%d: testing oversized request: %d: ", getpid(), ntohl(req.len));
 288         READ_ALL_ERR_RT(sock, &rep, sizeof(struct nbd_reply), err, -1, "Could not read reply header: %s", strerror(errno));
 289         READ_ALL_ERR_RT(sock, &buf, ntohl(req.len), err, -1, "Could not read data: %s", strerror(errno));
 290         if(rep.error) {
 291                 printf("error\n");
 292         } else {
 293                 printf("OK\n");
 294         }
 295         if((rep.error && !got_err) || (!rep.error && got_err)) {
 296                 printf("Received unexpected error\n");
 297                 retval=-1;
 298         }
 299   err:
 300         return retval;
 301 }
 302
 303 int throughput_test(gchar* hostname, int port, char* name, int sock,
 304                     char sock_is_open, char close_sock, int write) {
 305         long long int i;
 306         char buf[1024];
 307         char writebuf[1024];
 308         struct nbd_request req;
 309         int requests=0;
 310         fd_set set;
 311         struct timeval tv;
 312         struct timeval start;
 313         struct timeval stop;
 314         float timespan;
 315         int speed;
 316         char speedchar[2] = { '\0', '\0' };
 317         int retval=0;
 318         size_t tmp;
 319         signed int do_write=TRUE;
 320         pid_t mypid = getpid();
 321
 322         memset (writebuf, 'X', sizeof(1024));
 323         size=0;
 324         if(!sock_is_open) {
 325                 if((sock=setup_connection(hostname, port, name, CONNECTION_TYPE_FULL))<0) {
 326                         g_warning("Could not open socket: %s", errstr);
 327                         retval=-1;
 328                         goto err;
 329                 }
 330         }
 331         req.magic=htonl(NBD_REQUEST_MAGIC);
 332         req.type=htonl(write?NBD_CMD_WRITE:NBD_CMD_READ);
 333         req.len=htonl(1024);
 334         if(gettimeofday(&start, NULL)<0) {
 335                 retval=-1;
 336                 snprintf(errstr, errstr_len, "Could not measure start time: %s", strerror(errno));
 337                 goto err_open;
 338         }
 339         for(i=0;i+1024<=size;i+=1024) {
 340                 if(do_write) {
 341                         memcpy(&(req.handle),&i,sizeof(i));
 342                         req.from=htonll(i);
 343                         if (write_all(sock, &req, sizeof(req)) <0) {
 344                                 retval=-1;
 345                                 goto err_open;
 346                         }
 347                         if (write) {
 348                                 if (write_all(sock, writebuf, 1024) <0) {
 349                                         retval=-1;
 350                                         goto err_open;
 351                                 }
 352                         }
 353                         printf("%d: Requests(+): %d\n", (int)mypid, ++requests);
 354                 }
 355                 do {
 356                         FD_ZERO(&set);
 357                         FD_SET(sock, &set);
 358                         tv.tv_sec=0;
 359                         tv.tv_usec=0;
 360                         select(sock+1, &set, NULL, NULL, &tv);
 361                         if(FD_ISSET(sock, &set)) {
 362                                 /* Okay, there's something ready for
 363                                  * reading here */
 364                                 if(read_packet_check_header(sock, write?0:1024, i)<0) {
 365                                         retval=-1;
 366                                         goto err_open;
 367                                 }
 368                                 printf("%d: Requests(-): %d\n", (int)mypid, --requests);
 369                         }
 370                 } while FD_ISSET(sock, &set);
 371                 /* Now wait until we can write again or until a second have
 372                  * passed, whichever comes first*/
 373                 FD_ZERO(&set);
 374                 FD_SET(sock, &set);
 375                 tv.tv_sec=1;
 376                 tv.tv_usec=0;
 377                 do_write=select(sock+1,NULL,&set,NULL,&tv);
 378                 if(!do_write) printf("Select finished\n");
 379                 if(do_write<0) {
 380                         snprintf(errstr, errstr_len, "select: %s", strerror(errno));
 381                         retval=-1;
 382                         goto err_open;
 383                 }
 384         }
 385         /* Now empty the read buffer */
 386         do {
 387                 FD_ZERO(&set);
 388                 FD_SET(sock, &set);
 389                 tv.tv_sec=0;
 390                 tv.tv_usec=0;
 391                 select(sock+1, &set, NULL, NULL, &tv);
 392                 if(FD_ISSET(sock, &set)) {
 393                         /* Okay, there's something ready for
 394                          * reading here */
 395                         read_packet_check_header(sock, write?0:1024, i);
 396                         printf("%d: Requests(-): %d\n", (int)mypid, --requests);
 397                 }
 398         } while (requests);
 399         if(gettimeofday(&stop, NULL)<0) {
 400                 retval=-1;
 401                 snprintf(errstr, errstr_len, "Could not measure end time: %s", strerror(errno));
 402                 goto err_open;
 403         }
 404         timespan=(float)(stop.tv_sec-start.tv_sec+(stop.tv_usec-start.tv_usec))/(float)1000000;
 405         speed=(int)(size/timespan);
 406         if(speed>1024) {
 407                 speed>>=10;
 408                 speedchar[0]='K';
 409         }
 410         if(speed>1024) {
 411                 speed>>=10;
 412                 speedchar[0]='M';
 413         }
 414         if(speed>1024) {
 415                 speed>>=10;
 416                 speedchar[0]='G';
 417         }
 418         g_message("%d: Throughput %s test complete. Took %.3f seconds to complete, %d%siB/s", (int)getpid(), write?"write":"read", timespan, speed, speedchar);
 419
 420 err_open:
 421         if(close_sock) {
 422                 close_connection(sock, CONNECTION_CLOSE_PROPERLY);
 423         }
 424 err:
 425         return retval;
 426 }
 427
 428 typedef int (*testfunc)(gchar*, int, char*, int, char, char, int);
 429
 430 int main(int argc, char**argv) {
 431         gchar *hostname;
 432         long int p = 0;
 433         char* name = NULL;
 434         int sock=0;
 435         int c;
 436         bool want_port = TRUE;
 437         int nonopt=0;
 438         int write=0;
 439         testfunc test = throughput_test;
 440
 441         if(argc<3) {
 442                 g_message("%d: Not enough arguments", (int)getpid());
 443                 g_message("%d: Usage: %s <hostname> <port>", (int)getpid(), argv[0]);
 444                 g_message("%d: Or: %s <hostname> -N <exportname>", (int)getpid(), argv[0]);
 445                 exit(EXIT_FAILURE);
 446         }
 447         logging();
 448         while((c=getopt(argc, argv, "-N:ow"))>=0) {
 449                 switch(c) {
 450                         case 1:
 451                                 switch(nonopt) {
 452                                         case 0:
 453                                                 hostname=g_strdup(optarg);
 454                                                 nonopt++;
 455                                                 break;
 456                                         case 1:
 457                                                 if(want_port)
 458                                                 p=(strtol(argv[2], NULL, 0));
 459                                                 if(p==LONG_MIN||p==LONG_MAX) {
 460                                                         g_critical("Could not parse port number: %s", strerror(errno));
 461                                                         exit(EXIT_FAILURE);
 462                                                 }
 463                                                 break;
 464                                 }
 465                                 break;
 466                         case 'N':
 467                                 name=g_strdup(optarg);
 468                                 p = 10809;
 469                                 want_port = false;
 470                                 break;
 471                         case 'o':
 472                                 test=oversize_test;
 473                                 break;
 474                         case 'w':
 475                                 write=1;
 476                                 break;
 477                 }
 478         }
 479
 480         if(test(hostname, (int)p, name, sock, FALSE, TRUE, write)<0) {
 481                 g_warning("Could not run test: %s", errstr);
 482                 exit(EXIT_FAILURE);
 483         }
 484
 485         return 0;
 486 }