btrfs-progs: build: add more debugging features
[platform/upstream/btrfs-progs.git] / Makefile.in
1 # btrfs-progs
2 #
3 # Basic build targets:
4 #   all         all main tools
5 #   static      build static bnaries, requires static version of the libraries
6 #   test        run the full testsuite
7 #   install     install to default location (/usr/local)
8 #   clean       clean built binaries (not the documentation)
9 #   clean-all   clean as above, clean docs and generated files
10 #
11 # Tuning by variables (environment or make arguments):
12 #   V=1            verbose, print command lines (default: quiet)
13 #   C=1            run checker before compilation (default checker: sparse)
14 #   D=1            debugging build, turn off optimizations
15 #   D=dflags       dtto, turn on additional debugging features:
16 #                  verbose - print file:line along with error/warning messages
17 #                  trace   - print trace before the error/warning messages
18 #                  abort   - call abort() on first error (dumps core)
19 #                  all     - shortcut for all of the above
20 #   W=123          build with warnings (default: off)
21 #   DEBUG_CFLAGS   additional compiler flags for debugging build
22 #   EXTRA_CFLAGS   additional compiler flags
23 #   EXTRA_LDFLAGS  additional linker flags
24 #
25 # Static checkers:
26 #   CHECKER        static checker binary to be called (default: sparse)
27 #   CHECKER_FLAGS  flags to pass to CHECKER, can override CFLAGS
28 #
29
30 # Export all variables to sub-makes by default
31 export
32
33 include Makefile.extrawarn
34
35 CC = @CC@
36 LN_S = @LN_S@
37 AR = @AR@
38 RM = @RM@
39 RMDIR = @RMDIR@
40 INSTALL = @INSTALL@
41 DISABLE_DOCUMENTATION = @DISABLE_DOCUMENTATION@
42 DISABLE_BTRFSCONVERT = @DISABLE_BTRFSCONVERT@
43
44 EXTRA_CFLAGS :=
45 EXTRA_LDFLAGS :=
46
47 DEBUG_CFLAGS_DEFAULT = -O0 -U_FORTIFY_SOURCE -ggdb3
48 DEBUG_CFLAGS_INTERNAL =
49 DEBUG_CFLAGS :=
50
51 # Common build flags
52 CFLAGS = @CFLAGS@ \
53          -include config.h \
54          -DBTRFS_FLAT_INCLUDES \
55          -D_XOPEN_SOURCE=700  \
56          -fno-strict-aliasing \
57          -fPIC \
58          $(EXTRAWARN_CFLAGS) \
59          $(DEBUG_CFLAGS_INTERNAL) \
60          $(EXTRA_CFLAGS)
61
62 LDFLAGS = @LDFLAGS@ \
63           -rdynamic $(EXTRA_LDFLAGS)
64
65 LIBS = @UUID_LIBS@ @BLKID_LIBS@ @ZLIB_LIBS@ @LZO2_LIBS@ -L. -pthread
66 LIBBTRFS_LIBS = $(LIBS)
67
68 # Static compilation flags
69 STATIC_CFLAGS = $(CFLAGS) -ffunction-sections -fdata-sections
70 STATIC_LDFLAGS = -static -Wl,--gc-sections
71 STATIC_LIBS = @UUID_LIBS_STATIC@ @BLKID_LIBS_STATIC@ \
72               @ZLIB_LIBS_STATIC@ @LZO2_LIBS_STATIC@ -L. -pthread
73
74 # don't use FORTIFY with sparse because glibc with FORTIFY can
75 # generate so many sparse errors that sparse stops parsing,
76 # which masks real errors that we want to see.
77 CHECKER := sparse
78 check_defs := .cc-defines.h
79 CHECKER_FLAGS := -include $(check_defs) -D__CHECKER__ \
80         -D__CHECK_ENDIAN__ -Wbitwise -Wuninitialized -Wshadow -Wundef \
81         -U_FORTIFY_SOURCE
82
83 objects = ctree.o disk-io.o radix-tree.o extent-tree.o print-tree.o \
84           root-tree.o dir-item.o file-item.o inode-item.o inode-map.o \
85           extent-cache.o extent_io.o volumes.o utils.o repair.o \
86           qgroup.o raid6.o free-space-cache.o list_sort.o props.o \
87           ulist.o qgroup-verify.o backref.o string-table.o task-utils.o \
88           inode.o file.o find-root.o free-space-tree.o help.o
89 cmds_objects = cmds-subvolume.o cmds-filesystem.o cmds-device.o cmds-scrub.o \
90                cmds-inspect.o cmds-balance.o cmds-send.o cmds-receive.o \
91                cmds-quota.o cmds-qgroup.o cmds-replace.o cmds-check.o \
92                cmds-restore.o cmds-rescue.o chunk-recover.o super-recover.o \
93                cmds-property.o cmds-fi-usage.o cmds-inspect-dump-tree.o \
94                cmds-inspect-dump-super.o cmds-inspect-tree-stats.o cmds-fi-du.o
95 libbtrfs_objects = send-stream.o send-utils.o rbtree.o btrfs-list.o crc32c.o \
96                    uuid-tree.o utils-lib.o rbtree-utils.o
97 libbtrfs_headers = send-stream.h send-utils.h send.h rbtree.h btrfs-list.h \
98                crc32c.h list.h kerncompat.h radix-tree.h extent-cache.h \
99                extent_io.h ioctl.h ctree.h btrfsck.h version.h
100 TESTS = fsck-tests.sh convert-tests.sh
101
102 udev_rules = 64-btrfs-dm.rules
103
104 prefix ?= @prefix@
105 exec_prefix = @exec_prefix@
106 bindir = @bindir@
107 libdir ?= @libdir@
108 incdir = @includedir@/btrfs
109 udevdir = @UDEVDIR@
110 udevruledir = ${udevdir}/rules.d
111
112 ifeq ("$(origin V)", "command line")
113   BUILD_VERBOSE = $(V)
114 endif
115 ifndef BUILD_VERBOSE
116   BUILD_VERBOSE = 0
117 endif
118
119 ifeq ($(BUILD_VERBOSE),1)
120   Q =
121 else
122   Q = @
123 endif
124
125 ifeq ("$(origin D)", "command line")
126   DEBUG_CFLAGS_INTERNAL = $(DEBUG_CFLAGS_DEFAULT) $(DEBUG_CFLAGS)
127 endif
128
129 ifneq (,$(findstring verbose,$(D)))
130   DEBUG_CFLAGS_INTERNAL += -DDEBUG_VERBOSE_ERROR=1
131 endif
132
133 ifneq (,$(findstring trace,$(D)))
134   DEBUG_CFLAGS_INTERNAL += -DDEBUG_TRACE_ON_ERROR=1
135 endif
136
137 ifneq (,$(findstring abort,$(D)))
138   DEBUG_CFLAGS_INTERNAL += -DDEBUG_ABORT_ON_ERROR=1
139 endif
140
141 ifneq (,$(findstring all,$(D)))
142   DEBUG_CFLAGS_INTERNAL += -DDEBUG_VERBOSE_ERROR=1
143   DEBUG_CFLAGS_INTERNAL += -DDEBUG_TRACE_ON_ERROR=1
144   DEBUG_CFLAGS_INTERNAL += -DDEBUG_ABORT_ON_ERROR=1
145 endif
146
147 MAKEOPTS = --no-print-directory Q=$(Q)
148
149 # build all by default
150 progs = $(progs_install) btrfsck btrfs-corrupt-block btrfs-calc-size
151
152 # install only selected
153 progs_install = btrfs mkfs.btrfs btrfs-debug-tree \
154         btrfs-map-logical btrfs-image btrfs-zero-log \
155         btrfs-find-root btrfstune btrfs-show-super \
156         btrfs-select-super
157
158 progs_extra = btrfs-fragments
159
160 progs_static = $(foreach p,$(progs),$(p).static)
161
162 ifneq ($(DISABLE_BTRFSCONVERT),1)
163 progs_install += btrfs-convert
164 endif
165
166 # external libs required by various binaries; for btrfs-foo,
167 # specify btrfs_foo_libs = <list of libs>; see $($(subst...)) rules below
168 btrfs_convert_libs = @EXT2FS_LIBS@ @COM_ERR_LIBS@
169 btrfs_fragments_libs = -lgd -lpng -ljpeg -lfreetype
170 btrfs_debug_tree_objects = cmds-inspect-dump-tree.o
171 btrfs_show_super_objects = cmds-inspect-dump-super.o
172 btrfs_calc_size_objects = cmds-inspect-tree-stats.o
173
174 # collect values of the variables above
175 standalone_deps = $(foreach dep,$(patsubst %,%_objects,$(subst -,_,$(filter btrfs-%, $(progs)))),$($(dep)))
176
177 SUBDIRS =
178 BUILDDIRS = $(patsubst %,build-%,$(SUBDIRS))
179 INSTALLDIRS = $(patsubst %,install-%,$(SUBDIRS))
180 CLEANDIRS = $(patsubst %,clean-%,$(SUBDIRS))
181
182 ifneq ($(DISABLE_DOCUMENTATION),1)
183 BUILDDIRS += build-Documentation
184 INSTALLDIRS += install-Documentation
185 endif
186
187 .PHONY: $(SUBDIRS)
188 .PHONY: $(BUILDDIRS)
189 .PHONY: $(INSTALLDIRS)
190 .PHONY: $(TESTDIRS)
191 .PHONY: $(CLEANDIRS)
192 .PHONY: all install clean
193
194 # Create all the static targets
195 static_objects = $(patsubst %.o, %.static.o, $(objects))
196 static_cmds_objects = $(patsubst %.o, %.static.o, $(cmds_objects))
197 static_libbtrfs_objects = $(patsubst %.o, %.static.o, $(libbtrfs_objects))
198
199 libs_shared = libbtrfs.so.0.1
200 libs_static = libbtrfs.a
201 libs = $(libs_shared) $(libs_static)
202 lib_links = libbtrfs.so.0 libbtrfs.so
203 headers = $(libbtrfs_headers)
204
205 # make C=1 to enable sparse
206 ifdef C
207         # We're trying to use sparse against glibc headers which go wild
208         # trying to use internal compiler macros to test features.  We
209         # copy gcc's and give them to sparse.  But not __SIZE_TYPE__
210         # 'cause sparse defines that one.
211         #
212         dummy := $(shell $(CC) -dM -E -x c - < /dev/null | \
213                         grep -v __SIZE_TYPE__ > $(check_defs))
214         check = $(CHECKER)
215         check_echo = echo
216 else
217         check = true
218         check_echo = true
219 endif
220
221 %.o.d: %.c
222         $(Q)$(CC) -MM -MG -MF $@ -MT $(@:.o.d=.o) -MT $(@:.o.d=.static.o) -MT $@ $(CFLAGS) $<
223
224 .c.o:
225         @$(check_echo) "    [SP]     $<"
226         $(Q)$(check) $(CFLAGS) $(CHECKER_FLAGS) $<
227         @echo "    [CC]     $@"
228         $(Q)$(CC) $(CFLAGS) -c $<
229
230 %.static.o: %.c
231         @echo "    [CC]     $@"
232         $(Q)$(CC) $(STATIC_CFLAGS) -c $< -o $@
233
234 all: $(progs) $(BUILDDIRS)
235 $(SUBDIRS): $(BUILDDIRS)
236 $(BUILDDIRS):
237         @echo "Making all in $(patsubst build-%,%,$@)"
238         $(Q)$(MAKE) $(MAKEOPTS) -C $(patsubst build-%,%,$@)
239
240 test-convert: btrfs btrfs-convert
241         @echo "    [TEST]   convert-tests.sh"
242         $(Q)bash tests/convert-tests.sh
243
244 test-fsck: btrfs btrfs-image btrfs-corrupt-block btrfs-debug-tree mkfs.btrfs
245         @echo "    [TEST]   fsck-tests.sh"
246         $(Q)bash tests/fsck-tests.sh
247
248 test-misc: btrfs btrfs-image btrfs-corrupt-block btrfs-debug-tree mkfs.btrfs btrfstune
249         @echo "    [TEST]   misc-tests.sh"
250         $(Q)bash tests/misc-tests.sh
251
252 test-mkfs: btrfs mkfs.btrfs
253         @echo "    [TEST]   mkfs-tests.sh"
254         $(Q)bash tests/mkfs-tests.sh
255
256 test-fuzz: btrfs
257         @echo "    [TEST]   fuzz-tests.sh"
258         $(Q)bash tests/fuzz-tests.sh
259
260 test-cli: btrfs
261         @echo "    [TEST]   cli-tests.sh"
262         $(Q)bash tests/cli-tests.sh
263
264 test-clean:
265         @echo "Cleaning tests"
266         $(Q)bash tests/clean-tests.sh
267
268 test-inst: all
269         @tmpdest=`mktemp --tmpdir -d btrfs-inst.XXXXXX` && \
270                 echo "Test installation to $$tmpdest" && \
271                 $(MAKE) DESTDIR=$$tmpdest install && \
272                 $(RM) -rf -- $$tmpdest
273
274 test: test-fsck test-mkfs test-convert test-misc test-fuzz
275
276 #
277 # NOTE: For static compiles, you need to have all the required libs
278 #       static equivalent available
279 #
280 static: $(progs_static)
281
282 version.h: version.sh version.h.in configure.ac
283         @echo "    [SH]     $@"
284         $(Q)bash ./config.status --silent $@
285
286 $(libs_shared): $(libbtrfs_objects) $(lib_links) send.h
287         @echo "    [LD]     $@"
288         $(Q)$(CC) $(CFLAGS) $(libbtrfs_objects) $(LDFLAGS) $(LIBBTRFS_LIBS) \
289                 -shared -Wl,-soname,libbtrfs.so.0 -o libbtrfs.so.0.1
290
291 $(libs_static): $(libbtrfs_objects)
292         @echo "    [AR]     $@"
293         $(Q)$(AR) cr libbtrfs.a $(libbtrfs_objects)
294
295 $(lib_links):
296         @echo "    [LN]     $@"
297         $(Q)$(LN_S) -f libbtrfs.so.0.1 $@
298
299 # keep intermediate files from the below implicit rules around
300 .PRECIOUS: $(addsuffix .o,$(progs))
301
302 # Make any btrfs-foo out of btrfs-foo.o, with appropriate libs.
303 # The $($(subst...)) bits below takes the btrfs_*_libs definitions above and
304 # turns them into a list of libraries to link against if they exist
305 #
306 # For static variants, use an extra $(subst) to get rid of the ".static"
307 # from the target name before translating to list of libs
308
309 btrfs-%.static: $(static_objects) btrfs-%.static.o $(static_libbtrfs_objects) $(patsubst %.o,%.static.o,$(standalone_deps))
310         @echo "    [LD]     $@"
311         $(Q)$(CC) $(STATIC_CFLAGS) -o $@ $@.o $(static_objects) \
312                 $(patsubst %.o, %.static.o, $($(subst -,_,$(subst .static,,$@)-objects))) \
313                 $(static_libbtrfs_objects) $(STATIC_LDFLAGS) \
314                 $($(subst -,_,$(subst .static,,$@)-libs)) $(STATIC_LIBS)
315
316 btrfs-%: $(objects) $(libs_static) btrfs-%.o $(standalone_deps)
317         @echo "    [LD]     $@"
318         $(Q)$(CC) $(CFLAGS) -o $@ $(objects) $@.o \
319                 $($(subst -,_,$@-objects)) \
320                 $(libs_static) \
321                 $(LDFLAGS) $(LIBS) $($(subst -,_,$@-libs))
322
323 btrfs: $(objects) btrfs.o $(cmds_objects) $(libs_static)
324         @echo "    [LD]     $@"
325         $(Q)$(CC) $(CFLAGS) -o btrfs btrfs.o $(cmds_objects) \
326                 $(objects) $(libs_static) $(LDFLAGS) $(LIBS)
327
328 btrfs.static: $(static_objects) btrfs.static.o $(static_cmds_objects) $(static_libbtrfs_objects)
329         @echo "    [LD]     $@"
330         $(Q)$(CC) $(STATIC_CFLAGS) -o btrfs.static btrfs.static.o $(static_cmds_objects) \
331                 $(static_objects) $(static_libbtrfs_objects) $(STATIC_LDFLAGS) $(STATIC_LIBS)
332
333 # For backward compatibility, 'btrfs' changes behaviour to fsck if it's named 'btrfsck'
334 btrfsck: btrfs
335         @echo "    [LN]     $@"
336         $(Q)$(LN_S) -f btrfs btrfsck
337
338 btrfsck.static: btrfs.static
339         @echo "    [LN]     $@"
340         $(Q)$(LN_S) -f $^ $@
341
342 mkfs.btrfs: $(objects) $(libs_static) mkfs.o
343         @echo "    [LD]     $@"
344         $(Q)$(CC) $(CFLAGS) -o mkfs.btrfs $(objects) $(libs_static) mkfs.o $(LDFLAGS) $(LIBS)
345
346 mkfs.btrfs.static: $(static_objects) mkfs.static.o $(static_libbtrfs_objects)
347         @echo "    [LD]     $@"
348         $(Q)$(CC) $(STATIC_CFLAGS) -o mkfs.btrfs.static mkfs.static.o $(static_objects) \
349                 $(static_libbtrfs_objects) $(STATIC_LDFLAGS) $(STATIC_LIBS)
350
351 btrfstune: $(objects) $(libs_static) btrfstune.o
352         @echo "    [LD]     $@"
353         $(Q)$(CC) $(CFLAGS) -o btrfstune $(objects) btrfstune.o $(libs_static) $(LDFLAGS) $(LIBS)
354
355 btrfstune.static: $(static_objects) btrfstune.static.o $(static_libbtrfs_objects)
356         @echo "    [LD]     $@"
357         $(Q)$(CC) $(STATIC_CFLAGS) -o $@ btrfstune.static.o $(static_objects) \
358                 $(static_libbtrfs_objects) $(STATIC_LDFLAGS) $(STATIC_LIBS)
359
360 dir-test: $(objects) $(libs) dir-test.o
361         @echo "    [LD]     $@"
362         $(Q)$(CC) $(CFLAGS) -o dir-test $(objects) $(libs) dir-test.o $(LDFLAGS) $(LIBS)
363
364 quick-test: $(objects) $(libs) quick-test.o
365         @echo "    [LD]     $@"
366         $(Q)$(CC) $(CFLAGS) -o quick-test $(objects) $(libs) quick-test.o $(LDFLAGS) $(LIBS)
367
368 ioctl-test: $(objects) $(libs) ioctl-test.o
369         @echo "    [LD]     $@"
370         $(Q)$(CC) $(CFLAGS) -o ioctl-test $(objects) $(libs) ioctl-test.o $(LDFLAGS) $(LIBS)
371
372 send-test: $(objects) $(libs) send-test.o
373         @echo "    [LD]     $@"
374         $(Q)$(CC) $(CFLAGS) -o send-test $(objects) $(libs) send-test.o $(LDFLAGS) $(LIBS)
375
376 library-test: $(libs_shared) library-test.o
377         @echo "    [LD]     $@"
378         $(Q)$(CC) $(CFLAGS) -o library-test library-test.o $(LDFLAGS) -lbtrfs
379
380 library-test.static: $(libs_static) library-test.o
381         @echo "    [LD]     $@"
382         $(Q)$(CC) $(CFLAGS) -o library-test-static library-test.o $(LDFLAGS) $(libs_static)
383
384 test-build: test-build-pre test-build-real
385
386 test-build-pre:
387         $(MAKE) clean-all
388         ./autogen.sh
389         ./configure
390
391 test-build-real:
392         $(MAKE) library-test
393         -$(MAKE) library-test.static
394         $(MAKE) -j 8 all
395         -$(MAKE) -j 8 static
396         $(MAKE) -j 8 $(progs_extra)
397
398 manpages:
399         $(Q)$(MAKE) $(MAKEOPTS) -C Documentation
400
401
402 clean-all: clean clean-doc clean-gen
403
404 clean: $(CLEANDIRS)
405         @echo "Cleaning"
406         $(Q)$(RM) -f $(progs) cscope.out *.o *.o.d \
407               dir-test ioctl-test quick-test send-test library-test library-test-static \
408               btrfs.static mkfs.btrfs.static \
409               $(check_defs) \
410               $(libs) $(lib_links) \
411               $(progs_static) $(progs_extra)
412
413 clean-doc:
414         @echo "Cleaning Documentation"
415         $(Q)$(MAKE) $(MAKEOPTS) -C Documentation clean
416
417 clean-gen:
418         @echo "Cleaning Generated Files"
419         $(Q)$(RM) -rf version.h config.status config.cache connfig.log \
420                 configure.lineno config.status.lineno Makefile \
421                 Documentation/Makefile \
422                 config.log config.h config.h.in~ aclocal.m4 \
423                 configure autom4te.cache/ config/
424
425 $(CLEANDIRS):
426         @echo "Cleaning $(patsubst clean-%,%,$@)"
427         $(Q)$(MAKE) $(MAKEOPTS) -C $(patsubst clean-%,%,$@) clean
428
429 install: $(libs) $(progs_install) $(INSTALLDIRS)
430         $(INSTALL) -m755 -d $(DESTDIR)$(bindir)
431         $(INSTALL) $(progs_install) $(DESTDIR)$(bindir)
432         $(INSTALL) fsck.btrfs $(DESTDIR)$(bindir)
433         # btrfsck is a link to btrfs in the src tree, make it so for installed file as well
434         $(LN_S) -f btrfs $(DESTDIR)$(bindir)/btrfsck
435         $(INSTALL) -m755 -d $(DESTDIR)$(libdir)
436         $(INSTALL) $(libs) $(DESTDIR)$(libdir)
437         cp -a $(lib_links) $(DESTDIR)$(libdir)
438         $(INSTALL) -m755 -d $(DESTDIR)$(incdir)
439         $(INSTALL) -m644 $(headers) $(DESTDIR)$(incdir)
440 ifneq ($(udevdir),)
441         $(INSTALL) -m755 -d $(DESTDIR)$(udevruledir)
442         $(INSTALL) -m644 $(udev_rules) $(DESTDIR)$(udevruledir)
443 endif
444
445 install-static: $(progs_static) $(INSTALLDIRS)
446         $(INSTALL) -m755 -d $(DESTDIR)$(bindir)
447         $(INSTALL) $(progs_static) $(DESTDIR)$(bindir)
448         # btrfsck is a link to btrfs in the src tree, make it so for installed file as well
449         $(LN_S) -f btrfs.static $(DESTDIR)$(bindir)/btrfsck.static
450
451 $(INSTALLDIRS):
452         @echo "Making install in $(patsubst install-%,%,$@)"
453         $(Q)$(MAKE) $(MAKEOPTS) -C $(patsubst install-%,%,$@) install
454
455 uninstall:
456         $(Q)$(MAKE) $(MAKEOPTS) -C Documentation uninstall
457         cd $(DESTDIR)$(incdir); $(RM) -f $(headers)
458         $(RMDIR) -p --ignore-fail-on-non-empty $(DESTDIR)$(incdir)
459         cd $(DESTDIR)$(libdir); $(RM) -f $(lib_links) $(libs)
460         cd $(DESTDIR)$(bindir); $(RM) -f btrfsck fsck.btrfs $(progs_install)
461
462 ifneq ($(MAKECMDGOALS),clean)
463 -include $(objects:.o=.o.d) $(cmds_objects:.o=.o.d) $(subst .btrfs,, $(filter-out btrfsck.o.d, $(progs:=.o.d)))
464 endif