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
149 # Allow gnu extensions...
150 CPPFLAGS += -D_GNU_SOURCE
152 # -Wno-unused-parameter
153 CompileCommonOpts := -Wall -W -Wwrite-strings -Wno-unused -I$(LEVEL)/include
155 # Compile a cpp 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)
161 # Compile a c file, don't link...
162 CompileC := $(CC) -c $(CPPFLAGS) $(CCFLAGS) $(CompileCommonOpts)
163 CompileCG := $(CompileC) -g -D_DEBUG
164 CompileCO := $(CompileC) -O3 -DNDEBUG -finline-functions -felide-constructors -fshort-enums ## DISABLE -freg-struct-return because of gcc3.2 bug
165 CompileCP := $(CompileCO) $(PROFILE)
168 # Link final executable
170 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
171 Link := $(PURIFY) $(CXX) -static
175 LinkG := $(Link) -g -L $(LIBDEBUG) $(STRIP)
176 LinkO := $(Link) -O3 -L $(LIBRELEASE)
177 LinkP := $(Link) -O3 -L $(LIBPROFILE) $(PROFILE)
179 # Create one .o file from a bunch of .o files...
182 # MakeSO - Create a .so file from a .o files...
183 MakeSO := $(CXX) $(MakeSharedObjectOption)
184 MakeSOO := $(MakeSO) -O3
185 MakeSOP := $(MakeSOO) $(PROFILE)
187 # Create dependancy file from CPP file, send to stdout.
188 Depend := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
189 DependC := $(CC) -MM -I$(LEVEL)/include $(CPPFLAGS)
191 # Archive a bunch of .o files into a .a file...
195 #----------------------------------------------------------
197 # Source includes all of the cpp files, and objects are derived from the
199 # The local Makefile can list other Source files via ExtraSource = ...
201 Source := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
203 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
204 ObjectsO := $(addprefix $(BUILD_ROOT)/Release/,$(Objs))
205 ObjectsP := $(addprefix $(BUILD_ROOT)/Profile/,$(Objs))
206 ObjectsG := $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
209 #---------------------------------------------------------
210 # Handle the DIRS and PARALLEL_DIRS options
211 #---------------------------------------------------------
215 $(VERB) for dir in ${DIRS}; do \
216 (cd $$dir; $(MAKE) $@) || exit 1; \
220 # Handle PARALLEL_DIRS
222 all :: $(addsuffix /.makeall , $(PARALLEL_DIRS))
223 install :: $(addsuffix /.makeinstall, $(PARALLEL_DIRS))
224 clean :: $(addsuffix /.makeclean , $(PARALLEL_DIRS))
226 %/.makeall %/.makeinstall %/.makeclean:
227 $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
231 #---------------------------------------------------------
232 # Handle the LIBRARYNAME option - used when building libs...
233 #---------------------------------------------------------
235 # When libraries are built, they are allowed to optionally define the
236 # DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
237 # from being built for the library. This .o files may then be linked to by a
238 # tool if the tool does not need (or want) the semantics a .a file provides
239 # (linking in only object files that are "needed"). If a library is never to
240 # be used in this way, it is better to define DONT_BUILD_RELINKED, and define
241 # BUILD_ARCHIVE instead.
243 # Some libraries must be built as .a files (libscalar for example) because if
244 # it's built as a .o file, then all of the constituent .o files in it will be
245 # linked into tools (for example gccas) even if they only use one of the parts
246 # of it. For this reason, sometimes it's useful to use libraries as .a files.
250 # Make sure there isn't any extranous whitespace on the LIBRARYNAME option
251 LIBRARYNAME := $(strip $(LIBRARYNAME))
253 LIBNAME_O := $(LIBRELEASE)/lib$(LIBRARYNAME).so
254 LIBNAME_P := $(LIBPROFILE)/lib$(LIBRARYNAME).so
255 LIBNAME_G := $(LIBDEBUG)/lib$(LIBRARYNAME).so
256 LIBNAME_AO := $(LIBRELEASE)/lib$(LIBRARYNAME).a
257 LIBNAME_AP := $(LIBPROFILE)/lib$(LIBRARYNAME).a
258 LIBNAME_AG := $(LIBDEBUG)/lib$(LIBRARYNAME).a
259 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
260 LIBNAME_OBJP := $(LIBPROFILE)/$(LIBRARYNAME).o
261 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
264 ifndef ENABLE_OPTIMIZED
265 BUILD_LIBNAME_G := $(LIBNAME_G)
266 ifndef DONT_BUILD_RELINKED
267 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
270 BUILD_LIBNAME_AG := $(LIBNAME_AG)
274 # If optimized builds are enabled...
275 ifdef ENABLE_OPTIMIZED
276 ifdef ENABLE_PROFILING
277 BUILD_LIBNAME_O := $(LIBNAME_P)
278 ifndef DONT_BUILD_RELINKED
279 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJP)
282 BUILD_LIBNAME_AO := $(LIBNAME_AP)
285 BUILD_LIBNAME_O := $(LIBNAME_O)
286 ifndef DONT_BUILD_RELINKED
287 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
290 BUILD_LIBNAME_AO := $(LIBNAME_AO)
295 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG) # Debug
296 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO) # Release
297 all:: $(BUILD_LIBNAME_AP) $(BUILD_LIBNAME_OBJP) # Profile
298 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O) $(BUILD_LIBNAME_P) # .so files
300 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
301 @echo ======= Linking $(LIBRARYNAME) release library =======
302 $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
304 $(LIBNAME_P): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
305 @echo ======= Linking $(LIBRARYNAME) profile library =======
306 $(VERB) $(MakeSOP) -o $@ $(ObjectsP) $(LibSubDirs) $(LibLinkOpts)
308 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
309 @echo ======= Linking $(LIBRARYNAME) debug library =======
310 $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
312 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
313 @echo ======= Linking $(LIBRARYNAME) release library =======
315 $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
317 $(LIBNAME_AP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
318 @echo ======= Linking $(LIBRARYNAME) profile library =======
320 $(VERB) $(AR) $@ $(ObjectsP) $(LibSubDirs)
322 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
323 @echo ======= Linking $(LIBRARYNAME) debug library =======
325 $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
327 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
329 $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
331 $(LIBNAME_OBJP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
333 $(VERB) $(Relink) -o $@ $(ObjectsP) $(LibSubDirs)
335 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
337 $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
341 #------------------------------------------------------------------------
342 # Create a TAGS database for emacs
343 #------------------------------------------------------------------------
347 etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
351 #------------------------------------------------------------------------
352 # Handle the TOOLNAME option - used when building tool executables...
353 #------------------------------------------------------------------------
355 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
356 # libraries (and the order of the libs) that should be linked to the
357 # tool. USEDLIBS should contain a list of library names (some with .a extension)
358 # that are automatically linked in as .o files unless the .a suffix is added.
362 # TOOLEXENAME* - These compute the output filenames to generate...
363 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
364 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
365 TOOLEXENAME_P := $(BUILD_ROOT_TOP)/tools/Profile/$(TOOLNAME)
367 ifndef ENABLE_OPTIMIZED
368 TOOLEXENAMES := $(TOOLEXENAME_G)
370 ifdef ENABLE_PROFILING
371 TOOLEXENAMES := $(TOOLEXENAME_P)
373 TOOLEXENAMES := $(TOOLEXENAME_O)
377 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
378 USED_LIBS_OPTIONS := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
379 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o, $(USED_LIBS_OPTIONS))
380 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
381 USED_LIBS_OPTIONS_P := $(patsubst %.o, $(LIBPROFILE)/%.o,$(USED_LIBS_OPTIONS))
384 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
385 # rebuilt if libraries change. This has to make sure to handle .a/.so and .o
388 STATICUSEDLIBS := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
389 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
390 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
391 USED_LIB_PATHS_P := $(addprefix $(LIBPROFILE)/, $(STATICUSEDLIBS))
393 all:: $(TOOLEXENAMES)
395 $(VERB) rm -f $(TOOLEXENAMES)
397 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
398 @echo ======= Linking $(TOOLNAME) debug executable =======
399 $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
401 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
402 @echo ======= Linking $(TOOLNAME) release executable =======
403 $(VERB) $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
405 $(TOOLEXENAME_P): $(ObjectsP) $(USED_LIB_PATHS_P) $(BUILD_ROOT_TOP)/tools/Profile/.dir
406 @echo ======= Linking $(TOOLNAME) profile executable =======
407 $(VERB) $(LinkP) -o $@ $(ObjectsP) $(USED_LIBS_OPTIONS_P) $(TOOLLINKOPTS)
413 #---------------------------------------------------------
414 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
415 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
417 # Create dependencies for the *.cpp files...
418 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
419 $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Profile/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
421 # Create dependencies for the *.c files...
422 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
423 $(VERB) $(DependC) $< | sed 's|$*\.o *|Release/& Profile/& Debug/& Depend/$(@F)|g' > $@
425 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
426 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
428 $(VERB) $(CompileO) $< -o $@
430 $(BUILD_ROOT)/Release/%.o: %.c $(BUILD_ROOT)/Release/.dir
431 $(VERB) $(CompileOC) $< -o $@
433 $(BUILD_ROOT)/Profile/%.o: %.cpp $(BUILD_ROOT)/Profile/.dir
435 $(VERB) $(CompileP) $< -o $@
437 $(BUILD_ROOT)/Profile/%.o: %.c $(BUILD_ROOT)/Profile/.dir
439 $(VERB) $(CompileCP) $< -o $@
441 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
443 $(VERB) $(CompileG) $< -o $@
445 $(BUILD_ROOT)/Debug/%.o: %.c $(BUILD_ROOT)/Debug/.dir
446 $(VERB) $(CompileCG) $< -o $@
448 # Create a .cpp source file from a flex input file... this uses sed to cut down
449 # on the warnings emited by GCC...
451 flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
453 # Rule for building the bison parsers...
456 $(VERB) $(BISON) -v -d -p $(<:%Parser.y=%) $(basename $@).y
457 $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
458 $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
460 # To create the directories...
462 $(VERB) mkdir -p $(@D)
465 # 'make clean' nukes the tree
467 $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Profile $(BUILD_ROOT)/Depend
468 $(VERB) rm -f core *.o *.d *.so *~ *.flc
470 # If dependancies were generated for the file that included this file,
471 # include the dependancies now...
473 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
474 ifneq ($(SourceDepend),)
475 include $(SourceDepend)