osfmk/kern/hibernate.c

   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
  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
  64             retval = KERN_RESOURCE_SHORTAGE;
  65             goto done;
  66     }
  67     page_list_wired = hibernate_page_list_allocate(FALSE);
  68     if (!page_list_wired)
  69     {
  70             kfree(page_list, page_list->list_size);
  71
  72             retval = KERN_RESOURCE_SHORTAGE;
  73             goto done;
  74     }
  75     page_list_pal = hibernate_page_list_allocate(FALSE);
  76     if (!page_list_pal)
  77     {
  78             kfree(page_list, page_list->list_size);
  79             kfree(page_list_wired, page_list_wired->list_size);
  80
  81             retval = KERN_RESOURCE_SHORTAGE;
  82             goto done;
  83     }
  84     *page_list_ret        = page_list;
  85     *page_list_wired_ret  = page_list_wired;
  86     *page_list_pal_ret    = page_list_pal;
  87
  88 done:
  89     return (retval);
  90
  91 }
  92
  93 extern int sync_internal(void);
  94
  95 kern_return_t
  96 hibernate_setup(IOHibernateImageHeader * header,
  97                         boolean_t vmflush,
  98                         hibernate_page_list_t * page_list __unused,
  99                         hibernate_page_list_t * page_list_wired __unused,
 100                         hibernate_page_list_t * page_list_pal __unused)
 101 {
 102     kern_return_t       retval = KERN_SUCCESS;
 103
 104     hibernate_create_paddr_map();
 105
 106     hibernate_reset_stats();
 107
 108     if (vmflush && VM_CONFIG_COMPRESSOR_IS_PRESENT) {
 109
 110             sync_internal();
 111
 112             vm_decompressor_lock();
 113             need_to_unlock_decompressor = TRUE;
 114
 115             hibernate_flush_memory();
 116     }
 117
 118     // no failures hereafter
 119
 120     hibernate_processor_setup(header);
 121
 122     HIBLOG("hibernate_alloc_pages act %d, inact %d, anon %d, throt %d, spec %d, wire %d, wireinit %d\n",
 123             vm_page_active_count, vm_page_inactive_count,
 124             vm_page_anonymous_count,  vm_page_throttled_count, vm_page_speculative_count,
 125             vm_page_wire_count, vm_page_wire_count_initial);
 126
 127     if (retval != KERN_SUCCESS && need_to_unlock_decompressor == TRUE) {
 128             need_to_unlock_decompressor = FALSE;
 129             vm_decompressor_unlock();
 130     }
 131     return (retval);
 132 }
 133
 134 kern_return_t
 135 hibernate_teardown(hibernate_page_list_t * page_list,
 136                     hibernate_page_list_t * page_list_wired,
 137                     hibernate_page_list_t * page_list_pal)
 138 {
 139     hibernate_free_gobble_pages();
 140
 141     if (page_list)
 142         kfree(page_list, page_list->list_size);
 143     if (page_list_wired)
 144         kfree(page_list_wired, page_list_wired->list_size);
 145     if (page_list_pal)
 146         kfree(page_list_pal, page_list_pal->list_size);
 147
 148     if (VM_CONFIG_COMPRESSOR_IS_PRESENT) {
 149             if (need_to_unlock_decompressor == TRUE) {
 150                     need_to_unlock_decompressor = FALSE;
 151                     vm_decompressor_unlock();
 152             }
 153             vm_compressor_delay_trim();
 154     }
 155     return (KERN_SUCCESS);
 156 }