1 #===-- Makefile.common - Common make rules for LLVM -------*- makefile -*--====
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.
8 # The following functionality can be set by setting incoming variables.
9 # The variable $(LEVEL) *must* be set:
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.
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
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.
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
29 #===-----------------------------------------------------------------------====
31 # Configuration file to set paths specific to local installation of LLVM
33 include $(LEVEL)/Makefile.config
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)
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.
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.
49 # When ENABLE_OPTIMIZED is enabled, Release builds of all of the LLVM code are
50 # turned on, and Debug builds are turned off.
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).
59 UNAME := $(shell uname)
60 include $(LEVEL)/Makefile.$(UNAME)
63 # if SHARED_LIBRARY is specified, the default is to build the dynamic lib
67 # Default Rule: Make sure it's also a :: rule
70 # Default for install is to at least build everything...
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
78 ifeq ($(LLVM_OBJ_DIR),.)
79 BUILD_ROOT = $(LLVM_OBJ_DIR)
80 BUILD_ROOT_TOP = $(LEVEL)
83 BUILD_ROOT := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(shell pwd))
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
91 TOP_DIRECTORY := $(shell cd $(LEVEL); pwd)
92 BUILD_ROOT_TOP := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
95 #--------------------------------------------------------------------
96 # Variables derived from configuration options...
97 #--------------------------------------------------------------------
99 #BinInstDir=/usr/local/bin
100 #LibInstDir=/usrl/local/lib/xxx
101 #DocInstDir=/usr/doc/xxx
105 PURIFY := $(PURIFY) -cache-dir="$(BUILD_ROOT_TOP)/../purifycache" -chain-length="30" -messages=all
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
122 #---------------------------------------------------------
123 # Compilation options...
124 #---------------------------------------------------------
126 # Special tools used while building the LLVM tree. Burg is built as part of the
129 BURG := $(TOOLDEBUG)/burg
130 RunBurg := $(BURG) $(BURG_OPTS)
133 # Enable this for profiling support with 'gprof'
134 # This automatically enables optimized builds.
135 ifdef ENABLE_PROFILING
142 # By default, strip symbol information from executable
147 STRIP = $(PLATFORMSTRIPOPTS)
148 STRIP_WARN_MSG = "(without symbols) "
151 # Allow gnu extensions...
152 CPPFLAGS += -D_GNU_SOURCE
154 # -Wno-unused-parameter
155 CompileCommonOpts := -Wall -W -Wwrite-strings -Wno-unused -I$(LEVEL)/include
156 CompileOptimizeOpts := -O3 -DNDEBUG -finline-functions -fshort-enums
158 # Compile a cpp file, don't link...
159 Compile := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
160 CompileG := $(Compile) -g -D_DEBUG
161 CompileO := $(Compile) $(CompileOptimizeOpts) -felide-constructors -fomit-frame-pointer
162 CompileP := $(Compile) $(CompileOptimizeOpts) -felide-constructors $(PROFILE)
164 # Compile a c file, don't link...
165 CompileC := $(CC) -c $(CPPFLAGS) $(CCFLAGS) $(CompileCommonOpts)
166 CompileCG := $(CompileC) -g -D_DEBUG
167 CompileCO := $(CompileC) $(CompileOptimizeOpts) -fomit-frame-pointer
168 CompileCP := $(CompileC) $(CompileOptimizeOpts) $(PROFILE)
171 # Link final executable
173 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
174 Link := $(PURIFY) $(CXX) -static
178 LinkG := $(Link) -g -L$(LIBDEBUG) $(STRIP)
179 LinkO := $(Link) -O3 -L$(LIBRELEASE)
180 LinkP := $(Link) -O3 -L$(LIBPROFILE) $(PROFILE)
182 # Create one .o file from a bunch of .o files...
185 # MakeSO - Create a .so file from a .o files...
186 MakeSO := $(CXX) $(MakeSharedObjectOption)
187 MakeSOO := $(MakeSO) -O3
188 MakeSOP := $(MakeSOO) $(PROFILE)
190 # Create dependancy file from CPP file, send to stdout.
191 Depend := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
192 DependC := $(CC) -MM -I$(LEVEL)/include $(CPPFLAGS)
194 # Archive a bunch of .o files into a .a file...
198 #----------------------------------------------------------
200 # Source includes all of the cpp files, and objects are derived from the
202 # The local Makefile can list other Source files via ExtraSource = ...
205 Source := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
208 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
209 ObjectsO := $(addprefix $(BUILD_ROOT)/Release/,$(Objs))
210 ObjectsP := $(addprefix $(BUILD_ROOT)/Profile/,$(Objs))
211 ObjectsG := $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
214 #---------------------------------------------------------
215 # Handle the DIRS and PARALLEL_DIRS options
216 #---------------------------------------------------------
219 all install clean test ::
220 $(VERB) for dir in ${DIRS}; do \
221 (cd $$dir; $(MAKE) $@) || exit 1; \
225 # Handle PARALLEL_DIRS
227 all :: $(addsuffix /.makeall , $(PARALLEL_DIRS))
228 install :: $(addsuffix /.makeinstall, $(PARALLEL_DIRS))
229 clean :: $(addsuffix /.makeclean , $(PARALLEL_DIRS))
230 test :: $(addsuffix /.maketest , $(PARALLEL_DIRS))
232 %/.makeall %/.makeinstall %/.makeclean %/.maketest:
233 $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
236 #---------------------------------------------------------
237 # Handle the LIBRARYNAME option - used when building libs...
238 #---------------------------------------------------------
240 # When libraries are built, they are allowed to optionally define the
241 # DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
242 # from being built for the library. This .o files may then be linked to by a
243 # tool if the tool does not need (or want) the semantics a .a file provides
244 # (linking in only object files that are "needed"). If a library is never to
245 # be used in this way, it is better to define DONT_BUILD_RELINKED, and define
246 # BUILD_ARCHIVE instead.
248 # Some libraries must be built as .a files (libscalar for example) because if
249 # it's built as a .o file, then all of the constituent .o files in it will be
250 # linked into tools (for example gccas) even if they only use one of the parts
251 # of it. For this reason, sometimes it's useful to use libraries as .a files.
255 # Make sure there isn't any extranous whitespace on the LIBRARYNAME option
256 LIBRARYNAME := $(strip $(LIBRARYNAME))
258 LIBNAME_O := $(LIBRELEASE)/lib$(LIBRARYNAME).so
259 LIBNAME_P := $(LIBPROFILE)/lib$(LIBRARYNAME).so
260 LIBNAME_G := $(LIBDEBUG)/lib$(LIBRARYNAME).so
261 LIBNAME_AO := $(LIBRELEASE)/lib$(LIBRARYNAME).a
262 LIBNAME_AP := $(LIBPROFILE)/lib$(LIBRARYNAME).a
263 LIBNAME_AG := $(LIBDEBUG)/lib$(LIBRARYNAME).a
264 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
265 LIBNAME_OBJP := $(LIBPROFILE)/$(LIBRARYNAME).o
266 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
269 ifndef ENABLE_OPTIMIZED
270 BUILD_LIBNAME_G := $(LIBNAME_G)
271 ifndef DONT_BUILD_RELINKED
272 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
275 BUILD_LIBNAME_AG := $(LIBNAME_AG)
279 # If optimized builds are enabled...
280 ifdef ENABLE_OPTIMIZED
281 ifdef ENABLE_PROFILING
282 BUILD_LIBNAME_O := $(LIBNAME_P)
283 ifndef DONT_BUILD_RELINKED
284 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJP)
287 BUILD_LIBNAME_AO := $(LIBNAME_AP)
290 BUILD_LIBNAME_O := $(LIBNAME_O)
291 ifndef DONT_BUILD_RELINKED
292 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
295 BUILD_LIBNAME_AO := $(LIBNAME_AO)
300 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG) # Debug
301 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO) # Release
302 all:: $(BUILD_LIBNAME_AP) $(BUILD_LIBNAME_OBJP) # Profile
303 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O) $(BUILD_LIBNAME_P) # .so files
305 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
306 @echo ======= Linking $(LIBRARYNAME) release library =======
307 $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
309 $(LIBNAME_P): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
310 @echo ======= Linking $(LIBRARYNAME) profile library =======
311 $(VERB) $(MakeSOP) -o $@ $(ObjectsP) $(LibSubDirs) $(LibLinkOpts)
313 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
314 @echo ======= Linking $(LIBRARYNAME) debug library =======
315 $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
317 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
318 @echo ======= Linking $(LIBRARYNAME) release library =======
320 $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
322 $(LIBNAME_AP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
323 @echo ======= Linking $(LIBRARYNAME) profile library =======
325 $(VERB) $(AR) $@ $(ObjectsP) $(LibSubDirs)
327 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
328 @echo ======= Linking $(LIBRARYNAME) debug library =======
330 $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
332 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
334 $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
336 $(LIBNAME_OBJP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
338 $(VERB) $(Relink) -o $@ $(ObjectsP) $(LibSubDirs)
340 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
342 $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
346 #------------------------------------------------------------------------
347 # Create a TAGS database for emacs
348 #------------------------------------------------------------------------
352 etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
356 #------------------------------------------------------------------------
357 # Handle the TOOLNAME option - used when building tool executables...
358 #------------------------------------------------------------------------
360 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
361 # libraries (and the order of the libs) that should be linked to the
362 # tool. USEDLIBS should contain a list of library names (some with .a extension)
363 # that are automatically linked in as .o files unless the .a suffix is added.
367 # TOOLEXENAME* - These compute the output filenames to generate...
368 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
369 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
370 TOOLEXENAME_P := $(BUILD_ROOT_TOP)/tools/Profile/$(TOOLNAME)
372 ifndef ENABLE_OPTIMIZED
373 TOOLEXENAMES := $(TOOLEXENAME_G)
375 ifdef ENABLE_PROFILING
376 TOOLEXENAMES := $(TOOLEXENAME_P)
378 TOOLEXENAMES := $(TOOLEXENAME_O)
382 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
383 USED_LIBS_OPTIONS := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
384 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o, $(USED_LIBS_OPTIONS))
385 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
386 USED_LIBS_OPTIONS_P := $(patsubst %.o, $(LIBPROFILE)/%.o,$(USED_LIBS_OPTIONS))
389 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
390 # rebuilt if libraries change. This has to make sure to handle .a/.so and .o
393 STATICUSEDLIBS := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
394 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
395 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
396 USED_LIB_PATHS_P := $(addprefix $(LIBPROFILE)/, $(STATICUSEDLIBS))
397 LINK_OPTS := $(TOOLLINKOPTS) $(PLATFORMLINKOPTS)
400 # Tell make that we need to rebuild subdirectories before we can link the tool.
401 # This affects things like LLI which has library subdirectories.
402 $(USED_LIB_PATHS_G) $(USED_LIB_PATHS_O) $(USED_LIB_PATHS_P): \
403 $(addsuffix /.makeall, $(PARALLEL_DIRS))
405 all:: $(TOOLEXENAMES)
407 $(VERB) rm -f $(TOOLEXENAMES)
409 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(TOOLDEBUG)/.dir
410 @echo ======= Linking $(TOOLNAME) debug executable $(STRIP_WARN_MSG) =======
411 $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(LINK_OPTS)
413 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(TOOLRELEASE)/.dir
414 @echo ======= Linking $(TOOLNAME) release executable =======
415 $(VERB) $(LinkO) -o $@ $(ObjectsO) $(USED_LIBS_OPTIONS_O) $(LINK_OPTS)
417 $(TOOLEXENAME_P): $(ObjectsP) $(USED_LIB_PATHS_P) $(TOOLPROFILE)/.dir
418 @echo ======= Linking $(TOOLNAME) profile executable =======
419 $(VERB) $(LinkP) -o $@ $(ObjectsP) $(USED_LIBS_OPTIONS_P) $(LINK_OPTS)
425 #---------------------------------------------------------
426 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
427 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
429 # Create dependencies for the *.cpp files...
430 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
431 $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Profile/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
433 # Create dependencies for the *.c files...
434 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
435 $(VERB) $(DependC) $< | sed 's|$*\.o *|Release/& Profile/& Debug/& Depend/$(@F)|g' > $@
437 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
438 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
440 $(VERB) $(CompileO) $< -o $@
442 $(BUILD_ROOT)/Release/%.o: %.c $(BUILD_ROOT)/Release/.dir
443 $(VERB) $(CompileCO) $< -o $@
445 $(BUILD_ROOT)/Profile/%.o: %.cpp $(BUILD_ROOT)/Profile/.dir
447 $(VERB) $(CompileP) $< -o $@
449 $(BUILD_ROOT)/Profile/%.o: %.c $(BUILD_ROOT)/Profile/.dir
451 $(VERB) $(CompileCP) $< -o $@
453 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
455 $(VERB) $(CompileG) $< -o $@
457 $(BUILD_ROOT)/Debug/%.o: %.c $(BUILD_ROOT)/Debug/.dir
458 $(VERB) $(CompileCG) $< -o $@
461 # Rules for building lex/yacc files
463 LEX_FILES = $(filter %.l, $(Source))
464 LEX_OUTPUT = $(LEX_FILES:%.l=%.cpp)
465 YACC_FILES = $(filter %.y, $(Source))
466 YACC_OUTPUT = $(addprefix $(YACC_FILES:%.y=%), .h .cpp .output)
467 .PRECIOUS: $(LEX_OUTPUT) $(YACC_OUTPUT)
469 # Create a .cpp source file from a flex input file... this uses sed to cut down
470 # on the warnings emited by GCC...
472 # The last line is a gross hack to work around flex aparently not being able to
473 # resize the buffer on a large token input. Currently, for uninitialized string
474 # buffers in LLVM we can generate very long tokens, so this is a hack around it.
475 # FIXME. (f.e. char Buffer[10000]; )
478 flex -t $< | sed '/^find_rule/d' | \
479 sed 's/void yyunput/inline void yyunput/' | \
480 sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' | \
481 sed 's/#define YY_BUF_SIZE 16384/#define YY_BUF_SIZE (16384*64)/' > $@
483 # Rule for building the bison parsers...
486 $(VERB) $(BISON) -v -d -p $(<:%Parser.y=%) $*.y
487 $(VERB) mv -f $*.tab.c $*.cpp
488 $(VERB) mv -f $*.tab.h $*.h
490 # To create the directories...
495 # To create postscript files from dot files...
499 # 'make clean' nukes the tree
501 $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Profile $(BUILD_ROOT)/Depend
502 $(VERB) rm -f core core.[0-9][0-9]* *.o *.d *.so *~ *.flc
503 $(VERB) rm -f $(LEX_OUTPUT) $(YACC_OUTPUT)
505 # If dependancies were generated for the file that included this file,
506 # include the dependancies now...
508 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
509 ifneq ($(SourceDepend),)
510 -include $(SourceDepend)