include/linux/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  */
  12
  13 #ifndef LINUX_NBD_H
  14 #define LINUX_NBD_H
  15
  16 #define NBD_SET_SOCK    _IO( 0xab, 0 )
  17 #define NBD_SET_BLKSIZE _IO( 0xab, 1 )
  18 #define NBD_SET_SIZE    _IO( 0xab, 2 )
  19 #define NBD_DO_IT       _IO( 0xab, 3 )
  20 #define NBD_CLEAR_SOCK  _IO( 0xab, 4 )
  21 #define NBD_CLEAR_QUE   _IO( 0xab, 5 )
  22 #define NBD_PRINT_DEBUG _IO( 0xab, 6 )
  23 #define NBD_SET_SIZE_BLOCKS     _IO( 0xab, 7 )
  24 #define NBD_DISCONNECT  _IO( 0xab, 8 )
  25
  26 enum {
  27         NBD_CMD_READ = 0,
  28         NBD_CMD_WRITE = 1,
  29         NBD_CMD_DISC = 2
  30 };
  31
  32 #define nbd_cmd(req) ((req)->cmd[0])
  33 #define MAX_NBD 128
  34
  35 /* Define PARANOIA to include extra sanity checking code in here & driver */
  36 #define PARANOIA
  37
  38 struct nbd_device {
  39         int flags;
  40         int harderror;          /* Code of hard error                   */
  41 #define NBD_READ_ONLY 0x0001
  42 #define NBD_WRITE_NOCHK 0x0002
  43         struct socket * sock;
  44         struct file * file;     /* If == NULL, device is not ready, yet */
  45 #ifdef PARANOIA
  46         int magic;              /* FIXME: not if debugging is off       */
  47 #endif
  48         spinlock_t queue_lock;
  49         struct list_head queue_head;/* Requests are added here...       */
  50         struct semaphore tx_lock;
  51         struct gendisk *disk;
  52         int blksize;
  53         u64 bytesize;
  54 };
  55
  56 /* This now IS in some kind of include file...  */
  57
  58 /* These are send over network in request/reply magic field */
  59
  60 #define NBD_REQUEST_MAGIC 0x25609513
  61 #define NBD_REPLY_MAGIC 0x67446698
  62 /* Do *not* use magics: 0x12560953 0x96744668. */
  63
  64 /*
  65  * This is packet used for communication between client and
  66  * server. All data are in network byte order.
  67  */
  68 struct nbd_request {
  69         u32 magic;
  70         u32 type;       /* == READ || == WRITE  */
  71         char handle[8];
  72         u64 from;
  73         u32 len;
  74 }
  75 #ifdef __GNUC__
  76         __attribute__ ((packed))
  77 #endif
  78 ;
  79
  80 struct nbd_reply {
  81         u32 magic;
  82         u32 error;              /* 0 = ok, else error   */
  83         char handle[8];         /* handle you got from request  */
  84 };
  85 #endif