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
54 ifeq ($(DEBUG_SHADOW_PAGING),1)
55 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING
57 ifeq ($(DEBUG_CTRL_REGS),1)
58 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_CTRL_REGS
60 ifeq ($(DEBUG_INTERRUPTS),1)
61 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_INTERRUPTS
64 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IO
66 ifeq ($(DEBUG_KEYBOARD),1)
67 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_KEYBOARD
70 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIC
73 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIT
75 ifeq ($(DEBUG_NVRAM),1)
76 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NVRAM
78 ifeq ($(DEBUG_GENERIC),1)
79 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_GENERIC
81 ifeq ($(DEBUG_EMULATOR),1)
82 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_EMULATOR
87 JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1 -DVMM_DEBUG=1 -DVMM_INFO=1 -DVMM_TRACE=1 $(DEBUG_SECTIONS)
90 JRLDEBUG= -DSERIAL_PRINT_DEBUG=0 -DSERIAL_PRINT_DEBUG_LEVEL=999999 -DSERIAL_PRINT=0 -DVMM_DEBUG=0 -DVMM_INFO=0 -DVMM_TRACE=0
95 # DECODER is the decoder that will be used
96 # currently we only support xed
104 ifeq ($(DECODER),XED)
105 DECODER_SRCS := vmm_xed.c
106 DECODER_FLAGS := -L../lib/xed
107 DECODER_LIBS := -lxed
113 #TCPSTACK, uIP is used currently
121 # This is wrong for current cygwin - no changes needed
123 # Figure out if we're compiling with cygwin, http://cygwin.com
126 #SYSTEM_NAME := $(shell uname -s)
127 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
129 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
130 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
131 #NON_ELF_SYSTEM := yes
132 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
138 # ----------------------------------------------------------------------
140 # Various options specifying how GeekOS should be built,
141 # what source files to build, which user programs to build,
142 # etc. This is generally the only section of the makefile
143 # that will need to be modified.
144 # ----------------------------------------------------------------------
146 # List of targets to build by default.
147 # These targets encompass everything needed to boot
149 ALL_TARGETS := vmm.img vm_kernel
152 # Kernel source files
153 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
154 blockdev.c ide.c ne2k.c \
155 keyboard.c screen.c timer.c \
157 gdt.c tss.c segment.c \
162 debug.c vmm_stubs.c vm.c pci.c\
165 # Kernel object files built from C source files
166 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
168 # Kernel assembly files
169 KERNEL_ASM_SRCS := lowlevel.asm
171 KERNEL_GAS_SRCS := testvm.s udivdi3.s
173 # Kernel object files build from assembler source files
174 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
176 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
179 # All kernel object files
180 KERNEL_OBJS := $(KERNEL_C_OBJS) \
181 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
183 # Common library source files.
184 # This library is linked into both the kernel and user programs.
185 # It provides string functions and generic printf()-style
187 COMMON_C_SRCS := fmtout.c string.c memmove.c
189 # Common library object files.
190 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
192 VMM_ASM_SRCS := svm_lowlevel.asm \
195 VMM_ASM_OBJS := $(VMM_ASM_SRCS:%.asm=palacios/%.o)
198 VMM_C_SRCS := vm_guest.c \
199 svm.c svm_handler.c vmm.c vmm_util.c vmm_ctrl_regs.c \
200 vmcb.c vmm_mem.c vmm_paging.c vmm_io.c vmm_debug.c svm_io.c \
201 vmm_intr.c vmm_time.c \
202 vmm_shadow_paging.c vm_guest_mem.c \
203 vm_dev.c vmm_dev_mgr.c vmm_decoder.c \
204 svm_halt.c svm_pause.c svm_wbinvd.c \
205 vmm_config.c vmm_hashtable.c \
206 vmm_string.c vmm_emulator.c \
208 # vmx.c vmcs_gen.c vmcs.c
210 VMM_C_OBJS := $(VMM_C_SRCS:%.c=palacios/%.o)
212 VMM_OBJS := $(VMM_C_OBJS) $(VMM_ASM_OBJS)
217 DEVICE_C_SRCS := generic.c keyboard.c nvram.c timer.c simple_pic.c 8259a.c 8254.c serial.c
219 DEVICE_C_OBJS := $(DEVICE_C_SRCS:%.c=devices/%.o)
221 DEVICE_OBJS := $(DEVICE_C_OBJS)
223 V3LIBS := $(DECODER_LIBS)
226 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
228 TCPSTACK_C_OBJS := $(TCPSTACK_C_SRCS:%.c=net/%.o)
230 TCPSTACK_OBJS := $(TCPSTACK_C_OBJS)
235 # ----------------------------------------------------------------------
237 # This section defines programs that are used to build GeekOS.
238 # ----------------------------------------------------------------------
240 # Uncomment if cross compiling
241 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
242 #TARGET_CC_PREFIX := i386-elf-
244 # Target C compiler. gcc 2.95.2 or later should work.
245 TARGET_CC := $(TARGET_CC_PREFIX)gcc
246 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
248 # Host C compiler. This is used to compile programs to execute on
249 # the host platform, not the target (x86) platform. On x86/ELF
250 # systems, such as Linux and FreeBSD, it can generally be the same
251 # as the target C compiler.
254 # Target linker. GNU ld is probably to only one that will work.
255 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
258 TARGET_AR := $(TARGET_CC_PREFIX)ar
261 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
264 TARGET_NM := $(TARGET_CC_PREFIX)nm
267 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
269 # Nasm (http://nasm.sourceforge.net)
270 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
271 #NASM := /opt/vmm-tools/bin/nasm
275 # Tool to build PFAT filesystem images.
276 BUILDFAT := tools/builtFat.exe
281 # Pad a file so its size is a multiple of some unit (i.e., sector size)
282 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
284 # Create a file filled with zeroes.
285 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
287 # Calculate size of file in sectors
288 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
291 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
294 # ----------------------------------------------------------------------
296 # Options passed to the tools.
297 # ----------------------------------------------------------------------
299 # Flags used for all C source files
300 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(VMM_FLAGS) -fPIC
301 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
303 # Flags used for kernel C source files
304 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include
306 # Flags used for VMM C source files
307 CC_VMM_OPTS := -g -I$(PROJECT_ROOT)/include -D__V3VEE__ -D__V3_32BIT__ $(DECODER_FLAGS) $(JRLDEBUG)
309 # Flags used for VMM C ASM files
310 NASM_VMM_OPTS := -I$(PROJECT_ROOT)/src/palacios/ -f elf $(EXTRA_NASM_OPTS)
312 # Flags user for kernel assembly files
313 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
315 # Flags used for common library and libc source files
316 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
317 $(EXTRA_CC_USER_OPTS)
319 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
320 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
322 # ----------------------------------------------------------------------
324 # Describes how to compile the source files.
325 # ----------------------------------------------------------------------
327 # Compilation of kernel C source files
329 geekos/%.o : geekos/%.c
330 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
333 # Compilation of kernel assembly source files
334 geekos/%.o : geekos/%.asm
335 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
337 # Compilation of test VM
338 geekos/%.o : geekos/%.s
339 $(AS) $< -o geekos/$*.o
341 geekos/%.o : geekos/%.S
342 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
344 # Compilation of common library C source files
345 common/%.o : common/%.c
346 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
348 palacios/%.o : palacios/%.c
349 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o palacios/$*.o
351 palacios/%.o : palacios/%.asm
352 $(NASM) $(NASM_VMM_OPTS) $< -o palacios/$*.o
354 devices/%.o : devices/%.c
355 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o devices/$*.o
357 devices/%.o : devices/%.asm
358 $(NASM) $(NASM_VMM_OPTS) $< -o devices/$*.o
361 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $(CC_USER_OPTS) $< -o net/$*.o
363 # ----------------------------------------------------------------------
365 # Specifies files to be built
366 # ----------------------------------------------------------------------
368 # Default target - see definition of ALL_TARGETS in Configuration section
372 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
375 # -I$(PROJECT_ROOT)/src/geekos/ \
376 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
380 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
381 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
383 # Standard floppy image - just boots the kernel
384 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin
385 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp
391 $(PAD) vmm.img 1474560
394 (cd ../src/vmboot/rombios; make clean; make)
397 (cd ../src/vmboot/vgabios; make clean; make)
399 force_payload: force_rombios force_vgabios
400 ../scripts/make_payload.pl payload_layout.txt vm_kernel
402 inter1: force_payload
405 world: inter1 vmm.img
407 # make ready to boot over PXE
409 cp vmm.img /tftpboot/vmm.img
412 /usr/local/qemu/bin/qemu-system-x86_64 -m 1024 -serial file:serial.out -cdrom puppy.iso -fda vmm.img
417 # Floppy boot sector (first stage boot loader).
418 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm
420 -I$(PROJECT_ROOT)/src/geekos/ \
421 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
422 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
423 -DSECTORS_PER_TRACK=`$(FD_SECTORS_PER_TRACK) geekos/kernel.bin geekos/setup.bin` \
424 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
427 # Setup program (second stage boot loader).
428 geekos/setup.bin : geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/setup.asm
430 -I$(PROJECT_ROOT)/src/geekos/ \
431 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
432 -DVMM_SIZE=`$(NUMSECS) geekos/kernel.bin` \
433 $(PROJECT_ROOT)/src/geekos/setup.asm \
437 # Loadable (flat) kernel image.
438 geekos/kernel.bin : geekos/kernel.exe
439 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
442 # The kernel executable and symbol map.
443 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(TCPSTACK_OBJS) vm_kernel
444 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
446 $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(V3LIBS) -b binary vm_kernel
447 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
454 # $(PAD) vm_kernel 512
455 # @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long"
460 # Clean build directories of generated files
462 for d in geekos common libc user tools palacios devices; do \
463 (cd $$d && rm -f *); \
467 # Build header file dependencies, so source files are recompiled when
468 # header files they depend on are modified.
469 depend : $(GENERATED_LIBC_SRCS)
470 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
471 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
472 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
474 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
475 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
476 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
478 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
479 $(VMM_C_SRCS:%.c=$(PROJECT_ROOT)/src/palacios/%.c) \
480 | $(PERL) -n -e 's,^(\S),palacios/$$1,;print' \
482 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
483 $(DEVICE_C_SRCS:%.c=$(PROJECT_ROOT)/src/devices/%.c) \
484 | $(PERL) -n -e 's,^(\S),devices/$$1,;print' \
487 # By default, there are no header file dependencies.