blob: 91895106a951f1d2318ec2331bb29297b9f4a132 [file] [log] [blame]
Fam Zheng798bfe02016-01-14 16:41:02 +08001/*
2 * NBD Internal Declarations
3 *
Eric Blaked95ffb62023-08-29 12:58:30 -05004 * Copyright Red Hat
Fam Zheng798bfe02016-01-14 16:41:02 +08005 *
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"
Daniel P. Berrangef95910f2016-02-10 18:41:11 +000014#include "io/channel-tls.h"
Fam Zheng798bfe02016-01-14 16:41:02 +080015
Daniel P. Berrange1c778ef2016-02-10 18:41:04 +000016#include "qemu/iov.h"
Fam Zheng798bfe02016-01-14 16:41:02 +080017
Fam Zheng798bfe02016-01-14 16:41:02 +080018#ifndef _WIN32
19#include <sys/ioctl.h>
20#endif
Thomas Huthded5d782020-11-14 11:10:11 +010021#ifdef HAVE_SYS_IOCCOM_H
Fam Zheng798bfe02016-01-14 16:41:02 +080022#include <sys/ioccom.h>
23#endif
Fam Zheng798bfe02016-01-14 16:41:02 +080024
25#ifdef __linux__
26#include <linux/fs.h>
27#endif
28
Paolo Bonzini58369e22016-03-15 17:22:36 +010029#include "qemu/bswap.h"
Fam Zheng798bfe02016-01-14 16:41:02 +080030
Fam Zheng798bfe02016-01-14 16:41:02 +080031/* This is all part of the "official" NBD API.
32 *
33 * The most up-to-date documentation is available at:
Eric Blakeb626b512016-10-14 13:33:04 -050034 * https://github.com/yoe/nbd/blob/master/doc/proto.md
Fam Zheng798bfe02016-01-14 16:41:02 +080035 */
36
Eric Blakec8720ca2023-09-25 14:22:32 -050037/* Size of all compact NBD_CMD_*, without payload */
Eric Blake5f66d062017-07-17 14:26:35 -050038#define NBD_REQUEST_SIZE (4 + 2 + 2 + 8 + 8 + 4)
Eric Blakec8720ca2023-09-25 14:22:32 -050039/* Size of all extended NBD_CMD_*, without payload */
40#define NBD_EXTENDED_REQUEST_SIZE (4 + 2 + 2 + 8 + 8 + 8)
41
Eric Blake8ecaeae2017-07-07 15:30:47 -050042/* Size of all NBD_REP_* sent in answer to most NBD_OPT_*, without payload */
Eric Blake5f66d062017-07-17 14:26:35 -050043#define NBD_REPLY_SIZE (4 + 4 + 8)
44/* Size of reply to NBD_OPT_EXPORT_NAME */
45#define NBD_REPLY_EXPORT_NAME_SIZE (8 + 2 + 124)
46/* Size of oldstyle negotiation */
47#define NBD_OLDSTYLE_NEGOTIATE_SIZE (8 + 8 + 8 + 4 + 124)
Eric Blake8ecaeae2017-07-07 15:30:47 -050048
Eric Blakeef2e35f2018-12-15 07:53:10 -060049#define NBD_INIT_MAGIC 0x4e42444d41474943LL /* ASCII "NBDMAGIC" */
Eric Blakeef2e35f2018-12-15 07:53:10 -060050#define NBD_OPTS_MAGIC 0x49484156454F5054LL /* ASCII "IHAVEOPT" */
Vladimir Sementsov-Ogievskiy92652b12017-10-12 12:53:14 +030051#define NBD_CLIENT_MAGIC 0x0000420281861253LL
52#define NBD_REP_MAGIC 0x0003e889045565a9LL
Fam Zheng798bfe02016-01-14 16:41:02 +080053
Vladimir Sementsov-Ogievskiy92652b12017-10-12 12:53:14 +030054#define NBD_SET_SOCK _IO(0xab, 0)
55#define NBD_SET_BLKSIZE _IO(0xab, 1)
56#define NBD_SET_SIZE _IO(0xab, 2)
57#define NBD_DO_IT _IO(0xab, 3)
58#define NBD_CLEAR_SOCK _IO(0xab, 4)
59#define NBD_CLEAR_QUE _IO(0xab, 5)
60#define NBD_PRINT_DEBUG _IO(0xab, 6)
61#define NBD_SET_SIZE_BLOCKS _IO(0xab, 7)
62#define NBD_DISCONNECT _IO(0xab, 8)
63#define NBD_SET_TIMEOUT _IO(0xab, 9)
64#define NBD_SET_FLAGS _IO(0xab, 10)
Fam Zheng798bfe02016-01-14 16:41:02 +080065
Vladimir Sementsov-Ogievskiyd1fdf252017-06-02 18:01:39 +030066/* nbd_write
Vladimir Sementsov-Ogievskiyf5d406f2017-05-16 12:45:30 +030067 * Writes @size bytes to @ioc. Returns 0 on success.
68 */
Vladimir Sementsov-Ogievskiyd1fdf252017-06-02 18:01:39 +030069static inline int nbd_write(QIOChannel *ioc, const void *buffer, size_t size,
70 Error **errp)
Fam Zheng798bfe02016-01-14 16:41:02 +080071{
Eric Blake030fa7f2017-09-05 14:11:14 -050072 return qio_channel_write_all(ioc, buffer, size, errp) < 0 ? -EIO : 0;
Fam Zheng798bfe02016-01-14 16:41:02 +080073}
74
Vladimir Sementsov-Ogievskiy44298022017-06-02 18:01:40 +030075int nbd_drop(QIOChannel *ioc, size_t size, Error **errp);
76
Fam Zheng798bfe02016-01-14 16:41:02 +080077#endif