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
52 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
55 ifeq ($(DEBUG_SHADOW_PAGING),1)
56 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING
58 ifeq ($(DEBUG_SHADOW_PAGING),0)
59 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_SHADOW_PAGING
63 ifeq ($(DEBUG_CTRL_REGS),1)
64 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_CTRL_REGS
66 ifeq ($(DEBUG_CTRL_REGS),0)
67 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_CTRL_REGS
71 ifeq ($(DEBUG_INTERRUPTS),1)
72 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_INTERRUPTS
74 ifeq ($(DEBUG_DEBUG_INTERRUPTS),0)
75 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_INTERRUPTS
80 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IO
83 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_IO
87 ifeq ($(DEBUG_KEYBOARD),1)
88 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_KEYBOARD
90 ifeq ($(DEBUG_KEYBOARD),0)
91 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_KEYBOARD
96 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIC
99 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIC
103 ifeq ($(DEBUG_PIT),1)
104 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIT
106 ifeq ($(DEBUG_PIT),0)
107 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIT
111 ifeq ($(DEBUG_NVRAM),1)
112 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NVRAM
114 ifeq ($(DEBUG_NVRAM),0)
115 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_NVRAM
119 ifeq ($(DEBUG_GENERIC),1)
120 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_GENERIC
122 ifeq ($(DEBUG_GENERIC),0)
123 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_GENERIC
127 ifeq ($(DEBUG_EMULATOR),1)
128 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_EMULATOR
130 ifeq ($(DEBUG_EMULATOR),0)
131 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_EMULATOR
135 ifeq ($(DEBUG_RAMDISK),1)
136 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_RAMDISK
138 ifeq ($(DEBUG_RAMDISK),0)
139 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_RAMDISK
145 JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1 -DVMM_DEBUG=1 -DVMM_INFO=1 -DVMM_TRACE=1 $(DEBUG_SECTIONS)
148 JRLDEBUG= -DSERIAL_PRINT_DEBUG=0 -DSERIAL_PRINT_DEBUG_LEVEL=999999 -DSERIAL_PRINT=0 -DVMM_DEBUG=0 -DVMM_INFO=0 -DVMM_TRACE=0
153 # DECODER is the decoder that will be used
154 # currently we only support xed
162 ifeq ($(DECODER),XED)
163 DECODER_SRCS := vmm_xed.c
164 DECODER_FLAGS := -L../lib/xed
165 DECODER_LIBS := -lxed
171 #TCPSTACK, uIP is used currently
181 ifeq ($(RAMDISK_BOOT),1)
182 BOOT_FLAGS := $(BOOT_FLAGS) -DRAMDISK_BOOT
183 RAMDISK_SRCS := ramdisk.c cdrom.c
189 # This is wrong for current cygwin - no changes needed
191 # Figure out if we're compiling with cygwin, http://cygwin.com
194 #SYSTEM_NAME := $(shell uname -s)
195 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
197 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
198 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
199 #NON_ELF_SYSTEM := yes
200 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
206 # ----------------------------------------------------------------------
208 # Various options specifying how GeekOS should be built,
209 # what source files to build, which user programs to build,
210 # etc. This is generally the only section of the makefile
211 # that will need to be modified.
212 # ----------------------------------------------------------------------
214 # List of targets to build by default.
215 # These targets encompass everything needed to boot
217 ALL_TARGETS := vmm.img vm_kernel
220 # Kernel source files
221 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
222 blockdev.c ide.c ne2k.c \
223 keyboard.c screen.c timer.c \
225 gdt.c tss.c segment.c \
230 debug.c vmm_stubs.c vm.c pci.c\
231 queue.c socket.c ring_buffer.c \
234 # Kernel object files built from C source files
235 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
237 # Kernel assembly files
238 KERNEL_ASM_SRCS := lowlevel.asm
240 KERNEL_GAS_SRCS := testvm.s udivdi3.s
242 # Kernel object files build from assembler source files
243 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
245 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
248 # All kernel object files
249 KERNEL_OBJS := $(KERNEL_C_OBJS) \
250 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
252 # Common library source files.
253 # This library is linked into both the kernel and user programs.
254 # It provides string functions and generic printf()-style
256 COMMON_C_SRCS := fmtout.c string.c memmove.c
258 # Common library object files.
259 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
261 VMM_ASM_SRCS := svm_lowlevel.asm \
264 VMM_ASM_OBJS := $(VMM_ASM_SRCS:%.asm=palacios/%.o)
267 VMM_C_SRCS := vm_guest.c \
268 svm.c svm_handler.c vmm.c vmm_util.c vmm_ctrl_regs.c \
269 vmcb.c vmm_mem.c vmm_paging.c vmm_io.c vmm_debug.c svm_io.c \
270 vmm_intr.c vmm_time.c \
271 vmm_shadow_paging.c vm_guest_mem.c \
272 vm_dev.c vmm_dev_mgr.c vmm_decoder.c \
273 svm_halt.c svm_pause.c svm_wbinvd.c \
274 vmm_config.c vmm_hashtable.c \
275 vmm_string.c vmm_emulator.c vmm_queue.c\
277 # vmx.c vmcs_gen.c vmcs.c
279 VMM_C_OBJS := $(VMM_C_SRCS:%.c=palacios/%.o)
281 VMM_OBJS := $(VMM_C_OBJS) $(VMM_ASM_OBJS)
286 DEVICE_C_SRCS := generic.c keyboard.c nvram.c timer.c simple_pic.c 8259a.c 8254.c serial.c $(RAMDISK_SRCS)
288 DEVICE_C_OBJS := $(DEVICE_C_SRCS:%.c=devices/%.o)
290 DEVICE_OBJS := $(DEVICE_C_OBJS)
292 V3LIBS := $(DECODER_LIBS)
295 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
297 TCPSTACK_C_OBJS := $(TCPSTACK_C_SRCS:%.c=net/%.o)
299 TCPSTACK_OBJS := $(TCPSTACK_C_OBJS)
304 # ----------------------------------------------------------------------
306 # This section defines programs that are used to build GeekOS.
307 # ----------------------------------------------------------------------
309 # Uncomment if cross compiling
310 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
311 #TARGET_CC_PREFIX := i386-elf-
313 # Target C compiler. gcc 2.95.2 or later should work.
314 TARGET_CC := $(TARGET_CC_PREFIX)gcc
315 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
317 # Host C compiler. This is used to compile programs to execute on
318 # the host platform, not the target (x86) platform. On x86/ELF
319 # systems, such as Linux and FreeBSD, it can generally be the same
320 # as the target C compiler.
323 # Target linker. GNU ld is probably to only one that will work.
324 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
327 TARGET_AR := $(TARGET_CC_PREFIX)ar
330 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
333 TARGET_NM := $(TARGET_CC_PREFIX)nm
336 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
338 # Nasm (http://nasm.sourceforge.net)
339 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
340 #NASM := /opt/vmm-tools/bin/nasm
344 # Tool to build PFAT filesystem images.
345 BUILDFAT := tools/builtFat.exe
350 # Pad a file so its size is a multiple of some unit (i.e., sector size)
351 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
353 # Create a file filled with zeroes.
354 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
356 # Calculate size of file in sectors
357 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
360 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
363 # ----------------------------------------------------------------------
365 # Options passed to the tools.
366 # ----------------------------------------------------------------------
368 # Flags used for all C source files
369 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(VMM_FLAGS) $(BOOT_FLAGS) -fPIC
370 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
372 # Flags used for kernel C source files
373 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include
375 # Flags used for VMM C source files
376 CC_VMM_OPTS := -g -I$(PROJECT_ROOT)/include -D__V3VEE__ -D__V3_32BIT__ $(DECODER_FLAGS) $(JRLDEBUG)
378 # Flags used for VMM C ASM files
379 NASM_VMM_OPTS := -I$(PROJECT_ROOT)/src/palacios/ -f elf $(EXTRA_NASM_OPTS)
381 # Flags user for kernel assembly files
382 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
384 # Flags used for common library and libc source files
385 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
386 $(EXTRA_CC_USER_OPTS)
388 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
389 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
391 # ----------------------------------------------------------------------
393 # Describes how to compile the source files.
394 # ----------------------------------------------------------------------
396 # Compilation of kernel C source files
398 geekos/%.o : geekos/%.c
399 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
402 # Compilation of kernel assembly source files
403 geekos/%.o : geekos/%.asm
404 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
406 # Compilation of test VM
407 geekos/%.o : geekos/%.s
408 $(AS) $< -o geekos/$*.o
410 geekos/%.o : geekos/%.S
411 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
413 # Compilation of common library C source files
414 common/%.o : common/%.c
415 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
417 palacios/%.o : palacios/%.c
418 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o palacios/$*.o
420 palacios/%.o : palacios/%.asm
421 $(NASM) $(NASM_VMM_OPTS) $< -o palacios/$*.o
423 devices/%.o : devices/%.c
424 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o devices/$*.o
426 devices/%.o : devices/%.asm
427 $(NASM) $(NASM_VMM_OPTS) $< -o devices/$*.o
430 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $(CC_USER_OPTS) $< -o net/$*.o
432 # ----------------------------------------------------------------------
434 # Specifies files to be built
435 # ----------------------------------------------------------------------
437 # Default target - see definition of ALL_TARGETS in Configuration section
441 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
444 # -I$(PROJECT_ROOT)/src/geekos/ \
445 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
449 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
450 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
452 # Standard floppy image - just boots the kernel
453 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin
454 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp
460 $(PAD) vmm.img 1474560
463 (cd ../src/vmboot/rombios; make clean; make)
466 (cd ../src/vmboot/vgabios; make clean; make)
468 force_payload: force_rombios force_vgabios
469 ../scripts/make_payload.pl payload_layout.txt vm_kernel
471 inter1: force_payload
474 world: inter1 vmm.img
476 # make ready to boot over PXE
478 cp vmm.img /tftpboot/vmm.img
481 /usr/local/qemu/bin/qemu-system-x86_64 -m 1024 -serial file:serial.out -cdrom puppy.iso -fda vmm.img
486 # Floppy boot sector (first stage boot loader).
487 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm
489 -I$(PROJECT_ROOT)/src/geekos/ \
490 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
491 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
492 -DSECTORS_PER_TRACK=`$(FD_SECTORS_PER_TRACK) geekos/kernel.bin geekos/setup.bin` \
493 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
496 # Setup program (second stage boot loader).
497 geekos/setup.bin : geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/setup.asm
499 -I$(PROJECT_ROOT)/src/geekos/ \
500 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
501 -DVMM_SIZE=`$(NUMSECS) geekos/kernel.bin` \
502 $(PROJECT_ROOT)/src/geekos/setup.asm \
506 # Loadable (flat) kernel image.
507 geekos/kernel.bin : geekos/kernel.exe
508 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
511 # The kernel executable and symbol map.
512 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(TCPSTACK_OBJS) vm_kernel
513 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
515 $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(V3LIBS) $(TCPSTACK_OBJS) -b binary vm_kernel
516 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
523 # $(PAD) vm_kernel 512
524 # @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long"
529 # Clean build directories of generated files
531 for d in geekos common libc user tools palacios devices net; do \
532 (cd $$d && rm -f *); \
536 # Build header file dependencies, so source files are recompiled when
537 # header files they depend on are modified.
538 depend : $(GENERATED_LIBC_SRCS)
539 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
540 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
541 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
543 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
544 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
545 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
547 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
548 $(VMM_C_SRCS:%.c=$(PROJECT_ROOT)/src/palacios/%.c) \
549 | $(PERL) -n -e 's,^(\S),palacios/$$1,;print' \
551 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
552 $(DEVICE_C_SRCS:%.c=$(PROJECT_ROOT)/src/devices/%.c) \
553 | $(PERL) -n -e 's,^(\S),devices/$$1,;print' \
556 # By default, there are no header file dependencies.