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 TOOLDEBUG   := $(BUILD_ROOT_TOP)/tools/Debug
 111 TOOLRELEASE := $(BUILD_ROOT_TOP)/tools/Release
 112
 113 # Verbosity levels
 114 ifdef VERBOSE
 115 VERB :=
 116 else
 117 VERB := @
 118 endif
 119
 120 #---------------------------------------------------------
 121 # Compilation options...
 122 #---------------------------------------------------------
 123
 124 # Special tools used while building
 125 RunBurg  := $(BURG) $(BURG_OPTS)
 126
 127 # Enable this for profiling support with 'gprof'
 128 ifdef ENABLE_PROFILING
 129 PROFILE = -pg
 130 else
 131 PROFILE =
 132 endif
 133
 134 # By default, strip symbol information from executable
 135 ifdef KEEP_SYMBOLS
 136 STRIP =
 137 else
 138 STRIP = -s
 139 endif
 140
 141 # Allow gnu extensions...
 142 CPPFLAGS += -D_GNU_SOURCE
 143
 144 # -Wno-unused-parameter
 145 CompileCommonOpts := $(PROFILE) -Wall -W  -Wwrite-strings -Wno-unused -I$(LEVEL)/include
 146
 147 # Compile a file, don't link...
 148 Compile  := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
 149 CompileG := $(Compile) -g  -D_DEBUG
 150 CompileO := $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fnonnull-objects -freg-struct-return -fshort-enums
 151
 152 # Link final executable
 153
 154 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
 155 Link     := $(PURIFY) $(CXX) $(PROFILE) -static
 156 else
 157 Link     := $(CXX) $(PROFILE)
 158 endif
 159 LinkG    := $(Link) -g  -L $(LIBDEBUG) $(STRIP)
 160 LinkO    := $(Link) -O3 -L $(LIBRELEASE)
 161
 162 # Create one .o file from a bunch of .o files...
 163 Relink = ld -r
 164
 165 # MakeSO - Create a .so file from a .o files...
 166 MakeSO   := $(CXX) $(MakeSharedObjectOption) $(PROFILE)
 167 MakeSOO  := $(MakeSO) -O3
 168
 169 # Create dependancy file from CPP file, send to stdout.
 170 Depend   := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
 171
 172 # Archive a bunch of .o files into a .a file...
 173 AR       = ar cq
 174
 175 #----------------------------------------------------------
 176
 177 # Source includes all of the cpp files, and objects are derived from the
 178 # source files...
 179 # The local Makefile can list other Source files via ExtraSource = ...
 180 #
 181 Source  := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
 182
 183 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
 184 ObjectsO = $(addprefix $(BUILD_ROOT)/Release/,$(Objs)))
 185 ObjectsG = $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
 186
 187
 188 #---------------------------------------------------------
 189 # Handle the DIRS and PARALLEL_DIRS options
 190 #---------------------------------------------------------
 191
 192 ifdef DIRS
 193 all install clean ::
 194         $(VERB) for dir in ${DIRS}; do \
 195                 (cd $$dir; $(MAKE) $@) || exit 1; \
 196         done
 197 endif
 198
 199 # Handle PARALLEL_DIRS
 200 ifdef PARALLEL_DIRS
 201 all     :: $(addsuffix /.makeall    , $(PARALLEL_DIRS))
 202 install :: $(addsuffix /.makeinstall, $(PARALLEL_DIRS))
 203 clean   :: $(addsuffix /.makeclean  , $(PARALLEL_DIRS))
 204
 205 %/.makeall %/.makeinstall %/.makeclean:
 206         $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
 207
 208 endif
 209
 210 #---------------------------------------------------------
 211 # Handle the LIBRARYNAME option - used when building libs...
 212 #---------------------------------------------------------
 213 #
 214 #  When libraries are built, they are allowed to optionally define the
 215 #  DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
 216 #  from being built for the library. This .o files may then be linked to by a
 217 #  tool if the tool does not need (or want) the semantics a .a file provides
 218 #  (linking in only object files that are "needed").  If a library is never to
 219 #  be used in this way, it is better to define DONT_BUILD_RELINKED, and define
 220 #  BUILD_ARCHIVE instead.
 221 #
 222 #  Some libraries must be built as .a files (libscalar for example) because if
 223 #  it's built as a .o file, then all of the constituent .o files in it will be
 224 #  linked into tools (for example gccas) even if they only use one of the parts
 225 #  of it.  For this reason, sometimes it's useful to use libraries as .a files.
 226
 227 ifdef LIBRARYNAME
 228
 229 # Make sure there isn't any extranous whitespace on the LIBRARYNAME option
 230 LIBRARYNAME := $(strip $(LIBRARYNAME))
 231
 232 LIBNAME_O    := $(LIBRELEASE)/lib$(LIBRARYNAME).so
 233 LIBNAME_G    := $(LIBDEBUG)/lib$(LIBRARYNAME).so
 234 LIBNAME_AO   := $(LIBRELEASE)/lib$(LIBRARYNAME).a
 235 LIBNAME_AG   := $(LIBDEBUG)/lib$(LIBRARYNAME).a
 236 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
 237 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
 238
 239
 240 ifndef ENABLE_OPTIMIZED
 241 BUILD_LIBNAME_G := $(LIBNAME_G)
 242 ifndef DONT_BUILD_RELINKED
 243 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
 244 endif
 245 ifdef BUILD_ARCHIVE
 246 BUILD_LIBNAME_AG := $(LIBNAME_AG)
 247 endif
 248 endif
 249
 250 # If optimized builds are enabled...
 251 ifdef ENABLE_OPTIMIZED
 252 BUILD_LIBNAME_O  := $(LIBNAME_O)
 253 ifndef DONT_BUILD_RELINKED
 254 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
 255 endif
 256 ifdef BUILD_ARCHIVE
 257 BUILD_LIBNAME_AO := $(LIBNAME_AO)
 258 endif
 259 endif
 260
 261 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG)      # Debug
 262 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO)      # Release
 263 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O)      # .so files
 264
 265 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 266         @echo ======= Linking $(LIBRARYNAME) release library =======
 267         $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
 268
 269 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 270         @echo ======= Linking $(LIBRARYNAME) debug library =======
 271         $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
 272
 273 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 274         @echo ======= Linking $(LIBRARYNAME) release library =======
 275         @rm -f $@
 276         $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
 277
 278 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 279         @echo ======= Linking $(LIBRARYNAME) debug library =======
 280         @rm -f $@
 281         $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
 282
 283 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
 284         @echo "Linking $@"
 285         $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
 286
 287 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
 288         $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
 289
 290 endif
 291
 292 #------------------------------------------------------------------------
 293 # Create a TAGS database for emacs
 294 #------------------------------------------------------------------------
 295
 296 ifeq ($(LEVEL), .)
 297 tags:
 298         etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
 299 all:: tags
 300 endif
 301
 302 #------------------------------------------------------------------------
 303 # Handle the TOOLNAME option - used when building tool executables...
 304 #------------------------------------------------------------------------
 305 #
 306 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
 307 # libraries (and the order of the libs) that should be linked to the
 308 # tool. USEDLIBS should contain a list of library names (some with .a extension)
 309 # that are automatically linked in as .o files unless the .a suffix is added.
 310 #
 311 ifdef TOOLNAME
 312
 313 # TOOLEXENAME* - These compute the output filenames to generate...
 314 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
 315 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
 316 TOOLEXENAMES  := $(TOOLEXENAME_G)
 317 ifdef ENABLE_OPTIMIZED
 318 TOOLEXENAMES += $(TOOLEXENAME_O)
 319 endif
 320
 321 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
 322 USED_LIBS_OPTIONS   := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
 323 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o,  $(USED_LIBS_OPTIONS))
 324 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
 325
 326
 327 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
 328 # rebuilt if libraries change.  This has to make sure to handle .a/.so and .o
 329 # files seperately.
 330 #
 331 STATICUSEDLIBS   := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
 332 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
 333 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
 334
 335 all::   $(TOOLEXENAMES)
 336 clean::
 337         $(VERB) rm -f $(TOOLEXENAMES)
 338
 339 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
 340         @echo ======= Linking $(TOOLNAME) debug executable =======
 341         $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
 342
 343 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
 344         @echo ======= Linking $(TOOLNAME) release executable =======
 345         $(VERB) $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
 346
 347 endif
 348
 349
 350
 351 #---------------------------------------------------------
 352 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
 353 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
 354
 355 # Create dependencies for the *.cpp files...
 356 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
 357         $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
 358
 359 # Create dependencies for the *.c files...
 360 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
 361         $(VERB) $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
 362
 363 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
 364 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
 365         @echo "Compiling $<"
 366         $(VERB) $(CompileO) $< -o $@
 367
 368 #Release/%.o: %.c Release/.dir Depend/.dir
 369 #       $(CompileOC) $< -o $@
 370
 371 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
 372         @echo "Compiling $<"
 373         $(VERB) $(CompileG) $< -o $@
 374
 375 #Debug/%.o: %.c Debug/.dir
 376 #       $(CompileGC) $< -o $@
 377
 378 # Create a .cpp source file from a flex input file... this uses sed to cut down
 379 # on the warnings emited by GCC...
 380 %.cpp: %.l
 381         flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
 382
 383 # Rule for building the bison parsers...
 384
 385 %.cpp %.h : %.y
 386         $(VERB) bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
 387         $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
 388         $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
 389
 390 # To create the directories...
 391 %/.dir:
 392         $(VERB) mkdir -p $(@D)
 393         @date > $@
 394
 395 # Clean nukes the tree
 396 clean::
 397         $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Depend
 398         $(VERB) rm -f core *.o *.d *.so *~ *.flc
 399
 400 # If dependancies were generated for the file that included this file,
 401 # include the dependancies now...
 402 #
 403 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
 404 ifneq ($(SourceDepend),)
 405 include $(SourceDepend)
 406 endif