#! /bin/sh
#
# Test suite for xmalloc and friends.
#
# The canonical version of this file is maintained in the rra-c-util package,
# which can be found at .
#
# Written by Russ Allbery
# Copyright 2000-2001, 2006, 2014, 2016 Russ Allbery
# Copyright 2008-2010, 2012
# The Board of Trustees of the Leland Stanford Junior University
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
#
# SPDX-License-Identifier: MIT
. "$C_TAP_SOURCE/tap/libtap.sh"
cd "$C_TAP_BUILD/util"
# Run an xmalloc test. Takes the description, the expectd exit status, the
# output, and the arguments.
ok_xmalloc () {
local desc w_status w_output output status
desc="$1"
shift
w_status="$1"
shift
w_output="$1"
shift
output=`strip_colon_error ./xmalloc "$@" 2>&1`
status=$?
if [ $status = $w_status ] && [ x"$output" = x"$w_output" ] ; then
ok "$desc" true
elif [ $status = 2 ] ; then
diag "$output"
skip "no data limit support"
else
diag "saw: ($status) $output"
diag "not: ($w_status) $w_output"
ok "$desc" false
fi
}
# Skip this test suite unless maintainer-mode tests are enabled. All of the
# failures in automated testing have been problems with the assumptions around
# memory allocation or problems with the test suite, not problems with the
# underlying xmalloc code.
if [ -z "$AUTHOR_TESTING" ] ; then
skip_all 'xmalloc tests only run for author'
fi
# Total tests.
plan 41
# First run the tests expected to succeed.
ok_xmalloc "malloc small" 0 "" "m" "21" "0"
ok_xmalloc "malloc large" 0 "" "m" "30000000" "0"
ok_xmalloc "malloc zero" 0 "" "m" "0" "0"
ok_xmalloc "realloc small" 0 "" "r" "21" "0"
ok_xmalloc "realloc large" 0 "" "r" "30000000" "0"
ok_xmalloc "reallocarray small" 0 "" "y" "20" "0"
ok_xmalloc "reallocarray large" 0 "" "y" "30000000" "0"
ok_xmalloc "strdup small" 0 "" "s" "21" "0"
ok_xmalloc "strdup large" 0 "" "s" "30000000" "0"
ok_xmalloc "strndup small" 0 "" "n" "21" "0"
ok_xmalloc "strndup large" 0 "" "n" "30000000" "0"
ok_xmalloc "calloc small" 0 "" "c" "24" "0"
ok_xmalloc "calloc large" 0 "" "c" "30000000" "0"
ok_xmalloc "asprintf small" 0 "" "a" "24" "0"
ok_xmalloc "asprintf large" 0 "" "a" "30000000" "0"
ok_xmalloc "vasprintf small" 0 "" "v" "24" "0"
ok_xmalloc "vasprintf large" 0 "" "v" "30000000" "0"
# Now limit our memory to 30MB and then try the large ones again, all of
# which should fail.
#
# The exact memory limits used here are essentially black magic. They need to
# be large enough to allow the program to be loaded and do small allocations,
# but not so large that we can't reasonably expect to allocate that much
# memory normally. The amount of memory required varies a lot based on what
# shared libraries are loaded, and if it's too small, all memory allocations
# fail. 30MB seems to work reasonably well on both Solaris and Linux, even
# when the program is linked with additional libraries.
#
# We assume that there are enough miscellaneous allocations that an allocation
# exactly as large as the limit will always fail.
ok_xmalloc "malloc fail" 1 \
"failed to malloc 30000000 bytes at xmalloc.c line 41" \
"m" "30000000" "30000000"
ok_xmalloc "realloc fail" 1 \
"failed to realloc 30000000 bytes at xmalloc.c line 69" \
"r" "30000000" "30000000"
ok_xmalloc "reallocarray fail" 1 \
"failed to reallocarray 30000000 bytes at xmalloc.c line 99" \
"y" "30000000" "30000000"
ok_xmalloc "strdup fail" 1 \
"failed to strdup 30000000 bytes at xmalloc.c line 130" \
"s" "30000000" "30000000"
ok_xmalloc "strndup fail" 1 \
"failed to strndup 30000000 bytes at xmalloc.c line 176" \
"n" "30000000" "30000000"
ok_xmalloc "calloc fail" 1 \
"failed to calloc 30000000 bytes at xmalloc.c line 200" \
"c" "30000000" "30000000"
ok_xmalloc "asprintf fail" 1 \
"failed to asprintf 30000000 bytes at xmalloc.c line 224" \
"a" "30000000" "30000000"
ok_xmalloc "vasprintf fail" 1 \
"failed to vasprintf 30000000 bytes at xmalloc.c line 243" \
"v" "30000000" "30000000"
# Check our custom error handler.
ok_xmalloc "malloc custom" 1 "malloc 30000000 xmalloc.c 41" \
"M" "30000000" "30000000"
ok_xmalloc "realloc custom" 1 "realloc 30000000 xmalloc.c 69" \
"R" "30000000" "30000000"
ok_xmalloc "reallocarray custom" 1 "reallocarray 30000000 xmalloc.c 99" \
"Y" "30000000" "30000000"
ok_xmalloc "strdup custom" 1 "strdup 30000000 xmalloc.c 130" \
"S" "30000000" "30000000"
ok_xmalloc "strndup custom" 1 "strndup 30000000 xmalloc.c 176" \
"N" "30000000" "30000000"
ok_xmalloc "calloc custom" 1 "calloc 30000000 xmalloc.c 200" \
"C" "30000000" "30000000"
ok_xmalloc "asprintf custom" 1 "asprintf 30000000 xmalloc.c 224" \
"A" "30000000" "30000000"
ok_xmalloc "vasprintf custom" 1 "vasprintf 30000000 xmalloc.c 243" \
"V" "30000000" "30000000"
# Check the smaller ones again just for grins.
ok_xmalloc "malloc retry" 0 "" "m" "21" "30000000"
ok_xmalloc "realloc retry" 0 "" "r" "32" "30000000"
ok_xmalloc "reallocarray retry" 0 "" "y" "32" "30000000"
ok_xmalloc "strdup retry" 0 "" "s" "64" "30000000"
ok_xmalloc "strndup retry" 0 "" "n" "20" "30000000"
ok_xmalloc "calloc retry" 0 "" "c" "24" "30000000"
ok_xmalloc "asprintf retry" 0 "" "a" "30" "30000000"
ok_xmalloc "vasprintf retry" 0 "" "v" "35" "30000000"