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_NESTED_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_IDE
  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
  77 endif
  78 ifeq ($(DEBUG_NESTED_PAGING),1)
  79 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NESTED_PAGING
  80 else
  81 ifeq ($(DEBUG_NESTED_PAGING),0)
  82 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_NESTED_PAGING
  83 endif
  84 endif
  85
  86 ifeq ($(DEBUG_CTRL_REGS),1)
  87 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_CTRL_REGS
  88 else
  89 ifeq ($(DEBUG_CTRL_REGS),0)
  90 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_CTRL_REGS
  91 endif
  92 endif
  93
  94 ifeq ($(DEBUG_INTERRUPTS),1)
  95 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_INTERRUPTS
  96 else
  97 ifeq ($(DEBUG_INTERRUPTS),0)
  98 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_INTERRUPTS
  99 endif
 100 endif
 101
 102 ifeq ($(DEBUG_IO),1)
 103 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IO
 104 else
 105 ifeq ($(DEBUG_IO),0)
 106 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_IO
 107 endif
 108 endif
 109
 110 ifeq ($(DEBUG_KEYBOARD),1)
 111 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_KEYBOARD
 112 else
 113 ifeq ($(DEBUG_KEYBOARD),0)
 114 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_KEYBOARD
 115 endif
 116 endif
 117
 118 ifeq ($(DEBUG_PIC),1)
 119 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIC
 120 else
 121 ifeq ($(DEBUG_PIC),0)
 122 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIC
 123 endif
 124 endif
 125
 126 ifeq ($(DEBUG_PIT),1)
 127 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PIT
 128 else
 129 ifeq ($(DEBUG_PIT),0)
 130 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PIT
 131 endif
 132 endif
 133
 134 ifeq ($(DEBUG_NVRAM),1)
 135 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NVRAM
 136 else
 137 ifeq ($(DEBUG_NVRAM),0)
 138 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_NVRAM
 139 endif
 140 endif
 141
 142 ifeq ($(DEBUG_GENERIC),1)
 143 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_GENERIC
 144 else
 145 ifeq ($(DEBUG_GENERIC),0)
 146 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_GENERIC
 147 endif
 148 endif
 149
 150 ifeq ($(DEBUG_EMULATOR),1)
 151 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_EMULATOR
 152 else
 153 ifeq ($(DEBUG_EMULATOR),0)
 154 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_EMULATOR
 155 endif
 156 endif
 157
 158 ifeq ($(DEBUG_IDE),1)
 159 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_IDE
 160 else
 161 ifeq ($(DEBUG_IDE),0)
 162 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_IDE
 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_APIC),1)
 183 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_APIC
 184 else
 185 ifeq ($(DEBUG_APIC),0)
 186 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_APIC
 187 endif
 188 endif
 189
 190 ifeq ($(DEBUG_PCI),1)
 191 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_PCI
 192 else
 193 ifeq ($(DEBUG_PCI),0)
 194 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_PCI
 195 endif
 196 endif
 197
 198 ifeq ($(DEBUG_DEV_MGR),1)
 199 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_DEV_MGR
 200 else
 201 ifeq ($(DEBUG_DEV_MGR),0)
 202 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_DEV_MGR
 203 endif
 204 endif
 205
 206 ifeq ($(DEBUG_NE2K),1)
 207 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DDEBUG_NE2K
 208 else
 209 ifeq ($(DEBUG_NE2K),0)
 210 DEBUG_SECTIONS := $(DEBUG_SECTIONS) -UDEBUG_NE2K
 211 endif
 212 endif
 213
 214 #DEBUG_SECTIONS := $(DEBUG_SECTIONS) -DTEST_NE2K
 215
 216 ifeq ($(DEBUG),1)
 217   JRLDEBUG=  -DVMM_DEBUG -DVMM_INFO -DVMM_TRACE $(DEBUG_SECTIONS)
 218 else
 219
 220 endif
 221
 222
 223
 224
 225
 226
 227 #
 228 # This is wrong for current cygwin - no changes needed
 229 #
 230 # Figure out if we're compiling with cygwin, http://cygwin.com
 231 #
 232 #
 233 #SYSTEM_NAME := $(shell uname -s)
 234 #ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
 235 #SYM_PFX            := _
 236 #EXTRA_C_OPTS       := -DNEED_UNDERSCORE -DGNU_WIN32
 237 #EXTRA_NASM_OPTS    := -DNEED_UNDERSCORE
 238 #NON_ELF_SYSTEM     := yes
 239 #EXTRA_CC_USER_OPTS := -Dmain=geekos_main
 240 #endif
 241
 242
 243
 244 ifeq ($(INSTRUMENT_VMM),1)
 245   EXTRA_C_OPTS:= -DINSTRUMENT_VMM
 246   INSTRUMENT_OPT := -finstrument-functions
 247   OBJ_FILES := palacios/vmm_instrument.o
 248 else
 249   INSTRUMENT_OPT :=
 250 endif
 251
 252
 253
 254 # ----------------------------------------------------------------------
 255 # Configuration -
 256 #   Various options specifying how GeekOS should be built,
 257 #   what source files to build, which user programs to build,
 258 #   etc.  This is generally the only section of the makefile
 259 #   that will need to be modified.
 260 # ----------------------------------------------------------------------
 261
 262 # List of targets to build by default.
 263 # These targets encompass everything needed to boot
 264 # and run GeekOS.
 265 ALL_TARGETS := vmm force_payload
 266
 267
 268 VMM_OBJS := \
 269         palacios/vm_guest.o \
 270         palacios/svm.o \
 271         palacios/svm_handler.o \
 272         palacios/vmm.o \
 273         palacios/vmm_util.o \
 274         palacios/vmm_ctrl_regs.o \
 275         palacios/vmcb.o \
 276         palacios/vmm_mem.o \
 277         palacios/vmm_paging.o \
 278         palacios/vmm_io.o \
 279         palacios/vmm_debug.o \
 280         palacios/svm_io.o \
 281         palacios/vmm_intr.o \
 282         palacios/vmm_excp.o \
 283         palacios/vmm_time.o \
 284         palacios/vmm_shadow_paging.o \
 285         palacios/vm_guest_mem.o \
 286         palacios/vm_dev.o \
 287         palacios/vmm_dev_mgr.o \
 288         palacios/vmm_decoder.o \
 289         palacios/svm_halt.o \
 290         palacios/svm_pause.o \
 291         palacios/svm_wbinvd.o \
 292         palacios/vmm_config.o \
 293         palacios/vmm_hashtable.o \
 294         palacios/vmm_string.o \
 295         palacios/vmm_emulator.o \
 296         palacios/vmm_queue.o \
 297         palacios/vmm_host_events.o \
 298         palacios/svm_lowlevel.o \
 299         palacios/vmm_msr.o \
 300         palacios/svm_msr.o \
 301         palacios/vmm_socket.o \
 302         palacios/vmm_xed.o \
 303         palacios/vmm_rbtree.o \
 304         palacios/vmm_profiler.o \
 305         palacios/vmm_direct_paging.o \
 306         palacios/vmm_ringbuffer.o \
 307         palacios/vmm_hypercall.o \
 308         $(OBJ_FILES)
 309
 310 #               vmx.c vmcs_gen.c vmcs.c
 311
 312 # Extra C flags for the VMM objects
 313 $(VMM_OBJS) :: EXTRA_CFLAGS = \
 314         $(JRLDEBUG) \
 315
 316
 317
 318 XED_OBJS := \
 319         xed/v3-xed-compat.o \
 320         xed/v3-udiv-compat.o \
 321
 322 $(XED_OBJS) :: EXTRA_CFLAGS = \
 323         $(JRLDEBUG) \
 324
 325 DEVICES_OBJS := \
 326         devices/generic.o \
 327         devices/keyboard.o \
 328         devices/nvram.o \
 329         devices/timer.o \
 330         devices/simple_pic.o \
 331         devices/8259a.o \
 332         devices/8254.o \
 333         devices/serial.o \
 334         devices/bochs_debug.o \
 335         devices/os_debug.o \
 336         devices/apic.o  \
 337         devices/io_apic.o \
 338         devices/pci.o \
 339         devices/para_net.o \
 340         devices/ide.o \
 341         devices/ram_cd.o \
 342         devices/ram_hd.o \
 343         devices/i440fx.o \
 344         devices/piix3.o \
 345
 346 #       devices/ne2k.o  \
 347 #       devices/cdrom.o \
 348 #       devices/ramdisk.o \
 349 #       devices/vnic.o \
 350
 351 $(DEVICES_OBJS) :: EXTRA_CFLAGS = \
 352         $(JRLDEBUG) \
 353
 354
 355
 356 # ----------------------------------------------------------------------
 357 # Tools -
 358 #   This section defines programs that are used to build GeekOS.
 359 # ----------------------------------------------------------------------
 360
 361 ifeq ($(ARCH),64)
 362 V3_ARCH := __V3_64BIT__
 363 else
 364 V3_ARCH := __V3_32BIT__
 365 endif
 366
 367
 368 ifeq ($(CRAY_XT),1)
 369 EXTRA_C_OPTS := $(EXTRA_C_OPTS) -DCRAY_XT
 370 endif
 371
 372
 373 # Uncomment if cross compiling
 374 #TARGET_CC_PREFIX :=  $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
 375 #TARGET_CC_PREFIX :=  i386-elf-
 376
 377 # Target C compiler.  gcc 2.95.2 or later should work.
 378 ifeq ($(ARCH),64)
 379 TARGET_CC := $(TARGET_CC_PREFIX)gcc -m64
 380 else
 381 TARGET_CC := $(TARGET_CC_PREFIX)gcc -m32
 382 endif
 383 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
 384
 385
 386 # Target linker.  GNU ld is probably to only one that will work.
 387 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
 388
 389 # Target archiver
 390 TARGET_AR := $(TARGET_CC_PREFIX)ar
 391
 392 # Target ranlib
 393 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
 394
 395 # Target nm
 396 TARGET_NM := $(TARGET_CC_PREFIX)nm
 397
 398 # Target objcopy
 399 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
 400
 401 # Nasm (http://nasm.sourceforge.net)
 402 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
 403 #NASM := /opt/vmm-tools/bin/nasm
 404
 405 CPP := cpp
 406
 407
 408 ifeq ($(ARCH),64)
 409 AS = as --64
 410 else
 411 AS = as --32
 412 endif
 413
 414
 415 # Tool to build PFAT filesystem images.
 416 BUILDFAT := tools/builtFat.exe
 417
 418 # Perl5 or later
 419 PERL := perl
 420
 421 # Pad a file so its size is a multiple of some unit (i.e., sector size)
 422 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
 423
 424 # Create a file filled with zeroes.
 425 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
 426
 427 # Calculate size of file in sectors
 428 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
 429
 430
 431 FD_SECTORS_PER_TRACK := $(PERL) $(PROJECT_ROOT)/scripts/numsecs_per_track
 432
 433
 434 # ----------------------------------------------------------------------
 435 # Definitions -
 436 #   Options passed to the tools.
 437 # ----------------------------------------------------------------------
 438
 439 # Flags used for all C source files
 440
 441 CC_GENERAL_OPTS = \
 442         -O \
 443         -Wall \
 444         -g \
 445         -D__V3VEE__ \
 446         -D$(V3_ARCH) \
 447         $(EXTRA_C_OPTS) \
 448         $(VMM_FLAGS) \
 449         -I$(PROJECT_ROOT)/include \
 450         -Werror \
 451         -fPIC \
 452         -mno-red-zone \
 453         -Wp,-MD,$(@D)/.$(@F).d \
 454         -Wp,-MT,$@ \
 455
 456 #-fPIC \
 457 #-fvisibility=hidden
 458
 459
 460 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
 461 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
 462
 463 # ----------------------------------------------------------------------
 464 # Rules -
 465 #   Describes how to compile the source files.
 466 # ----------------------------------------------------------------------
 467
 468 # Compilation of kernel C source files
 469 # Usage:
 470 #       $(call build,TAG,commandline)
 471 #
 472 # If V=1 on the command line or the environment, then the actual
 473 # command executed will be echoed to the terminal.  Otherwise
 474 # only the tag and the output file will be printed to make
 475 # any warnings stand out from the compile messages.
 476 #
 477 build = \
 478         @if [ -z "$V" ]; then \
 479                 echo '    [$1]  $@'; \
 480                 $2; \
 481         else \
 482                 echo '$2'; \
 483                 $2; \
 484         fi
 485
 486
 487
 488 CC_COMPILE = \
 489         $(call build,CC,$(TARGET_CC) \
 490                 $(CC_GENERAL_OPTS) \
 491                 $(EXTRA_CFLAGS) \
 492                 -c \
 493                 $< \
 494                 -o $@ \
 495                 $(INSTRUMENT_OPT) \
 496         )
 497
 498 AS_COMPILE = \
 499         $(call build,AS,$(TARGET_CC) \
 500                 $(CC_GENERAL_OPTS) \
 501                 $(EXTRA_CFLAGS) \
 502                 -c \
 503                 $< \
 504                 -o $@ \
 505                 $(INSTRUMENT_OPT) \
 506         )
 507
 508
 509 %.o: %.c
 510         $(CC_COMPILE)
 511 %.o: %.S
 512         $(AS_COMPILE)
 513 %.o: %.s
 514         $(AS_COMPILE)
 515
 516
 517 # ----------------------------------------------------------------------
 518 # Targets -
 519 #   Specifies files to be built
 520 # ----------------------------------------------------------------------
 521
 522 # Default target - see definition of ALL_TARGETS in Configuration section
 523 all : $(ALL_TARGETS)
 524
 525
 526 #geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
 527 #       $(NASM) -O99 \
 528 #       -f elf \
 529 #               -I$(PROJECT_ROOT)/src/geekos/ \
 530 #               $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
 531 #       -o $@
 532
 533
 534 #geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
 535 #       $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o  -o geekos/test
 536
 537
 538
 539 rombios_link:
 540         ln -s -f ../src/vmboot/rombios/BIOS-bochs-latest rombios
 541
 542 vgabios_link:
 543         ln -s -f ../src/vmboot/vgabios/VGABIOS-lgpl-latest.bin vgabios
 544
 545
 546 force_payload: rombios_link vgabios_link
 547         ../scripts/make_payload.pl payload_layout.txt vm_kernel
 548
 549 inter1: force_payload
 550         -make clean
 551
 552 world: inter1 vmm
 553
 554 vmm: palacios/vmm.lib
 555
 556
 557
 558
 559 # Loadable (flat) kernel image.
 560 palacios/vmm.bin : palacios/vmm.lib
 561         $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary palacios/vmm.lib palacios/vmm.bin
 562
 563
 564 # The kernel executable and symbol map.
 565 palacios/vmm.lib: libv3vee.a
 566 libv3vee.a: \
 567         $(VMM_OBJS) \
 568         $(DEVICES_OBJS) \
 569         $(XED_OBJS) \
 570
 571         $(call build,AR,$(TARGET_AR) rcs $@ $^)
 572
 573 force:
 574
 575
 576
 577
 578
 579 # Clean build directories of generated files
 580 clean :
 581         for d in palacios devices xed; do \
 582                 (cd $$d && rm -f * .*.d); \
 583         done
 584
 585
 586 # Include all of the generated dependency files if they exist
 587 -include */.*.o.d