User defined operators are not supposed to live beyond the lifetime of the
[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    := $(TOOLDEBUG)/burg
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 WARN_MSG =
146 else
147 STRIP = -s
148 WARN_MSG = "(without symbols) "
149 endif
150
151 # Allow gnu extensions...
152 CPPFLAGS += -D_GNU_SOURCE
153
154 # -Wno-unused-parameter
155 CompileCommonOpts := -Wall -W  -Wwrite-strings -Wno-unused -I$(LEVEL)/include
156
157 # Compile a cpp file, don't link...
158 Compile  := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
159 CompileG := $(Compile) -g  -D_DEBUG
160 CompileO := $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fshort-enums ## DISABLE -freg-struct-return because of gcc3.2 bug
161 CompileP := $(CompileO) $(PROFILE)
162
163 # Compile a c file, don't link...
164 CompileC  := $(CC) -c $(CPPFLAGS) $(CCFLAGS) $(CompileCommonOpts)
165 CompileCG := $(CompileC) -g  -D_DEBUG
166 CompileCO := $(CompileC) -O3 -DNDEBUG -finline-functions -fshort-enums ## DISABLE -freg-struct-return because of gcc3.2 bug
167 CompileCP := $(CompileCO) $(PROFILE)
168
169
170 # Link final executable
171
172 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
173 Link     := $(PURIFY) $(CXX) -static
174 else
175 Link     := $(CXX)
176 endif
177 LinkG    := $(Link) -g  -L $(LIBDEBUG) $(STRIP)
178 LinkO    := $(Link) -O3 -L $(LIBRELEASE)
179 LinkP    := $(Link) -O3 -L $(LIBPROFILE) $(PROFILE)
180
181 # Create one .o file from a bunch of .o files...
182 Relink = ld -r
183
184 # MakeSO - Create a .so file from a .o files...
185 MakeSO   := $(CXX) $(MakeSharedObjectOption)
186 MakeSOO  := $(MakeSO) -O3
187 MakeSOP  := $(MakeSOO) $(PROFILE)
188
189 # Create dependancy file from CPP file, send to stdout.
190 Depend   := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS) 
191 DependC  := $(CC)  -MM -I$(LEVEL)/include $(CPPFLAGS) 
192
193 # Archive a bunch of .o files into a .a file...
194 AR       = ar cq 
195 BISON    = bison
196
197 #----------------------------------------------------------
198
199 # Source includes all of the cpp files, and objects are derived from the
200 # source files...
201 # The local Makefile can list other Source files via ExtraSource = ...
202
203 ifndef Source
204 Source  := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
205 endif
206
207 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
208 ObjectsO := $(addprefix $(BUILD_ROOT)/Release/,$(Objs))
209 ObjectsP := $(addprefix $(BUILD_ROOT)/Profile/,$(Objs))
210 ObjectsG := $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
211
212
213 #---------------------------------------------------------
214 # Handle the DIRS and PARALLEL_DIRS options
215 #---------------------------------------------------------
216
217 ifdef DIRS
218 all install clean ::
219         $(VERB) for dir in ${DIRS}; do \
220                 (cd $$dir; $(MAKE) $@) || exit 1; \
221         done
222 endif
223
224 # Handle PARALLEL_DIRS
225 ifdef PARALLEL_DIRS
226 all     :: $(addsuffix /.makeall    , $(PARALLEL_DIRS))
227 install :: $(addsuffix /.makeinstall, $(PARALLEL_DIRS))
228 clean   :: $(addsuffix /.makeclean  , $(PARALLEL_DIRS))
229
230 %/.makeall %/.makeinstall %/.makeclean:
231         $(VERB) cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
232
233 endif
234
235 #---------------------------------------------------------
236 # Handle the LIBRARYNAME option - used when building libs...
237 #---------------------------------------------------------
238 #
239 #  When libraries are built, they are allowed to optionally define the
240 #  DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
241 #  from being built for the library. This .o files may then be linked to by a
242 #  tool if the tool does not need (or want) the semantics a .a file provides
243 #  (linking in only object files that are "needed").  If a library is never to
244 #  be used in this way, it is better to define DONT_BUILD_RELINKED, and define
245 #  BUILD_ARCHIVE instead.
246 #
247 #  Some libraries must be built as .a files (libscalar for example) because if
248 #  it's built as a .o file, then all of the constituent .o files in it will be
249 #  linked into tools (for example gccas) even if they only use one of the parts
250 #  of it.  For this reason, sometimes it's useful to use libraries as .a files.
251
252 ifdef LIBRARYNAME
253
254 # Make sure there isn't any extranous whitespace on the LIBRARYNAME option
255 LIBRARYNAME := $(strip $(LIBRARYNAME))
256
257 LIBNAME_O    := $(LIBRELEASE)/lib$(LIBRARYNAME).so
258 LIBNAME_P    := $(LIBPROFILE)/lib$(LIBRARYNAME).so
259 LIBNAME_G    := $(LIBDEBUG)/lib$(LIBRARYNAME).so
260 LIBNAME_AO   := $(LIBRELEASE)/lib$(LIBRARYNAME).a
261 LIBNAME_AP   := $(LIBPROFILE)/lib$(LIBRARYNAME).a
262 LIBNAME_AG   := $(LIBDEBUG)/lib$(LIBRARYNAME).a
263 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
264 LIBNAME_OBJP := $(LIBPROFILE)/$(LIBRARYNAME).o
265 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
266
267
268 ifndef ENABLE_OPTIMIZED
269 BUILD_LIBNAME_G := $(LIBNAME_G)
270 ifndef DONT_BUILD_RELINKED
271 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
272 endif
273 ifdef BUILD_ARCHIVE
274 BUILD_LIBNAME_AG := $(LIBNAME_AG)
275 endif
276 endif
277
278 # If optimized builds are enabled...
279 ifdef ENABLE_OPTIMIZED
280   ifdef ENABLE_PROFILING
281     BUILD_LIBNAME_O  := $(LIBNAME_P)
282     ifndef DONT_BUILD_RELINKED
283       BUILD_LIBNAME_OBJO := $(LIBNAME_OBJP)
284     endif
285     ifdef BUILD_ARCHIVE
286       BUILD_LIBNAME_AO := $(LIBNAME_AP)
287     endif
288   else
289     BUILD_LIBNAME_O  := $(LIBNAME_O)
290     ifndef DONT_BUILD_RELINKED
291       BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
292     endif
293     ifdef BUILD_ARCHIVE
294       BUILD_LIBNAME_AO := $(LIBNAME_AO)
295     endif
296   endif
297 endif
298
299 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG)      # Debug
300 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO)      # Release
301 all:: $(BUILD_LIBNAME_AP) $(BUILD_LIBNAME_OBJP)      # Profile
302 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O) $(BUILD_LIBNAME_P) # .so files
303
304 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
305         @echo ======= Linking $(LIBRARYNAME) release library =======
306         $(VERB) $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
307
308 $(LIBNAME_P): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
309         @echo ======= Linking $(LIBRARYNAME) profile library =======
310         $(VERB) $(MakeSOP) -o $@ $(ObjectsP) $(LibSubDirs) $(LibLinkOpts)
311
312 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
313         @echo ======= Linking $(LIBRARYNAME) debug library =======
314         $(VERB) $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
315
316 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
317         @echo ======= Linking $(LIBRARYNAME) release library =======
318         @rm -f $@
319         $(VERB) $(AR) $@ $(ObjectsO) $(LibSubDirs)
320
321 $(LIBNAME_AP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
322         @echo ======= Linking $(LIBRARYNAME) profile library =======
323         @rm -f $@
324         $(VERB) $(AR) $@ $(ObjectsP) $(LibSubDirs)
325
326 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
327         @echo ======= Linking $(LIBRARYNAME) debug library =======
328         @rm -f $@
329         $(VERB) $(AR) $@ $(ObjectsG) $(LibSubDirs)
330
331 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
332         @echo "Linking $@"
333         $(VERB) $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
334
335 $(LIBNAME_OBJP): $(ObjectsP) $(LibSubDirs) $(LIBPROFILE)/.dir
336         @echo "Linking $@"
337         $(VERB) $(Relink) -o $@ $(ObjectsP) $(LibSubDirs)
338
339 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
340         @echo "Linking $@"
341         $(VERB) $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
342
343 endif
344
345 #------------------------------------------------------------------------
346 # Create a TAGS database for emacs
347 #------------------------------------------------------------------------
348
349 ifeq ($(LEVEL), .)
350 tags:
351         etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
352 all:: tags
353 endif
354
355 #------------------------------------------------------------------------
356 # Handle the TOOLNAME option - used when building tool executables...
357 #------------------------------------------------------------------------
358 #
359 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
360 # libraries (and the order of the libs) that should be linked to the
361 # tool. USEDLIBS should contain a list of library names (some with .a extension)
362 # that are automatically linked in as .o files unless the .a suffix is added.
363 #
364 ifdef TOOLNAME
365
366 # TOOLEXENAME* - These compute the output filenames to generate...
367 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
368 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
369 TOOLEXENAME_P := $(BUILD_ROOT_TOP)/tools/Profile/$(TOOLNAME)
370
371 ifndef ENABLE_OPTIMIZED
372   TOOLEXENAMES  := $(TOOLEXENAME_G)
373 else
374   ifdef ENABLE_PROFILING
375     TOOLEXENAMES := $(TOOLEXENAME_P)
376   else
377     TOOLEXENAMES := $(TOOLEXENAME_O)
378   endif
379 endif
380
381 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
382 USED_LIBS_OPTIONS   := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
383 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o,  $(USED_LIBS_OPTIONS))
384 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
385 USED_LIBS_OPTIONS_P := $(patsubst %.o, $(LIBPROFILE)/%.o,$(USED_LIBS_OPTIONS))
386
387
388 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
389 # rebuilt if libraries change.  This has to make sure to handle .a/.so and .o
390 # files seperately.
391 #
392 STATICUSEDLIBS   := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
393 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
394 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
395 USED_LIB_PATHS_P := $(addprefix $(LIBPROFILE)/, $(STATICUSEDLIBS))
396 LINK_OPTS        := $(TOOLLINKOPTS) $(PLATFORMLINKOPTS)
397
398 all::   $(TOOLEXENAMES)
399 clean::
400         $(VERB) rm -f $(TOOLEXENAMES)
401
402 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
403         @echo ======= Linking $(TOOLNAME) debug executable $(WARN_MSG) =======
404         $(VERB) $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(LINK_OPTS)
405
406 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
407         @echo ======= Linking $(TOOLNAME) release executable =======
408         $(VERB) $(LinkO) -o $@ $(ObjectsO) $(USED_LIBS_OPTIONS_O) $(LINK_OPTS)
409
410 $(TOOLEXENAME_P): $(ObjectsP) $(USED_LIB_PATHS_P) $(BUILD_ROOT_TOP)/tools/Profile/.dir
411         @echo ======= Linking $(TOOLNAME) profile executable =======
412         $(VERB) $(LinkP) -o $@ $(ObjectsP) $(USED_LIBS_OPTIONS_P) $(LINK_OPTS)
413
414 endif
415
416
417
418 #---------------------------------------------------------
419 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
420 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
421
422 # Create dependencies for the *.cpp files...
423 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
424         $(VERB) $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Profile/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
425
426 # Create dependencies for the *.c files...
427 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
428         $(VERB) $(DependC) $< | sed 's|$*\.o *|Release/& Profile/& Debug/& Depend/$(@F)|g' > $@
429
430 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
431 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
432         @echo "Compiling $<"
433         $(VERB) $(CompileO) $< -o $@
434
435 $(BUILD_ROOT)/Release/%.o: %.c $(BUILD_ROOT)/Release/.dir
436         $(VERB) $(CompileCO) $< -o $@
437
438 $(BUILD_ROOT)/Profile/%.o: %.cpp $(BUILD_ROOT)/Profile/.dir
439         @echo "Compiling $<"
440         $(VERB) $(CompileP) $< -o $@
441
442 $(BUILD_ROOT)/Profile/%.o: %.c $(BUILD_ROOT)/Profile/.dir
443         @echo "Compiling $<"
444         $(VERB) $(CompileCP) $< -o $@
445
446 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
447         @echo "Compiling $<"
448         $(VERB) $(CompileG) $< -o $@
449
450 $(BUILD_ROOT)/Debug/%.o: %.c $(BUILD_ROOT)/Debug/.dir 
451         $(VERB) $(CompileCG) $< -o $@
452
453 # Create a .cpp source file from a flex input file... this uses sed to cut down
454 # on the warnings emited by GCC...
455 %.cpp: %.l
456         flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
457
458 # Rule for building the bison parsers...
459
460 %.cpp %.h : %.y
461         $(VERB) $(BISON) -v -d -p $(<:%Parser.y=%) $(basename $@).y
462         $(VERB) mv -f $(basename $@).tab.c $(basename $@).cpp
463         $(VERB) mv -f $(basename $@).tab.h $(basename $@).h
464
465 # To create the directories...
466 %/.dir:
467         $(VERB) mkdir -p $(@D)
468         @date > $@
469
470 # 'make clean' nukes the tree
471 clean::
472         $(VERB) rm -rf $(BUILD_ROOT)/Debug $(BUILD_ROOT)/Release $(BUILD_ROOT)/Profile $(BUILD_ROOT)/Depend
473         $(VERB) rm -f core *.o *.d *.so *~ *.flc
474
475 # If dependancies were generated for the file that included this file,
476 # include the dependancies now...
477 #
478 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
479 ifneq ($(SourceDepend),)
480 -include $(SourceDepend)
481 endif