]> git.proxmox.com Git - mirror_qemu.git/blame - nbd/nbd-internal.h
nbd: Implement NBD_OPT_GO on server
[mirror_qemu.git] / nbd / nbd-internal.h
CommitLineData
798bfe00
FZ
1/*
2 * NBD Internal Declarations
3 *
4 * Copyright (C) 2016 Red Hat, Inc.
5 *
6 * This work is licensed under the terms of the GNU GPL, version 2 or later.
7 * See the COPYING file in the top-level directory.
8 */
9
10#ifndef NBD_INTERNAL_H
11#define NBD_INTERNAL_H
12#include "block/nbd.h"
13#include "sysemu/block-backend.h"
f95910fe 14#include "io/channel-tls.h"
798bfe00
FZ
15
16#include "qemu/coroutine.h"
1c778ef7 17#include "qemu/iov.h"
798bfe00 18
798bfe00
FZ
19#ifndef _WIN32
20#include <sys/ioctl.h>
21#endif
22#if defined(__sun__) || defined(__HAIKU__)
23#include <sys/ioccom.h>
24#endif
798bfe00
FZ
25
26#ifdef __linux__
27#include <linux/fs.h>
28#endif
29
58369e22 30#include "qemu/bswap.h"
798bfe00
FZ
31#include "qemu/queue.h"
32#include "qemu/main-loop.h"
33
798bfe00
FZ
34/* This is all part of the "official" NBD API.
35 *
36 * The most up-to-date documentation is available at:
b626b51a 37 * https://github.com/yoe/nbd/blob/master/doc/proto.md
798bfe00
FZ
38 */
39
b626b51a 40#define NBD_REQUEST_SIZE (4 + 2 + 2 + 8 + 8 + 4)
798bfe00
FZ
41#define NBD_REPLY_SIZE (4 + 4 + 8)
42#define NBD_REQUEST_MAGIC 0x25609513
43#define NBD_REPLY_MAGIC 0x67446698
44#define NBD_OPTS_MAGIC 0x49484156454F5054LL
45#define NBD_CLIENT_MAGIC 0x0000420281861253LL
c8a3a1b6 46#define NBD_REP_MAGIC 0x0003e889045565a9LL
798bfe00
FZ
47
48#define NBD_SET_SOCK _IO(0xab, 0)
49#define NBD_SET_BLKSIZE _IO(0xab, 1)
50#define NBD_SET_SIZE _IO(0xab, 2)
51#define NBD_DO_IT _IO(0xab, 3)
52#define NBD_CLEAR_SOCK _IO(0xab, 4)
53#define NBD_CLEAR_QUE _IO(0xab, 5)
54#define NBD_PRINT_DEBUG _IO(0xab, 6)
55#define NBD_SET_SIZE_BLOCKS _IO(0xab, 7)
56#define NBD_DISCONNECT _IO(0xab, 8)
57#define NBD_SET_TIMEOUT _IO(0xab, 9)
58#define NBD_SET_FLAGS _IO(0xab, 10)
59
798bfe00
FZ
60/* NBD errors are based on errno numbers, so there is a 1:1 mapping,
61 * but only a limited set of errno values is specified in the protocol.
62 * Everything else is squashed to EINVAL.
63 */
64#define NBD_SUCCESS 0
65#define NBD_EPERM 1
66#define NBD_EIO 5
67#define NBD_ENOMEM 12
68#define NBD_EINVAL 22
69#define NBD_ENOSPC 28
b6f5d3b5 70#define NBD_ESHUTDOWN 108
798bfe00 71
d1fdf257 72/* nbd_read_eof
f5d406fe
VSO
73 * Tries to read @size bytes from @ioc. Returns number of bytes actually read.
74 * May return a value >= 0 and < size only on EOF, i.e. when iteratively called
d1fdf257 75 * qio_channel_readv() returns 0. So, there is no need to call nbd_read_eof
f5d406fe
VSO
76 * iteratively.
77 */
d1fdf257
VSO
78static inline ssize_t nbd_read_eof(QIOChannel *ioc, void *buffer, size_t size,
79 Error **errp)
798bfe00 80{
1c778ef7 81 struct iovec iov = { .iov_base = buffer, .iov_len = size };
798bfe00
FZ
82 /* Sockets are kept in blocking mode in the negotiation phase. After
83 * that, a non-readable socket simply means that another thread stole
84 * our request/reply. Synchronization is done with recv_coroutine, so
85 * that this is coroutine-safe.
86 */
d1fdf257 87 return nbd_rwv(ioc, &iov, 1, size, true, errp);
798bfe00
FZ
88}
89
d1fdf257 90/* nbd_read
f5d406fe
VSO
91 * Reads @size bytes from @ioc. Returns 0 on success.
92 */
d1fdf257
VSO
93static inline int nbd_read(QIOChannel *ioc, void *buffer, size_t size,
94 Error **errp)
f5d406fe 95{
d1fdf257 96 ssize_t ret = nbd_read_eof(ioc, buffer, size, errp);
f5d406fe
VSO
97
98 if (ret >= 0 && ret != size) {
99 ret = -EINVAL;
e44ed99d 100 error_setg(errp, "End of file");
f5d406fe
VSO
101 }
102
103 return ret < 0 ? ret : 0;
104}
105
d1fdf257 106/* nbd_write
f5d406fe
VSO
107 * Writes @size bytes to @ioc. Returns 0 on success.
108 */
d1fdf257
VSO
109static inline int nbd_write(QIOChannel *ioc, const void *buffer, size_t size,
110 Error **errp)
798bfe00 111{
b1a75b33 112 struct iovec iov = { .iov_base = (void *) buffer, .iov_len = size };
1c778ef7 113
d1fdf257 114 ssize_t ret = nbd_rwv(ioc, &iov, 1, size, false, errp);
f5d406fe
VSO
115
116 assert(ret < 0 || ret == size);
117
118 return ret < 0 ? ret : 0;
798bfe00
FZ
119}
120
f95910fe
DB
121struct NBDTLSHandshakeData {
122 GMainLoop *loop;
123 bool complete;
124 Error *error;
125};
126
127
60e705c5 128void nbd_tls_handshake(QIOTask *task,
f95910fe 129 void *opaque);
3736cc5b
EB
130const char *nbd_opt_lookup(uint32_t opt);
131const char *nbd_rep_lookup(uint32_t rep);
132const char *nbd_info_lookup(uint16_t info);
133const char *nbd_cmd_lookup(uint16_t info);
f95910fe 134
44298024
VSO
135int nbd_drop(QIOChannel *ioc, size_t size, Error **errp);
136
798bfe00 137#endif