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 # -Wno-unused-parameter
122 CompileCommonOpts := $(PROFILE) -Wall -W -Wwrite-strings -Wno-unused -I$(LEVEL)/include
124 # Compile a file, don't link...
125 Compile := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
126 CompileG := $(Compile) -g -D_DEBUG
127 CompileO := $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fnonnull-objects -freg-struct-return -fshort-enums
129 # Link final executable
131 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
132 Link := $(PURIFY) $(CXX) $(PROFILE) -static
134 Link := $(CXX) $(PROFILE)
136 LinkG := $(Link) -g -L $(LIBDEBUG)
137 LinkO := $(Link) -O3 -L $(LIBRELEASE)
139 # Create a .so file from a .o files...
140 #MakeSO := $(CXX) -shared $(PROFILE)
141 MakeSO := $(CXX) -G $(PROFILE)
142 MakeSOO := $(MakeSO) -O3
144 # Create one .o file from a bunch of .o files...
147 # Create dependancy file from CPP file, send to stdout.
148 Depend := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS)
150 # Archive a bunch of .o files into a .a file...
153 #----------------------------------------------------------
155 # Source includes all of the cpp files, and objects are derived from the
157 # The local Makefile can list other Source files via ExtraSource = ...
159 Source := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
161 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
162 ObjectsO = $(addprefix $(BUILD_ROOT)/Release/,$(Objs)))
163 ObjectsG = $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
166 #---------------------------------------------------------
167 # Handle the DIRS option
168 #---------------------------------------------------------
170 ifdef DIRS # Only do this if we're using DIRS!
172 all :: $(addsuffix /.makeall , $(DIRS))
173 install :: $(addsuffix /.makeinstall, $(DIRS))
174 clean :: $(addsuffix /.makeclean , $(DIRS))
176 %/.makeall %/.makeclean %/.makeinstall:
177 $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
180 #---------------------------------------------------------
181 # Handle the LIBRARYNAME option - used when building libs...
182 #---------------------------------------------------------
184 # When libraries are built, they are allowed to optionally define the
185 # DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
186 # from being built for the library. This .o files may then be linked to by a
187 # tool if the tool does not need (or want) the semantics a .a file provides
188 # (linking in only object files that are "needed"). If a library is never to
189 # be used in this way, it is better to define DONT_BUILD_RELINKED, and define
190 # BUILD_ARCHIVE instead.
192 # Some libraries must be built as .a files (libscalar for example) because if
193 # it's built as a .o file, then all of the constituent .o files in it will be
194 # linked into tools (for example gccas) even if they only use one of the parts
195 # of it. For this reason, sometimes it's useful to use libraries as .a files.
199 LIBNAME_O := $(LIBRELEASE)/lib$(LIBRARYNAME).so
200 LIBNAME_G := $(LIBDEBUG)/lib$(LIBRARYNAME).so
201 LIBNAME_AO := $(LIBRELEASE)/lib$(LIBRARYNAME).a
202 LIBNAME_AG := $(LIBDEBUG)/lib$(LIBRARYNAME).a
203 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
204 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
207 ifndef ENABLE_OPTIMIZED
208 BUILD_LIBNAME_G := $(LIBNAME_G)
209 ifndef DONT_BUILD_RELINKED
210 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
213 BUILD_LIBNAME_AG := $(LIBNAME_AG)
217 # If optimized builds are enabled...
218 ifdef ENABLE_OPTIMIZED
219 BUILD_LIBNAME_O := $(LIBNAME_O)
220 ifndef DONT_BUILD_RELINKED
221 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
224 BUILD_LIBNAME_AO := $(LIBNAME_AO)
228 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG) # Debug
229 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO) # Release
230 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O) # .so files
232 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
233 @echo ======= Linking $(LIBRARYNAME) release library =======
234 $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
236 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
237 @echo ======= Linking $(LIBRARYNAME) debug library =======
238 $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
240 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
241 @echo ======= Linking $(LIBRARYNAME) release library =======
243 $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
245 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
246 @echo ======= Linking $(LIBRARYNAME) debug library =======
248 $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
250 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
252 $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
254 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
255 $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
259 #------------------------------------------------------------------------
260 # Create a TAGS database for emacs
261 #------------------------------------------------------------------------
265 etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
269 #------------------------------------------------------------------------
270 # Handle the TOOLNAME option - used when building tool executables...
271 #------------------------------------------------------------------------
273 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
274 # libraries (and the order of the libs) that should be linked to the
275 # tool. USEDLIBS should contain a list of library names (some with .a extension)
276 # that are automatically linked in as .o files unless the .a suffix is added.
280 # TOOLEXENAME* - These compute the output filenames to generate...
281 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
282 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
283 TOOLEXENAMES := $(TOOLEXENAME_G)
284 ifdef ENABLE_OPTIMIZED
285 TOOLEXENAMES += $(TOOLEXENAME_O)
288 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
289 USED_LIBS_OPTIONS := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
290 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o, $(USED_LIBS_OPTIONS))
291 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
294 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
295 # rebuilt if libraries change. This has to make sure to handle .a/.so and .o
298 STATICUSEDLIBS := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
299 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
300 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
302 all:: $(TOOLEXENAMES)
304 $(VERB) rm -f $(TOOLEXENAMES)
306 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
307 @echo ======= Linking $(TOOLNAME) debug executable =======
308 $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
310 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
311 @echo ======= Linking $(TOOLNAME) release executable =======
312 $(VERB) $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
318 #---------------------------------------------------------
319 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
320 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
322 # Create dependencies for the *.cpp files...
323 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
324 $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
326 # Create dependencies for the *.c files...
327 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
328 $(VERB) $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
330 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
331 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
333 $(VERB) $(CompileO) $< -o $@
335 #Release/%.o: %.c Release/.dir Depend/.dir
336 # $(CompileOC) $< -o $@
338 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
340 $(VERB) $(CompileG) $< -o $@
342 #Debug/%.o: %.c Debug/.dir
343 # $(CompileGC) $< -o $@
345 # Create a .cpp source file from a flex input file... this uses sed to cut down
346 # on the warnings emited by GCC...
348 flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
350 # Rule for building the bison parsers...
353 $(VERB) bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
354 $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
355 $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
357 # To create the directories...
359 $(VERB) mkdir -p $(@D)
362 # Clean nukes the tree
364 $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Depend
365 $(VERB) rm -f core *.o *.d *.so *~ *.flc
367 # If dependancies were generated for the file that included this file,
368 # include the dependancies now...
370 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
371 ifneq ($(SourceDepend),)
372 include $(SourceDepend)