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