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
42 KERNEL_BASE_ADDR := 0x00100000
44 # Kernel entry point function
45 KERNEL_ENTRY = $(SYM_PFX)Main
49 V3_ROOT := $(PROJECT_ROOT)/../palacios
50 VPATH := $(PROJECT_ROOT)/src
55 #TCPSTACK, uIP is used currently
60 #TCPSTACK, uIP is used currently
65 #LWIP, ON -- used, OFF -- not used
71 # This is wrong for current cygwin - no changes needed
73 # Figure out if we're compiling with cygwin, http://cygwin.com
76 #SYSTEM_NAME := $(shell uname -s)
77 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
79 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
80 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
81 #NON_ELF_SYSTEM := yes
82 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
88 # ----------------------------------------------------------------------
90 # Various options specifying how GeekOS should be built,
91 # what source files to build, which user programs to build,
92 # etc. This is generally the only section of the makefile
93 # that will need to be modified.
94 # ----------------------------------------------------------------------
96 # List of targets to build by default.
97 # These targets encompass everything needed to boot
99 ALL_TARGETS := vmm.img
102 # Kernel source files
103 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
104 blockdev.c ide.c ne2k.c \
105 keyboard.c screen.c timer.c \
107 gdt.c tss.c segment.c \
112 debug.c vmm_stubs.c vm.c pci.c\
113 queue.c socket.c net.c ring_buffer.c \
117 # Kernel object files built from C source files
118 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
120 # Kernel assembly files
121 KERNEL_ASM_SRCS := lowlevel.asm
125 # Kernel object files build from assembler source files
126 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
128 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
131 # All kernel object files
132 KERNEL_OBJS := $(KERNEL_C_OBJS) \
133 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
135 # Common library source files.
136 # This library is linked into both the kernel and user programs.
137 # It provides string functions and generic printf()-style
139 COMMON_C_SRCS := fmtout.c string.c memmove.c
141 # Common library object files.
142 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
147 V3_LD_FLAGS := -L./palacios/
148 #V3_LIBS := -lxed -lv3vee
149 V3_LIBS := ./palacios/libxed.a ./palacios/libv3vee.a ./palacios/libxed.a ./palacios/libv3vee.a
157 UIP_C_SRCS := psock.c timer.c uip_arp.c uip.c uip-fw.c uiplib.c uip-neighbor.c uip-split.c resolv.c
158 UIP_C_OBJS := $(UIP_C_SRCS:%.c=net/%.o)
165 LWIP_OBJS := lwip/*.o
166 CC_LWIP_OPTS := -I$(PROJECT_ROOT)/include/lwip -I$(PROJECT_ROOT)/include/lwip/ipv4 -I$(PROJECT_ROOT)/include/libc -DLWIP_DEBUG
172 TCPSTACK_OBJS := $(UIP_C_OBJS) $(LWIP_OBJS)
175 # ----------------------------------------------------------------------
177 # This section defines programs that are used to build GeekOS.
178 # ----------------------------------------------------------------------
180 # Uncomment if cross compiling
181 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
182 #TARGET_CC_PREFIX := i386-elf-
184 # Target C compiler. gcc 2.95.2 or later should work.
185 TARGET_CC := $(TARGET_CC_PREFIX)gcc
186 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
188 # Host C compiler. This is used to compile programs to execute on
189 # the host platform, not the target (x86) platform. On x86/ELF
190 # systems, such as Linux and FreeBSD, it can generally be the same
191 # as the target C compiler.
194 # Target linker. GNU ld is probably to only one that will work.
195 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
198 TARGET_AR := $(TARGET_CC_PREFIX)ar
201 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
204 TARGET_NM := $(TARGET_CC_PREFIX)nm
207 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
209 # Nasm (http://nasm.sourceforge.net)
210 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
211 #NASM := /opt/vmm-tools/bin/nasm
215 # Tool to build PFAT filesystem images.
216 BUILDFAT := tools/builtFat.exe
221 # Pad a file so its size is a multiple of some unit (i.e., sector size)
222 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
224 # Create a file filled with zeroes.
225 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
227 # Calculate size of file in sectors
228 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
231 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
234 # ----------------------------------------------------------------------
236 # Options passed to the tools.
237 # ----------------------------------------------------------------------
239 # Flags used for all C source files
240 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(BOOT_FLAGS) -fPIC
241 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
243 # Flags used for kernel C source files
244 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include -I$(V3_ROOT)/include
247 # Flags user for kernel assembly files
248 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
250 # Flags used for common library and libc source files
251 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
252 $(EXTRA_CC_USER_OPTS) -I$(V3_ROOT)/include
254 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
255 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
257 # ----------------------------------------------------------------------
259 # Describes how to compile the source files.
260 # ----------------------------------------------------------------------
262 # Compilation of kernel C source files
264 geekos/%.o : geekos/%.c
265 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $(CC_LWIP_OPTS) $< -o geekos/$*.o
268 # Compilation of kernel assembly source files
269 geekos/%.o : geekos/%.asm
270 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
273 # Compilation of common library C source files
274 common/%.o : common/%.c
275 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
279 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o net/$*.o
281 # ----------------------------------------------------------------------
283 # Specifies files to be built
284 # ----------------------------------------------------------------------
286 # Default target - see definition of ALL_TARGETS in Configuration section
290 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
293 # -I$(PROJECT_ROOT)/src/geekos/ \
294 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
298 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
299 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
301 # Standard floppy image - just boots the kernel
302 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin
303 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp
310 $(PAD) vmm.img 1474560
317 # Floppy boot sector (first stage boot loader).
318 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm
320 -I$(PROJECT_ROOT)/src/geekos/ \
321 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
322 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
323 -DSECTORS_PER_TRACK=`$(FD_SECTORS_PER_TRACK) geekos/kernel.bin geekos/setup.bin` \
324 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
327 # Setup program (second stage boot loader).
328 geekos/setup.bin : geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/setup.asm
330 -I$(PROJECT_ROOT)/src/geekos/ \
331 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
332 -DVMM_SIZE=`$(NUMSECS) geekos/kernel.bin` \
333 $(PROJECT_ROOT)/src/geekos/setup.asm \
337 # Loadable (flat) kernel image.
338 geekos/kernel.bin : geekos/kernel.exe
339 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
342 # The kernel executable and symbol map.
343 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS) $(TCPSTACK_OBJS)
344 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
346 $(KERNEL_OBJS) $(COMMON_C_OBJS) $(TCPSTACK_OBJS) $(V3_LIBS) -b binary ./palacios/vm_kernel
347 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
354 # $(PAD) vm_kernel 512
355 # @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long"
360 # Clean build directories of generated files
362 for d in geekos common libc user tools net; do \
363 (cd $$d && rm -f *); \
367 # Build header file dependencies, so source files are recompiled when
368 # header files they depend on are modified.
369 depend : $(GENERATED_LIBC_SRCS)
370 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
371 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
372 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
374 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
375 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
376 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
380 # By default, there are no header file dependencies.