2 * Copyright (c) 2004,2005 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Hiten Pandya <hmp@backplane.com> and Matthew Dillon
6 * <dillon@backplane.com>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * The MSF_BUF API is an augmentation similar to the SFBUF APIs and uses XIO
36 * page array handling. The SFBUF API originally came from:
38 * Copyright (c) 2003 Alan L. Cox <alc@cs.rice.edu>. All rights reserved.
39 * Copyright (c) 1998 David Greenman. All rights reserved.
40 * src/sys/sys/sfbuf.h,v 1.4 2004/04/01 17:58:06 dillon
42 * $DragonFly: src/sys/sys/msfbuf.h,v 1.9 2005/03/04 05:20:29 dillon Exp $
44 #ifndef _SYS_MSFBUF_H_
45 #define _SYS_MSFBUF_H_
47 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
48 #error "This file should not be included by userland programs."
52 #include <sys/queue.h>
59 #if defined(MALLOC_DECLARE)
60 MALLOC_DECLARE(M_MSFBUF);
64 * MSF_BUFs are used for caching ephermal mappings that span more than
67 * The interface returns an msf_buf data structure which has information
68 * about managing the ephermal mapping, its KVA pointer and an embedded
69 * XIO structure which describes the mapping.
71 * The embedded XIO structure be passed around to the DEV system because
72 * it is ref-counted; thus making it perfectly usable by anything that
73 * can accept an XIO as a transfer unit, most notably the buffer-cache
81 * MSF_TYPE_PGLIST - mapping based on raw list of pages.
82 * MSF_TYPE_XIO - mapping based on an XIO.
83 * MSF_TYPE_UBUF - mapping based on an arbitrary user buffer.
84 * MSF_TYPE_KBUF - mapping based on an arbitrary kernel buffer.
86 enum msf_type { MSF_TYPE_UNKNOWN, MSF_TYPE_PGLIST, MSF_TYPE_XIO,
87 MSF_TYPE_UBUF, MSF_TYPE_KBUF };
90 TAILQ_ENTRY(msf_buf) free_list; /* free list of buffers */
91 vm_offset_t ms_kva; /* KVA offset */
92 cpumask_t ms_cpumask; /* CPU mask for synchronization */
93 struct xio *ms_xio; /* xio being used */
94 struct xio ms_internal_xio;/* xio embedded */
95 int ms_refcnt; /* map usage tracking */
96 int ms_flags; /* control flags */
97 enum msf_type ms_type; /* type of mapped data */
101 #define MSF_ONFREEQ 0x0001 /* currently on the freelist */
102 #define MSF_CATCH 0x0004 /* allow interruption */
103 #define MSF_CPUPRIVATE 0x0008 /* sync mapping to current cpu only */
108 * Return a KVA offset to the client
112 msf_buf_kva(struct msf_buf *msf)
114 return ((char *)msf->ms_kva + msf->ms_xio->xio_offset);
118 * Return a reference to the underlying pages of an MSF_BUF
122 msf_buf_pages(struct msf_buf *msf)
124 return (msf->ms_xio->xio_pages);
127 /* API function prototypes */
128 int msf_map_pagelist(struct msf_buf **, struct vm_page **, int, int);
129 int msf_map_xio(struct msf_buf **, struct xio *, int);
130 int msf_map_ubuf(struct msf_buf **, void *, size_t, int);
131 int msf_map_kbuf(struct msf_buf **, void *, size_t, int);
132 int msf_uio_iterate(struct uio *uio,
133 int (*callback)(void *info, char *buf, int bytes), void *info);
134 void msf_buf_free(struct msf_buf *);
135 void msf_buf_ref(struct msf_buf *);