Chameleon

Chameleon Svn Source Tree

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

Archive Download this file

Revision: 321