Makefile.rules

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