nbd.h

   1 /*
   2  * 1999 Copyright (C) Pavel Machek, pavel@ucw.cz. This code is GPL.
   3  * 1999/11/04 Copyright (C) 1999 VMware, Inc. (Regis "HPReg" Duchesne)
   4  *            Made nbd_end_request() use the io_request_lock
   5  * 2001 Copyright (C) Steven Whitehouse
   6  *            New nbd_end_request() for compatibility with new linux block
   7  *            layer code.
   8  * 2003/06/24 Louis D. Langholtz <ldl@aros.net>
   9  *            Removed unneeded blksize_bits field from nbd_device struct.
  10  *            Cleanup PARANOIA usage & code.
  11  * 2004/02/19 Paul Clements
  12  *            Removed PARANOIA, plus various cleanup and comments
  13  */
  14
  15 #ifndef LINUX_NBD_H
  16 #define LINUX_NBD_H
  17
  18 #include <linux/types.h>
  19
  20 #define NBD_SET_SOCK    _IO( 0xab, 0 )
  21 #define NBD_SET_BLKSIZE _IO( 0xab, 1 )
  22 #define NBD_SET_SIZE    _IO( 0xab, 2 )
  23 #define NBD_DO_IT       _IO( 0xab, 3 )
  24 #define NBD_CLEAR_SOCK  _IO( 0xab, 4 )
  25 #define NBD_CLEAR_QUE   _IO( 0xab, 5 )
  26 #define NBD_PRINT_DEBUG _IO( 0xab, 6 )
  27 #define NBD_SET_SIZE_BLOCKS     _IO( 0xab, 7 )
  28 #define NBD_DISCONNECT  _IO( 0xab, 8 )
  29 #define NBD_SET_TIMEOUT _IO( 0xab, 9 )
  30 #define NBD_SET_FLAGS _IO( 0xab, 10 )
  31
  32 enum {
  33         NBD_CMD_READ = 0,
  34         NBD_CMD_WRITE = 1,
  35         NBD_CMD_DISC = 2,
  36         NBD_CMD_FLUSH = 3
  37 };
  38
  39 #define NBD_CMD_MASK_COMMAND 0x0000ffff
  40 #define NBD_CMD_FLAG_FUA (1<<16)
  41
  42 /* values for flags field */
  43 #define NBD_FLAG_HAS_FLAGS      (1 << 0)        /* Flags are there */
  44 #define NBD_FLAG_READ_ONLY      (1 << 1)        /* Device is read-only */
  45 #define NBD_FLAG_SEND_FLUSH     (1 << 2)        /* Send FLUSH */
  46 #define NBD_FLAG_SEND_FUA       (1 << 3)        /* Send FUA (Force Unit Access) */
  47 #define NBD_FLAG_ROTATIONAL     (1 << 4)        /* Use elevator algorithm - rotational media */
  48
  49 #define nbd_cmd(req) ((req)->cmd[0])
  50
  51 /* userspace doesn't need the nbd_device structure */
  52 #ifdef __KERNEL__
  53
  54 #include <linux/wait.h>
  55 #include <linux/mutex.h>
  56
  57 struct request;
  58
  59 struct nbd_device {
  60         int flags;
  61         int harderror;          /* Code of hard error                   */
  62         struct socket * sock;
  63         struct file * file;     /* If == NULL, device is not ready, yet */
  64         int magic;
  65
  66         spinlock_t queue_lock;
  67         struct list_head queue_head;    /* Requests waiting result */
  68         struct request *active_req;
  69         wait_queue_head_t active_wq;
  70         struct list_head waiting_queue; /* Requests to be sent */
  71         wait_queue_head_t waiting_wq;
  72
  73         struct mutex tx_lock;
  74         struct gendisk *disk;
  75         int blksize;
  76         u64 bytesize;
  77         pid_t pid; /* pid of nbd-client, if attached */
  78         int xmit_timeout;
  79 };
  80
  81 #endif
  82
  83 /* These are sent over the network in the request/reply magic fields */
  84
  85 #define NBD_REQUEST_MAGIC 0x25609513
  86 #define NBD_REPLY_MAGIC 0x67446698
  87 /* Do *not* use magics: 0x12560953 0x96744668. */
  88
  89 /*
  90  * This is the packet used for communication between client and
  91  * server. All data are in network byte order.
  92  */
  93 struct nbd_request {
  94         __be32 magic;
  95         __be32 type;    /* == READ || == WRITE  */
  96         char handle[8];
  97         __be64 from;
  98         __be32 len;
  99 } __attribute__((packed));
 100
 101 /*
 102  * This is the reply packet that nbd-server sends back to the client after
 103  * it has completed an I/O request (or an error occurs).
 104  */
 105 struct nbd_reply {
 106         __be32 magic;
 107         __be32 error;           /* 0 = ok, else error   */
 108         char handle[8];         /* handle you got from request  */
 109 };
 110 #endif