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/coroutine.h" 17 #include "qemu/iov.h" 18 19 #ifndef _WIN32 20 #include <sys/ioctl.h> 21 #endif 22 #if defined(__sun__) || defined(__HAIKU__) 23 #include <sys/ioccom.h> 24 #endif 25 26 #ifdef __linux__ 27 #include <linux/fs.h> 28 #endif 29 30 #include "qemu/queue.h" 31 #include "qemu/main-loop.h" 32 33 /* #define DEBUG_NBD */ 34 35 #ifdef DEBUG_NBD 36 #define DEBUG_NBD_PRINT 1 37 #else 38 #define DEBUG_NBD_PRINT 0 39 #endif 40 41 #define TRACE(msg, ...) do { \ 42 if (DEBUG_NBD_PRINT) { \ 43 LOG(msg, ## __VA_ARGS__); \ 44 } \ 45 } while (0) 46 47 #define LOG(msg, ...) do { \ 48 fprintf(stderr, "%s:%s():L%d: " msg "\n", \ 49 __FILE__, __FUNCTION__, __LINE__, ## __VA_ARGS__); \ 50 } while (0) 51 52 /* This is all part of the "official" NBD API. 53 * 54 * The most up-to-date documentation is available at: 55 * https://github.com/yoe/nbd/blob/master/doc/proto.txt 56 */ 57 58 #define NBD_REQUEST_SIZE (4 + 4 + 8 + 8 + 4) 59 #define NBD_REPLY_SIZE (4 + 4 + 8) 60 #define NBD_REQUEST_MAGIC 0x25609513 61 #define NBD_REPLY_MAGIC 0x67446698 62 #define NBD_OPTS_MAGIC 0x49484156454F5054LL 63 #define NBD_CLIENT_MAGIC 0x0000420281861253LL 64 #define NBD_REP_MAGIC 0x3e889045565a9LL 65 66 #define NBD_SET_SOCK _IO(0xab, 0) 67 #define NBD_SET_BLKSIZE _IO(0xab, 1) 68 #define NBD_SET_SIZE _IO(0xab, 2) 69 #define NBD_DO_IT _IO(0xab, 3) 70 #define NBD_CLEAR_SOCK _IO(0xab, 4) 71 #define NBD_CLEAR_QUE _IO(0xab, 5) 72 #define NBD_PRINT_DEBUG _IO(0xab, 6) 73 #define NBD_SET_SIZE_BLOCKS _IO(0xab, 7) 74 #define NBD_DISCONNECT _IO(0xab, 8) 75 #define NBD_SET_TIMEOUT _IO(0xab, 9) 76 #define NBD_SET_FLAGS _IO(0xab, 10) 77 78 #define NBD_OPT_EXPORT_NAME (1) 79 #define NBD_OPT_ABORT (2) 80 #define NBD_OPT_LIST (3) 81 #define NBD_OPT_PEEK_EXPORT (4) 82 #define NBD_OPT_STARTTLS (5) 83 84 /* NBD errors are based on errno numbers, so there is a 1:1 mapping, 85 * but only a limited set of errno values is specified in the protocol. 86 * Everything else is squashed to EINVAL. 87 */ 88 #define NBD_SUCCESS 0 89 #define NBD_EPERM 1 90 #define NBD_EIO 5 91 #define NBD_ENOMEM 12 92 #define NBD_EINVAL 22 93 #define NBD_ENOSPC 28 94 95 static inline ssize_t read_sync(QIOChannel *ioc, void *buffer, size_t size) 96 { 97 struct iovec iov = { .iov_base = buffer, .iov_len = size }; 98 /* Sockets are kept in blocking mode in the negotiation phase. After 99 * that, a non-readable socket simply means that another thread stole 100 * our request/reply. Synchronization is done with recv_coroutine, so 101 * that this is coroutine-safe. 102 */ 103 return nbd_wr_syncv(ioc, &iov, 1, 0, size, true); 104 } 105 106 static inline ssize_t write_sync(QIOChannel *ioc, void *buffer, size_t size) 107 { 108 struct iovec iov = { .iov_base = buffer, .iov_len = size }; 109 110 return nbd_wr_syncv(ioc, &iov, 1, 0, size, false); 111 } 112 113 struct NBDTLSHandshakeData { 114 GMainLoop *loop; 115 bool complete; 116 Error *error; 117 }; 118 119 120 void nbd_tls_handshake(Object *src, 121 Error *err, 122 void *opaque); 123 124 #endif 125