palacios/build/Makefile

   1 # Makefile for GeekOS kernel, userspace, and tools
   2 #
   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 <lxia@northwestern.edu>
   7 # (c) 2008, The V3VEE Project <http://www.v3vee.org>
   8 #
   9 # Based on GeekOS Makefile:
  10 # Copyright (c) 2004,2005 David H. Hovemeyer <daveho@cs.umd.edu>
  11 # $Revision: 1.71 $
  12
  13
  14 # This is free software.  You are permitted to use,
  15 # redistribute, and modify it as specified in the file "COPYING".
  16
  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 # - Perl5, AWK (any version), egrep
  21 #
  22 # Cygwin (http://cygwin.com) may be used to build GeekOS.
  23 # Make sure that gcc, binutils, nasm, and perl are installed.
  24
  25 # NOTES:
  26 # - This makefile has been written carefully to work correctly
  27 #   with the -j (parallel make) option.  I regularly use "make -j 2"
  28 #   to speed the build process on 2 processor systems.
  29
  30
  31 # Base address of kernel
  32 #
  33 # Note: at top of memory minus three pages (GDT/TSS/IDT)
  34 # minus maximum size
  35 #
  36 #
  37 # Note that the code will initially load at 0x10000
  38 #
  39 # The setup code needs to copy it up to this address and jump there
  40 #
  41
  42
  43
  44
  45 PROJECT_ROOT := ..
  46 VPATH := $(PROJECT_ROOT)/src
  47
  48 #when -DNDEBUG is set the kassert functions are disabled
  49 #JRLDEBUG=-DNDEBUG
  50
  51 # DEBUG=1 means VMM_DEBUG, VMM_INFO, and VMM_TRACE are enabled
  52 # as are SERIAL_PRINT_DEBUG
  53 #
  54
  55 ifeq ($(LEAN_AND_MEAN),1)
  56 DEBUG := 0
  57 DEBUG_SECTIONS :=
  58 else
  59 DEBUG := 1
  60 DEBUG_SECTIONS :=
  61 endif
  62
  63
  64 ifeq ($(DEBUG_ALL),1)
  65   DEBUG_SECTIONS:= $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING -DDEBUG_CTRL_REGS -DDEBUG_INTERRUPTS -DDEBUG_KEYBOARD -DDEBUG_PIC -DDEBUG_PIT -DDEBUG_NVRAM -DDEBUG_EMULATOR  -DDEBUG_XED -DDEBUG_HALT -DDEBUG_DEV_MGR
  66 # -DDEBUG_IO -DDEBUG_GENERIC -DDEBUG_RAMDISK
  67 endif
  68
  69
  70 ifeq ($(DEBUG_SHADOW_PAGING),1)
  71 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_SHADOW_PAGING
  72 else
  73 ifeq ($(DEBUG_SHADOW_PAGING),0)
  74 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_SHADOW_PAGING
  75 endif
  76 endif
  77
  78 ifeq ($(DEBUG_CTRL_REGS),1)
  79 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_CTRL_REGS
  80 else
  81 ifeq ($(DEBUG_CTRL_REGS),0)
  82 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_CTRL_REGS
  83 endif
  84 endif
  85
  86 ifeq ($(DEBUG_INTERRUPTS),1)
  87 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_INTERRUPTS
  88 else
  89 ifeq ($(DEBUG_INTERRUPTS),0)
  90 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_INTERRUPTS
  91 endif
  92 endif
  93
  94 ifeq ($(DEBUG_IO),1)
  95 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IO
  96 else
  97 ifeq ($(DEBUG_IO),0)
  98 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_IO
  99 endif
 100 endif
 101
 102 ifeq ($(DEBUG_KEYBOARD),1)
 103 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_KEYBOARD
 104 else
 105 ifeq ($(DEBUG_KEYBOARD),0)
 106 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_KEYBOARD
 107 endif
 108 endif
 109
 110 ifeq ($(DEBUG_PIC),1)
 111 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIC
 112 else
 113 ifeq ($(DEBUG_PIC),0)
 114 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIC
 115 endif
 116 endif
 117
 118 ifeq ($(DEBUG_PIT),1)
 119 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIT
 120 else
 121 ifeq ($(DEBUG_PIT),0)
 122 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIT
 123 endif
 124 endif
 125
 126 ifeq ($(DEBUG_NVRAM),1)
 127 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NVRAM
 128 else
 129 ifeq ($(DEBUG_NVRAM),0)
 130 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_NVRAM
 131 endif
 132 endif
 133
 134 ifeq ($(DEBUG_GENERIC),1)
 135 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_GENERIC
 136 else
 137 ifeq ($(DEBUG_GENERIC),0)
 138 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_GENERIC
 139 endif
 140 endif
 141
 142 ifeq ($(DEBUG_EMULATOR),1)
 143 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_EMULATOR
 144 else
 145 ifeq ($(DEBUG_EMULATOR),0)
 146 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_EMULATOR
 147 endif
 148 endif
 149
 150 ifeq ($(DEBUG_RAMDISK),1)
 151 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_RAMDISK
 152 else
 153 ifeq ($(DEBUG_RAMDISK),0)
 154 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_RAMDISK
 155 endif
 156 endif
 157
 158 ifeq ($(TRACE_RAMDISK),1)
 159 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DTRACE_RAMDISK
 160 else
 161 ifeq ($(TRACE_RAMDSK),0)
 162 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UTRACE_RAMDISK
 163 endif
 164 endif
 165
 166 ifeq ($(DEBUG_XED),1)
 167 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_XED
 168 else
 169 ifeq ($(DEBUG_XED),0)
 170 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_XED
 171 endif
 172 endif
 173
 174 ifeq ($(DEBUG_HALT),1)
 175 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_HALT
 176 else
 177 ifeq ($(DEBUG_HALT),0)
 178 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_HALT
 179 endif
 180 endif
 181
 182 ifeq ($(DEBUG_DEV_MGR),1)
 183 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_DEV_MGR
 184 else
 185 ifeq ($(DEBUG_DEV_MGR),0)
 186 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_DEV_MGR
 187 endif
 188 endif
 189
 190 #DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DTEST_NE2K
 191
 192 ifeq ($(DEBUG),1)
 193   JRLDEBUG=  -DVMM_DEBUG -DVMM_INFO -DVMM_TRACE $(DEBUG_SECTIONS)
 194 else
 195
 196 endif
 197
 198
 199
 200
 201
 202
 203 #
 204 # This is wrong for current cygwin - no changes needed
 205 #
 206 # Figure out if we're compiling with cygwin, http://cygwin.com
 207 #
 208 #
 209 #SYSTEM_NAME := $(shell uname -s)
 210 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
 211 #SYM_PFX            := _
 212 #EXTRA_C_OPTS       := -DNEED_UNDERSCORE -DGNU_WIN32
 213 #EXTRA_NASM_OPTS    := -DNEED_UNDERSCORE
 214 #NON_ELF_SYSTEM     := yes
 215 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
 216 #endif
 217
 218
 219
 220 ifeq ($(INSTRUMENT_VMM),1)
 221   EXTRA_C_OPTS:= -DINSTRUMENT_VMM
 222   INSTRUMENT_OPT := -finstrument-functions
 223   OBJ_FILES := palacios/vmm_instrument.o
 224 else
 225   INSTRUMENT_OPT :=
 226 endif
 227
 228
 229
 230 # ----------------------------------------------------------------------
 231 # Configuration -
 232 #   Various options specifying how GeekOS should be built,
 233 #   what source files to build, which user programs to build,
 234 #   etc.  This is generally the only section of the makefile
 235 #   that will need to be modified.
 236 # ----------------------------------------------------------------------
 237
 238 # List of targets to build by default.
 239 # These targets encompass everything needed to boot
 240 # and run GeekOS.
 241 ALL_TARGETS := vmm force_payload
 242
 243
 244 VMM_OBJS := \
 245         palacios/vm_guest.o \
 246         palacios/svm.o \
 247         palacios/svm_handler.o \
 248         palacios/vmm.o \
 249         palacios/vmm_util.o \
 250         palacios/vmm_ctrl_regs.o \
 251         palacios/vmcb.o \
 252         palacios/vmm_mem.o \
 253         palacios/vmm_paging.o \
 254         palacios/vmm_io.o \
 255         palacios/vmm_debug.o \
 256         palacios/svm_io.o \
 257         palacios/vmm_intr.o \
 258         palacios/vmm_time.o \
 259         palacios/vmm_shadow_paging.o \
 260         palacios/vm_guest_mem.o \
 261         palacios/vm_dev.o \
 262         palacios/vmm_dev_mgr.o \
 263         palacios/vmm_decoder.o \
 264         palacios/svm_halt.o \
 265         palacios/svm_pause.o \
 266         palacios/svm_wbinvd.o \
 267         palacios/vmm_config.o \
 268         palacios/vmm_hashtable.o \
 269         palacios/vmm_string.o \
 270         palacios/vmm_emulator.o \
 271         palacios/vmm_queue.o \
 272         palacios/vmm_host_events.o \
 273         palacios/svm_lowlevel.o \
 274         palacios/vmm_msr.o \
 275         palacios/svm_msr.o \
 276         palacios/vmm_socket.o \
 277         palacios/vmm_xed.o \
 278         palacios/vmm_rbtree.o \
 279         palacios/vmm_profiler.o \
 280         palacios/vmm_direct_paging.o \
 281         palacios/vmm_ringbuffer.o \
 282         palacios/vmm_hypercall.o \
 283         $(OBJ_FILES)
 284
 285 #               vmx.c vmcs_gen.c vmcs.c
 286
 287 # Extra C flags for the VMM objects
 288 $(VMM_OBJS) :: EXTRA_CFLAGS = \
 289         $(JRLDEBUG) \
 290
 291
 292
 293 XED_OBJS := \
 294         xed/v3-xed-compat.o \
 295         xed/v3-udiv-compat.o \
 296
 297 $(XED_OBJS) :: EXTRA_CFLAGS = \
 298         $(JRLDEBUG) \
 299
 300 DEVICES_OBJS := \
 301         devices/generic.o \
 302         devices/keyboard.o \
 303         devices/nvram.o \
 304         devices/timer.o \
 305         devices/simple_pic.o \
 306         devices/8259a.o \
 307         devices/8254.o \
 308         devices/serial.o \
 309         devices/ramdisk.o \
 310         devices/cdrom.o \
 311         devices/bochs_debug.o \
 312         devices/os_debug.o \
 313         devices/apic.o  \
 314         devices/io_apic.o \
 315
 316 $(DEVICES_OBJS) :: EXTRA_CFLAGS = \
 317         $(JRLDEBUG) \
 318
 319
 320
 321 # ----------------------------------------------------------------------
 322 # Tools -
 323 #   This section defines programs that are used to build GeekOS.
 324 # ----------------------------------------------------------------------
 325
 326 ifeq ($(ARCH),64)
 327 V3_ARCH := __V3_64BIT__
 328 else
 329 V3_ARCH := __V3_32BIT__
 330 endif
 331
 332
 333 # Uncomment if cross compiling
 334 #TARGET_CC_PREFIX :=  $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
 335 #TARGET_CC_PREFIX :=  i386-elf-
 336
 337 # Target C compiler.  gcc 2.95.2 or later should work.
 338 ifeq ($(ARCH),64)
 339 TARGET_CC := $(TARGET_CC_PREFIX)gcc -m64
 340 else
 341 TARGET_CC := $(TARGET_CC_PREFIX)gcc -m32
 342 endif
 343 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
 344
 345
 346 # Target linker.  GNU ld is probably to only one that will work.
 347 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
 348
 349 # Target archiver
 350 TARGET_AR := $(TARGET_CC_PREFIX)ar
 351
 352 # Target ranlib
 353 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
 354
 355 # Target nm
 356 TARGET_NM := $(TARGET_CC_PREFIX)nm
 357
 358 # Target objcopy
 359 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
 360
 361 # Nasm (http://nasm.sourceforge.net)
 362 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
 363 #NASM := /opt/vmm-tools/bin/nasm
 364
 365 CPP := cpp
 366
 367
 368 ifeq ($(ARCH),64)
 369 AS = as --64
 370 else
 371 AS = as --32
 372 endif
 373
 374
 375 # Tool to build PFAT filesystem images.
 376 BUILDFAT := tools/builtFat.exe
 377
 378 # Perl5 or later
 379 PERL := perl
 380
 381 # Pad a file so its size is a multiple of some unit (i.e., sector size)
 382 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
 383
 384 # Create a file filled with zeroes.
 385 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
 386
 387 # Calculate size of file in sectors
 388 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
 389
 390
 391 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
 392
 393
 394 # ----------------------------------------------------------------------
 395 # Definitions -
 396 #   Options passed to the tools.
 397 # ----------------------------------------------------------------------
 398
 399 # Flags used for all C source files
 400
 401 CC_GENERAL_OPTS = \
 402         -O \
 403         -Wall \
 404         -g \
 405         -D__V3VEE__ \
 406         -D$(V3_ARCH) \
 407         $(EXTRA_C_OPTS) \
 408         $(VMM_FLAGS) \
 409         -I$(PROJECT_ROOT)/include \
 410         -Werror \
 411         -fPIC \
 412         -Wp,-MD,$(@D)/.$(@F).d \
 413         -Wp,-MT,$@ \
 414
 415 #-fPIC \
 416 #-fvisibility=hidden
 417
 418
 419 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
 420 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
 421
 422 # ----------------------------------------------------------------------
 423 # Rules -
 424 #   Describes how to compile the source files.
 425 # ----------------------------------------------------------------------
 426
 427 # Compilation of kernel C source files
 428 # Usage:
 429 #       $(call build,TAG,commandline)
 430 #
 431 # If V=1 on the command line or the environment, then the actual
 432 # command executed will be echoed to the terminal.  Otherwise
 433 # only the tag and the output file will be printed to make
 434 # any warnings stand out from the compile messages.
 435 #
 436 build = \
 437         @if [ -z "$V" ]; then \
 438                 echo '    [$1]  $@'; \
 439                 $2; \
 440         else \
 441                 echo '$2'; \
 442                 $2; \
 443         fi
 444
 445
 446
 447 CC_COMPILE = \
 448         $(call build,CC,$(TARGET_CC) \
 449                 $(CC_GENERAL_OPTS) \
 450                 $(EXTRA_CFLAGS) \
 451                 -c \
 452                 $< \
 453                 -o $@ \
 454                 $(INSTRUMENT_OPT) \
 455         )
 456
 457 AS_COMPILE = \
 458         $(call build,AS,$(TARGET_CC) \
 459                 $(CC_GENERAL_OPTS) \
 460                 $(EXTRA_CFLAGS) \
 461                 -c \
 462                 $< \
 463                 -o $@ \
 464                 $(INSTRUMENT_OPT) \
 465         )
 466
 467
 468 %.o: %.c
 469         $(CC_COMPILE)
 470 %.o: %.S
 471         $(AS_COMPILE)
 472 %.o: %.s
 473         $(AS_COMPILE)
 474
 475
 476 # ----------------------------------------------------------------------
 477 # Targets -
 478 #   Specifies files to be built
 479 # ----------------------------------------------------------------------
 480
 481 # Default target - see definition of ALL_TARGETS in Configuration section
 482 all : $(ALL_TARGETS)
 483
 484
 485 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
 486 #       $(NASM) -O99 \
 487 #       -f elf \
 488 #               -I$(PROJECT_ROOT)/src/geekos/ \
 489 #               $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
 490 #       -o $@
 491
 492
 493 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
 494 #       $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o  -o geekos/test
 495
 496
 497
 498 rombios_link:
 499         ln -s -f ../src/vmboot/rombios/BIOS-bochs-latest rombios
 500
 501 vgabios_link:
 502         ln -s -f ../src/vmboot/vgabios/VGABIOS-lgpl-latest.bin vgabios
 503
 504
 505 force_rombios: rombios_link
 506         (cd ../src/vmboot/rombios; make clean; make)
 507
 508 force_vgabios: vgabios_link
 509         (cd ../src/vmboot/vgabios; make clean; make)
 510
 511 force_payload: force_rombios force_vgabios
 512         ../scripts/make_payload.pl payload_layout.txt vm_kernel
 513
 514 inter1: force_payload
 515         -make clean
 516
 517 world: inter1 vmm
 518
 519 vmm: palacios/vmm.lib
 520
 521
 522
 523
 524 # Loadable (flat) kernel image.
 525 palacios/vmm.bin : palacios/vmm.lib
 526         $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary palacios/vmm.lib palacios/vmm.bin
 527
 528
 529 # The kernel executable and symbol map.
 530 palacios/vmm.lib: libv3vee.a
 531 libv3vee.a: \
 532         $(VMM_OBJS) \
 533         $(DEVICES_OBJS) \
 534         $(XED_OBJS) \
 535
 536         $(call build,AR,$(TARGET_AR) rcs $@ $^)
 537
 538 force:
 539
 540
 541
 542
 543
 544 # Clean build directories of generated files
 545 clean :
 546         for d in palacios devices xed; do \
 547                 (cd $$d && rm -f * .*.d); \
 548         done
 549
 550
 551 # Include all of the generated dependency files if they exist
 552 -include */.*.o.d