xref: /freebsd/sys/vm/vm_phys.h (revision 0bf48626aaa33768078f5872b922b1487b3a9296)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2002-2006 Rice University
5  * Copyright (c) 2007 Alan L. Cox <alc@cs.rice.edu>
6  * All rights reserved.
7  *
8  * This software was developed for the FreeBSD Project by Alan L. Cox,
9  * Olivier Crameri, Peter Druschel, Sitaram Iyer, and Juan Navarro.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
24  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
30  * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * $FreeBSD$
34  */
35 
36 /*
37  *	Physical memory system definitions
38  */
39 
40 #ifndef	_VM_PHYS_H_
41 #define	_VM_PHYS_H_
42 
43 #ifdef _KERNEL
44 
45 #ifndef VM_NFREEORDER_MAX
46 #define	VM_NFREEORDER_MAX	VM_NFREEORDER
47 #endif
48 
49 /* Domains must be dense (non-sparse) and zero-based. */
50 struct mem_affinity {
51 	vm_paddr_t start;
52 	vm_paddr_t end;
53 	int domain;
54 };
55 #ifdef NUMA
56 extern struct mem_affinity *mem_affinity;
57 extern int *mem_locality;
58 #endif
59 
60 struct vm_freelist {
61 	struct pglist pl;
62 	int lcnt;
63 };
64 
65 struct vm_phys_seg {
66 	vm_paddr_t	start;
67 	vm_paddr_t	end;
68 	vm_page_t	first_page;
69 	int		domain;
70 	struct vm_freelist (*free_queues)[VM_NFREEPOOL][VM_NFREEORDER_MAX];
71 };
72 
73 extern struct vm_phys_seg vm_phys_segs[];
74 extern int vm_phys_nsegs;
75 
76 /*
77  * The following functions are only to be used by the virtual memory system.
78  */
79 void vm_phys_add_seg(vm_paddr_t start, vm_paddr_t end);
80 vm_page_t vm_phys_alloc_contig(int domain, u_long npages, vm_paddr_t low,
81     vm_paddr_t high, u_long alignment, vm_paddr_t boundary);
82 vm_page_t vm_phys_alloc_freelist_pages(int domain, int freelist, int pool,
83     int order);
84 int vm_phys_alloc_npages(int domain, int pool, int npages, vm_page_t ma[]);
85 vm_page_t vm_phys_alloc_pages(int domain, int pool, int order);
86 int vm_phys_domain_match(int prefer, vm_paddr_t low, vm_paddr_t high);
87 void vm_phys_enqueue_contig(vm_page_t m, u_long npages);
88 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
89     vm_memattr_t memattr);
90 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
91 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
92 void vm_phys_free_contig(vm_page_t m, u_long npages);
93 void vm_phys_free_pages(vm_page_t m, int order);
94 void vm_phys_init(void);
95 vm_page_t vm_phys_paddr_to_vm_page(vm_paddr_t pa);
96 void vm_phys_register_domains(int ndomains, struct mem_affinity *affinity,
97     int *locality);
98 vm_page_t vm_phys_scan_contig(int domain, u_long npages, vm_paddr_t low,
99     vm_paddr_t high, u_long alignment, vm_paddr_t boundary, int options);
100 void vm_phys_set_pool(int pool, vm_page_t m, int order);
101 boolean_t vm_phys_unfree_page(vm_page_t m);
102 int vm_phys_mem_affinity(int f, int t);
103 
104 /*
105  *
106  *	vm_phys_domain:
107  *
108  *	Return the index of the domain the page belongs to.
109  */
110 static inline int
111 vm_phys_domain(vm_page_t m)
112 {
113 #ifdef NUMA
114 	int domn, segind;
115 
116 	/* XXXKIB try to assert that the page is managed */
117 	segind = m->segind;
118 	KASSERT(segind < vm_phys_nsegs, ("segind %d m %p", segind, m));
119 	domn = vm_phys_segs[segind].domain;
120 	KASSERT(domn < vm_ndomains, ("domain %d m %p", domn, m));
121 	return (domn);
122 #else
123 	return (0);
124 #endif
125 }
126 int _vm_phys_domain(vm_paddr_t pa);
127 
128 #endif	/* _KERNEL */
129 #endif	/* !_VM_PHYS_H_ */
130