xref: /illumos-kvm-cmd/nbd.h (revision 68396ea9)
1 /*
2  *  Copyright (C) 2005  Anthony Liguori <anthony@codemonkey.ws>
3  *
4  *  Network Block Device
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; under version 2 of the License.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
17  */
18 
19 #ifndef NBD_H
20 #define NBD_H
21 
22 #include <sys/types.h>
23 
24 #include <qemu-common.h>
25 #include "block_int.h"
26 
27 struct nbd_request {
28     uint32_t type;
29     uint64_t handle;
30     uint64_t from;
31     uint32_t len;
32 };
33 
34 struct nbd_reply {
35     uint32_t error;
36     uint64_t handle;
37 };
38 
39 enum {
40     NBD_CMD_READ = 0,
41     NBD_CMD_WRITE = 1,
42     NBD_CMD_DISC = 2
43 };
44 
45 #define NBD_DEFAULT_PORT	10809
46 
47 size_t nbd_wr_sync(int fd, void *buffer, size_t size, bool do_read);
48 int tcp_socket_outgoing(const char *address, uint16_t port);
49 int tcp_socket_incoming(const char *address, uint16_t port);
50 int unix_socket_outgoing(const char *path);
51 int unix_socket_incoming(const char *path);
52 
53 int nbd_negotiate(int csock, off_t size);
54 int nbd_receive_negotiate(int csock, const char *name, uint32_t *flags,
55                           off_t *size, size_t *blocksize);
56 int nbd_init(int fd, int csock, off_t size, size_t blocksize);
57 int nbd_send_request(int csock, struct nbd_request *request);
58 int nbd_receive_reply(int csock, struct nbd_reply *reply);
59 int nbd_trip(BlockDriverState *bs, int csock, off_t size, uint64_t dev_offset,
60              off_t *offset, bool readonly, uint8_t *data, int data_size);
61 int nbd_client(int fd);
62 int nbd_disconnect(int fd);
63 
64 #endif
65