1 # Makefile for GeekOS kernel, userspace, and tools
3 # Northwestern University
4 # (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
5 # (c) 2008, Peter Dinda <pdinda@northwestern.edu>
6 # (c) 2008, Lei Xia <xiaxlei@gmail.com>
7 # (c) 2008, The V3VEE Project <http://www.v3vee.org>
9 # Based on GeekOS Makefile:
10 # Copyright (c) 2004,2005 David H. Hovemeyer <daveho@cs.umd.edu>
14 # This is free software. You are permitted to use,
15 # redistribute, and modify it as specified in the file "COPYING".
17 # Required software to build GeekOS:
18 # - GNU Make (http://www.gnu.org/software/make)
19 # - gcc 2.95.2 generating code for target (i386/ELF) and host platforms
20 # - nasm (http://nasm.sourceforge.net)
21 # - Perl5, AWK (any version), egrep
23 # Cygwin (http://cygwin.com) may be used to build GeekOS.
24 # Make sure that gcc, binutils, nasm, and perl are installed.
27 # - This makefile has been written carefully to work correctly
28 # with the -j (parallel make) option. I regularly use "make -j 2"
29 # to speed the build process on 2 processor systems.
32 # Base address of kernel
34 # Note: at top of memory minus three pages (GDT/TSS/IDT)
38 # Note that the code will initially load at 0x10000
40 # The setup code needs to copy it up to this address and jump there
42 KERNEL_BASE_ADDR := 0x00100000
44 # Kernel entry point function
45 KERNEL_ENTRY = $(SYM_PFX)Main
49 VPATH := $(PROJECT_ROOT)/src
51 #when -DNDEBUG is set the kassert functions are disabled
54 # DEBUG=1 means VMM_DEBUG, VMM_INFO, and VMM_TRACE are enabled
55 # as are SERIAL_PRINT_DEBUG
61 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
64 ifeq ($(DEBUG_SHADOW_PAGING),1)
65 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING
67 ifeq ($(DEBUG_SHADOW_PAGING),0)
68 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_SHADOW_PAGING
72 ifeq ($(DEBUG_CTRL_REGS),1)
73 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_CTRL_REGS
75 ifeq ($(DEBUG_CTRL_REGS),0)
76 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_CTRL_REGS
80 ifeq ($(DEBUG_INTERRUPTS),1)
81 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_INTERRUPTS
83 ifeq ($(DEBUG_DEBUG_INTERRUPTS),0)
84 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_INTERRUPTS
89 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IO
92 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_IO
96 ifeq ($(DEBUG_KEYBOARD),1)
97 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_KEYBOARD
99 ifeq ($(DEBUG_KEYBOARD),0)
100 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_KEYBOARD
104 ifeq ($(DEBUG_PIC),1)
105 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIC
107 ifeq ($(DEBUG_PIC),0)
108 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIC
112 ifeq ($(DEBUG_PIT),1)
113 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIT
115 ifeq ($(DEBUG_PIT),0)
116 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIT
120 ifeq ($(DEBUG_NVRAM),1)
121 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NVRAM
123 ifeq ($(DEBUG_NVRAM),0)
124 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_NVRAM
128 ifeq ($(DEBUG_GENERIC),1)
129 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_GENERIC
131 ifeq ($(DEBUG_GENERIC),0)
132 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_GENERIC
136 ifeq ($(DEBUG_EMULATOR),1)
137 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_EMULATOR
139 ifeq ($(DEBUG_EMULATOR),0)
140 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_EMULATOR
144 ifeq ($(DEBUG_RAMDISK),1)
145 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_RAMDISK
147 ifeq ($(DEBUG_RAMDISK),0)
148 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_RAMDISK
153 #DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DTEST_NE2K
156 JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1 -DVMM_DEBUG=1 -DVMM_INFO=1 -DVMM_TRACE=1 $(DEBUG_SECTIONS)
159 JRLDEBUG= -DSERIAL_PRINT_DEBUG=0 -DSERIAL_PRINT_DEBUG_LEVEL=999999 -DSERIAL_PRINT=0 -DVMM_DEBUG=0 -DVMM_INFO=0 -DVMM_TRACE=0
164 # DECODER is the decoder that will be used
165 # currently we only support xed
173 ifeq ($(DECODER),XED)
174 DECODER_SRCS := vmm_xed.c
175 DECODER_FLAGS := -L../lib/xed
176 DECODER_LIBS := -lxed
182 #TCPSTACK, uIP is used currently
187 #LWIP, ON -- used, OFF -- not used
197 ifeq ($(RAMDISK_BOOT),1)
198 BOOT_FLAGS := $(BOOT_FLAGS) -DRAMDISK_BOOT
199 RAMDISK_SRCS := ramdisk.c cdrom.c
205 # This is wrong for current cygwin - no changes needed
207 # Figure out if we're compiling with cygwin, http://cygwin.com
210 #SYSTEM_NAME := $(shell uname -s)
211 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
213 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
214 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
215 #NON_ELF_SYSTEM := yes
216 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
222 # ----------------------------------------------------------------------
224 # Various options specifying how GeekOS should be built,
225 # what source files to build, which user programs to build,
226 # etc. This is generally the only section of the makefile
227 # that will need to be modified.
228 # ----------------------------------------------------------------------
230 # List of targets to build by default.
231 # These targets encompass everything needed to boot
233 ALL_TARGETS := vmm.img vm_kernel
236 # Kernel source files
237 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
238 blockdev.c ide.c ne2k.c \
239 keyboard.c screen.c timer.c \
241 gdt.c tss.c segment.c \
246 debug.c vmm_stubs.c vm.c pci.c\
247 queue.c socket.c net.c ring_buffer.c \
251 # Kernel object files built from C source files
252 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
254 # Kernel assembly files
255 KERNEL_ASM_SRCS := lowlevel.asm
257 KERNEL_GAS_SRCS := testvm.s udivdi3.s
259 # Kernel object files build from assembler source files
260 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
262 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
265 # All kernel object files
266 KERNEL_OBJS := $(KERNEL_C_OBJS) \
267 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
269 # Common library source files.
270 # This library is linked into both the kernel and user programs.
271 # It provides string functions and generic printf()-style
273 COMMON_C_SRCS := fmtout.c string.c memmove.c
275 # Common library object files.
276 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
278 VMM_ASM_SRCS := svm_lowlevel.asm \
281 VMM_ASM_OBJS := $(VMM_ASM_SRCS:%.asm=palacios/%.o)
284 VMM_C_SRCS := vm_guest.c \
285 svm.c svm_handler.c vmm.c vmm_util.c vmm_ctrl_regs.c \
286 vmcb.c vmm_mem.c vmm_paging.c vmm_io.c vmm_debug.c svm_io.c \
287 vmm_intr.c vmm_time.c \
288 vmm_shadow_paging.c vm_guest_mem.c \
289 vm_dev.c vmm_dev_mgr.c vmm_decoder.c \
290 svm_halt.c svm_pause.c svm_wbinvd.c \
291 vmm_config.c vmm_hashtable.c \
292 vmm_string.c vmm_emulator.c vmm_queue.c\
294 # vmx.c vmcs_gen.c vmcs.c
296 VMM_C_OBJS := $(VMM_C_SRCS:%.c=palacios/%.o)
298 VMM_OBJS := $(VMM_C_OBJS) $(VMM_ASM_OBJS)
303 DEVICE_C_SRCS := generic.c keyboard.c nvram.c timer.c simple_pic.c 8259a.c 8254.c serial.c $(RAMDISK_SRCS)
305 DEVICE_C_OBJS := $(DEVICE_C_SRCS:%.c=devices/%.o)
307 DEVICE_OBJS := $(DEVICE_C_OBJS)
309 V3LIBS := $(DECODER_LIBS)
315 UIP_C_SRCS := psock.c timer.c uip_arp.c uip.c uip-fw.c uiplib.c uip-neighbor.c uip-split.c resolv.c
316 UIP_C_OBJS := $(UIP_C_SRCS:%.c=net/%.o)
323 LWIP_OBJS := lwip/*.o
328 TCPSTACK_OBJS := $(UIP_C_OBJS) $(LWIP_OBJS)
333 # ----------------------------------------------------------------------
335 # This section defines programs that are used to build GeekOS.
336 # ----------------------------------------------------------------------
338 # Uncomment if cross compiling
339 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
340 #TARGET_CC_PREFIX := i386-elf-
342 # Target C compiler. gcc 2.95.2 or later should work.
343 TARGET_CC := $(TARGET_CC_PREFIX)gcc
344 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
346 # Host C compiler. This is used to compile programs to execute on
347 # the host platform, not the target (x86) platform. On x86/ELF
348 # systems, such as Linux and FreeBSD, it can generally be the same
349 # as the target C compiler.
352 # Target linker. GNU ld is probably to only one that will work.
353 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
356 TARGET_AR := $(TARGET_CC_PREFIX)ar
359 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
362 TARGET_NM := $(TARGET_CC_PREFIX)nm
365 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
367 # Nasm (http://nasm.sourceforge.net)
368 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
369 #NASM := /opt/vmm-tools/bin/nasm
373 # Tool to build PFAT filesystem images.
374 BUILDFAT := tools/builtFat.exe
379 # Pad a file so its size is a multiple of some unit (i.e., sector size)
380 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
382 # Create a file filled with zeroes.
383 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
385 # Calculate size of file in sectors
386 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
389 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
392 # ----------------------------------------------------------------------
394 # Options passed to the tools.
395 # ----------------------------------------------------------------------
397 # Flags used for all C source files
398 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(VMM_FLAGS) $(BOOT_FLAGS) -fPIC
399 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
401 # Flags used for kernel C source files
402 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include
404 # Flags used for VMM C source files
405 CC_VMM_OPTS := -g -I$(PROJECT_ROOT)/include -D__V3VEE__ -D__V3_32BIT__ $(DECODER_FLAGS) $(JRLDEBUG)
407 # Flags used for VMM C ASM files
408 NASM_VMM_OPTS := -I$(PROJECT_ROOT)/src/palacios/ -f elf $(EXTRA_NASM_OPTS)
410 # Flags user for kernel assembly files
411 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
413 # Flags used for common library and libc source files
414 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
415 $(EXTRA_CC_USER_OPTS)
417 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
418 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
420 # ----------------------------------------------------------------------
422 # Describes how to compile the source files.
423 # ----------------------------------------------------------------------
425 # Compilation of kernel C source files
427 geekos/%.o : geekos/%.c
428 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
431 # Compilation of kernel assembly source files
432 geekos/%.o : geekos/%.asm
433 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
435 # Compilation of test VM
436 geekos/%.o : geekos/%.s
437 $(AS) $< -o geekos/$*.o
439 geekos/%.o : geekos/%.S
440 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
442 # Compilation of common library C source files
443 common/%.o : common/%.c
444 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
446 palacios/%.o : palacios/%.c
447 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o palacios/$*.o
449 palacios/%.o : palacios/%.asm
450 $(NASM) $(NASM_VMM_OPTS) $< -o palacios/$*.o
452 devices/%.o : devices/%.c
453 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o devices/$*.o
455 devices/%.o : devices/%.asm
456 $(NASM) $(NASM_VMM_OPTS) $< -o devices/$*.o
459 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o net/$*.o
461 # ----------------------------------------------------------------------
463 # Specifies files to be built
464 # ----------------------------------------------------------------------
466 # Default target - see definition of ALL_TARGETS in Configuration section
470 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
473 # -I$(PROJECT_ROOT)/src/geekos/ \
474 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
478 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
479 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
481 # Standard floppy image - just boots the kernel
482 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin
483 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp
489 $(PAD) vmm.img 1474560
492 ln -s -f ../src/vmboot/rombios/BIOS-bochs-latest rombios
495 ln -s -f ../src/vmboot/vgabios/VGABIOS-lgpl-latest.bin vgabios
498 (cd ../src/lwip/build; make clean; make)
500 force_rombios: rombios_link
501 (cd ../src/vmboot/rombios; make clean; make)
503 force_vgabios: vgabios_link
504 (cd ../src/vmboot/vgabios; make clean; make)
506 force_payload: force_rombios force_vgabios
507 ../scripts/make_payload.pl payload_layout.txt vm_kernel
509 inter1: force_payload force_lwip
512 world: inter1 vmm.img
514 # make ready to boot over PXE
516 cp vmm.img /tftpboot/vmm.img
519 /usr/local/qemu/bin/qemu-system-x86_64 -m 1024 -serial file:serial.out -cdrom puppy.iso -fda vmm.img
524 # Floppy boot sector (first stage boot loader).
525 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm
527 -I$(PROJECT_ROOT)/src/geekos/ \
528 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
529 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
530 -DSECTORS_PER_TRACK=`$(FD_SECTORS_PER_TRACK) geekos/kernel.bin geekos/setup.bin` \
531 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
534 # Setup program (second stage boot loader).
535 geekos/setup.bin : geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/setup.asm
537 -I$(PROJECT_ROOT)/src/geekos/ \
538 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
539 -DVMM_SIZE=`$(NUMSECS) geekos/kernel.bin` \
540 $(PROJECT_ROOT)/src/geekos/setup.asm \
544 # Loadable (flat) kernel image.
545 geekos/kernel.bin : geekos/kernel.exe
546 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
549 # The kernel executable and symbol map.
550 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(TCPSTACK_OBJS) vm_kernel
551 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
553 $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(V3LIBS) $(TCPSTACK_OBJS) -b binary vm_kernel
554 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
561 # $(PAD) vm_kernel 512
562 # @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long"
567 # Clean build directories of generated files
569 for d in geekos common libc user tools palacios devices net; do \
570 (cd $$d && rm -f *); \
574 # Build header file dependencies, so source files are recompiled when
575 # header files they depend on are modified.
576 depend : $(GENERATED_LIBC_SRCS)
577 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
578 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
579 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
581 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
582 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
583 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
585 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
586 $(VMM_C_SRCS:%.c=$(PROJECT_ROOT)/src/palacios/%.c) \
587 | $(PERL) -n -e 's,^(\S),palacios/$$1,;print' \
589 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
590 $(DEVICE_C_SRCS:%.c=$(PROJECT_ROOT)/src/devices/%.c) \
591 | $(PERL) -n -e 's,^(\S),devices/$$1,;print' \
594 # By default, there are no header file dependencies.