sys/compat/linuxkpi/common/include/linux/page.h

   1 /*-
   2  * Copyright (c) 2010 Isilon Systems, Inc.
   3  * Copyright (c) 2010 iX Systems, Inc.
   4  * Copyright (c) 2010 Panasas, Inc.
   5  * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
   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 unmodified, this list of conditions, and the following
  13  *    disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31 #ifndef _LINUX_PAGE_H_
  32 #define _LINUX_PAGE_H_
  33
  34 #include <linux/types.h>
  35
  36 #include <sys/param.h>
  37 #include <sys/vmmeter.h>
  38
  39 #include <machine/atomic.h>
  40 #include <vm/vm.h>
  41 #include <vm/vm_page.h>
  42 #include <vm/pmap.h>
  43
  44 typedef unsigned long linux_pte_t;
  45 typedef unsigned long linux_pmd_t;
  46 typedef unsigned long linux_pgd_t;
  47 typedef unsigned long pgprot_t;
  48
  49 #define page    vm_page
  50
  51 #define LINUXKPI_PROT_VALID (1 << 3)
  52 #define LINUXKPI_CACHE_MODE_SHIFT 4
  53
  54 CTASSERT((VM_PROT_ALL & -LINUXKPI_PROT_VALID) == 0);
  55
  56 static inline pgprot_t
  57 cachemode2protval(vm_memattr_t attr)
  58 {
  59         return ((attr << LINUXKPI_CACHE_MODE_SHIFT) | LINUXKPI_PROT_VALID);
  60 }
  61
  62 static inline vm_memattr_t
  63 pgprot2cachemode(pgprot_t prot)
  64 {
  65         if (prot & LINUXKPI_PROT_VALID)
  66                 return (prot >> LINUXKPI_CACHE_MODE_SHIFT);
  67         else
  68                 return (VM_MEMATTR_DEFAULT);
  69 }
  70
  71 #define virt_to_page(x)         PHYS_TO_VM_PAGE(vtophys(x))
  72 #define page_to_pfn(pp)         (VM_PAGE_TO_PHYS(pp) >> PAGE_SHIFT)
  73 #define pfn_to_page(pfn)        (PHYS_TO_VM_PAGE((pfn) << PAGE_SHIFT))
  74 #define nth_page(page,n)        pfn_to_page(page_to_pfn(page) + (n))
  75
  76 #define clear_page(page)                memset(page, 0, PAGE_SIZE)
  77 #define pgprot_noncached(prot)          \
  78         (((prot) & VM_PROT_ALL) | cachemode2protval(VM_MEMATTR_UNCACHEABLE))
  79 #define pgprot_writecombine(prot)       \
  80         (((prot) & VM_PROT_ALL) | cachemode2protval(VM_MEMATTR_WRITE_COMBINING))
  81
  82 #undef  PAGE_MASK
  83 #define PAGE_MASK       (~(PAGE_SIZE-1))
  84 /*
  85  * Modifying PAGE_MASK in the above way breaks trunc_page, round_page,
  86  * and btoc macros. Therefore, redefine them in a way that makes sense
  87  * so the LinuxKPI consumers don't get totally broken behavior.
  88  */
  89 #undef  btoc
  90 #define btoc(x) (((vm_offset_t)(x) + PAGE_SIZE - 1) >> PAGE_SHIFT)
  91 #undef  round_page
  92 #define round_page(x)   ((((uintptr_t)(x)) + PAGE_SIZE - 1) & ~(PAGE_SIZE - 1))
  93 #undef  trunc_page
  94 #define trunc_page(x)   ((uintptr_t)(x) & ~(PAGE_SIZE - 1))
  95
  96 #endif  /* _LINUX_PAGE_H_ */