sys/sys/sf_buf.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2014 Gleb Smirnoff <glebius@FreeBSD.org>
   5  * Copyright (c) 2003-2004 Alan L. Cox <alc@cs.rice.edu>
   6  * All rights reserved.
   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  * 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 the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _SYS_SF_BUF_H_
  33 #define _SYS_SF_BUF_H_
  34
  35 struct sfstat {                         /* sendfile statistics */
  36         uint64_t        sf_syscalls;    /* times sendfile was called */
  37         uint64_t        sf_noiocnt;     /* times sendfile didn't require I/O */
  38         uint64_t        sf_iocnt;       /* times sendfile had to do disk I/O */
  39         uint64_t        sf_pages_read;  /* pages read as part of a request */
  40         uint64_t        sf_pages_valid; /* pages were valid for a request */
  41         uint64_t        sf_rhpages_requested;   /* readahead pages requested */
  42         uint64_t        sf_rhpages_read;        /* readahead pages read */
  43         uint64_t        sf_busy;        /* times aborted on a busy page */
  44         uint64_t        sf_allocfail;   /* times sfbuf allocation failed */
  45         uint64_t        sf_allocwait;   /* times sfbuf allocation had to wait */
  46         uint64_t        sf_pages_bogus; /* times bogus page was used */
  47 };
  48
  49 #ifdef _KERNEL
  50 #include <sys/types.h>
  51 #include <sys/systm.h>
  52 #include <sys/counter.h>
  53 #include <vm/vm.h>
  54 #include <vm/vm_param.h>
  55 #include <vm/vm_page.h>
  56
  57 /*
  58  * Sf_bufs, or sendfile(2) buffers provide a vm_page that is mapped
  59  * into kernel address space. Note, that they aren't used only
  60  * by sendfile(2)!
  61  *
  62  * Sf_bufs could be implemented as a feature of vm_page_t, but that
  63  * would require growth of the structure. That's why they are implemented
  64  * as a separate hash indexed by vm_page address. Implementation lives in
  65  * kern/subr_sfbuf.c. Meanwhile, most 64-bit machines have a physical map,
  66  * so they don't require this hash at all, thus ignore subr_sfbuf.c.
  67  *
  68  * Different 32-bit architectures demand different requirements on sf_buf
  69  * hash and functions. They request features in machine/vmparam.h, which
  70  * enable parts of this file. They can also optionally provide helpers in
  71  * machine/sf_buf.h
  72  *
  73  * Defines are:
  74  * SFBUF                This machine requires sf_buf hash.
  75  *                      subr_sfbuf.c should be compiled.
  76  * SFBUF_CPUSET         This machine can perform SFB_CPUPRIVATE mappings,
  77  *                      that do no invalidate cache on the rest of CPUs.
  78  * SFBUF_NOMD           This machine doesn't have machine/sf_buf.h
  79  *
  80  * SFBUF_OPTIONAL_DIRECT_MAP    Value of this define is used as boolean
  81  *                              variable that tells whether machine is
  82  *                              capable of direct map or not at runtime.
  83  * SFBUF_MAP            This machine provides its own sf_buf_map() and
  84  *                      sf_buf_unmap().
  85  * SFBUF_PROCESS_PAGE   This machine provides sf_buf_process_page()
  86  *                      function.
  87  */
  88
  89 #ifdef SFBUF
  90 #if defined(SMP) && defined(SFBUF_CPUSET)
  91 #include <sys/_cpuset.h>
  92 #endif
  93 #include <sys/queue.h>
  94
  95 struct sf_buf {
  96         LIST_ENTRY(sf_buf)      list_entry;     /* list of buffers */
  97         TAILQ_ENTRY(sf_buf)     free_entry;     /* list of buffers */
  98         vm_page_t               m;              /* currently mapped page */
  99         vm_offset_t             kva;            /* va of mapping */
 100         int                     ref_count;      /* usage of this mapping */
 101 #if defined(SMP) && defined(SFBUF_CPUSET)
 102         cpuset_t                cpumask;        /* where mapping is valid */
 103 #endif
 104 };
 105 #else /* ! SFBUF */
 106 struct sf_buf;
 107 #endif /* SFBUF */
 108
 109 #ifndef SFBUF_NOMD
 110 #include <machine/sf_buf.h>
 111 #endif
 112 #ifdef SFBUF_OPTIONAL_DIRECT_MAP
 113 #include <machine/md_var.h>
 114 #endif
 115
 116 #ifdef SFBUF
 117 struct sf_buf *sf_buf_alloc(struct vm_page *, int);
 118 void sf_buf_free(struct sf_buf *);
 119 void sf_buf_ref(struct sf_buf *);
 120
 121 static inline vm_offset_t
 122 sf_buf_kva(struct sf_buf *sf)
 123 {
 124 #ifdef SFBUF_OPTIONAL_DIRECT_MAP
 125         if (SFBUF_OPTIONAL_DIRECT_MAP)
 126                 return (SFBUF_PHYS_DMAP(VM_PAGE_TO_PHYS((vm_page_t)sf)));
 127 #endif
 128
 129         return (sf->kva);
 130 }
 131
 132 static inline vm_page_t
 133 sf_buf_page(struct sf_buf *sf)
 134 {
 135 #ifdef SFBUF_OPTIONAL_DIRECT_MAP
 136         if (SFBUF_OPTIONAL_DIRECT_MAP)
 137                 return ((vm_page_t)sf);
 138 #endif
 139
 140         return (sf->m);
 141 }
 142
 143 #ifndef SFBUF_MAP
 144 #include <vm/pmap.h>
 145
 146 static inline void
 147 sf_buf_map(struct sf_buf *sf, int flags)
 148 {
 149
 150         pmap_qenter(sf->kva, &sf->m, 1);
 151 }
 152
 153 static inline int
 154 sf_buf_unmap(struct sf_buf *sf)
 155 {
 156
 157         return (0);
 158 }
 159 #endif /* SFBUF_MAP */
 160
 161 #if defined(SMP) && defined(SFBUF_CPUSET)
 162 void sf_buf_shootdown(struct sf_buf *, int);
 163 #endif
 164
 165 #ifdef SFBUF_PROCESS_PAGE
 166 boolean_t sf_buf_process_page(vm_page_t, void (*)(struct sf_buf *));
 167 #endif
 168
 169 #else /* ! SFBUF */
 170
 171 static inline struct sf_buf *
 172 sf_buf_alloc(struct vm_page *m, int pri)
 173 {
 174
 175         return ((struct sf_buf *)m);
 176 }
 177
 178 static inline void
 179 sf_buf_free(struct sf_buf *sf)
 180 {
 181 }
 182
 183 static inline void
 184 sf_buf_ref(struct sf_buf *sf)
 185 {
 186 }
 187 #endif /* SFBUF */
 188
 189 /*
 190  * Options to sf_buf_alloc() are specified through its flags argument.  This
 191  * argument's value should be the result of a bitwise or'ing of one or more
 192  * of the following values.
 193  */
 194 #define SFB_CATCH       1               /* Check signals if the allocation
 195                                            sleeps. */
 196 #define SFB_CPUPRIVATE  2               /* Create a CPU private mapping. */
 197 #define SFB_DEFAULT     0
 198 #define SFB_NOWAIT      4               /* Return NULL if all bufs are used. */
 199
 200 extern counter_u64_t sfstat[sizeof(struct sfstat) / sizeof(uint64_t)];
 201 #define SFSTAT_ADD(name, val)   \
 202     counter_u64_add(sfstat[offsetof(struct sfstat, name) / sizeof(uint64_t)],\
 203         (val))
 204 #define SFSTAT_INC(name)        SFSTAT_ADD(name, 1)
 205 #endif /* _KERNEL */
 206 #endif /* !_SYS_SF_BUF_H_ */