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_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
151 #DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DTEST_NE2K
154 JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1 -DVMM_DEBUG=1 -DVMM_INFO=1 -DVMM_TRACE=1 $(DEBUG_SECTIONS)
157 JRLDEBUG= -DSERIAL_PRINT_DEBUG=0 -DSERIAL_PRINT_DEBUG_LEVEL=999999 -DSERIAL_PRINT=0 -DVMM_DEBUG=0 -DVMM_INFO=0 -DVMM_TRACE=0
162 # DECODER is the decoder that will be used
163 # currently we only support xed
171 ifeq ($(DECODER),XED)
172 DECODER_SRCS := vmm_xed.c
173 DECODER_FLAGS := -L../lib/xed
174 DECODER_LIBS := $(PROJECT_ROOT)/lib/xed/libxed.a
185 # This is wrong for current cygwin - no changes needed
187 # Figure out if we're compiling with cygwin, http://cygwin.com
190 #SYSTEM_NAME := $(shell uname -s)
191 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
193 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
194 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
195 #NON_ELF_SYSTEM := yes
196 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
202 # ----------------------------------------------------------------------
204 # Various options specifying how GeekOS should be built,
205 # what source files to build, which user programs to build,
206 # etc. This is generally the only section of the makefile
207 # that will need to be modified.
208 # ----------------------------------------------------------------------
210 # List of targets to build by default.
211 # These targets encompass everything needed to boot
213 ALL_TARGETS := vmm vm_kernel
220 VMM_ASM_SRCS := svm_lowlevel.asm vmm_lowlevel.asm\
223 VMM_ASM_OBJS := $(VMM_ASM_SRCS:%.asm=palacios/%.o)
226 VMM_C_SRCS := vm_guest.c \
227 svm.c svm_handler.c vmm.c vmm_util.c vmm_ctrl_regs.c \
228 vmcb.c vmm_mem.c vmm_paging.c vmm_io.c vmm_debug.c svm_io.c \
229 vmm_intr.c vmm_time.c \
230 vmm_shadow_paging.c vm_guest_mem.c \
231 vm_dev.c vmm_dev_mgr.c vmm_decoder.c \
232 svm_halt.c svm_pause.c svm_wbinvd.c \
233 vmm_config.c vmm_hashtable.c \
234 vmm_string.c vmm_emulator.c vmm_queue.c\
236 # vmx.c vmcs_gen.c vmcs.c
238 VMM_C_OBJS := $(VMM_C_SRCS:%.c=palacios/%.o)
240 VMM_OBJS := $(VMM_C_OBJS) $(VMM_ASM_OBJS)
244 XED_C_SRCS := v3-xed-compat.c
246 XED_C_OBJS := $(XED_C_SRCS:%.c=xed/%.o)
248 XED_GAS_SRCS := v3-udiv-compat.s
250 XED_GAS_OBJS := $(XED_GAS_SRCS:%.s=xed/%.o)
252 XED_OBJS := $(XED_C_OBJS) $(XED_GAS_OBJS)
255 DEVICE_C_SRCS := generic.c keyboard.c nvram.c timer.c simple_pic.c 8259a.c 8254.c serial.c ramdisk.c cdrom.c
257 DEVICE_C_OBJS := $(DEVICE_C_SRCS:%.c=devices/%.o)
259 DEVICE_OBJS := $(DEVICE_C_OBJS)
261 V3LIBS := $(DECODER_LIBS)
266 # ----------------------------------------------------------------------
268 # This section defines programs that are used to build GeekOS.
269 # ----------------------------------------------------------------------
271 # Uncomment if cross compiling
272 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
273 #TARGET_CC_PREFIX := i386-elf-
275 # Target C compiler. gcc 2.95.2 or later should work.
276 TARGET_CC := $(TARGET_CC_PREFIX)gcc
277 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
280 # Target linker. GNU ld is probably to only one that will work.
281 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
284 TARGET_AR := $(TARGET_CC_PREFIX)ar
287 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
290 TARGET_NM := $(TARGET_CC_PREFIX)nm
293 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
295 # Nasm (http://nasm.sourceforge.net)
296 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
297 #NASM := /opt/vmm-tools/bin/nasm
301 # Tool to build PFAT filesystem images.
302 BUILDFAT := tools/builtFat.exe
307 # Pad a file so its size is a multiple of some unit (i.e., sector size)
308 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
310 # Create a file filled with zeroes.
311 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
313 # Calculate size of file in sectors
314 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
317 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
320 # ----------------------------------------------------------------------
322 # Options passed to the tools.
323 # ----------------------------------------------------------------------
325 # Flags used for all C source files
326 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(VMM_FLAGS) -fPIC #-fvisibility=hidden
327 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
329 # Flags used for VMM C source files
330 CC_VMM_OPTS := -g -I$(PROJECT_ROOT)/include -D__V3VEE__ -D__V3_32BIT__ $(DECODER_FLAGS) $(JRLDEBUG)
332 # Flags used for VMM C ASM files
333 NASM_VMM_OPTS := -I$(PROJECT_ROOT)/src/palacios/ -f elf $(EXTRA_NASM_OPTS)
339 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
340 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
342 # ----------------------------------------------------------------------
344 # Describes how to compile the source files.
345 # ----------------------------------------------------------------------
350 palacios/%.o : palacios/%.c
351 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o palacios/$*.o
353 palacios/%.o : palacios/%.asm
354 $(NASM) $(NASM_VMM_OPTS) $< -o palacios/$*.o
356 devices/%.o : devices/%.c
357 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o devices/$*.o
359 devices/%.o : devices/%.asm
360 $(NASM) $(NASM_VMM_OPTS) $< -o devices/$*.o
364 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o xed/$*.o
370 # ----------------------------------------------------------------------
372 # Specifies files to be built
373 # ----------------------------------------------------------------------
375 # Default target - see definition of ALL_TARGETS in Configuration section
379 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
382 # -I$(PROJECT_ROOT)/src/geekos/ \
383 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
387 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
388 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
393 ln -s -f ../src/vmboot/rombios/BIOS-bochs-latest rombios
396 ln -s -f ../src/vmboot/vgabios/VGABIOS-lgpl-latest.bin vgabios
398 force_rombios: rombios_link
399 (cd ../src/vmboot/rombios; make clean; make)
401 force_vgabios: vgabios_link
402 (cd ../src/vmboot/vgabios; make clean; make)
404 force_payload: force_rombios force_vgabios
405 ../scripts/make_payload.pl payload_layout.txt vm_kernel
407 inter1: force_payload
412 vmm: palacios/vmm.lib
417 # Loadable (flat) kernel image.
418 palacios/vmm.bin : palacios/vmm.lib
419 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary palacios/vmm.lib palacios/vmm.bin
422 # The kernel executable and symbol map.
423 palacios/vmm.lib: $(VMM_OBJS) $(DEVICE_OBJS) $(XED_OBJS) vm_kernel
424 # $(TARGET_LD) -o palacios/vmm.lib \
426 # $(VMM_OBJS) $(DEVICE_OBJS) $(XED_OBJS) $(V3LIBS) -b binary vm_kernel
427 # $(TARGET_NM) palacios/vmm.lib > palacios/vmm.syms
428 $(TARGET_AR) rcs libv3vee.a \
429 $(VMM_OBJS) $(DEVICE_OBJS) $(XED_OBJS)
439 # Clean build directories of generated files
441 for d in palacios devices; do \
442 (cd $$d && rm -f *); \
446 # Build header file dependencies, so source files are recompiled when
447 # header files they depend on are modified.
448 depend : $(GENERATED_LIBC_SRCS)
450 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
451 $(VMM_C_SRCS:%.c=$(PROJECT_ROOT)/src/palacios/%.c) \
452 | $(PERL) -n -e 's,^(\S),palacios/$$1,;print' \
454 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
455 $(DEVICE_C_SRCS:%.c=$(PROJECT_ROOT)/src/devices/%.c) \
456 | $(PERL) -n -e 's,^(\S),devices/$$1,;print' \
459 # By default, there are no header file dependencies.