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 can be set by setting incoming variables.
   9 # The variable $(LEVEL) *must* be set:
  10 #
  11 # 1. LEVEL - The level of the current subdirectory from the top of the
  12 #    MagicStats view.  This level should be expressed as a path, for
  13 #    example, ../.. for two levels deep.
  14 #
  15 # 2. DIRS - A list of subdirectories to be built.  Fake targets are set up
  16 #    so that each of the targets "all", "install", and "clean" each build
  17 #    the subdirectories before the local target.  DIRS are guaranteed to be
  18 #    built in order.
  19 #
  20 # 3. PARALLEL_DIRS - A list of subdirectories to be built, but that may be
  21 #    built in any order.  All DIRS are built in order before PARALLEL_DIRS are
  22 #    built, which are then built in any order.
  23 #
  24 # 4. Source - If specified, this sets the source code filenames.  If this
  25 #    is not set, it defaults to be all of the .cpp, .c, .y, and .l files
  26 #    in the current directory.  Also, if you want to build files in addition
  27 #    to the local files, you can use the ExtraSource variable
  28 #
  29 #===-----------------------------------------------------------------------====
  30
  31 # Configuration file to set paths specific to local installation of LLVM
  32 #
  33 include $(LEVEL)/Makefile.config
  34
  35 # These are options that can either be enabled here, or can be enabled on the
  36 # make command line (ie, make ENABLE_PROFILING=1)
  37 #
  38
  39 # When ENABLE_PROFILING is enabled, the llvm source base is built with profile
  40 # information to allow gprof to be used to get execution frequencies.
  41 #
  42 #ENABLE_PROFILING = 1
  43
  44 # When ENABLE_PURIFY is enabled, the LLVM tools are linked with purify (which
  45 # must be locally installed) to allow for some automated memory error debugging.
  46 #
  47 #ENABLE_PURIFY    = 1
  48
  49 # When ENABLE_OPTIMIZED is enabled, Release builds of all of the LLVM code are
  50 # turned on, and Debug builds are turned off.
  51 #
  52 #ENABLE_OPTIMIZED = 1
  53
  54
  55 # Figure out how to do platform specific stuff on this platform.  This is really
  56 # gross and should be autoconfiscated (automake actually), but should hopefully
  57 # work on Linux and solaris (SunOS).
  58 #
  59 UNAME := $(shell uname)
  60 include $(LEVEL)/Makefile.$(UNAME)
  61
  62 ifdef SHARED_LIBRARY
  63 # if SHARED_LIBRARY is specified, the default is to build the dynamic lib
  64 dynamic ::
  65 endif
  66
  67 # Default Rule:  Make sure it's also a :: rule
  68 all ::
  69
  70 # Default for install is to at least build everything...
  71 install ::
  72
  73
  74 # Figure out which directory to build stuff into.  We want to build into the
  75 # /shared directory by default because it is guaranteed to be local to the
  76 # current machine.
  77 #
  78 ifeq ($(LLVM_OBJ_DIR),.)
  79 BUILD_ROOT     = $(LLVM_OBJ_DIR)
  80 BUILD_ROOT_TOP = $(LEVEL)
  81 else
  82
  83 BUILD_ROOT := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(shell pwd))
  84
  85 # Calculate the BUILD_ROOT_TOP variable, which is the top of the llvm/ tree.
  86 # Note that although this is just equal to $(BUILD_ROOT)/$(LEVEL), we cannot use
  87 # this expression because some of the directories on the source tree may not
  88 # exist in the build tree (for example the test/ heirarchy).  Thus we evaluate
  89 # the directory to eliminate the ../'s
  90 #
  91 TOP_DIRECTORY := $(shell cd $(LEVEL); pwd)
  92 BUILD_ROOT_TOP := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
  93 endif
  94
  95 #--------------------------------------------------------------------
  96 # Variables derived from configuration options...
  97 #--------------------------------------------------------------------
  98
  99 #BinInstDir=/usr/local/bin
 100 #LibInstDir=/usrl/local/lib/xxx
 101 #DocInstDir=/usr/doc/xxx
 102
 103 BURG_OPTS = -I
 104
 105 PURIFY := $(PURIFY) -cache-dir="$(BUILD_ROOT_TOP)/../purifycache" -chain-length="30" -messages=all
 106
 107 # Shorthand for commonly accessed directories
 108 LIBDEBUG    := $(BUILD_ROOT_TOP)/lib/Debug
 109 LIBRELEASE  := $(BUILD_ROOT_TOP)/lib/Release
 110 LIBPROFILE  := $(BUILD_ROOT_TOP)/lib/Profile
 111 TOOLDEBUG   := $(BUILD_ROOT_TOP)/tools/Debug
 112 TOOLRELEASE := $(BUILD_ROOT_TOP)/tools/Release
 113 TOOLPROFILE := $(BUILD_ROOT_TOP)/tools/Profile
 114
 115 # Verbosity levels
 116 ifdef VERBOSE
 117 VERB :=
 118 else
 119 VERB := @
 120 endif
 121
 122 #---------------------------------------------------------
 123 # Compilation options...
 124 #---------------------------------------------------------
 125
 126 # Special tools used while building the LLVM tree.  Burg is built as part of the
 127 # utils directory.
 128 #
 129 BURG    := $(LEVEL)/utils/Burg/burg
 130 RunBurg := $(BURG) $(BURG_OPTS)
 131
 132
 133 # Enable this for profiling support with 'gprof'
 134 # This automatically enables optimized builds.
 135 ifdef ENABLE_PROFILING
 136   PROFILE = -pg
 137   ENABLE_OPTIMIZED = 1
 138 else
 139   PROFILE =
 140 endif
 141
 142 # By default, strip symbol information from executable
 143 ifdef KEEP_SYMBOLS
 144 STRIP =
 145 else
 146 STRIP = -s
 147 endif
 148
 149 # Allow gnu extensions...
 150 CPPFLAGS += -D_GNU_SOURCE
 151
 152 # -Wno-unused-parameter
 153 CompileCommonOpts := -Wall -W  -Wwrite-strings -Wno-unused -I$(LEVEL)/include
 154
 155 # Compile a file, don't link...
 156 Compile  := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
 157 CompileG := $(Compile) -g  -D_DEBUG
 158 CompileO := $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fshort-enums ## DISABLE -freg-struct-return because of gcc3.2 bug
 159 CompileP := $(CompileO) $(PROFILE)
 160
 161 # Link final executable
 162
 163 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
 164 Link     := $(PURIFY) $(CXX) -static
 165 else
 166 Link     := $(CXX)
 167 endif
 168 LinkG    := $(Link) -g  -L $(LIBDEBUG) $(STRIP)
 169 LinkO    := $(Link) -O3 -L $(LIBRELEASE)
 170 LinkP    := $(LinkO) $(PROFILE)
 171
 172 # Create one .o file from a bunch of .o files...
 173 Relink = ld -r
 174
 175 # MakeSO - Create a .so file from a .o files...
 176 MakeSO   := $(CXX) $(MakeSharedObjectOption)
 177 MakeSOO  := $(MakeSO) -O3
 178 MakeSOP  := $(MakeSOO) $(PROFILE)
 179
 180 # Create dependancy file from CPP file, send to stdout.
 181 Depend   := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
 182
 183 # Archive a bunch of .o files into a .a file...
 184 AR       = ar cq
 185
 186 #----------------------------------------------------------
 187
 188 # Source includes all of the cpp files, and objects are derived from the
 189 # source files...
 190 # The local Makefile can list other Source files via ExtraSource = ...
 191 #
 192 Source  := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
 193
 194 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
 195 ObjectsO := $(addprefix $(BUILD_ROOT)/Release/,$(Objs))
 196 ObjectsP := $(addprefix $(BUILD_ROOT)/Profile/,$(Objs))
 197 ObjectsG := $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
 198
 199
 200 #---------------------------------------------------------
 201 # Handle the DIRS and PARALLEL_DIRS options
 202 #---------------------------------------------------------
 203
 204 ifdef DIRS
 205 all install clean ::
 206         $(VERB) for dir in ${DIRS}; do \
 207                 (cd $$dir; $(MAKE) $@) || exit 1; \
 208         done
 209 endif
 210
 211 # Handle PARALLEL_DIRS
 212 ifdef PARALLEL_DIRS
 213 all     :: $(addsuffix /.makeall    , $(PARALLEL_DIRS))
 214 install :: $(addsuffix /.makeinstall, $(PARALLEL_DIRS))
 215 clean   :: $(addsuffix /.makeclean  , $(PARALLEL_DIRS))
 216
 217 %/.makeall %/.makeinstall %/.makeclean:
 218         $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
 219
 220 endif
 221
 222 #---------------------------------------------------------
 223 # Handle the LIBRARYNAME option - used when building libs...
 224 #---------------------------------------------------------
 225 #
 226 #  When libraries are built, they are allowed to optionally define the
 227 #  DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
 228 #  from being built for the library. This .o files may then be linked to by a
 229 #  tool if the tool does not need (or want) the semantics a .a file provides
 230 #  (linking in only object files that are "needed").  If a library is never to
 231 #  be used in this way, it is better to define DONT_BUILD_RELINKED, and define
 232 #  BUILD_ARCHIVE instead.
 233 #
 234 #  Some libraries must be built as .a files (libscalar for example) because if
 235 #  it's built as a .o file, then all of the constituent .o files in it will be
 236 #  linked into tools (for example gccas) even if they only use one of the parts
 237 #  of it.  For this reason, sometimes it's useful to use libraries as .a files.
 238
 239 ifdef LIBRARYNAME
 240
 241 # Make sure there isn't any extranous whitespace on the LIBRARYNAME option
 242 LIBRARYNAME := $(strip $(LIBRARYNAME))
 243
 244 LIBNAME_O    := $(LIBRELEASE)/lib$(LIBRARYNAME).so
 245 LIBNAME_P    := $(LIBPROFILE)/lib$(LIBRARYNAME).so
 246 LIBNAME_G    := $(LIBDEBUG)/lib$(LIBRARYNAME).so
 247 LIBNAME_AO   := $(LIBRELEASE)/lib$(LIBRARYNAME).a
 248 LIBNAME_AP   := $(LIBPROFILE)/lib$(LIBRARYNAME).a
 249 LIBNAME_AG   := $(LIBDEBUG)/lib$(LIBRARYNAME).a
 250 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
 251 LIBNAME_OBJP := $(LIBPROFILE)/$(LIBRARYNAME).o
 252 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
 253
 254
 255 ifndef ENABLE_OPTIMIZED
 256 BUILD_LIBNAME_G := $(LIBNAME_G)
 257 ifndef DONT_BUILD_RELINKED
 258 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
 259 endif
 260 ifdef BUILD_ARCHIVE
 261 BUILD_LIBNAME_AG := $(LIBNAME_AG)
 262 endif
 263 endif
 264
 265 # If optimized builds are enabled...
 266 ifdef ENABLE_OPTIMIZED
 267   ifdef ENABLE_PROFILING
 268     BUILD_LIBNAME_O  := $(LIBNAME_P)
 269     ifndef DONT_BUILD_RELINKED
 270       BUILD_LIBNAME_OBJO := $(LIBNAME_OBJP)
 271     endif
 272     ifdef BUILD_ARCHIVE
 273       BUILD_LIBNAME_AO := $(LIBNAME_AP)
 274     endif
 275   else
 276     BUILD_LIBNAME_O  := $(LIBNAME_O)
 277     ifndef DONT_BUILD_RELINKED
 278       BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
 279     endif
 280     ifdef BUILD_ARCHIVE
 281       BUILD_LIBNAME_AO := $(LIBNAME_AO)
 282     endif
 283   endif
 284 endif
 285
 286 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG)      # Debug
 287 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO)      # Release
 288 all:: $(BUILD_LIBNAME_AP) $(BUILD_LIBNAME_OBJP)      # Profile
 289 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O) $(BUILD_LIBNAME_P) # .so files
 290
 291 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 292         @echo ======= Linking $(LIBRARYNAME) release library =======
 293         $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
 294
 295 $(LIBNAME_P): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
 296         @echo ======= Linking $(LIBRARYNAME) profile library =======
 297         $(VERB) $(MakeSOP) -o $@ $(ObjectsP) $(LibSubDirs) $(LibLinkOpts)
 298
 299 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 300         @echo ======= Linking $(LIBRARYNAME) debug library =======
 301         $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
 302
 303 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 304         @echo ======= Linking $(LIBRARYNAME) release library =======
 305         @rm -f $@
 306         $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
 307
 308 $(LIBNAME_AP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
 309         @echo ======= Linking $(LIBRARYNAME) profile library =======
 310         @rm -f $@
 311         $(VERB) $(AR) $@ $(ObjectsP) $(LibSubDirs)
 312
 313 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 314         @echo ======= Linking $(LIBRARYNAME) debug library =======
 315         @rm -f $@
 316         $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
 317
 318 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 319         @echo "Linking $@"
 320         $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
 321
 322 $(LIBNAME_OBJP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
 323         @echo "Linking $@"
 324         $(VERB) $(Relink) -o $@ $(ObjectsP) $(LibSubDirs)
 325
 326 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 327         $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
 328
 329 endif
 330
 331 #------------------------------------------------------------------------
 332 # Create a TAGS database for emacs
 333 #------------------------------------------------------------------------
 334
 335 ifeq ($(LEVEL), .)
 336 tags:
 337         etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
 338 all:: tags
 339 endif
 340
 341 #------------------------------------------------------------------------
 342 # Handle the TOOLNAME option - used when building tool executables...
 343 #------------------------------------------------------------------------
 344 #
 345 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
 346 # libraries (and the order of the libs) that should be linked to the
 347 # tool. USEDLIBS should contain a list of library names (some with .a extension)
 348 # that are automatically linked in as .o files unless the .a suffix is added.
 349 #
 350 ifdef TOOLNAME
 351
 352 # TOOLEXENAME* - These compute the output filenames to generate...
 353 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
 354 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
 355 TOOLEXENAME_P := $(BUILD_ROOT_TOP)/tools/Profile/$(TOOLNAME)
 356
 357 ifndef ENABLE_OPTIMIZED
 358   TOOLEXENAMES  := $(TOOLEXENAME_G)
 359 else
 360   ifdef ENABLE_PROFILING
 361     TOOLEXENAMES := $(TOOLEXENAME_O)
 362   else
 363     TOOLEXENAMES := $(TOOLEXENAME_P)
 364   endif
 365 endif
 366
 367 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
 368 USED_LIBS_OPTIONS   := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
 369 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o,  $(USED_LIBS_OPTIONS))
 370 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
 371 USED_LIBS_OPTIONS_P := $(patsubst %.o, $(LIBPROFILE)/%.o,$(USED_LIBS_OPTIONS))
 372
 373
 374 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
 375 # rebuilt if libraries change.  This has to make sure to handle .a/.so and .o
 376 # files seperately.
 377 #
 378 STATICUSEDLIBS   := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
 379 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
 380 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
 381 USED_LIB_PATHS_P := $(addprefix $(LIBPROFILE)/, $(STATICUSEDLIBS))
 382
 383 all::   $(TOOLEXENAMES)
 384 clean::
 385         $(VERB) rm -f $(TOOLEXENAMES)
 386
 387 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
 388         @echo ======= Linking $(TOOLNAME) debug executable =======
 389         $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
 390
 391 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
 392         @echo ======= Linking $(TOOLNAME) release executable =======
 393         $(VERB) $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
 394
 395 $(TOOLEXENAME_P): $(ObjectsP) $(USED_LIB_PATHS_P) $(BUILD_ROOT_TOP)/tools/Profile/.dir
 396         @echo ======= Linking $(TOOLNAME) profile executable =======
 397         $(VERB) $(LinkP) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_P) $(TOOLLINKOPTS)
 398
 399 endif
 400
 401
 402
 403 #---------------------------------------------------------
 404 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
 405 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
 406
 407 # Create dependencies for the *.cpp files...
 408 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
 409         $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Profile/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
 410
 411 # Create dependencies for the *.c files...
 412 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
 413         $(VERB) $(Depend) $< | sed 's|$*\.o *|Release/& Profile/& Debug/& Depend/$(@F)|g' > $@
 414
 415 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
 416 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
 417         @echo "Compiling $<"
 418         $(VERB) $(CompileO) $< -o $@
 419
 420 #Release/%.o: %.c Release/.dir Depend/.dir
 421 #       $(CompileOC) $< -o $@
 422
 423 $(BUILD_ROOT)/Profile/%.o: %.cpp $(BUILD_ROOT)/Profile/.dir
 424         @echo "Compiling $<"
 425         $(VERB) $(CompileP) $< -o $@
 426
 427 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
 428         @echo "Compiling $<"
 429         $(VERB) $(CompileG) $< -o $@
 430
 431 #Debug/%.o: %.c Debug/.dir
 432 #       $(CompileGC) $< -o $@
 433
 434 # Create a .cpp source file from a flex input file... this uses sed to cut down
 435 # on the warnings emited by GCC...
 436 %.cpp: %.l
 437         flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
 438
 439 # Rule for building the bison parsers...
 440
 441 %.cpp %.h : %.y
 442         $(VERB) bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
 443         $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
 444         $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
 445
 446 # To create the directories...
 447 %/.dir:
 448         $(VERB) mkdir -p $(@D)
 449         @date > $@
 450
 451 # Clean nukes the tree
 452 clean::
 453         $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Profile $(BUILD_ROOT)/Depend
 454         $(VERB) rm -f core *.o *.d *.so *~ *.flc
 455
 456 # If dependancies were generated for the file that included this file,
 457 # include the dependancies now...
 458 #
 459 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
 460 ifneq ($(SourceDepend),)
 461 include $(SourceDepend)
 462 endif