2 * Network Block Device - server
4 * Copyright 1996-1998 Pavel Machek, distribute under GPL
5 * <pavel@atrey.karlin.mff.cuni.cz>
6 * Copyright 2001-2004 Wouter Verhelst <wouter@debian.org>
7 * Copyright 2002 Anton Altaparmakov <aia21@cam.ac.uk>
9 * Version 1.0 - hopefully 64-bit-clean
10 * Version 1.1 - merging enhancements from Josh Parsons, <josh@coombs.anu.edu.au>
11 * Version 1.2 - autodetect size of block devices, thanx to Peter T. Breuer" <ptb@it.uc3m.es>
12 * Version 1.5 - can compile on Unix systems that don't have 64 bit integer
13 * type, or don't have 64 bit file offsets by defining FS_32BIT
14 * in compile options for nbd-server *only*. This can be done
15 * with make FSCHOICE=-DFS_32BIT nbd-server. (I don't have the
16 * original autoconf input file, or I would make it a configure
17 * option.) Ken Yap <ken@nlc.net.au>.
18 * Version 1.6 - fix autodetection of block device size and really make 64 bit
19 * clean on 32 bit machines. Anton Altaparmakov <aia21@cam.ac.uk>
20 * Version 2.0 - Version synchronised with client
21 * Version 2.1 - Reap zombie client processes when they exit. Removed
22 * (uncommented) the _IO magic, it's no longer necessary. Wouter
23 * Verhelst <wouter@debian.org>
24 * Version 2.2 - Auto switch to read-only mode (usefull for floppies).
25 * Version 2.3 - Fixed code so that Large File Support works. This
26 * removes the FS_32BIT compile-time directive; define
27 * _FILE_OFFSET_BITS=64 and _LARGEFILE_SOURCE if you used to be
28 * using FS_32BIT. This will allow you to use files >2GB instead of
29 * having to use the -m option. Wouter Verhelst <wouter@debian.org>
30 * Version 2.4 - Added code to keep track of children, so that we can
31 * properly kill them from initscripts. Add a call to daemon(),
32 * so that processes don't think they have to wait for us, which is
33 * interesting for initscripts as well. Wouter Verhelst
35 * Version 2.5 - Bugfix release: forgot to reset child_arraysize to
36 * zero after fork()ing, resulting in nbd-server going berserk
37 * when it receives a signal with at least one child open. Wouter
38 * Verhelst <wouter@debian.org>
39 * 10/10/2003 - Added socket option SO_KEEPALIVE (sf.net bug 819235);
40 * rectified type of mainloop::size_host (sf.net bugs 814435 and
41 * 817385); close the PID file after writing to it, so that the
42 * daemon can actually be found. Wouter Verhelst
44 * 10/10/2003 - Size of the data "size_host" was wrong and so was not
45 * correctly put in network endianness. Many types were corrected
46 * (size_t and off_t instead of int). <vspaceg@sourceforge.net>
47 * Version 2.6 - Some code cleanup.
48 * Version 2.7 - Better build system.
49 * 11/02/2004 - Doxygenified the source, modularized it a bit. Needs a
50 * lot more work, but this is a start. Wouter Verhelst
52 * 16/03/2010 - Add IPv6 support.
53 * Kitt Tientanopajai <kitt@kitty.in.th>
54 * Neutron Soutmun <neo.neutron@gmail.com>
55 * Suriya Soutmun <darksolar@gmail.com>
58 /* Includes LFS defines, which defines behaviours of some of the following
59 * headers, so must come before those */
62 #include <sys/types.h>
63 #include <sys/socket.h>
65 #include <sys/select.h> /* select */
66 #include <sys/wait.h> /* wait */
67 #ifdef HAVE_SYS_IOCTL_H
68 #include <sys/ioctl.h>
70 #include <sys/param.h>
71 #ifdef HAVE_SYS_MOUNT_H
72 #include <sys/mount.h> /* For BLKGETSIZE */
74 #include <signal.h> /* sigaction */
76 #include <netinet/tcp.h>
77 #include <netinet/in.h>
85 #include <arpa/inet.h>
95 /* used in cliserv.h, so must come first */
96 #define MY_NAME "nbd_server"
100 #include <sdp_inet.h>
103 /** Default position of the config file */
105 #define SYSCONFDIR "/etc"
107 #define CFILE SYSCONFDIR "/nbd-server/config"
109 /** Where our config file actually is */
110 gchar* config_file_pos;
112 /** What user we're running as */
114 /** What group we're running as */
115 gchar* rungroup=NULL;
116 /** whether to export using the old negotiation protocol (port-based) */
117 gboolean do_oldstyle=FALSE;
119 /* Whether we should avoid forking */
122 /** Logging macros, now nothing goes to syslog unless you say ISSERVER */
124 #define msg2(a,b) syslog(a,b)
125 #define msg3(a,b,c) syslog(a,b,c)
126 #define msg4(a,b,c,d) syslog(a,b,c,d)
128 #define msg2(a,b) g_message(b)
129 #define msg3(a,b,c) g_message(b,c)
130 #define msg4(a,b,c,d) g_message(b,c,d)
133 /* Debugging macros */
136 #define DEBUG( a ) printf( a )
137 #define DEBUG2( a,b ) printf( a,b )
138 #define DEBUG3( a,b,c ) printf( a,b,c )
139 #define DEBUG4( a,b,c,d ) printf( a,b,c,d )
140 #define DEBUG5( a,b,c,d,e ) printf( a,b,c,d,e )
143 #define DEBUG2( a,b )
144 #define DEBUG3( a,b,c )
145 #define DEBUG4( a,b,c,d )
146 #define DEBUG5( a,b,c,d,e )
148 #ifndef PACKAGE_VERSION
149 #define PACKAGE_VERSION ""
152 * The highest value a variable of type off_t can reach. This is a signed
153 * integer, so set all bits except for the leftmost one.
155 #define OFFT_MAX ~((off_t)1<<(sizeof(off_t)*8-1))
156 #define LINELEN 256 /**< Size of static buffer used to read the
157 authorization file (yuck) */
158 #define BUFSIZE ((1024*1024)+sizeof(struct nbd_reply)) /**< Size of buffer that can hold requests */
159 #define DIFFPAGESIZE 4096 /**< diff file uses those chunks */
160 #define F_READONLY 1 /**< flag to tell us a file is readonly */
161 #define F_MULTIFILE 2 /**< flag to tell us a file is exported using -m */
162 #define F_COPYONWRITE 4 /**< flag to tell us a file is exported using
164 #define F_AUTOREADONLY 8 /**< flag to tell us a file is set to autoreadonly */
165 #define F_SPARSE 16 /**< flag to tell us copyronwrite should use a sparse file */
166 #define F_SDP 32 /**< flag to tell us the export should be done using the Socket Direct Protocol for RDMA */
167 #define F_SYNC 64 /**< Whether to fsync() after a write */
168 #define F_FLUSH 128 /**< Whether server wants FLUSH to be sent by the client */
169 #define F_FUA 256 /**< Whether server wants FUA to be sent by the client */
170 #define F_ROTATIONAL 512 /**< Whether server wants the client to implement the elevator algorithm */
171 GHashTable *children;
172 char pidfname[256]; /**< name of our PID file */
173 char pidftemplate[256]; /**< template to be used for the filename of the PID file */
174 char default_authname[] = SYSCONFDIR "/nbd-server/allow"; /**< default name of allow file */
176 int modernsock=0; /**< Socket for the modern handler. Not used
177 if a client was only specified on the
178 command line; only port used if
179 oldstyle is set to false (and then the
180 command-line client isn't used, gna gna) */
181 char* modern_listen; /**< listenaddr value for modernsock */
184 * Types of virtuatlization
187 VIRT_NONE=0, /**< No virtualization */
188 VIRT_IPLIT, /**< Literal IP address as part of the filename */
189 VIRT_IPHASH, /**< Replacing all dots in an ip address by a / before
190 doing the same as in IPLIT */
191 VIRT_CIDR, /**< Every subnet in its own directory */
195 * Variables associated with a server.
198 gchar* exportname; /**< (unprocessed) filename of the file we're exporting */
199 off_t expected_size; /**< size of the exported file as it was told to
200 us through configuration */
201 gchar* listenaddr; /**< The IP address we're listening on */
202 unsigned int port; /**< port we're exporting this file at */
203 char* authname; /**< filename of the authorization file */
204 int flags; /**< flags associated with this exported file */
205 int socket; /**< The socket of this server. */
206 int socket_family; /**< family of the socket */
207 VIRT_STYLE virtstyle;/**< The style of virtualization, if any */
208 uint8_t cidrlen; /**< The length of the mask when we use
209 CIDR-style virtualization */
210 gchar* prerun; /**< command to be ran after connecting a client,
211 but before starting to serve */
212 gchar* postrun; /**< command that will be ran after the client
214 gchar* servename; /**< name of the export as selected by nbd-client */
215 int max_connections; /**< maximum number of opened connections */
219 * Variables associated with a client socket.
222 int fhandle; /**< file descriptor */
223 off_t startoff; /**< starting offset of this file */
227 off_t exportsize; /**< size of the file we're exporting */
228 char *clientname; /**< peer */
229 char *exportname; /**< (processed) filename of the file we're exporting */
230 GArray *export; /**< array of FILE_INFO of exported files;
231 array size is always 1 unless we're
232 doing the multiple file option */
233 int net; /**< The actual client socket */
234 SERVER *server; /**< The server this client is getting data from */
235 char* difffilename; /**< filename of the copy-on-write file, if any */
236 int difffile; /**< filedescriptor of copyonwrite file. @todo
237 shouldn't this be an array too? (cfr export) Or
238 make -m and -c mutually exclusive */
239 u32 difffilelen; /**< number of pages in difffile */
240 u32 *difmap; /**< see comment on the global difmap for this one */
241 gboolean modern; /**< client was negotiated using modern negotiation protocol */
245 * Type of configuration file values
248 PARAM_INT, /**< This parameter is an integer */
249 PARAM_STRING, /**< This parameter is a string */
250 PARAM_BOOL, /**< This parameter is a boolean */
254 * Configuration file values
257 gchar *paramname; /**< Name of the parameter, as it appears in
259 gboolean required; /**< Whether this is a required (as opposed to
260 optional) parameter */
261 PARAM_TYPE ptype; /**< Type of the parameter. */
262 gpointer target; /**< Pointer to where the data of this
263 parameter should be written. If ptype is
264 PARAM_BOOL, the data is or'ed rather than
266 gint flagval; /**< Flag mask for this parameter in case ptype
271 * Check whether a client is allowed to connect. Works with an authorization
272 * file which contains one line per machine, no wildcards.
274 * @param opts The client who's trying to connect.
275 * @return 0 - authorization refused, 1 - OK
277 int authorized_client(CLIENT *opts) {
278 const char *ERRMSG="Invalid entry '%s' in authfile '%s', so, refusing all connections.";
283 struct in_addr client;
284 struct in_addr cltemp;
287 if ((f=fopen(opts->server->authname,"r"))==NULL) {
288 msg4(LOG_INFO,"Can't open authorization file %s (%s).",
289 opts->server->authname,strerror(errno)) ;
293 inet_aton(opts->clientname, &client);
294 while (fgets(line,LINELEN,f)!=NULL) {
295 if((tmp=index(line, '/'))) {
296 if(strlen(line)<=tmp-line) {
297 msg4(LOG_CRIT, ERRMSG, line, opts->server->authname);
301 if(!inet_aton(line,&addr)) {
302 msg4(LOG_CRIT, ERRMSG, line, opts->server->authname);
305 len=strtol(tmp, NULL, 0);
306 addr.s_addr>>=32-len;
307 addr.s_addr<<=32-len;
308 memcpy(&cltemp,&client,sizeof(client));
309 cltemp.s_addr>>=32-len;
310 cltemp.s_addr<<=32-len;
311 if(addr.s_addr == cltemp.s_addr) {
315 if (strncmp(line,opts->clientname,strlen(opts->clientname))==0) {
325 * Read data from a file descriptor into a buffer
327 * @param f a file descriptor
328 * @param buf a buffer
329 * @param len the number of bytes to be read
331 static inline void readit(int f, void *buf, size_t len) {
335 if ((res = read(f, buf, len)) <= 0) {
336 if(errno != EAGAIN) {
337 err("Read failed: %m");
347 * Write data from a buffer into a filedescriptor
349 * @param f a file descriptor
350 * @param buf a buffer containing data
351 * @param len the number of bytes to be written
353 static inline void writeit(int f, void *buf, size_t len) {
357 if ((res = write(f, buf, len)) <= 0)
358 err("Send failed: %m");
365 * Print out a message about how to use nbd-server. Split out to a separate
366 * function so that we can call it from multiple places
369 printf("This is nbd-server version " VERSION "\n");
370 printf("Usage: [ip:|ip6@]port file_to_export [size][kKmM] [-l authorize_file] [-r] [-m] [-c] [-C configuration file] [-p PID file name] [-o section name] [-M max connections]\n"
371 "\t-r|--read-only\t\tread only\n"
372 "\t-m|--multi-file\t\tmultiple file\n"
373 "\t-c|--copy-on-write\tcopy on write\n"
374 "\t-C|--config-file\tspecify an alternate configuration file\n"
375 "\t-l|--authorize-file\tfile with list of hosts that are allowed to\n\t\t\t\tconnect.\n"
376 "\t-p|--pid-file\t\tspecify a filename to write our PID to\n"
377 "\t-o|--output-config\toutput a config file section for what you\n\t\t\t\tspecified on the command line, with the\n\t\t\t\tspecified section name\n"
378 "\t-M|--max-connections\tspecify the maximum number of opened connections\n\n"
379 "\tif port is set to 0, stdin is used (for running from inetd)\n"
380 "\tif file_to_export contains '%%s', it is substituted with the IP\n"
381 "\t\taddress of the machine trying to connect\n"
382 "\tif ip is set, it contains the local IP address on which we're listening.\n\tif not, the server will listen on all local IP addresses\n");
383 printf("Using configuration file %s\n", CFILE);
386 /* Dumps a config file section of the given SERVER*, and exits. */
387 void dump_section(SERVER* serve, gchar* section_header) {
388 printf("[%s]\n", section_header);
389 printf("\texportname = %s\n", serve->exportname);
390 printf("\tlistenaddr = %s\n", serve->listenaddr);
391 printf("\tport = %d\n", serve->port);
392 if(serve->flags & F_READONLY) {
393 printf("\treadonly = true\n");
395 if(serve->flags & F_MULTIFILE) {
396 printf("\tmultifile = true\n");
398 if(serve->flags & F_COPYONWRITE) {
399 printf("\tcopyonwrite = true\n");
401 if(serve->expected_size) {
402 printf("\tfilesize = %lld\n", (long long int)serve->expected_size);
404 if(serve->authname) {
405 printf("\tauthfile = %s\n", serve->authname);
411 * Parse the command line.
413 * @param argc the argc argument to main()
414 * @param argv the argv argument to main()
416 SERVER* cmdline(int argc, char *argv[]) {
420 struct option long_options[] = {
421 {"read-only", no_argument, NULL, 'r'},
422 {"multi-file", no_argument, NULL, 'm'},
423 {"copy-on-write", no_argument, NULL, 'c'},
424 {"dont-fork", no_argument, NULL, 'd'},
425 {"authorize-file", required_argument, NULL, 'l'},
426 {"config-file", required_argument, NULL, 'C'},
427 {"pid-file", required_argument, NULL, 'p'},
428 {"output-config", required_argument, NULL, 'o'},
429 {"max-connection", required_argument, NULL, 'M'},
436 gboolean do_output=FALSE;
437 gchar* section_header="";
443 serve=g_new0(SERVER, 1);
444 serve->authname = g_strdup(default_authname);
445 serve->virtstyle=VIRT_IPLIT;
446 while((c=getopt_long(argc, argv, "-C:cdl:mo:rp:M:", long_options, &i))>=0) {
449 /* non-option argument */
450 switch(nonspecial++) {
452 if(strchr(optarg, ':') == strrchr(optarg, ':')) {
453 addr_port=g_strsplit(optarg, ":", 2);
455 /* Check for "@" - maybe user using this separator
458 g_strfreev(addr_port);
459 addr_port=g_strsplit(optarg, "@", 2);
462 addr_port=g_strsplit(optarg, "@", 2);
466 serve->port=strtol(addr_port[1], NULL, 0);
467 serve->listenaddr=g_strdup(addr_port[0]);
469 serve->listenaddr=NULL;
470 serve->port=strtol(addr_port[0], NULL, 0);
472 g_strfreev(addr_port);
475 serve->exportname = g_strdup(optarg);
476 if(serve->exportname[0] != '/') {
477 fprintf(stderr, "E: The to be exported file needs to be an absolute filename!\n");
482 last=strlen(optarg)-1;
484 if (suffix == 'k' || suffix == 'K' ||
485 suffix == 'm' || suffix == 'M')
487 es = (off_t)atoll(optarg);
495 serve->expected_size = es;
500 serve->flags |= F_READONLY;
503 serve->flags |= F_MULTIFILE;
507 section_header = g_strdup(optarg);
510 strncpy(pidftemplate, optarg, 256);
513 serve->flags |=F_COPYONWRITE;
519 g_free(config_file_pos);
520 config_file_pos=g_strdup(optarg);
523 g_free(serve->authname);
524 serve->authname=g_strdup(optarg);
527 serve->max_connections = strtol(optarg, NULL, 0);
535 /* What's left: the port to export, the name of the to be exported
536 * file, and, optionally, the size of the file, in that order. */
545 g_critical("Need a complete configuration on the command line to output a config file section!");
548 dump_section(serve, section_header);
554 * Error codes for config file parsing
557 CFILE_NOTFOUND, /**< The configuration file is not found */
558 CFILE_MISSING_GENERIC, /**< The (required) group "generic" is missing */
559 CFILE_KEY_MISSING, /**< A (required) key is missing */
560 CFILE_VALUE_INVALID, /**< A value is syntactically invalid */
561 CFILE_VALUE_UNSUPPORTED,/**< A value is not supported in this build */
562 CFILE_PROGERR, /**< Programmer error */
563 CFILE_NO_EXPORTS, /**< A config file was specified that does not
564 define any exports */
565 CFILE_INCORRECT_PORT, /**< The reserved port was specified for an
570 * Remove a SERVER from memory. Used from the hash table
572 void remove_server(gpointer s) {
576 g_free(server->exportname);
578 g_free(server->authname);
579 if(server->listenaddr)
580 g_free(server->listenaddr);
582 g_free(server->prerun);
584 g_free(server->postrun);
590 * @param s the old server we want to duplicate
591 * @return new duplicated server
593 SERVER* dup_serve(SERVER *s) {
594 SERVER *serve = NULL;
596 serve=g_new0(SERVER, 1);
601 serve->exportname = g_strdup(s->exportname);
603 serve->expected_size = s->expected_size;
606 serve->listenaddr = g_strdup(s->listenaddr);
608 serve->port = s->port;
611 serve->authname = strdup(s->authname);
613 serve->flags = s->flags;
614 serve->socket = s->socket;
615 serve->socket_family = s->socket_family;
616 serve->virtstyle = s->virtstyle;
617 serve->cidrlen = s->cidrlen;
620 serve->prerun = g_strdup(s->prerun);
623 serve->postrun = g_strdup(s->postrun);
626 serve->servename = g_strdup(s->servename);
628 serve->max_connections = s->max_connections;
634 * append new server to array
636 * @param a server array
637 * @return 0 success, -1 error
639 int append_serve(SERVER *s, GArray *a) {
641 struct addrinfo hints;
642 struct addrinfo *ai = NULL;
643 struct addrinfo *rp = NULL;
644 char host[NI_MAXHOST];
650 err("Invalid parsing server");
654 port = g_strdup_printf("%d", s->port);
656 memset(&hints,'\0',sizeof(hints));
657 hints.ai_family = AF_UNSPEC;
658 hints.ai_socktype = SOCK_STREAM;
659 hints.ai_flags = AI_ADDRCONFIG | AI_PASSIVE;
660 hints.ai_protocol = IPPROTO_TCP;
662 e = getaddrinfo(s->listenaddr, port, &hints, &ai);
668 for (rp = ai; rp != NULL; rp = rp->ai_next) {
669 e = getnameinfo(rp->ai_addr, rp->ai_addrlen, host, sizeof(host), NULL, 0, NI_NUMERICHOST);
671 if (e != 0) { // error
672 fprintf(stderr, "getnameinfo: %s\n", gai_strerror(e));
676 // duplicate server and set listenaddr to resolved IP address
679 ns->listenaddr = g_strdup(host);
680 ns->socket_family = rp->ai_family;
681 g_array_append_val(a, *ns);
689 fprintf(stderr, "getaddrinfo failed on listen host/address: %s (%s)\n", s->listenaddr ? s->listenaddr : "any", gai_strerror(e));
700 * Parse the config file.
702 * @param f the name of the config file
703 * @param e a GError. @see CFILE_ERRORS for what error values this function can
705 * @return a Array of SERVER* pointers, If the config file is empty or does not
706 * exist, returns an empty GHashTable; if the config file contains an
707 * error, returns NULL, and e is set appropriately
709 GArray* parse_cfile(gchar* f, GError** e) {
710 const char* DEFAULT_ERROR = "Could not parse %s in group %s: %s";
711 const char* MISSING_REQUIRED_ERROR = "Could not find required value %s in group %s: %s";
713 gchar *virtstyle=NULL;
715 { "exportname", TRUE, PARAM_STRING, &(s.exportname), 0 },
716 { "port", TRUE, PARAM_INT, &(s.port), 0 },
717 { "authfile", FALSE, PARAM_STRING, &(s.authname), 0 },
718 { "filesize", FALSE, PARAM_INT, &(s.expected_size), 0 },
719 { "virtstyle", FALSE, PARAM_STRING, &(virtstyle), 0 },
720 { "prerun", FALSE, PARAM_STRING, &(s.prerun), 0 },
721 { "postrun", FALSE, PARAM_STRING, &(s.postrun), 0 },
722 { "readonly", FALSE, PARAM_BOOL, &(s.flags), F_READONLY },
723 { "multifile", FALSE, PARAM_BOOL, &(s.flags), F_MULTIFILE },
724 { "copyonwrite", FALSE, PARAM_BOOL, &(s.flags), F_COPYONWRITE },
725 { "sparse_cow", FALSE, PARAM_BOOL, &(s.flags), F_SPARSE },
726 { "sdp", FALSE, PARAM_BOOL, &(s.flags), F_SDP },
727 { "sync", FALSE, PARAM_BOOL, &(s.flags), F_SYNC },
728 { "flush", FALSE, PARAM_BOOL, &(s.flags), F_FLUSH },
729 { "fua", FALSE, PARAM_BOOL, &(s.flags), F_FUA },
730 { "rotational", FALSE, PARAM_BOOL, &(s.flags), F_ROTATIONAL },
731 { "listenaddr", FALSE, PARAM_STRING, &(s.listenaddr), 0 },
732 { "maxconnections", FALSE, PARAM_INT, &(s.max_connections), 0 },
734 const int lp_size=sizeof(lp)/sizeof(PARAM);
736 { "user", FALSE, PARAM_STRING, &runuser, 0 },
737 { "group", FALSE, PARAM_STRING, &rungroup, 0 },
738 { "oldstyle", FALSE, PARAM_BOOL, &do_oldstyle, 1 },
739 { "listenaddr", FALSE, PARAM_STRING, &modern_listen, 0 },
742 int p_size=sizeof(gp)/sizeof(PARAM);
745 const char *err_msg=NULL;
754 errdomain = g_quark_from_string("parse_cfile");
755 cfile = g_key_file_new();
756 retval = g_array_new(FALSE, TRUE, sizeof(SERVER));
757 if(!g_key_file_load_from_file(cfile, f, G_KEY_FILE_KEEP_COMMENTS |
758 G_KEY_FILE_KEEP_TRANSLATIONS, &err)) {
759 g_set_error(e, errdomain, CFILE_NOTFOUND, "Could not open config file %s.", f);
760 g_key_file_free(cfile);
763 startgroup = g_key_file_get_start_group(cfile);
764 if(!startgroup || strcmp(startgroup, "generic")) {
765 g_set_error(e, errdomain, CFILE_MISSING_GENERIC, "Config file does not contain the [generic] group!");
766 g_key_file_free(cfile);
769 groups = g_key_file_get_groups(cfile, NULL);
770 for(i=0;groups[i];i++) {
771 memset(&s, '\0', sizeof(SERVER));
773 /* After the [generic] group, start parsing exports */
778 for(j=0;j<p_size;j++) {
779 g_assert(p[j].target != NULL);
780 g_assert(p[j].ptype==PARAM_INT||p[j].ptype==PARAM_STRING||p[j].ptype==PARAM_BOOL);
783 *((gint*)p[j].target) =
784 g_key_file_get_integer(cfile,
790 *((gchar**)p[j].target) =
791 g_key_file_get_string(cfile,
797 value = g_key_file_get_boolean(cfile,
799 p[j].paramname, &err);
802 *((gint*)p[j].target) |= p[j].flagval;
804 *((gint*)p[j].target) &= ~(p[j].flagval);
809 if(!strcmp(p[j].paramname, "port") && !strcmp(p[j].target, NBD_DEFAULT_PORT)) {
810 g_set_error(e, errdomain, CFILE_INCORRECT_PORT, "Config file specifies default port for oldstyle export");
811 g_key_file_free(cfile);
815 if(err->code == G_KEY_FILE_ERROR_KEY_NOT_FOUND) {
817 /* Ignore not-found error for optional values */
821 err_msg = MISSING_REQUIRED_ERROR;
824 err_msg = DEFAULT_ERROR;
826 g_set_error(e, errdomain, CFILE_VALUE_INVALID, err_msg, p[j].paramname, groups[i], err->message);
827 g_array_free(retval, TRUE);
829 g_key_file_free(cfile);
834 if(!strncmp(virtstyle, "none", 4)) {
835 s.virtstyle=VIRT_NONE;
836 } else if(!strncmp(virtstyle, "ipliteral", 9)) {
837 s.virtstyle=VIRT_IPLIT;
838 } else if(!strncmp(virtstyle, "iphash", 6)) {
839 s.virtstyle=VIRT_IPHASH;
840 } else if(!strncmp(virtstyle, "cidrhash", 8)) {
841 s.virtstyle=VIRT_CIDR;
842 if(strlen(virtstyle)<10) {
843 g_set_error(e, errdomain, CFILE_VALUE_INVALID, "Invalid value %s for parameter virtstyle in group %s: missing length", virtstyle, groups[i]);
844 g_array_free(retval, TRUE);
845 g_key_file_free(cfile);
848 s.cidrlen=strtol(virtstyle+8, NULL, 0);
850 g_set_error(e, errdomain, CFILE_VALUE_INVALID, "Invalid value %s for parameter virtstyle in group %s", virtstyle, groups[i]);
851 g_array_free(retval, TRUE);
852 g_key_file_free(cfile);
855 if(s.port && !do_oldstyle) {
856 g_warning("A port was specified, but oldstyle exports were not requested. This may not do what you expect.");
857 g_warning("Please read 'man 5 nbd-server' and search for oldstyle for more info");
860 s.virtstyle=VIRT_IPLIT;
862 /* Don't need to free this, it's not our string */
864 /* Don't append values for the [generic] group */
866 s.socket_family = AF_UNSPEC;
867 s.servename = groups[i];
869 append_serve(&s, retval);
876 if(s.flags & F_SDP) {
877 g_set_error(e, errdomain, CFILE_VALUE_UNSUPPORTED, "This nbd-server was built without support for SDP, yet group %s uses it", groups[i]);
878 g_array_free(retval, TRUE);
879 g_key_file_free(cfile);
885 g_set_error(e, errdomain, CFILE_NO_EXPORTS, "The config file does not specify any exports");
887 g_key_file_free(cfile);
892 * Signal handler for SIGCHLD
893 * @param s the signal we're handling (must be SIGCHLD, or something
896 void sigchld_handler(int s) {
901 while((pid=waitpid(-1, &status, WNOHANG)) > 0) {
902 if(WIFEXITED(status)) {
903 msg3(LOG_INFO, "Child exited with %d", WEXITSTATUS(status));
905 i=g_hash_table_lookup(children, &pid);
907 msg3(LOG_INFO, "SIGCHLD received for an unknown child with PID %ld", (long)pid);
909 DEBUG2("Removing %d from the list of children", pid);
910 g_hash_table_remove(children, &pid);
916 * Kill a child. Called from sigterm_handler::g_hash_table_foreach.
919 * @param value the value corresponding to the above key
920 * @param user_data a pointer which we always set to 1, so that we know what
923 void killchild(gpointer key, gpointer value, gpointer user_data) {
925 int *parent=user_data;
932 * Handle SIGTERM and dispatch it to our children
933 * @param s the signal we're handling (must be SIGTERM, or something
934 * is severely wrong).
936 void sigterm_handler(int s) {
939 g_hash_table_foreach(children, killchild, &parent);
949 * Detect the size of a file.
951 * @param fhandle An open filedescriptor
952 * @return the size of the file, or OFFT_MAX if detection was
955 off_t size_autodetect(int fhandle) {
958 struct stat stat_buf;
961 #ifdef HAVE_SYS_MOUNT_H
962 #ifdef HAVE_SYS_IOCTL_H
964 DEBUG("looking for export size with ioctl BLKGETSIZE64\n");
965 if (!ioctl(fhandle, BLKGETSIZE64, &bytes) && bytes) {
968 #endif /* BLKGETSIZE64 */
969 #endif /* HAVE_SYS_IOCTL_H */
970 #endif /* HAVE_SYS_MOUNT_H */
972 DEBUG("looking for fhandle size with fstat\n");
973 stat_buf.st_size = 0;
974 error = fstat(fhandle, &stat_buf);
976 if(stat_buf.st_size > 0)
977 return (off_t)stat_buf.st_size;
979 err("fstat failed: %m");
982 DEBUG("looking for fhandle size with lseek SEEK_END\n");
983 es = lseek(fhandle, (off_t)0, SEEK_END);
984 if (es > ((off_t)0)) {
987 DEBUG2("lseek failed: %d", errno==EBADF?1:(errno==ESPIPE?2:(errno==EINVAL?3:4)));
990 err("Could not find size of exported block device: %m");
995 * Get the file handle and offset, given an export offset.
997 * @param export An array of export files
998 * @param a The offset to get corresponding file/offset for
999 * @param fhandle [out] File descriptor
1000 * @param foffset [out] Offset into fhandle
1001 * @param maxbytes [out] Tells how many bytes can be read/written
1002 * from fhandle starting at foffset (0 if there is no limit)
1003 * @return 0 on success, -1 on failure
1005 int get_filepos(GArray* export, off_t a, int* fhandle, off_t* foffset, size_t* maxbytes ) {
1006 /* Negative offset not allowed */
1010 /* Binary search for last file with starting offset <= a */
1013 int end = export->len - 1;
1014 while( start <= end ) {
1015 int mid = (start + end) / 2;
1016 fi = g_array_index(export, FILE_INFO, mid);
1017 if( fi.startoff < a ) {
1019 } else if( fi.startoff > a ) {
1027 /* end should never go negative, since first startoff is 0 and a >= 0 */
1030 fi = g_array_index(export, FILE_INFO, end);
1031 *fhandle = fi.fhandle;
1032 *foffset = a - fi.startoff;
1034 if( end+1 < export->len ) {
1035 FILE_INFO fi_next = g_array_index(export, FILE_INFO, end+1);
1036 *maxbytes = fi_next.startoff - a;
1043 * seek to a position in a file, with error handling.
1044 * @param handle a filedescriptor
1045 * @param a position to seek to
1046 * @todo get rid of this; lastpoint is a global variable right now, but it
1047 * shouldn't be. If we pass it on as a parameter, that makes things a *lot*
1050 void myseek(int handle,off_t a) {
1051 if (lseek(handle, a, SEEK_SET) < 0) {
1052 err("Can not seek locally!\n");
1057 * Write an amount of bytes at a given offset to the right file. This
1058 * abstracts the write-side of the multiple file option.
1060 * @param a The offset where the write should start
1061 * @param buf The buffer to write from
1062 * @param len The length of buf
1063 * @param client The client we're serving for
1064 * @return The number of bytes actually written, or -1 in case of an error
1066 ssize_t rawexpwrite(off_t a, char *buf, size_t len, CLIENT *client, int fua) {
1072 if(get_filepos(client->export, a, &fhandle, &foffset, &maxbytes))
1074 if(maxbytes && len > maxbytes)
1077 DEBUG5("(WRITE to fd %d offset %llu len %u fua %d), ", fhandle, foffset, len, fua);
1079 myseek(fhandle, foffset);
1080 retval = write(fhandle, buf, len);
1081 if(client->server->flags & F_SYNC) {
1084 #ifdef USE_SYNC_FILE_RANGE
1085 sync_file_range(fhandle, foffset, len,
1086 SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE |
1087 SYNC_FILE_RANGE_WAIT_AFTER);
1096 * Call rawexpwrite repeatedly until all data has been written.
1097 * @return 0 on success, nonzero on failure
1099 int rawexpwrite_fully(off_t a, char *buf, size_t len, CLIENT *client, int fua) {
1102 while(len > 0 && (ret=rawexpwrite(a, buf, len, client, fua)) > 0 ) {
1107 return (ret < 0 || len != 0);
1111 * Read an amount of bytes at a given offset from the right file. This
1112 * abstracts the read-side of the multiple files option.
1114 * @param a The offset where the read should start
1115 * @param buf A buffer to read into
1116 * @param len The size of buf
1117 * @param client The client we're serving for
1118 * @return The number of bytes actually read, or -1 in case of an
1121 ssize_t rawexpread(off_t a, char *buf, size_t len, CLIENT *client) {
1126 if(get_filepos(client->export, a, &fhandle, &foffset, &maxbytes))
1128 if(maxbytes && len > maxbytes)
1131 DEBUG4("(READ from fd %d offset %llu len %u), ", fhandle, foffset, len);
1133 myseek(fhandle, foffset);
1134 return read(fhandle, buf, len);
1138 * Call rawexpread repeatedly until all data has been read.
1139 * @return 0 on success, nonzero on failure
1141 int rawexpread_fully(off_t a, char *buf, size_t len, CLIENT *client) {
1144 while(len > 0 && (ret=rawexpread(a, buf, len, client)) > 0 ) {
1149 return (ret < 0 || len != 0);
1153 * Read an amount of bytes at a given offset from the right file. This
1154 * abstracts the read-side of the copyonwrite stuff, and calls
1155 * rawexpread() with the right parameters to do the actual work.
1156 * @param a The offset where the read should start
1157 * @param buf A buffer to read into
1158 * @param len The size of buf
1159 * @param client The client we're going to read for
1160 * @return 0 on success, nonzero on failure
1162 int expread(off_t a, char *buf, size_t len, CLIENT *client) {
1163 off_t rdlen, offset;
1164 off_t mapcnt, mapl, maph, pagestart;
1166 if (!(client->server->flags & F_COPYONWRITE))
1167 return(rawexpread_fully(a, buf, len, client));
1168 DEBUG3("Asked to read %d bytes at %llu.\n", len, (unsigned long long)a);
1170 mapl=a/DIFFPAGESIZE; maph=(a+len-1)/DIFFPAGESIZE;
1172 for (mapcnt=mapl;mapcnt<=maph;mapcnt++) {
1173 pagestart=mapcnt*DIFFPAGESIZE;
1175 rdlen=(0<DIFFPAGESIZE-offset && len<(size_t)(DIFFPAGESIZE-offset)) ?
1176 len : (size_t)DIFFPAGESIZE-offset;
1177 if (client->difmap[mapcnt]!=(u32)(-1)) { /* the block is already there */
1178 DEBUG3("Page %llu is at %lu\n", (unsigned long long)mapcnt,
1179 (unsigned long)(client->difmap[mapcnt]));
1180 myseek(client->difffile, client->difmap[mapcnt]*DIFFPAGESIZE+offset);
1181 if (read(client->difffile, buf, rdlen) != rdlen) return -1;
1182 } else { /* the block is not there */
1183 DEBUG2("Page %llu is not here, we read the original one\n",
1184 (unsigned long long)mapcnt);
1185 if(rawexpread_fully(a, buf, rdlen, client)) return -1;
1187 len-=rdlen; a+=rdlen; buf+=rdlen;
1193 * Write an amount of bytes at a given offset to the right file. This
1194 * abstracts the write-side of the copyonwrite option, and calls
1195 * rawexpwrite() with the right parameters to do the actual work.
1197 * @param a The offset where the write should start
1198 * @param buf The buffer to write from
1199 * @param len The length of buf
1200 * @param client The client we're going to write for.
1201 * @return 0 on success, nonzero on failure
1203 int expwrite(off_t a, char *buf, size_t len, CLIENT *client, int fua) {
1204 char pagebuf[DIFFPAGESIZE];
1205 off_t mapcnt,mapl,maph;
1210 if (!(client->server->flags & F_COPYONWRITE))
1211 return(rawexpwrite_fully(a, buf, len, client, fua));
1212 DEBUG3("Asked to write %d bytes at %llu.\n", len, (unsigned long long)a);
1214 mapl=a/DIFFPAGESIZE ; maph=(a+len-1)/DIFFPAGESIZE ;
1216 for (mapcnt=mapl;mapcnt<=maph;mapcnt++) {
1217 pagestart=mapcnt*DIFFPAGESIZE ;
1218 offset=a-pagestart ;
1219 wrlen=(0<DIFFPAGESIZE-offset && len<(size_t)(DIFFPAGESIZE-offset)) ?
1220 len : (size_t)DIFFPAGESIZE-offset;
1222 if (client->difmap[mapcnt]!=(u32)(-1)) { /* the block is already there */
1223 DEBUG3("Page %llu is at %lu\n", (unsigned long long)mapcnt,
1224 (unsigned long)(client->difmap[mapcnt])) ;
1225 myseek(client->difffile,
1226 client->difmap[mapcnt]*DIFFPAGESIZE+offset);
1227 if (write(client->difffile, buf, wrlen) != wrlen) return -1 ;
1228 } else { /* the block is not there */
1229 myseek(client->difffile,client->difffilelen*DIFFPAGESIZE) ;
1230 client->difmap[mapcnt]=(client->server->flags&F_SPARSE)?mapcnt:client->difffilelen++;
1231 DEBUG3("Page %llu is not here, we put it at %lu\n",
1232 (unsigned long long)mapcnt,
1233 (unsigned long)(client->difmap[mapcnt]));
1234 rdlen=DIFFPAGESIZE ;
1235 if (rawexpread_fully(pagestart, pagebuf, rdlen, client))
1237 memcpy(pagebuf+offset,buf,wrlen) ;
1238 if (write(client->difffile, pagebuf, DIFFPAGESIZE) !=
1242 len-=wrlen ; a+=wrlen ; buf+=wrlen ;
1244 if (client->server->flags & F_SYNC) {
1245 fsync(client->difffile);
1247 /* open question: would it be cheaper to do multiple sync_file_ranges?
1248 as we iterate through the above?
1250 fdatasync(client->difffile);
1255 int expflush(CLIENT *client) {
1261 if (client->server->flags & F_COPYONWRITE) {
1262 return fsync(client->difffile);
1265 for (i = 0; i < client->export->len; i++) {
1266 FILE_INFO fi = g_array_index(client->export, FILE_INFO, i);
1267 if (fsync(fi.fhandle) < 0)
1275 * Do the initial negotiation.
1277 * @param client The client we're negotiating with.
1279 CLIENT* negotiate(int net, CLIENT *client, GArray* servers) {
1282 uint32_t flags = NBD_FLAG_HAS_FLAGS;
1283 uint16_t smallflags = 0;
1286 memset(zeros, '\0', sizeof(zeros));
1287 if(!client || !client->modern) {
1289 if (write(net, INIT_PASSWD, 8) < 0) {
1290 err_nonfatal("Negotiation failed: %m");
1294 if(!client || client->modern) {
1296 magic = htonll(opts_magic);
1299 magic = htonll(cliserv_magic);
1301 if (write(net, &magic, sizeof(magic)) < 0) {
1302 err_nonfatal("Negotiation failed: %m");
1316 err("programmer error");
1317 if (write(net, &smallflags, sizeof(uint16_t)) < 0)
1318 err("Negotiation failed: %m");
1319 if (read(net, &reserved, sizeof(reserved)) < 0)
1320 err("Negotiation failed: %m");
1321 if (read(net, &magic, sizeof(magic)) < 0)
1322 err("Negotiation failed: %m");
1323 magic = ntohll(magic);
1324 if(magic != opts_magic) {
1328 if (read(net, &opt, sizeof(opt)) < 0)
1329 err("Negotiation failed: %m");
1331 if(opt != NBD_OPT_EXPORT_NAME) {
1335 if (read(net, &namelen, sizeof(namelen)) < 0)
1336 err("Negotiation failed: %m");
1337 namelen = ntohl(namelen);
1338 name = malloc(namelen+1);
1340 if (read(net, name, namelen) < 0)
1341 err("Negotiation failed: %m");
1342 for(i=0; i<servers->len; i++) {
1343 SERVER* serve = &(g_array_index(servers, SERVER, i));
1344 if(!strcmp(serve->servename, name)) {
1345 CLIENT* client = g_new0(CLIENT, 1);
1346 client->server = serve;
1347 client->exportsize = OFFT_MAX;
1349 client->modern = TRUE;
1358 size_host = htonll((u64)(client->exportsize));
1359 if (write(net, &size_host, 8) < 0)
1360 err("Negotiation failed: %m");
1361 if (client->server->flags & F_READONLY)
1362 flags |= NBD_FLAG_READ_ONLY;
1363 if (client->server->flags & F_FLUSH)
1364 flags |= NBD_FLAG_SEND_FLUSH;
1365 if (client->server->flags & F_FUA)
1366 flags |= NBD_FLAG_SEND_FUA;
1367 if (client->server->flags & F_ROTATIONAL)
1368 flags |= NBD_FLAG_ROTATIONAL;
1369 if (!client->modern) {
1371 flags = htonl(flags);
1372 if (write(client->net, &flags, 4) < 0)
1373 err("Negotiation failed: %m");
1376 smallflags = (uint16_t)(flags & ~((uint16_t)0));
1377 smallflags = htons(smallflags);
1378 if (write(client->net, &smallflags, sizeof(smallflags)) < 0) {
1379 err("Negotiation failed: %m");
1383 if (write(client->net, zeros, 124) < 0)
1384 err("Negotiation failed: %m");
1388 /** sending macro. */
1389 #define SEND(net,reply) writeit( net, &reply, sizeof( reply ));
1391 #define ERROR(client,reply,errcode) { reply.error = htonl(errcode); SEND(client->net,reply); reply.error = 0; }
1393 * Serve a file to a single client.
1395 * @todo This beast needs to be split up in many tiny little manageable
1396 * pieces. Preferably with a chainsaw.
1398 * @param client The client we're going to serve to.
1399 * @return when the client disconnects
1401 int mainloop(CLIENT *client) {
1402 struct nbd_request request;
1403 struct nbd_reply reply;
1404 gboolean go_on=TRUE;
1408 negotiate(client->net, client, NULL);
1409 DEBUG("Entering request loop!\n");
1410 reply.magic = htonl(NBD_REPLY_MAGIC);
1423 readit(client->net, &request, sizeof(request));
1424 request.from = ntohll(request.from);
1425 request.type = ntohl(request.type);
1426 command = request.type & NBD_CMD_MASK_COMMAND;
1428 if (command==NBD_CMD_DISC) {
1429 msg2(LOG_INFO, "Disconnect request received.");
1430 if (client->server->flags & F_COPYONWRITE) {
1431 if (client->difmap) g_free(client->difmap) ;
1432 close(client->difffile);
1433 unlink(client->difffilename);
1434 free(client->difffilename);
1440 len = ntohl(request.len);
1442 if (request.magic != htonl(NBD_REQUEST_MAGIC))
1443 err("Not enough magic.");
1444 if (len > BUFSIZE - sizeof(struct nbd_reply)) {
1445 currlen = BUFSIZE - sizeof(struct nbd_reply);
1446 msg2(LOG_INFO, "oversized request (this is not a problem)");
1451 printf("%s from %llu (%llu) len %d, ", command ? "WRITE" :
1452 "READ", (unsigned long long)request.from,
1453 (unsigned long long)request.from / 512, len);
1455 memcpy(reply.handle, request.handle, sizeof(reply.handle));
1456 if ((request.from + len) > (OFFT_MAX)) {
1457 DEBUG("[Number too large!]");
1458 ERROR(client, reply, EINVAL);
1462 if (((ssize_t)((off_t)request.from + len) > client->exportsize)) {
1464 ERROR(client, reply, EINVAL);
1468 if (command==NBD_CMD_WRITE) {
1469 DEBUG("wr: net->buf, ");
1471 readit(client->net, buf, currlen);
1472 DEBUG("buf->exp, ");
1473 if ((client->server->flags & F_READONLY) ||
1474 (client->server->flags & F_AUTOREADONLY)) {
1475 DEBUG("[WRITE to READONLY!]");
1476 ERROR(client, reply, EPERM);
1479 if (expwrite(request.from, buf, len, client,
1480 request.type & NBD_CMD_FLAG_FUA)) {
1481 DEBUG("Write failed: %m" );
1482 ERROR(client, reply, errno);
1485 SEND(client->net, reply);
1488 currlen = (len < BUFSIZE) ? len : BUFSIZE;
1493 if (command==NBD_CMD_FLUSH) {
1495 if (expflush(client)) {
1496 DEBUG("Flush failed: %m");
1497 ERROR(client, reply, errno);
1500 SEND(client->net, reply);
1505 if (command==NBD_CMD_READ) {
1506 DEBUG("exp->buf, ");
1507 memcpy(buf, &reply, sizeof(struct nbd_reply));
1508 p = buf + sizeof(struct nbd_reply);
1509 writelen = currlen + sizeof(struct nbd_reply);
1511 if (expread(request.from, p, currlen, client)) {
1512 DEBUG("Read failed: %m");
1513 ERROR(client, reply, errno);
1517 DEBUG("buf->net, ");
1518 writeit(client->net, buf, writelen);
1520 currlen = (len < BUFSIZE) ? len : BUFSIZE;
1528 DEBUG ("Ignoring unknown command\n");
1534 * Set up client export array, which is an array of FILE_INFO.
1535 * Also, split a single exportfile into multiple ones, if that was asked.
1536 * @param client information on the client which we want to setup export for
1538 void setupexport(CLIENT* client) {
1540 off_t laststartoff = 0, lastsize = 0;
1541 int multifile = (client->server->flags & F_MULTIFILE);
1543 client->export = g_array_new(TRUE, TRUE, sizeof(FILE_INFO));
1545 /* If multi-file, open as many files as we can.
1546 * If not, open exactly one file.
1547 * Calculate file sizes as we go to get total size. */
1551 gchar* error_string;
1552 mode_t mode = (client->server->flags & F_READONLY) ? O_RDONLY : O_RDWR;
1555 tmpname=g_strdup_printf("%s.%d", client->exportname, i);
1557 tmpname=g_strdup(client->exportname);
1559 DEBUG2( "Opening %s\n", tmpname );
1560 fi.fhandle = open(tmpname, mode);
1561 if(fi.fhandle == -1 && mode == O_RDWR) {
1562 /* Try again because maybe media was read-only */
1563 fi.fhandle = open(tmpname, O_RDONLY);
1564 if(fi.fhandle != -1) {
1565 /* Opening the base file in copyonwrite mode is
1567 if(!(client->server->flags & F_COPYONWRITE)) {
1568 client->server->flags |= F_AUTOREADONLY;
1569 client->server->flags |= F_READONLY;
1573 if(fi.fhandle == -1) {
1574 if(multifile && i>0)
1576 error_string=g_strdup_printf(
1577 "Could not open exported file %s: %%m",
1581 fi.startoff = laststartoff + lastsize;
1582 g_array_append_val(client->export, fi);
1585 /* Starting offset and size of this file will be used to
1586 * calculate starting offset of next file */
1587 laststartoff = fi.startoff;
1588 lastsize = size_autodetect(fi.fhandle);
1594 /* Set export size to total calculated size */
1595 client->exportsize = laststartoff + lastsize;
1597 /* Export size may be overridden */
1598 if(client->server->expected_size) {
1599 /* desired size must be <= total calculated size */
1600 if(client->server->expected_size > client->exportsize) {
1601 err("Size of exported file is too big\n");
1604 client->exportsize = client->server->expected_size;
1607 msg3(LOG_INFO, "Size of exported file/device is %llu", (unsigned long long)client->exportsize);
1609 msg3(LOG_INFO, "Total number of files: %d", i);
1613 int copyonwrite_prepare(CLIENT* client) {
1615 if ((client->difffilename = malloc(1024))==NULL)
1616 err("Failed to allocate string for diff file name");
1617 snprintf(client->difffilename, 1024, "%s-%s-%d.diff",client->exportname,client->clientname,
1619 client->difffilename[1023]='\0';
1620 msg3(LOG_INFO,"About to create map and diff file %s",client->difffilename) ;
1621 client->difffile=open(client->difffilename,O_RDWR | O_CREAT | O_TRUNC,0600) ;
1622 if (client->difffile<0) err("Could not create diff file (%m)") ;
1623 if ((client->difmap=calloc(client->exportsize/DIFFPAGESIZE,sizeof(u32)))==NULL)
1624 err("Could not allocate memory") ;
1625 for (i=0;i<client->exportsize/DIFFPAGESIZE;i++) client->difmap[i]=(u32)-1 ;
1631 * Run a command. This is used for the ``prerun'' and ``postrun'' config file
1634 * @param command the command to be ran. Read from the config file
1635 * @param file the file name we're about to export
1637 int do_run(gchar* command, gchar* file) {
1641 if(command && *command) {
1642 cmd = g_strdup_printf(command, file);
1650 * Serve a connection.
1652 * @todo allow for multithreading, perhaps use libevent. Not just yet, though;
1653 * follow the road map.
1655 * @param client a connected client
1657 void serveconnection(CLIENT *client) {
1658 if(do_run(client->server->prerun, client->exportname)) {
1661 setupexport(client);
1663 if (client->server->flags & F_COPYONWRITE) {
1664 copyonwrite_prepare(client);
1667 setmysockopt(client->net);
1670 do_run(client->server->postrun, client->exportname);
1674 * Find the name of the file we have to serve. This will use g_strdup_printf
1675 * to put the IP address of the client inside a filename containing
1676 * "%s" (in the form as specified by the "virtstyle" option). That name
1677 * is then written to client->exportname.
1679 * @param net A socket connected to an nbd client
1680 * @param client information about the client. The IP address in human-readable
1681 * format will be written to a new char* buffer, the address of which will be
1682 * stored in client->clientname.
1684 void set_peername(int net, CLIENT *client) {
1685 struct sockaddr_storage addrin;
1686 struct sockaddr_storage netaddr;
1687 struct sockaddr_in *netaddr4 = NULL;
1688 struct sockaddr_in6 *netaddr6 = NULL;
1689 size_t addrinlen = sizeof( addrin );
1690 struct addrinfo hints;
1691 struct addrinfo *ai = NULL;
1692 char peername[NI_MAXHOST];
1693 char netname[NI_MAXHOST];
1699 if (getpeername(net, (struct sockaddr *) &addrin, (socklen_t *)&addrinlen) < 0)
1700 err("getsockname failed: %m");
1702 getnameinfo((struct sockaddr *)&addrin, (socklen_t)addrinlen,
1703 peername, sizeof (peername), NULL, 0, NI_NUMERICHOST);
1705 memset(&hints, '\0', sizeof (hints));
1706 hints.ai_flags = AI_ADDRCONFIG;
1707 e = getaddrinfo(peername, NULL, &hints, &ai);
1710 fprintf(stderr, "getaddrinfo failed: %s\n", gai_strerror(e));
1715 switch(client->server->virtstyle) {
1717 client->exportname=g_strdup(client->server->exportname);
1720 for(i=0;i<strlen(peername);i++) {
1721 if(peername[i]=='.') {
1726 client->exportname=g_strdup_printf(client->server->exportname, peername);
1729 memcpy(&netaddr, &addrin, addrinlen);
1730 if(ai->ai_family == AF_INET) {
1731 netaddr4 = (struct sockaddr_in *)&netaddr;
1732 (netaddr4->sin_addr).s_addr>>=32-(client->server->cidrlen);
1733 (netaddr4->sin_addr).s_addr<<=32-(client->server->cidrlen);
1735 getnameinfo((struct sockaddr *) netaddr4, (socklen_t) addrinlen,
1736 netname, sizeof (netname), NULL, 0, NI_NUMERICHOST);
1737 tmp=g_strdup_printf("%s/%s", netname, peername);
1738 }else if(ai->ai_family == AF_INET6) {
1739 netaddr6 = (struct sockaddr_in6 *)&netaddr;
1741 shift = 128-(client->server->cidrlen);
1743 while(shift >= 32) {
1744 ((netaddr6->sin6_addr).s6_addr32[i])=0;
1748 (netaddr6->sin6_addr).s6_addr32[i]>>=shift;
1749 (netaddr6->sin6_addr).s6_addr32[i]<<=shift;
1751 getnameinfo((struct sockaddr *)netaddr6, (socklen_t)addrinlen,
1752 netname, sizeof(netname), NULL, 0, NI_NUMERICHOST);
1753 tmp=g_strdup_printf("%s/%s", netname, peername);
1757 client->exportname=g_strdup_printf(client->server->exportname, tmp);
1763 msg4(LOG_INFO, "connect from %s, assigned file is %s",
1764 peername, client->exportname);
1765 client->clientname=g_strdup(peername);
1770 * @param data a pointer to pid_t which should be freed
1772 void destroy_pid_t(gpointer data) {
1777 * Loop through the available servers, and serve them. Never returns.
1779 int serveloop(GArray* servers) {
1780 struct sockaddr_storage addrin;
1781 socklen_t addrinlen=sizeof(addrin);
1789 * Set up the master fd_set. The set of descriptors we need
1790 * to select() for never changes anyway and it buys us a *lot*
1791 * of time to only build this once. However, if we ever choose
1792 * to not fork() for clients anymore, we may have to revisit
1797 for(i=0;i<servers->len;i++) {
1798 if((sock=(g_array_index(servers, SERVER, i)).socket)) {
1799 FD_SET(sock, &mset);
1800 max=sock>max?sock:max;
1804 FD_SET(modernsock, &mset);
1805 max=modernsock>max?modernsock:max;
1808 CLIENT *client = NULL;
1811 memcpy(&rset, &mset, sizeof(fd_set));
1812 if(select(max+1, &rset, NULL, NULL, NULL)>0) {
1817 if(FD_ISSET(modernsock, &rset)) {
1818 if((net=accept(modernsock, (struct sockaddr *) &addrin, &addrinlen)) < 0)
1820 client = negotiate(net, NULL, servers);
1822 err_nonfatal("negotiation failed");
1827 serve = client->server;
1829 for(i=0;i<servers->len && !net;i++) {
1830 serve=&(g_array_index(servers, SERVER, i));
1831 if(FD_ISSET(serve->socket, &rset)) {
1832 if ((net=accept(serve->socket, (struct sockaddr *) &addrin, &addrinlen)) < 0)
1839 if(serve->max_connections > 0 &&
1840 g_hash_table_size(children) >= serve->max_connections) {
1841 msg2(LOG_INFO, "Max connections reached");
1845 if((sock_flags = fcntl(net, F_GETFL, 0))==-1) {
1846 err("fcntl F_GETFL");
1848 if(fcntl(net, F_SETFL, sock_flags &~O_NONBLOCK)==-1) {
1849 err("fcntl F_SETFL ~O_NONBLOCK");
1852 client = g_new0(CLIENT, 1);
1853 client->server=serve;
1854 client->exportsize=OFFT_MAX;
1857 set_peername(net, client);
1858 if (!authorized_client(client)) {
1859 msg2(LOG_INFO,"Unauthorized client") ;
1863 msg2(LOG_INFO,"Authorized client") ;
1864 pid=g_malloc(sizeof(pid_t));
1867 if ((*pid=fork())<0) {
1868 msg3(LOG_INFO,"Could not fork (%s)",strerror(errno)) ;
1872 if (*pid>0) { /* parent */
1874 g_hash_table_insert(children, pid, pid);
1878 g_hash_table_destroy(children);
1879 for(i=0;i<servers->len;i++) {
1880 serve=&g_array_index(servers, SERVER, i);
1881 close(serve->socket);
1883 /* FALSE does not free the
1884 actual data. This is required,
1885 because the client has a
1886 direct reference into that
1887 data, and otherwise we get a
1889 g_array_free(servers, FALSE);
1892 msg2(LOG_INFO,"Starting to serve");
1893 serveconnection(client);
1900 void dosockopts(int socket) {
1908 /* lose the pesky "Address already in use" error message */
1909 if (setsockopt(socket,SOL_SOCKET,SO_REUSEADDR,&yes,sizeof(int)) == -1) {
1910 err("setsockopt SO_REUSEADDR");
1912 if (setsockopt(socket,SOL_SOCKET,SO_KEEPALIVE,&yes,sizeof(int)) == -1) {
1913 err("setsockopt SO_KEEPALIVE");
1916 /* make the listening socket non-blocking */
1917 if ((sock_flags = fcntl(socket, F_GETFL, 0)) == -1) {
1918 err("fcntl F_GETFL");
1920 if (fcntl(socket, F_SETFL, sock_flags | O_NONBLOCK) == -1) {
1921 err("fcntl F_SETFL O_NONBLOCK");
1926 * Connect a server's socket.
1928 * @param serve the server we want to connect.
1930 int setup_serve(SERVER *serve) {
1931 struct addrinfo hints;
1932 struct addrinfo *ai = NULL;
1937 return serve->servename ? 1 : 0;
1939 memset(&hints,'\0',sizeof(hints));
1940 hints.ai_flags = AI_PASSIVE | AI_ADDRCONFIG | AI_NUMERICSERV;
1941 hints.ai_socktype = SOCK_STREAM;
1942 hints.ai_family = serve->socket_family;
1944 port = g_strdup_printf ("%d", serve->port);
1948 e = getaddrinfo(serve->listenaddr,port,&hints,&ai);
1953 fprintf(stderr, "getaddrinfo failed: %s\n", gai_strerror(e));
1959 if(serve->socket_family == AF_UNSPEC)
1960 serve->socket_family = ai->ai_family;
1963 if ((serve->flags) && F_SDP) {
1964 if (ai->ai_family == AF_INET)
1965 ai->ai_family = AF_INET_SDP;
1966 else (ai->ai_family == AF_INET6)
1967 ai->ai_family = AF_INET6_SDP;
1970 if ((serve->socket = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol)) < 0)
1973 dosockopts(serve->socket);
1975 DEBUG("Waiting for connections... bind, ");
1976 e = bind(serve->socket, ai->ai_addr, ai->ai_addrlen);
1977 if (e != 0 && errno != EADDRINUSE)
1980 if (listen(serve->socket, 1) < 0)
1984 if(serve->servename) {
1991 void open_modern(void) {
1992 struct addrinfo hints;
1993 struct addrinfo* ai = NULL;
1997 memset(&hints, '\0', sizeof(hints));
1998 hints.ai_flags = AI_PASSIVE | AI_ADDRCONFIG;
1999 hints.ai_socktype = SOCK_STREAM;
2000 hints.ai_family = AF_UNSPEC;
2001 hints.ai_protocol = IPPROTO_TCP;
2002 e = getaddrinfo(modern_listen, NBD_DEFAULT_PORT, &hints, &ai);
2004 fprintf(stderr, "getaddrinfo failed: %s\n", gai_strerror(e));
2007 if((modernsock = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol))<0) {
2011 dosockopts(modernsock);
2013 if(bind(modernsock, ai->ai_addr, ai->ai_addrlen)) {
2016 if(listen(modernsock, 10) <0) {
2024 * Connect our servers.
2026 void setup_servers(GArray* servers) {
2028 struct sigaction sa;
2031 for(i=0;i<servers->len;i++) {
2032 want_modern |= setup_serve(&(g_array_index(servers, SERVER, i)));
2037 children=g_hash_table_new_full(g_int_hash, g_int_equal, NULL, destroy_pid_t);
2039 sa.sa_handler = sigchld_handler;
2040 sigemptyset(&sa.sa_mask);
2041 sa.sa_flags = SA_RESTART;
2042 if(sigaction(SIGCHLD, &sa, NULL) == -1)
2043 err("sigaction: %m");
2044 sa.sa_handler = sigterm_handler;
2045 sigemptyset(&sa.sa_mask);
2046 sa.sa_flags = SA_RESTART;
2047 if(sigaction(SIGTERM, &sa, NULL) == -1)
2048 err("sigaction: %m");
2052 * Go daemon (unless we specified at compile time that we didn't want this)
2053 * @param serve the first server of our configuration. If its port is zero,
2054 * then do not daemonize, because we're doing inetd then. This parameter
2055 * is only used to create a PID file of the form
2056 * /var/run/nbd-server.<port>.pid; it's not modified in any way.
2058 #if !defined(NODAEMON)
2059 void daemonize(SERVER* serve) {
2062 if(serve && !(serve->port)) {
2068 if(!*pidftemplate) {
2070 strncpy(pidftemplate, "/var/run/nbd-server.%d.pid", 255);
2072 strncpy(pidftemplate, "/var/run/nbd-server.pid", 255);
2075 snprintf(pidfname, 255, pidftemplate, serve ? serve->port : 0);
2076 pidf=fopen(pidfname, "w");
2078 fprintf(pidf,"%d\n", (int)getpid());
2082 fprintf(stderr, "Not fatal; continuing");
2086 #define daemonize(serve)
2087 #endif /* !defined(NODAEMON) */
2090 * Everything beyond this point (in the file) is run in non-daemon mode.
2091 * The stuff above daemonize() isn't.
2094 void serve_err(SERVER* serve, const char* msg) G_GNUC_NORETURN;
2096 void serve_err(SERVER* serve, const char* msg) {
2097 g_message("Export of %s on port %d failed:", serve->exportname,
2103 * Set up user-ID and/or group-ID
2105 void dousers(void) {
2110 gr=getgrnam(rungroup);
2112 str = g_strdup_printf("Invalid group name: %s", rungroup);
2115 if(setgid(gr->gr_gid)<0) {
2116 err("Could not set GID: %m");
2120 pw=getpwnam(runuser);
2122 str = g_strdup_printf("Invalid user name: %s", runuser);
2125 if(setuid(pw->pw_uid)<0) {
2126 err("Could not set UID: %m");
2132 void glib_message_syslog_redirect(const gchar *log_domain,
2133 GLogLevelFlags log_level,
2134 const gchar *message,
2137 int level=LOG_DEBUG;
2141 case G_LOG_FLAG_FATAL:
2142 case G_LOG_LEVEL_CRITICAL:
2143 case G_LOG_LEVEL_ERROR:
2146 case G_LOG_LEVEL_WARNING:
2149 case G_LOG_LEVEL_MESSAGE:
2150 case G_LOG_LEVEL_INFO:
2153 case G_LOG_LEVEL_DEBUG:
2158 syslog(level, "%s", message);
2163 * Main entry point...
2165 int main(int argc, char *argv[]) {
2170 if (sizeof( struct nbd_request )!=28) {
2171 fprintf(stderr,"Bad size of structure. Alignment problems?\n");
2172 exit(EXIT_FAILURE) ;
2175 memset(pidftemplate, '\0', 256);
2178 config_file_pos = g_strdup(CFILE);
2179 serve=cmdline(argc, argv);
2180 servers = parse_cfile(config_file_pos, &err);
2183 serve->socket_family = AF_UNSPEC;
2185 append_serve(serve, servers);
2187 if (!(serve->port)) {
2190 /* You really should define ISSERVER if you're going to use
2191 * inetd mode, but if you don't, closing stdout and stderr
2192 * (which inetd had connected to the client socket) will let it
2196 open("/dev/null", O_WRONLY);
2197 open("/dev/null", O_WRONLY);
2198 g_log_set_default_handler( glib_message_syslog_redirect, NULL );
2200 client=g_malloc(sizeof(CLIENT));
2201 client->server=serve;
2203 client->exportsize=OFFT_MAX;
2204 set_peername(0,client);
2205 serveconnection(client);
2210 if(!servers || !servers->len) {
2211 if(err && !(err->domain == g_quark_from_string("parse_cfile")
2212 && err->code == CFILE_NOTFOUND)) {
2213 g_warning("Could not parse config file: %s",
2214 err ? err->message : "Unknown error");
2218 g_warning("Specifying an export on the command line is deprecated.");
2219 g_warning("Please use a configuration file instead.");
2222 if((!serve) && (!servers||!servers->len)) {
2223 g_message("No configured exports; quitting.");
2228 setup_servers(servers);