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.
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
24 #===-----------------------------------------------------------------------====
26 # Configuration file to set paths specific to local installation of LLVM
28 include $(LEVEL)/Makefile.config
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)
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.
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.
44 # When ENABLE_OPTIMIZED is enabled, Release builds of all of the LLVM code are
45 # turned on, and Debug builds are turned off.
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).
54 UNAME := $(shell uname)
55 include $(LEVEL)/Makefile.$(UNAME)
58 # if SHARED_LIBRARY is specified, the default is to build the dynamic lib
62 # Default Rule: Make sure it's also a :: rule
65 # Default for install is to at least build everything...
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
73 ifeq ($(LLVM_OBJ_DIR),.)
74 BUILD_ROOT = $(LLVM_OBJ_DIR)
75 BUILD_ROOT_TOP = $(LEVEL)
78 BUILD_ROOT := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(shell pwd))
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
86 TOP_DIRECTORY := $(shell cd $(LEVEL); pwd)
87 BUILD_ROOT_TOP := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
90 #--------------------------------------------------------------------
91 # Variables derived from configuration options...
92 #--------------------------------------------------------------------
94 #BinInstDir=/usr/local/bin
95 #LibInstDir=/usrl/local/lib/xxx
96 #DocInstDir=/usr/doc/xxx
100 PURIFY := $(PURIFY) -cache-dir="$(BUILD_ROOT_TOP)/../purifycache" -chain-length="30" -messages=all
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
115 #---------------------------------------------------------
116 # Compilation options...
117 #---------------------------------------------------------
119 # Special tools used while building
120 RunBurg := $(BURG) $(BURG_OPTS)
122 # Enable this for profiling support with 'gprof'
123 ifdef ENABLE_PROFILING
129 # Allow gnu extensions...
130 CPPFLAGS += -D_GNU_SOURCE
132 # -Wno-unused-parameter
133 CompileCommonOpts := $(PROFILE) -Wall -W -Wwrite-strings -Wno-unused -I$(LEVEL)/include
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
140 # Link final executable
142 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
143 Link := $(PURIFY) $(CXX) $(PROFILE) -static
145 Link := $(CXX) $(PROFILE)
147 LinkG := $(Link) -g -L $(LIBDEBUG)
148 LinkO := $(Link) -O3 -L $(LIBRELEASE)
150 # Create one .o file from a bunch of .o files...
153 # MakeSO - Create a .so file from a .o files...
154 MakeSO := $(CXX) $(MakeSharedObjectOption) $(PROFILE)
155 MakeSOO := $(MakeSO) -O3
157 # Create dependancy file from CPP file, send to stdout.
158 Depend := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
160 # Archive a bunch of .o files into a .a file...
163 #----------------------------------------------------------
165 # Source includes all of the cpp files, and objects are derived from the
167 # The local Makefile can list other Source files via ExtraSource = ...
169 Source := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
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))
176 #---------------------------------------------------------
177 # Handle the DIRS option
178 #---------------------------------------------------------
180 ifdef DIRS # Only do this if we're using DIRS!
183 $(VERB) for dir in ${DIRS}; do \
184 (cd $$dir; $(MAKE) $@) || exit 1; \
188 #---------------------------------------------------------
189 # Handle the LIBRARYNAME option - used when building libs...
190 #---------------------------------------------------------
192 # When libraries are built, they are allowed to optionally define the
193 # DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
194 # from being built for the library. This .o files may then be linked to by a
195 # tool if the tool does not need (or want) the semantics a .a file provides
196 # (linking in only object files that are "needed"). If a library is never to
197 # be used in this way, it is better to define DONT_BUILD_RELINKED, and define
198 # BUILD_ARCHIVE instead.
200 # Some libraries must be built as .a files (libscalar for example) because if
201 # it's built as a .o file, then all of the constituent .o files in it will be
202 # linked into tools (for example gccas) even if they only use one of the parts
203 # of it. For this reason, sometimes it's useful to use libraries as .a files.
207 # Make sure there isn't any extranous whitespace on the LIBRARYNAME option
208 LIBRARYNAME := $(strip $(LIBRARYNAME))
210 LIBNAME_O := $(LIBRELEASE)/lib$(LIBRARYNAME).so
211 LIBNAME_G := $(LIBDEBUG)/lib$(LIBRARYNAME).so
212 LIBNAME_AO := $(LIBRELEASE)/lib$(LIBRARYNAME).a
213 LIBNAME_AG := $(LIBDEBUG)/lib$(LIBRARYNAME).a
214 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
215 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
218 ifndef ENABLE_OPTIMIZED
219 BUILD_LIBNAME_G := $(LIBNAME_G)
220 ifndef DONT_BUILD_RELINKED
221 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
224 BUILD_LIBNAME_AG := $(LIBNAME_AG)
228 # If optimized builds are enabled...
229 ifdef ENABLE_OPTIMIZED
230 BUILD_LIBNAME_O := $(LIBNAME_O)
231 ifndef DONT_BUILD_RELINKED
232 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
235 BUILD_LIBNAME_AO := $(LIBNAME_AO)
239 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG) # Debug
240 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO) # Release
241 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O) # .so files
243 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
244 @echo ======= Linking $(LIBRARYNAME) release library =======
245 $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
247 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
248 @echo ======= Linking $(LIBRARYNAME) debug library =======
249 $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
251 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
252 @echo ======= Linking $(LIBRARYNAME) release library =======
254 $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
256 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
257 @echo ======= Linking $(LIBRARYNAME) debug library =======
259 $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
261 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
263 $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
265 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
266 $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
270 #------------------------------------------------------------------------
271 # Create a TAGS database for emacs
272 #------------------------------------------------------------------------
276 etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
280 #------------------------------------------------------------------------
281 # Handle the TOOLNAME option - used when building tool executables...
282 #------------------------------------------------------------------------
284 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
285 # libraries (and the order of the libs) that should be linked to the
286 # tool. USEDLIBS should contain a list of library names (some with .a extension)
287 # that are automatically linked in as .o files unless the .a suffix is added.
291 # TOOLEXENAME* - These compute the output filenames to generate...
292 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
293 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
294 TOOLEXENAMES := $(TOOLEXENAME_G)
295 ifdef ENABLE_OPTIMIZED
296 TOOLEXENAMES += $(TOOLEXENAME_O)
299 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
300 USED_LIBS_OPTIONS := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
301 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o, $(USED_LIBS_OPTIONS))
302 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
305 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
306 # rebuilt if libraries change. This has to make sure to handle .a/.so and .o
309 STATICUSEDLIBS := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
310 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
311 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
313 all:: $(TOOLEXENAMES)
315 $(VERB) rm -f $(TOOLEXENAMES)
317 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
318 @echo ======= Linking $(TOOLNAME) debug executable =======
319 $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
321 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
322 @echo ======= Linking $(TOOLNAME) release executable =======
323 $(VERB) $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
329 #---------------------------------------------------------
330 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
331 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
333 # Create dependencies for the *.cpp files...
334 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
335 $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
337 # Create dependencies for the *.c files...
338 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
339 $(VERB) $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
341 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
342 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
344 $(VERB) $(CompileO) $< -o $@
346 #Release/%.o: %.c Release/.dir Depend/.dir
347 # $(CompileOC) $< -o $@
349 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
351 $(VERB) $(CompileG) $< -o $@
353 #Debug/%.o: %.c Debug/.dir
354 # $(CompileGC) $< -o $@
356 # Create a .cpp source file from a flex input file... this uses sed to cut down
357 # on the warnings emited by GCC...
359 flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
361 # Rule for building the bison parsers...
364 $(VERB) bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
365 $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
366 $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
368 # To create the directories...
370 $(VERB) mkdir -p $(@D)
373 # Clean nukes the tree
375 $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Depend
376 $(VERB) rm -f core *.o *.d *.so *~ *.flc
378 # If dependancies were generated for the file that included this file,
379 # include the dependancies now...
381 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
382 ifneq ($(SourceDepend),)
383 include $(SourceDepend)