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
56 #uIP, ON -- used, OFF -- not used
61 #LWIP, ON -- used, OFF -- not used
67 # This is wrong for current cygwin - no changes needed
69 # Figure out if we're compiling with cygwin, http://cygwin.com
72 #SYSTEM_NAME := $(shell uname -s)
73 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
75 #EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
76 #EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
77 #NON_ELF_SYSTEM := yes
78 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
84 # ----------------------------------------------------------------------
86 # Various options specifying how GeekOS should be built,
87 # what source files to build, which user programs to build,
88 # etc. This is generally the only section of the makefile
89 # that will need to be modified.
90 # ----------------------------------------------------------------------
92 # List of targets to build by default.
93 # These targets encompass everything needed to boot
95 ALL_TARGETS := vmm.img
99 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
100 blockdev.c ide.c ne2k.c \
101 keyboard.c screen.c timer.c \
103 gdt.c tss.c segment.c \
108 debug.c vmm_stubs.c vm.c pci.c\
109 queue.c socket.c net.c ring_buffer.c \
113 # Kernel object files built from C source files
114 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
116 # Kernel assembly files
117 KERNEL_ASM_SRCS := lowlevel.asm
121 # Kernel object files build from assembler source files
122 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
124 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
127 # All kernel object files
128 KERNEL_OBJS := $(KERNEL_C_OBJS) \
129 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
131 # Common library source files.
132 # This library is linked into both the kernel and user programs.
133 # It provides string functions and generic printf()-style
135 COMMON_C_SRCS := fmtout.c string.c memmove.c
137 # Common library object files.
138 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
141 V3_LD_FLAGS := -L./palacios/
142 #V3_LIBS := -lxed -lv3vee
143 V3_LIBS := ./palacios/libxed.a ./palacios/libv3vee.a ./palacios/libxed.a ./palacios/libv3vee.a
147 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
148 UIP_C_OBJS := $(UIP_C_SRCS:%.c=net/%.o)
155 LWIP_OBJS := lwip/*.o
156 CC_LWIP_OPTS := -I$(PROJECT_ROOT)/include/lwip -I$(PROJECT_ROOT)/include/lwip/ipv4 -I$(PROJECT_ROOT)/include/libc -DLWIP_DEBUG -DLWIP
162 TCPSTACK_OBJS := $(UIP_C_OBJS) $(LWIP_OBJS)
165 # ----------------------------------------------------------------------
167 # This section defines programs that are used to build GeekOS.
168 # ----------------------------------------------------------------------
170 # Uncomment if cross compiling
171 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
172 #TARGET_CC_PREFIX := i386-elf-
174 # Target C compiler. gcc 2.95.2 or later should work.
175 TARGET_CC := $(TARGET_CC_PREFIX)gcc
176 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
178 # Host C compiler. This is used to compile programs to execute on
179 # the host platform, not the target (x86) platform. On x86/ELF
180 # systems, such as Linux and FreeBSD, it can generally be the same
181 # as the target C compiler.
184 # Target linker. GNU ld is probably to only one that will work.
185 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
188 TARGET_AR := $(TARGET_CC_PREFIX)ar
191 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
194 TARGET_NM := $(TARGET_CC_PREFIX)nm
197 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
199 # Nasm (http://nasm.sourceforge.net)
200 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
201 #NASM := /opt/vmm-tools/bin/nasm
205 # Tool to build PFAT filesystem images.
206 BUILDFAT := tools/builtFat.exe
211 # Pad a file so its size is a multiple of some unit (i.e., sector size)
212 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
214 # Create a file filled with zeroes.
215 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
217 # Calculate size of file in sectors
218 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
221 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
224 # ----------------------------------------------------------------------
226 # Options passed to the tools.
227 # ----------------------------------------------------------------------
229 # Flags used for all C source files
230 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(BOOT_FLAGS) -fPIC
231 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
233 # Flags used for kernel C source files
234 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include -I$(V3_ROOT)/include
237 # Flags user for kernel assembly files
238 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
240 # Flags used for common library and libc source files
241 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
242 $(EXTRA_CC_USER_OPTS) -I$(V3_ROOT)/include
244 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
245 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
247 # ----------------------------------------------------------------------
249 # Describes how to compile the source files.
250 # ----------------------------------------------------------------------
252 # Compilation of kernel C source files
254 geekos/%.o : geekos/%.c
255 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $(CC_LWIP_OPTS) $< -o geekos/$*.o
258 # Compilation of kernel assembly source files
259 geekos/%.o : geekos/%.asm
260 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
263 # Compilation of common library C source files
264 common/%.o : common/%.c
265 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
269 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o net/$*.o
271 # ----------------------------------------------------------------------
273 # Specifies files to be built
274 # ----------------------------------------------------------------------
276 # Default target - see definition of ALL_TARGETS in Configuration section
281 (cd ../src/lwip/build; make clean; make)
284 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
287 # -I$(PROJECT_ROOT)/src/geekos/ \
288 # $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
292 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
293 # $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
295 # Standard floppy image - just boots the kernel
296 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin
297 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp
304 $(PAD) vmm.img 1474560
311 # Floppy boot sector (first stage boot loader).
312 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm
314 -I$(PROJECT_ROOT)/src/geekos/ \
315 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
316 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
317 -DSECTORS_PER_TRACK=`$(FD_SECTORS_PER_TRACK) geekos/kernel.bin geekos/setup.bin` \
318 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
321 # Setup program (second stage boot loader).
322 geekos/setup.bin : geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/setup.asm
324 -I$(PROJECT_ROOT)/src/geekos/ \
325 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
326 -DVMM_SIZE=`$(NUMSECS) geekos/kernel.bin` \
327 $(PROJECT_ROOT)/src/geekos/setup.asm \
331 # Loadable (flat) kernel image.
332 geekos/kernel.bin : geekos/kernel.exe
333 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
336 # The kernel executable and symbol map.
337 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS) force_lwip
338 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
340 $(KERNEL_OBJS) $(COMMON_C_OBJS) $(TCPSTACK_OBJS) $(V3_LIBS) -b binary ./palacios/vm_kernel
341 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
348 # $(PAD) vm_kernel 512
349 # @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long"
354 # Clean build directories of generated files
356 for d in geekos common libc user tools net; do \
357 (cd $$d && rm -f *); \
361 # Build header file dependencies, so source files are recompiled when
362 # header files they depend on are modified.
363 depend : $(GENERATED_LIBC_SRCS)
364 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
365 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
366 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
368 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
369 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
370 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
374 # By default, there are no header file dependencies.