2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * The Mach Operating System project at Carnegie-Mellon University.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * from: @(#)vm_kern.c 8.3 (Berkeley) 1/12/94
35 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36 * All rights reserved.
38 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
40 * Permission to use, copy, modify and distribute this software and
41 * its documentation is hereby granted, provided that both the copyright
42 * notice and this permission notice appear in all copies of the
43 * software, derivative works or modified versions, and any portions
44 * thereof, and that both notices appear in supporting documentation.
46 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
47 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
48 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
50 * Carnegie Mellon requests users of this software to return to
52 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
53 * School of Computer Science
54 * Carnegie Mellon University
55 * Pittsburgh PA 15213-3890
57 * any improvements or extensions that they make and grant Carnegie the
58 * rights to redistribute these changes.
62 * Kernel memory management.
65 #include <sys/cdefs.h>
66 __FBSDID("$FreeBSD$");
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/kernel.h> /* for ticks and hz */
71 #include <sys/eventhandler.h>
73 #include <sys/mutex.h>
75 #include <sys/malloc.h>
76 #include <sys/sysctl.h>
79 #include <vm/vm_param.h>
81 #include <vm/vm_map.h>
82 #include <vm/vm_object.h>
83 #include <vm/vm_page.h>
84 #include <vm/vm_pageout.h>
85 #include <vm/vm_extern.h>
93 vm_map_t bio_transient_map;
95 const void *zero_region;
96 CTASSERT((ZERO_REGION_SIZE & PAGE_MASK) == 0);
101 * Allocate a virtual address range with no underlying object and
102 * no initial mapping to physical memory. Any mapping from this
103 * range to physical memory must be explicitly created prior to
104 * its use, typically with pmap_qenter(). Any attempt to create
105 * a mapping on demand through vm_fault() will result in a panic.
108 kmem_alloc_nofault(map, size)
115 size = round_page(size);
116 addr = vm_map_min(map);
117 result = vm_map_find(map, NULL, 0, &addr, size, VMFS_ANY_SPACE,
118 VM_PROT_ALL, VM_PROT_ALL, MAP_NOFAULT);
119 if (result != KERN_SUCCESS) {
126 * kmem_alloc_nofault_space:
128 * Allocate a virtual address range with no underlying object and
129 * no initial mapping to physical memory within the specified
130 * address space. Any mapping from this range to physical memory
131 * must be explicitly created prior to its use, typically with
132 * pmap_qenter(). Any attempt to create a mapping on demand
133 * through vm_fault() will result in a panic.
136 kmem_alloc_nofault_space(map, size, find_space)
144 size = round_page(size);
145 addr = vm_map_min(map);
146 result = vm_map_find(map, NULL, 0, &addr, size, find_space,
147 VM_PROT_ALL, VM_PROT_ALL, MAP_NOFAULT);
148 if (result != KERN_SUCCESS) {
155 * Allocate wired-down memory in the kernel's address map
159 kmem_alloc(map, size)
166 size = round_page(size);
169 * Use the kernel object for wired-down kernel pages. Assume that no
170 * region of the kernel object is referenced more than once.
174 * Locate sufficient space in the map. This will give us the final
175 * virtual address for the new memory, and thus will tell us the
176 * offset within the kernel map.
179 if (vm_map_findspace(map, vm_map_min(map), size, &addr)) {
183 offset = addr - VM_MIN_KERNEL_ADDRESS;
184 vm_object_reference(kernel_object);
185 vm_map_insert(map, kernel_object, offset, addr, addr + size,
186 VM_PROT_ALL, VM_PROT_ALL, 0);
190 * And finally, mark the data as non-pageable.
192 (void) vm_map_wire(map, addr, addr + size,
193 VM_MAP_WIRE_SYSTEM|VM_MAP_WIRE_NOHOLES);
201 * Release a region of kernel virtual memory allocated
202 * with kmem_alloc, and return the physical pages
203 * associated with that region.
205 * This routine may not block on kernel maps.
208 kmem_free(map, addr, size)
214 (void) vm_map_remove(map, trunc_page(addr), round_page(addr + size));
220 * Allocates a map to manage a subrange
221 * of the kernel virtual address space.
223 * Arguments are as follows:
225 * parent Map to take range from
226 * min, max Returned endpoints of map
227 * size Size of range to find
228 * superpage_align Request that min is superpage aligned
231 kmem_suballoc(vm_map_t parent, vm_offset_t *min, vm_offset_t *max,
232 vm_size_t size, boolean_t superpage_align)
237 size = round_page(size);
239 *min = vm_map_min(parent);
240 ret = vm_map_find(parent, NULL, 0, min, size, superpage_align ?
241 VMFS_ALIGNED_SPACE : VMFS_ANY_SPACE, VM_PROT_ALL, VM_PROT_ALL,
243 if (ret != KERN_SUCCESS)
244 panic("kmem_suballoc: bad status return of %d", ret);
246 result = vm_map_create(vm_map_pmap(parent), *min, *max);
248 panic("kmem_suballoc: cannot create submap");
249 if (vm_map_submap(parent, *min, *max, result) != KERN_SUCCESS)
250 panic("kmem_suballoc: unable to change range to submap");
257 * Allocate wired-down memory in the kernel's address map for the higher
258 * level kernel memory allocator (kern/kern_malloc.c). We cannot use
259 * kmem_alloc() because we may need to allocate memory at interrupt
260 * level where we cannot block (canwait == FALSE).
262 * This routine has its own private kernel submap (kmem_map) and object
263 * (kmem_object). This, combined with the fact that only malloc uses
264 * this routine, ensures that we will never block in map or object waits.
266 * We don't worry about expanding the map (adding entries) since entries
267 * for wired maps are statically allocated.
269 * `map' is ONLY allowed to be kmem_map or one of the mbuf submaps to
270 * which we never free.
273 kmem_malloc(map, size, flags)
281 size = round_page(size);
282 addr = vm_map_min(map);
285 * Locate sufficient space in the map. This will give us the final
286 * virtual address for the new memory, and thus will tell us the
287 * offset within the kernel map.
290 if (vm_map_findspace(map, vm_map_min(map), size, &addr)) {
292 if ((flags & M_NOWAIT) == 0) {
293 for (i = 0; i < 8; i++) {
294 EVENTHANDLER_INVOKE(vm_lowmem, 0);
297 if (vm_map_findspace(map, vm_map_min(map),
302 tsleep(&i, 0, "nokva", (hz / 4) * (i + 1));
305 panic("kmem_malloc(%ld): kmem_map too small: %ld total allocated",
306 (long)size, (long)map->size);
313 rv = kmem_back(map, addr, size, flags);
315 return (rv == KERN_SUCCESS ? addr : 0);
321 * Allocate physical pages for the specified virtual address range.
324 kmem_back(vm_map_t map, vm_offset_t addr, vm_size_t size, int flags)
326 vm_offset_t offset, i;
327 vm_map_entry_t entry;
332 KASSERT(vm_map_locked(map), ("kmem_back: map %p is not locked", map));
333 offset = addr - VM_MIN_KERNEL_ADDRESS;
334 vm_object_reference(kmem_object);
335 vm_map_insert(map, kmem_object, offset, addr, addr + size,
336 VM_PROT_ALL, VM_PROT_ALL, 0);
339 * Assert: vm_map_insert() will never be able to extend the
340 * previous entry so vm_map_lookup_entry() will find a new
341 * entry exactly corresponding to this address range and it
342 * will have wired_count == 0.
344 found = vm_map_lookup_entry(map, addr, &entry);
345 KASSERT(found && entry->start == addr && entry->end == addr + size &&
346 entry->wired_count == 0 && (entry->eflags & MAP_ENTRY_IN_TRANSITION)
347 == 0, ("kmem_back: entry not found or misaligned"));
349 if ((flags & (M_NOWAIT|M_USE_RESERVE)) == M_NOWAIT)
350 pflags = VM_ALLOC_INTERRUPT | VM_ALLOC_WIRED;
352 pflags = VM_ALLOC_SYSTEM | VM_ALLOC_WIRED;
355 pflags |= VM_ALLOC_ZERO;
356 if (flags & M_NODUMP)
357 pflags |= VM_ALLOC_NODUMP;
359 VM_OBJECT_LOCK(kmem_object);
360 for (i = 0; i < size; i += PAGE_SIZE) {
362 m = vm_page_alloc(kmem_object, OFF_TO_IDX(offset + i), pflags);
365 * Ran out of space, free everything up and return. Don't need
366 * to lock page queues here as we know that the pages we got
367 * aren't on any queues.
370 if ((flags & M_NOWAIT) == 0) {
371 VM_OBJECT_UNLOCK(kmem_object);
372 entry->eflags |= MAP_ENTRY_IN_TRANSITION;
377 (entry->eflags & (MAP_ENTRY_IN_TRANSITION | MAP_ENTRY_NEEDS_WAKEUP)) ==
378 MAP_ENTRY_IN_TRANSITION,
379 ("kmem_back: volatile entry"));
380 entry->eflags &= ~MAP_ENTRY_IN_TRANSITION;
381 VM_OBJECT_LOCK(kmem_object);
385 * Free the pages before removing the map entry.
386 * They are already marked busy. Calling
387 * vm_map_delete before the pages has been freed or
388 * unbusied will cause a deadlock.
392 m = vm_page_lookup(kmem_object,
393 OFF_TO_IDX(offset + i));
394 vm_page_unwire(m, 0);
397 VM_OBJECT_UNLOCK(kmem_object);
398 vm_map_delete(map, addr, addr + size);
399 return (KERN_NO_SPACE);
401 if (flags & M_ZERO && (m->flags & PG_ZERO) == 0)
403 m->valid = VM_PAGE_BITS_ALL;
404 KASSERT((m->oflags & VPO_UNMANAGED) != 0,
405 ("kmem_malloc: page %p is managed", m));
407 VM_OBJECT_UNLOCK(kmem_object);
410 * Mark map entry as non-pageable. Repeat the assert.
412 KASSERT(entry->start == addr && entry->end == addr + size &&
413 entry->wired_count == 0,
414 ("kmem_back: entry not found or misaligned after allocation"));
415 entry->wired_count = 1;
418 * At this point, the kmem_object must be unlocked because
419 * vm_map_simplify_entry() calls vm_object_deallocate(), which
420 * locks the kmem_object.
422 vm_map_simplify_entry(map, entry);
425 * Loop thru pages, entering them in the pmap.
427 VM_OBJECT_LOCK(kmem_object);
428 for (i = 0; i < size; i += PAGE_SIZE) {
429 m = vm_page_lookup(kmem_object, OFF_TO_IDX(offset + i));
431 * Because this is kernel_pmap, this call will not block.
433 pmap_enter(kernel_pmap, addr + i, VM_PROT_ALL, m, VM_PROT_ALL,
437 VM_OBJECT_UNLOCK(kmem_object);
439 return (KERN_SUCCESS);
445 * Allocates pageable memory from a sub-map of the kernel. If the submap
446 * has no room, the caller sleeps waiting for more memory in the submap.
448 * This routine may block.
451 kmem_alloc_wait(map, size)
457 size = round_page(size);
458 if (!swap_reserve(size))
463 * To make this work for more than one map, use the map's lock
464 * to lock out sleepers/wakers.
467 if (vm_map_findspace(map, vm_map_min(map), size, &addr) == 0)
469 /* no space now; see if we can ever get space */
470 if (vm_map_max(map) - vm_map_min(map) < size) {
475 map->needs_wakeup = TRUE;
476 vm_map_unlock_and_wait(map, 0);
478 vm_map_insert(map, NULL, 0, addr, addr + size, VM_PROT_ALL,
479 VM_PROT_ALL, MAP_ACC_CHARGED);
487 * Returns memory to a submap of the kernel, and wakes up any processes
488 * waiting for memory in that map.
491 kmem_free_wakeup(map, addr, size)
498 (void) vm_map_delete(map, trunc_page(addr), round_page(addr + size));
499 if (map->needs_wakeup) {
500 map->needs_wakeup = FALSE;
507 kmem_init_zero_region(void)
514 * Map a single physical page of zeros to a larger virtual range.
515 * This requires less looping in places that want large amounts of
516 * zeros, while not using much more physical resources.
518 addr = kmem_alloc_nofault(kernel_map, ZERO_REGION_SIZE);
519 m = vm_page_alloc(NULL, 0, VM_ALLOC_NORMAL |
520 VM_ALLOC_NOOBJ | VM_ALLOC_WIRED | VM_ALLOC_ZERO);
521 if ((m->flags & PG_ZERO) == 0)
523 for (i = 0; i < ZERO_REGION_SIZE; i += PAGE_SIZE)
524 pmap_qenter(addr + i, &m, 1);
525 error = vm_map_protect(kernel_map, addr, addr + ZERO_REGION_SIZE,
527 KASSERT(error == 0, ("error=%d", error));
529 zero_region = (const void *)addr;
535 * Create the kernel map; insert a mapping covering kernel text,
536 * data, bss, and all space allocated thus far (`boostrap' data). The
537 * new map will thus map the range between VM_MIN_KERNEL_ADDRESS and
538 * `start' as allocated, and the range between `start' and `end' as free.
541 kmem_init(start, end)
542 vm_offset_t start, end;
546 m = vm_map_create(kernel_pmap, VM_MIN_KERNEL_ADDRESS, end);
549 /* N.B.: cannot use kgdb to debug, starting with this assignment ... */
551 (void) vm_map_insert(m, NULL, (vm_ooffset_t) 0,
555 VM_MIN_KERNEL_ADDRESS,
557 start, VM_PROT_ALL, VM_PROT_ALL, MAP_NOFAULT);
558 /* ... and ending with the completion of the above `insert' */
561 kmem_init_zero_region();
566 * Allow userspace to directly trigger the VM drain routine for testing
570 debug_vm_lowmem(SYSCTL_HANDLER_ARGS)
575 error = sysctl_handle_int(oidp, &i, 0, req);
579 EVENTHANDLER_INVOKE(vm_lowmem, 0);
583 SYSCTL_PROC(_debug, OID_AUTO, vm_lowmem, CTLTYPE_INT | CTLFLAG_RW, 0, 0,
584 debug_vm_lowmem, "I", "set to trigger vm_lowmem event");