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
197 finalizeBootStruct();
198
199 // Jump to kernel's entry point. There's no going back now.
200
201 startprog( kernelEntry, bootArgs );
202
203 // Not reached
204
205 return 0;
206}
207
208//==========================================================================
209// This is the entrypoint from real-mode which functions exactly as it did
210// before. Multiboot does its own runtime initialization, does some of its
211// own things, and then calls common_boot.
212void boot(int biosdev)
213{
214initialize_runtime();
215// Enable A20 gate before accessing memory above 1Mb.
216enableA20();
217common_boot(biosdev);
218}
219
220//==========================================================================
221// The 'main' function for the booter. Called by boot0 when booting
222// from a block device, or by the network booter.
223//
224// arguments:
225// biosdev - Value passed from boot1/NBP to specify the device
226// that the booter was loaded from.
227//
228// If biosdev is kBIOSDevNetwork, then this function will return if
229// booting was unsuccessful. This allows the PXE firmware to try the
230// next boot device on its list.
231void common_boot(int biosdev)
232{
233 int status;
234 char *bootFile;
235 unsigned long adler32;
236 bool quiet;
237 bool firstRun = true;
238 bool instantMenu;
239 bool rescanPrompt;
240 unsigned int allowBVFlags = kBVFlagSystemVolume|kBVFlagForeignBoot;
241 unsigned int denyBVFlags = kBVFlagEFISystem;
242
243 // Set reminder to unload the PXE base code. Neglect to unload
244 // the base code will result in a hang or kernel panic.
245 gUnloadPXEOnExit = true;
246
247 // Record the device that the booter was loaded from.
248 gBIOSDev = biosdev & kBIOSDevMask;
249
250 // Initialize boot info structure.
251 initKernBootStruct();
252
253 // Setup VGA text mode.
254 // Not sure if it is safe to call setVideoMode() before the
255 // config table has been loaded. Call video_mode() instead.
256#if DEBUG
257 printf("before video_mode\n");
258#endif
259 video_mode( 2 ); // 80x25 mono text mode.
260#if DEBUG
261 printf("after video_mode\n");
262#endif
263
264 // Scan and record the system's hardware information.
265 scan_platform();
266
267 // First get info for boot volume.
268 scanBootVolumes(gBIOSDev, 0);
269 bvChain = getBVChainForBIOSDev(gBIOSDev);
270 setBootGlobals(bvChain);
271
272 // Load boot.plist config file
273 status = loadSystemConfig(&bootInfo->bootConfig);
274
275 if (getBoolForKey(kQuietBootKey, &quiet, &bootInfo->bootConfig) && quiet) {
276 gBootMode |= kBootModeQuiet;
277 }
278
279 // Override firstRun to get to the boot menu instantly by setting "Instant Menu"=y in system config
280 if (getBoolForKey(kInstantMenuKey, &instantMenu, &bootInfo->bootConfig) && instantMenu) {
281 firstRun = false;
282 }
283
284 // Loading preboot ramdisk if exists.
285 loadPrebootRAMDisk();
286
287 // Disable rescan option by default
288 gEnableCDROMRescan = false;
289
290 // Enable it with Rescan=y in system config
291 if (getBoolForKey(kRescanKey, &gEnableCDROMRescan, &bootInfo->bootConfig) && gEnableCDROMRescan) {
292 gEnableCDROMRescan = true;
293 }
294
295 // Ask the user for Rescan option by setting "Rescan Prompt"=y in system config.
296 rescanPrompt = false;
297 if (getBoolForKey(kRescanPromptKey, &rescanPrompt , &bootInfo->bootConfig) && rescanPrompt && biosDevIsCDROM(gBIOSDev)) {
298 gEnableCDROMRescan = promptForRescanOption();
299 }
300
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 scanBootVolumes(gBIOSDev, &bvCount);
309 } else {
310 scanDisks(gBIOSDev, &bvCount);
311 }
312
313 // Create a separated bvr chain using the specified filters.
314 bvChain = newFilteredBVChain(0x80, 0xFF, allowBVFlags, denyBVFlags, &gDeviceCount);
315
316 gBootVolume = selectBootVolume(bvChain);
317
318#if DEBUG
319 printf(" Default: %d, ->biosdev: %d, ->part_no: %d ->flags: %d\n", gBootVolume, gBootVolume->biosdev, gBootVolume->part_no, gBootVolume->flags);
320 printf(" bt(0,0): %d, ->biosdev: %d, ->part_no: %d ->flags: %d\n", gBIOSBootVolume, gBIOSBootVolume->biosdev, gBIOSBootVolume->part_no, gBIOSBootVolume->flags);
321 getc();
322#endif
323
324 useGUI = true;
325 // Override useGUI default
326 getBoolForKey(kGUIKey, &useGUI, &bootInfo->bootConfig);
327 if (useGUI && initGUI())
328{
329// initGUI() returned with an error, disabling GUI.
330useGUI = false;
331}
332
333 setBootGlobals(bvChain);
334
335 // Parse args, load and start kernel.
336 while (1) {
337 const char *val;
338 int len;
339 int trycache;
340 long flags, cachetime, kerneltime, exttime, sleeptime, time;
341 int ret = -1;
342 void *binary = (void *)kLoadAddr;
343 bool tryresume;
344 bool tryresumedefault;
345 bool forceresume;
346
347 config_file_t systemVersion;// system.plist of booting partition
348char osxVersion[8]; // replaces gMacOSVersion here, for now.
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//Azi: doing this earlier to get the verbose from loadOverrideConfig.
363// Draw background, turn off any GUI elements and update VRAM.
364if ( bootArgs->Video.v_display == GRAPHICS_MODE )
365{
366drawBackground(); // order matters!!
367gui.devicelist.draw = false; // Needed when the verbose "flips" the screen.
368gui.bootprompt.draw = false; // ?
369gui.menu.draw = false; // ?
370gui.infobox.draw = false; // Enter doesn't work with this drawn; most probably it's not needed!?
371updateVRAM();
372}
373
374 status = processBootOptions();
375 // Status==1 means to chainboot
376 if ( status == 1 ) break;
377 // Status==-1 means that the config file couldn't be loaded or that gBootVolume is NULL
378 if ( status == -1 )
379 {
380 // gBootVolume == NULL usually means the user hit escape.
381 if(gBootVolume == NULL)
382 {
383 freeFilteredBVChain(bvChain);
384
385 if (gEnableCDROMRescan)
386 rescanBIOSDevice(gBIOSDev);
387
388 bvChain = newFilteredBVChain(0x80, 0xFF, allowBVFlags, denyBVFlags, &gDeviceCount);
389 setBootGlobals(bvChain);
390 }
391 continue;
392 }
393
394 // Other status (e.g. 0) means that we should proceed with boot.
395 // Found and loaded a config file. Proceed with boot.
396
397//Azi: still calling this here. The call on processBootOptions() gets hidden from verbose and
398// for some reason gMacOSVersion doesn't get initialized on boot.c like on the others. Later...
399// Find out which version mac os we're booting.
400if (!loadConfigFile("System/Library/CoreServices/SystemVersion.plist", &systemVersion)) {
401if (getValueForKey(kProductVersion, &val, &len, &systemVersion)) {
402// getValueForKey uses const char for val
403// so copy it and trim
404strncpy(osxVersion, val, MIN(len, 4));
405osxVersion[MIN(len, 4)] = '\0';
406}
407}
408
409// If cpu doesn't handle 64 bit instructions,...
410if (!platformCPUFeature(CPU_FEATURE_EM64T) ||
411// ... user forced i386 kernel architecture on cpu with "em64t"...
412getValueForKey(kArchI386Flag, &val, &len, &bootInfo->bootConfig) ||
413// ... or forced Legacy Mode...
414getValueForKey(kLegacyModeFlag, &val, &len, &bootInfo->bootConfig))
415{
416// ... use i386 kernel arch.
417archCpuType = CPU_TYPE_I386;
418}
419else
420{
421// Else use x86_64 kernel arch.
422archCpuType = CPU_TYPE_X86_64;
423}
424// Override i386/-legacy, if flagged on Boot.plist.
425if (getValueForKey(kArchX86_64Flag, &val, &len, &bootInfo->bootConfig))
426{
427archCpuType = CPU_TYPE_X86_64;
428}
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", osxVersion);
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 {
542 sprintf(bootFileSpec, "com.apple.boot.R/%s", bootFile);
543 ret = GetFileInfo(NULL, bootFileSpec, &flags, &time);
544 if (ret == -1)
545 {
546 sprintf(bootFileSpec, "com.apple.boot.S/%s", bootFile);
547 ret = GetFileInfo(NULL, bootFileSpec, &flags, &time);
548 if (ret == -1)
549 {
550 // Not found any alternate locations, using the original kernel image path.
551 strcpy(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 {
560 archCpuType = CPU_TYPE_I386;
561 ret = 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
575if(gui.initialised) {
576sleep(1);
577drawBackground();
578gui.devicelist.draw = true;
579gui.redraw = true;
580}
581 if (gBootFileType == kNetworkDeviceType) {
582 // Return control back to PXE. Don't unload PXE base code.
583 gUnloadPXEOnExit = false;
584 break;
585 }
586 } else {
587 /* Won't return if successful. */
588 ret = ExecKernel(binary);
589 }
590 }
591
592 // chainboot
593 if (status==1) {
594if (getVideoMode() == GRAPHICS_MODE) {// if we are already in graphics-mode,
595setVideoMode(VGA_TEXT_MODE, 0);// switch back to text mode
596}
597 }
598
599 if ((gBootFileType == kNetworkDeviceType) && gUnloadPXEOnExit) {
600nbpUnloadBaseCode();
601 }
602}
603
604/*!
605 Selects a new BIOS device, taking care to update the global state appropriately.
606 */
607/*
608static void selectBiosDevice(void)
609{
610 struct DiskBVMap *oldMap = diskResetBootVolumes(gBIOSDev);
611 CacheReset();
612 diskFreeMap(oldMap);
613 oldMap = NULL;
614
615 int dev = selectAlternateBootDevice(gBIOSDev);
616
617 BVRef bvchain = scanBootVolumes(dev, 0);
618 BVRef bootVol = selectBootVolume(bvchain);
619 gBootVolume = bootVol;
620 setRootVolume(bootVol);
621 gBIOSDev = dev;
622}
623*/
624
625#define BASE 65521L /* largest prime smaller than 65536 */
626#define NMAX 5000
627// NMAX (was 5521) the largest n such that 255n(n+1)/2 + (n+1)(BASE-1) <= 2^32-1
628
629#define DO1(buf,i) {s1 += buf[i]; s2 += s1;}
630#define DO2(buf,i) DO1(buf,i); DO1(buf,i+1);
631#define DO4(buf,i) DO2(buf,i); DO2(buf,i+2);
632#define DO8(buf,i) DO4(buf,i); DO4(buf,i+4);
633#define DO16(buf) DO8(buf,0); DO8(buf,8);
634
635unsigned long Adler32(unsigned char *buf, long len)
636{
637 unsigned long s1 = 1; // adler & 0xffff;
638 unsigned long s2 = 0; // (adler >> 16) & 0xffff;
639 unsigned long result;
640 int k;
641
642 while (len > 0) {
643 k = len < NMAX ? len : NMAX;
644 len -= k;
645 while (k >= 16) {
646 DO16(buf);
647 buf += 16;
648 k -= 16;
649 }
650 if (k != 0) do {
651 s1 += *buf++;
652 s2 += s1;
653 } while (--k);
654 s1 %= BASE;
655 s2 %= BASE;
656 }
657 result = (s2 << 16) | s1;
658 return OSSwapHostToBigInt32(result);
659}
660

Archive Download this file

Revision: 378