sys/sys/msfbuf.h

   1 /*
   2  * Copyright (c) 2004 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.7 2005/03/01 06:18:18 hmp 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 struct msf_buf {
  79         LIST_ENTRY(msf_buf)  active_list; /* active list of buffers */
  80         TAILQ_ENTRY(msf_buf) free_list;   /* free list of buffers */
  81         vm_offset_t     m_kva;                /* KVA offset */
  82         cpumask_t       m_cpumask;            /* CPU mask for synchronization */
  83         struct xio      m_xio;                /* xio embedded */
  84         int             m_refcnt;             /* map usage tracking */
  85         int             m_flags;              /* control flags */
  86 };
  87
  88 #if defined(_KERNEL)
  89
  90 /*
  91  * Return a KVA offset to the client
  92  */
  93 static __inline
  94 vm_offset_t
  95 msf_buf_kva(struct msf_buf *msf)
  96 {
  97         return (msf->m_kva);
  98 }
  99
 100 /*
 101  * Return a reference to the underlying pages of an MSF_BUF
 102  */
 103 static __inline
 104 vm_page_t *
 105 msf_buf_pages(struct msf_buf *msf)
 106 {
 107         return (msf->m_xio.xio_pages);
 108 }
 109
 110 /* API function prototypes */
 111 struct msf_buf  *msf_buf_alloc(vm_page_t *, int, int);
 112 void    msf_buf_free(struct msf_buf *);
 113 void    msf_buf_ref(struct msf_buf *);
 114
 115 #endif /* _KERNEL */
 116
 117 #endif