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 # if SHARED_LIBRARY is specified, the default is to build the dynamic lib
54 # Default Rule: Make sure it's also a :: rule
57 # Default for install is to at least build everything...
61 # Figure out which directory to build stuff into. We want to build into the
62 # /shared directory by default because it is guaranteed to be local to the
65 ifeq ($(LLVM_OBJ_DIR),.)
66 BUILD_ROOT = $(LLVM_OBJ_DIR)
67 BUILD_ROOT_TOP = $(LEVEL)
70 BUILD_ROOT := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(shell pwd))
72 # Calculate the BUILD_ROOT_TOP variable, which is the top of the llvm/ tree.
73 # Note that although this is just equal to $(BUILD_ROOT)/$(LEVEL), we cannot use
74 # this expression because some of the directories on the source tree may not
75 # exist in the build tree (for example the test/ heirarchy). Thus we evaluate
76 # the directory to eliminate the ../'s
78 TOP_DIRECTORY := $(shell cd $(LEVEL); pwd)
79 BUILD_ROOT_TOP := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
82 #--------------------------------------------------------------------
83 # Variables derived from configuration options...
84 #--------------------------------------------------------------------
86 #BinInstDir=/usr/local/bin
87 #LibInstDir=/usrl/local/lib/xxx
88 #DocInstDir=/usr/doc/xxx
92 PURIFY := $(PURIFY) -cache-dir="$(BUILD_ROOT_TOP)/../purifycache" -chain-length="30" -messages=all
94 # Shorthand for commonly accessed directories
95 LIBDEBUG := $(BUILD_ROOT_TOP)/lib/Debug
96 LIBRELEASE := $(BUILD_ROOT_TOP)/lib/Release
97 TOOLDEBUG := $(BUILD_ROOT_TOP)/tools/Debug
98 TOOLRELEASE := $(BUILD_ROOT_TOP)/tools/Release
107 #---------------------------------------------------------
108 # Compilation options...
109 #---------------------------------------------------------
111 # Special tools used while building
112 RunBurg := $(BURG) $(BURG_OPTS)
114 # Enable this for profiling support with 'gprof'
115 ifdef ENABLE_PROFILING
121 # Allow gnu extensions...
122 CPPFLAGS += -D_GNU_SOURCE
124 # -Wno-unused-parameter
125 CompileCommonOpts := $(PROFILE) -Wall -W -Wwrite-strings -Wno-unused -I$(LEVEL)/include
127 # Compile a file, don't link...
128 Compile := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
129 CompileG := $(Compile) -g -D_DEBUG
130 CompileO := $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fnonnull-objects -freg-struct-return -fshort-enums
132 # Link final executable
134 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
135 Link := $(PURIFY) $(CXX) $(PROFILE) -static
137 Link := $(CXX) $(PROFILE)
139 LinkG := $(Link) -g -L $(LIBDEBUG)
140 LinkO := $(Link) -O3 -L $(LIBRELEASE)
142 # Create a .so file from a .o files...
143 #MakeSO := $(CXX) -shared $(PROFILE)
144 MakeSO := $(CXX) -G $(PROFILE)
145 MakeSOO := $(MakeSO) -O3
147 # Create one .o file from a bunch of .o files...
150 # Create dependancy file from CPP file, send to stdout.
151 Depend := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
153 # Archive a bunch of .o files into a .a file...
156 #----------------------------------------------------------
158 # Source includes all of the cpp files, and objects are derived from the
160 # The local Makefile can list other Source files via ExtraSource = ...
162 Source := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
164 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
165 ObjectsO = $(addprefix $(BUILD_ROOT)/Release/,$(Objs)))
166 ObjectsG = $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
169 #---------------------------------------------------------
170 # Handle the DIRS option
171 #---------------------------------------------------------
173 ifdef DIRS # Only do this if we're using DIRS!
175 all :: $(addsuffix /.makeall , $(DIRS))
176 install :: $(addsuffix /.makeinstall, $(DIRS))
177 clean :: $(addsuffix /.makeclean , $(DIRS))
179 %/.makeall %/.makeclean %/.makeinstall:
180 $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
183 #---------------------------------------------------------
184 # Handle the LIBRARYNAME option - used when building libs...
185 #---------------------------------------------------------
187 # When libraries are built, they are allowed to optionally define the
188 # DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
189 # from being built for the library. This .o files may then be linked to by a
190 # tool if the tool does not need (or want) the semantics a .a file provides
191 # (linking in only object files that are "needed"). If a library is never to
192 # be used in this way, it is better to define DONT_BUILD_RELINKED, and define
193 # BUILD_ARCHIVE instead.
195 # Some libraries must be built as .a files (libscalar for example) because if
196 # it's built as a .o file, then all of the constituent .o files in it will be
197 # linked into tools (for example gccas) even if they only use one of the parts
198 # of it. For this reason, sometimes it's useful to use libraries as .a files.
202 LIBNAME_O := $(LIBRELEASE)/lib$(LIBRARYNAME).so
203 LIBNAME_G := $(LIBDEBUG)/lib$(LIBRARYNAME).so
204 LIBNAME_AO := $(LIBRELEASE)/lib$(LIBRARYNAME).a
205 LIBNAME_AG := $(LIBDEBUG)/lib$(LIBRARYNAME).a
206 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
207 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
210 ifndef ENABLE_OPTIMIZED
211 BUILD_LIBNAME_G := $(LIBNAME_G)
212 ifndef DONT_BUILD_RELINKED
213 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
216 BUILD_LIBNAME_AG := $(LIBNAME_AG)
220 # If optimized builds are enabled...
221 ifdef ENABLE_OPTIMIZED
222 BUILD_LIBNAME_O := $(LIBNAME_O)
223 ifndef DONT_BUILD_RELINKED
224 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
227 BUILD_LIBNAME_AO := $(LIBNAME_AO)
231 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG) # Debug
232 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO) # Release
233 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O) # .so files
235 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
236 @echo ======= Linking $(LIBRARYNAME) release library =======
237 $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
239 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
240 @echo ======= Linking $(LIBRARYNAME) debug library =======
241 $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
243 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
244 @echo ======= Linking $(LIBRARYNAME) release library =======
246 $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
248 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
249 @echo ======= Linking $(LIBRARYNAME) debug library =======
251 $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
253 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
255 $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
257 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
258 $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
262 #------------------------------------------------------------------------
263 # Create a TAGS database for emacs
264 #------------------------------------------------------------------------
268 etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
272 #------------------------------------------------------------------------
273 # Handle the TOOLNAME option - used when building tool executables...
274 #------------------------------------------------------------------------
276 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
277 # libraries (and the order of the libs) that should be linked to the
278 # tool. USEDLIBS should contain a list of library names (some with .a extension)
279 # that are automatically linked in as .o files unless the .a suffix is added.
283 # TOOLEXENAME* - These compute the output filenames to generate...
284 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
285 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
286 TOOLEXENAMES := $(TOOLEXENAME_G)
287 ifdef ENABLE_OPTIMIZED
288 TOOLEXENAMES += $(TOOLEXENAME_O)
291 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
292 USED_LIBS_OPTIONS := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
293 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o, $(USED_LIBS_OPTIONS))
294 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
297 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
298 # rebuilt if libraries change. This has to make sure to handle .a/.so and .o
301 STATICUSEDLIBS := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
302 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
303 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
305 all:: $(TOOLEXENAMES)
307 $(VERB) rm -f $(TOOLEXENAMES)
309 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
310 @echo ======= Linking $(TOOLNAME) debug executable =======
311 $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
313 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
314 @echo ======= Linking $(TOOLNAME) release executable =======
315 $(VERB) $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
321 #---------------------------------------------------------
322 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
323 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
325 # Create dependencies for the *.cpp files...
326 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
327 $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
329 # Create dependencies for the *.c files...
330 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
331 $(VERB) $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
333 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
334 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
336 $(VERB) $(CompileO) $< -o $@
338 #Release/%.o: %.c Release/.dir Depend/.dir
339 # $(CompileOC) $< -o $@
341 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
343 $(VERB) $(CompileG) $< -o $@
345 #Debug/%.o: %.c Debug/.dir
346 # $(CompileGC) $< -o $@
348 # Create a .cpp source file from a flex input file... this uses sed to cut down
349 # on the warnings emited by GCC...
351 flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
353 # Rule for building the bison parsers...
356 $(VERB) bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
357 $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
358 $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
360 # To create the directories...
362 $(VERB) mkdir -p $(@D)
365 # Clean nukes the tree
367 $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Depend
368 $(VERB) rm -f core *.o *.d *.so *~ *.flc
370 # If dependancies were generated for the file that included this file,
371 # include the dependancies now...
373 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
374 ifneq ($(SourceDepend),)
375 include $(SourceDepend)