osfmk/i386/hibernate_i386.c

   1 /*
   2  * Copyright (c) 2004 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/machine.h>
  30 #include <kern/misc_protos.h>
  31 #include <kern/thread.h>
  32 #include <kern/processor.h>
  33 #include <kern/kalloc.h>
  34 #include <mach/machine.h>
  35 #include <mach/processor_info.h>
  36 #include <mach/mach_types.h>
  37 #include <i386/pmap.h>
  38 #include <kern/cpu_data.h>
  39 #include <IOKit/IOPlatformExpert.h>
  40
  41 #include <pexpert/i386/efi.h>
  42
  43 #include <IOKit/IOHibernatePrivate.h>
  44 #include <vm/vm_page.h>
  45 #include "i386_lowmem.h"
  46
  47 #define MAX_BANKS       32
  48
  49 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  50
  51 hibernate_page_list_t *
  52 hibernate_page_list_allocate(void)
  53 {
  54     ppnum_t                 base, num;
  55     vm_size_t               size;
  56     uint32_t                bank, num_banks;
  57     uint32_t                pages, page_count;
  58     hibernate_page_list_t * list;
  59     hibernate_bitmap_t *    bitmap;
  60
  61     EfiMemoryRange *        mptr;
  62     uint32_t                mcount, msize, i;
  63     hibernate_bitmap_t      dram_ranges[MAX_BANKS];
  64     boot_args *             args = (boot_args *) PE_state.bootArgs;
  65
  66     mptr = args->MemoryMap;
  67     if (args->MemoryMapDescriptorSize == 0)
  68         panic("Invalid memory map descriptor size");
  69     msize = args->MemoryMapDescriptorSize;
  70     mcount = args->MemoryMapSize / msize;
  71
  72     num_banks = 0;
  73     for (i = 0; i < mcount; i++, mptr = (EfiMemoryRange *)(((vm_offset_t)mptr) + msize))
  74     {
  75         base = (ppnum_t) (mptr->PhysicalStart >> I386_PGSHIFT);
  76         num = (ppnum_t) mptr->NumberOfPages;
  77         if (!num)
  78             continue;
  79
  80         switch (mptr->Type)
  81         {
  82             // any kind of dram
  83             case kEfiLoaderCode:
  84             case kEfiLoaderData:
  85             case kEfiBootServicesCode:
  86             case kEfiBootServicesData:
  87             case kEfiConventionalMemory:
  88             case kEfiACPIReclaimMemory:
  89             case kEfiACPIMemoryNVS:
  90             case kEfiPalCode:
  91
  92                 if (!num_banks || (base != (1 + dram_ranges[num_banks - 1].last_page)))
  93                 {
  94                     num_banks++;
  95                     if (num_banks >= MAX_BANKS)
  96                         break;
  97                     dram_ranges[num_banks - 1].first_page = base;
  98                 }
  99                 dram_ranges[num_banks - 1].last_page = base + num - 1;
 100                 break;
 101
 102             // runtime services will be restarted, so no save
 103             case kEfiRuntimeServicesCode:
 104             case kEfiRuntimeServicesData:
 105             // non dram
 106             case kEfiReservedMemoryType:
 107             case kEfiUnusableMemory:
 108             case kEfiMemoryMappedIO:
 109             case kEfiMemoryMappedIOPortSpace:
 110             default:
 111                 break;
 112         }
 113     }
 114
 115     if (num_banks >= MAX_BANKS)
 116         return (NULL);
 117
 118     // size the hibernation bitmap
 119
 120     size = sizeof(hibernate_page_list_t);
 121     page_count = 0;
 122     for (bank = 0; bank < num_banks; bank++) {
 123         pages = dram_ranges[bank].last_page + 1 - dram_ranges[bank].first_page;
 124         page_count += pages;
 125         size += sizeof(hibernate_bitmap_t) + ((pages + 31) >> 5) * sizeof(uint32_t);
 126     }
 127
 128     list = (hibernate_page_list_t *)kalloc(size);
 129     if (!list)
 130         return (list);
 131
 132     list->list_size  = size;
 133     list->page_count = page_count;
 134     list->bank_count = num_banks;
 135
 136     // convert to hibernation bitmap.
 137
 138     bitmap = &list->bank_bitmap[0];
 139     for (bank = 0; bank < num_banks; bank++)
 140     {
 141         bitmap->first_page = dram_ranges[bank].first_page;
 142         bitmap->last_page  = dram_ranges[bank].last_page;
 143         bitmap->bitmapwords = (bitmap->last_page + 1
 144                                - bitmap->first_page + 31) >> 5;
 145         kprintf("hib bank[%d]: 0x%x000 end 0x%xfff\n", bank,
 146                 bitmap->first_page,
 147                 bitmap->last_page);
 148         bitmap = (hibernate_bitmap_t *) &bitmap->bitmap[bitmap->bitmapwords];
 149     }
 150
 151     return (list);
 152 }
 153
 154 // mark pages not to be saved, but available for scratch usage during restore
 155
 156 void
 157 hibernate_page_list_setall_machine( __unused hibernate_page_list_t * page_list,
 158                                     __unused hibernate_page_list_t * page_list_wired,
 159                                     __unused uint32_t * pagesOut)
 160 {
 161 }
 162
 163 // mark pages not to be saved and not for scratch usage during restore
 164 void
 165 hibernate_page_list_set_volatile( hibernate_page_list_t * page_list,
 166                                   hibernate_page_list_t * page_list_wired,
 167                                   uint32_t * pagesOut)
 168 {
 169     boot_args * args = (boot_args *) PE_state.bootArgs;
 170
 171     hibernate_set_page_state(page_list, page_list_wired,
 172                 I386_HIB_PAGETABLE, I386_HIB_PAGETABLE_COUNT,
 173                 kIOHibernatePageStateFree);
 174     *pagesOut -= I386_HIB_PAGETABLE_COUNT;
 175
 176     if (args->efiRuntimeServicesPageStart)
 177     {
 178         hibernate_set_page_state(page_list, page_list_wired,
 179                     args->efiRuntimeServicesPageStart, args->efiRuntimeServicesPageCount,
 180                     kIOHibernatePageStateFree);
 181         *pagesOut -= args->efiRuntimeServicesPageCount;
 182     }
 183 }
 184
 185 kern_return_t
 186 hibernate_processor_setup(IOHibernateImageHeader * header)
 187 {
 188     boot_args * args = (boot_args *) PE_state.bootArgs;
 189
 190     cpu_datap(0)->cpu_hibernate = 1;
 191     header->processorFlags = 0;
 192
 193     header->runtimePages     = args->efiRuntimeServicesPageStart;
 194     header->runtimePageCount = args->efiRuntimeServicesPageCount;
 195
 196     return (KERN_SUCCESS);
 197 }
 198
 199 void
 200 hibernate_vm_lock(void)
 201 {
 202     if (current_cpu_datap()->cpu_hibernate)
 203     {
 204         vm_page_lock_queues();
 205         mutex_lock(&vm_page_queue_free_lock);
 206     }
 207 }
 208
 209 void
 210 hibernate_vm_unlock(void)
 211 {
 212     if (current_cpu_datap()->cpu_hibernate)
 213     {
 214         mutex_unlock(&vm_page_queue_free_lock);
 215         vm_page_unlock_queues();
 216     }
 217 }