xref: /freebsd/sys/vm/vm_phys.h (revision 9f23cbd6cae82fd77edfad7173432fa8dccd0a95)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 #include <vm/_vm_phys.h>
46 
47 extern vm_paddr_t phys_avail[];
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 /*
61  * The following functions are only to be used by the virtual memory system.
62  */
63 void vm_phys_add_seg(vm_paddr_t start, vm_paddr_t end);
64 vm_page_t vm_phys_alloc_contig(int domain, u_long npages, vm_paddr_t low,
65     vm_paddr_t high, u_long alignment, vm_paddr_t boundary);
66 vm_page_t vm_phys_alloc_freelist_pages(int domain, int freelist, int pool,
67     int order);
68 int vm_phys_alloc_npages(int domain, int pool, int npages, vm_page_t ma[]);
69 vm_page_t vm_phys_alloc_pages(int domain, int pool, int order);
70 int vm_phys_domain_match(int prefer, vm_paddr_t low, vm_paddr_t high);
71 void vm_phys_enqueue_contig(vm_page_t m, u_long npages);
72 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
73     vm_memattr_t memattr);
74 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
75 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
76 int vm_phys_find_range(vm_page_t bounds[], int segind, int domain,
77     u_long npages, vm_paddr_t low, vm_paddr_t high);
78 void vm_phys_free_contig(vm_page_t m, u_long npages);
79 void vm_phys_free_pages(vm_page_t m, int order);
80 void vm_phys_init(void);
81 vm_page_t vm_phys_paddr_to_vm_page(vm_paddr_t pa);
82 void vm_phys_register_domains(int ndomains, struct mem_affinity *affinity,
83     int *locality);
84 bool vm_phys_unfree_page(vm_page_t m);
85 int vm_phys_mem_affinity(int f, int t);
86 void vm_phys_early_add_seg(vm_paddr_t start, vm_paddr_t end);
87 vm_paddr_t vm_phys_early_alloc(int domain, size_t alloc_size);
88 void vm_phys_early_startup(void);
89 int vm_phys_avail_largest(void);
90 vm_paddr_t vm_phys_avail_size(int i);
91 bool vm_phys_is_dumpable(vm_paddr_t pa);
92 
93 static inline int
94 vm_phys_domain(vm_paddr_t pa)
95 {
96 #ifdef NUMA
97 	int i;
98 
99 	if (vm_ndomains == 1)
100 		return (0);
101 	for (i = 0; mem_affinity[i].end != 0; i++)
102 		if (mem_affinity[i].start <= pa &&
103 		    mem_affinity[i].end >= pa)
104 			return (mem_affinity[i].domain);
105 	return (-1);
106 #else
107 	return (0);
108 #endif
109 }
110 
111 /*
112  * Find the segind for the first segment at or after the given physical address.
113  */
114 static inline int
115 vm_phys_lookup_segind(vm_paddr_t pa)
116 {
117 	u_int hi, lo, mid;
118 
119 	lo = 0;
120 	hi = vm_phys_nsegs;
121 	while (lo != hi) {
122 		/*
123 		 * for i in [0, lo), segs[i].end <= pa
124 		 * for i in [hi, nsegs), segs[i].end > pa
125 		 */
126 		mid = lo + (hi - lo) / 2;
127 		if (vm_phys_segs[mid].end <= pa)
128 			lo = mid + 1;
129 		else
130 			hi = mid;
131 	}
132 	return (lo);
133 }
134 
135 /*
136  * Find the segment corresponding to the given physical address.
137  */
138 static inline struct vm_phys_seg *
139 vm_phys_paddr_to_seg(vm_paddr_t pa)
140 {
141 	struct vm_phys_seg *seg;
142 	int segind;
143 
144 	segind = vm_phys_lookup_segind(pa);
145 	if (segind < vm_phys_nsegs) {
146 		seg = &vm_phys_segs[segind];
147 		if (pa >= seg->start)
148 			return (seg);
149 	}
150 	return (NULL);
151 }
152 
153 #endif	/* _KERNEL */
154 #endif	/* !_VM_PHYS_H_ */
155