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
47 VPATH := $(PROJECT_ROOT)/src
49 #when -DNDEBUG is set the kassert functions are disabled
52 # DEBUG=1 means VMM_DEBUG, VMM_INFO, and VMM_TRACE are enabled
53 # as are SERIAL_PRINT_DEBUG
59 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
62 ifeq ($(DEBUG_SHADOW_PAGING),1)
63 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING
65 ifeq ($(DEBUG_SHADOW_PAGING),0)
66 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_SHADOW_PAGING
70 ifeq ($(DEBUG_CTRL_REGS),1)
71 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_CTRL_REGS
73 ifeq ($(DEBUG_CTRL_REGS),0)
74 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_CTRL_REGS
78 ifeq ($(DEBUG_INTERRUPTS),1)
79 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_INTERRUPTS
81 ifeq ($(DEBUG_INTERRUPTS),0)
82 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_INTERRUPTS
87 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IO
90 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_IO
94 ifeq ($(DEBUG_KEYBOARD),1)
95 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_KEYBOARD
97 ifeq ($(DEBUG_KEYBOARD),0)
98 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_KEYBOARD
102 ifeq ($(DEBUG_PIC),1)
103 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIC
105 ifeq ($(DEBUG_PIC),0)
106 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIC
110 ifeq ($(DEBUG_PIT),1)
111 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIT
113 ifeq ($(DEBUG_PIT),0)
114 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIT
118 ifeq ($(DEBUG_NVRAM),1)
119 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NVRAM
121 ifeq ($(DEBUG_NVRAM),0)
122 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_NVRAM
126 ifeq ($(DEBUG_GENERIC),1)
127 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_GENERIC
129 ifeq ($(DEBUG_GENERIC),0)
130 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_GENERIC
134 ifeq ($(DEBUG_EMULATOR),1)
135 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_EMULATOR
137 ifeq ($(DEBUG_EMULATOR),0)
138 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_EMULATOR
142 ifeq ($(DEBUG_RAMDISK),1)
143 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_RAMDISK
145 ifeq ($(DEBUG_RAMDISK),0)
146 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_RAMDISK
150 ifeq ($(TRACE_RAMDISK),1)
151 DEBUG_SECTIONS := $(DEBUG_SECTIONS -DTRACE_RAMDISK
153 ifeq ($(TRACE_RAMDSK),0)
154 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UTRACE_RAMDISK
160 #DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DTEST_NE2K
163 JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1 -DVMM_DEBUG=1 -DVMM_INFO=1 -DVMM_TRACE=1 $(DEBUG_SECTIONS)
166 JRLDEBUG= -DSERIAL_PRINT_DEBUG=0 -DSERIAL_PRINT_DEBUG_LEVEL=999999 -DSERIAL_PRINT=0 -DVMM_DEBUG=0 -DVMM_INFO=0 -DVMM_TRACE=0
171 # DECODER is the decoder that will be used
172 # currently we only support xed
180 ifeq ($(DECODER),XED)
181 DECODER_SRCS := vmm_xed.c
182 DECODER_FLAGS := -L../lib/xed
183 DECODER_LIBS := $(PROJECT_ROOT)/lib/xed/libxed.a
194 # This is wrong for current cygwin - no changes needed
196 # Figure out if we're compiling with cygwin, http://cygwin.com
199 #SYSTEM_NAME := $(shell uname -s)
200 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
202 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
203 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
204 #NON_ELF_SYSTEM := yes
205 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
211 # ----------------------------------------------------------------------
213 # Various options specifying how GeekOS should be built,
214 # what source files to build, which user programs to build,
215 # etc. This is generally the only section of the makefile
216 # that will need to be modified.
217 # ----------------------------------------------------------------------
219 # List of targets to build by default.
220 # These targets encompass everything needed to boot
222 ALL_TARGETS := vmm vm_kernel
229 VMM_ASM_SRCS := svm_lowlevel.asm vmm_lowlevel.asm\
232 VMM_ASM_OBJS := $(VMM_ASM_SRCS:%.asm=palacios/%.o)
235 VMM_C_SRCS := vm_guest.c \
236 svm.c svm_handler.c vmm.c vmm_util.c vmm_ctrl_regs.c \
237 vmcb.c vmm_mem.c vmm_paging.c vmm_io.c vmm_debug.c svm_io.c \
238 vmm_intr.c vmm_time.c \
239 vmm_shadow_paging.c vm_guest_mem.c \
240 vm_dev.c vmm_dev_mgr.c vmm_decoder.c \
241 svm_halt.c svm_pause.c svm_wbinvd.c \
242 vmm_config.c vmm_hashtable.c \
243 vmm_string.c vmm_emulator.c vmm_queue.c\
245 # vmx.c vmcs_gen.c vmcs.c
247 VMM_C_OBJS := $(VMM_C_SRCS:%.c=palacios/%.o)
249 VMM_OBJS := $(VMM_C_OBJS) $(VMM_ASM_OBJS)
253 XED_C_SRCS := v3-xed-compat.c
255 XED_C_OBJS := $(XED_C_SRCS:%.c=xed/%.o)
257 XED_GAS_SRCS := v3-udiv-compat.s
259 XED_GAS_OBJS := $(XED_GAS_SRCS:%.s=xed/%.o)
261 XED_OBJS := $(XED_C_OBJS) $(XED_GAS_OBJS)
265 DEVICE_C_SRCS := generic.c keyboard.c nvram.c timer.c simple_pic.c 8259a.c 8254.c serial.c ramdisk.c cdrom.c
267 DEVICE_C_OBJS := $(DEVICE_C_SRCS:%.c=devices/%.o)
269 DEVICE_OBJS := $(DEVICE_C_OBJS)
271 V3LIBS := $(DECODER_LIBS)
277 # ----------------------------------------------------------------------
279 # This section defines programs that are used to build GeekOS.
280 # ----------------------------------------------------------------------
283 V3_ARCH := __V3_32BIT__
284 #V3_ARCH := __V3_64BIT__
286 # Uncomment if cross compiling
287 #TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
288 #TARGET_CC_PREFIX := i386-elf-
290 # Target C compiler. gcc 2.95.2 or later should work.
291 TARGET_CC := $(TARGET_CC_PREFIX)gcc -m32
292 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
295 # Target linker. GNU ld is probably to only one that will work.
296 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
299 TARGET_AR := $(TARGET_CC_PREFIX)ar
302 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
305 TARGET_NM := $(TARGET_CC_PREFIX)nm
308 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
310 # Nasm (http://nasm.sourceforge.net)
311 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
312 #NASM := /opt/vmm-tools/bin/nasm
316 # Tool to build PFAT filesystem images.
317 BUILDFAT := tools/builtFat.exe
322 # Pad a file so its size is a multiple of some unit (i.e., sector size)
323 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
325 # Create a file filled with zeroes.
326 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
328 # Calculate size of file in sectors
329 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
332 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
335 # ----------------------------------------------------------------------
337 # Options passed to the tools.
338 # ----------------------------------------------------------------------
340 # Flags used for all C source files
341 #GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(VMM_FLAGS) -fPIC #-fvisibility=hidden
342 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(VMM_FLAGS) -fPIC #-fvisibility=hidden
343 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
345 # Flags used for VMM C source files
346 CC_VMM_OPTS := -g -I$(PROJECT_ROOT)/include -D__V3VEE__ -D$(V3_ARCH) $(DECODER_FLAGS) $(JRLDEBUG)
348 # Flags used for VMM C ASM files
349 NASM_VMM_OPTS := -I$(PROJECT_ROOT)/src/palacios/ -f elf $(EXTRA_NASM_OPTS)
355 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
356 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
358 # ----------------------------------------------------------------------
360 # Describes how to compile the source files.
361 # ----------------------------------------------------------------------
365 palacios/%.o : palacios/%.c
366 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o palacios/$*.o
368 palacios/%.o : palacios/%.asm
369 $(NASM) $(NASM_VMM_OPTS) $< -o palacios/$*.o
371 devices/%.o : devices/%.c
372 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o devices/$*.o
374 devices/%.o : devices/%.asm
375 $(NASM) $(NASM_VMM_OPTS) $< -o devices/$*.o
379 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o xed/$*.o
385 # ----------------------------------------------------------------------
387 # Specifies files to be built
388 # ----------------------------------------------------------------------
390 # Default target - see definition of ALL_TARGETS in Configuration section
394 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
397 # -I$(PROJECT_ROOT)/src/geekos/ \
398 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
402 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
403 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
408 ln -s -f ../src/vmboot/rombios/BIOS-bochs-latest rombios
411 ln -s -f ../src/vmboot/vgabios/VGABIOS-lgpl-latest.bin vgabios
414 (cd ../src/lwip/build; make clean; make)
416 force_rombios: rombios_link
417 (cd ../src/vmboot/rombios; make clean; make)
419 force_vgabios: vgabios_link
420 (cd ../src/vmboot/vgabios; make clean; make)
422 force_payload: force_rombios force_vgabios
423 ../scripts/make_payload.pl payload_layout.txt vm_kernel
425 inter1: force_payload force_lwip
430 vmm: palacios/vmm.lib
435 # Loadable (flat) kernel image.
436 palacios/vmm.bin : palacios/vmm.lib
437 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary palacios/vmm.lib palacios/vmm.bin
440 # The kernel executable and symbol map.
441 palacios/vmm.lib: $(VMM_OBJS) $(DEVICE_OBJS) $(XED_OBJS) vm_kernel
442 # $(TARGET_LD) -o palacios/vmm.lib \
444 # $(VMM_OBJS) $(DEVICE_OBJS) $(XED_OBJS) $(V3LIBS) -b binary vm_kernel
445 # $(TARGET_NM) palacios/vmm.lib > palacios/vmm.syms
446 $(TARGET_AR) rcs libv3vee.a \
447 $(VMM_OBJS) $(DEVICE_OBJS) $(XED_OBJS)
457 # Clean build directories of generated files
459 for d in palacios devices; do \
460 (cd $$d && rm -f *); \
464 # Build header file dependencies, so source files are recompiled when
465 # header files they depend on are modified.
466 depend : $(GENERATED_LIBC_SRCS)
468 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
469 $(VMM_C_SRCS:%.c=$(PROJECT_ROOT)/src/palacios/%.c) \
470 | $(PERL) -n -e 's,^(\S),palacios/$$1,;print' \
472 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
473 $(DEVICE_C_SRCS:%.c=$(PROJECT_ROOT)/src/devices/%.c) \
474 | $(PERL) -n -e 's,^(\S),devices/$$1,;print' \
477 # By default, there are no header file dependencies.