1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
|
/* NBD client library in userspace
* Copyright Red Hat
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/* FUSE support. */
#include <config.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <stdint.h>
#include <inttypes.h>
#include <string.h>
#include <getopt.h>
#include <limits.h>
#include <unistd.h>
#include <errno.h>
#include <assert.h>
#include <time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <libnbd.h>
#include "version.h"
#include "nbdfuse.h"
handles nbd = empty_vector;
unsigned connections = 4;
bool readonly;
bool file_mode = false;
struct timespec start_t;
char *filename;
uint64_t size;
bool verbose = false;
static char *mountpoint;
static const char *pidfile;
static char *fuse_options;
static struct fuse *fuse;
static struct fuse_session *fuse_session;
enum mode {
MODE_URI, /* URI */
MODE_COMMAND, /* --command */
MODE_FD, /* --fd */
MODE_SQUARE_BRACKET, /* [ CMD ], same as --socket-activation*/
MODE_SOCKET_ACTIVATION, /* --socket-activation */
MODE_TCP, /* --tcp */
MODE_UNIX, /* --unix */
MODE_VSOCK, /* --vsock */
};
static void __attribute__ ((noreturn))
usage (FILE *fp, int exitcode)
{
fprintf (fp,
"\n"
"Mount NBD server as a virtual file:\n"
"\n"
#ifdef HAVE_LIBXML2
" nbdfuse [-C N|--connections N] [-d] [-o FUSE-OPTION] [-P PIDFILE]\n"
" [-r] [-s] [-v]\n"
" MOUNTPOINT[/FILENAME] URI\n"
"\n"
"Other modes:\n"
"\n"
#endif
" nbdfuse MOUNTPOINT[/FILENAME] [ CMD [ARGS ...] ]\n"
" nbdfuse MOUNTPOINT[/FILENAME] --command CMD [ARGS ...]\n"
" nbdfuse MOUNTPOINT[/FILENAME] --fd N\n"
" nbdfuse MOUNTPOINT[/FILENAME] --tcp HOST PORT\n"
" nbdfuse MOUNTPOINT[/FILENAME] --unix SOCKET\n"
" nbdfuse MOUNTPOINT[/FILENAME] --vsock CID PORT\n"
"\n"
"To unmount:\n"
"\n"
" fusermount3 -u MOUNTPOINT\n"
"\n"
"Other options:\n"
"\n"
" nbdfuse --help\n"
" nbdfuse --fuse-help\n"
" nbdfuse -V|--version\n"
"\n"
"Please read the nbdfuse(1) manual page for full usage.\n"
"\n"
);
exit (exitcode);
}
static void
fuse_help (const char *prog)
{
static struct fuse_operations null_operations;
const char *tmp_argv[] = { prog, "--help", NULL };
fuse_main (2, (char **)tmp_argv, &null_operations, NULL);
exit (EXIT_SUCCESS);
}
static bool
is_directory (const char *path)
{
struct stat statbuf;
if (stat (path, &statbuf) == -1)
return false;
return S_ISDIR (statbuf.st_mode);
}
static bool
is_regular_file (const char *path)
{
struct stat statbuf;
if (stat (path, &statbuf) == -1)
return false;
return S_ISREG (statbuf.st_mode);
}
/* Which modes support multi-conn? We cannot connect multiple times
* to subprocesses (since we'd have to launch multiple subprocesses).
*/
static bool
mode_is_multi_conn_compatible (enum mode mode)
{
switch (mode) {
case MODE_COMMAND:
case MODE_SQUARE_BRACKET:
case MODE_SOCKET_ACTIVATION:
case MODE_FD:
return false;
case MODE_URI:
case MODE_TCP:
case MODE_UNIX:
case MODE_VSOCK:
return true;
default:
abort ();
}
}
static struct nbd_handle *create_and_connect (enum mode mode,
int argc, char **argv);
int
main (int argc, char *argv[])
{
enum mode mode = MODE_URI;
enum {
HELP_OPTION = CHAR_MAX + 1,
FUSE_HELP_OPTION,
LONG_OPTIONS,
SHORT_OPTIONS,
};
/* Note the "+" means we stop processing as soon as we get to the
* first non-option argument (the mountpoint) and then we parse the
* rest of the command line without getopt.
*/
const char *short_options = "+C:do:P:rsvV";
const struct option long_options[] = {
{ "fuse-help", no_argument, NULL, FUSE_HELP_OPTION },
{ "help", no_argument, NULL, HELP_OPTION },
{ "long-options", no_argument, NULL, LONG_OPTIONS },
{ "connections", required_argument, NULL, 'C' },
{ "pidfile", required_argument, NULL, 'P' },
{ "pid-file", required_argument, NULL, 'P' },
{ "readonly", no_argument, NULL, 'r' },
{ "read-only", no_argument, NULL, 'r' },
{ "short-options", no_argument, NULL, SHORT_OPTIONS },
{ "verbose", no_argument, NULL, 'v' },
{ "version", no_argument, NULL, 'V' },
{ NULL }
};
int c, r;
size_t i;
bool singlethread = false;
struct nbd_handle *h;
int64_t ssize;
const char *s;
struct fuse_args fuse_args = FUSE_ARGS_INIT (0, NULL);
struct fuse_loop_config fuse_loop_config;
FILE *fp;
for (;;) {
c = getopt_long (argc, argv, short_options, long_options, NULL);
if (c == -1)
break;
switch (c) {
case HELP_OPTION:
usage (stdout, EXIT_SUCCESS);
case FUSE_HELP_OPTION:
fuse_help (argv[0]);
exit (EXIT_SUCCESS);
case LONG_OPTIONS:
for (i = 0; long_options[i].name != NULL; ++i) {
if (strcmp (long_options[i].name, "long-options") != 0 &&
strcmp (long_options[i].name, "short-options") != 0)
printf ("--%s\n", long_options[i].name);
}
exit (EXIT_SUCCESS);
case SHORT_OPTIONS:
for (i = 0; short_options[i]; ++i) {
if (short_options[i] != ':' && short_options[i] != '+')
printf ("-%c\n", short_options[i]);
}
exit (EXIT_SUCCESS);
case 'C':
if (sscanf (optarg, "%u", &connections) != 1 ||
connections < 1 || connections > 1024) {
fprintf (stderr, "%s: --connections option-argument must be an "
"unsigned integer >= 1\n", argv[0]);
exit (EXIT_FAILURE);
}
break;
case 'o':
fuse_opt_add_opt_escaped (&fuse_options, optarg);
break;
case 'P':
pidfile = optarg;
break;
case 'r':
readonly = true;
break;
case 's':
singlethread = true;
break;
case 'v': case 'd':
verbose = true;
break;
case 'V':
display_version ("nbdfuse");
exit (EXIT_SUCCESS);
default:
usage (stderr, EXIT_FAILURE);
}
}
/* There must be at least 2 parameters (mountpoint and
* URI/--command/etc).
*/
if (argc - optind < 2)
usage (stderr, EXIT_FAILURE);
/* Parse and check the mountpoint. It might be MOUNTPOINT (file),
* MOUNTPOINT (directory), or MOUNTPOINT/FILENAME.
*/
s = argv[optind++];
if (is_regular_file (s)) { /* MOUNTPOINT (file) */
const char *p;
file_mode = true;
mountpoint = strdup (s);
if (mountpoint == NULL) {
strdup_error:
perror ("strdup");
exit (EXIT_FAILURE);
}
p = strrchr (s, '/');
if (!p)
filename = strdup (s);
else {
if (strlen (p+1) == 0) goto mp_error; /* probably can't happen */
filename = strdup (p+1);
}
if (!filename) goto strdup_error;
}
else if (is_directory (s)) { /* MOUNTPOINT/nbd */
mountpoint = strdup (s);
filename = strdup ("nbd");
if (mountpoint == NULL || filename == NULL)
goto strdup_error;
}
else { /* MOUNTPOINT/FILENAME */
const char *p = strrchr (s, '/');
if (p == NULL) {
mp_error:
fprintf (stderr, "%s: %s: "
"mountpoint must be \"directory\" or \"directory/filename\"\n",
argv[0], s);
exit (EXIT_FAILURE);
}
mountpoint = strndup (s, p-s);
if (mountpoint == NULL) goto strdup_error;
if (! is_directory (mountpoint)) goto mp_error;
if (strlen (p+1) == 0) goto mp_error;
filename = strdup (p+1);
if (filename == NULL) goto strdup_error;
}
/* The next parameter is either a URI or a mode switch. */
if (strcmp (argv[optind], "--command") == 0 ||
strcmp (argv[optind], "--cmd") == 0) {
mode = MODE_COMMAND;
optind++;
}
else if (strcmp (argv[optind], "[") == 0) {
mode = MODE_SQUARE_BRACKET;
optind++;
}
else if (strcmp (argv[optind], "--socket-activation") == 0 ||
strcmp (argv[optind], "--systemd-socket-activation") == 0) {
mode = MODE_SOCKET_ACTIVATION;
optind++;
}
else if (strcmp (argv[optind], "--fd") == 0) {
mode = MODE_FD;
optind++;
}
else if (strcmp (argv[optind], "--tcp") == 0) {
mode = MODE_TCP;
optind++;
}
else if (strcmp (argv[optind], "--unix") == 0) {
mode = MODE_UNIX;
optind++;
}
else if (strcmp (argv[optind], "--vsock") == 0) {
mode = MODE_VSOCK;
optind++;
}
/* This is undocumented, but allow either URI or --uri URI. */
else if (strcmp (argv[optind], "--uri") == 0) {
mode = MODE_URI;
optind++;
}
else if (argv[optind][0] == '-') {
fprintf (stderr, "%s: unknown mode: %s\n", argv[0], argv[optind]);
usage (stderr, EXIT_FAILURE);
}
#ifndef HAVE_LIBXML2
if (mode == MODE_URI) {
fprintf (stderr, "%s: URIs are not supported in this build of libnbd\n",
argv[0]);
exit (EXIT_FAILURE);
}
#endif
/* Check there are enough parameters following given the mode. */
switch (mode) {
case MODE_URI:
case MODE_FD:
case MODE_UNIX:
if (argc - optind != 1)
usage (stderr, EXIT_FAILURE);
break;
case MODE_TCP:
case MODE_VSOCK:
if (argc - optind != 2)
usage (stderr, EXIT_FAILURE);
break;
case MODE_COMMAND:
case MODE_SOCKET_ACTIVATION:
if (argc - optind < 1)
usage (stderr, EXIT_FAILURE);
break;
case MODE_SQUARE_BRACKET:
if (argc - optind < 2 || strcmp (argv[argc-1], "]") != 0)
usage (stderr, EXIT_FAILURE);
break;
}
/* At this point we know the command line is valid, and so can start
* opening FUSE and libnbd.
*/
/* Create the libnbd handle and connect to it. */
h = create_and_connect (mode, argc, argv);
if (handles_append (&nbd, h) == -1) {
perror ("realloc");
exit (EXIT_FAILURE);
}
/* If the server supports multi-conn, and we are able to, try to
* open more handles.
*/
if (connections > 1 &&
mode_is_multi_conn_compatible (mode) &&
nbd_can_multi_conn (nbd.ptr[0]) >= 1) {
if (handles_reserve_exactly (&nbd, connections-1) == -1) {
perror ("realloc");
exit (EXIT_FAILURE);
}
for (i = 2; i <= connections; ++i) {
h = create_and_connect (mode, argc, argv);
handles_append (&nbd, h); /* reserved above, so can't fail */
}
}
connections = nbd.len;
if (verbose)
fprintf (stderr, "nbdfuse: connections=%u\n", connections);
ssize = nbd_get_size (nbd.ptr[0]);
if (ssize == -1) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
size = ssize;
/* If the remote NBD server is readonly, then act as if the '-r'
* flag was given on the nbdfuse command line.
*/
if (nbd_is_read_only (nbd.ptr[0]) > 0)
readonly = true;
/* Create the background threads which are used to dispatch NBD
* operations.
*/
start_operations_threads ();
/* This is just used to give an unchanging time when they stat in
* the mountpoint.
*/
clock_gettime (CLOCK_REALTIME, &start_t);
/* Create the FUSE args. */
if (fuse_opt_add_arg (&fuse_args, argv[0]) == -1) {
fuse_opt_error:
perror ("fuse_opt_add_arg");
exit (EXIT_FAILURE);
}
if (fuse_options) {
if (fuse_opt_add_arg (&fuse_args, "-o") == -1 ||
fuse_opt_add_arg (&fuse_args, fuse_options) == -1)
goto fuse_opt_error;
}
/* Create the FUSE mountpoint. */
fuse = fuse_new (&fuse_args,
&nbdfuse_operations, sizeof nbdfuse_operations, NULL);
if (!fuse) {
perror ("fuse_new");
exit (EXIT_FAILURE);
}
fuse_opt_free_args (&fuse_args);
fuse_session = fuse_get_session (fuse);
fuse_set_signal_handlers (fuse_session);
/* After successful fuse_mount we must be careful not to call
* exit(2) in this program until we have unmounted the filesystem
* below.
*/
if (fuse_mount (fuse, mountpoint) == -1) {
perror ("fuse_mount");
exit (EXIT_FAILURE);
}
/* Ready to serve, write pidfile. */
if (pidfile) {
fp = fopen (pidfile, "w");
if (fp) {
fprintf (fp, "%ld", (long)getpid ());
fclose (fp);
}
}
/* Enter the main loop. */
if (!singlethread) {
memset (&fuse_loop_config, 0, sizeof fuse_loop_config);
fuse_loop_config.clone_fd = 0;
fuse_loop_config.max_idle_threads = 10;
r = fuse_loop_mt (fuse, &fuse_loop_config);
}
else {
r = fuse_loop (fuse);
}
if (r < 0) {
errno = -r;
perror ("fuse_loop");
}
else if (r > 0) {
fprintf (stderr, "%s: fuse_loop: fuse loop terminated by signal %d\n",
argv[0], r);
}
/* Close FUSE. */
fuse_remove_signal_handlers (fuse_session);
fuse_unmount (fuse);
fuse_destroy (fuse);
/* Close NBD handle(s). */
for (i = 0; i < nbd.len; ++i)
nbd_close (nbd.ptr[i]);
free (mountpoint);
free (filename);
free (fuse_options);
exit (r == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
}
/* Called from main() above to create an NBD handle and connect to it.
* For multi-conn, this may be called several times.
*/
static struct nbd_handle *
create_and_connect (enum mode mode, int argc, char **argv)
{
int fd;
uint32_t cid, port;
struct nbd_handle *h;
/* Create the libnbd handle. */
h = nbd_create ();
if (h == NULL) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
nbd_set_debug (h, verbose);
/* Allow ?tls-psk-file and ?tls-certificates */
nbd_set_uri_allow_local_file (h, true);
/* Connect to the NBD server synchronously. */
switch (mode) {
case MODE_URI:
if (nbd_connect_uri (h, argv[optind]) == -1) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
break;
case MODE_COMMAND:
if (nbd_connect_command (h, &argv[optind]) == -1) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
break;
case MODE_SQUARE_BRACKET:
/* This is the same as MODE_SOCKET_ACTIVATION but we must eat the
* closing square bracket on the command line.
*/
assert (strcmp (argv[argc-1], "]") == 0); /* checked above */
argv[argc-1] = NULL;
/*FALLTHROUGH*/
case MODE_SOCKET_ACTIVATION:
if (nbd_connect_systemd_socket_activation (h, &argv[optind]) == -1) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
break;
case MODE_FD:
if (sscanf (argv[optind], "%d", &fd) != 1) {
fprintf (stderr, "%s: could not parse file descriptor: %s\n\n",
argv[0], argv[optind]);
exit (EXIT_FAILURE);
}
if (nbd_connect_socket (h, fd) == -1) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
break;
case MODE_TCP:
if (nbd_connect_tcp (h, argv[optind], argv[optind+1]) == -1) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
break;
case MODE_UNIX:
if (nbd_connect_unix (h, argv[optind]) == -1) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
break;
case MODE_VSOCK:
if (sscanf (argv[optind], "%" SCNu32, &cid) != 1) {
fprintf (stderr, "%s: could not parse vsock cid: %s\n\n",
argv[0], argv[optind]);
exit (EXIT_FAILURE);
}
if (sscanf (argv[optind+1], "%" SCNu32, &port) != 1) {
fprintf (stderr, "%s: could not parse vsock port: %s\n\n",
argv[0], argv[optind]);
exit (EXIT_FAILURE);
}
if (nbd_connect_vsock (h, cid, port) == -1) {
fprintf (stderr, "%s\n", nbd_get_error ());
exit (EXIT_FAILURE);
}
break;
}
return h;
}
|