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
51 # XED=1 means that libxed will be included
55 # and make world will build an empty boot package
60 JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1 -DVMM_DEBUG=1 -DVMM_INFO=1 -DVMM_TRACE=1
62 JRLDEBUG= -DSERIAL_PRINT_DEBUG=0 -DSERIAL_PRINT_DEBUG_LEVEL=999999 -DSERIAL_PRINT=0 -DVMM_DEBUG=0 -DVMM_INFO=0 -DVMM_TRACE=0
75 #Peter's compile flags
79 # This is wrong for current cygwin - no changes needed
81 # Figure out if we're compiling with cygwin, http://cygwin.com
84 #SYSTEM_NAME := $(shell uname -s)
85 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
87 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
88 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
89 #NON_ELF_SYSTEM := yes
90 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
96 # ----------------------------------------------------------------------
98 # Various options specifying how GeekOS should be built,
99 # what source files to build, which user programs to build,
100 # etc. This is generally the only section of the makefile
101 # that will need to be modified.
102 # ----------------------------------------------------------------------
104 # List of targets to build by default.
105 # These targets encompass everything needed to boot
107 ALL_TARGETS := vmm.img vm_kernel
110 # Kernel source files
111 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
113 keyboard.c screen.c timer.c \
115 gdt.c tss.c segment.c \
120 debug.c vmm_stubs.c vm.c pci.c\
123 # Kernel object files built from C source files
124 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
126 # Kernel assembly files
127 KERNEL_ASM_SRCS := lowlevel.asm
129 KERNEL_GAS_SRCS := testvm.s udivdi3.s
131 # Kernel object files build from assembler source files
132 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
134 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
137 # All kernel object files
138 KERNEL_OBJS := $(KERNEL_C_OBJS) \
139 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
141 # Common library source files.
142 # This library is linked into both the kernel and user programs.
143 # It provides string functions and generic printf()-style
145 COMMON_C_SRCS := fmtout.c string.c memmove.c
147 # Common library object files.
148 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
150 VMM_ASM_SRCS := svm_lowlevel.asm \
153 VMM_ASM_OBJS := $(VMM_ASM_SRCS:%.asm=palacios/%.o)
156 VMM_C_SRCS := vm_guest.c \
157 svm.c svm_handler.c vmm.c vmm_util.c vmm_ctrl_regs.c \
158 vmcb.c vmm_mem.c vmm_paging.c vmm_io.c vmm_debug.c svm_io.c \
159 vmm_intr.c vmm_time.c\
160 vmm_shadow_paging.c vm_guest_mem.c \
161 vm_dev.c vmm_dev_mgr.c vmm_decoder.c \
162 svm_halt.c svm_pause.c
164 # vmx.c vmcs_gen.c vmcs.c
166 VMM_C_OBJS := $(VMM_C_SRCS:%.c=palacios/%.o)
168 VMM_OBJS := $(VMM_C_OBJS) $(VMM_ASM_OBJS)
170 DEVICE_C_SRCS := generic.c keyboard.c nvram.c timer.c simple_pic.c 8259a.c 8254.c serial.c
172 DEVICE_C_OBJS := $(DEVICE_C_SRCS:%.c=devices/%.o)
174 DEVICE_OBJS := $(DEVICE_C_OBJS)
179 V3LIBS := $(V3LIBS) -L../lib/xed -lxed
183 # ----------------------------------------------------------------------
185 # This section defines programs that are used to build GeekOS.
186 # ----------------------------------------------------------------------
188 # Uncomment if cross compiling
189 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
190 #TARGET_CC_PREFIX := i386-elf-
192 # Target C compiler. gcc 2.95.2 or later should work.
193 TARGET_CC := $(TARGET_CC_PREFIX)gcc
194 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
196 # Host C compiler. This is used to compile programs to execute on
197 # the host platform, not the target (x86) platform. On x86/ELF
198 # systems, such as Linux and FreeBSD, it can generally be the same
199 # as the target C compiler.
202 # Target linker. GNU ld is probably to only one that will work.
203 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
206 TARGET_AR := $(TARGET_CC_PREFIX)ar
209 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
212 TARGET_NM := $(TARGET_CC_PREFIX)nm
215 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
217 # Nasm (http://nasm.sourceforge.net)
218 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
219 #NASM := /opt/vmm-tools/bin/nasm
223 # Tool to build PFAT filesystem images.
224 BUILDFAT := tools/builtFat.exe
229 # Pad a file so its size is a multiple of some unit (i.e., sector size)
230 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
232 # Create a file filled with zeroes.
233 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
235 # Calculate size of file in sectors
236 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
239 #Round a value up to a certain factor (hex values)
240 ROUND_UP_HEX := $(PERL) $(PROJECT_ROOT)/scripts/round_up_hex.pl
242 # ----------------------------------------------------------------------
244 # Options passed to the tools.
245 # ----------------------------------------------------------------------
247 # Flags used for all C source files
248 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(JRLDEBUG) $(PADFLAGS) $(LEIFLAGS) -fPIC
249 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
251 # Flags used for kernel C source files
252 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include
254 # Flags used for VMM C source files
255 CC_VMM_OPTS := -g -I$(PROJECT_ROOT)/include -D__V3VEE__ -D__V3_32BIT__
257 # Flags used for VMM C ASM files
258 NASM_VMM_OPTS := -I$(PROJECT_ROOT)/src/palacios/ -f elf $(EXTRA_NASM_OPTS)
260 # Flags user for kernel assembly files
261 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
263 # Flags used for common library and libc source files
264 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
265 $(EXTRA_CC_USER_OPTS)
267 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
268 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
270 # ----------------------------------------------------------------------
272 # Describes how to compile the source files.
273 # ----------------------------------------------------------------------
275 # Compilation of kernel C source files
277 geekos/%.o : geekos/%.c
278 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
281 # Compilation of kernel assembly source files
282 geekos/%.o : geekos/%.asm
283 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
285 # Compilation of test VM
286 geekos/%.o : geekos/%.s
287 $(AS) $< -o geekos/$*.o
289 geekos/%.o : geekos/%.S
290 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
292 # Compilation of common library C source files
293 common/%.o : common/%.c
294 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
296 palacios/%.o : palacios/%.c
297 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o palacios/$*.o
299 palacios/%.o : palacios/%.asm
300 $(NASM) $(NASM_VMM_OPTS) $< -o palacios/$*.o
302 devices/%.o : devices/%.c
303 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_VMM_OPTS) $< -o devices/$*.o
305 devices/%.o : devices/%.asm
306 $(NASM) $(NASM_VMM_OPTS) $< -o devices/$*.o
308 # ----------------------------------------------------------------------
310 # Specifies files to be built
311 # ----------------------------------------------------------------------
313 # Default target - see definition of ALL_TARGETS in Configuration section
317 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
320 # -I$(PROJECT_ROOT)/src/geekos/ \
321 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
325 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
326 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
328 # Standard floppy image - just boots the kernel
329 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin
330 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp
336 $(PAD) vmm.img 1474560
339 (cd ../src/vmboot/rombios; make clean; make)
342 (cd ../src/vmboot/vgabios; make clean; make)
344 force_payload: force_rombios force_vgabios
346 ../scripts/make_payload.pl payload_none.txt vm_kernel
348 ../scripts/make_payload.pl payload_layout.txt vm_kernel
351 inter1: force_payload
354 world: inter1 vmm.img
356 # make ready to boot over PXE
358 cp vmm.img /tftpboot/vmm.img
361 /usr/local/qemu/bin/qemu-system-x86_64 -m 1024 -serial file:serial.out -cdrom puppy.iso -fda vmm.img
366 # Floppy boot sector (first stage boot loader).
367 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm
369 -I$(PROJECT_ROOT)/src/geekos/ \
370 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
371 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
372 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
375 # Setup program (second stage boot loader).
376 geekos/setup.bin : geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/setup.asm
378 -I$(PROJECT_ROOT)/src/geekos/ \
379 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
380 -DVMM_SIZE=`$(NUMSECS) geekos/kernel.bin` \
381 $(PROJECT_ROOT)/src/geekos/setup.asm \
385 # Loadable (flat) kernel image.
386 geekos/kernel.bin : geekos/kernel.exe
387 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
390 # The kernel executable and symbol map.
391 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) vm_kernel
392 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
393 $(KERNEL_OBJS) $(COMMON_C_OBJS) $(VMM_OBJS) $(DEVICE_OBJS) $(V3LIBS) -b binary vm_kernel
394 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
401 # $(PAD) vm_kernel 512
402 # @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long"
407 # Clean build directories of generated files
409 for d in geekos common libc user tools palacios devices; do \
410 (cd $$d && rm -f *); \
414 # Build header file dependencies, so source files are recompiled when
415 # header files they depend on are modified.
416 depend : $(GENERATED_LIBC_SRCS)
417 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
418 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
419 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
421 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
422 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
423 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
425 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
426 $(VMM_C_SRCS:%.c=$(PROJECT_ROOT)/src/palacios/%.c) \
427 | $(PERL) -n -e 's,^(\S),palacios/$$1,;print' \
429 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
430 $(DEVICE_C_SRCS:%.c=$(PROJECT_ROOT)/src/devices/%.c) \
431 | $(PERL) -n -e 's,^(\S),devices/$$1,;print' \
434 # By default, there are no header file dependencies.