1/*-
2 * Copyright (c) 2013  Peter Grehan <grehan@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD$
27 */
28
29/*
30 * The block API to be used by bhyve block-device emulations. The routines
31 * are thread safe, with no assumptions about the context of the completion
32 * callback - it may occur in the caller's context, or asynchronously in
33 * another thread.
34 */
35
36#ifndef _BLOCK_IF_H_
37#define _BLOCK_IF_H_
38
39#include <sys/uio.h>
40#include <sys/unistd.h>
41
42#define BLOCKIF_IOV_MAX		32	/* not practical to be IOV_MAX */
43
44struct blockif_req {
45	struct iovec	br_iov[BLOCKIF_IOV_MAX];
46	int		br_iovcnt;
47	off_t		br_offset;
48	void		(*br_callback)(struct blockif_req *req, int err);
49	void		*br_param;
50};
51
52struct blockif_ctxt;
53struct blockif_ctxt *blockif_open(const char *optstr, const char *ident);
54off_t	blockif_size(struct blockif_ctxt *bc);
55int	blockif_sectsz(struct blockif_ctxt *bc);
56int	blockif_queuesz(struct blockif_ctxt *bc);
57int	blockif_is_ro(struct blockif_ctxt *bc);
58int	blockif_read(struct blockif_ctxt *bc, struct blockif_req *breq);
59int	blockif_write(struct blockif_ctxt *bc, struct blockif_req *breq);
60int	blockif_flush(struct blockif_ctxt *bc, struct blockif_req *breq);
61int	blockif_cancel(struct blockif_ctxt *bc, struct blockif_req *breq);
62int	blockif_close(struct blockif_ctxt *bc);
63
64#endif /* _BLOCK_IF_H_ */
65