sys/sys/msfbuf.h

   1 /*
   2  * Copyright (c) 2004,2005 The DragonFly Project.  All rights reserved.
   3  *
   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>.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  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
  17  *    distribution.
  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.
  21  *
  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
  33  * SUCH DAMAGE.
  34  *
  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:
  37  *
  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
  41  *
  42  * $DragonFly: src/sys/sys/msfbuf.h,v 1.11 2005/03/05 05:04:32 dillon Exp $
  43  */
  44 #ifndef _SYS_MSFBUF_H_
  45 #define _SYS_MSFBUF_H_
  46
  47 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
  48 #error "This file should not be included by userland programs."
  49 #endif
  50
  51 #ifndef _SYS_QUEUE_H_
  52 #include <sys/queue.h>
  53 #endif
  54
  55 #ifndef _SYS_XIO_H_
  56 #include <sys/xio.h>
  57 #endif
  58
  59 #if defined(MALLOC_DECLARE)
  60 MALLOC_DECLARE(M_MSFBUF);
  61 #endif
  62
  63 /*
  64  * MSF_BUFs are used for caching ephermal mappings that span more than
  65  * one page.
  66  *
  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.
  70  *
  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
  74  * and the XIO API.
  75  *
  76  */
  77
  78 /*
  79  * Type of mapping.
  80  *
  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.
  85  */
  86 enum msf_type { MSF_TYPE_UNKNOWN, MSF_TYPE_PGLIST, MSF_TYPE_XIO,
  87                                 MSF_TYPE_UBUF, MSF_TYPE_KBUF };
  88
  89 struct msf_buf {
  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  */
  98 };
  99
 100 /* Flags. */
 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 */
 104
 105 typedef struct msf_buf  *msf_t;
 106
 107 #if defined(_KERNEL)
 108
 109 /*
 110  * Return a KVA offset to the client
 111  */
 112 static __inline
 113 char *
 114 msf_buf_kva(struct msf_buf *msf)
 115 {
 116         return ((char *)msf->ms_kva + msf->ms_xio->xio_offset);
 117 }
 118
 119 static __inline
 120 int
 121 msf_buf_bytes(struct msf_buf *msf)
 122 {
 123         return (msf->ms_xio->xio_bytes);
 124 }
 125
 126 /*
 127  * Return a reference to the underlying pages of an MSF_BUF
 128  */
 129 static __inline
 130 struct vm_page **
 131 msf_buf_pages(struct msf_buf *msf)
 132 {
 133         return (msf->ms_xio->xio_pages);
 134 }
 135
 136 /* API function prototypes */
 137 int msf_map_pagelist(struct msf_buf **, struct vm_page **, int, int);
 138 int msf_map_xio(struct msf_buf **, struct xio *, int);
 139 int msf_map_ubuf(struct msf_buf **, void *, size_t, int);
 140 int msf_map_kbuf(struct msf_buf **, void *, size_t, int);
 141 int msf_uio_iterate(struct uio *uio,
 142                 int (*callback)(void *info, char *buf, int bytes), void *info);
 143 void    msf_buf_free(struct msf_buf *);
 144 void    msf_buf_ref(struct msf_buf *);
 145
 146 #endif /* _KERNEL */
 147
 148 #endif