Change sendfile() to use the new m_ext callback scheme for cleaning up after
[dragonfly.git] / sys / sys / xio.h
1 /*
2  * Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  * 
34  * $DragonFly: src/sys/sys/xio.h,v 1.5 2004/07/16 05:51:57 dillon Exp $
35  */
36
37 /*
38  * The XIO structure is intended to replace UIO for messaged I/O operations
39  * within the kernel.  The originator of the transaction must supply an XIO
40  * structure containing a list of appropriate held vm_page's representing
41  * the buffer.  The target of the transaction will generally map the
42  * pages using the SF_BUF facility, complete the operation, and reply the
43  * message.
44  */
45 #ifndef _SYS_XIO_H_
46 #define _SYS_XIO_H_
47
48 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
49
50 #ifndef _SYS_MSGPORT_H_
51 #include <sys/msgport.h>
52 #endif
53
54 #define XIO_INTERNAL_PAGES      btoc(MAXPHYS)
55 #define XIO_INTERNAL_SIZE       (XIO_INTERNAL_PAGES * PAGE_SIZE)
56
57 struct vm_page;
58
59 struct xio {
60         struct vm_page **xio_pages;
61         int     xio_npages;     /* number of pages in xio_pages[] array */
62         int     xio_offset;     /* byte offset (may exceed a page) */
63         int     xio_bytes;      /* number of bytes to transfer */
64         int     xio_flags;
65         int     xio_error;
66         struct vm_page *xio_internal_pages[XIO_INTERNAL_PAGES];
67 };
68
69 typedef struct xio *xio_t;
70
71 #define XIOF_READ       0x0001
72 #define XIOF_WRITE      0x0002
73 #define XIOF_LINMAP     0x0004
74
75 #endif
76
77 #if defined(_KERNEL)
78
79 void xio_init(xio_t xio);
80 int xio_init_ubuf(xio_t xio, void *ubase, size_t ubytes, int vmprot);
81 int xio_init_kbuf(xio_t xio, void *kbase, size_t kbytes);
82 void xio_release(xio_t xio);
83 int xio_uio_copy(xio_t xio, struct uio *uio, int *sizep);
84 int xio_copy_xtou(xio_t xio, void *uptr, int bytes);
85 int xio_copy_xtok(xio_t xio, void *kptr, int bytes);
86
87 #endif /* _KERNEL */
88
89 #endif /* !_SYS_XIO_H_ */