2012-10-13 16:46:48 +07:00
|
|
|
/*
|
|
|
|
* 1999 Copyright (C) Pavel Machek, pavel@ucw.cz. This code is GPL.
|
|
|
|
* 1999/11/04 Copyright (C) 1999 VMware, Inc. (Regis "HPReg" Duchesne)
|
|
|
|
* Made nbd_end_request() use the io_request_lock
|
|
|
|
* 2001 Copyright (C) Steven Whitehouse
|
|
|
|
* New nbd_end_request() for compatibility with new linux block
|
|
|
|
* layer code.
|
|
|
|
* 2003/06/24 Louis D. Langholtz <ldl@aros.net>
|
|
|
|
* Removed unneeded blksize_bits field from nbd_device struct.
|
|
|
|
* Cleanup PARANOIA usage & code.
|
|
|
|
* 2004/02/19 Paul Clements
|
|
|
|
* Removed PARANOIA, plus various cleanup and comments
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _UAPILINUX_NBD_H
|
|
|
|
#define _UAPILINUX_NBD_H
|
|
|
|
|
|
|
|
#include <linux/types.h>
|
|
|
|
|
|
|
|
#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)
|
|
|
|
|
|
|
|
enum {
|
|
|
|
NBD_CMD_READ = 0,
|
|
|
|
NBD_CMD_WRITE = 1,
|
|
|
|
NBD_CMD_DISC = 2,
|
nbd: support FLUSH requests
Currently, the NBD device does not accept flush requests from the Linux
block layer. If the NBD server opened the target with neither O_SYNC nor
O_DSYNC, however, the device will be effectively backed by a writeback
cache. Without issuing flushes properly, operation of the NBD device will
not be safe against power losses.
The NBD protocol has support for both a cache flush command and a FUA
command flag; the server will also pass a flag to note its support for
these features. This patch adds support for the cache flush command and
flag. In the kernel, we receive the flags via the NBD_SET_FLAGS ioctl,
and map NBD_FLAG_SEND_FLUSH to the argument of blk_queue_flush. When the
flag is active the block layer will send REQ_FLUSH requests, which we
translate to NBD_CMD_FLUSH commands.
FUA support is not included in this patch because all free software
servers implement it with a full fdatasync; thus it has no advantage over
supporting flush only. Because I [Paolo] cannot really benchmark it in a
realistic scenario, I cannot tell if it is a good idea or not. It is also
not clear if it is valid for an NBD server to support FUA but not flush.
The Linux block layer gives a warning for this combination, the NBD
protocol documentation says nothing about it.
The patch also fixes a small problem in the handling of flags: nbd->flags
must be cleared at the end of NBD_DO_IT, but the driver was not doing
that. The bug manifests itself as follows. Suppose you two different
client/server pairs to start the NBD device. Suppose also that the first
client supports NBD_SET_FLAGS, and the first server sends
NBD_FLAG_SEND_FLUSH; the second pair instead does neither of these two
things. Before this patch, the second invocation of NBD_DO_IT will use a
stale value of nbd->flags, and the second server will issue an error every
time it receives an NBD_CMD_FLUSH command.
This bug is pre-existing, but it becomes much more important after this
patch; flush failures make the device pretty much unusable, unlike
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Alex Bligh <alex@alex.org.uk>
Acked-by: Paul Clements <Paul.Clements@steeleye.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2013-02-28 08:05:23 +07:00
|
|
|
NBD_CMD_FLUSH = 3,
|
2012-10-13 16:46:48 +07:00
|
|
|
NBD_CMD_TRIM = 4
|
|
|
|
};
|
|
|
|
|
2017-04-07 04:02:07 +07:00
|
|
|
/* values for flags field, these are server interaction specific. */
|
2016-11-23 02:04:40 +07:00
|
|
|
#define NBD_FLAG_HAS_FLAGS (1 << 0) /* nbd-server supports flags */
|
|
|
|
#define NBD_FLAG_READ_ONLY (1 << 1) /* device is read-only */
|
|
|
|
#define NBD_FLAG_SEND_FLUSH (1 << 2) /* can flush writeback cache */
|
2012-10-13 16:46:48 +07:00
|
|
|
/* there is a gap here to match userspace */
|
2016-11-23 02:04:40 +07:00
|
|
|
#define NBD_FLAG_SEND_TRIM (1 << 5) /* send trim/discard */
|
2016-11-23 03:09:50 +07:00
|
|
|
#define NBD_FLAG_CAN_MULTI_CONN (1 << 8) /* Server supports multiple connections per export. */
|
2012-10-13 16:46:48 +07:00
|
|
|
|
2017-04-07 04:02:07 +07:00
|
|
|
/* These are client behavior specific flags. */
|
|
|
|
#define NBD_CFLAG_DESTROY_ON_DISCONNECT (1 << 0) /* delete the nbd device on
|
|
|
|
disconnect. */
|
|
|
|
|
2012-10-13 16:46:48 +07:00
|
|
|
/* userspace doesn't need the nbd_device structure */
|
|
|
|
|
|
|
|
/* These are sent over the network in the request/reply magic fields */
|
|
|
|
|
|
|
|
#define NBD_REQUEST_MAGIC 0x25609513
|
|
|
|
#define NBD_REPLY_MAGIC 0x67446698
|
|
|
|
/* Do *not* use magics: 0x12560953 0x96744668. */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This is the packet used for communication between client and
|
|
|
|
* server. All data are in network byte order.
|
|
|
|
*/
|
|
|
|
struct nbd_request {
|
|
|
|
__be32 magic;
|
|
|
|
__be32 type; /* == READ || == WRITE */
|
|
|
|
char handle[8];
|
|
|
|
__be64 from;
|
|
|
|
__be32 len;
|
|
|
|
} __attribute__((packed));
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This is the reply packet that nbd-server sends back to the client after
|
|
|
|
* it has completed an I/O request (or an error occurs).
|
|
|
|
*/
|
|
|
|
struct nbd_reply {
|
|
|
|
__be32 magic;
|
|
|
|
__be32 error; /* 0 = ok, else error */
|
|
|
|
char handle[8]; /* handle you got from request */
|
|
|
|
};
|
|
|
|
#endif /* _UAPILINUX_NBD_H */
|