xref: /qemu/nbd/nbd-internal.h (revision e2c1c34f139f49ef909bb4322607fb8b39002312)
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"
14  #include "io/channel-tls.h"
15  
16  #include "qemu/iov.h"
17  
18  #ifndef _WIN32
19  #include <sys/ioctl.h>
20  #endif
21  #ifdef HAVE_SYS_IOCCOM_H
22  #include <sys/ioccom.h>
23  #endif
24  
25  #ifdef __linux__
26  #include <linux/fs.h>
27  #endif
28  
29  #include "qemu/bswap.h"
30  
31  /* This is all part of the "official" NBD API.
32   *
33   * The most up-to-date documentation is available at:
34   * https://github.com/yoe/nbd/blob/master/doc/proto.md
35   */
36  
37  /* Size of all NBD_OPT_*, without payload */
38  #define NBD_REQUEST_SIZE            (4 + 2 + 2 + 8 + 8 + 4)
39  /* Size of all NBD_REP_* sent in answer to most NBD_OPT_*, without payload */
40  #define NBD_REPLY_SIZE              (4 + 4 + 8)
41  /* Size of reply to NBD_OPT_EXPORT_NAME */
42  #define NBD_REPLY_EXPORT_NAME_SIZE  (8 + 2 + 124)
43  /* Size of oldstyle negotiation */
44  #define NBD_OLDSTYLE_NEGOTIATE_SIZE (8 + 8 + 8 + 4 + 124)
45  
46  #define NBD_INIT_MAGIC              0x4e42444d41474943LL /* ASCII "NBDMAGIC" */
47  #define NBD_REQUEST_MAGIC           0x25609513
48  #define NBD_OPTS_MAGIC              0x49484156454F5054LL /* ASCII "IHAVEOPT" */
49  #define NBD_CLIENT_MAGIC            0x0000420281861253LL
50  #define NBD_REP_MAGIC               0x0003e889045565a9LL
51  
52  #define NBD_SET_SOCK                _IO(0xab, 0)
53  #define NBD_SET_BLKSIZE             _IO(0xab, 1)
54  #define NBD_SET_SIZE                _IO(0xab, 2)
55  #define NBD_DO_IT                   _IO(0xab, 3)
56  #define NBD_CLEAR_SOCK              _IO(0xab, 4)
57  #define NBD_CLEAR_QUE               _IO(0xab, 5)
58  #define NBD_PRINT_DEBUG             _IO(0xab, 6)
59  #define NBD_SET_SIZE_BLOCKS         _IO(0xab, 7)
60  #define NBD_DISCONNECT              _IO(0xab, 8)
61  #define NBD_SET_TIMEOUT             _IO(0xab, 9)
62  #define NBD_SET_FLAGS               _IO(0xab, 10)
63  
64  /* nbd_write
65   * Writes @size bytes to @ioc. Returns 0 on success.
66   */
67  static inline int nbd_write(QIOChannel *ioc, const void *buffer, size_t size,
68                              Error **errp)
69  {
70      return qio_channel_write_all(ioc, buffer, size, errp) < 0 ? -EIO : 0;
71  }
72  
73  struct NBDTLSHandshakeData {
74      GMainLoop *loop;
75      bool complete;
76      Error *error;
77  };
78  
79  
80  void nbd_tls_handshake(QIOTask *task,
81                         void *opaque);
82  
83  int nbd_drop(QIOChannel *ioc, size_t size, Error **errp);
84  
85  #endif
86