f3f3cf159ccf9f91a76f443758519734c4c3eaa6
[oota-llvm.git] / Makefile.common
1 #===-- Makefile.common - Common make rules for LLVM -------*- makefile -*--====
2 #
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.
7 #
8 # The following functionality can be set by setting incoming variables.
9 # The variable $(LEVEL) *must* be set:
10 #
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.
14 #
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
18 #    built in order.
19 #
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.
23 #
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
28 #
29 #===-----------------------------------------------------------------------====
30
31 # Configuration file to set paths specific to local installation of LLVM
32
33 include $(LEVEL)/Makefile.config
34
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)
37 #
38
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.
41 #
42 #ENABLE_PROFILING = 1
43
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.
46 #
47 #ENABLE_PURIFY    = 1
48
49 # When ENABLE_OPTIMIZED is enabled, Release builds of all of the LLVM code are
50 # turned on, and Debug builds are turned off.
51 #
52 #ENABLE_OPTIMIZED = 1
53
54
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).
58 #
59 UNAME := $(shell uname)
60 include $(LEVEL)/Makefile.$(UNAME)
61
62 ifdef SHARED_LIBRARY
63 # if SHARED_LIBRARY is specified, the default is to build the dynamic lib
64 dynamic ::
65 endif
66
67 # Default Rule:  Make sure it's also a :: rule
68 all ::
69
70 # Default for install is to at least build everything...
71 install ::
72
73
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
76 # current machine.
77 #
78 ifeq ($(LLVM_OBJ_DIR),.)
79 BUILD_ROOT     = $(LLVM_OBJ_DIR)
80 BUILD_ROOT_TOP = $(LEVEL)
81 else
82
83 BUILD_ROOT := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(shell pwd))
84
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
90 #
91 TOP_DIRECTORY := $(shell cd $(LEVEL); pwd)
92 BUILD_ROOT_TOP := $(LLVM_OBJ_DIR)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
93 endif
94
95 #--------------------------------------------------------------------
96 # Variables derived from configuration options... 
97 #--------------------------------------------------------------------
98
99 #BinInstDir=/usr/local/bin
100 #LibInstDir=/usrl/local/lib/xxx
101 #DocInstDir=/usr/doc/xxx
102
103 BURG_OPTS = -I
104
105 PURIFY := $(PURIFY) -cache-dir="$(BUILD_ROOT_TOP)/../purifycache" -chain-length="30" -messages=all 
106
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
114
115 # Verbosity levels
116 ifdef VERBOSE
117 VERB := 
118 else
119 VERB := @
120 endif
121
122 #---------------------------------------------------------
123 # Compilation options...
124 #---------------------------------------------------------
125
126 # Special tools used while building the LLVM tree.  Burg is built as part of the
127 # utils directory.
128 #
129 BURG    := $(LEVEL)/utils/Burg/burg.$(UNAME)
130 RunBurg := $(BURG) $(BURG_OPTS)
131
132
133 # Enable this for profiling support with 'gprof'
134 # This automatically enables optimized builds.
135 ifdef ENABLE_PROFILING
136   PROFILE = -pg
137   ENABLE_OPTIMIZED = 1
138 else
139   PROFILE =
140 endif
141
142 # By default, strip symbol information from executable
143 ifdef KEEP_SYMBOLS
144 STRIP =
145 else
146 STRIP = -s
147 endif
148
149 # Allow gnu extensions...
150 CPPFLAGS += -D_GNU_SOURCE
151
152 # -Wno-unused-parameter
153 CompileCommonOpts := -Wall -W  -Wwrite-strings -Wno-unused -I$(LEVEL)/include
154
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)
160
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)
166
167
168 # Link final executable
169
170 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
171 Link     := $(PURIFY) $(CXX) -static
172 else
173 Link     := $(CXX)
174 endif
175 LinkG    := $(Link) -g  -L $(LIBDEBUG) $(STRIP)
176 LinkO    := $(Link) -O3 -L $(LIBRELEASE)
177 LinkP    := $(Link) -O3 -L $(LIBPROFILE) $(PROFILE)
178
179 # Create one .o file from a bunch of .o files...
180 Relink = ld -r
181
182 # MakeSO - Create a .so file from a .o files...
183 MakeSO   := $(CXX) $(MakeSharedObjectOption)
184 MakeSOO  := $(MakeSO) -O3
185 MakeSOP  := $(MakeSOO) $(PROFILE)
186
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) 
190
191 # Archive a bunch of .o files into a .a file...
192 AR       = ar cq 
193 BISON    = bison
194
195 #----------------------------------------------------------
196
197 # Source includes all of the cpp files, and objects are derived from the
198 # source files...
199 # The local Makefile can list other Source files via ExtraSource = ...
200
201 ifndef Source
202 Source  := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
203 endif
204
205 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
206 ObjectsO := $(addprefix $(BUILD_ROOT)/Release/,$(Objs))
207 ObjectsP := $(addprefix $(BUILD_ROOT)/Profile/,$(Objs))
208 ObjectsG := $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
209
210
211 #---------------------------------------------------------
212 # Handle the DIRS and PARALLEL_DIRS options
213 #---------------------------------------------------------
214
215 ifdef DIRS
216 all install clean ::
217         $(VERB) for dir in ${DIRS}; do \
218                 (cd $$dir; $(MAKE) $@) || exit 1; \
219         done
220 endif
221
222 # Handle PARALLEL_DIRS
223 ifdef PARALLEL_DIRS
224 all     :: $(addsuffix /.makeall    , $(PARALLEL_DIRS))
225 install :: $(addsuffix /.makeinstall, $(PARALLEL_DIRS))
226 clean   :: $(addsuffix /.makeclean  , $(PARALLEL_DIRS))
227
228 %/.makeall %/.makeinstall %/.makeclean:
229         $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
230
231 endif
232
233 #---------------------------------------------------------
234 # Handle the LIBRARYNAME option - used when building libs...
235 #---------------------------------------------------------
236 #
237 #  When libraries are built, they are allowed to optionally define the
238 #  DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
239 #  from being built for the library. This .o files may then be linked to by a
240 #  tool if the tool does not need (or want) the semantics a .a file provides
241 #  (linking in only object files that are "needed").  If a library is never to
242 #  be used in this way, it is better to define DONT_BUILD_RELINKED, and define
243 #  BUILD_ARCHIVE instead.
244 #
245 #  Some libraries must be built as .a files (libscalar for example) because if
246 #  it's built as a .o file, then all of the constituent .o files in it will be
247 #  linked into tools (for example gccas) even if they only use one of the parts
248 #  of it.  For this reason, sometimes it's useful to use libraries as .a files.
249
250 ifdef LIBRARYNAME
251
252 # Make sure there isn't any extranous whitespace on the LIBRARYNAME option
253 LIBRARYNAME := $(strip $(LIBRARYNAME))
254
255 LIBNAME_O    := $(LIBRELEASE)/lib$(LIBRARYNAME).so
256 LIBNAME_P    := $(LIBPROFILE)/lib$(LIBRARYNAME).so
257 LIBNAME_G    := $(LIBDEBUG)/lib$(LIBRARYNAME).so
258 LIBNAME_AO   := $(LIBRELEASE)/lib$(LIBRARYNAME).a
259 LIBNAME_AP   := $(LIBPROFILE)/lib$(LIBRARYNAME).a
260 LIBNAME_AG   := $(LIBDEBUG)/lib$(LIBRARYNAME).a
261 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
262 LIBNAME_OBJP := $(LIBPROFILE)/$(LIBRARYNAME).o
263 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
264
265
266 ifndef ENABLE_OPTIMIZED
267 BUILD_LIBNAME_G := $(LIBNAME_G)
268 ifndef DONT_BUILD_RELINKED
269 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
270 endif
271 ifdef BUILD_ARCHIVE
272 BUILD_LIBNAME_AG := $(LIBNAME_AG)
273 endif
274 endif
275
276 # If optimized builds are enabled...
277 ifdef ENABLE_OPTIMIZED
278   ifdef ENABLE_PROFILING
279     BUILD_LIBNAME_O  := $(LIBNAME_P)
280     ifndef DONT_BUILD_RELINKED
281       BUILD_LIBNAME_OBJO := $(LIBNAME_OBJP)
282     endif
283     ifdef BUILD_ARCHIVE
284       BUILD_LIBNAME_AO := $(LIBNAME_AP)
285     endif
286   else
287     BUILD_LIBNAME_O  := $(LIBNAME_O)
288     ifndef DONT_BUILD_RELINKED
289       BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
290     endif
291     ifdef BUILD_ARCHIVE
292       BUILD_LIBNAME_AO := $(LIBNAME_AO)
293     endif
294   endif
295 endif
296
297 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG)      # Debug
298 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO)      # Release
299 all:: $(BUILD_LIBNAME_AP) $(BUILD_LIBNAME_OBJP)      # Profile
300 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O) $(BUILD_LIBNAME_P) # .so files
301
302 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
303         @echo ======= Linking $(LIBRARYNAME) release library =======
304         $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
305
306 $(LIBNAME_P): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
307         @echo ======= Linking $(LIBRARYNAME) profile library =======
308         $(VERB) $(MakeSOP) -o $@ $(ObjectsP) $(LibSubDirs) $(LibLinkOpts)
309
310 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
311         @echo ======= Linking $(LIBRARYNAME) debug library =======
312         $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
313
314 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
315         @echo ======= Linking $(LIBRARYNAME) release library =======
316         @rm -f $@
317         $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
318
319 $(LIBNAME_AP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
320         @echo ======= Linking $(LIBRARYNAME) profile library =======
321         @rm -f $@
322         $(VERB) $(AR) $@ $(ObjectsP) $(LibSubDirs)
323
324 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
325         @echo ======= Linking $(LIBRARYNAME) debug library =======
326         @rm -f $@
327         $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
328
329 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
330         @echo "Linking $@"
331         $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
332
333 $(LIBNAME_OBJP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
334         @echo "Linking $@"
335         $(VERB) $(Relink) -o $@ $(ObjectsP) $(LibSubDirs)
336
337 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
338         @echo "Linking $@"
339         $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
340
341 endif
342
343 #------------------------------------------------------------------------
344 # Create a TAGS database for emacs
345 #------------------------------------------------------------------------
346
347 ifeq ($(LEVEL), .)
348 tags:
349         etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
350 all:: tags
351 endif
352
353 #------------------------------------------------------------------------
354 # Handle the TOOLNAME option - used when building tool executables...
355 #------------------------------------------------------------------------
356 #
357 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
358 # libraries (and the order of the libs) that should be linked to the
359 # tool. USEDLIBS should contain a list of library names (some with .a extension)
360 # that are automatically linked in as .o files unless the .a suffix is added.
361 #
362 ifdef TOOLNAME
363
364 # TOOLEXENAME* - These compute the output filenames to generate...
365 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
366 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
367 TOOLEXENAME_P := $(BUILD_ROOT_TOP)/tools/Profile/$(TOOLNAME)
368
369 ifndef ENABLE_OPTIMIZED
370   TOOLEXENAMES  := $(TOOLEXENAME_G)
371 else
372   ifdef ENABLE_PROFILING
373     TOOLEXENAMES := $(TOOLEXENAME_P)
374   else
375     TOOLEXENAMES := $(TOOLEXENAME_O)
376   endif
377 endif
378
379 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
380 USED_LIBS_OPTIONS   := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
381 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o,  $(USED_LIBS_OPTIONS))
382 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
383 USED_LIBS_OPTIONS_P := $(patsubst %.o, $(LIBPROFILE)/%.o,$(USED_LIBS_OPTIONS))
384
385
386 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
387 # rebuilt if libraries change.  This has to make sure to handle .a/.so and .o
388 # files seperately.
389 #
390 STATICUSEDLIBS   := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
391 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
392 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
393 USED_LIB_PATHS_P := $(addprefix $(LIBPROFILE)/, $(STATICUSEDLIBS))
394
395 all::   $(TOOLEXENAMES)
396 clean::
397         $(VERB) rm -f $(TOOLEXENAMES)
398
399 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
400         @echo ======= Linking $(TOOLNAME) debug executable =======
401         $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
402
403 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
404         @echo ======= Linking $(TOOLNAME) release executable =======
405         $(VERB) $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
406
407 $(TOOLEXENAME_P): $(ObjectsP) $(USED_LIB_PATHS_P) $(BUILD_ROOT_TOP)/tools/Profile/.dir
408         @echo ======= Linking $(TOOLNAME) profile executable =======
409         $(VERB) $(LinkP) -o $@ $(ObjectsP) $(USED_LIBS_OPTIONS_P) $(TOOLLINKOPTS)
410
411 endif
412
413
414
415 #---------------------------------------------------------
416 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
417 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
418
419 # Create dependencies for the *.cpp files...
420 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
421         $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Profile/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
422
423 # Create dependencies for the *.c files...
424 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
425         $(VERB) $(DependC) $< | sed 's|$*\.o *|Release/& Profile/& Debug/& Depend/$(@F)|g' > $@
426
427 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
428 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
429         @echo "Compiling $<"
430         $(VERB) $(CompileO) $< -o $@
431
432 $(BUILD_ROOT)/Release/%.o: %.c $(BUILD_ROOT)/Release/.dir
433         $(VERB) $(CompileOC) $< -o $@
434
435 $(BUILD_ROOT)/Profile/%.o: %.cpp $(BUILD_ROOT)/Profile/.dir
436         @echo "Compiling $<"
437         $(VERB) $(CompileP) $< -o $@
438
439 $(BUILD_ROOT)/Profile/%.o: %.c $(BUILD_ROOT)/Profile/.dir
440         @echo "Compiling $<"
441         $(VERB) $(CompileCP) $< -o $@
442
443 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
444         @echo "Compiling $<"
445         $(VERB) $(CompileG) $< -o $@
446
447 $(BUILD_ROOT)/Debug/%.o: %.c $(BUILD_ROOT)/Debug/.dir 
448         $(VERB) $(CompileCG) $< -o $@
449
450 # Create a .cpp source file from a flex input file... this uses sed to cut down
451 # on the warnings emited by GCC...
452 %.cpp: %.l
453         flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
454
455 # Rule for building the bison parsers...
456
457 %.cpp %.h : %.y
458         $(VERB) $(BISON) -v -d -p $(<:%Parser.y=%) $(basename $@).y
459         $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
460         $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
461
462 # To create the directories...
463 %/.dir:
464         $(VERB) mkdir -p $(@D)
465         @date > $@
466
467 # 'make clean' nukes the tree
468 clean::
469         $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Profile $(BUILD_ROOT)/Depend
470         $(VERB) rm -f core *.o *.d *.so *~ *.flc
471
472 # If dependancies were generated for the file that included this file,
473 # include the dependancies now...
474 #
475 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
476 ifneq ($(SourceDepend),)
477 include $(SourceDepend)
478 endif