xref: /xnu-8019.80.24/osfmk/kern/hibernate.c (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1 /*
2  * Copyright (c) 2004-2005 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #include <kern/kalloc.h>
30 #include <kern/machine.h>
31 #include <kern/misc_protos.h>
32 #include <kern/thread.h>
33 #include <kern/processor.h>
34 #include <mach/machine.h>
35 #include <mach/processor_info.h>
36 #include <mach/mach_types.h>
37 #include <IOKit/IOPlatformExpert.h>
38 
39 #include <IOKit/IOHibernatePrivate.h>
40 #include <vm/vm_page.h>
41 #include <vm/vm_pageout.h>
42 #include <vm/vm_purgeable_internal.h>
43 #include <vm/vm_compressor.h>
44 
45 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
46 
47 boolean_t       need_to_unlock_decompressor = FALSE;
48 
49 kern_return_t
hibernate_alloc_page_lists(hibernate_page_list_t ** page_list_ret,hibernate_page_list_t ** page_list_wired_ret,hibernate_page_list_t ** page_list_pal_ret)50 hibernate_alloc_page_lists(
51 	hibernate_page_list_t ** page_list_ret,
52 	hibernate_page_list_t ** page_list_wired_ret,
53 	hibernate_page_list_t ** page_list_pal_ret)
54 {
55 	kern_return_t       retval = KERN_SUCCESS;
56 
57 	hibernate_page_list_t * page_list = NULL;
58 	hibernate_page_list_t * page_list_wired = NULL;
59 	hibernate_page_list_t * page_list_pal = NULL;
60 
61 	page_list = hibernate_page_list_allocate(TRUE);
62 	if (!page_list) {
63 		HIBLOG("%s: failed for page_list\n", __FUNCTION__);
64 		retval = KERN_RESOURCE_SHORTAGE;
65 		goto done;
66 	}
67 	page_list_wired = hibernate_page_list_allocate(FALSE);
68 	if (!page_list_wired) {
69 		kfree_data(page_list, page_list->list_size);
70 		HIBLOG("%s: failed for page_list_wired\n", __FUNCTION__);
71 		retval = KERN_RESOURCE_SHORTAGE;
72 		goto done;
73 	}
74 	page_list_pal = hibernate_page_list_allocate(FALSE);
75 	if (!page_list_pal) {
76 		kfree_data(page_list, page_list->list_size);
77 		kfree_data(page_list_wired, page_list_wired->list_size);
78 		HIBLOG("%s: failed for page_list_pal\n", __FUNCTION__);
79 		retval = KERN_RESOURCE_SHORTAGE;
80 		goto done;
81 	}
82 	*page_list_ret        = page_list;
83 	*page_list_wired_ret  = page_list_wired;
84 	*page_list_pal_ret    = page_list_pal;
85 
86 done:
87 	return retval;
88 }
89 
90 extern int sync_internal(void);
91 
92 kern_return_t
hibernate_setup(IOHibernateImageHeader * header,boolean_t vmflush,hibernate_page_list_t * page_list __unused,hibernate_page_list_t * page_list_wired __unused,hibernate_page_list_t * page_list_pal __unused)93 hibernate_setup(IOHibernateImageHeader * header,
94     boolean_t vmflush,
95     hibernate_page_list_t * page_list __unused,
96     hibernate_page_list_t * page_list_wired __unused,
97     hibernate_page_list_t * page_list_pal __unused)
98 {
99 	kern_return_t       retval = KERN_SUCCESS;
100 
101 	hibernate_create_paddr_map();
102 
103 	hibernate_reset_stats();
104 
105 	if (vmflush && VM_CONFIG_COMPRESSOR_IS_PRESENT) {
106 		sync_internal();
107 
108 		vm_decompressor_lock();
109 		need_to_unlock_decompressor = TRUE;
110 
111 		hibernate_flush_memory();
112 	}
113 
114 	// no failures hereafter
115 
116 	hibernate_processor_setup(header);
117 
118 	HIBLOG("hibernate_alloc_pages act %d, inact %d, anon %d, throt %d, spec %d, wire %d, wireinit %d\n",
119 	    vm_page_active_count, vm_page_inactive_count,
120 	    vm_page_anonymous_count, vm_page_throttled_count, vm_page_speculative_count,
121 	    vm_page_wire_count, vm_page_wire_count_initial);
122 
123 	if (retval != KERN_SUCCESS && need_to_unlock_decompressor == TRUE) {
124 		need_to_unlock_decompressor = FALSE;
125 		vm_decompressor_unlock();
126 	}
127 	return retval;
128 }
129 
130 kern_return_t
hibernate_teardown(hibernate_page_list_t * page_list,hibernate_page_list_t * page_list_wired,hibernate_page_list_t * page_list_pal)131 hibernate_teardown(hibernate_page_list_t * page_list,
132     hibernate_page_list_t * page_list_wired,
133     hibernate_page_list_t * page_list_pal)
134 {
135 	hibernate_free_gobble_pages();
136 
137 	if (page_list) {
138 		kfree_data(page_list, page_list->list_size);
139 	}
140 	if (page_list_wired) {
141 		kfree_data(page_list_wired, page_list_wired->list_size);
142 	}
143 	if (page_list_pal) {
144 		kfree_data(page_list_pal, page_list_pal->list_size);
145 	}
146 
147 	if (VM_CONFIG_COMPRESSOR_IS_PRESENT) {
148 		if (need_to_unlock_decompressor == TRUE) {
149 			need_to_unlock_decompressor = FALSE;
150 			vm_decompressor_unlock();
151 		}
152 		vm_compressor_delay_trim();
153 	}
154 	return KERN_SUCCESS;
155 }
156