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 ifdef ENABLE_PROFILING
109 CONFIGURATION := Profile
111 ifdef ENABLE_OPTIMIZED
112 CONFIGURATION := Release
114 CONFIGURATION := Debug
118 # Shorthand for commonly accessed directories
119 LIBDEBUG := $(BUILD_ROOT_TOP)/lib/Debug
120 LIBRELEASE := $(BUILD_ROOT_TOP)/lib/Release
121 LIBPROFILE := $(BUILD_ROOT_TOP)/lib/Profile
122 LIBCURRENT := $(BUILD_ROOT_TOP)/lib/$(CONFIGURATION)
124 TOOLDEBUG := $(BUILD_ROOT_TOP)/tools/Debug
125 TOOLRELEASE := $(BUILD_ROOT_TOP)/tools/Release
126 TOOLPROFILE := $(BUILD_ROOT_TOP)/tools/Profile
127 TOOLCURRENT := $(BUILD_ROOT_TOP)/tools/$(CONFIGURATION)
134 #---------------------------------------------------------
135 # Compilation options...
136 #---------------------------------------------------------
138 # Special tools used while building the LLVM tree. Burg is built as part of the
141 BURG := $(TOOLCURRENT)/burg
142 RunBurg := $(BURG) $(BURG_OPTS)
145 # Enable this for profiling support with 'gprof'
146 # This automatically enables optimized builds.
147 ifdef ENABLE_PROFILING
151 # By default, strip symbol information from executable
153 STRIP = $(PLATFORMSTRIPOPTS)
154 STRIP_WARN_MSG = "(without symbols) "
157 # Allow gnu extensions...
158 CPPFLAGS += -D_GNU_SOURCE
160 # -Wno-unused-parameter
161 CompileCommonOpts := -Wall -W -Wwrite-strings -Wno-unused -I$(LEVEL)/include
162 CompileOptimizeOpts := -O3 -DNDEBUG -finline-functions -fshort-enums
164 # Compile a cpp file, don't link...
165 Compile := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
166 CompileG := $(Compile) -g -D_DEBUG
167 CompileO := $(Compile) $(CompileOptimizeOpts) -felide-constructors -fomit-frame-pointer
168 CompileP := $(Compile) $(CompileOptimizeOpts) -felide-constructors $(PROFILE)
170 # Compile a c file, don't link...
171 CompileC := $(CC) -c $(CPPFLAGS) $(CCFLAGS) $(CompileCommonOpts)
172 CompileCG := $(CompileC) -g -D_DEBUG
173 CompileCO := $(CompileC) $(CompileOptimizeOpts) -fomit-frame-pointer
174 CompileCP := $(CompileC) $(CompileOptimizeOpts) $(PROFILE)
177 # Link final executable
179 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
180 Link := $(PURIFY) $(CXX) -static
184 LinkG := $(Link) -g -L$(LIBDEBUG) $(STRIP)
185 LinkO := $(Link) -O3 -L$(LIBRELEASE)
186 LinkP := $(Link) -O3 -L$(LIBPROFILE) $(PROFILE)
188 # Create one .o file from a bunch of .o files...
191 # MakeSO - Create a .so file from a .o files...
192 MakeSO := $(CXX) $(MakeSharedObjectOption)
193 MakeSOO := $(MakeSO) -O3
194 MakeSOP := $(MakeSOO) $(PROFILE)
196 # Create dependancy file from CPP file, send to stdout.
197 Depend := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
198 DependC := $(CC) -MM -I$(LEVEL)/include $(CPPFLAGS)
200 # Archive a bunch of .o files into a .a file...
204 #----------------------------------------------------------
206 # Source includes all of the cpp files, and objects are derived from the
208 # The local Makefile can list other Source files via ExtraSource = ...
211 Source := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
214 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
215 ObjectsO := $(addprefix $(BUILD_ROOT)/Release/,$(Objs))
216 ObjectsP := $(addprefix $(BUILD_ROOT)/Profile/,$(Objs))
217 ObjectsG := $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
220 #---------------------------------------------------------
221 # Handle the DIRS and PARALLEL_DIRS options
222 #---------------------------------------------------------
225 all install clean test ::
226 $(VERB) for dir in ${DIRS}; do \
227 (cd $$dir; $(MAKE) $@) || exit 1; \
231 # Handle PARALLEL_DIRS
233 all :: $(addsuffix /.makeall , $(PARALLEL_DIRS))
234 install :: $(addsuffix /.makeinstall, $(PARALLEL_DIRS))
235 clean :: $(addsuffix /.makeclean , $(PARALLEL_DIRS))
236 test :: $(addsuffix /.maketest , $(PARALLEL_DIRS))
238 %/.makeall %/.makeinstall %/.makeclean %/.maketest:
239 $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
242 #---------------------------------------------------------
243 # Handle the LIBRARYNAME option - used when building libs...
244 #---------------------------------------------------------
246 # When libraries are built, they are allowed to optionally define the
247 # DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
248 # from being built for the library. This .o files may then be linked to by a
249 # tool if the tool does not need (or want) the semantics a .a file provides
250 # (linking in only object files that are "needed"). If a library is never to
251 # be used in this way, it is better to define DONT_BUILD_RELINKED, and define
252 # BUILD_ARCHIVE instead.
254 # Some libraries must be built as .a files (libscalar for example) because if
255 # it's built as a .o file, then all of the constituent .o files in it will be
256 # linked into tools (for example gccas) even if they only use one of the parts
257 # of it. For this reason, sometimes it's useful to use libraries as .a files.
261 # Make sure there isn't any extranous whitespace on the LIBRARYNAME option
262 LIBRARYNAME := $(strip $(LIBRARYNAME))
264 LIBNAME_O := $(LIBRELEASE)/lib$(LIBRARYNAME).so
265 LIBNAME_P := $(LIBPROFILE)/lib$(LIBRARYNAME).so
266 LIBNAME_G := $(LIBDEBUG)/lib$(LIBRARYNAME).so
267 LIBNAME_AO := $(LIBRELEASE)/lib$(LIBRARYNAME).a
268 LIBNAME_AP := $(LIBPROFILE)/lib$(LIBRARYNAME).a
269 LIBNAME_AG := $(LIBDEBUG)/lib$(LIBRARYNAME).a
270 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
271 LIBNAME_OBJP := $(LIBPROFILE)/$(LIBRARYNAME).o
272 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
274 # dynamic target builds a shared object version of the library...
275 dynamic:: $(LIBCURRENT)/lib$(LIBRARYNAME).so
277 # Does the library want a .o version built?
278 ifndef DONT_BUILD_RELINKED
279 all:: $(LIBCURRENT)/$(LIBRARYNAME).o
282 # Does the library want an archive version built?
284 all:: $(LIBCURRENT)/lib$(LIBRARYNAME).a
287 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
288 @echo ======= Linking $(LIBRARYNAME) release library =======
289 $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
291 $(LIBNAME_P): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
292 @echo ======= Linking $(LIBRARYNAME) profile library =======
293 $(VERB) $(MakeSOP) -o $@ $(ObjectsP) $(LibSubDirs) $(LibLinkOpts)
295 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
296 @echo ======= Linking $(LIBRARYNAME) debug library =======
297 $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
299 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
300 @echo ======= Linking $(LIBRARYNAME) release library =======
302 $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
304 $(LIBNAME_AP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
305 @echo ======= Linking $(LIBRARYNAME) profile library =======
307 $(VERB) $(AR) $@ $(ObjectsP) $(LibSubDirs)
309 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
310 @echo ======= Linking $(LIBRARYNAME) debug library =======
312 $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
314 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
316 $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
318 $(LIBNAME_OBJP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
320 $(VERB) $(Relink) -o $@ $(ObjectsP) $(LibSubDirs)
322 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
324 $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
328 #------------------------------------------------------------------------
329 # Create a TAGS database for emacs
330 #------------------------------------------------------------------------
334 etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
338 #------------------------------------------------------------------------
339 # Handle the TOOLNAME option - used when building tool executables...
340 #------------------------------------------------------------------------
342 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
343 # libraries (and the order of the libs) that should be linked to the
344 # tool. USEDLIBS should contain a list of library names (some with .a extension)
345 # that are automatically linked in as .o files unless the .a suffix is added.
349 # TOOLEXENAME* - These compute the output filenames to generate...
350 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
351 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
352 TOOLEXENAME_P := $(BUILD_ROOT_TOP)/tools/Profile/$(TOOLNAME)
353 TOOLEXENAMES := $(BUILD_ROOT_TOP)/tools/$(CONFIGURATION)/$(TOOLNAME)
355 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
356 USED_LIBS_OPTIONS := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
357 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o, $(USED_LIBS_OPTIONS))
358 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
359 USED_LIBS_OPTIONS_P := $(patsubst %.o, $(LIBPROFILE)/%.o,$(USED_LIBS_OPTIONS))
362 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
363 # rebuilt if libraries change. This has to make sure to handle .a/.so and .o
366 STATICUSEDLIBS := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
367 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
368 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
369 USED_LIB_PATHS_P := $(addprefix $(LIBPROFILE)/, $(STATICUSEDLIBS))
370 LINK_OPTS := $(TOOLLINKOPTS) $(PLATFORMLINKOPTS)
373 # Tell make that we need to rebuild subdirectories before we can link the tool.
374 # This affects things like LLI which has library subdirectories.
375 $(USED_LIB_PATHS_G) $(USED_LIB_PATHS_O) $(USED_LIB_PATHS_P): \
376 $(addsuffix /.makeall, $(PARALLEL_DIRS))
378 all:: $(TOOLEXENAMES)
380 $(VERB) rm -f $(TOOLEXENAMES)
382 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(TOOLDEBUG)/.dir
383 @echo ======= Linking $(TOOLNAME) debug executable $(STRIP_WARN_MSG) =======
384 $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(LINK_OPTS)
386 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(TOOLRELEASE)/.dir
387 @echo ======= Linking $(TOOLNAME) release executable =======
388 $(VERB) $(LinkO) -o $@ $(ObjectsO) $(USED_LIBS_OPTIONS_O) $(LINK_OPTS)
390 $(TOOLEXENAME_P): $(ObjectsP) $(USED_LIB_PATHS_P) $(TOOLPROFILE)/.dir
391 @echo ======= Linking $(TOOLNAME) profile executable =======
392 $(VERB) $(LinkP) -o $@ $(ObjectsP) $(USED_LIBS_OPTIONS_P) $(LINK_OPTS)
398 #---------------------------------------------------------
399 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
400 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
402 # Create dependencies for the *.cpp files...
403 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
404 $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Profile/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
406 # Create dependencies for the *.c files...
407 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
408 $(VERB) $(DependC) $< | sed 's|$*\.o *|Release/& Profile/& Debug/& Depend/$(@F)|g' > $@
410 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
411 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
413 $(VERB) $(CompileO) $< -o $@
415 $(BUILD_ROOT)/Release/%.o: %.c $(BUILD_ROOT)/Release/.dir
416 $(VERB) $(CompileCO) $< -o $@
418 $(BUILD_ROOT)/Profile/%.o: %.cpp $(BUILD_ROOT)/Profile/.dir
420 $(VERB) $(CompileP) $< -o $@
422 $(BUILD_ROOT)/Profile/%.o: %.c $(BUILD_ROOT)/Profile/.dir
424 $(VERB) $(CompileCP) $< -o $@
426 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
428 $(VERB) $(CompileG) $< -o $@
430 $(BUILD_ROOT)/Debug/%.o: %.c $(BUILD_ROOT)/Debug/.dir
431 $(VERB) $(CompileCG) $< -o $@
434 # Rules for building lex/yacc files
436 LEX_FILES = $(filter %.l, $(Source))
437 LEX_OUTPUT = $(LEX_FILES:%.l=%.cpp)
438 YACC_FILES = $(filter %.y, $(Source))
439 YACC_OUTPUT = $(addprefix $(YACC_FILES:%.y=%), .h .cpp .output)
440 .PRECIOUS: $(LEX_OUTPUT) $(YACC_OUTPUT)
442 # Create a .cpp source file from a flex input file... this uses sed to cut down
443 # on the warnings emited by GCC...
445 # The last line is a gross hack to work around flex aparently not being able to
446 # resize the buffer on a large token input. Currently, for uninitialized string
447 # buffers in LLVM we can generate very long tokens, so this is a hack around it.
448 # FIXME. (f.e. char Buffer[10000]; )
451 flex -t $< | sed '/^find_rule/d' | \
452 sed 's/void yyunput/inline void yyunput/' | \
453 sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' | \
454 sed 's/#define YY_BUF_SIZE 16384/#define YY_BUF_SIZE (16384*64)/' > $@
456 # Rule for building the bison parsers...
459 $(VERB) $(BISON) -v -d -p $(<:%Parser.y=%) $*.y
460 $(VERB) mv -f $*.tab.c $*.cpp
461 $(VERB) mv -f $*.tab.h $*.h
463 # To create the directories...
468 # To create postscript files from dot files...
472 # 'make clean' nukes the tree
474 $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Profile $(BUILD_ROOT)/Depend
475 $(VERB) rm -f core core.[0-9][0-9]* *.o *.d *.so *~ *.flc
476 $(VERB) rm -f $(LEX_OUTPUT) $(YACC_OUTPUT)
478 # If dependancies were generated for the file that included this file,
479 # include the dependancies now...
481 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
482 ifneq ($(SourceDepend),)
483 -include $(SourceDepend)