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