- Makefile changes:
[oota-llvm.git] / Makefile.rules
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 may be set by setting incoming variables:
9 #
10 # 1. LEVEL - The level of the current subdirectory from the top of the 
11 #    MagicStats view.  This level should be expressed as a path, for 
12 #    example, ../.. for two levels deep.
13 #
14 # 2. DIRS - A list of subdirectories to be built.  Fake targets are set up
15 #    so that each of the targets "all", "install", and "clean" each build.
16 #    the subdirectories before the local target.
17 #
18 # 3. Source - If specified, this sets the source code filenames.  If this
19 #    is not set, it defaults to be all of the .cpp, .c, .y, and .l files 
20 #    in the current directory.  Also, if you want to build files in addition
21 #    to the local files, you can use the ExtraSource variable
22 #
23 #===-----------------------------------------------------------------------====
24
25 # These are options that can either be enabled here, or can be enabled on the
26 # make command line (ie, make ENABLE_PROFILING=1)
27 #
28
29 # When ENABLE_PROFILING is enabled, the llvm source base is built with profile
30 # information to allow gprof to be used to get execution frequencies.
31 #
32 #ENABLE_PROFILING = 1
33
34 # When ENABLE_PURIFY is enabled, the LLVM tools are linked with purify (which
35 # must be locally installed) to allow for some automated memory error debugging.
36 #
37 #ENABLE_PURIFY    = 1
38
39 # When ENABLE_OPTIMIZED is enabled, Release builds of all of the LLVM code are
40 # turned on, and Debug builds are turned off.
41 #
42 #ENABLE_OPTIMIZED = 1
43
44 # If you do not want to build into /shared, uncomment this
45 #
46 #BUILD_ROOT = .
47
48 ifdef SHARED_LIBRARY
49 # if SHARED_LIBRARY is specified, the default is to build the dynamic lib
50 dynamic ::
51 endif
52
53 # Default Rule:  Make sure it's also a :: rule
54 all ::
55
56 # Default for install is to at least build everything...
57 install ::
58
59
60 # Figure out which directory to build stuff into.  We want to build into the
61 # /shared directory by default because it is guaranteed to be local to the
62 # current machine.
63 #
64 ifdef BUILD_ROOT
65 BUILD_ROOT_TOP := $(LEVEL)
66 else
67
68 LOGIN_NAME := $(shell whoami)
69 CUR_DIRECTORY := $(shell pwd)
70 BUILD_ROOT := /shared/$(LOGIN_NAME)$(patsubst $(HOME)%,%,$(CUR_DIRECTORY))
71
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
77 #
78 TOP_DIRECTORY := $(shell cd $(LEVEL); pwd)
79 BUILD_ROOT_TOP := /shared/$(LOGIN_NAME)$(patsubst $(HOME)%,%,$(TOP_DIRECTORY))
80 endif
81
82 #--------------------------------------------------------------------
83 # Installation configuration options... 
84 #--------------------------------------------------------------------
85
86 #BinInstDir=/usr/local/bin
87 #LibInstDir=/usrl/local/lib/xxx
88 #DocInstDir=/usr/doc/xxx
89
90 BURG = /home/vadve/vadve/Research/DynOpt/Burg/burg
91 BURG_OPTS = -I
92
93
94 PURIFY = /usr/dcs/applications/purify/bin/purify -cache-dir="$(HOME)/purifycache" -chain-length="30" -messages=all 
95
96 # Shorthand for commonly accessed directories
97 LIBDEBUG    := $(BUILD_ROOT_TOP)/lib/Debug
98 LIBRELEASE  := $(BUILD_ROOT_TOP)/lib/Release
99 TOOLDEBUG   := $(BUILD_ROOT_TOP)/tools/Debug
100 TOOLRELEASE := $(BUILD_ROOT_TOP)/tools/Release
101
102 #---------------------------------------------------------
103 # Compilation options...
104 #---------------------------------------------------------
105
106 # Special tools used while building
107 RunBurg  := $(BURG) $(BURG_OPTS)
108
109 # Enable this for profiling support with 'gprof'
110 ifdef ENABLE_PROFILING
111 PROFILE = -pg
112 else
113 PROFILE =
114 endif
115
116 # -Wno-unused-parameter
117 CompileCommonOpts := $(PROFILE) -Wall -W  -Wwrite-strings -Wno-unused -I$(LEVEL)/include
118
119 # Compile a file, don't link...
120 Compile  := $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $(CompileCommonOpts)
121 CompileG := $(Compile) -g  -D_DEBUG
122 CompileO := $(Compile) -O3 -DNDEBUG -finline-functions -felide-constructors -fnonnull-objects -freg-struct-return -fshort-enums
123
124 # Link final executable
125
126 ifdef ENABLE_PURIFY # To enable purify, build with 'gmake ENABLE_PURIFY=1'
127 Link     := $(PURIFY) $(CXX) $(PROFILE) -static
128 else
129 Link     := $(CXX) $(PROFILE)
130 endif
131 LinkG    := $(Link) -g  -L $(LIBDEBUG)
132 LinkO    := $(Link) -O3 -L $(LIBRELEASE)
133
134 # Create a .so file from a .o files...
135 #MakeSO   := $(CXX) -shared $(PROFILE)
136 MakeSO   := $(CXX) -G $(PROFILE)
137 MakeSOO  := $(MakeSO) -O3
138
139 # Create one .o file from a bunch of .o files...
140 Relink = ld -r
141
142 # Create dependancy file from CPP file, send to stdout.
143 Depend   := $(CXX) -MM -I$(LEVEL)/include $(CPPFLAGS) 
144
145 # Archive a bunch of .o files into a .a file...
146 AR       = ar cq 
147
148 #----------------------------------------------------------
149
150 # Source includes all of the cpp files, and objects are derived from the
151 # source files...
152 # The local Makefile can list other Source files via ExtraSource = ...
153
154 Source  := $(ExtraSource) $(wildcard *.cpp *.c *.y *.l)
155
156 Objs := $(sort $(patsubst Debug/%.o, %.o, $(addsuffix .o,$(basename $(Source)))))
157 ObjectsO = $(addprefix $(BUILD_ROOT)/Release/,$(Objs)))
158 ObjectsG = $(addprefix $(BUILD_ROOT)/Debug/,$(Objs))
159
160
161 #---------------------------------------------------------
162 # Handle the DIRS option
163 #---------------------------------------------------------
164
165 ifdef DIRS  # Only do this if we're using DIRS!
166
167 all     :: $(addsuffix /.makeall    , $(DIRS))
168 install :: $(addsuffix /.makeinstall, $(DIRS))
169 clean   :: $(addsuffix /.makeclean  , $(DIRS))
170
171 %/.makeall %/.makeclean %/.makeinstall:
172         cd $(@D); $(MAKE) $(subst $(@D)/.make,,$@)
173 endif
174
175 #---------------------------------------------------------
176 # Handle the LIBRARYNAME option - used when building libs...
177 #---------------------------------------------------------
178 #
179 #  When libraries are built, they are allowed to optionally define the
180 #  DONT_BUILD_RELINKED make variable, which, when defined, prevents a .o file
181 #  from being built for the library. This .o files may then be linked to by a
182 #  tool if the tool does not need (or want) the semantics a .a file provides
183 #  (linking in only object files that are "needed").  If a library is never to
184 #  be used in this way, it is better to define DONT_BUILD_RELINKED, and define
185 #  BUILD_ARCHIVE instead.
186 #
187 #  Some libraries must be built as .a files (libscalar for example) because if
188 #  it's built as a .o file, then all of the constituent .o files in it will be
189 #  linked into tools (for example gccas) even if they only use one of the parts
190 #  of it.  For this reason, sometimes it's useful to use libraries as .a files.
191
192 ifdef LIBRARYNAME
193
194 LIBNAME_O    := $(LIBRELEASE)/lib$(LIBRARYNAME).so
195 LIBNAME_G    := $(LIBDEBUG)/lib$(LIBRARYNAME).so
196 LIBNAME_AO   := $(LIBRELEASE)/lib$(LIBRARYNAME).a
197 LIBNAME_AG   := $(LIBDEBUG)/lib$(LIBRARYNAME).a
198 LIBNAME_OBJO := $(LIBRELEASE)/$(LIBRARYNAME).o
199 LIBNAME_OBJG := $(LIBDEBUG)/$(LIBRARYNAME).o
200
201
202 ifndef ENABLE_OPTIMIZED
203 BUILD_LIBNAME_G := $(LIBNAME_G)
204 ifndef DONT_BUILD_RELINKED
205 BUILD_LIBNAME_OBJG := $(LIBNAME_OBJG)
206 endif
207 ifdef BUILD_ARCHIVE
208 BUILD_LIBNAME_AG := $(LIBNAME_AG)
209 endif
210 endif
211
212 # If optimized builds are enabled...
213 ifdef ENABLE_OPTIMIZED
214 BUILD_LIBNAME_O  := $(LIBNAME_O)
215 ifndef DONT_BUILD_RELINKED
216 BUILD_LIBNAME_OBJO := $(LIBNAME_OBJO)
217 endif
218 ifdef BUILD_ARCHIVE
219 BUILD_LIBNAME_AO := $(LIBNAME_AO)
220 endif
221 endif
222
223 all:: $(BUILD_LIBNAME_AG) $(BUILD_LIBNAME_OBJG)      # Debug
224 all:: $(BUILD_LIBNAME_AO) $(BUILD_LIBNAME_OBJO)      # Release
225 dynamic:: $(BUILD_LIBNAME_G) $(BUILD_LIBNAME_O)      # .so files
226
227 $(LIBNAME_O): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
228         @echo ======= Linking $(LIBRARYNAME) release library =======
229         $(MakeSOO) -o $@ $(ObjectsO) $(LibSubDirs) $(LibLinkOpts)
230
231 $(LIBNAME_G): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
232         @echo ======= Linking $(LIBRARYNAME) debug library =======
233         $(MakeSO) -g -o $@ $(ObjectsG) $(LibSubDirs) $(LibLinkOpts)
234
235 $(LIBNAME_AO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
236         @echo ======= Linking $(LIBRARYNAME) release library =======
237         @rm -f $@
238         $(AR) $@ $(ObjectsO) $(LibSubDirs)
239
240 $(LIBNAME_AG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
241         @echo ======= Linking $(LIBRARYNAME) debug library =======
242         @rm -f $@
243         $(AR) $@ $(ObjectsG) $(LibSubDirs)
244
245 $(LIBNAME_OBJO): $(ObjectsO) $(LibSubDirs) $(LIBRELEASE)/.dir
246         $(Relink) -o $@ $(ObjectsO) $(LibSubDirs)
247
248 $(LIBNAME_OBJG): $(ObjectsG) $(LibSubDirs) $(LIBDEBUG)/.dir
249         $(Relink) -o $@ $(ObjectsG) $(LibSubDirs)
250
251 endif
252
253 #------------------------------------------------------------------------
254 # Create a TAGS database for emacs
255 #------------------------------------------------------------------------
256
257 ifeq ($(LEVEL), .)
258 tags:
259         etags -l c++ `find include lib tools -name '*.cpp' -o -name '*.h'`
260 all:: tags
261 endif
262
263 #------------------------------------------------------------------------
264 # Handle the TOOLNAME option - used when building tool executables...
265 #------------------------------------------------------------------------
266 #
267 # The TOOLNAME option should be used with a USEDLIBS variable that tells the
268 # libraries (and the order of the libs) that should be linked to the
269 # tool. USEDLIBS should contain a list of library names (some with .a extension)
270 # that are automatically linked in as .o files unless the .a suffix is added.
271 #
272 ifdef TOOLNAME
273
274 # TOOLEXENAME* - These compute the output filenames to generate...
275 TOOLEXENAME_G := $(BUILD_ROOT_TOP)/tools/Debug/$(TOOLNAME)
276 TOOLEXENAME_O := $(BUILD_ROOT_TOP)/tools/Release/$(TOOLNAME)
277 TOOLEXENAMES  := $(TOOLEXENAME_G)
278 ifdef ENABLE_OPTIMIZED
279 TOOLEXENAMES += $(TOOLEXENAME_O)
280 endif
281
282 # USED_LIBS_OPTIONS - Compute the options line that add -llib1 -llib2, etc.
283 USED_LIBS_OPTIONS   := $(patsubst %.a.o, -l%, $(addsuffix .o, $(USEDLIBS)))
284 USED_LIBS_OPTIONS_G := $(patsubst %.o, $(LIBDEBUG)/%.o,  $(USED_LIBS_OPTIONS))
285 USED_LIBS_OPTIONS_O := $(patsubst %.o, $(LIBRELEASE)/%.o,$(USED_LIBS_OPTIONS))
286
287
288 # USED_LIB_PATHS - Compute the path of the libraries used so that tools are
289 # rebuilt if libraries change.  This has to make sure to handle .a/.so and .o
290 # files seperately.
291 #
292 STATICUSEDLIBS   := $(patsubst %.a.o, lib%.a, $(addsuffix .o, $(USEDLIBS)))
293 USED_LIB_PATHS_G := $(addprefix $(LIBDEBUG)/, $(STATICUSEDLIBS))
294 USED_LIB_PATHS_O := $(addprefix $(LIBRELEASE)/, $(STATICUSEDLIBS))
295
296 all::   $(TOOLEXENAMES)
297 clean::
298         rm -f $(TOOLEXENAMES)
299
300 $(TOOLEXENAME_G): $(ObjectsG) $(USED_LIB_PATHS_G) $(BUILD_ROOT_TOP)/tools/Debug/.dir
301         $(LinkG) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_G) $(TOOLLINKOPTS)
302
303 $(TOOLEXENAME_O): $(ObjectsO) $(USED_LIB_PATHS_O) $(BUILD_ROOT_TOP)/tools/Release/.dir
304         $(LinkO) -o $@ $(ObjectsG) $(USED_LIBS_OPTIONS_O) $(TOOLLINKOPTS)
305
306 endif
307
308
309
310 #---------------------------------------------------------
311 .PRECIOUS: $(BUILD_ROOT)/Depend/.dir
312 .PRECIOUS: $(BUILD_ROOT)/Debug/.dir $(BUILD_ROOT)/Release/.dir
313
314 # Create dependencies for the *.cpp files...
315 $(BUILD_ROOT)/Depend/%.d: %.cpp $(BUILD_ROOT)/Depend/.dir
316         $(Depend) $< | sed 's|$*\.o *|$(BUILD_ROOT)/Release/& $(BUILD_ROOT)/Debug/& $(BUILD_ROOT)/Depend/$(@F)|g' > $@
317
318 # Create dependencies for the *.c files...
319 $(BUILD_ROOT)/Depend/%.d: %.c $(BUILD_ROOT)/Depend/.dir
320         $(Depend) $< | sed 's|$*\.o *|Release/& Debug/& Depend/$(@F)|g' > $@
321
322 # Create .o files in the ObjectFiles directory from the .cpp and .c files...
323 $(BUILD_ROOT)/Release/%.o: %.cpp $(BUILD_ROOT)/Release/.dir
324         $(CompileO) $< -o $@
325
326 #Release/%.o: %.c Release/.dir Depend/.dir
327 #       $(CompileOC) $< -o $@
328
329 $(BUILD_ROOT)/Debug/%.o: %.cpp $(BUILD_ROOT)/Debug/.dir
330         $(CompileG) $< -o $@
331
332 #Debug/%.o: %.c Debug/.dir 
333 #       $(CompileGC) $< -o $@
334
335 # Create a .cpp source file from a flex input file... this uses sed to cut down
336 # on the warnings emited by GCC...
337 %.cpp: %.l
338         flex -t $< | sed '/^find_rule/d' | sed 's/void yyunput/inline void yyunput/' | sed 's/void \*yy_flex_realloc/inline void *yy_flex_realloc/' > $@
339
340 # Rule for building the bison parsers...
341
342 %.cpp %.h : %.y
343         bison -v -d -p $(<:%Parser.y=%) $(basename $@).y
344         mv -f $(basename $@).tab.c $(basename $@).cpp
345         mv -f $(basename $@).tab.h $(basename $@).h
346
347 # To create the directories...
348 %/.dir:
349         mkdir -p $(@D)
350         @date > $@
351
352 # Clean nukes the tree
353 clean::
354         rm -rf Debug Release Depend
355         rm -f core *.o *.d *.so *~ *.flc
356
357 # If dependancies were generated for the file that included this file,
358 # include the dependancies now...
359 #
360 SourceDepend := $(addsuffix .d,$(addprefix $(BUILD_ROOT)/Depend/,$(basename $(filter-out Debug/%, $(Source)))))
361 ifneq ($(SourceDepend),)
362 include $(SourceDepend)
363 endif