From: Jack Lange Date: Fri, 1 May 2009 19:44:38 +0000 (-0500) Subject: removed superfulous build documentation X-Git-Url: http://v3vee.org/palacios/gitweb/gitweb.cgi?p=palacios.git;a=commitdiff_plain;h=54422ed2a539195fca95bc065627d38f0dfbda34 removed superfulous build documentation --- diff --git a/build/Makefile.MASTER.BACKUP b/build/Makefile.MASTER.BACKUP deleted file mode 100644 index b01fc50..0000000 --- a/build/Makefile.MASTER.BACKUP +++ /dev/null @@ -1,571 +0,0 @@ -# Makefile for GeekOS kernel, userspace, and tools -# -# Northwestern University -# (c) 2008, Jack Lange -# (c) 2008, Peter Dinda -# (c) 2008, Lei Xia -# (c) 2008, The V3VEE Project -# -# Based on GeekOS Makefile: -# Copyright (c) 2004,2005 David H. Hovemeyer -# $Revision: 1.71 $ - - -# This is free software. You are permitted to use, -# redistribute, and modify it as specified in the file "COPYING". - -# Required software to build GeekOS: -# - GNU Make (http://www.gnu.org/software/make) -# - gcc 2.95.2 generating code for target (i386/ELF) and host platforms -# - nasm (http://nasm.sourceforge.net) -# - Perl5, AWK (any version), egrep -# -# Cygwin (http://cygwin.com) may be used to build GeekOS. -# Make sure that gcc, binutils, nasm, and perl are installed. - -# NOTES: -# - This makefile has been written carefully to work correctly -# with the -j (parallel make) option. I regularly use "make -j 2" -# to speed the build process on 2 processor systems. - - -# Base address of kernel -# -# Note: at top of memory minus three pages (GDT/TSS/IDT) -# minus maximum size -# -# -# Note that the code will initially load at 0x10000 -# -# The setup code needs to copy it up to this address and jump there -# -KERNEL_BASE_ADDR := 0x00100000 - -# Kernel entry point function -KERNEL_ENTRY = $(SYM_PFX)Main - - -PROJECT_ROOT := .. -VPATH := $(PROJECT_ROOT)/src - -#when -DNDEBUG is set the kassert functions are disabled -#JRLDEBUG=-DNDEBUG - -# DEBUG=1 means VMM_DEBUG, VMM_INFO, and VMM_TRACE are enabled -# as are SERIAL_PRINT_DEBUG -# -DEBUG=1 -DEBUG_SECTIONS= - -ifeq ($(DEBUG_ALL),1) - DEBUG_SECTIONS:= $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING -DDEBUG_CTRL_REGS -DDEBUG_INTERRUPTS -DDEBUG_IO -DDEBUG_KEYBOARD -DDEBUG_PIC -DDEBUG_PIT -DDEBUG_NVRAM -DDEBUG_EMULATOR -DDEBUG_GENERIC -DDEBUG_RAMDISK -endif - -ifeq ($(DEBUG_SHADOW_PAGING),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING -else -ifeq ($(DEBUG_SHADOW_PAGING),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_SHADOW_PAGING -endif -endif - -ifeq ($(DEBUG_CTRL_REGS),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_CTRL_REGS -else -ifeq ($(DEBUG_CTRL_REGS),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_CTRL_REGS -endif -endif - -ifeq ($(DEBUG_INTERRUPTS),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_INTERRUPTS -else -ifeq ($(DEBUG_DEBUG_INTERRUPTS),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_INTERRUPTS -endif -endif - -ifeq ($(DEBUG_IO),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IO -else -ifeq ($(DEBUG_IO),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_IO -endif -endif - -ifeq ($(DEBUG_KEYBOARD),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_KEYBOARD -else -ifeq ($(DEBUG_KEYBOARD),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_KEYBOARD -endif -endif - -ifeq ($(DEBUG_PIC),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIC -else -ifeq ($(DEBUG_PIC),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIC -endif -endif - -ifeq ($(DEBUG_PIT),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIT -else -ifeq ($(DEBUG_PIT),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIT -endif -endif - -ifeq ($(DEBUG_NVRAM),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NVRAM -else -ifeq ($(DEBUG_NVRAM),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_NVRAM -endif -endif - -ifeq ($(DEBUG_GENERIC),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_GENERIC -else -ifeq ($(DEBUG_GENERIC),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_GENERIC -endif -endif - -ifeq ($(DEBUG_EMULATOR),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_EMULATOR -else -ifeq ($(DEBUG_EMULATOR),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_EMULATOR -endif -endif - -ifeq ($(DEBUG_RAMDISK),1) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_RAMDISK -else -ifeq ($(DEBUG_RAMDISK),0) -DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_RAMDISK -endif -endif - - -#DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DTEST_NE2K - -ifeq ($(DEBUG),1) - JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1 -DVMM_DEBUG=1 -DVMM_INFO=1 -DVMM_TRACE=1 $(DEBUG_SECTIONS) - -else - JRLDEBUG= -DSERIAL_PRINT_DEBUG=0 -DSERIAL_PRINT_DEBUG_LEVEL=999999 -DSERIAL_PRINT=0 -DVMM_DEBUG=0 -DVMM_INFO=0 -DVMM_TRACE=0 -endif - - -# -# DECODER is the decoder that will be used -# currently we only support xed -# -DECODER=XED - -DECODER_FLAGS= -DECODER_SRCS= -DECODER_LIBS= - -ifeq ($(DECODER),XED) -DECODER_SRCS := vmm_xed.c -DECODER_FLAGS := -L../lib/xed -DECODER_LIBS := -lxed -else -# This is an error -endif - -# -#TCPSTACK, uIP is used currently -# -TCPSTACK=UIP - - - - -# -# This is wrong for current cygwin - no changes needed -# -# Figure out if we're compiling with cygwin, http://cygwin.com -# -# -#SYSTEM_NAME := $(shell uname -s) -#ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN) -#SYM_PFX := _ -#EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32 -#EXTRA_NASM_OPTS := -DNEED_UNDERSCORE -#NON_ELF_SYSTEM := yes -#EXTRA_CC_USER_OPTS := -Dmain=geekos_main -#endif - - - - -# ---------------------------------------------------------------------- -# Configuration - -# Various options specifying how GeekOS should be built, -# what source files to build, which user programs to build, -# etc. This is generally the only section of the makefile -# that will need to be modified. -# ---------------------------------------------------------------------- - -# List of targets to build by default. -# These targets encompass everything needed to boot -# and run GeekOS. -ALL_TARGETS := vmm.img vm_kernel - - -# Kernel source files -KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \ - blockdev.c ide.c ne2k.c \ - keyboard.c screen.c timer.c \ - mem.c crc32.c \ - gdt.c tss.c segment.c \ - bget.c malloc.c \ - synch.c kthread.c \ - serial.c reboot.c \ - paging.c \ - debug.c vmm_stubs.c vm.c pci.c\ - queue.c socket.c net.c ring_buffer.c \ - main.c - - -# Kernel object files built from C source files -KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o) - -# Kernel assembly files -KERNEL_ASM_SRCS := lowlevel.asm - -KERNEL_GAS_SRCS := testvm.s udivdi3.s - -# Kernel object files build from assembler source files -KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o) - -KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o) - - -# All kernel object files -KERNEL_OBJS := $(KERNEL_C_OBJS) \ - $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS) - -# Common library source files. -# This library is linked into both the kernel and user programs. -# It provides string functions and generic printf()-style -# formatted output. -COMMON_C_SRCS := fmtout.c string.c memmove.c - -# Common library object files. -COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o) - -VMM_ASM_SRCS := svm_lowlevel.asm \ -# vmx_lowlevel.asm - -VMM_ASM_OBJS := $(VMM_ASM_SRCS:%.asm=palacios/%.o) - - -VMM_C_SRCS := vm_guest.c \ - svm.c svm_handler.c vmm.c vmm_util.c vmm_ctrl_regs.c \ - vmcb.c vmm_mem.c vmm_paging.c vmm_io.c vmm_debug.c svm_io.c \ - vmm_intr.c vmm_time.c \ - vmm_shadow_paging.c vm_guest_mem.c \ - vm_dev.c vmm_dev_mgr.c vmm_decoder.c \ - svm_halt.c svm_pause.c svm_wbinvd.c \ - vmm_config.c vmm_hashtable.c \ - vmm_string.c vmm_emulator.c vmm_queue.c\ - $(DECODER_SRCS) -# vmx.c vmcs_gen.c vmcs.c - -VMM_C_OBJS := $(VMM_C_SRCS:%.c=palacios/%.o) - -VMM_OBJS := $(VMM_C_OBJS) $(VMM_ASM_OBJS) - - - - -DEVICE_C_SRCS := generic.c keyboard.c nvram.c timer.c simple_pic.c 8259a.c 8254.c serial.c ramdisk.c cdrom.c - -DEVICE_C_OBJS := $(DEVICE_C_SRCS:%.c=devices/%.o) - -DEVICE_OBJS := $(DEVICE_C_OBJS) - -V3LIBS := $(DECODER_LIBS) - - -TCPSTACK_C_SRCS := psock.c timer.c uip_arp.c uip.c uip-fw.c uiplib.c uip-neighbor.c uip-split.c resolv.c - -TCPSTACK_C_OBJS := $(TCPSTACK_C_SRCS:%.c=net/%.o) - -TCPSTACK_OBJS := $(TCPSTACK_C_OBJS) - - - - -# ---------------------------------------------------------------------- -# Tools - -# This section defines programs that are used to build GeekOS. -# ---------------------------------------------------------------------- - -# Uncomment if cross compiling -TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf- -#TARGET_CC_PREFIX := i386-elf- - -# Target C compiler. gcc 2.95.2 or later should work. -TARGET_CC := $(TARGET_CC_PREFIX)gcc -#TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32 - -# Host C compiler. This is used to compile programs to execute on -# the host platform, not the target (x86) platform. On x86/ELF -# systems, such as Linux and FreeBSD, it can generally be the same -# as the target C compiler. -HOST_CC := gcc - -# Target linker. GNU ld is probably to only one that will work. -TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386 - -# Target archiver -TARGET_AR := $(TARGET_CC_PREFIX)ar - -# Target ranlib -TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib - -# Target nm -TARGET_NM := $(TARGET_CC_PREFIX)nm - -# Target objcopy -TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy - -# Nasm (http://nasm.sourceforge.net) -NASM := $(PROJECT_ROOT)/../devtools/bin/nasm -#NASM := /opt/vmm-tools/bin/nasm - -AS = as --32 - -# Tool to build PFAT filesystem images. -BUILDFAT := tools/builtFat.exe - -# Perl5 or later -PERL := perl - -# Pad a file so its size is a multiple of some unit (i.e., sector size) -PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad - -# Create a file filled with zeroes. -ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile - -# Calculate size of file in sectors -NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs - - -FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track - - -# ---------------------------------------------------------------------- -# Definitions - -# Options passed to the tools. -# ---------------------------------------------------------------------- - -# Flags used for all C source files -GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(VMM_FLAGS) $(BOOT_FLAGS) -fPIC -CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror - -# Flags used for kernel C source files -CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include - -# Flags used for VMM C source files -CC_VMM_OPTS := -g -I$(PROJECT_ROOT)/include -D__V3VEE__ -D__V3_32BIT__ $(DECODER_FLAGS) $(JRLDEBUG) - -# Flags used for VMM C ASM files -NASM_VMM_OPTS := -I$(PROJECT_ROOT)/src/palacios/ -f elf $(EXTRA_NASM_OPTS) - -# Flags user for kernel assembly files -NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS) - -# Flags used for common library and libc source files -CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \ - $(EXTRA_CC_USER_OPTS) - -# Flags passed to objcopy program (strip unnecessary sections from kernel.exe) -OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment - -# ---------------------------------------------------------------------- -# Rules - -# Describes how to compile the source files. -# ---------------------------------------------------------------------- - -# Compilation of kernel C source files - -geekos/%.o : geekos/%.c - $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o - - -# Compilation of kernel assembly source files -geekos/%.o : geekos/%.asm - $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o - -# Compilation of test VM -geekos/%.o : geekos/%.s - $(AS) $< -o geekos/$*.o - -geekos/%.o : geekos/%.S - $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o - -# Compilation of common library C source files -common/%.o : common/%.c - $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o - -palacios/%.o : palacios/%.c - $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o palacios/$*.o - -palacios/%.o : palacios/%.asm - $(NASM) $(NASM_VMM_OPTS) $< -o palacios/$*.o - -devices/%.o : devices/%.c - $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o devices/$*.o - -devices/%.o : devices/%.asm - $(NASM) $(NASM_VMM_OPTS) $< -o devices/$*.o - -net/%.o : net/%.c - $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o net/$*.o - -# ---------------------------------------------------------------------- -# Targets - -# Specifies files to be built -# ---------------------------------------------------------------------- - -# Default target - see definition of ALL_TARGETS in Configuration section -all : $(ALL_TARGETS) - - -#geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm -# $(NASM) -O99 \ -# -f elf \ -# -I$(PROJECT_ROOT)/src/geekos/ \ -# $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \ -# -o $@ - - -#geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -# $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test - -# Standard floppy image - just boots the kernel -fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin - cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp - $(PAD) _temp 512 - cp _temp fd.img - -vmm.img : fd.img - cp fd.img vmm.img - $(PAD) vmm.img 1474560 - -rombios_link: - ln -s -f ../src/vmboot/rombios/BIOS-bochs-latest rombios - -vgabios_link: - ln -s -f ../src/vmboot/vgabios/VGABIOS-lgpl-latest.bin vgabios - -force_rombios: rombios_link - (cd ../src/vmboot/rombios; make clean; make) - -force_vgabios: vgabios_link - (cd ../src/vmboot/vgabios; make clean; make) - -force_payload: force_rombios force_vgabios - ../scripts/make_payload.pl payload_layout.txt vm_kernel - -inter1: force_payload - -make clean - -world: inter1 vmm.img - -# make ready to boot over PXE -pxe: vmm.img - cp vmm.img /tftpboot/vmm.img - -run: vmm.img - /usr/local/qemu/bin/qemu-system-x86_64 -m 1024 -serial file:serial.out -cdrom puppy.iso -fda vmm.img - -iso: vmm.img - cp vmm.img iso/vmm.img - mkisofs -R -b boot/grub/stage2_eltorito -no-emul-boot -boot-load-size 4 -boot-info-table -o test.iso iso - - - -# Floppy boot sector (first stage boot loader). -geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm - $(NASM) -f bin \ - -I$(PROJECT_ROOT)/src/geekos/ \ - -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \ - -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \ - -DSECTORS_PER_TRACK=`$(FD_SECTORS_PER_TRACK) geekos/kernel.bin geekos/setup.bin` \ - $(PROJECT_ROOT)/src/geekos/fd_boot.asm \ - -o $@ - -# Setup program (second stage boot loader). -geekos/setup.bin : geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/setup.asm - $(NASM) -f bin \ - -I$(PROJECT_ROOT)/src/geekos/ \ - -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \ - -DVMM_SIZE=`$(NUMSECS) geekos/kernel.bin` \ - $(PROJECT_ROOT)/src/geekos/setup.asm \ - -o $@ - $(PAD) $@ 2048 - -# Loadable (flat) kernel image. -geekos/kernel.bin : geekos/kernel.exe - $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin - $(PAD) $@ 512 - -# The kernel executable and symbol map. -geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(TCPSTACK_OBJS) vm_kernel - $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \ - $(DECODER_FLAGS) \ - $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(V3LIBS) $(TCPSTACK_OBJS) -b binary vm_kernel - $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms - - -force: - - -#vm_kernel: force -# $(PAD) vm_kernel 512 -# @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long" - - - - -# Clean build directories of generated files -clean : - for d in geekos common libc user tools palacios devices net; do \ - (cd $$d && rm -f *); \ - done - - -# Build header file dependencies, so source files are recompiled when -# header files they depend on are modified. -depend : $(GENERATED_LIBC_SRCS) - $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \ - $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \ - | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \ - > depend.mak - $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \ - $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \ - | $(PERL) -n -e 's,^(\S),common/$$1,;print' \ - >> depend.mak - $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \ - $(VMM_C_SRCS:%.c=$(PROJECT_ROOT)/src/palacios/%.c) \ - | $(PERL) -n -e 's,^(\S),palacios/$$1,;print' \ - >> depend.mak - $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \ - $(DEVICE_C_SRCS:%.c=$(PROJECT_ROOT)/src/devices/%.c) \ - | $(PERL) -n -e 's,^(\S),devices/$$1,;print' \ - >> depend.mak - -# By default, there are no header file dependencies. -depend.mak : - touch $@ - -include depend.mak diff --git a/build/RunPuppy.sh b/build/RunPuppy.sh deleted file mode 100755 index 315707e..0000000 --- a/build/RunPuppy.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh -cp ../geekos/build/vmm.img ./ -/usr/local/qemu/bin/qemu-system-x86_64 -serial file:serial.out -m 1024 -fda vmm.img -cdrom /opt/vmm-tools/isos/puppy.iso diff --git a/build/RunXP.sh b/build/RunXP.sh deleted file mode 100755 index b78ed47..0000000 --- a/build/RunXP.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh - -/usr/local/qemu/bin/qemu-system-x86_64 -serial file:serial.out -m 1024 -fda vmm.img -cdrom /opt/vmm-tools/isos/winxp.iso