1 # Makefile for GeekOS kernel, userspace, and tools
2 # Copyright (c) 2004,2005 David H. Hovemeyer <daveho@cs.umd.edu>
5 # This is free software. You are permitted to use,
6 # redistribute, and modify it as specified in the file "COPYING".
8 # Required software to build GeekOS:
9 # - GNU Make (http://www.gnu.org/software/make)
10 # - gcc 2.95.2 generating code for target (i386/ELF) and host platforms
11 # - nasm (http://nasm.sourceforge.net)
12 # - Perl5, AWK (any version), egrep
14 # Cygwin (http://cygwin.com) may be used to build GeekOS.
15 # Make sure that gcc, binutils, nasm, and perl are installed.
18 # - This makefile has been written carefully to work correctly
19 # with the -j (parallel make) option. I regularly use "make -j 2"
20 # to speed the build process on 2 processor systems.
23 # Base address of kernel
25 # Note: at top of memory minus three pages (GDT/TSS/IDT)
29 # Note that the code will initially load at 0x10000
31 # The setup code needs to copy it up to this address and jump there
33 KERNEL_BASE_ADDR := 0x00100000
35 # Kernel entry point function
36 KERNEL_ENTRY = $(SYM_PFX)Main
40 VPATH := $(PROJECT_ROOT)/src
42 #when -DNDEBUG is set the kassert functions are disabled
45 # DEBUG=1 means VMM_DEBUG, VMM_INFO, and VMM_TRACE are enabled
46 # as are SERIAL_PRINT_DEBUG
51 ifeq ($(DEBUG_SHADOW_PAGING),1)
52 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING
54 ifeq ($(DEBUG_CTRL_REGS),1)
55 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_CTRL_REGS
57 ifeq ($(DEBUG_INTERRUPTS),1)
58 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_INTERRUPTS
61 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IO
63 ifeq ($(DEBUG_KEYBOARD),1)
64 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_KEYBOARD
67 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIC
69 ifeq ($(DEBUG_DEBUG_PIT),1)
70 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIT
72 ifeq ($(DEBUG_NVRAM),1)
73 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NVRAM
79 # XED=1 means that libxed will be included
83 # and make world will build an empty boot package
88 JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1 -DVMM_DEBUG=1 -DVMM_INFO=1 -DVMM_TRACE=1 $(DEBUG_SECTIONS)
91 JRLDEBUG= -DSERIAL_PRINT_DEBUG=0 -DSERIAL_PRINT_DEBUG_LEVEL=999999 -DSERIAL_PRINT=0 -DVMM_DEBUG=0 -DVMM_INFO=0 -DVMM_TRACE=0
104 #Peter's compile flags
108 # This is wrong for current cygwin - no changes needed
110 # Figure out if we're compiling with cygwin, http://cygwin.com
113 #SYSTEM_NAME := $(shell uname -s)
114 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
116 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
117 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
118 #NON_ELF_SYSTEM := yes
119 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
125 # ----------------------------------------------------------------------
127 # Various options specifying how GeekOS should be built,
128 # what source files to build, which user programs to build,
129 # etc. This is generally the only section of the makefile
130 # that will need to be modified.
131 # ----------------------------------------------------------------------
133 # List of targets to build by default.
134 # These targets encompass everything needed to boot
136 ALL_TARGETS := vmm.img vm_kernel
139 # Kernel source files
140 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
142 keyboard.c screen.c timer.c \
144 gdt.c tss.c segment.c \
149 debug.c vmm_stubs.c vm.c pci.c\
152 # Kernel object files built from C source files
153 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
155 # Kernel assembly files
156 KERNEL_ASM_SRCS := lowlevel.asm
158 KERNEL_GAS_SRCS := testvm.s udivdi3.s
160 # Kernel object files build from assembler source files
161 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
163 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
166 # All kernel object files
167 KERNEL_OBJS := $(KERNEL_C_OBJS) \
168 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
170 # Common library source files.
171 # This library is linked into both the kernel and user programs.
172 # It provides string functions and generic printf()-style
174 COMMON_C_SRCS := fmtout.c string.c memmove.c
176 # Common library object files.
177 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
179 VMM_ASM_SRCS := svm_lowlevel.asm \
182 VMM_ASM_OBJS := $(VMM_ASM_SRCS:%.asm=palacios/%.o)
185 VMM_C_SRCS := vm_guest.c \
186 svm.c svm_handler.c vmm.c vmm_util.c vmm_ctrl_regs.c \
187 vmcb.c vmm_mem.c vmm_paging.c vmm_io.c vmm_debug.c svm_io.c \
188 vmm_intr.c vmm_time.c\
189 vmm_shadow_paging.c vm_guest_mem.c \
190 vm_dev.c vmm_dev_mgr.c vmm_decoder.c \
191 svm_halt.c svm_pause.c
193 # vmx.c vmcs_gen.c vmcs.c
195 VMM_C_OBJS := $(VMM_C_SRCS:%.c=palacios/%.o)
197 VMM_OBJS := $(VMM_C_OBJS) $(VMM_ASM_OBJS)
199 DEVICE_C_SRCS := generic.c keyboard.c nvram.c timer.c simple_pic.c 8259a.c 8254.c serial.c
201 DEVICE_C_OBJS := $(DEVICE_C_SRCS:%.c=devices/%.o)
203 DEVICE_OBJS := $(DEVICE_C_OBJS)
208 V3LIBS := $(V3LIBS) -L../lib/xed -lxed
212 # ----------------------------------------------------------------------
214 # This section defines programs that are used to build GeekOS.
215 # ----------------------------------------------------------------------
217 # Uncomment if cross compiling
218 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
219 #TARGET_CC_PREFIX := i386-elf-
221 # Target C compiler. gcc 2.95.2 or later should work.
222 TARGET_CC := $(TARGET_CC_PREFIX)gcc
223 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
225 # Host C compiler. This is used to compile programs to execute on
226 # the host platform, not the target (x86) platform. On x86/ELF
227 # systems, such as Linux and FreeBSD, it can generally be the same
228 # as the target C compiler.
231 # Target linker. GNU ld is probably to only one that will work.
232 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
235 TARGET_AR := $(TARGET_CC_PREFIX)ar
238 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
241 TARGET_NM := $(TARGET_CC_PREFIX)nm
244 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
246 # Nasm (http://nasm.sourceforge.net)
247 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
248 #NASM := /opt/vmm-tools/bin/nasm
252 # Tool to build PFAT filesystem images.
253 BUILDFAT := tools/builtFat.exe
258 # Pad a file so its size is a multiple of some unit (i.e., sector size)
259 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
261 # Create a file filled with zeroes.
262 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
264 # Calculate size of file in sectors
265 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
268 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
271 # ----------------------------------------------------------------------
273 # Options passed to the tools.
274 # ----------------------------------------------------------------------
276 # Flags used for all C source files
277 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(JRLDEBUG) $(PADFLAGS) $(LEIFLAGS) -fPIC
278 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
280 # Flags used for kernel C source files
281 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include
283 # Flags used for VMM C source files
284 CC_VMM_OPTS := -g -I$(PROJECT_ROOT)/include -D__V3VEE__ -D__V3_32BIT__
286 # Flags used for VMM C ASM files
287 NASM_VMM_OPTS := -I$(PROJECT_ROOT)/src/palacios/ -f elf $(EXTRA_NASM_OPTS)
289 # Flags user for kernel assembly files
290 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
292 # Flags used for common library and libc source files
293 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
294 $(EXTRA_CC_USER_OPTS)
296 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
297 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
299 # ----------------------------------------------------------------------
301 # Describes how to compile the source files.
302 # ----------------------------------------------------------------------
304 # Compilation of kernel C source files
306 geekos/%.o : geekos/%.c
307 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
310 # Compilation of kernel assembly source files
311 geekos/%.o : geekos/%.asm
312 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
314 # Compilation of test VM
315 geekos/%.o : geekos/%.s
316 $(AS) $< -o geekos/$*.o
318 geekos/%.o : geekos/%.S
319 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
321 # Compilation of common library C source files
322 common/%.o : common/%.c
323 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
325 palacios/%.o : palacios/%.c
326 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o palacios/$*.o
328 palacios/%.o : palacios/%.asm
329 $(NASM) $(NASM_VMM_OPTS) $< -o palacios/$*.o
331 devices/%.o : devices/%.c
332 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o devices/$*.o
334 devices/%.o : devices/%.asm
335 $(NASM) $(NASM_VMM_OPTS) $< -o devices/$*.o
337 # ----------------------------------------------------------------------
339 # Specifies files to be built
340 # ----------------------------------------------------------------------
342 # Default target - see definition of ALL_TARGETS in Configuration section
346 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
349 # -I$(PROJECT_ROOT)/src/geekos/ \
350 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
354 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
355 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
357 # Standard floppy image - just boots the kernel
358 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin
359 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp
365 $(PAD) vmm.img 1474560
368 (cd ../src/vmboot/rombios; make clean; make)
371 (cd ../src/vmboot/vgabios; make clean; make)
373 force_payload: force_rombios force_vgabios
375 ../scripts/make_payload.pl payload_none.txt vm_kernel
377 ../scripts/make_payload.pl payload_layout.txt vm_kernel
380 inter1: force_payload
383 world: inter1 vmm.img
385 # make ready to boot over PXE
387 cp vmm.img /tftpboot/vmm.img
390 /usr/local/qemu/bin/qemu-system-x86_64 -m 1024 -serial file:serial.out -cdrom puppy.iso -fda vmm.img
395 # Floppy boot sector (first stage boot loader).
396 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm
398 -I$(PROJECT_ROOT)/src/geekos/ \
399 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
400 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
401 -DSECTORS_PER_TRACK=`$(FD_SECTORS_PER_TRACK) geekos/kernel.bin geekos/setup.bin` \
402 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
405 # Setup program (second stage boot loader).
406 geekos/setup.bin : geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/setup.asm
408 -I$(PROJECT_ROOT)/src/geekos/ \
409 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
410 -DVMM_SIZE=`$(NUMSECS) geekos/kernel.bin` \
411 $(PROJECT_ROOT)/src/geekos/setup.asm \
415 # Loadable (flat) kernel image.
416 geekos/kernel.bin : geekos/kernel.exe
417 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
420 # The kernel executable and symbol map.
421 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) vm_kernel
422 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
423 $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(V3LIBS) -b binary vm_kernel
424 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
431 # $(PAD) vm_kernel 512
432 # @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long"
437 # Clean build directories of generated files
439 for d in geekos common libc user tools palacios devices; do \
440 (cd $$d && rm -f *); \
444 # Build header file dependencies, so source files are recompiled when
445 # header files they depend on are modified.
446 depend : $(GENERATED_LIBC_SRCS)
447 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
448 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
449 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
451 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
452 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
453 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
455 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
456 $(VMM_C_SRCS:%.c=$(PROJECT_ROOT)/src/palacios/%.c) \
457 | $(PERL) -n -e 's,^(\S),palacios/$$1,;print' \
459 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
460 $(DEVICE_C_SRCS:%.c=$(PROJECT_ROOT)/src/devices/%.c) \
461 | $(PERL) -n -e 's,^(\S),devices/$$1,;print' \
464 # By default, there are no header file dependencies.