xref: /freebsd/sys/vm/vm_phys.h (revision 1f474190)
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 extern vm_paddr_t phys_avail[PHYS_AVAIL_COUNT];
50 
51 /* Domains must be dense (non-sparse) and zero-based. */
52 struct mem_affinity {
53 	vm_paddr_t start;
54 	vm_paddr_t end;
55 	int domain;
56 };
57 #ifdef NUMA
58 extern struct mem_affinity *mem_affinity;
59 extern int *mem_locality;
60 #endif
61 
62 struct vm_freelist {
63 	struct pglist pl;
64 	int lcnt;
65 };
66 
67 struct vm_phys_seg {
68 	vm_paddr_t	start;
69 	vm_paddr_t	end;
70 	vm_page_t	first_page;
71 #if VM_NRESERVLEVEL > 0
72 	vm_reserv_t	first_reserv;
73 #endif
74 #ifdef __aarch64__
75 	void		*md_first;
76 #endif
77 	int		domain;
78 	struct vm_freelist (*free_queues)[VM_NFREEPOOL][VM_NFREEORDER_MAX];
79 };
80 
81 extern struct vm_phys_seg vm_phys_segs[];
82 extern int vm_phys_nsegs;
83 
84 /*
85  * The following functions are only to be used by the virtual memory system.
86  */
87 void vm_phys_add_seg(vm_paddr_t start, vm_paddr_t end);
88 vm_page_t vm_phys_alloc_contig(int domain, u_long npages, vm_paddr_t low,
89     vm_paddr_t high, u_long alignment, vm_paddr_t boundary);
90 vm_page_t vm_phys_alloc_freelist_pages(int domain, int freelist, int pool,
91     int order);
92 int vm_phys_alloc_npages(int domain, int pool, int npages, vm_page_t ma[]);
93 vm_page_t vm_phys_alloc_pages(int domain, int pool, int order);
94 int vm_phys_domain_match(int prefer, vm_paddr_t low, vm_paddr_t high);
95 void vm_phys_enqueue_contig(vm_page_t m, u_long npages);
96 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
97     vm_memattr_t memattr);
98 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
99 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
100 void vm_phys_free_contig(vm_page_t m, u_long npages);
101 void vm_phys_free_pages(vm_page_t m, int order);
102 void vm_phys_init(void);
103 vm_page_t vm_phys_paddr_to_vm_page(vm_paddr_t pa);
104 void vm_phys_register_domains(int ndomains, struct mem_affinity *affinity,
105     int *locality);
106 vm_page_t vm_phys_scan_contig(int domain, u_long npages, vm_paddr_t low,
107     vm_paddr_t high, u_long alignment, vm_paddr_t boundary, int options);
108 void vm_phys_set_pool(int pool, vm_page_t m, int order);
109 boolean_t vm_phys_unfree_page(vm_page_t m);
110 int vm_phys_mem_affinity(int f, int t);
111 void vm_phys_early_add_seg(vm_paddr_t start, vm_paddr_t end);
112 vm_paddr_t vm_phys_early_alloc(int domain, size_t alloc_size);
113 void vm_phys_early_startup(void);
114 int vm_phys_avail_largest(void);
115 vm_paddr_t vm_phys_avail_size(int i);
116 
117 /*
118  *
119  *	vm_phys_domain:
120  *
121  *	Return the index of the domain the page belongs to.
122  */
123 static inline int
124 vm_phys_domain(vm_page_t m)
125 {
126 #ifdef NUMA
127 	int domn, segind;
128 
129 	/* XXXKIB try to assert that the page is managed */
130 	segind = m->segind;
131 	KASSERT(segind < vm_phys_nsegs, ("segind %d m %p", segind, m));
132 	domn = vm_phys_segs[segind].domain;
133 	KASSERT(domn < vm_ndomains, ("domain %d m %p", domn, m));
134 	return (domn);
135 #else
136 	return (0);
137 #endif
138 }
139 int _vm_phys_domain(vm_paddr_t pa);
140 
141 #endif	/* _KERNEL */
142 #endif	/* !_VM_PHYS_H_ */
143