Files
Alex Waterman 5f0fdf085c nvgpu: unit: Add new mock register framework
Many tests used various incarnations of the mock register framework.
This was based on a dump of gv11b registers. Tests that greatly
benefitted from having generally sane register values all rely
heavily on this framework.

However, every test essentially did their own thing. This was not
efficient and has caused a some issues in cleaning up the device and
host code.

Therefore introduce a much leaner and simplified register framework.
All unit tests now automatically get a good subset of the gv11b
registers auto-populated. As part of this also populate the HAL with
a nvgpu_detect_chip() call. Many tests can now _probably_ have all
their HAL init (except dummy HAL stuff) deleted. But this does
require a few fixups here and there to set HALs to NULL where tests
expect HALs to be NULL by default.

Where necessary HALs are cleared with a memset to prevent unwanted
code from executing.

Overall, this imposes a far smaller burden on tests to initialize
their environments.

Something to consider for the future, though, is how to handle
supporting multiple chips in the unit test world.

JIRA NVGPU-5422

Change-Id: Icf1a63f728e9c5671ee0fdb726c235ffbd2843e2
Signed-off-by: Alex Waterman <alexw@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2335334
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
2020-12-15 14:13:28 -06:00

175 lines
5.8 KiB
Makefile

# Copyright (c) 2018-2020, NVIDIA CORPORATION. All rights reserved.
#
# 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.
# TODO:
# - Separate rule for nvgpu_unit shared library
# - Proper header dependency checking.
# Turn off suffix rules. They are deprecated.
.SUFFIXES:
# Full paths. Makes submakefiles easier. That said this make file _must_ be run
# from <NVGPU>/userspace/.
TWD=$(CURDIR)
# Top level out dir.
OUT=$(TWD)/build
# Core unit test framework.
CORE_SRC=$(TWD)/src
CORE_OUT=$(OUT)/nvgpu_unit_core
# Nvgpu driver code.
NVGPU_SRC=$(TWD)/../drivers/gpu/nvgpu
# Nvgpu-next driver code.
NVGPU_NEXT_SRC=$(TWD)/../../nvgpu-next/drivers/gpu/nvgpu
NVGPU_OUT=$(OUT)/libnvgpu
# Unit tests themselves.
UNIT_SRC=$(TWD)/units
UNIT_OUT=$(OUT)/units
INCLUDES= \
-I$(NVGPU_SRC) \
-I$(NVGPU_SRC)/include \
-I$(NVGPU_NEXT_SRC) \
-I$(NVGPU_NEXT_SRC)/include \
-I$(TWD)/../include \
-I$(TWD)/../include/uapi \
-I$(TWD)/include \
# This is safety build by default.
NV_BUILD_CONFIGURATION_IS_SAFETY=1
# This Makefile is only for host POSIX builds
NVGPU_POSIX=1
# Enable fault injection for unit tests
NVGPU_FAULT_INJECTION_ENABLEMENT=1
# Linux configs. We want these so that we can mirror builds from the actual
# Linux kernel.
# include Makefile.configs
CONFIGS := -D__NVGPU_POSIX__ \
-DNVGPU_UNITTEST_FAULT_INJECTION_ENABLEMENT \
-D__NVGPU_UNIT_TEST__
# safety-debug profile is used by default
NVGPU_FORCE_SAFETY_PROFILE := 1
NVGPU_FORCE_DEBUG_PROFILE := 1
include $(NVGPU_SRC)/Makefile.shared.configs
CONFIGS+=$(NVGPU_COMMON_CFLAGS)
# Compiler, c-flags, etc.
# CC = clang
CC = gcc
CFLAGS = -Wall -Wextra -ggdb -Werror -Wno-unused-parameter \
-Wno-missing-field-initializers -Wformat -Wchar-subscripts \
-Wparentheses -Wtrigraphs -Wpointer-arith -Wmissing-declarations \
-Wmissing-prototypes -Wredundant-decls -Wmain -Wreturn-type \
-Wmultichar -Wunused -Wmissing-braces -Wstrict-aliasing \
-Wsign-compare -Waddress -Wno-unused-local-typedefs -fPIC \
-Wno-maybe-uninitialized $(INCLUDES) $(CONFIGS)
LIB_PATHS = -L$(OUT) -L$(UNIT_OUT)
LIBS = -lpthread -pthread -lgcov -ldl
# NV_IS_COVERITY is used by violation whitelisting macros which use pragma
# directives. Whitelisting is only enabled when a coverity scan is being run.
ifeq ($(NV_BUILD_CONFIGURATION_IS_COVERITY),1)
CFLAGS += -Wno-unknown-pragmas
CONFIGS += -DNV_IS_COVERITY
endif
# Source files. We expect $(OBJS) and $(HEADERS) to get filled in here.
include Makefile.sources
all: $(OUT)/nvgpu_unit $(UNITS)
# Convenience targets.
.PHONY: libnvgpu core units
libnvgpu: $(OUT)/libnvgpu-drv-igpu.so
core: $(OUT)/nvgpu_unit
units: $(UNITS)
# Note the weird libnvgpu_unit.so file: this is a bit of a hack. It lets the
# unit tests link back against the nvgpu_unit executable so that they can call
# functions (like unit_info()) directly. This shared library isn't actually
# used for anything beyond that.
#
# Also it really should have its own rule...
$(OUT)/nvgpu_unit: $(OUT)/libnvgpu-drv-igpu.so $(CORE_OBJS)
$(CC) -shared -o $(OUT)/libnvgpu_unit.so \
$(CORE_OBJS) $(LIB_PATHS) $(LIBS)
$(CC) --coverage \
-o $(OUT)/nvgpu_unit $(CORE_OBJS) $(LIB_PATHS) $(LIBS)
$(OUT)/libnvgpu-drv-igpu.so: $(OBJS)
$(CC) -shared -Wl,--no-undefined -o $(OUT)/libnvgpu-drv-igpu.so $(OBJS) -lgcov -rdynamic -lpthread
# Default build target for all the nvgpu driver object files we want to build in
# userspace. These get bundled into libnvgpu-drv-igpu.so.
$(NVGPU_OUT)/%.o : $(NVGPU_SRC)/%.c $(HEADERS)
@if [ ! -d $(dir $@) ] ; then \
mkdir -p $(dir $@) ; \
fi
$(CC) --coverage $(CFLAGS) -c -o $@ $<
# Default build target for all the nvgpu-next driver object files we want to
# build in userspace. These too get bundled into libnvgpu-drv-igpu.so.
$(NVGPU_OUT)/%.o : $(NVGPU_NEXT_SRC)/%.c $(HEADERS) $(HEADERS_NEXT)
@if [ ! -d $(dir $@) ] ; then \
mkdir -p $(dir $@) ; \
fi
$(CC) --coverage $(CFLAGS) $(configs) -c -o $@ $<
# Build target for unit test files. These are not part of the libnvgpu-drv-igpu.so.
# These comprise the unit test framework.
$(CORE_OUT)/%.o : $(CORE_SRC)/%.c $(CORE_HEADERS)
@if [ ! -d $(dir $@) ] ; then \
mkdir -p $(dir $@) ; \
fi
$(CC) --coverage $(CFLAGS) -c -o $@ $<
# Certain variables should be exported to the unit test module builds.
export TWD INCLUDES CONFIGS UNIT_SRC UNIT_OUT
export CC CFLAGS LIB_PATHS LIBS
.PHONY: $(UNITS)
$(UNITS): $(OUT)/libnvgpu-drv-igpu.so
@echo "Building unit module: $@"
@+$(MAKE) --no-print-directory -C $@
.PHONY: clean nvgpu_clean core_clean unit_clean
clean: nvgpu_clean core_clean unit_clean
rm -rf $(OUT)
nvgpu_clean:
rm -rf $(OUT)/libnvgpu*
core_clean:
rm -rf $(OUT)/nvgpu_unit*
unit_clean:
@for d in $(UNITS); do \
echo Cleaning $$d; \
$(MAKE) --no-print-directory -C $$d clean; \
done
rm -rf $(OUT)/units