blob: 344f05b794d9dbbf4d487174da106404a395ffb7 [file] [log] [blame]
ths75818252008-07-03 13:41:03 +00001/*
bellard7a5ca862008-05-27 21:13:40 +00002 * 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
Blue Swirl8167ee82009-07-16 20:47:01 +000016 * along with this program; if not, see <http://www.gnu.org/licenses/>.
ths75818252008-07-03 13:41:03 +000017 */
bellard7a5ca862008-05-27 21:13:40 +000018
19#ifndef NBD_H
20#define NBD_H
21
22#include <sys/types.h>
bellard7a5ca862008-05-27 21:13:40 +000023
Stefan Weil5a61cb62011-09-08 17:55:32 +020024#include "qemu-common.h"
Nick Thomasc12504c2011-02-22 15:44:53 +000025
ths75818252008-07-03 13:41:03 +000026struct nbd_request {
Nick Thomasc12504c2011-02-22 15:44:53 +000027 uint32_t magic;
ths75818252008-07-03 13:41:03 +000028 uint32_t type;
29 uint64_t handle;
30 uint64_t from;
31 uint32_t len;
Stefan Weil541dc0d2011-08-31 12:38:01 +020032} QEMU_PACKED;
ths75818252008-07-03 13:41:03 +000033
34struct nbd_reply {
Nick Thomasc12504c2011-02-22 15:44:53 +000035 uint32_t magic;
ths75818252008-07-03 13:41:03 +000036 uint32_t error;
37 uint64_t handle;
Stefan Weil541dc0d2011-08-31 12:38:01 +020038} QEMU_PACKED;
ths75818252008-07-03 13:41:03 +000039
Paolo Bonzinib90fb4b2011-09-08 17:24:54 +020040#define NBD_FLAG_HAS_FLAGS (1 << 0) /* Flags are there */
41#define NBD_FLAG_READ_ONLY (1 << 1) /* Device is read-only */
Paolo Bonzinibbb74ed2011-09-08 17:24:55 +020042#define NBD_FLAG_SEND_FLUSH (1 << 2) /* Send FLUSH */
43#define NBD_FLAG_SEND_FUA (1 << 3) /* Send FUA (Force Unit Access) */
44#define NBD_FLAG_ROTATIONAL (1 << 4) /* Use elevator algorithm - rotational media */
45#define NBD_FLAG_SEND_TRIM (1 << 5) /* Send TRIM (discard) */
46
47#define NBD_CMD_MASK_COMMAND 0x0000ffff
48#define NBD_CMD_FLAG_FUA (1 << 16)
Paolo Bonzinib90fb4b2011-09-08 17:24:54 +020049
ths75818252008-07-03 13:41:03 +000050enum {
51 NBD_CMD_READ = 0,
52 NBD_CMD_WRITE = 1,
Paolo Bonzinibbb74ed2011-09-08 17:24:55 +020053 NBD_CMD_DISC = 2,
54 NBD_CMD_FLUSH = 3,
55 NBD_CMD_TRIM = 4
ths75818252008-07-03 13:41:03 +000056};
57
Laurent Vivier1d45f8b2010-08-25 22:48:33 +020058#define NBD_DEFAULT_PORT 10809
59
Paolo Bonzini3777b092011-10-07 14:35:58 +020060#define NBD_BUFFER_SIZE (1024*1024)
61
Paolo Bonzini185b4332012-03-05 08:56:10 +010062ssize_t nbd_wr_sync(int fd, void *buffer, size_t size, bool do_read);
ths75818252008-07-03 13:41:03 +000063int tcp_socket_outgoing(const char *address, uint16_t port);
bellard7a5ca862008-05-27 21:13:40 +000064int tcp_socket_incoming(const char *address, uint16_t port);
Nick Thomasc12504c2011-02-22 15:44:53 +000065int tcp_socket_outgoing_spec(const char *address_and_port);
66int tcp_socket_incoming_spec(const char *address_and_port);
thscd831bd2008-07-03 10:23:51 +000067int unix_socket_outgoing(const char *path);
68int unix_socket_incoming(const char *path);
bellard7a5ca862008-05-27 21:13:40 +000069
Laurent Vivier1d45f8b2010-08-25 22:48:33 +020070int nbd_receive_negotiate(int csock, const char *name, uint32_t *flags,
71 off_t *size, size_t *blocksize);
Paolo Bonzinib90fb4b2011-09-08 17:24:54 +020072int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize);
Paolo Bonzini94e73402012-03-07 11:25:01 +010073ssize_t nbd_send_request(int csock, struct nbd_request *request);
74ssize_t nbd_receive_reply(int csock, struct nbd_reply *reply);
Jes Sorensen0a4eb862010-08-31 09:30:33 +020075int nbd_client(int fd);
bellard7a5ca862008-05-27 21:13:40 +000076int nbd_disconnect(int fd);
77
Paolo Bonziniaf49bbb2011-09-19 14:03:37 +020078typedef struct NBDExport NBDExport;
Paolo Bonzini1743b512011-09-19 14:33:23 +020079typedef struct NBDClient NBDClient;
Paolo Bonziniaf49bbb2011-09-19 14:03:37 +020080
81NBDExport *nbd_export_new(BlockDriverState *bs, off_t dev_offset,
Paolo Bonzini0ddf08d2012-09-18 13:59:03 +020082 off_t size, uint32_t nbdflags,
83 void (*close)(NBDExport *));
Paolo Bonziniaf49bbb2011-09-19 14:03:37 +020084void nbd_export_close(NBDExport *exp);
Paolo Bonzini2c8d9f02012-09-18 13:26:25 +020085void nbd_export_get(NBDExport *exp);
86void nbd_export_put(NBDExport *exp);
Paolo Bonzinice339672012-09-18 13:17:52 +020087
Paolo Bonzini125afda2012-09-18 14:31:44 +020088BlockDriverState *nbd_export_get_blockdev(NBDExport *exp);
89
Paolo Bonziniee0a19e2012-08-22 15:59:23 +020090NBDExport *nbd_export_find(const char *name);
91void nbd_export_set_name(NBDExport *exp, const char *name);
92void nbd_export_close_all(void);
93
Paolo Bonzini1743b512011-09-19 14:33:23 +020094NBDClient *nbd_client_new(NBDExport *exp, int csock,
95 void (*close)(NBDClient *));
Paolo Bonziniff2b68a2012-08-22 18:45:12 +020096void nbd_client_close(NBDClient *client);
Paolo Bonzinice339672012-09-18 13:17:52 +020097void nbd_client_get(NBDClient *client);
98void nbd_client_put(NBDClient *client);
Paolo Bonziniaf49bbb2011-09-19 14:03:37 +020099
bellard7a5ca862008-05-27 21:13:40 +0000100#endif