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
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 # asan - enable address sanitizer compiler feature
21 # ubsan - undefined behaviour sanitizer compiler feature
22 # bcheck - extended build checks
23 # W=123 build with warnings (default: off)
24 # DEBUG_CFLAGS additional compiler flags for debugging build
25 # EXTRA_CFLAGS additional compiler flags
26 # EXTRA_LDFLAGS additional linker flags
28 # Testing-specific options (see also tests/README.md):
29 # TEST=GLOB run test(s) from directories matching GLOB
30 # TEST_LOG=tty print name of a command run via the execution helpers
31 # TEST_LOG=dump dump testing log file when a test fails
34 # CHECKER static checker binary to be called (default: sparse)
35 # CHECKER_FLAGS flags to pass to CHECKER, can override CFLAGS
38 # Export all variables to sub-makes by default
41 include Makefile.extrawarn
49 DISABLE_DOCUMENTATION = @DISABLE_DOCUMENTATION@
50 DISABLE_BTRFSCONVERT = @DISABLE_BTRFSCONVERT@
51 BTRFSCONVERT_EXT2 = @BTRFSCONVERT_EXT2@
56 DEBUG_CFLAGS_DEFAULT = -O0 -U_FORTIFY_SOURCE -ggdb3
57 DEBUG_CFLAGS_INTERNAL =
60 TOPDIR := $(shell pwd)
65 -DBTRFS_FLAT_INCLUDES \
67 -fno-strict-aliasing \
70 -I$(TOPDIR)/kernel-lib \
72 $(DEBUG_CFLAGS_INTERNAL) \
76 -rdynamic -L$(TOPDIR) $(EXTRA_LDFLAGS)
78 LIBS = @UUID_LIBS@ @BLKID_LIBS@ @ZLIB_LIBS@ @LZO2_LIBS@ -L. -pthread
79 LIBBTRFS_LIBS = $(LIBS)
81 # Static compilation flags
82 STATIC_CFLAGS = $(CFLAGS) -ffunction-sections -fdata-sections
83 STATIC_LDFLAGS = -static -Wl,--gc-sections
84 STATIC_LIBS = @UUID_LIBS_STATIC@ @BLKID_LIBS_STATIC@ \
85 @ZLIB_LIBS_STATIC@ @LZO2_LIBS_STATIC@ -L. -pthread
87 # don't use FORTIFY with sparse because glibc with FORTIFY can
88 # generate so many sparse errors that sparse stops parsing,
89 # which masks real errors that we want to see.
91 check_defs := .cc-defines.h
92 CHECKER_FLAGS := -include $(check_defs) -D__CHECKER__ \
93 -D__CHECK_ENDIAN__ -Wbitwise -Wuninitialized -Wshadow -Wundef \
96 objects = ctree.o disk-io.o kernel-lib/radix-tree.o extent-tree.o print-tree.o \
97 root-tree.o dir-item.o file-item.o inode-item.o inode-map.o \
98 extent-cache.o extent_io.o volumes.o utils.o repair.o \
99 qgroup.o raid56.o free-space-cache.o kernel-lib/list_sort.o props.o \
100 ulist.o qgroup-verify.o backref.o string-table.o task-utils.o \
101 inode.o file.o find-root.o free-space-tree.o help.o send-dump.o
102 cmds_objects = cmds-subvolume.o cmds-filesystem.o cmds-device.o cmds-scrub.o \
103 cmds-inspect.o cmds-balance.o cmds-send.o cmds-receive.o \
104 cmds-quota.o cmds-qgroup.o cmds-replace.o cmds-check.o \
105 cmds-restore.o cmds-rescue.o chunk-recover.o super-recover.o \
106 cmds-property.o cmds-fi-usage.o cmds-inspect-dump-tree.o \
107 cmds-inspect-dump-super.o cmds-inspect-tree-stats.o cmds-fi-du.o
108 libbtrfs_objects = send-stream.o send-utils.o kernel-lib/rbtree.o btrfs-list.o \
109 kernel-lib/crc32c.o \
110 uuid-tree.o utils-lib.o rbtree-utils.o
111 libbtrfs_headers = send-stream.h send-utils.h send.h kernel-lib/rbtree.h btrfs-list.h \
112 kernel-lib/crc32c.h kernel-lib/list.h kerncompat.h \
113 kernel-lib/radix-tree.h extent-cache.h \
114 extent_io.h ioctl.h ctree.h btrfsck.h version.h
115 TESTS = fsck-tests.sh convert-tests.sh
117 udev_rules = 64-btrfs-dm.rules
120 exec_prefix = @exec_prefix@
123 incdir = @includedir@/btrfs
125 udevruledir = ${udevdir}/rules.d
127 ifeq ("$(origin V)", "command line")
134 ifeq ($(BUILD_VERBOSE),1)
140 ifeq ("$(origin D)", "command line")
141 DEBUG_CFLAGS_INTERNAL = $(DEBUG_CFLAGS_DEFAULT) $(DEBUG_CFLAGS)
144 ifneq (,$(findstring verbose,$(D)))
145 DEBUG_CFLAGS_INTERNAL += -DDEBUG_VERBOSE_ERROR=1
148 ifneq (,$(findstring trace,$(D)))
149 DEBUG_CFLAGS_INTERNAL += -DDEBUG_TRACE_ON_ERROR=1
152 ifneq (,$(findstring abort,$(D)))
153 DEBUG_CFLAGS_INTERNAL += -DDEBUG_ABORT_ON_ERROR=1
156 ifneq (,$(findstring all,$(D)))
157 DEBUG_CFLAGS_INTERNAL += -DDEBUG_VERBOSE_ERROR=1
158 DEBUG_CFLAGS_INTERNAL += -DDEBUG_TRACE_ON_ERROR=1
159 DEBUG_CFLAGS_INTERNAL += -DDEBUG_ABORT_ON_ERROR=1
162 ifneq (,$(findstring asan,$(D)))
163 DEBUG_CFLAGS_INTERNAL += -fsanitize=address
166 ifneq (,$(findstring ubsan,$(D)))
167 DEBUG_CFLAGS_INTERNAL += -fsanitize=undefined
170 ifneq (,$(findstring bcheck,$(D)))
171 DEBUG_CFLAGS_INTERNAL += -DDEBUG_BUILD_CHECKS
174 MAKEOPTS = --no-print-directory Q=$(Q)
176 # build all by default
177 progs = $(progs_install) btrfsck btrfs-corrupt-block
179 # install only selected
180 progs_install = btrfs mkfs.btrfs btrfs-debug-tree \
181 btrfs-map-logical btrfs-image btrfs-zero-log \
182 btrfs-find-root btrfstune \
185 # other tools, not built by default
186 progs_extra = btrfs-fragments btrfs-calc-size btrfs-show-super
188 progs_static = $(foreach p,$(progs),$(p).static)
190 ifneq ($(DISABLE_BTRFSCONVERT),1)
191 progs_install += btrfs-convert
194 # external libs required by various binaries; for btrfs-foo,
195 # specify btrfs_foo_libs = <list of libs>; see $($(subst...)) rules below
196 btrfs_convert_libs = @EXT2FS_LIBS@ @COM_ERR_LIBS@
197 btrfs_convert_cflags = -DBTRFSCONVERT_EXT2=$(BTRFSCONVERT_EXT2)
198 btrfs_fragments_libs = -lgd -lpng -ljpeg -lfreetype
199 btrfs_debug_tree_objects = cmds-inspect-dump-tree.o
200 btrfs_show_super_objects = cmds-inspect-dump-super.o
201 btrfs_calc_size_objects = cmds-inspect-tree-stats.o
203 # collect values of the variables above
204 standalone_deps = $(foreach dep,$(patsubst %,%_objects,$(subst -,_,$(filter btrfs-%, $(progs)))),$($(dep)))
207 BUILDDIRS = $(patsubst %,build-%,$(SUBDIRS))
208 INSTALLDIRS = $(patsubst %,install-%,$(SUBDIRS))
209 CLEANDIRS = $(patsubst %,clean-%,$(SUBDIRS))
211 ifneq ($(DISABLE_DOCUMENTATION),1)
212 BUILDDIRS += build-Documentation
213 INSTALLDIRS += install-Documentation
218 .PHONY: $(INSTALLDIRS)
221 .PHONY: all install clean
223 # Create all the static targets
224 static_objects = $(patsubst %.o, %.static.o, $(objects))
225 static_cmds_objects = $(patsubst %.o, %.static.o, $(cmds_objects))
226 static_libbtrfs_objects = $(patsubst %.o, %.static.o, $(libbtrfs_objects))
228 libs_shared = libbtrfs.so.0.1
229 libs_static = libbtrfs.a
230 libs = $(libs_shared) $(libs_static)
231 lib_links = libbtrfs.so.0 libbtrfs.so
232 headers = $(libbtrfs_headers)
234 # make C=1 to enable sparse
236 # We're trying to use sparse against glibc headers which go wild
237 # trying to use internal compiler macros to test features. We
238 # copy gcc's and give them to sparse. But not __SIZE_TYPE__
239 # 'cause sparse defines that one.
241 dummy := $(shell $(CC) -dM -E -x c - < /dev/null | \
242 grep -v __SIZE_TYPE__ > $(check_defs))
251 $(Q)$(CC) -MD -MM -MG -MF $@ -MT $(@:.o.d=.o) -MT $(@:.o.d=.static.o) -MT $@ $(CFLAGS) $<
254 # Pick from per-file variables, btrfs_*_cflags
257 @$(check_echo) " [SP] $<"
258 $(Q)$(check) $(CFLAGS) $(CHECKER_FLAGS) $<
260 $(Q)$(CC) $(CFLAGS) -c $< -o $@ $($(subst -,_,$(@:%.o=%)-cflags)) \
261 $($(subst -,_,btrfs-$(@:%/$(notdir $@)=%)-cflags))
265 $(Q)$(CC) $(STATIC_CFLAGS) -c $< -o $@ $($(subst -,_,$(@:%.static.o=%)-cflags)) \
266 $($(subst -,_,btrfs-$(@:%/$(notdir $@)=%)-cflags))
268 all: $(progs) $(BUILDDIRS)
269 $(SUBDIRS): $(BUILDDIRS)
271 @echo "Making all in $(patsubst build-%,%,$@)"
272 $(Q)$(MAKE) $(MAKEOPTS) -C $(patsubst build-%,%,$@)
274 test-convert: btrfs btrfs-convert
275 @echo " [TEST] convert-tests.sh"
276 $(Q)bash tests/convert-tests.sh
278 test-check: test-fsck
279 test-fsck: btrfs btrfs-image btrfs-corrupt-block btrfs-debug-tree mkfs.btrfs
280 @echo " [TEST] fsck-tests.sh"
281 $(Q)bash tests/fsck-tests.sh
283 test-misc: btrfs btrfs-image btrfs-corrupt-block btrfs-debug-tree mkfs.btrfs btrfstune
284 @echo " [TEST] misc-tests.sh"
285 $(Q)bash tests/misc-tests.sh
287 test-mkfs: btrfs mkfs.btrfs
288 @echo " [TEST] mkfs-tests.sh"
289 $(Q)bash tests/mkfs-tests.sh
292 @echo " [TEST] fuzz-tests.sh"
293 $(Q)bash tests/fuzz-tests.sh
296 @echo " [TEST] cli-tests.sh"
297 $(Q)bash tests/cli-tests.sh
300 @echo "Cleaning tests"
301 $(Q)bash tests/clean-tests.sh
304 @tmpdest=`mktemp --tmpdir -d btrfs-inst.XXXXXX` && \
305 echo "Test installation to $$tmpdest" && \
306 $(MAKE) DESTDIR=$$tmpdest install && \
307 $(RM) -rf -- $$tmpdest
309 test: test-fsck test-mkfs test-convert test-misc test-fuzz test-cli
312 # NOTE: For static compiles, you need to have all the required libs
313 # static equivalent available
315 static: $(progs_static)
317 version.h: version.sh version.h.in configure.ac
319 $(Q)bash ./config.status --silent $@
321 $(libs_shared): $(libbtrfs_objects) $(lib_links) send.h
323 $(Q)$(CC) $(CFLAGS) $(libbtrfs_objects) $(LDFLAGS) $(LIBBTRFS_LIBS) \
324 -shared -Wl,-soname,libbtrfs.so.0 -o libbtrfs.so.0.1
326 $(libs_static): $(libbtrfs_objects)
328 $(Q)$(AR) cr libbtrfs.a $(libbtrfs_objects)
332 $(Q)$(LN_S) -f libbtrfs.so.0.1 $@
334 # keep intermediate files from the below implicit rules around
335 .PRECIOUS: $(addsuffix .o,$(progs))
337 # Make any btrfs-foo out of btrfs-foo.o, with appropriate libs.
338 # The $($(subst...)) bits below takes the btrfs_*_libs definitions above and
339 # turns them into a list of libraries to link against if they exist
341 # For static variants, use an extra $(subst) to get rid of the ".static"
342 # from the target name before translating to list of libs
344 btrfs-%.static: $(static_objects) btrfs-%.static.o $(static_libbtrfs_objects) $(patsubst %.o,%.static.o,$(standalone_deps))
346 $(Q)$(CC) $(STATIC_CFLAGS) -o $@ $@.o $(static_objects) \
347 $(patsubst %.o, %.static.o, $($(subst -,_,$(subst .static,,$@)-objects))) \
348 $(static_libbtrfs_objects) $(STATIC_LDFLAGS) \
349 $($(subst -,_,$(subst .static,,$@)-libs)) $(STATIC_LIBS)
351 btrfs-%: $(objects) $(libs_static) btrfs-%.o $(standalone_deps)
353 $(Q)$(CC) $(CFLAGS) -o $@ $(objects) $@.o \
354 $($(subst -,_,$@-objects)) \
356 $(LDFLAGS) $(LIBS) $($(subst -,_,$@-libs))
358 btrfs: $(objects) btrfs.o $(cmds_objects) $(libs_static)
360 $(Q)$(CC) $(CFLAGS) -o btrfs btrfs.o $(cmds_objects) \
361 $(objects) $(libs_static) $(LDFLAGS) $(LIBS)
363 btrfs.static: $(static_objects) btrfs.static.o $(static_cmds_objects) $(static_libbtrfs_objects)
365 $(Q)$(CC) $(STATIC_CFLAGS) -o btrfs.static btrfs.static.o $(static_cmds_objects) \
366 $(static_objects) $(static_libbtrfs_objects) $(STATIC_LDFLAGS) $(STATIC_LIBS)
368 # For backward compatibility, 'btrfs' changes behaviour to fsck if it's named 'btrfsck'
371 $(Q)$(LN_S) -f btrfs btrfsck
373 btrfsck.static: btrfs.static
377 mkfs.btrfs: $(objects) $(libs_static) mkfs/main.o
379 $(Q)$(CC) $(CFLAGS) -o mkfs.btrfs $(objects) $(libs_static) mkfs/main.o $(LDFLAGS) $(LIBS)
381 mkfs.btrfs.static: $(static_objects) mkfs/main.static.o $(static_libbtrfs_objects)
383 $(Q)$(CC) $(STATIC_CFLAGS) -o mkfs.btrfs.static mkfs/main.static.o $(static_objects) \
384 $(static_libbtrfs_objects) $(STATIC_LDFLAGS) $(STATIC_LIBS)
386 btrfstune: $(objects) $(libs_static) btrfstune.o
388 $(Q)$(CC) $(CFLAGS) -o btrfstune $(objects) btrfstune.o $(libs_static) $(LDFLAGS) $(LIBS)
390 btrfstune.static: $(static_objects) btrfstune.static.o $(static_libbtrfs_objects)
392 $(Q)$(CC) $(STATIC_CFLAGS) -o $@ btrfstune.static.o $(static_objects) \
393 $(static_libbtrfs_objects) $(STATIC_LDFLAGS) $(STATIC_LIBS)
395 btrfs-image: $(objects) $(libs_static) image/main.o
397 $(Q)$(CC) $(CFLAGS) -I$(TOPDIR)/image -o btrfs-image $(objects) image/main.o $(libs_static) $(LDFLAGS) $(LIBS)
399 btrfs-image.static: $(static_objects) image/main.static.o $(static_libbtrfs_objects)
401 $(Q)$(CC) $(STATIC_CFLAGS) -o $@ image/main.static.o $(static_objects) \
402 $(static_libbtrfs_objects) $(STATIC_LDFLAGS) $(STATIC_LIBS)
404 btrfs-convert: $(objects) $(libs_static) convert/main.o
406 $(Q)$(CC) $(CFLAGS) -I$(TOPDIR)/convert -o btrfs-convert $(objects) convert/main.o $(libs_static) \
407 $(LDFLAGS) $(btrfs_convert_libs) $(LIBS)
409 btrfs-convert.static: $(static_objects) convert/main.static.o $(static_libbtrfs_objects)
411 $(Q)$(CC) $(STATIC_CFLAGS) -o $@ convert/main.static.o $(static_objects) \
412 $(static_libbtrfs_objects) $(STATIC_LDFLAGS) $(btrfs_convert_libs) $(STATIC_LIBS)
414 dir-test: $(objects) $(libs) dir-test.o
416 $(Q)$(CC) $(CFLAGS) -o dir-test $(objects) $(libs) dir-test.o $(LDFLAGS) $(LIBS)
418 quick-test: $(objects) $(libs) quick-test.o
420 $(Q)$(CC) $(CFLAGS) -o quick-test $(objects) $(libs) quick-test.o $(LDFLAGS) $(LIBS)
422 ioctl-test.o: ioctl-test.c ioctl.h kerncompat.h ctree.h
424 $(Q)$(CC) $(CFLAGS) -c $< -o $@
426 ioctl-test-32.o: ioctl-test.c ioctl.h kerncompat.h ctree.h
428 $(Q)$(CC) $(CFLAGS) -m32 -c $< -o $@
430 ioctl-test-64.o: ioctl-test.c ioctl.h kerncompat.h ctree.h
432 $(Q)$(CC) $(CFLAGS) -m64 -c $< -o $@
434 ioctl-test: ioctl-test.o
436 $(Q)$(CC) $(CFLAGS) -o $@ $< $(LDFLAGS)
437 @echo " ?[PAHOLE] $@.pahole"
438 -$(Q)pahole $@ > $@.pahole
440 ioctl-test-32: ioctl-test-32.o
442 $(Q)$(CC) $(CFLAGS) -m32 -o $@ $< $(LDFLAGS)
443 @echo " ?[PAHOLE] $@.pahole"
444 -$(Q)pahole $@ > $@.pahole
446 ioctl-test-64: ioctl-test-64.o
448 $(Q)$(CC) $(CFLAGS) -m64 -o $@ $< $(LDFLAGS)
449 @echo " ?[PAHOLE] $@.pahole"
450 -$(Q)pahole $@ > $@.pahole
452 test-ioctl: ioctl-test ioctl-test-32 ioctl-test-64
453 @echo " [TEST/ioctl]"
454 $(Q)./ioctl-test > ioctl-test.log
455 $(Q)./ioctl-test-32 > ioctl-test-32.log
456 $(Q)./ioctl-test-64 > ioctl-test-64.log
458 library-test: $(libs_shared) library-test.o
460 $(Q)$(CC) $(CFLAGS) -o library-test library-test.o $(LDFLAGS) -Wl,-rpath=$(TOPDIR) -lbtrfs
464 library-test.static: $(libs_static) library-test.static.o
466 $(Q)$(CC) $(STATIC_CFLAGS) -o library-test.static library-test.static.o $(STATIC_LDFLAGS) $(libs_static) $(STATIC_LIBS)
470 test-build: test-build-pre test-build-real
479 -$(MAKE) library-test.static
482 $(MAKE) -j 8 $(progs_extra)
485 $(Q)$(MAKE) $(MAKEOPTS) -C Documentation
488 clean-all: clean clean-doc clean-gen
492 $(Q)$(RM) -f -- $(progs) cscope.out *.o *.o.d \
493 kernel-lib/*.o kernel-lib/*.o.d \
494 image/*.o image/*.o.d \
495 convert/*.o convert/*.o.d \
496 mkfs/*.o mkfs/*.o.d \
497 dir-test ioctl-test quick-test library-test library-test-static \
498 btrfs.static mkfs.btrfs.static \
500 $(libs) $(lib_links) \
501 $(progs_static) $(progs_extra)
504 @echo "Cleaning Documentation"
505 $(Q)$(MAKE) $(MAKEOPTS) -C Documentation clean
508 @echo "Cleaning Generated Files"
509 $(Q)$(RM) -rf -- version.h config.status config.cache connfig.log \
510 configure.lineno config.status.lineno Makefile \
511 Documentation/Makefile \
512 config.log config.h config.h.in~ aclocal.m4 \
513 configure autom4te.cache/ config/
516 @echo "Cleaning $(patsubst clean-%,%,$@)"
517 $(Q)$(MAKE) $(MAKEOPTS) -C $(patsubst clean-%,%,$@) clean
519 install: $(libs) $(progs_install) $(INSTALLDIRS)
520 $(INSTALL) -m755 -d $(DESTDIR)$(bindir)
521 $(INSTALL) $(progs_install) $(DESTDIR)$(bindir)
522 $(INSTALL) fsck.btrfs $(DESTDIR)$(bindir)
523 # btrfsck is a link to btrfs in the src tree, make it so for installed file as well
524 $(LN_S) -f btrfs $(DESTDIR)$(bindir)/btrfsck
525 $(INSTALL) -m755 -d $(DESTDIR)$(libdir)
526 $(INSTALL) $(libs) $(DESTDIR)$(libdir)
527 cp -a $(lib_links) $(DESTDIR)$(libdir)
528 $(INSTALL) -m755 -d $(DESTDIR)$(incdir)
529 $(INSTALL) -m644 $(headers) $(DESTDIR)$(incdir)
531 $(INSTALL) -m755 -d $(DESTDIR)$(udevruledir)
532 $(INSTALL) -m644 $(udev_rules) $(DESTDIR)$(udevruledir)
535 install-static: $(progs_static) $(INSTALLDIRS)
536 $(INSTALL) -m755 -d $(DESTDIR)$(bindir)
537 $(INSTALL) $(progs_static) $(DESTDIR)$(bindir)
538 # btrfsck is a link to btrfs in the src tree, make it so for installed file as well
539 $(LN_S) -f btrfs.static $(DESTDIR)$(bindir)/btrfsck.static
542 @echo "Making install in $(patsubst install-%,%,$@)"
543 $(Q)$(MAKE) $(MAKEOPTS) -C $(patsubst install-%,%,$@) install
546 $(Q)$(MAKE) $(MAKEOPTS) -C Documentation uninstall
547 cd $(DESTDIR)$(incdir); $(RM) -f -- $(headers)
548 $(RMDIR) -p --ignore-fail-on-non-empty -- $(DESTDIR)$(incdir)
549 cd $(DESTDIR)$(libdir); $(RM) -f -- $(lib_links) $(libs)
550 cd $(DESTDIR)$(bindir); $(RM) -f -- btrfsck fsck.btrfs $(progs_install)
552 ifneq ($(MAKECMDGOALS),clean)
553 -include $(objects:.o=.o.d) $(cmds_objects:.o=.o.d) $(subst .btrfs,, $(filter-out btrfsck.o.d, $(progs:=.o.d)))