1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19#ifndef NBD_H
20#define NBD_H
21
22
23#include "qemu-common.h"
24#include "qemu/option.h"
25#include "io/channel-socket.h"
26#include "crypto/tlscreds.h"
27
28struct nbd_request {
29 uint32_t magic;
30 uint32_t type;
31 uint64_t handle;
32 uint64_t from;
33 uint32_t len;
34} QEMU_PACKED;
35
36struct nbd_reply {
37 uint32_t magic;
38 uint32_t error;
39 uint64_t handle;
40} QEMU_PACKED;
41
42#define NBD_FLAG_HAS_FLAGS (1 << 0)
43#define NBD_FLAG_READ_ONLY (1 << 1)
44#define NBD_FLAG_SEND_FLUSH (1 << 2)
45#define NBD_FLAG_SEND_FUA (1 << 3)
46#define NBD_FLAG_ROTATIONAL (1 << 4)
47#define NBD_FLAG_SEND_TRIM (1 << 5)
48
49
50#define NBD_FLAG_FIXED_NEWSTYLE (1 << 0)
51
52
53#define NBD_FLAG_C_FIXED_NEWSTYLE (1 << 0)
54
55
56#define NBD_REP_ACK (1)
57#define NBD_REP_SERVER (2)
58#define NBD_REP_ERR_UNSUP ((UINT32_C(1) << 31) | 1)
59#define NBD_REP_ERR_POLICY ((UINT32_C(1) << 31) | 2)
60#define NBD_REP_ERR_INVALID ((UINT32_C(1) << 31) | 3)
61#define NBD_REP_ERR_TLS_REQD ((UINT32_C(1) << 31) | 5)
62
63
64#define NBD_CMD_MASK_COMMAND 0x0000ffff
65#define NBD_CMD_FLAG_FUA (1 << 16)
66
67enum {
68 NBD_CMD_READ = 0,
69 NBD_CMD_WRITE = 1,
70 NBD_CMD_DISC = 2,
71 NBD_CMD_FLUSH = 3,
72 NBD_CMD_TRIM = 4
73};
74
75#define NBD_DEFAULT_PORT 10809
76
77
78#define NBD_MAX_BUFFER_SIZE (32 * 1024 * 1024)
79#define NBD_MAX_SECTORS (NBD_MAX_BUFFER_SIZE / BDRV_SECTOR_SIZE)
80
81ssize_t nbd_wr_syncv(QIOChannel *ioc,
82 struct iovec *iov,
83 size_t niov,
84 size_t offset,
85 size_t length,
86 bool do_read);
87int nbd_receive_negotiate(QIOChannel *ioc, const char *name, uint16_t *flags,
88 QCryptoTLSCreds *tlscreds, const char *hostname,
89 QIOChannel **outioc,
90 off_t *size, Error **errp);
91int nbd_init(int fd, QIOChannelSocket *sioc, uint16_t flags, off_t size);
92ssize_t nbd_send_request(QIOChannel *ioc, struct nbd_request *request);
93ssize_t nbd_receive_reply(QIOChannel *ioc, struct nbd_reply *reply);
94int nbd_client(int fd);
95int nbd_disconnect(int fd);
96
97typedef struct NBDExport NBDExport;
98typedef struct NBDClient NBDClient;
99
100NBDExport *nbd_export_new(BlockBackend *blk, off_t dev_offset, off_t size,
101 uint16_t nbdflags, void (*close)(NBDExport *),
102 Error **errp);
103void nbd_export_close(NBDExport *exp);
104void nbd_export_get(NBDExport *exp);
105void nbd_export_put(NBDExport *exp);
106
107BlockBackend *nbd_export_get_blockdev(NBDExport *exp);
108
109NBDExport *nbd_export_find(const char *name);
110void nbd_export_set_name(NBDExport *exp, const char *name);
111void nbd_export_close_all(void);
112
113void nbd_client_new(NBDExport *exp,
114 QIOChannelSocket *sioc,
115 QCryptoTLSCreds *tlscreds,
116 const char *tlsaclname,
117 void (*close)(NBDClient *));
118void nbd_client_get(NBDClient *client);
119void nbd_client_put(NBDClient *client);
120
121#endif
122