Chameleon

Chameleon Svn Source Tree

Root/branches/andyvand/i386/boot2/boot.c

1/*
2 * Copyright (c) 1999-2003 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Portions Copyright (c) 1999-2003 Apple Computer, Inc. All Rights
7 * Reserved. This file contains Original Code and/or Modifications of
8 * Original Code as defined in and that are subject to the Apple Public
9 * Source License Version 2.0 (the "License"). You may not use this file
10 * except in compliance with the License. Please obtain a copy of the
11 * License at http://www.apple.com/publicsource and read it before using
12 * this file.
13 *
14 * The Original Code and all software distributed under the License are
15 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
16 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
17 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT. Please see the
19 * License for the specific language governing rights and limitations
20 * under the License.
21 *
22 * @APPLE_LICENSE_HEADER_END@
23 */
24/*
25 * Mach Operating System
26 * Copyright (c) 1990 Carnegie-Mellon University
27 * Copyright (c) 1989 Carnegie-Mellon University
28 * All rights reserved. The CMU software License Agreement specifies
29 * the terms and conditions for use and redistribution.
30 */
31
32/*
33 * INTEL CORPORATION PROPRIETARY INFORMATION
34 *
35 * This software is supplied under the terms of a license agreement or
36 * nondisclosure agreement with Intel Corporation and may not be copied
37 * nor disclosed except in accordance with the terms of that agreement.
38 *
39 * Copyright 1988, 1989 by Intel Corporation
40 */
41
42/*
43 * Copyright 1993 NeXT Computer, Inc.
44 * All rights reserved.
45 */
46
47/*
48 * Completely reworked by Sam Streeper (sam_s@NeXT.com)
49 * Reworked again by Curtis Galloway (galloway@NeXT.com)
50 */
51
52
53#include "boot.h"
54#include "bootstruct.h"
55#include "fake_efi.h"
56#include "sl.h"
57#include "libsa.h"
58#include "ramdisk.h"
59#include "gui.h"
60#include "platform.h"
61#include "edid.h"
62#include "915resolution.h"
63
64long gBootMode; /* defaults to 0 == kBootModeNormal */
65bool gOverrideKernel;
66static char gBootKernelCacheFile[512];
67static char gCacheNameAdler[64 + 256];
68char *gPlatformName = gCacheNameAdler;
69char gRootDevice[512];
70char gMKextName[512];
71char gMacOSVersion[8];
72bool gEnableCDROMRescan;
73bool gScanSingleDrive;
74
75int bvCount = 0;
76//intmenucount = 0;
77int gDeviceCount = 0;
78
79BVRef bvr;
80BVRef menuBVR;
81BVRef bvChain;
82bool useGUI;
83
84//static void selectBiosDevice(void);
85static unsigned long Adler32(unsigned char *buffer, long length);
86
87
88static bool gUnloadPXEOnExit = false;
89
90/*
91 * How long to wait (in seconds) to load the
92 * kernel after displaying the "boot:" prompt.
93 */
94#define kBootErrorTimeout 5
95
96/*
97 * Default path to kernel cache file
98 */
99#define kDefaultCachePath "/System/Library/Caches/com.apple.kernelcaches/kernelcache"
100
101//==========================================================================
102// Zero the BSS.
103
104static void zeroBSS(void)
105{
106extern char _DATA__bss__begin, _DATA__bss__end;
107extern char _DATA__common__begin, _DATA__common__end;
108
109bzero(&_DATA__bss__begin, (&_DATA__bss__end - &_DATA__bss__begin));
110bzero(&_DATA__common__begin, (&_DATA__common__end - &_DATA__common__begin));
111}
112
113//==========================================================================
114// Malloc error function
115
116static void malloc_error(char *addr, size_t size, const char *file, int line)
117{
118stop("\nMemory allocation error! Addr=0x%x, Size=0x%x, File=%s, Line=%d\n", (unsigned)addr, (unsigned)size, file, line);
119}
120
121//==========================================================================
122//Initializes the runtime. Right now this means zeroing the BSS and initializing malloc.
123//
124void initialize_runtime(void)
125{
126zeroBSS();
127malloc_init(0, 0, 0, malloc_error);
128}
129
130//==========================================================================
131// execKernel - Load the kernel image (mach-o) and jump to its entry point.
132
133static int ExecKernel(void *binary)
134{
135 entry_t kernelEntry;
136 int ret;
137
138 bootArgs->kaddr = bootArgs->ksize = 0;
139
140 ret = DecodeKernel(binary,
141 &kernelEntry,
142 (char **) &bootArgs->kaddr,
143 (int *)&bootArgs->ksize );
144
145 if ( ret != 0 )
146 return ret;
147
148 // Reserve space for boot args
149 reserveKernBootStruct();
150
151 // Load boot drivers from the specifed root path.
152
153 if (!gHaveKernelCache) {
154 LoadDrivers("/");
155 }
156
157 clearActivityIndicator();
158
159 if (gErrors) {
160 printf("Errors encountered while starting up the computer.\n");
161 printf("Pausing %d seconds...\n", kBootErrorTimeout);
162 sleep(kBootErrorTimeout);
163 }
164
165 setupFakeEfi();
166
167 verbose("Starting Darwin %s\n",( archCpuType == CPU_TYPE_I386 ) ? "x86" : "x86_64");
168
169 // Cleanup the PXE base code.
170
171 if ( (gBootFileType == kNetworkDeviceType) && gUnloadPXEOnExit ) {
172if ( (ret = nbpUnloadBaseCode()) != nbpStatusSuccess )
173 {
174 printf("nbpUnloadBaseCode error %d\n", (int) ret);
175 sleep(2);
176 }
177 }
178
179 bool dummyVal;
180 if (getBoolForKey(kWaitForKeypressKey, &dummyVal, &bootInfo->bootConfig) && dummyVal) {
181printf("Press any key to continue...");
182getc();
183 }
184
185 // If we were in text mode, switch to graphics mode.
186 // This will draw the boot graphics unless we are in
187 // verbose mode.
188
189 if(gVerboseMode)
190 setVideoMode( GRAPHICS_MODE, 0 );
191 else
192 drawBootGraphics();
193
194 finalizeBootStruct();
195
196 // Jump to kernel's entry point. There's no going back now.
197
198 startprog( kernelEntry, bootArgs );
199
200 // Not reached
201
202 return 0;
203}
204
205//==========================================================================
206// This is the entrypoint from real-mode which functions exactly as it did
207// before. Multiboot does its own runtime initialization, does some of its
208// own things, and then calls common_boot.
209void boot(int biosdev)
210{
211initialize_runtime();
212// Enable A20 gate before accessing memory above 1Mb.
213enableA20();
214common_boot(biosdev);
215}
216
217//==========================================================================
218// The 'main' function for the booter. Called by boot0 when booting
219// from a block device, or by the network booter.
220//
221// arguments:
222// biosdev - Value passed from boot1/NBP to specify the device
223// that the booter was loaded from.
224//
225// If biosdev is kBIOSDevNetwork, then this function will return if
226// booting was unsuccessful. This allows the PXE firmware to try the
227// next boot device on its list.
228void common_boot(int biosdev)
229{
230 int status;
231 char *bootFile;
232 unsigned long adler32;
233 bool quiet;
234 bool firstRun = true;
235 bool instantMenu;
236 bool rescanPrompt;
237 unsigned int allowBVFlags = kBVFlagSystemVolume|kBVFlagForeignBoot;
238 unsigned int denyBVFlags = kBVFlagEFISystem;
239
240 // Set reminder to unload the PXE base code. Neglect to unload
241 // the base code will result in a hang or kernel panic.
242 gUnloadPXEOnExit = true;
243
244 // Record the device that the booter was loaded from.
245 gBIOSDev = biosdev & kBIOSDevMask;
246
247 // Initialize boot info structure.
248 initKernBootStruct();
249
250 // Setup VGA text mode.
251 // Not sure if it is safe to call setVideoMode() before the
252 // config table has been loaded. Call video_mode() instead.
253#if DEBUG
254 printf("before video_mode\n");
255#endif
256 video_mode( 2 ); // 80x25 mono text mode.
257#if DEBUG
258 printf("after video_mode\n");
259#endif
260
261 // Scan and record the system's hardware information.
262 scan_platform();
263
264 // First get info for boot volume.
265 scanBootVolumes(gBIOSDev, 0);
266 bvChain = getBVChainForBIOSDev(gBIOSDev);
267 setBootGlobals(bvChain);
268
269 // Load boot.plist config file.
270 // At this point, since the boot args are not typed in yet, just use
271 // empty string so that loadSystemConfig gets the default.
272 status = loadSystemConfig("", &bootInfo->bootConfig, NULL, false);
273
274 if (getBoolForKey(kQuietBootKey, &quiet, &bootInfo->bootConfig) && quiet) {
275 gBootMode |= kBootModeQuiet;
276 }
277
278 // Override firstRun to get to the boot menu instantly by setting "Instant Menu"=y in system config
279 if (getBoolForKey(kInsantMenuKey, &instantMenu, &bootInfo->bootConfig) && instantMenu) {
280 firstRun = false;
281 }
282
283 // Loading preboot ramdisk if exists.
284 loadPrebootRAMDisk();
285
286 // Disable rescan option by default
287 gEnableCDROMRescan = false;
288
289 // Enable it with Rescan=y in system config
290 if (getBoolForKey(kRescanKey, &gEnableCDROMRescan, &bootInfo->bootConfig) && gEnableCDROMRescan) {
291 gEnableCDROMRescan = true;
292 }
293
294 // Ask the user for Rescan option by setting "Rescan Prompt"=y in system config.
295 rescanPrompt = false;
296 if (getBoolForKey(kRescanPromptKey, &rescanPrompt , &bootInfo->bootConfig) && rescanPrompt && biosDevIsCDROM(gBIOSDev)) {
297 gEnableCDROMRescan = promptForRescanOption();
298 }
299
300 // Enable touching a single BIOS device only if "Scan Single Drive"=y is set in system config.
301 if (getBoolForKey(kScanSingleDriveKey, &gScanSingleDrive, &bootInfo->bootConfig) && gScanSingleDrive) {
302 gScanSingleDrive = true;
303 }
304
305 // Create a list of partitions on device(s).
306 if (gScanSingleDrive) {
307 scanBootVolumes(gBIOSDev, &bvCount);
308 } else {
309 scanDisks(gBIOSDev, &bvCount);
310 }
311
312 // Create a separated bvr chain using the specified filters.
313 bvChain = newFilteredBVChain(0x80, 0xFF, allowBVFlags, denyBVFlags, &gDeviceCount);
314
315 gBootVolume = selectBootVolume(bvChain);
316
317#if DEBUG
318 printf(" Default: %d, ->biosdev: %d, ->part_no: %d ->flags: %d\n", gBootVolume, gBootVolume->biosdev, gBootVolume->part_no, gBootVolume->flags);
319 printf(" bt(0,0): %d, ->biosdev: %d, ->part_no: %d ->flags: %d\n", gBIOSBootVolume, gBIOSBootVolume->biosdev, gBIOSBootVolume->part_no, gBIOSBootVolume->flags);
320 getc();
321#endif
322
323
324 useGUI = true;
325 // Override useGUI default
326 getBoolForKey(kGUIKey, &useGUI, &bootInfo->bootConfig);
327
328// Before initGui, path the video bios with the correct resolution
329
330UInt32 x = 0, y = 0;
331UInt32 bp = 0;
332
333getResolution(&x, &y, &bp);
334
335if (x!=0 && y!=0) {
336vbios_map * map;
337
338map = open_vbios(CT_UNKWN);
339
340unlock_vbios(map);
341
342set_mode(map, x, y, bp, 0, 0);
343
344relock_vbios(map);
345
346close_vbios(map);
347
348verbose("Patched first resolution mode to %dx%d.\n", x, y);
349}
350
351 if (useGUI) {
352 /* XXX AsereBLN handle error */
353initGUI();
354 }
355
356 setBootGlobals(bvChain);
357
358 // Parse args, load and start kernel.
359 while (1) {
360 const char *val;
361 int len;
362 int trycache;
363 long flags, cachetime, kerneltime, exttime, sleeptime, time;
364 int ret = -1;
365 void *binary = (void *)kLoadAddr;
366 bool tryresume;
367 bool tryresumedefault;
368 bool forceresume;
369
370 config_file_t systemVersion;// system.plist of booting partition
371
372 // additional variable for testing alternate kernel image locations on boot helper partitions.
373 char bootFileSpec[512];
374
375 // Initialize globals.
376
377 sysConfigValid = false;
378 gErrors = false;
379
380 status = getBootOptions(firstRun);
381 firstRun = false;
382 if (status == -1) continue;
383
384 status = processBootOptions();
385 // Status==1 means to chainboot
386 if ( status == 1 ) break;
387 // Status==-1 means that the config file couldn't be loaded or that gBootVolume is NULL
388 if ( status == -1 )
389 {
390 // gBootVolume == NULL usually means the user hit escape.
391 if(gBootVolume == NULL)
392 {
393 freeFilteredBVChain(bvChain);
394
395 if (gEnableCDROMRescan)
396 rescanBIOSDevice(gBIOSDev);
397
398 bvChain = newFilteredBVChain(0x80, 0xFF, allowBVFlags, denyBVFlags, &gDeviceCount);
399 setBootGlobals(bvChain);
400 }
401 continue;
402 }
403
404 // Other status (e.g. 0) means that we should proceed with boot.
405
406if( bootArgs->Video.v_display == GRAPHICS_MODE )
407drawBackground();
408
409 // Found and loaded a config file. Proceed with boot.
410
411// Turn off any GUI elements
412if( bootArgs->Video.v_display == GRAPHICS_MODE )
413{
414gui.devicelist.draw = false;
415gui.bootprompt.draw = false;
416gui.menu.draw = false;
417gui.infobox.draw = false;
418drawBackground();
419updateVRAM();
420}
421
422// Find out which version mac os we're booting.
423if (!loadConfigFile("System/Library/CoreServices/SystemVersion.plist", &systemVersion)) {
424if (getValueForKey(kProductVersion, &val, &len, &systemVersion)) {
425// getValueForKey uses const char for val
426// so copy it and trim
427strncpy(gMacOSVersion, val, MIN(len, 4));
428gMacOSVersion[MIN(len, 4)] = '\0';
429}
430}
431
432if (platformCPUFeature(CPU_FEATURE_EM64T)) {
433archCpuType = CPU_TYPE_X86_64;
434} else {
435archCpuType = CPU_TYPE_I386;
436}
437if (getValueForKey(karch, &val, &len, &bootInfo->bootConfig)) {
438if (strncmp(val, "i386", 4) == 0) {
439archCpuType = CPU_TYPE_I386;
440}
441}
442if (getValueForKey(k32BitModeFlag, &val, &len, &bootInfo->bootConfig)) {
443archCpuType = CPU_TYPE_I386;
444}
445if (getValueForKey(k64BitModeFlag, &val, &len, &bootInfo->bootConfig)) {
446archCpuType = CPU_TYPE_X86_64;
447}
448
449if (!getBoolForKey (kWake, &tryresume, &bootInfo->bootConfig)) {
450tryresume = true;
451tryresumedefault = true;
452} else {
453tryresumedefault = false;
454}
455
456if (!getBoolForKey (kForceWake, &forceresume, &bootInfo->bootConfig)) {
457forceresume = false;
458}
459
460if (forceresume) {
461tryresume = true;
462tryresumedefault = false;
463}
464
465while (tryresume) {
466const char *tmp;
467BVRef bvr;
468if (!getValueForKey(kWakeImage, &val, &len, &bootInfo->bootConfig))
469val="/private/var/vm/sleepimage";
470
471// Do this first to be sure that root volume is mounted
472ret = GetFileInfo(0, val, &flags, &sleeptime);
473
474if ((bvr = getBootVolumeRef(val, &tmp)) == NULL)
475break;
476
477// Can't check if it was hibernation Wake=y is required
478if (bvr->modTime == 0 && tryresumedefault)
479break;
480
481if ((ret != 0) || ((flags & kFileTypeMask) != kFileTypeFlat))
482break;
483
484if (!forceresume && sleeptime+3<bvr->modTime) {
485printf ("Hibernate image is too old by %d seconds. Use ForceWake=y to override\n",bvr->modTime-sleeptime);
486break;
487}
488
489HibernateBoot((char *)val);
490break;
491}
492
493 // Reset cache name.
494 bzero(gCacheNameAdler + 64, sizeof(gCacheNameAdler) - 64);
495
496 sprintf(gCacheNameAdler + 64, "%s,%s", gRootDevice, bootInfo->bootFile);
497
498 adler32 = Adler32((unsigned char *)gCacheNameAdler, sizeof(gCacheNameAdler));
499
500 if (getValueForKey(kKernelCacheKey, &val, &len, &bootInfo->bootConfig)) {
501 strlcpy(gBootKernelCacheFile, val, len+1);
502 } else {
503 sprintf(gBootKernelCacheFile, "%s.%08lX", kDefaultCachePath, adler32);
504 }
505
506 // Check for cache file.
507 trycache = (((gBootMode & kBootModeSafe) == 0) &&
508 !gOverrideKernel &&
509 (gBootFileType == kBlockDeviceType) &&
510 (gMKextName[0] == '\0') &&
511 (gBootKernelCacheFile[0] != '\0'));
512
513verbose("Loading Darwin %s\n", gMacOSVersion);
514
515 if (trycache) do {
516
517 // if we haven't found the kernel yet, don't use the cache
518 ret = GetFileInfo(NULL, bootInfo->bootFile, &flags, &kerneltime);
519 if ((ret != 0) || ((flags & kFileTypeMask) != kFileTypeFlat)) {
520 trycache = 0;
521 break;
522 }
523 ret = GetFileInfo(NULL, gBootKernelCacheFile, &flags, &cachetime);
524 if ((ret != 0) || ((flags & kFileTypeMask) != kFileTypeFlat)
525 || (cachetime < kerneltime)) {
526 trycache = 0;
527 break;
528 }
529 ret = GetFileInfo("/System/Library/", "Extensions", &flags, &exttime);
530 if ((ret == 0) && ((flags & kFileTypeMask) == kFileTypeDirectory)
531 && (cachetime < exttime)) {
532 trycache = 0;
533 break;
534 }
535 if (kerneltime > exttime) {
536 exttime = kerneltime;
537 }
538 if (cachetime != (exttime + 1)) {
539 trycache = 0;
540 break;
541 }
542 } while (0);
543
544 do {
545 if (trycache) {
546 bootFile = gBootKernelCacheFile;
547 verbose("Loading kernel cache %s\n", bootFile);
548 ret = LoadFile(bootFile);
549 binary = (void *)kLoadAddr;
550 if (ret >= 0) {
551 break;
552 }
553 }
554 bootFile = bootInfo->bootFile;
555
556 // Try to load kernel image from alternate locations on boot helper partitions.
557 sprintf(bootFileSpec, "com.apple.boot.P/%s", bootFile);
558 ret = GetFileInfo(NULL, bootFileSpec, &flags, &time);
559 if (ret == -1)
560 {
561 sprintf(bootFileSpec, "com.apple.boot.R/%s", bootFile);
562 ret = GetFileInfo(NULL, bootFileSpec, &flags, &time);
563 if (ret == -1)
564 {
565 sprintf(bootFileSpec, "com.apple.boot.S/%s", bootFile);
566 ret = GetFileInfo(NULL, bootFileSpec, &flags, &time);
567 if (ret == -1)
568 {
569 // Not found any alternate locations, using the original kernel image path.
570 strcpy(bootFileSpec, bootFile);
571 }
572 }
573 }
574
575 verbose("Loading kernel %s\n", bootFileSpec);
576 ret = LoadThinFatFile(bootFileSpec, &binary);
577 if (ret <= 0 && archCpuType == CPU_TYPE_X86_64)
578 {
579 archCpuType = CPU_TYPE_I386;
580 ret = LoadThinFatFile(bootFileSpec, &binary);
581 }
582
583 } while (0);
584
585 clearActivityIndicator();
586#if DEBUG
587 printf("Pausing...");
588 sleep(8);
589#endif
590
591 if (ret <= 0) {
592printf("Can't find %s\n", bootFile);
593
594if(gui.initialised) {
595sleep(1);
596drawBackground();
597gui.devicelist.draw = true;
598gui.redraw = true;
599}
600 if (gBootFileType == kNetworkDeviceType) {
601 // Return control back to PXE. Don't unload PXE base code.
602 gUnloadPXEOnExit = false;
603 break;
604 }
605 } else {
606 /* Won't return if successful. */
607 ret = ExecKernel(binary);
608 }
609 }
610
611 // chainboot
612 if (status==1) {
613if (getVideoMode() == GRAPHICS_MODE) {// if we are already in graphics-mode,
614setVideoMode(VGA_TEXT_MODE, 0);// switch back to text mode
615}
616 }
617
618 if ((gBootFileType == kNetworkDeviceType) && gUnloadPXEOnExit) {
619nbpUnloadBaseCode();
620 }
621}
622
623/*!
624 Selects a new BIOS device, taking care to update the global state appropriately.
625 */
626/*
627static void selectBiosDevice(void)
628{
629 struct DiskBVMap *oldMap = diskResetBootVolumes(gBIOSDev);
630 CacheReset();
631 diskFreeMap(oldMap);
632 oldMap = NULL;
633
634 int dev = selectAlternateBootDevice(gBIOSDev);
635
636 BVRef bvchain = scanBootVolumes(dev, 0);
637 BVRef bootVol = selectBootVolume(bvchain);
638 gBootVolume = bootVol;
639 setRootVolume(bootVol);
640 gBIOSDev = dev;
641}
642*/
643
644#define BASE 65521L /* largest prime smaller than 65536 */
645#define NMAX 5000
646// NMAX (was 5521) the largest n such that 255n(n+1)/2 + (n+1)(BASE-1) <= 2^32-1
647
648#define DO1(buf,i) {s1 += buf[i]; s2 += s1;}
649#define DO2(buf,i) DO1(buf,i); DO1(buf,i+1);
650#define DO4(buf,i) DO2(buf,i); DO2(buf,i+2);
651#define DO8(buf,i) DO4(buf,i); DO4(buf,i+4);
652#define DO16(buf) DO8(buf,0); DO8(buf,8);
653
654unsigned long Adler32(unsigned char *buf, long len)
655{
656 unsigned long s1 = 1; // adler & 0xffff;
657 unsigned long s2 = 0; // (adler >> 16) & 0xffff;
658 unsigned long result;
659 int k;
660
661 while (len > 0) {
662 k = len < NMAX ? len : NMAX;
663 len -= k;
664 while (k >= 16) {
665 DO16(buf);
666 buf += 16;
667 k -= 16;
668 }
669 if (k != 0) do {
670 s1 += *buf++;
671 s2 += s1;
672 } while (--k);
673 s1 %= BASE;
674 s2 %= BASE;
675 }
676 result = (s2 << 16) | s1;
677 return OSSwapHostToBigInt32(result);
678}
679

Archive Download this file

Revision: 141