Makefile.common

   1 #===-- Makefile.common - Common make rules for LLVM -------*- makefile -*--====
   2 #
   3 # This file is included by all of the LLVM makefiles.  This file defines common
   4 # rules to do things like compile a .cpp file or generate dependancy info.
   5 # These are platform dependant, so this is the file used to specify these
   6 # system dependant operations.
   7 #
   8 # The following functionality may be set by setting incoming variables:
   9 #
  10 # 1. LEVEL - The level of the current subdirectory from the top of the
  11 #    MagicStats view.  This level should be expressed as a path, for
  12 #    example, ../.. for two levels deep.
  13 #
  14 # 2. DIRS - A list of subdirectories to be built.  Fake targets are set up
  15 #    so that each of the targets "all", "install", and "clean" each build.
  16 #    the subdirectories before the local target.
  17 #
  18 # 3. Source - If specified, this sets the source code filenames.  If this
  19 #    is not set, it defaults to be all of the .cpp, .c, .y, and .l files
  20 #    in the current directory.  Also, if you want to build files in addition
  21 #    to the local files, you can use the ExtraSource variable
  22 #
  23 #===-----------------------------------------------------------------------====
  24
  25 # These are options that can either be enabled here, or can be enabled on the
  26 # make command line (ie, make ENABLE_PROFILING=1)
  27 #
  28
  29 # When ENABLE_PROFILING is enabled, the llvm source base is built with profile
  30 # information to allow gprof to be used to get execution frequencies.
  31 #
  32 #ENABLE_PROFILING = 1
  33
  34 # When ENABLE_PURIFY is enabled, the LLVM tools are linked with purify (which
  35 # must be locally installed) to allow for some automated memory error debugging.
  36 #
  37 #ENABLE_PURIFY    = 1
  38
  39 # When ENABLE_OPTIMIZED is enabled, Release builds of all of the LLVM code are
  40 # turned on, and Debug builds are turned off.
  41 #
  42 #ENABLE_OPTIMIZED = 1
  43
  44 # Current working directory, used below
  45 CUR_DIRECTORY := $(shell pwd)
  46
  47 # Path to directory where object files should be stored during a build.
  48 # Set this to "." if you do not want to use a separate place for object files.
  49 #
  50 BUILD_DIR = /shared/$(LOGIN_NAME)$(patsubst $(HOME)%,%,$(CUR_DIRECTORY))
  51
  52 # Flag whether or not to use a separate location for build files
  53 #
  54 ifeq ($(BUILD_DIR),".")
  55   BUILD_ROOT = $(BUILD_DIR)
  56 endif
  57
  58 ifdef SHARED_LIBRARY
  59 # if SHARED_LIBRARY is specified, the default is to build the dynamic lib
  60 dynamic ::
  61 endif
  62
  63 # Default Rule:  Make sure it's also a :: rule
  64 all ::
  65
  66 # Default for install is to at least build everything...
  67 install ::
  68
  69
  70 # Figure out which directory to build stuff into.  We want to build into the
  71 # /shared directory by default because it is guaranteed to be local to the
  72 # current machine.
  73 #
  74 ifdef BUILD_ROOT
  75 BUILD_ROOT_TOP := $(LEVEL)
  76 else
  77
  78 LOGIN_NAME := $(shell whoami)
  79 BUILD_ROOT := $(BUILD_DIR)
  80
  81 # Calculate the BUILD_ROOT_TOP variable, which is the top of the llvm/ tree.
  82 # Note that although this is just equal to $(BUILD_ROOT)/$(LEVEL), we cannot use
  83 # this expression because some of the directories on the source tree may not
  84 # exist in the build tree (for example the test/ heirarchy).  Thus we evaluate
  85 # the directory to eliminate the ../'s
  86 #
  87 TOP_DIRECTORY := $(shell cd $(LEVEL); pwd)
  88 BUILD_ROOT_TOP := /shared/$(LOGIN_NAME)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
  89 endif
  90
  91 #--------------------------------------------------------------------
  92 # Installation configuration options...
  93 #--------------------------------------------------------------------
  94
  95 #BinInstDir=/usr/local/bin
  96 #LibInstDir=/usrl/local/lib/xxx
  97 #DocInstDir=/usr/doc/xxx
  98
  99 BURG = /home/vadve/vadve/Research/DynOpt/Burg/burg
 100 BURG_OPTS = -I
 101
 102
 103 PURIFY = /usr/dcs/applications/purify/bin/purify -cache-dir="$(BUILD_ROOT_TOP)/../purifycache" -chain-length="30" -messages=all
 104
 105 # Shorthand for commonly accessed directories
 106 LIBDEBUG    := $(BUILD_ROOT_TOP)/lib/Debug
 107 LIBRELEASE  := $(BUILD_ROOT_TOP)/lib/Release
 108 TOOLDEBUG   := $(BUILD_ROOT_TOP)/tools/Debug
 109 TOOLRELEASE := $(BUILD_ROOT_TOP)/tools/Release
 110
 111 #---------------------------------------------------------
 112 # Compilation options...
 113 #---------------------------------------------------------
 114
 115 # Special tools used while building
 116 RunBurg  := $(BURG) $(BURG_OPTS)
 117
 118 # Enable this for profiling support with 'gprof'
 119 ifdef ENABLE_PROFILING
 120 PROFILE = -pg
 121 else
 122 PROFILE =
 123 endif
 124
 125 # -Wno-unused-parameter
 126 CompileCommonOpts := $(PROFILE) -Wall -W  -Wwrite-strings -Wno-unused -I$(LEVEL)/include
 127
 128 # Compile a file, don't link...
 129 Compile  := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
 130 CompileG := $(Compile) -g  -D_DEBUG
 131 CompileO := $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fnonnull-objects -freg-struct-return -fshort-enums
 132
 133 # Link final executable
 134
 135 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
 136 Link     := $(PURIFY) $(CXX) $(PROFILE) -static
 137 else
 138 Link     := $(CXX) $(PROFILE)
 139 endif
 140 LinkG    := $(Link) -g  -L $(LIBDEBUG)
 141 LinkO    := $(Link) -O3 -L $(LIBRELEASE)
 142
 143 # Create a .so file from a .o files...
 144 #MakeSO   := $(CXX) -shared $(PROFILE)
 145 MakeSO   := $(CXX) -G $(PROFILE)
 146 MakeSOO  := $(MakeSO) -O3
 147
 148 # Create one .o file from a bunch of .o files...
 149 Relink = ld -r
 150
 151 # Create dependancy file from CPP file, send to stdout.
 152 Depend   := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
 153
 154 # Archive a bunch of .o files into a .a file...
 155 AR       = ar cq
 156
 157 #----------------------------------------------------------
 158
 159 # Source includes all of the cpp files, and objects are derived from the
 160 # source files...
 161 # The local Makefile can list other Source files via ExtraSource = ...
 162 #
 163 Source  := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
 164
 165 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
 166 ObjectsO = $(addprefix $(BUILD_ROOT)/Release/,$(Objs)))
 167 ObjectsG = $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
 168
 169
 170 #---------------------------------------------------------
 171 # Handle the DIRS option
 172 #---------------------------------------------------------
 173
 174 ifdef DIRS  # Only do this if we're using DIRS!
 175
 176 all     :: $(addsuffix /.makeall    , $(DIRS))
 177 install :: $(addsuffix /.makeinstall, $(DIRS))
 178 clean   :: $(addsuffix /.makeclean  , $(DIRS))
 179
 180 %/.makeall %/.makeclean %/.makeinstall:
 181         cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
 182 endif
 183
 184 #---------------------------------------------------------
 185 # Handle the LIBRARYNAME option - used when building libs...
 186 #---------------------------------------------------------
 187 #
 188 #  When libraries are built, they are allowed to optionally define the
 189 #  DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
 190 #  from being built for the library. This .o files may then be linked to by a
 191 #  tool if the tool does not need (or want) the semantics a .a file provides
 192 #  (linking in only object files that are "needed").  If a library is never to
 193 #  be used in this way, it is better to define DONT_BUILD_RELINKED, and define
 194 #  BUILD_ARCHIVE instead.
 195 #
 196 #  Some libraries must be built as .a files (libscalar for example) because if
 197 #  it's built as a .o file, then all of the constituent .o files in it will be
 198 #  linked into tools (for example gccas) even if they only use one of the parts
 199 #  of it.  For this reason, sometimes it's useful to use libraries as .a files.
 200
 201 ifdef LIBRARYNAME
 202
 203 LIBNAME_O    := $(LIBRELEASE)/lib$(LIBRARYNAME).so
 204 LIBNAME_G    := $(LIBDEBUG)/lib$(LIBRARYNAME).so
 205 LIBNAME_AO   := $(LIBRELEASE)/lib$(LIBRARYNAME).a
 206 LIBNAME_AG   := $(LIBDEBUG)/lib$(LIBRARYNAME).a
 207 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
 208 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
 209
 210
 211 ifndef ENABLE_OPTIMIZED
 212 BUILD_LIBNAME_G := $(LIBNAME_G)
 213 ifndef DONT_BUILD_RELINKED
 214 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
 215 endif
 216 ifdef BUILD_ARCHIVE
 217 BUILD_LIBNAME_AG := $(LIBNAME_AG)
 218 endif
 219 endif
 220
 221 # If optimized builds are enabled...
 222 ifdef ENABLE_OPTIMIZED
 223 BUILD_LIBNAME_O  := $(LIBNAME_O)
 224 ifndef DONT_BUILD_RELINKED
 225 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
 226 endif
 227 ifdef BUILD_ARCHIVE
 228 BUILD_LIBNAME_AO := $(LIBNAME_AO)
 229 endif
 230 endif
 231
 232 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG)      # Debug
 233 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO)      # Release
 234 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O)      # .so files
 235
 236 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 237         @echo ======= Linking $(LIBRARYNAME) release library =======
 238         $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
 239
 240 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 241         @echo ======= Linking $(LIBRARYNAME) debug library =======
 242         $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
 243
 244 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 245         @echo ======= Linking $(LIBRARYNAME) release library =======
 246         @rm -f $@
 247         $(AR) $@ $(ObjectsO) $(LibSubDirs)
 248
 249 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 250         @echo ======= Linking $(LIBRARYNAME) debug library =======
 251         @rm -f $@
 252         $(AR) $@ $(ObjectsG) $(LibSubDirs)
 253
 254 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 255         $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
 256
 257 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 258         $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
 259
 260 endif
 261
 262 #------------------------------------------------------------------------
 263 # Create a TAGS database for emacs
 264 #------------------------------------------------------------------------
 265
 266 ifeq ($(LEVEL), .)
 267 tags:
 268         etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
 269 all:: tags
 270 endif
 271
 272 #------------------------------------------------------------------------
 273 # Handle the TOOLNAME option - used when building tool executables...
 274 #------------------------------------------------------------------------
 275 #
 276 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
 277 # libraries (and the order of the libs) that should be linked to the
 278 # tool. USEDLIBS should contain a list of library names (some with .a extension)
 279 # that are automatically linked in as .o files unless the .a suffix is added.
 280 #
 281 ifdef TOOLNAME
 282
 283 # TOOLEXENAME* - These compute the output filenames to generate...
 284 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
 285 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
 286 TOOLEXENAMES  := $(TOOLEXENAME_G)
 287 ifdef ENABLE_OPTIMIZED
 288 TOOLEXENAMES += $(TOOLEXENAME_O)
 289 endif
 290
 291 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
 292 USED_LIBS_OPTIONS   := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
 293 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o,  $(USED_LIBS_OPTIONS))
 294 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
 295
 296
 297 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
 298 # rebuilt if libraries change.  This has to make sure to handle .a/.so and .o
 299 # files seperately.
 300 #
 301 STATICUSEDLIBS   := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
 302 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
 303 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
 304
 305 all::   $(TOOLEXENAMES)
 306 clean::
 307         rm -f $(TOOLEXENAMES)
 308
 309 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
 310         $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
 311
 312 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
 313         $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
 314
 315 endif
 316
 317
 318
 319 #---------------------------------------------------------
 320 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
 321 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
 322
 323 # Create dependencies for the *.cpp files...
 324 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
 325         $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
 326
 327 # Create dependencies for the *.c files...
 328 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
 329         $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
 330
 331 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
 332 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
 333         $(CompileO) $< -o $@
 334
 335 #Release/%.o: %.c Release/.dir Depend/.dir
 336 #       $(CompileOC) $< -o $@
 337
 338 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
 339         $(CompileG) $< -o $@
 340
 341 #Debug/%.o: %.c Debug/.dir
 342 #       $(CompileGC) $< -o $@
 343
 344 # Create a .cpp source file from a flex input file... this uses sed to cut down
 345 # on the warnings emited by GCC...
 346 %.cpp: %.l
 347         flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
 348
 349 # Rule for building the bison parsers...
 350
 351 %.cpp %.h : %.y
 352         bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
 353         mv -f $(basename $@).tab.c $(basename $@).cpp
 354         mv -f $(basename $@).tab.h $(basename $@).h
 355
 356 # To create the directories...
 357 %/.dir:
 358         mkdir -p $(@D)
 359         @date > $@
 360
 361 # Clean nukes the tree
 362 clean::
 363         rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Depend
 364         rm -f core *.o *.d *.so *~ *.flc
 365
 366 # If dependancies were generated for the file that included this file,
 367 # include the dependancies now...
 368 #
 369 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
 370 ifneq ($(SourceDepend),)
 371 include $(SourceDepend)
 372 endif