Build with -D_GNU_SOURCE to enable gnu extensions in header files
[oota-llvm.git] / Makefile.common
index de40eabfcdbae9773f85c865b19b0f34a418fc20..029c2c987a5814e5254d30acbb71311f6b91a0f6 100644 (file)
@@ -5,7 +5,8 @@
 # These are platform dependant, so this is the file used to specify these
 # system dependant operations.
 #
-# The following functionality may be set by setting incoming variables:
+# The following functionality can be set by setting incoming variables.
+# The variable $(LEVEL) *must* be set:
 #
 # 1. LEVEL - The level of the current subdirectory from the top of the 
 #    MagicStats view.  This level should be expressed as a path, for 
 #
 #===-----------------------------------------------------------------------====
 
+# Configuration file to set paths specific to local installation of LLVM
+# 
+include $(LEVEL)/Makefile.config
+
 # These are options that can either be enabled here, or can be enabled on the
-# make command line (make ENABLE_PROFILING=1)
+# make command line (ie, make ENABLE_PROFILING=1)
+#
+
+# When ENABLE_PROFILING is enabled, the llvm source base is built with profile
+# information to allow gprof to be used to get execution frequencies.
 #
 #ENABLE_PROFILING = 1
+
+# When ENABLE_PURIFY is enabled, the LLVM tools are linked with purify (which
+# must be locally installed) to allow for some automated memory error debugging.
+#
 #ENABLE_PURIFY    = 1
+
+# When ENABLE_OPTIMIZED is enabled, Release builds of all of the LLVM code are
+# turned on, and Debug builds are turned off.
+#
 #ENABLE_OPTIMIZED = 1
 
 ifdef SHARED_LIBRARY
@@ -40,32 +57,59 @@ all ::
 # Default for install is to at least build everything...
 install ::
 
+
+# Figure out which directory to build stuff into.  We want to build into the
+# /shared directory by default because it is guaranteed to be local to the
+# current machine.
+#
+ifeq ($(LLVM_OBJ_DIR),.)
+BUILD_ROOT     = $(LLVM_OBJ_DIR)
+BUILD_ROOT_TOP = $(LEVEL)
+else
+
+BUILD_ROOT := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(shell pwd))
+
+# Calculate the BUILD_ROOT_TOP variable, which is the top of the llvm/ tree.
+# Note that although this is just equal to $(BUILD_ROOT)/$(LEVEL), we cannot use
+# this expression because some of the directories on the source tree may not
+# exist in the build tree (for example the test/ heirarchy).  Thus we evaluate
+# the directory to eliminate the ../'s
+#
+TOP_DIRECTORY := $(shell cd $(LEVEL); pwd)
+BUILD_ROOT_TOP := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
+endif
+
 #--------------------------------------------------------------------
-# Installation configuration options... 
+# Variables derived from configuration options... 
 #--------------------------------------------------------------------
 
 #BinInstDir=/usr/local/bin
 #LibInstDir=/usrl/local/lib/xxx
 #DocInstDir=/usr/doc/xxx
 
-BURG = /home/vadve/vadve/Research/DynOpt/Burg/burg
 BURG_OPTS = -I
 
-
-PURIFY = /usr/dcs/applications/purify/bin/purify -cache-dir="$(HOME)/purifycache" -chain-length="30" -messages=all 
+PURIFY := $(PURIFY) -cache-dir="$(BUILD_ROOT_TOP)/../purifycache" -chain-length="30" -messages=all 
 
 # Shorthand for commonly accessed directories
-LIBDEBUG    = $(LEVEL)/lib/Debug
-LIBRELEASE  = $(LEVEL)/lib/Release
-TOOLDEBUG   = $(LEVEL)/tools/Debug
-TOOLRELEASE = $(LEVEL)/tools/Release
+LIBDEBUG    := $(BUILD_ROOT_TOP)/lib/Debug
+LIBRELEASE  := $(BUILD_ROOT_TOP)/lib/Release
+TOOLDEBUG   := $(BUILD_ROOT_TOP)/tools/Debug
+TOOLRELEASE := $(BUILD_ROOT_TOP)/tools/Release
+
+# Verbosity levels
+ifdef VERBOSE
+VERB := 
+else
+VERB := @
+endif
 
 #---------------------------------------------------------
 # Compilation options...
 #---------------------------------------------------------
 
 # Special tools used while building
-RunBurg  = $(BURG) $(BURG_OPTS)
+RunBurg  := $(BURG) $(BURG_OPTS)
 
 # Enable this for profiling support with 'gprof'
 ifdef ENABLE_PROFILING
@@ -74,40 +118,40 @@ else
 PROFILE =
 endif
 
-# TODO: Get rid of exceptions! : -fno-exceptions -fno-rtti
+# Allow gnu extensions...
+CPPFLAGS += -D_GNU_SOURCE
+
 # -Wno-unused-parameter
-CompileCommonOpts = $(PROFILE) -Wall -W  -Wwrite-strings -Wno-unused -I$(LEVEL)/include
+CompileCommonOpts := $(PROFILE) -Wall -W  -Wwrite-strings -Wno-unused -I$(LEVEL)/include
 
 # Compile a file, don't link...
-Compile  = $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts) $(PROFILE)
-CompileG = $(Compile) -g  -D_DEBUG
-CompileO = $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fnonnull-objects -freg-struct-return -fshort-enums
+Compile  := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
+CompileG := $(Compile) -g  -D_DEBUG
+CompileO := $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fnonnull-objects -freg-struct-return -fshort-enums
 
 # Link final executable
 
-# To enable purify, do it here:
-ifdef ENABLE_PURIFY
-Link     = $(PURIFY) $(CXX) $(Prof) -static
+ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
+Link     := $(PURIFY) $(CXX) $(PROFILE) -static
 else
-Link     = LD_RUN_PATH=/usr/dcs/software/evaluation/encap/gcc-3.0.4/lib $(CXX) $(PROFILE)
+Link     := $(CXX) $(PROFILE)
 endif
-LinkG    = $(Link) -g  -L $(LIBDEBUG)
-LinkO    = $(Link) -O3 -L $(LIBRELEASE)
+LinkG    := $(Link) -g  -L $(LIBDEBUG)
+LinkO    := $(Link) -O3 -L $(LIBRELEASE)
 
 # Create a .so file from a .o files...
-#MakeSO   = $(CXX) -shared $(Prof)
-MakeSO   = $(CXX) -G $(Prof)
-MakeSOO  = $(MakeSO) -O3
+#MakeSO   := $(CXX) -shared $(PROFILE)
+MakeSO   := $(CXX) -G $(PROFILE)
+MakeSOO  := $(MakeSO) -O3
 
 # Create one .o file from a bunch of .o files...
 Relink = ld -r
 
 # Create dependancy file from CPP file, send to stdout.
-Depend   = $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS) 
+Depend   := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS) 
 
 # Archive a bunch of .o files into a .a file...
 AR       = ar cq 
-MakeLib   = $(AR)
 
 #----------------------------------------------------------
 
@@ -118,8 +162,8 @@ MakeLib   = $(AR)
 Source  := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
 
 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
-ObjectsO = $(addprefix Release/,$(Objs))
-ObjectsG = $(addprefix Debug/,$(Objs))
+ObjectsO = $(addprefix $(BUILD_ROOT)/Release/,$(Objs)))
+ObjectsG = $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
 
 
 #---------------------------------------------------------
@@ -133,7 +177,7 @@ install :: $(addsuffix /.makeinstall, $(DIRS))
 clean   :: $(addsuffix /.makeclean  , $(DIRS))
 
 %/.makeall %/.makeclean %/.makeinstall:
-       cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
+       $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
 endif
 
 #---------------------------------------------------------
@@ -149,7 +193,7 @@ endif
 #  BUILD_ARCHIVE instead.
 #
 #  Some libraries must be built as .a files (libscalar for example) because if
-#  it's built as a .o file, then all of the constitent .o files in it will be
+#  it's built as a .o file, then all of the constituent .o files in it will be
 #  linked into tools (for example gccas) even if they only use one of the parts
 #  of it.  For this reason, sometimes it's useful to use libraries as .a files.
 
@@ -162,6 +206,8 @@ LIBNAME_AG   := $(LIBDEBUG)/lib$(LIBRARYNAME).a
 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
 
+
+ifndef ENABLE_OPTIMIZED
 BUILD_LIBNAME_G := $(LIBNAME_G)
 ifndef DONT_BUILD_RELINKED
 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
@@ -169,6 +215,7 @@ endif
 ifdef BUILD_ARCHIVE
 BUILD_LIBNAME_AG := $(LIBNAME_AG)
 endif
+endif
 
 # If optimized builds are enabled...
 ifdef ENABLE_OPTIMIZED
@@ -185,29 +232,30 @@ all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG)      # Debug
 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO)      # Release
 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O)      # .so files
 
-$(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir Depend/.dir
+$(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
        @echo ======= Linking $(LIBRARYNAME) release library =======
-       $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
+       $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
 
-$(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir Depend/.dir
+$(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
        @echo ======= Linking $(LIBRARYNAME) debug library =======
-       $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
+       $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
 
-$(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir Depend/.dir
+$(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
        @echo ======= Linking $(LIBRARYNAME) release library =======
        @rm -f $@
-       $(MakeLib) $@ $(ObjectsO) $(LibSubDirs)
+       $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
 
-$(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir Depend/.dir
+$(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
        @echo ======= Linking $(LIBRARYNAME) debug library =======
        @rm -f $@
-       $(MakeLib) $@ $(ObjectsG) $(LibSubDirs)
+       $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
 
-$(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir Depend/.dir
-       $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
+$(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
+       @echo "Linking $@"
+       $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
 
-$(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir Depend/.dir
-       $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
+$(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
+       $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
 
 endif
 
@@ -216,12 +264,9 @@ endif
 #------------------------------------------------------------------------
 
 ifeq ($(LEVEL), .)
-
 tags:
        etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
-
 all:: tags
-
 endif
 
 #------------------------------------------------------------------------
@@ -236,9 +281,9 @@ endif
 ifdef TOOLNAME
 
 # TOOLEXENAME* - These compute the output filenames to generate...
-TOOLEXENAME_G = $(LEVEL)/tools/Debug/$(TOOLNAME)
-TOOLEXENAME_O = $(LEVEL)/tools/Release/$(TOOLNAME)
-TOOLEXENAMES := $(TOOLEXENAME_G)
+TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
+TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
+TOOLEXENAMES  := $(TOOLEXENAME_G)
 ifdef ENABLE_OPTIMIZED
 TOOLEXENAMES += $(TOOLEXENAME_O)
 endif
@@ -259,46 +304,47 @@ USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
 
 all::   $(TOOLEXENAMES)
 clean::
-       rm -f $(TOOLEXENAMES)
+       $(VERB) rm -f $(TOOLEXENAMES)
 
-$(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(LEVEL)/tools/Debug/.dir
-       $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
+$(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
+       @echo ======= Linking $(TOOLNAME) debug executable =======
+       $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
 
-$(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(LEVEL)/tools/Release/.dir
-       $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
+$(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
+       @echo ======= Linking $(TOOLNAME) release executable =======
+       $(VERB) $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
 
 endif
 
 
 
 #---------------------------------------------------------
-.PRECIOUS: Depend/.dir Debug/.dir Release/.dir
+.PRECIOUS: $(BUILD_ROOT)/Depend/.dir
+.PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
 
 # Create dependencies for the *.cpp files...
-Depend/%.d: %.cpp Depend/.dir
-       $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
+$(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
+       $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
 
 # Create dependencies for the *.c files...
-Depend/%.d: %.c Depend/.dir
-       $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
+$(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
+       $(VERB) $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
 
 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
-Release/%.o: %.cpp Release/.dir Depend/.dir
-       $(CompileO) $< -o $@
+$(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
+       @echo "Compiling $<"
+       $(VERB) $(CompileO) $< -o $@
 
 #Release/%.o: %.c Release/.dir Depend/.dir
 #      $(CompileOC) $< -o $@
 
-Debug/%.o: %.cpp Debug/.dir Depend/.dir
-       $(CompileG) $< -o $@
+$(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
+       @echo "Compiling $<"
+       $(VERB) $(CompileG) $< -o $@
 
-#Debug/%.o: %.c Debug/.dir Depend/.dir
+#Debug/%.o: %.c Debug/.dir 
 #      $(CompileGC) $< -o $@
 
-# Create a .cpp source file from a burg input file
-#Debug/%.cpp: Debug/% Debug/.dir
-#      $(RunBurg) $< -o $@
-
 # Create a .cpp source file from a flex input file... this uses sed to cut down
 # on the warnings emited by GCC...
 %.cpp: %.l
@@ -307,24 +353,24 @@ Debug/%.o: %.cpp Debug/.dir Depend/.dir
 # Rule for building the bison parsers...
 
 %.cpp %.h : %.y
-       bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
-       mv -f $(basename $@).tab.c $(basename $@).cpp
-       mv -f $(basename $@).tab.h $(basename $@).h
+       $(VERB) bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
+       $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
+       $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
 
 # To create the directories...
 %/.dir:
-       mkdir -p $(@D)
+       $(VERB) mkdir -p $(@D)
        @date > $@
 
-# Clean does not remove the output files... just the temporaries
+# Clean nukes the tree
 clean::
-       rm -rf Debug Release Depend
-       rm -f core *.o *.d *.so *~ *.flc
+       $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Depend
+       $(VERB) rm -f core *.o *.d *.so *~ *.flc
 
 # If dependancies were generated for the file that included this file,
 # include the dependancies now...
 #
-SourceDepend = $(addsuffix .d,$(addprefix Depend/,$(basename $(filter-out Debug/%, $(Source)))))
+SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
 ifneq ($(SourceDepend),)
 include $(SourceDepend)
 endif