2 * Open connection for network block device
4 * Copyright 1997,1998 Pavel Machek, distribute under GPL
5 * <pavel@atrey.karlin.mff.cuni.cz>
6 * Copyright (c) 2002 - 2011 Wouter Verhelst <w@uter.be>
8 * Version 1.0 - 64bit issues should be fixed, now
9 * Version 1.1 - added bs (blocksize) option (Alexey Guzeev, aga@permonline.ru)
10 * Version 1.2 - I added new option '-d' to send the disconnect request
11 * Version 2.0 - Version synchronised with server
12 * Version 2.1 - Check for disconnection before INIT_PASSWD is received
13 * to make errormsg a bit more helpful in case the server can't
14 * open the exported file.
15 * 16/03/2010 - Add IPv6 support.
16 * Kitt Tientanopajai <kitt@kitty.in.th>
17 * Neutron Soutmun <neo.neutron@gmail.com>
18 * Suriya Soutmun <darksolar@gmail.com>
24 #include <sys/ioctl.h>
25 #include <sys/socket.h>
26 #include <sys/types.h>
28 #include <netinet/tcp.h>
29 #include <netinet/in.h>
31 #include "netdb-compat.h"
36 #include <sys/mount.h>
43 #include <linux/ioctl.h>
44 #define MY_NAME "nbd_client"
51 #define NBDC_DO_LIST 1
53 int check_conn(char* devname
, int do_print
) {
59 if( (p
=strrchr(devname
, '/')) ) {
62 if((p
=strchr(devname
, 'p'))) {
63 /* We can't do checks on partitions. */
66 snprintf(buf
, 256, "/sys/block/%s/pid", devname
);
67 if((fd
=open(buf
, O_RDONLY
))<0) {
74 len
=read(fd
, buf
, 256);
77 if(do_print
) printf("%s\n", buf
);
81 int opennet(char *name
, char* portstr
, int sdp
) {
83 struct addrinfo hints
;
84 struct addrinfo
*ai
= NULL
;
85 struct addrinfo
*rp
= NULL
;
88 memset(&hints
,'\0',sizeof(hints
));
89 hints
.ai_family
= AF_UNSPEC
;
90 hints
.ai_socktype
= SOCK_STREAM
;
91 hints
.ai_flags
= AI_ADDRCONFIG
| AI_NUMERICSERV
;
92 hints
.ai_protocol
= IPPROTO_TCP
;
94 e
= getaddrinfo(name
, portstr
, &hints
, &ai
);
97 fprintf(stderr
, "getaddrinfo failed: %s\n", gai_strerror(e
));
104 if (ai
->ai_family
== AF_INET
)
105 ai
->ai_family
= AF_INET_SDP
;
106 else (ai
->ai_family
== AF_INET6
)
107 ai
->ai_family
= AF_INET6_SDP
;
109 err("Can't do SDP: I was not compiled with SDP support!");
113 for(rp
= ai
; rp
!= NULL
; rp
= rp
->ai_next
) {
114 sock
= socket(rp
->ai_family
, rp
->ai_socktype
, rp
->ai_protocol
);
117 continue; /* error */
119 if(connect(sock
, rp
->ai_addr
, rp
->ai_addrlen
) != -1)
126 err_nonfatal("Socket failed: %m");
136 void ask_list(int sock
) {
142 const int BUF_SIZE
= 1024;
145 magic
= ntohll(opts_magic
);
146 if (write(sock
, &magic
, sizeof(magic
)) < 0)
147 err("Failed/2.2: %m");
149 /* Ask for the list */
150 opt
= htonl(NBD_OPT_LIST
);
151 if(write(sock
, &opt
, sizeof(opt
)) < 0) {
152 err("writing list option failed: %m");
154 /* Send the length (zero) */
156 if(write(sock
, &len
, sizeof(len
)) < 0) {
157 err("writing length failed: %m");
159 /* newline, move away from the "Negotiation:" line */
162 memset(buf
, 0, 1024);
163 if(read(sock
, &magic
, sizeof(magic
)) < 0) {
164 err("Reading magic from server: %m");
166 if(read(sock
, &opt_server
, sizeof(opt_server
)) < 0) {
167 err("Reading option: %m");
169 if(read(sock
, &reptype
, sizeof(reptype
)) <0) {
170 err("Reading reply from server: %m");
172 if(read(sock
, &len
, sizeof(len
)) < 0) {
173 err("Reading length from server: %m");
177 reptype
=ntohl(reptype
);
178 if(magic
!= rep_magic
) {
179 err("Not enough magic from server");
181 if(reptype
& NBD_REP_FLAG_ERROR
) {
183 case NBD_REP_ERR_POLICY
:
184 fprintf(stderr
, "\nE: listing not allowed by server.\n");
187 fprintf(stderr
, "\nE: unexpected error from server.\n");
190 if(len
> 0 && len
< BUF_SIZE
) {
191 if(len
=read(sock
, buf
, len
) < 0) {
192 fprintf(stderr
, "\nE: could not read error message from server\n");
195 fprintf(stderr
, "Server said: %s\n", buf
);
200 if(reptype
!= NBD_REP_SERVER
) {
201 err("Server sent us a reply we don't understand!");
203 if(read(sock
, &len
, sizeof(len
)) < 0) {
204 fprintf(stderr
, "\nE: could not read export name length from server\n");
208 if (len
>= BUF_SIZE
) {
209 fprintf(stderr
, "\nE: export name on server too long\n");
212 if(read(sock
, buf
, len
) < 0) {
213 fprintf(stderr
, "\nE: could not read export name from server\n");
220 } while(reptype
!= NBD_REP_ACK
);
221 opt
=htonl(NBD_OPT_ABORT
);
223 magic
=htonll(opts_magic
);
224 if (write(sock
, &magic
, sizeof(magic
)) < 0)
225 err("Failed/2.2: %m");
226 if (write(sock
, &opt
, sizeof(opt
)) < 0)
227 err("Failed writing abort");
228 if (write(sock
, &len
, sizeof(len
)) < 0)
229 err("Failed writing length");
232 void negotiate(int sock
, u64
*rsize64
, u32
*flags
, char* name
, uint32_t needed_flags
, uint32_t client_flags
, uint32_t do_opts
) {
235 char buf
[256] = "\0\0\0\0\0\0\0\0\0";
237 printf("Negotiation: ");
238 if (read(sock
, buf
, 8) < 0)
241 err("Server closed connection");
242 if (strcmp(buf
, INIT_PASSWD
))
243 err("INIT_PASSWD bad");
245 if (read(sock
, &magic
, sizeof(magic
)) < 0)
247 magic
= ntohll(magic
);
252 if (magic
!= opts_magic
) {
253 if(magic
== cliserv_magic
) {
254 err("It looks like you're trying to connect to an oldstyle server with a named export. This won't work.");
258 if(read(sock
, &tmp
, sizeof(uint16_t)) < 0) {
259 err("Failed reading flags: %m");
261 *flags
= ((u32
)ntohs(tmp
));
262 if((needed_flags
& *flags
) != needed_flags
) {
263 /* There's currently really only one reason why this
264 * check could possibly fail, but we may need to change
265 * this error message in the future... */
266 fprintf(stderr
, "\nE: Server does not support listing exports\n");
270 client_flags
= htonl(client_flags
);
271 if (write(sock
, &client_flags
, sizeof(client_flags
)) < 0)
272 err("Failed/2.1: %m");
274 if(do_opts
& NBDC_DO_LIST
) {
279 /* Write the export name that we're after */
280 magic
= htonll(opts_magic
);
281 if (write(sock
, &magic
, sizeof(magic
)) < 0)
282 err("Failed/2.2: %m");
284 opt
= ntohl(NBD_OPT_EXPORT_NAME
);
285 if (write(sock
, &opt
, sizeof(opt
)) < 0)
286 err("Failed/2.3: %m");
287 namesize
= (u32
)strlen(name
);
288 namesize
= ntohl(namesize
);
289 if (write(sock
, &namesize
, sizeof(namesize
)) < 0)
290 err("Failed/2.4: %m");
291 if (write(sock
, name
, strlen(name
)) < 0)
292 err("Failed/2.4: %m");
294 if (magic
!= cliserv_magic
) {
295 if(magic
!= opts_magic
)
296 err("Not enough cliserv_magic");
298 err("It looks like you're trying to connect to a newstyle server with the oldstyle protocol. Try the -N option.");
303 if (read(sock
, &size64
, sizeof(size64
)) <= 0) {
305 err("Server closed connection");
306 err("Failed/3: %m\n");
308 size64
= ntohll(size64
);
310 if ((size64
>>12) > (uint64_t)~0UL) {
311 printf("size = %luMB", (unsigned long)(size64
>>20));
312 err("Exported device is too big for me. Get 64-bit machine :-(\n");
314 printf("size = %luMB", (unsigned long)(size64
>>20));
317 if (read(sock
, flags
, sizeof(*flags
)) < 0)
318 err("Failed/4: %m\n");
319 *flags
= ntohl(*flags
);
321 if(read(sock
, &tmp
, sizeof(tmp
)) < 0)
322 err("Failed/4: %m\n");
323 *flags
|= (uint32_t)ntohs(tmp
);
326 if (read(sock
, &buf
, 124) < 0)
327 err("Failed/5: %m\n");
333 void setsizes(int nbd
, u64 size64
, int blocksize
, u32 flags
) {
335 int read_only
= (flags
& NBD_FLAG_READ_ONLY
) ? 1 : 0;
337 if (size64
>>12 > (uint64_t)~0UL)
338 err("Device too large.\n");
340 if (ioctl(nbd
, NBD_SET_BLKSIZE
, 4096UL) < 0)
341 err("Ioctl/1.1a failed: %m\n");
342 size
= (unsigned long)(size64
>>12);
343 if (ioctl(nbd
, NBD_SET_SIZE_BLOCKS
, size
) < 0)
344 err("Ioctl/1.1b failed: %m\n");
345 if (ioctl(nbd
, NBD_SET_BLKSIZE
, (unsigned long)blocksize
) < 0)
346 err("Ioctl/1.1c failed: %m\n");
347 fprintf(stderr
, "bs=%d, sz=%llu bytes\n", blocksize
, 4096ULL*size
);
350 ioctl(nbd
, NBD_CLEAR_SOCK
);
352 /* ignore error as kernel may not support */
353 ioctl(nbd
, NBD_SET_FLAGS
, (unsigned long) flags
);
355 if (ioctl(nbd
, BLKROSET
, (unsigned long) &read_only
) < 0)
356 err("Unable to set read-only attribute for device");
359 void set_timeout(int nbd
, int timeout
) {
361 if (ioctl(nbd
, NBD_SET_TIMEOUT
, (unsigned long)timeout
) < 0)
362 err("Ioctl NBD_SET_TIMEOUT failed: %m\n");
363 fprintf(stderr
, "timeout=%d\n", timeout
);
367 void finish_sock(int sock
, int nbd
, int swap
) {
368 if (ioctl(nbd
, NBD_SET_SOCK
, sock
) < 0)
369 err("Ioctl NBD_SET_SOCK failed: %m\n");
372 mlockall(MCL_CURRENT
| MCL_FUTURE
);
376 oom_adjust(const char *file
, const char *value
)
381 fd
= open(file
, O_WRONLY
);
385 rc
= write(fd
, value
, len
) != (ssize_t
) len
;
390 void usage(char* errmsg
, ...) {
394 va_start(ap
, errmsg
);
395 snprintf(tmp
, 256, "ERROR: %s\n\n", errmsg
);
396 vfprintf(stderr
, tmp
, ap
);
399 fprintf(stderr
, "nbd-client version %s\n", PACKAGE_VERSION
);
401 fprintf(stderr
, "Usage: nbd-client host port nbd_device [-block-size|-b block size] [-timeout|-t timeout] [-swap|-s] [-sdp|-S] [-persist|-p] [-nofork|-n] [-systemd-mark|-m]\n");
402 fprintf(stderr
, "Or : nbd-client -name|-N name host [port] nbd_device [-block-size|-b block size] [-timeout|-t timeout] [-swap|-s] [-sdp|-S] [-persist|-p] [-nofork|-n]\n");
403 fprintf(stderr
, "Or : nbd-client -d nbd_device\n");
404 fprintf(stderr
, "Or : nbd-client -c nbd_device\n");
405 fprintf(stderr
, "Or : nbd-client -h|--help\n");
406 fprintf(stderr
, "Or : nbd-client -l|--list host\n");
407 fprintf(stderr
, "Default value for blocksize is 1024 (recommended for ethernet)\n");
408 fprintf(stderr
, "Allowed values for blocksize are 512,1024,2048,4096\n"); /* will be checked in kernel :) */
409 fprintf(stderr
, "Note, that kernel 2.4.2 and older ones do not work correctly with\n");
410 fprintf(stderr
, "blocksizes other than 1024 without patches\n");
411 fprintf(stderr
, "Default value for port with -N is 10809. Note that port must always be numeric\n");
414 void disconnect(char* device
) {
415 int nbd
= open(device
, O_RDWR
);
418 err("Cannot open NBD: %m\nPlease ensure the 'nbd' module is loaded.");
419 printf("disconnect, ");
420 if (ioctl(nbd
, NBD_DISCONNECT
)<0)
421 err("Ioctl failed: %m\n");
423 if (ioctl(nbd
, NBD_CLEAR_SOCK
)<0)
424 err("Ioctl failed: %m\n");
428 int main(int argc
, char *argv
[]) {
438 int G_GNUC_UNUSED nofork
=0; // if -dNOFORK
444 uint32_t needed_flags
=0;
449 struct option long_options
[] = {
450 { "block-size", required_argument
, NULL
, 'b' },
451 { "check", required_argument
, NULL
, 'c' },
452 { "disconnect", required_argument
, NULL
, 'd' },
453 { "help", no_argument
, NULL
, 'h' },
454 { "list", no_argument
, NULL
, 'l' },
455 { "name", required_argument
, NULL
, 'N' },
456 { "nofork", no_argument
, NULL
, 'n' },
457 { "persist", no_argument
, NULL
, 'p' },
458 { "sdp", no_argument
, NULL
, 'S' },
459 { "swap", no_argument
, NULL
, 's' },
460 { "systemd-mark", no_argument
, NULL
, 'm' },
461 { "timeout", required_argument
, NULL
, 't' },
467 while((c
=getopt_long_only(argc
, argv
, "-b:c:d:hlnN:pSst:", long_options
, NULL
))>=0) {
470 // non-option argument
471 if(strchr(optarg
, '=')) {
472 // old-style 'bs=' or 'timeout='
474 fprintf(stderr
, "WARNING: old-style command-line argument encountered. This is deprecated.\n");
475 if(!strncmp(optarg
, "bs=", 3)) {
479 if(!strncmp(optarg
, "timeout=", 8)) {
483 usage("unknown option %s encountered", optarg
);
486 switch(nonspecial
++) {
493 if(!strtol(optarg
, NULL
, 0)) {
494 // not parseable as a number, assume it's the device and we have a name
506 usage("too many non-option arguments specified");
512 blocksize
=(int)strtol(optarg
, NULL
, 0);
515 return check_conn(optarg
, 1);
523 needed_flags
|= NBD_FLAG_FIXED_NEWSTYLE
;
524 cflags
|= NBD_FLAG_C_FIXED_NEWSTYLE
;
525 opts
|= NBDC_DO_LIST
;
528 port
= NBD_DEFAULT_PORT
;
539 port
= NBD_DEFAULT_PORT
;
553 timeout
=strtol(optarg
, NULL
, 0);
556 fprintf(stderr
, "E: option eaten by 42 mice\n");
561 if((!port
&& !name
) || !hostname
|| !nbddev
) {
562 usage("not enough information specified");
566 sock
= opennet(hostname
, port
, sdp
);
570 negotiate(sock
, &size64
, &flags
, name
, needed_flags
, cflags
, opts
);
572 nbd
= open(nbddev
, O_RDWR
);
574 err("Cannot open NBD: %m\nPlease ensure the 'nbd' module is loaded.");
576 setsizes(nbd
, size64
, blocksize
, flags
);
577 set_timeout(nbd
, timeout
);
578 finish_sock(sock
, nbd
, swap
);
580 /* try linux >= 2.6.36 interface first */
581 if (oom_adjust("/proc/self/oom_score_adj", "-1000")) {
582 /* fall back to linux <= 2.6.35 interface */
583 oom_adjust("/proc/self/oom_adj", "-17");
592 err("Cannot detach from terminal");
595 memset(&sa
, 0, sizeof(sa
));
596 sa
.sa_handler
= SIG_IGN
;
597 sigaction(SIGCHLD
, &sa
, NULL
);
603 sigdelset(&block
, SIGKILL
);
604 sigdelset(&block
, SIGTERM
);
605 sigdelset(&block
, SIGPIPE
);
606 sigprocmask(SIG_SETMASK
, &block
, &old
);
609 /* Due to a race, the kernel NBD driver cannot
610 * call for a reread of the partition table
611 * in the handling of the NBD_DO_IT ioctl().
612 * Therefore, this is done in the first open()
613 * of the device. We therefore make sure that
614 * the device is opened at least once after the
615 * connection was made. This has to be done in a
616 * separate process, since the NBD_DO_IT ioctl()
617 * does not return until the NBD device has
620 while(check_conn(nbddev
, 0)) {
623 open(nbddev
, O_RDONLY
);
628 if (ioctl(nbd
, NBD_DO_IT
) < 0) {
630 fprintf(stderr
, "nbd,%d: Kernel call returned: %d", getpid(), error
);
632 /* The user probably did 'nbd-client -d' on us.
640 close(sock
); close(nbd
);
642 fprintf(stderr
, " Reconnecting\n");
643 sock
= opennet(hostname
, port
, sdp
);
648 nbd
= open(nbddev
, O_RDWR
);
650 err("Cannot open NBD: %m");
651 negotiate(sock
, &new_size
, &new_flags
, name
, needed_flags
, cflags
, opts
);
652 if (size64
!= new_size
) {
653 err("Size of the device changed. Bye");
655 setsizes(nbd
, size64
, blocksize
,
658 set_timeout(nbd
, timeout
);
659 finish_sock(sock
,nbd
,swap
);
663 /* We're on 2.4. It's not clearly defined what exactly
664 * happened at this point. Probably best to quit, now
666 fprintf(stderr
, "Kernel call returned.");
671 ioctl(nbd
, NBD_CLEAR_SOCK
);