[v13,00/12] Improve test coverage of TTM

Message

Karolina Stolarek June 3, 2024, 1:36 p.m. UTC

Introduce tests for ttm_bo_validate()/ttm_bo_init_validate() that exercise
simple BO placement as well as eviction (including the case where the evict
domain also requires eviction to fit the incoming buffer). Prepare KUnit
helpers to handle such scenarios and add a mock VRAM manager. This series also
includes some updates to the helpers and more definitions used to define
"special" memory domains (e.g., one that can't allocate resources or is busy),
as well as drive-by fixes for the tests.

There are a couple of areas in which this test suite can be improved.
Suggestions for future work can be found in the TODO file.

Use kunit_tool script to manually run all the tests:

$ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm/ttm/tests

To build a kernel with TTM KUnit tests, use a UML configuration,
enable CONFIG_KUNIT, and then select CONFIG_DRM_TTM_KUNIT_TEST.

Many thanks,
Karolina

v13 (all suggestions by Thomas):
  - Drop CONFIG_DRM_BUDDY=y from .kunitconfig
  - Remove ttm_bo_wait_ctx(bo, ctx) call from the mock move, it's not needed
  - Update MODULE_LICENSE descriptions (also respectively, 11/12)
  - Use u32 and u64 types instead uint(32|64)_t (also respectively, 12/12)
  - Update TODO to describe how the mock manager can be rewritten

v12:
  - Rewrite "drm/ttm/tests: Fix a warning in ttm_bo_unreserve_bulk" patch to
    extend ttm_bo_kunit_init() helper to accept a dma_resv object and update
    calls to that helper (Christian)
  - Update drm_buddy_free_list() calls with an extra argument

v11:
  - Delete CONFIG_DRM_KUNIT_TEST_HELPERS from .kunitconfig file, as it gets
    automatically selected when TTM KUnit tests are enabled
  - Call ttm_bo_put() in ttm_bo_validate_pinned() test case (Matt)
  - Fix a copy-paste mistake in ttm_mem_type_cases definition (Matt)
  - Update mock_move definition to do a hop on VRAM -> sysmem move and
    delete a dummy multihop domain. Fix the eviction tests accordingly (Matt)
  - Update ttm_bo_validate_swapout() to use TT domain instead of VRAM
  - Update eviction test cases to create TT domain, so they can perform multihop
  - Update TODO file, as it got outdated already

Karolina Stolarek (12):
  drm/ttm/tests: Fix a warning in ttm_bo_unreserve_bulk
  drm/ttm/tests: Delete unnecessary config option
  drm/ttm/tests: Set DMA mask in KUnit device
  drm/ttm/tests: Use an init function from the helpers lib
  drm/ttm/tests: Test simple BO creation and validation
  drm/ttm/tests: Add tests with mock resource managers
  drm/ttm/tests: Add test cases dependent on fence signaling
  drm/ttm/tests: Add eviction testing
  drm/ttm/tests: Add tests for ttm_tt_populate
  drm/ttm/tests: Add TODO file
  drm/ttm/tests: Correct modules' licenses
  drm/ttm/tests: Use u32 and u64 over uint*_t types

 drivers/gpu/drm/Kconfig                       |    1 +
 drivers/gpu/drm/ttm/tests/.kunitconfig        |    1 -
 drivers/gpu/drm/ttm/tests/Makefile            |    2 +
 drivers/gpu/drm/ttm/tests/TODO                |   27 +
 drivers/gpu/drm/ttm/tests/ttm_bo_test.c       |   54 +-
 .../gpu/drm/ttm/tests/ttm_bo_validate_test.c  | 1224 +++++++++++++++++
 drivers/gpu/drm/ttm/tests/ttm_device_test.c   |    2 +-
 drivers/gpu/drm/ttm/tests/ttm_kunit_helpers.c |  180 ++-
 drivers/gpu/drm/ttm/tests/ttm_kunit_helpers.h |   17 +-
 drivers/gpu/drm/ttm/tests/ttm_mock_manager.c  |  233 ++++
 drivers/gpu/drm/ttm/tests/ttm_mock_manager.h  |   30 +
 drivers/gpu/drm/ttm/tests/ttm_pool_test.c     |    8 +-
 drivers/gpu/drm/ttm/tests/ttm_resource_test.c |   20 +-
 drivers/gpu/drm/ttm/tests/ttm_tt_test.c       |  168 ++-
 drivers/gpu/drm/ttm/ttm_tt.c                  |    3 +
 15 files changed, 1882 insertions(+), 88 deletions(-)
 create mode 100644 drivers/gpu/drm/ttm/tests/TODO
 create mode 100644 drivers/gpu/drm/ttm/tests/ttm_bo_validate_test.c
 create mode 100644 drivers/gpu/drm/ttm/tests/ttm_mock_manager.c
 create mode 100644 drivers/gpu/drm/ttm/tests/ttm_mock_manager.h