Local configuration options for a particular installation of LLVM.
[oota-llvm.git] / Makefile.common
index b13db1802d8b526bfe3fd2412cfb0c0981d5a7bb..d564cad3eb1fa632c997cfd6368ff71c3ab31aae 100644 (file)
 #===-----------------------------------------------------------------------====
 
 # 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
 
+# Current working directory, used below
+CUR_DIRECTORY := $(shell pwd)
+
+# Path to directory where object files should be stored during a build.
+# Set this to "." if you do not want to use a separate place for object files.
+# 
+BUILD_DIR = /shared/$(LOGIN_NAME)$(patsubst $(HOME)%,%,$(CUR_DIRECTORY))
+
+# Flag whether or not to use a separate location for build files
+#
+ifeq ($(BUILD_DIR),".")
+  BUILD_ROOT = $(BUILD_DIR)
+endif
+
 ifdef SHARED_LIBRARY
 # if SHARED_LIBRARY is specified, the default is to build the dynamic lib
 dynamic ::
@@ -40,6 +66,28 @@ 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.
+#
+ifdef BUILD_ROOT
+BUILD_ROOT_TOP := $(LEVEL)
+else
+
+LOGIN_NAME := $(shell whoami)
+BUILD_ROOT := $(BUILD_DIR)
+
+# 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 := /shared/$(LOGIN_NAME)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
+endif
+
 #--------------------------------------------------------------------
 # Installation configuration options... 
 #--------------------------------------------------------------------
@@ -52,20 +100,20 @@ 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 = /usr/dcs/applications/purify/bin/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
 
 #---------------------------------------------------------
 # 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
@@ -75,37 +123,36 @@ PROFILE =
 endif
 
 # -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)
-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
 
 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
-Link     = $(PURIFY) $(CXX) $(PROFILE) -static
+Link     := $(PURIFY) $(CXX) $(PROFILE) -static
 else
-Link     = $(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 $(PROFILE)
-MakeSO   = $(CXX) -G $(PROFILE)
-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)
 
 #----------------------------------------------------------
 
@@ -116,8 +163,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))
 
 
 #---------------------------------------------------------
@@ -186,28 +233,28 @@ 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)
 
-$(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)
 
-$(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir Depend/.dir
+$(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
        @echo ======= Linking $(LIBRARYNAME) release library =======
        @rm -f $@
-       $(MakeLib) $@ $(ObjectsO) $(LibSubDirs)
+       $(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)
+       $(AR) $@ $(ObjectsG) $(LibSubDirs)
 
-$(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir Depend/.dir
+$(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
        $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
 
-$(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir Depend/.dir
+$(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
        $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
 
 endif
@@ -234,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,10 +306,10 @@ all::   $(TOOLEXENAMES)
 clean::
        rm -f $(TOOLEXENAMES)
 
-$(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(LEVEL)/tools/Debug/.dir
+$(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
        $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
 
-$(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(LEVEL)/tools/Release/.dir
+$(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
        $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
 
 endif
@@ -270,27 +317,28 @@ 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
+       $(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
+$(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
        $(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
+$(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
        $(CompileO) $< -o $@
 
 #Release/%.o: %.c Release/.dir Depend/.dir
 #      $(CompileOC) $< -o $@
 
-Debug/%.o: %.cpp Debug/.dir Depend/.dir
+$(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
        $(CompileG) $< -o $@
 
-#Debug/%.o: %.c Debug/.dir Depend/.dir
+#Debug/%.o: %.c Debug/.dir 
 #      $(CompileGC) $< -o $@
 
 # Create a .cpp source file from a flex input file... this uses sed to cut down
@@ -312,13 +360,13 @@ Debug/%.o: %.cpp Debug/.dir Depend/.dir
 
 # Clean nukes the tree
 clean::
-       rm -rf Debug Release Depend
+       rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Depend
        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