ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 1 | /* |
bellard | 7a5ca86 | 2008-05-27 21:13:40 +0000 | [diff] [blame] | 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 |
Blue Swirl | 8167ee8 | 2009-07-16 20:47:01 +0000 | [diff] [blame] | 16 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 17 | */ |
bellard | 7a5ca86 | 2008-05-27 21:13:40 +0000 | [diff] [blame] | 18 | |
| 19 | #ifndef NBD_H |
| 20 | #define NBD_H |
| 21 | |
| 22 | #include <sys/types.h> |
bellard | 7a5ca86 | 2008-05-27 21:13:40 +0000 | [diff] [blame] | 23 | |
Stefan Weil | 5a61cb6 | 2011-09-08 17:55:32 +0200 | [diff] [blame] | 24 | #include "qemu-common.h" |
Nick Thomas | c12504c | 2011-02-22 15:44:53 +0000 | [diff] [blame] | 25 | |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 26 | struct nbd_request { |
Nick Thomas | c12504c | 2011-02-22 15:44:53 +0000 | [diff] [blame] | 27 | uint32_t magic; |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 28 | uint32_t type; |
| 29 | uint64_t handle; |
| 30 | uint64_t from; |
| 31 | uint32_t len; |
Stefan Weil | 541dc0d | 2011-08-31 12:38:01 +0200 | [diff] [blame] | 32 | } QEMU_PACKED; |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 33 | |
| 34 | struct nbd_reply { |
Nick Thomas | c12504c | 2011-02-22 15:44:53 +0000 | [diff] [blame] | 35 | uint32_t magic; |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 36 | uint32_t error; |
| 37 | uint64_t handle; |
Stefan Weil | 541dc0d | 2011-08-31 12:38:01 +0200 | [diff] [blame] | 38 | } QEMU_PACKED; |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 39 | |
Paolo Bonzini | b90fb4b | 2011-09-08 17:24:54 +0200 | [diff] [blame] | 40 | #define NBD_FLAG_HAS_FLAGS (1 << 0) /* Flags are there */ |
| 41 | #define NBD_FLAG_READ_ONLY (1 << 1) /* Device is read-only */ |
Paolo Bonzini | bbb74ed | 2011-09-08 17:24:55 +0200 | [diff] [blame] | 42 | #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 Bonzini | b90fb4b | 2011-09-08 17:24:54 +0200 | [diff] [blame] | 49 | |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 50 | enum { |
| 51 | NBD_CMD_READ = 0, |
| 52 | NBD_CMD_WRITE = 1, |
Paolo Bonzini | bbb74ed | 2011-09-08 17:24:55 +0200 | [diff] [blame] | 53 | NBD_CMD_DISC = 2, |
| 54 | NBD_CMD_FLUSH = 3, |
| 55 | NBD_CMD_TRIM = 4 |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 56 | }; |
| 57 | |
Laurent Vivier | 1d45f8b | 2010-08-25 22:48:33 +0200 | [diff] [blame] | 58 | #define NBD_DEFAULT_PORT 10809 |
| 59 | |
Paolo Bonzini | 3777b09 | 2011-10-07 14:35:58 +0200 | [diff] [blame] | 60 | #define NBD_BUFFER_SIZE (1024*1024) |
| 61 | |
Paolo Bonzini | 185b433 | 2012-03-05 08:56:10 +0100 | [diff] [blame] | 62 | ssize_t nbd_wr_sync(int fd, void *buffer, size_t size, bool do_read); |
ths | 7581825 | 2008-07-03 13:41:03 +0000 | [diff] [blame] | 63 | int tcp_socket_outgoing(const char *address, uint16_t port); |
bellard | 7a5ca86 | 2008-05-27 21:13:40 +0000 | [diff] [blame] | 64 | int tcp_socket_incoming(const char *address, uint16_t port); |
Nick Thomas | c12504c | 2011-02-22 15:44:53 +0000 | [diff] [blame] | 65 | int tcp_socket_outgoing_spec(const char *address_and_port); |
| 66 | int tcp_socket_incoming_spec(const char *address_and_port); |
ths | cd831bd | 2008-07-03 10:23:51 +0000 | [diff] [blame] | 67 | int unix_socket_outgoing(const char *path); |
| 68 | int unix_socket_incoming(const char *path); |
bellard | 7a5ca86 | 2008-05-27 21:13:40 +0000 | [diff] [blame] | 69 | |
Laurent Vivier | 1d45f8b | 2010-08-25 22:48:33 +0200 | [diff] [blame] | 70 | int nbd_receive_negotiate(int csock, const char *name, uint32_t *flags, |
| 71 | off_t *size, size_t *blocksize); |
Paolo Bonzini | b90fb4b | 2011-09-08 17:24:54 +0200 | [diff] [blame] | 72 | int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize); |
Paolo Bonzini | 94e7340 | 2012-03-07 11:25:01 +0100 | [diff] [blame] | 73 | ssize_t nbd_send_request(int csock, struct nbd_request *request); |
| 74 | ssize_t nbd_receive_reply(int csock, struct nbd_reply *reply); |
Jes Sorensen | 0a4eb86 | 2010-08-31 09:30:33 +0200 | [diff] [blame] | 75 | int nbd_client(int fd); |
bellard | 7a5ca86 | 2008-05-27 21:13:40 +0000 | [diff] [blame] | 76 | int nbd_disconnect(int fd); |
| 77 | |
Paolo Bonzini | af49bbb | 2011-09-19 14:03:37 +0200 | [diff] [blame] | 78 | typedef struct NBDExport NBDExport; |
Paolo Bonzini | 1743b51 | 2011-09-19 14:33:23 +0200 | [diff] [blame] | 79 | typedef struct NBDClient NBDClient; |
Paolo Bonzini | af49bbb | 2011-09-19 14:03:37 +0200 | [diff] [blame] | 80 | |
| 81 | NBDExport *nbd_export_new(BlockDriverState *bs, off_t dev_offset, |
Paolo Bonzini | 0ddf08d | 2012-09-18 13:59:03 +0200 | [diff] [blame] | 82 | off_t size, uint32_t nbdflags, |
| 83 | void (*close)(NBDExport *)); |
Paolo Bonzini | af49bbb | 2011-09-19 14:03:37 +0200 | [diff] [blame] | 84 | void nbd_export_close(NBDExport *exp); |
Paolo Bonzini | 2c8d9f0 | 2012-09-18 13:26:25 +0200 | [diff] [blame] | 85 | void nbd_export_get(NBDExport *exp); |
| 86 | void nbd_export_put(NBDExport *exp); |
Paolo Bonzini | ce33967 | 2012-09-18 13:17:52 +0200 | [diff] [blame] | 87 | |
Paolo Bonzini | 125afda | 2012-09-18 14:31:44 +0200 | [diff] [blame] | 88 | BlockDriverState *nbd_export_get_blockdev(NBDExport *exp); |
| 89 | |
Paolo Bonzini | ee0a19e | 2012-08-22 15:59:23 +0200 | [diff] [blame] | 90 | NBDExport *nbd_export_find(const char *name); |
| 91 | void nbd_export_set_name(NBDExport *exp, const char *name); |
| 92 | void nbd_export_close_all(void); |
| 93 | |
Paolo Bonzini | 1743b51 | 2011-09-19 14:33:23 +0200 | [diff] [blame] | 94 | NBDClient *nbd_client_new(NBDExport *exp, int csock, |
| 95 | void (*close)(NBDClient *)); |
Paolo Bonzini | ff2b68a | 2012-08-22 18:45:12 +0200 | [diff] [blame] | 96 | void nbd_client_close(NBDClient *client); |
Paolo Bonzini | ce33967 | 2012-09-18 13:17:52 +0200 | [diff] [blame] | 97 | void nbd_client_get(NBDClient *client); |
| 98 | void nbd_client_put(NBDClient *client); |
Paolo Bonzini | af49bbb | 2011-09-19 14:03:37 +0200 | [diff] [blame] | 99 | |
bellard | 7a5ca86 | 2008-05-27 21:13:40 +0000 | [diff] [blame] | 100 | #endif |