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 <default_pager/default_pager_internal.h>
38#include <IOKit/IOPlatformExpert.h>
39
40#include <IOKit/IOHibernatePrivate.h>
41#include <vm/vm_page.h>
42#include <vm/vm_pageout.h>
43#include <vm/vm_purgeable_internal.h>
44
45/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
46
47kern_return_t
48hibernate_setup(IOHibernateImageHeader * header,
49                        uint32_t  free_page_ratio,
50                        uint32_t  free_page_time,
51                        boolean_t vmflush,
52			hibernate_page_list_t ** page_list_ret,
53			hibernate_page_list_t ** page_list_wired_ret,
54			hibernate_page_list_t ** page_list_pal_ret)
55{
56    hibernate_page_list_t * page_list = NULL;
57    hibernate_page_list_t * page_list_wired = NULL;
58    hibernate_page_list_t * page_list_pal = NULL;
59    uint32_t    	    gobble_count;
60
61    *page_list_ret       = NULL;
62    *page_list_wired_ret = NULL;
63	*page_list_pal_ret    = NULL;
64
65    if (vmflush && dp_isssd)
66        hibernate_flush_memory();
67
68    page_list = hibernate_page_list_allocate(TRUE);
69    if (!page_list)
70        return (KERN_RESOURCE_SHORTAGE);
71    page_list_wired = hibernate_page_list_allocate(FALSE);
72    if (!page_list_wired)
73    {
74        kfree(page_list, page_list->list_size);
75        return (KERN_RESOURCE_SHORTAGE);
76    }
77    page_list_pal = hibernate_page_list_allocate(FALSE);
78    if (!page_list_pal)
79    {
80        kfree(page_list, page_list->list_size);
81        kfree(page_list_wired, page_list_wired->list_size);
82        return (KERN_RESOURCE_SHORTAGE);
83    }
84
85    // pages we could force out to reduce hibernate image size
86    gobble_count = (uint32_t)((((uint64_t) page_list->page_count) * ((uint64_t) free_page_ratio)) / 100);
87
88    // no failures hereafter
89
90    hibernate_processor_setup(header);
91
92    if (gobble_count)
93	hibernate_gobble_pages(gobble_count, free_page_time);
94
95    HIBLOG("hibernate_alloc_pages act %d, inact %d, anon %d, throt %d, spec %d, wire %d, wireinit %d\n",
96    	    vm_page_active_count, vm_page_inactive_count,
97	    vm_page_anonymous_count,  vm_page_throttled_count, vm_page_speculative_count,
98	    vm_page_wire_count, vm_page_wire_count_initial);
99
100    *page_list_ret        = page_list;
101    *page_list_wired_ret  = page_list_wired;
102    *page_list_pal_ret    = page_list_pal;
103
104    return (KERN_SUCCESS);
105}
106
107kern_return_t
108hibernate_teardown(hibernate_page_list_t * page_list,
109                    hibernate_page_list_t * page_list_wired,
110		    hibernate_page_list_t * page_list_pal)
111{
112    hibernate_free_gobble_pages();
113
114    if (page_list)
115        kfree(page_list, page_list->list_size);
116    if (page_list_wired)
117        kfree(page_list_wired, page_list_wired->list_size);
118    if (page_list_pal)
119        kfree(page_list_pal, page_list_pal->list_size);
120
121    return (KERN_SUCCESS);
122}
123
124