malloc/Makefile

   1 # Copyright (C) 1991-2023 Free Software Foundation, Inc.
   2 # This file is part of the GNU C Library.
   3
   4 # The GNU C Library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License, or (at your option) any later version.
   8
   9 # The GNU C Library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with the GNU C Library; if not, see
  16 # <https://www.gnu.org/licenses/>.
  17
  18 #
  19 #       Makefile for malloc routines
  20 #
  21 subdir  := malloc
  22
  23 include ../Makeconfig
  24
  25 dist-headers := malloc.h
  26 headers := $(dist-headers) obstack.h mcheck.h
  27 tests := mallocbug tst-malloc tst-valloc tst-calloc tst-obstack \
  28          tst-malloc-check tst-mallocfork tst-trim1 \
  29          tst-malloc-usable tst-realloc tst-reallocarray tst-posix_memalign \
  30          tst-pvalloc tst-pvalloc-fortify tst-memalign tst-mallopt \
  31          tst-malloc-backtrace tst-malloc-thread-exit \
  32          tst-malloc-thread-fail tst-malloc-fork-deadlock \
  33          tst-mallocfork2 \
  34          tst-mallocfork3 \
  35          tst-interpose-nothread \
  36          tst-interpose-thread \
  37          tst-alloc_buffer \
  38          tst-free-errno \
  39          tst-malloc-tcache-leak \
  40          tst-malloc_info tst-mallinfo2 \
  41          tst-malloc-too-large \
  42          tst-malloc-stats-cancellation \
  43          tst-tcfree1 tst-tcfree2 tst-tcfree3 \
  44          tst-safe-linking \
  45          tst-mallocalign1 \
  46          tst-memalign-2 \
  47          tst-memalign-3
  48
  49 tests-static := \
  50          tst-interpose-static-nothread \
  51          tst-interpose-static-thread
  52
  53 # Test for the malloc_set_state symbol removed in glibc 2.25.
  54 ifeq ($(have-GLIBC_2.23)$(build-shared),yesyes)
  55 tests += tst-mallocstate tst-compathooks-off tst-compathooks-on
  56 endif
  57
  58 tests-internal := tst-scratch_buffer
  59
  60 # The dynarray framework is only available inside glibc.
  61 tests-internal += \
  62          tst-dynarray \
  63          tst-dynarray-fail \
  64          tst-dynarray-at-fail \
  65
  66 tests += tst-malloc-usable-tunables tst-mxfast
  67
  68 tests += $(tests-static)
  69 test-srcs = tst-mtrace
  70
  71 # These tests either are run with MALLOC_CHECK_=3 by default or do not work
  72 # with MALLOC_CHECK_=3 because they expect a specific failure.
  73 tests-exclude-malloc-check = tst-malloc-check tst-malloc-usable \
  74         tst-mxfast tst-safe-linking \
  75         tst-compathooks-off tst-compathooks-on tst-memalign-2 tst-memalign-3
  76
  77 # Run all tests with MALLOC_CHECK_=3
  78 tests-malloc-check = $(filter-out $(tests-exclude-malloc-check) \
  79                                   $(tests-static),$(tests))
  80
  81 # Run all tests with GLIBC_TUNABLES=glibc.malloc.hugetlb={1,2} which check
  82 # the Transparent Huge Pages support (1) or automatic huge page support (2).
  83 # We need exclude some tests that define the ENV vars.
  84 tests-exclude-hugetlb1 = \
  85         tst-compathooks-off \
  86         tst-compathooks-on \
  87         tst-interpose-nothread \
  88         tst-interpose-thread \
  89         tst-interpose-static-nothread \
  90         tst-interpose-static-thread \
  91         tst-malloc-usable \
  92         tst-malloc-usable-tunables \
  93         tst-mallocstate
  94 # The tst-free-errno relies on the used malloc page size to mmap an
  95 # overlapping region.
  96 tests-exclude-hugetlb2 = \
  97         $(tests-exclude-hugetlb1) \
  98         tst-free-errno
  99 tests-malloc-hugetlb1 = \
 100         $(filter-out $(tests-exclude-hugetlb1), $(tests))
 101 tests-malloc-hugetlb2 = \
 102         $(filter-out $(tests-exclude-hugetlb2), $(tests))
 103
 104 # -lmcheck needs __malloc_initialize_hook, which was deprecated in 2.24.
 105 ifeq ($(have-GLIBC_2.23)$(build-shared),yesyes)
 106 # Tests that don't play well with mcheck.  They are either bugs in mcheck or
 107 # the tests expect specific internal behavior that is changed due to linking to
 108 # libmcheck.a.
 109 tests-exclude-mcheck = tst-mallocstate \
 110         tst-safe-linking \
 111         tst-malloc-backtrace \
 112         tst-malloc-fork-deadlock \
 113         tst-malloc-stats-cancellation \
 114         tst-malloc-tcache-leak \
 115         tst-malloc-thread-exit \
 116         tst-malloc-thread-fail \
 117         tst-malloc-usable-tunables \
 118         tst-malloc_info \
 119         tst-compathooks-off tst-compathooks-on \
 120         tst-memalign-2 \
 121         tst-memalign-3 \
 122         tst-mxfast
 123
 124 tests-mcheck = $(filter-out $(tests-exclude-mcheck) $(tests-static), $(tests))
 125 endif
 126
 127 routines = malloc mcheck mtrace obstack reallocarray \
 128   scratch_buffer_grow scratch_buffer_grow_preserve \
 129   scratch_buffer_set_array_size \
 130   dynarray_at_failure \
 131   dynarray_emplace_enlarge \
 132   dynarray_finalize \
 133   dynarray_resize \
 134   dynarray_resize_clear \
 135   alloc_buffer_alloc_array \
 136   alloc_buffer_allocate \
 137   alloc_buffer_copy_bytes  \
 138   alloc_buffer_copy_string \
 139   alloc_buffer_create_failure \
 140
 141 install-lib := libmcheck.a
 142 non-lib.a := libmcheck.a
 143
 144 # Additional libraries.
 145 extra-libs = libmemusage libc_malloc_debug
 146 extra-libs-others = $(extra-libs)
 147
 148 # Helper objects for some tests.
 149 extra-test-objs += \
 150   tst-interpose-aux-nothread.o \
 151   tst-interpose-aux-thread.o \
 152
 153 test-extras = \
 154   tst-interpose-aux-nothread \
 155   tst-interpose-aux-thread \
 156
 157 libmemusage-routines = memusage
 158 libmemusage-inhibit-o = $(filter-out .os,$(object-suffixes))
 159
 160 libc_malloc_debug-routines = malloc-debug $(sysdep_malloc_debug_routines)
 161 libc_malloc_debug-inhibit-o = $(filter-out .os,$(object-suffixes))
 162
 163 $(objpfx)tst-malloc-backtrace: $(shared-thread-library)
 164 $(objpfx)tst-malloc-thread-exit: $(shared-thread-library)
 165 $(objpfx)tst-malloc-thread-fail: $(shared-thread-library)
 166 $(objpfx)tst-mallocfork3: $(shared-thread-library)
 167 $(objpfx)tst-mallocfork3-mcheck: $(shared-thread-library)
 168 $(objpfx)tst-malloc-fork-deadlock: $(shared-thread-library)
 169 $(objpfx)tst-malloc-stats-cancellation: $(shared-thread-library)
 170 $(objpfx)tst-malloc-backtrace-mcheck: $(shared-thread-library)
 171 $(objpfx)tst-malloc-thread-exit-mcheck: $(shared-thread-library)
 172 $(objpfx)tst-malloc-thread-fail-mcheck: $(shared-thread-library)
 173 $(objpfx)tst-malloc-fork-deadlock-mcheck: $(shared-thread-library)
 174 $(objpfx)tst-malloc-stats-cancellation-mcheck: $(shared-thread-library)
 175 $(objpfx)tst-mallocfork3-malloc-check: $(shared-thread-library)
 176 $(objpfx)tst-malloc-backtrace-malloc-check: $(shared-thread-library)
 177 $(objpfx)tst-malloc-thread-exit-malloc-check: $(shared-thread-library)
 178 $(objpfx)tst-malloc-thread-fail-malloc-check: $(shared-thread-library)
 179 $(objpfx)tst-malloc-fork-deadlock-malloc-check: $(shared-thread-library)
 180 $(objpfx)tst-malloc-stats-cancellation-malloc-check: $(shared-thread-library)
 181 $(objpfx)tst-malloc-thread-exit-malloc-hugetlb1: $(shared-thread-library)
 182 $(objpfx)tst-malloc-thread-fail-malloc-hugetlb1: $(shared-thread-library)
 183 $(objpfx)tst-mallocfork2-malloc-hugetlb1: $(shared-thread-library)
 184 $(objpfx)tst-mallocfork3-malloc-hugetlb1: $(shared-thread-library)
 185 $(objpfx)tst-malloc-fork-deadlock-malloc-hugetlb1: $(shared-thread-library)
 186 $(objpfx)tst-malloc-stats-cancellation-malloc-hugetlb1: $(shared-thread-library)
 187 $(objpfx)tst-malloc-thread-exit-malloc-hugetlb2: $(shared-thread-library)
 188 $(objpfx)tst-malloc-thread-fail-malloc-hugetlb2: $(shared-thread-library)
 189 $(objpfx)tst-mallocfork2-malloc-hugetlb2: $(shared-thread-library)
 190 $(objpfx)tst-mallocfork3-malloc-hugetlb2: $(shared-thread-library)
 191 $(objpfx)tst-malloc-fork-deadlock-malloc-hugetlb2: $(shared-thread-library)
 192 $(objpfx)tst-malloc-stats-cancellation-malloc-hugetlb2: $(shared-thread-library)
 193
 194 # These should be removed by `make clean'.
 195 extra-objs = mcheck-init.o libmcheck.a
 196 others-extras = mcheck-init.o
 197
 198 # Include the cleanup handler.
 199 aux := set-freeres thread-freeres
 200
 201 # The Perl script to analyze the output of the mtrace functions.
 202 ifneq ($(PERL),no)
 203 install-bin-script = mtrace
 204 generated += mtrace
 205
 206 # The Perl script will print addresses and to do this nicely we must know
 207 # whether we are on a 32 or 64 bit machine.
 208 ifneq ($(findstring wordsize-32,$(config-sysdirs)),)
 209 address-width=10
 210 else
 211 address-width=18
 212 endif
 213 endif
 214
 215 # Unless we get a test for the availability of libgd which also works
 216 # for cross-compiling we disable the memusagestat generation in this
 217 # situation.
 218 ifneq ($(cross-compiling),yes)
 219 # If the gd library is available we build the `memusagestat' program.
 220 ifneq ($(LIBGD),no)
 221 others: $(objpfx)memusage
 222 others += memusagestat
 223 install-bin = memusagestat
 224 install-bin-script += memusage
 225 generated += memusagestat memusage
 226 extra-objs += memusagestat.o
 227
 228 # The configure.ac check for libgd and its headers did not use $SYSINCLUDES.
 229 # The directory specified by --with-headers usually contains only the basic
 230 # kernel interface headers, not something like libgd.  So the simplest thing
 231 # is to presume that the standard system headers will be ok for this file.
 232 $(objpfx)memusagestat.o: sysincludes = # nothing
 233 endif
 234 endif
 235
 236 # Another goal which can be used to override the configure decision.
 237 .PHONY: do-memusagestat
 238 do-memusagestat: $(objpfx)memusagestat
 239
 240 memusagestat-modules = memusagestat
 241
 242 cpp-srcs-left := $(memusagestat-modules)
 243 lib := memusagestat
 244 include $(patsubst %,$(..)libof-iterator.mk,$(cpp-srcs-left))
 245
 246 LDLIBS-memusagestat = $(libgd-LDFLAGS) -lgd -lpng -lz -lm
 247
 248 ifeq ($(run-built-tests),yes)
 249 ifeq (yes,$(build-shared))
 250 ifneq ($(PERL),no)
 251 tests-special += $(objpfx)tst-mtrace.out
 252 tests-special += $(objpfx)tst-dynarray-mem.out
 253 tests-special += $(objpfx)tst-dynarray-fail-mem.out
 254 endif
 255 endif
 256 endif
 257
 258 include ../Rules
 259
 260 CFLAGS-mcheck-init.c += $(PIC-ccflag)
 261 CFLAGS-obstack.c += $(uses-callbacks)
 262
 263 $(objpfx)libmcheck.a: $(objpfx)mcheck-init.o
 264         -rm -f $@
 265         $(patsubst %/,cd % &&,$(objpfx)) \
 266         $(LN_S) $(<F) $(@F)
 267
 268 lib: $(objpfx)libmcheck.a
 269
 270 ifeq ($(run-built-tests),yes)
 271 ifeq (yes,$(build-shared))
 272 ifneq ($(PERL),no)
 273 $(objpfx)tst-mtrace.out: tst-mtrace.sh $(objpfx)tst-mtrace
 274         $(SHELL) $< $(common-objpfx) '$(test-program-prefix-before-env)' \
 275                  '$(run-program-env)' '$(test-program-prefix-after-env)'; \
 276         $(evaluate-test)
 277 endif
 278 endif
 279 endif
 280
 281 tst-malloc-check-ENV = MALLOC_CHECK_=3 \
 282                        LD_PRELOAD=$(objpfx)/libc_malloc_debug.so
 283 tst-malloc-usable-ENV = MALLOC_CHECK_=3 \
 284                        LD_PRELOAD=$(objpfx)/libc_malloc_debug.so
 285 tst-malloc-usable-tunables-ENV = GLIBC_TUNABLES=glibc.malloc.check=3 \
 286                                  LD_PRELOAD=$(objpfx)/libc_malloc_debug.so
 287
 288 tst-mxfast-ENV = GLIBC_TUNABLES=glibc.malloc.tcache_count=0:glibc.malloc.mxfast=0
 289
 290 CPPFLAGS-malloc-debug.c += -DUSE_TCACHE=0
 291 CPPFLAGS-malloc.c += -DUSE_TCACHE=1
 292 # Uncomment this for test releases.  For public releases it is too expensive.
 293 #CPPFLAGS-malloc.o += -DMALLOC_DEBUG=1
 294
 295 sLIBdir := $(shell echo $(slibdir) | sed 's,lib\(\|64\)$$,\\\\$$LIB,')
 296
 297 $(objpfx)mtrace: mtrace.pl
 298         rm -f $@.new
 299         sed -e 's|@PERL@|$(PERL)|' -e 's|@XXX@|$(address-width)|' \
 300             -e 's|@VERSION@|$(version)|' \
 301             -e 's|@PKGVERSION@|$(PKGVERSION)|' \
 302             -e 's|@REPORT_BUGS_TO@|$(REPORT_BUGS_TO)|' $^ > $@.new \
 303         && rm -f $@ && mv $@.new $@ && chmod +x $@
 304
 305 $(objpfx)memusage: memusage.sh
 306         rm -f $@.new
 307         sed -e 's|@VERSION@|$(version)|' -e 's|@SLIBDIR@|$(sLIBdir)|' \
 308             -e 's|@BINDIR@|$(bindir)|' -e 's|@PKGVERSION@|$(PKGVERSION)|' \
 309             -e 's|@REPORT_BUGS_TO@|$(REPORT_BUGS_TO)|' $^ > $@.new \
 310         && rm -f $@ && mv $@.new $@ && chmod +x $@
 311
 312 # Compile the tests with a flag which suppresses the mallopt call in
 313 # the test skeleton.
 314 $(tests:%=$(objpfx)%.o): CPPFLAGS += -DTEST_NO_MALLOPT
 315
 316 $(objpfx)tst-interpose-nothread: $(objpfx)tst-interpose-aux-nothread.o
 317 $(objpfx)tst-interpose-nothread-mcheck: $(objpfx)tst-interpose-aux-nothread.o
 318 $(objpfx)tst-interpose-nothread-malloc-check: \
 319         $(objpfx)tst-interpose-aux-nothread.o
 320 $(objpfx)tst-interpose-thread: \
 321   $(objpfx)tst-interpose-aux-thread.o $(shared-thread-library)
 322 $(objpfx)tst-interpose-thread-mcheck: \
 323   $(objpfx)tst-interpose-aux-thread.o $(shared-thread-library)
 324 $(objpfx)tst-interpose-thread-malloc-check: \
 325   $(objpfx)tst-interpose-aux-thread.o $(shared-thread-library)
 326 $(objpfx)tst-interpose-static-nothread: $(objpfx)tst-interpose-aux-nothread.o
 327 $(objpfx)tst-interpose-static-thread: \
 328   $(objpfx)tst-interpose-aux-thread.o $(static-thread-library)
 329
 330 tst-dynarray-ENV = MALLOC_TRACE=$(objpfx)tst-dynarray.mtrace \
 331                    LD_PRELOAD=$(objpfx)libc_malloc_debug.so
 332 $(objpfx)tst-dynarray-mem.out: $(objpfx)tst-dynarray.out
 333         $(common-objpfx)malloc/mtrace $(objpfx)tst-dynarray.mtrace > $@; \
 334         $(evaluate-test)
 335
 336 tst-dynarray-fail-ENV = MALLOC_TRACE=$(objpfx)tst-dynarray-fail.mtrace \
 337                         LD_PRELOAD=$(objpfx)libc_malloc_debug.so
 338 $(objpfx)tst-dynarray-fail-mem.out: $(objpfx)tst-dynarray-fail.out
 339         $(common-objpfx)malloc/mtrace $(objpfx)tst-dynarray-fail.mtrace > $@; \
 340         $(evaluate-test)
 341
 342 $(objpfx)tst-malloc-tcache-leak: $(shared-thread-library)
 343 $(objpfx)tst-malloc_info: $(shared-thread-library)
 344 $(objpfx)tst-mallocfork2: $(shared-thread-library)
 345 $(objpfx)tst-malloc-tcache-leak-mcheck: $(shared-thread-library)
 346 $(objpfx)tst-malloc_info-mcheck: $(shared-thread-library)
 347 $(objpfx)tst-mallocfork2-mcheck: $(shared-thread-library)
 348 $(objpfx)tst-malloc-tcache-leak-malloc-check: $(shared-thread-library)
 349 $(objpfx)tst-malloc_info-malloc-check: $(shared-thread-library)
 350 $(objpfx)tst-mallocfork2-malloc-check: $(shared-thread-library)
 351 $(objpfx)tst-malloc-tcache-leak-malloc-hugetlb1: $(shared-thread-library)
 352 $(objpfx)tst-malloc-tcache-leak-malloc-hugetlb2: $(shared-thread-library)
 353 $(objpfx)tst-malloc_info-malloc-hugetlb1: $(shared-thread-library)
 354 $(objpfx)tst-malloc_info-malloc-hugetlb2: $(shared-thread-library)
 355
 356 tst-compathooks-on-ENV = LD_PRELOAD=$(objpfx)libc_malloc_debug.so
 357 tst-compathooks-on-mcheck-ENV = LD_PRELOAD=$(objpfx)libc_malloc_debug.so
 358 tst-compathooks-on-malloc-check-ENV = \
 359         LD_PRELOAD=$(objpfx)libc_malloc_debug.so
 360 tst-mallocstate-ENV = LD_PRELOAD=$(objpfx)libc_malloc_debug.so
 361 tst-mallocstate-malloc-check-ENV = LD_PRELOAD=$(objpfx)libc_malloc_debug.so
 362
 363 # The test needs malloc_get_state/malloc_set_state which is in
 364 # libc_malloc_debug.so.
 365 $(objpfx)tst-mallocstate: $(objpfx)libc_malloc_debug.so
 366 $(objpfx)tst-mallocstate-malloc-check: $(objpfx)libc_malloc_debug.so