Chameleon

Chameleon Svn Source Tree

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

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

Archive Download this file

Revision: 635