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

Archive Download this file

Revision: 388