#!/usr/bin/env bash
# SPDX-License-Identifier: BSD-3-Clause

# "sparse" is not designed for automated testing: its exit code is
# mostly useless. So this script extracts from its output the most
# important messages instead and returns 1 if any is found.

# As of Sep. 2022, sparse's exit status is by default always zero even
# when there is an error, see check_symbols() in sparse.c. There is a
# -DEXTRA_CFLAGS=-Wsparse-error option that returns non-zero... for any
# warning even the most harmless one and it seems to stops on the first
# one. SOF has hundreds of sparse warnings now.

main()
{
    local platform="$1" # optional
    local sparse_errors=()

    >&2 printf 'Reminder: to see ALL warnings you must as usual build _from scratch_\n'

    # To reproduce an 'error: ' and test this script try commenting out
    # `defined(__CHECKER__)` in common.h.
    #
    # To reproduce the 'different address space' warning and test this
    # script try deleting a __sparse_cache annotation like the one in
    # src/audio/mixer/mixer.c

    sparse_errors+=(-e '[[:space:]]error:[[:space:]]')

    sparse_errors+=(-e '[[:space:]]warning:[[:space:]].*too many warnings')

    sparse_errors+=(-e '[[:space:]]warning:[[:space:]].*different address space')

    sparse_errors+=(-e '[[:space:]]warning:[[:space:]].*cast removes address space')

    ! grep -v 'alsatplg.*topology2.*skip' | grep -i  "${sparse_errors[@]}"

}

main "$@"