xref: /freebsd/sys/vm/vm_kern.c (revision 02f2e93b60c2b91feac8f45c4c889a5a8e40d8a2)
1 /*
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * The Mach Operating System project at Carnegie-Mellon University.
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, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	from: @(#)vm_kern.c	8.3 (Berkeley) 1/12/94
37  *
38  *
39  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40  * All rights reserved.
41  *
42  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
43  *
44  * Permission to use, copy, modify and distribute this software and
45  * its documentation is hereby granted, provided that both the copyright
46  * notice and this permission notice appear in all copies of the
47  * software, derivative works or modified versions, and any portions
48  * thereof, and that both notices appear in supporting documentation.
49  *
50  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
51  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
52  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
53  *
54  * Carnegie Mellon requests users of this software to return to
55  *
56  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
57  *  School of Computer Science
58  *  Carnegie Mellon University
59  *  Pittsburgh PA 15213-3890
60  *
61  * any improvements or extensions that they make and grant Carnegie the
62  * rights to redistribute these changes.
63  *
64  * $Id: vm_kern.c,v 1.38 1997/08/02 14:33:26 bde Exp $
65  */
66 
67 /*
68  *	Kernel memory management.
69  */
70 
71 #include <sys/param.h>
72 #include <sys/systm.h>
73 #include <sys/proc.h>
74 #include <sys/malloc.h>
75 #include <sys/syslog.h>
76 
77 #include <vm/vm.h>
78 #include <vm/vm_param.h>
79 #include <vm/vm_prot.h>
80 #include <sys/lock.h>
81 #include <vm/pmap.h>
82 #include <vm/vm_map.h>
83 #include <vm/vm_object.h>
84 #include <vm/vm_page.h>
85 #include <vm/vm_pageout.h>
86 #include <vm/vm_extern.h>
87 
88 vm_map_t kernel_map=0;
89 vm_map_t kmem_map=0;
90 vm_map_t exec_map=0;
91 vm_map_t clean_map=0;
92 vm_map_t u_map=0;
93 vm_map_t buffer_map=0;
94 vm_map_t mb_map=0;
95 int mb_map_full=0;
96 vm_map_t io_map=0;
97 vm_map_t phys_map=0;
98 
99 /*
100  *	kmem_alloc_pageable:
101  *
102  *	Allocate pageable memory to the kernel's address map.
103  *	"map" must be kernel_map or a submap of kernel_map.
104  */
105 
106 vm_offset_t
107 kmem_alloc_pageable(map, size)
108 	vm_map_t map;
109 	register vm_size_t size;
110 {
111 	vm_offset_t addr;
112 	register int result;
113 
114 	size = round_page(size);
115 	addr = vm_map_min(map);
116 	result = vm_map_find(map, NULL, (vm_offset_t) 0,
117 	    &addr, size, TRUE, VM_PROT_ALL, VM_PROT_ALL, 0);
118 	if (result != KERN_SUCCESS) {
119 		return (0);
120 	}
121 	return (addr);
122 }
123 
124 /*
125  *	Allocate wired-down memory in the kernel's address map
126  *	or a submap.
127  */
128 vm_offset_t
129 kmem_alloc(map, size)
130 	register vm_map_t map;
131 	register vm_size_t size;
132 {
133 	vm_offset_t addr;
134 	register vm_offset_t offset;
135 	vm_offset_t i;
136 
137 	size = round_page(size);
138 
139 	/*
140 	 * Use the kernel object for wired-down kernel pages. Assume that no
141 	 * region of the kernel object is referenced more than once.
142 	 */
143 
144 	/*
145 	 * Locate sufficient space in the map.  This will give us the final
146 	 * virtual address for the new memory, and thus will tell us the
147 	 * offset within the kernel map.
148 	 */
149 	vm_map_lock(map);
150 	if (vm_map_findspace(map, 0, size, &addr)) {
151 		vm_map_unlock(map);
152 		return (0);
153 	}
154 	offset = addr - VM_MIN_KERNEL_ADDRESS;
155 	vm_object_reference(kernel_object);
156 	vm_map_insert(map, kernel_object, offset, addr, addr + size,
157 		VM_PROT_ALL, VM_PROT_ALL, 0);
158 	vm_map_unlock(map);
159 
160 	/*
161 	 * Guarantee that there are pages already in this object before
162 	 * calling vm_map_pageable.  This is to prevent the following
163 	 * scenario:
164 	 *
165 	 * 1) Threads have swapped out, so that there is a pager for the
166 	 * kernel_object. 2) The kmsg zone is empty, and so we are
167 	 * kmem_allocing a new page for it. 3) vm_map_pageable calls vm_fault;
168 	 * there is no page, but there is a pager, so we call
169 	 * pager_data_request.  But the kmsg zone is empty, so we must
170 	 * kmem_alloc. 4) goto 1 5) Even if the kmsg zone is not empty: when
171 	 * we get the data back from the pager, it will be (very stale)
172 	 * non-zero data.  kmem_alloc is defined to return zero-filled memory.
173 	 *
174 	 * We're intentionally not activating the pages we allocate to prevent a
175 	 * race with page-out.  vm_map_pageable will wire the pages.
176 	 */
177 
178 	for (i = 0; i < size; i += PAGE_SIZE) {
179 		vm_page_t mem;
180 
181 		while ((mem = vm_page_alloc(kernel_object,
182 			OFF_TO_IDX(offset + i), VM_ALLOC_ZERO)) == NULL) {
183 			VM_WAIT;
184 		}
185 		if ((mem->flags & PG_ZERO) == 0)
186 			vm_page_zero_fill(mem);
187 		mem->flags &= ~(PG_BUSY|PG_ZERO);
188 		mem->valid = VM_PAGE_BITS_ALL;
189 	}
190 
191 	/*
192 	 * And finally, mark the data as non-pageable.
193 	 */
194 
195 	(void) vm_map_pageable(map, (vm_offset_t) addr, addr + size, FALSE);
196 
197 	return (addr);
198 }
199 
200 /*
201  *	kmem_free:
202  *
203  *	Release a region of kernel virtual memory allocated
204  *	with kmem_alloc, and return the physical pages
205  *	associated with that region.
206  */
207 void
208 kmem_free(map, addr, size)
209 	vm_map_t map;
210 	register vm_offset_t addr;
211 	vm_size_t size;
212 {
213 	(void) vm_map_remove(map, trunc_page(addr), round_page(addr + size));
214 }
215 
216 /*
217  *	kmem_suballoc:
218  *
219  *	Allocates a map to manage a subrange
220  *	of the kernel virtual address space.
221  *
222  *	Arguments are as follows:
223  *
224  *	parent		Map to take range from
225  *	size		Size of range to find
226  *	min, max	Returned endpoints of map
227  *	pageable	Can the region be paged
228  */
229 vm_map_t
230 kmem_suballoc(parent, min, max, size, pageable)
231 	register vm_map_t parent;
232 	vm_offset_t *min, *max;
233 	register vm_size_t size;
234 	boolean_t pageable;
235 {
236 	register int ret;
237 	vm_map_t result;
238 
239 	size = round_page(size);
240 
241 	*min = (vm_offset_t) vm_map_min(parent);
242 	ret = vm_map_find(parent, NULL, (vm_offset_t) 0,
243 	    min, size, TRUE, VM_PROT_ALL, VM_PROT_ALL, 0);
244 	if (ret != KERN_SUCCESS) {
245 		printf("kmem_suballoc: bad status return of %d.\n", ret);
246 		panic("kmem_suballoc");
247 	}
248 	*max = *min + size;
249 	pmap_reference(vm_map_pmap(parent));
250 	result = vm_map_create(vm_map_pmap(parent), *min, *max, pageable);
251 	if (result == NULL)
252 		panic("kmem_suballoc: cannot create submap");
253 	if ((ret = vm_map_submap(parent, *min, *max, result)) != KERN_SUCCESS)
254 		panic("kmem_suballoc: unable to change range to submap");
255 	return (result);
256 }
257 
258 /*
259  * Allocate wired-down memory in the kernel's address map for the higher
260  * level kernel memory allocator (kern/kern_malloc.c).  We cannot use
261  * kmem_alloc() because we may need to allocate memory at interrupt
262  * level where we cannot block (canwait == FALSE).
263  *
264  * This routine has its own private kernel submap (kmem_map) and object
265  * (kmem_object).  This, combined with the fact that only malloc uses
266  * this routine, ensures that we will never block in map or object waits.
267  *
268  * Note that this still only works in a uni-processor environment and
269  * when called at splhigh().
270  *
271  * We don't worry about expanding the map (adding entries) since entries
272  * for wired maps are statically allocated.
273  */
274 vm_offset_t
275 kmem_malloc(map, size, waitflag)
276 	register vm_map_t map;
277 	register vm_size_t size;
278 	boolean_t waitflag;
279 {
280 	register vm_offset_t offset, i;
281 	vm_map_entry_t entry;
282 	vm_offset_t addr;
283 	vm_page_t m;
284 
285 	if (map != kmem_map && map != mb_map)
286 		panic("kmem_malloc: map != {kmem,mb}_map");
287 
288 	size = round_page(size);
289 	addr = vm_map_min(map);
290 
291 	/*
292 	 * Locate sufficient space in the map.  This will give us the final
293 	 * virtual address for the new memory, and thus will tell us the
294 	 * offset within the kernel map.
295 	 */
296 	vm_map_lock(map);
297 	if (vm_map_findspace(map, 0, size, &addr)) {
298 		vm_map_unlock(map);
299 		if (map == mb_map) {
300 			mb_map_full = TRUE;
301 			log(LOG_ERR, "Out of mbuf clusters - increase maxusers!\n");
302 			return (0);
303 		}
304 		if (waitflag == M_WAITOK)
305 			panic("kmem_malloc: kmem_map too small");
306 		return (0);
307 	}
308 	offset = addr - VM_MIN_KERNEL_ADDRESS;
309 	vm_object_reference(kmem_object);
310 	vm_map_insert(map, kmem_object, offset, addr, addr + size,
311 		VM_PROT_ALL, VM_PROT_ALL, 0);
312 
313 	for (i = 0; i < size; i += PAGE_SIZE) {
314 retry:
315 		m = vm_page_alloc(kmem_object, OFF_TO_IDX(offset + i),
316 			(waitflag == M_NOWAIT) ? VM_ALLOC_INTERRUPT : VM_ALLOC_SYSTEM);
317 
318 		/*
319 		 * Ran out of space, free everything up and return. Don't need
320 		 * to lock page queues here as we know that the pages we got
321 		 * aren't on any queues.
322 		 */
323 		if (m == NULL) {
324 			if (waitflag == M_WAITOK) {
325 				VM_WAIT;
326 				goto retry;
327 			}
328 			while (i != 0) {
329 				i -= PAGE_SIZE;
330 				m = vm_page_lookup(kmem_object,
331 					OFF_TO_IDX(offset + i));
332 				PAGE_WAKEUP(m);
333 				vm_page_free(m);
334 			}
335 			vm_map_delete(map, addr, addr + size);
336 			vm_map_unlock(map);
337 			return (0);
338 		}
339 		m->flags &= ~PG_ZERO;
340 		m->valid = VM_PAGE_BITS_ALL;
341 	}
342 
343 	/*
344 	 * Mark map entry as non-pageable. Assert: vm_map_insert() will never
345 	 * be able to extend the previous entry so there will be a new entry
346 	 * exactly corresponding to this address range and it will have
347 	 * wired_count == 0.
348 	 */
349 	if (!vm_map_lookup_entry(map, addr, &entry) ||
350 	    entry->start != addr || entry->end != addr + size ||
351 	    entry->wired_count)
352 		panic("kmem_malloc: entry not found or misaligned");
353 	entry->wired_count++;
354 
355 	vm_map_simplify_entry(map, entry);
356 
357 	/*
358 	 * Loop thru pages, entering them in the pmap. (We cannot add them to
359 	 * the wired count without wrapping the vm_page_queue_lock in
360 	 * splimp...)
361 	 */
362 	for (i = 0; i < size; i += PAGE_SIZE) {
363 		m = vm_page_lookup(kmem_object, OFF_TO_IDX(offset + i));
364 		vm_page_wire(m);
365 		PAGE_WAKEUP(m);
366 		pmap_enter(kernel_pmap, addr + i, VM_PAGE_TO_PHYS(m),
367 			VM_PROT_ALL, 1);
368 		m->flags |= PG_MAPPED|PG_WRITEABLE;
369 	}
370 	vm_map_unlock(map);
371 
372 	return (addr);
373 }
374 
375 /*
376  *	kmem_alloc_wait
377  *
378  *	Allocates pageable memory from a sub-map of the kernel.  If the submap
379  *	has no room, the caller sleeps waiting for more memory in the submap.
380  *
381  */
382 vm_offset_t
383 kmem_alloc_wait(map, size)
384 	vm_map_t map;
385 	vm_size_t size;
386 {
387 	vm_offset_t addr;
388 
389 	size = round_page(size);
390 
391 	for (;;) {
392 		/*
393 		 * To make this work for more than one map, use the map's lock
394 		 * to lock out sleepers/wakers.
395 		 */
396 		vm_map_lock(map);
397 		if (vm_map_findspace(map, 0, size, &addr) == 0)
398 			break;
399 		/* no space now; see if we can ever get space */
400 		if (vm_map_max(map) - vm_map_min(map) < size) {
401 			vm_map_unlock(map);
402 			return (0);
403 		}
404 		vm_map_unlock(map);
405 		tsleep(map, PVM, "kmaw", 0);
406 	}
407 	vm_map_insert(map, NULL, (vm_offset_t) 0, addr, addr + size, VM_PROT_ALL, VM_PROT_ALL, 0);
408 	vm_map_unlock(map);
409 	return (addr);
410 }
411 
412 /*
413  *	kmem_free_wakeup
414  *
415  *	Returns memory to a submap of the kernel, and wakes up any processes
416  *	waiting for memory in that map.
417  */
418 void
419 kmem_free_wakeup(map, addr, size)
420 	vm_map_t map;
421 	vm_offset_t addr;
422 	vm_size_t size;
423 {
424 	vm_map_lock(map);
425 	(void) vm_map_delete(map, trunc_page(addr), round_page(addr + size));
426 	wakeup(map);
427 	vm_map_unlock(map);
428 }
429 
430 /*
431  * Create the kernel map; insert a mapping covering kernel text, data, bss,
432  * and all space allocated thus far (`boostrap' data).  The new map will thus
433  * map the range between VM_MIN_KERNEL_ADDRESS and `start' as allocated, and
434  * the range between `start' and `end' as free.
435  */
436 void
437 kmem_init(start, end)
438 	vm_offset_t start, end;
439 {
440 	register vm_map_t m;
441 
442 	m = vm_map_create(kernel_pmap, VM_MIN_KERNEL_ADDRESS, end, FALSE);
443 	vm_map_lock(m);
444 	/* N.B.: cannot use kgdb to debug, starting with this assignment ... */
445 	kernel_map = m;
446 	kernel_map->system_map = 1;
447 	(void) vm_map_insert(m, NULL, (vm_offset_t) 0,
448 	    VM_MIN_KERNEL_ADDRESS, start, VM_PROT_ALL, VM_PROT_ALL, 0);
449 	/* ... and ending with the completion of the above `insert' */
450 	vm_map_unlock(m);
451 }
452