d1fdf257d5
Rename
nbd_wr_syncv -> nbd_rwv
read_sync -> nbd_read
read_sync_eof -> nbd_read_eof
write_sync -> nbd_write
drop_sync -> nbd_drop
1. nbd_ prefix
read_sync and write_sync are already shared, so it is good to have a
namespace prefix. drop_sync will be shared, and read_sync_eof is
related to read_sync, so let's rename them all.
2. _sync suffix
_sync is related to the fact that nbd_wr_syncv doesn't return if a
write to socket returns EAGAIN. The first implementation of
nbd_wr_syncv (was wr_sync in 7a5ca8648b) just loops while getting
EAGAIN, the current implementation yields in this case.
Why we want to get rid of it:
- it is normal for r/w functions to be synchronous, so having an
additional suffix for it looks redundant (contrariwise, we have
_aio suffix for async functions)
- _sync suffix in block layer is used when function does flush (so
using it for other thing is confusing a bit)
- keep function names short after adding nbd_ prefix
3. for nbd_wr_syncv let's use more common notation 'rw'
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Message-Id: <20170602150150.258222-2-vsementsov@virtuozzo.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
157 lines
4.2 KiB
C
157 lines
4.2 KiB
C
/*
|
|
* NBD Internal Declarations
|
|
*
|
|
* Copyright (C) 2016 Red Hat, Inc.
|
|
*
|
|
* This work is licensed under the terms of the GNU GPL, version 2 or later.
|
|
* See the COPYING file in the top-level directory.
|
|
*/
|
|
|
|
#ifndef NBD_INTERNAL_H
|
|
#define NBD_INTERNAL_H
|
|
#include "block/nbd.h"
|
|
#include "sysemu/block-backend.h"
|
|
#include "io/channel-tls.h"
|
|
|
|
#include "qemu/coroutine.h"
|
|
#include "qemu/iov.h"
|
|
|
|
#ifndef _WIN32
|
|
#include <sys/ioctl.h>
|
|
#endif
|
|
#if defined(__sun__) || defined(__HAIKU__)
|
|
#include <sys/ioccom.h>
|
|
#endif
|
|
|
|
#ifdef __linux__
|
|
#include <linux/fs.h>
|
|
#endif
|
|
|
|
#include "qemu/bswap.h"
|
|
#include "qemu/queue.h"
|
|
#include "qemu/main-loop.h"
|
|
|
|
/* #define DEBUG_NBD */
|
|
|
|
#ifdef DEBUG_NBD
|
|
#define DEBUG_NBD_PRINT 1
|
|
#else
|
|
#define DEBUG_NBD_PRINT 0
|
|
#endif
|
|
|
|
#define TRACE(msg, ...) do { \
|
|
if (DEBUG_NBD_PRINT) { \
|
|
LOG(msg, ## __VA_ARGS__); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define LOG(msg, ...) do { \
|
|
fprintf(stderr, "%s:%s():L%d: " msg "\n", \
|
|
__FILE__, __FUNCTION__, __LINE__, ## __VA_ARGS__); \
|
|
} while (0)
|
|
|
|
/* This is all part of the "official" NBD API.
|
|
*
|
|
* The most up-to-date documentation is available at:
|
|
* https://github.com/yoe/nbd/blob/master/doc/proto.md
|
|
*/
|
|
|
|
#define NBD_REQUEST_SIZE (4 + 2 + 2 + 8 + 8 + 4)
|
|
#define NBD_REPLY_SIZE (4 + 4 + 8)
|
|
#define NBD_REQUEST_MAGIC 0x25609513
|
|
#define NBD_REPLY_MAGIC 0x67446698
|
|
#define NBD_OPTS_MAGIC 0x49484156454F5054LL
|
|
#define NBD_CLIENT_MAGIC 0x0000420281861253LL
|
|
#define NBD_REP_MAGIC 0x0003e889045565a9LL
|
|
|
|
#define NBD_SET_SOCK _IO(0xab, 0)
|
|
#define NBD_SET_BLKSIZE _IO(0xab, 1)
|
|
#define NBD_SET_SIZE _IO(0xab, 2)
|
|
#define NBD_DO_IT _IO(0xab, 3)
|
|
#define NBD_CLEAR_SOCK _IO(0xab, 4)
|
|
#define NBD_CLEAR_QUE _IO(0xab, 5)
|
|
#define NBD_PRINT_DEBUG _IO(0xab, 6)
|
|
#define NBD_SET_SIZE_BLOCKS _IO(0xab, 7)
|
|
#define NBD_DISCONNECT _IO(0xab, 8)
|
|
#define NBD_SET_TIMEOUT _IO(0xab, 9)
|
|
#define NBD_SET_FLAGS _IO(0xab, 10)
|
|
|
|
#define NBD_OPT_EXPORT_NAME (1)
|
|
#define NBD_OPT_ABORT (2)
|
|
#define NBD_OPT_LIST (3)
|
|
#define NBD_OPT_PEEK_EXPORT (4)
|
|
#define NBD_OPT_STARTTLS (5)
|
|
|
|
/* NBD errors are based on errno numbers, so there is a 1:1 mapping,
|
|
* but only a limited set of errno values is specified in the protocol.
|
|
* Everything else is squashed to EINVAL.
|
|
*/
|
|
#define NBD_SUCCESS 0
|
|
#define NBD_EPERM 1
|
|
#define NBD_EIO 5
|
|
#define NBD_ENOMEM 12
|
|
#define NBD_EINVAL 22
|
|
#define NBD_ENOSPC 28
|
|
#define NBD_ESHUTDOWN 108
|
|
|
|
/* nbd_read_eof
|
|
* Tries to read @size bytes from @ioc. Returns number of bytes actually read.
|
|
* May return a value >= 0 and < size only on EOF, i.e. when iteratively called
|
|
* qio_channel_readv() returns 0. So, there is no need to call nbd_read_eof
|
|
* iteratively.
|
|
*/
|
|
static inline ssize_t nbd_read_eof(QIOChannel *ioc, void *buffer, size_t size,
|
|
Error **errp)
|
|
{
|
|
struct iovec iov = { .iov_base = buffer, .iov_len = size };
|
|
/* Sockets are kept in blocking mode in the negotiation phase. After
|
|
* that, a non-readable socket simply means that another thread stole
|
|
* our request/reply. Synchronization is done with recv_coroutine, so
|
|
* that this is coroutine-safe.
|
|
*/
|
|
return nbd_rwv(ioc, &iov, 1, size, true, errp);
|
|
}
|
|
|
|
/* nbd_read
|
|
* Reads @size bytes from @ioc. Returns 0 on success.
|
|
*/
|
|
static inline int nbd_read(QIOChannel *ioc, void *buffer, size_t size,
|
|
Error **errp)
|
|
{
|
|
ssize_t ret = nbd_read_eof(ioc, buffer, size, errp);
|
|
|
|
if (ret >= 0 && ret != size) {
|
|
ret = -EINVAL;
|
|
error_setg(errp, "End of file");
|
|
}
|
|
|
|
return ret < 0 ? ret : 0;
|
|
}
|
|
|
|
/* nbd_write
|
|
* Writes @size bytes to @ioc. Returns 0 on success.
|
|
*/
|
|
static inline int nbd_write(QIOChannel *ioc, const void *buffer, size_t size,
|
|
Error **errp)
|
|
{
|
|
struct iovec iov = { .iov_base = (void *) buffer, .iov_len = size };
|
|
|
|
ssize_t ret = nbd_rwv(ioc, &iov, 1, size, false, errp);
|
|
|
|
assert(ret < 0 || ret == size);
|
|
|
|
return ret < 0 ? ret : 0;
|
|
}
|
|
|
|
struct NBDTLSHandshakeData {
|
|
GMainLoop *loop;
|
|
bool complete;
|
|
Error *error;
|
|
};
|
|
|
|
|
|
void nbd_tls_handshake(QIOTask *task,
|
|
void *opaque);
|
|
|
|
#endif
|