1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20#ifndef NBD_H
21#define NBD_H
22
23#include "qapi/qapi-types-block.h"
24#include "io/channel-socket.h"
25#include "crypto/tlscreds.h"
26#include "qapi/error.h"
27
28
29
30struct NBDOption {
31 uint64_t magic;
32 uint32_t option;
33 uint32_t length;
34} QEMU_PACKED;
35typedef struct NBDOption NBDOption;
36
37struct NBDOptionReply {
38 uint64_t magic;
39 uint32_t option;
40 uint32_t type;
41 uint32_t length;
42} QEMU_PACKED;
43typedef struct NBDOptionReply NBDOptionReply;
44
45typedef struct NBDOptionReplyMetaContext {
46 NBDOptionReply h;
47 uint32_t context_id;
48
49} QEMU_PACKED NBDOptionReplyMetaContext;
50
51
52
53
54
55
56struct NBDRequest {
57 uint64_t handle;
58 uint64_t from;
59 uint32_t len;
60 uint16_t flags;
61 uint16_t type;
62};
63typedef struct NBDRequest NBDRequest;
64
65typedef struct NBDSimpleReply {
66 uint32_t magic;
67 uint32_t error;
68 uint64_t handle;
69} QEMU_PACKED NBDSimpleReply;
70
71
72typedef struct NBDStructuredReplyChunk {
73 uint32_t magic;
74 uint16_t flags;
75 uint16_t type;
76 uint64_t handle;
77 uint32_t length;
78} QEMU_PACKED NBDStructuredReplyChunk;
79
80typedef union NBDReply {
81 NBDSimpleReply simple;
82 NBDStructuredReplyChunk structured;
83 struct {
84
85
86
87
88 uint32_t magic;
89 uint32_t _skip;
90 uint64_t handle;
91 } QEMU_PACKED;
92} NBDReply;
93
94
95typedef struct NBDStructuredReadData {
96 NBDStructuredReplyChunk h;
97 uint64_t offset;
98
99} QEMU_PACKED NBDStructuredReadData;
100
101
102typedef struct NBDStructuredReadHole {
103 NBDStructuredReplyChunk h;
104 uint64_t offset;
105 uint32_t length;
106} QEMU_PACKED NBDStructuredReadHole;
107
108
109typedef struct NBDStructuredError {
110 NBDStructuredReplyChunk h;
111 uint32_t error;
112 uint16_t message_length;
113} QEMU_PACKED NBDStructuredError;
114
115
116typedef struct NBDStructuredMeta {
117 NBDStructuredReplyChunk h;
118 uint32_t context_id;
119
120} QEMU_PACKED NBDStructuredMeta;
121
122
123typedef struct NBDExtent {
124 uint32_t length;
125 uint32_t flags;
126} QEMU_PACKED NBDExtent;
127
128
129
130enum {
131 NBD_FLAG_HAS_FLAGS_BIT = 0,
132 NBD_FLAG_READ_ONLY_BIT = 1,
133 NBD_FLAG_SEND_FLUSH_BIT = 2,
134 NBD_FLAG_SEND_FUA_BIT = 3,
135 NBD_FLAG_ROTATIONAL_BIT = 4,
136
137 NBD_FLAG_SEND_TRIM_BIT = 5,
138 NBD_FLAG_SEND_WRITE_ZEROES_BIT = 6,
139 NBD_FLAG_SEND_DF_BIT = 7,
140 NBD_FLAG_CAN_MULTI_CONN_BIT = 8,
141 NBD_FLAG_SEND_RESIZE_BIT = 9,
142 NBD_FLAG_SEND_CACHE_BIT = 10,
143 NBD_FLAG_SEND_FAST_ZERO_BIT = 11,
144};
145
146#define NBD_FLAG_HAS_FLAGS (1 << NBD_FLAG_HAS_FLAGS_BIT)
147#define NBD_FLAG_READ_ONLY (1 << NBD_FLAG_READ_ONLY_BIT)
148#define NBD_FLAG_SEND_FLUSH (1 << NBD_FLAG_SEND_FLUSH_BIT)
149#define NBD_FLAG_SEND_FUA (1 << NBD_FLAG_SEND_FUA_BIT)
150#define NBD_FLAG_ROTATIONAL (1 << NBD_FLAG_ROTATIONAL_BIT)
151#define NBD_FLAG_SEND_TRIM (1 << NBD_FLAG_SEND_TRIM_BIT)
152#define NBD_FLAG_SEND_WRITE_ZEROES (1 << NBD_FLAG_SEND_WRITE_ZEROES_BIT)
153#define NBD_FLAG_SEND_DF (1 << NBD_FLAG_SEND_DF_BIT)
154#define NBD_FLAG_CAN_MULTI_CONN (1 << NBD_FLAG_CAN_MULTI_CONN_BIT)
155#define NBD_FLAG_SEND_RESIZE (1 << NBD_FLAG_SEND_RESIZE_BIT)
156#define NBD_FLAG_SEND_CACHE (1 << NBD_FLAG_SEND_CACHE_BIT)
157#define NBD_FLAG_SEND_FAST_ZERO (1 << NBD_FLAG_SEND_FAST_ZERO_BIT)
158
159
160
161#define NBD_FLAG_FIXED_NEWSTYLE (1 << 0)
162#define NBD_FLAG_NO_ZEROES (1 << 1)
163
164
165
166#define NBD_FLAG_C_FIXED_NEWSTYLE (1 << 0)
167#define NBD_FLAG_C_NO_ZEROES (1 << 1)
168
169
170#define NBD_OPT_EXPORT_NAME (1)
171#define NBD_OPT_ABORT (2)
172#define NBD_OPT_LIST (3)
173
174#define NBD_OPT_STARTTLS (5)
175#define NBD_OPT_INFO (6)
176#define NBD_OPT_GO (7)
177#define NBD_OPT_STRUCTURED_REPLY (8)
178#define NBD_OPT_LIST_META_CONTEXT (9)
179#define NBD_OPT_SET_META_CONTEXT (10)
180
181
182#define NBD_REP_ERR(value) ((UINT32_C(1) << 31) | (value))
183
184#define NBD_REP_ACK (1)
185#define NBD_REP_SERVER (2)
186#define NBD_REP_INFO (3)
187#define NBD_REP_META_CONTEXT (4)
188
189#define NBD_REP_ERR_UNSUP NBD_REP_ERR(1)
190#define NBD_REP_ERR_POLICY NBD_REP_ERR(2)
191#define NBD_REP_ERR_INVALID NBD_REP_ERR(3)
192#define NBD_REP_ERR_PLATFORM NBD_REP_ERR(4)
193#define NBD_REP_ERR_TLS_REQD NBD_REP_ERR(5)
194#define NBD_REP_ERR_UNKNOWN NBD_REP_ERR(6)
195#define NBD_REP_ERR_SHUTDOWN NBD_REP_ERR(7)
196#define NBD_REP_ERR_BLOCK_SIZE_REQD NBD_REP_ERR(8)
197
198
199#define NBD_INFO_EXPORT 0
200#define NBD_INFO_NAME 1
201#define NBD_INFO_DESCRIPTION 2
202#define NBD_INFO_BLOCK_SIZE 3
203
204
205#define NBD_CMD_FLAG_FUA (1 << 0)
206#define NBD_CMD_FLAG_NO_HOLE (1 << 1)
207#define NBD_CMD_FLAG_DF (1 << 2)
208#define NBD_CMD_FLAG_REQ_ONE (1 << 3)
209
210#define NBD_CMD_FLAG_FAST_ZERO (1 << 4)
211
212
213enum {
214 NBD_CMD_READ = 0,
215 NBD_CMD_WRITE = 1,
216 NBD_CMD_DISC = 2,
217 NBD_CMD_FLUSH = 3,
218 NBD_CMD_TRIM = 4,
219 NBD_CMD_CACHE = 5,
220 NBD_CMD_WRITE_ZEROES = 6,
221 NBD_CMD_BLOCK_STATUS = 7,
222};
223
224#define NBD_DEFAULT_PORT 10809
225
226
227#define NBD_MAX_BUFFER_SIZE (32 * 1024 * 1024)
228
229
230
231
232
233
234#define NBD_MAX_STRING_SIZE 4096
235
236
237#define NBD_SIMPLE_REPLY_MAGIC 0x67446698
238#define NBD_STRUCTURED_REPLY_MAGIC 0x668e33ef
239
240
241#define NBD_REPLY_FLAG_DONE (1 << 0)
242
243
244#define NBD_REPLY_ERR(value) ((1 << 15) | (value))
245
246#define NBD_REPLY_TYPE_NONE 0
247#define NBD_REPLY_TYPE_OFFSET_DATA 1
248#define NBD_REPLY_TYPE_OFFSET_HOLE 2
249#define NBD_REPLY_TYPE_BLOCK_STATUS 5
250#define NBD_REPLY_TYPE_ERROR NBD_REPLY_ERR(1)
251#define NBD_REPLY_TYPE_ERROR_OFFSET NBD_REPLY_ERR(2)
252
253
254#define NBD_STATE_HOLE (1 << 0)
255#define NBD_STATE_ZERO (1 << 1)
256
257
258#define NBD_STATE_DIRTY (1 << 0)
259
260static inline bool nbd_reply_type_is_error(int type)
261{
262 return type & (1 << 15);
263}
264
265
266
267
268
269#define NBD_SUCCESS 0
270#define NBD_EPERM 1
271#define NBD_EIO 5
272#define NBD_ENOMEM 12
273#define NBD_EINVAL 22
274#define NBD_ENOSPC 28
275#define NBD_EOVERFLOW 75
276#define NBD_ENOTSUP 95
277#define NBD_ESHUTDOWN 108
278
279
280struct NBDExportInfo {
281
282 bool request_sizes;
283 char *x_dirty_bitmap;
284
285
286
287 char *name;
288
289
290
291 bool structured_reply;
292 bool base_allocation;
293
294
295
296 uint64_t size;
297 uint16_t flags;
298 uint32_t min_block;
299 uint32_t opt_block;
300 uint32_t max_block;
301
302 uint32_t context_id;
303
304
305 char *description;
306 int n_contexts;
307 char **contexts;
308};
309typedef struct NBDExportInfo NBDExportInfo;
310
311int nbd_receive_negotiate(AioContext *aio_context, QIOChannel *ioc,
312 QCryptoTLSCreds *tlscreds,
313 const char *hostname, QIOChannel **outioc,
314 NBDExportInfo *info, Error **errp);
315void nbd_free_export_list(NBDExportInfo *info, int count);
316int nbd_receive_export_list(QIOChannel *ioc, QCryptoTLSCreds *tlscreds,
317 const char *hostname, NBDExportInfo **info,
318 Error **errp);
319int nbd_init(int fd, QIOChannelSocket *sioc, NBDExportInfo *info,
320 Error **errp);
321int nbd_send_request(QIOChannel *ioc, NBDRequest *request);
322int coroutine_fn nbd_receive_reply(BlockDriverState *bs, QIOChannel *ioc,
323 NBDReply *reply, Error **errp);
324int nbd_client(int fd);
325int nbd_disconnect(int fd);
326int nbd_errno_to_system_errno(int err);
327
328typedef struct NBDExport NBDExport;
329typedef struct NBDClient NBDClient;
330
331NBDExport *nbd_export_new(BlockDriverState *bs, uint64_t dev_offset,
332 uint64_t size, const char *name, const char *desc,
333 const char *bitmap, bool readonly, bool shared,
334 void (*close)(NBDExport *), bool writethrough,
335 BlockBackend *on_eject_blk, Error **errp);
336void nbd_export_close(NBDExport *exp);
337void nbd_export_remove(NBDExport *exp, NbdServerRemoveMode mode, Error **errp);
338void nbd_export_get(NBDExport *exp);
339void nbd_export_put(NBDExport *exp);
340
341BlockBackend *nbd_export_get_blockdev(NBDExport *exp);
342
343AioContext *nbd_export_aio_context(NBDExport *exp);
344NBDExport *nbd_export_find(const char *name);
345void nbd_export_close_all(void);
346
347void nbd_client_new(QIOChannelSocket *sioc,
348 QCryptoTLSCreds *tlscreds,
349 const char *tlsauthz,
350 void (*close_fn)(NBDClient *, bool));
351void nbd_client_get(NBDClient *client);
352void nbd_client_put(NBDClient *client);
353
354void nbd_server_start(SocketAddress *addr, const char *tls_creds,
355 const char *tls_authz, Error **errp);
356void nbd_server_start_options(NbdServerOptions *arg, Error **errp);
357
358
359
360
361static inline int nbd_read(QIOChannel *ioc, void *buffer, size_t size,
362 const char *desc, Error **errp)
363{
364 int ret = qio_channel_read_all(ioc, buffer, size, errp) < 0 ? -EIO : 0;
365
366 if (ret < 0) {
367 if (desc) {
368 error_prepend(errp, "Failed to read %s: ", desc);
369 }
370 return -1;
371 }
372
373 return 0;
374}
375
376#define DEF_NBD_READ_N(bits) \
377static inline int nbd_read##bits(QIOChannel *ioc, \
378 uint##bits##_t *val, \
379 const char *desc, Error **errp) \
380{ \
381 if (nbd_read(ioc, val, sizeof(*val), desc, errp) < 0) { \
382 return -1; \
383 } \
384 *val = be##bits##_to_cpu(*val); \
385 return 0; \
386}
387
388DEF_NBD_READ_N(16)
389DEF_NBD_READ_N(32)
390DEF_NBD_READ_N(64)
391
392#undef DEF_NBD_READ_N
393
394static inline bool nbd_reply_is_simple(NBDReply *reply)
395{
396 return reply->magic == NBD_SIMPLE_REPLY_MAGIC;
397}
398
399static inline bool nbd_reply_is_structured(NBDReply *reply)
400{
401 return reply->magic == NBD_STRUCTURED_REPLY_MAGIC;
402}
403
404const char *nbd_reply_type_lookup(uint16_t type);
405const char *nbd_opt_lookup(uint32_t opt);
406const char *nbd_rep_lookup(uint32_t rep);
407const char *nbd_info_lookup(uint16_t info);
408const char *nbd_cmd_lookup(uint16_t info);
409const char *nbd_err_lookup(int err);
410
411#endif
412