* [PATCH v5 1/4] lib: Add generic platform filtering framework
2026-08-05 20:28 [PATCH v5 0/4] Add platform filtering framework for IGT tests vitaly.prosyak
@ 2026-08-05 20:28 ` vitaly.prosyak
2026-08-05 20:28 ` [PATCH v5 2/4] lib/amdgpu: Add AMD platform filtering backend vitaly.prosyak
` (3 subsequent siblings)
4 siblings, 0 replies; 7+ messages in thread
From: vitaly.prosyak @ 2026-08-05 20:28 UTC (permalink / raw)
To: igt-dev
Cc: kamil.konieczny, pawel.sikora, jani.nikula, jesse.zhang,
christian.koenig, alexander.deucher, Vitaly Prosyak,
Krzysztof Karas
From: Vitaly Prosyak <vitaly.prosyak@amd.com>
Implement vendor-agnostic platform filtering system that allows any
vendor to plug in platform-specific test skipping logic via callbacks.
Key design elements:
- struct platform_filter_ops: vendor callback interface
- struct platform_skip_entry: vendor-neutral skip rule representation
- enum skip_source: three-tier priority (built-in, config, env)
- API functions: init, should_skip, require, dump
Platform filtering is automatic - tests only need to call
platform_filter_init() once in igt_fixture. The IGT framework
automatically checks each subtest before execution via __igt_run_subtest().
Example usage:
igt_fixture {
vendor_platform_filter_init(platform_info);
}
igt_subtest("test") {
// Automatic filtering - no manual call needed!
test_code();
}
Cc: Kamil Konieczny <kamil.konieczny@linux.intel.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Jesse Zhang <jesse.zhang@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Krzysztof Karas <krzysztof.karas@intel.com>
v5 changes (addressing Kamil Konieczny's review):
-This combines both the interface (header) and implementation in a
-single commit as requested by Kamil Konieczny.
-**IMPORTANT**: This commit is generic and vendor-agnostic, containing
-NO AMD-specific implementation. The AMD backend is in a separate commit
-(patch 2/6 "lib/amdgpu: Add AMD platform filtering backend").
- Reorganize and improve commit content.
- Squash patch 3: Add platform filter initialization check to fix
incremental compilation.
v4 changes (addressing Krzysztof Karas detailed review of v3):
- Fixed documentation comment placement - ALL moved before functions
- Reorganized commit message for clarity (v4 changes first)
- Added prominent note that this is generic (no vendor code)
- Proper [PATCH v4 X/Y] format using git format-patch --subject-prefix
v3 changes (addressing Kamil Konieczny's review):
- Squashed header and implementation into single commit
- Removed unnecessary comment "Function prototypes..." from header
- Comprehensive documentation in separate commit
(docs/platform_filtering.md)
- Automatic filtering via __igt_run_subtest() hook (no manual require
calls)
- Fixed code style: include order, SPDX style, checkpatch clean
- Removed unnecessary newlines before single-statement returns
Design rationale (addresses feedback from original RFC discussion):
This implementation addresses feedback from multiple reviewers on the
original RFC patch series.
1. Jani Nikula requested vendor-agnostic design:
"I would have expected an attempt to make an IGT shared filtering
system generic enough to plug into any vendor's platforms."
Resolution: Implemented vendor-agnostic callback-based design via
platform_filter_ops structure. Any vendor (Intel, AMD, Qualcomm, etc.)
can provide their own backend without modifying core framework.
2. Kamil Konieczny requested config file support:
a) "Add also example with config file as env vars are not convenient
for large tests lists"
Resolution: Comprehensive documentation added in patch 5/6
(docs/platform_filtering.md) showing config file as RECOMMENDED
method with real-world examples, wildcards, and best practices.
b) "imho you can get test name in require, no need to repeat it"
Resolution: Went further - v3 removes igt_platform_require()
entirely. Filtering is now automatic via __igt_run_subtest() hook
in patch 4/6. Zero manual calls needed in subtests.
c) Code style (include order, alignment, igt_debug vs igt_info)
Resolution: Fixed in v3. Includes alphabetically ordered, SPDX
headers use // style, checkpatch clean.
d) "No need for this comment" (function prototypes comment)
Resolution: Removed unnecessary comment from header file.
e) "Please squash this into second patch"
Resolution: Header and implementation now in single commit.
3. Multi-GPU support (integrated + discrete):
Current design queries platform once in igt_fixture. For multi-GPU
scenarios, tests can call platform_filter_init() per-device with
device-specific platform_info.
Signed-off-by: Vitaly Prosyak <vitaly.prosyak@amd.com>
Change-Id: I389d8a4e5bd67cdd00ac625c64b24e4d9b092e17
---
lib/igt_platform_filter.c | 574 ++++++++++++++++++++++++++++++++++++++
lib/igt_platform_filter.h | 124 ++++++++
lib/meson.build | 1 +
3 files changed, 699 insertions(+)
create mode 100644 lib/igt_platform_filter.c
create mode 100644 lib/igt_platform_filter.h
diff --git a/lib/igt_platform_filter.c b/lib/igt_platform_filter.c
new file mode 100644
index 000000000..0b9452c40
--- /dev/null
+++ b/lib/igt_platform_filter.c
@@ -0,0 +1,574 @@
+// SPDX-License-Identifier: MIT
+// Copyright 2026 Advanced Micro Devices, Inc.
+/*
+ * Generic platform-based test filtering framework
+ *
+ * This is a vendor-agnostic filtering system. Vendor-specific logic
+ * is implemented via platform_filter_ops callbacks.
+ */
+
+#include <ctype.h>
+#include <fnmatch.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "igt.h"
+#include "igt_platform_filter.h"
+
+/* Maximum entries from config file and env variable */
+#define MAX_CONFIG_ENTRIES 256
+#define MAX_ENV_ENTRIES 128
+#define MAX_LINE_LENGTH 512
+
+/* Filter context - holds all runtime state (no globals) */
+struct platform_filter_context {
+ const struct platform_filter_ops *ops;
+ const void *platform_info;
+
+ struct platform_skip_entry config_entries[MAX_CONFIG_ENTRIES];
+ int config_entry_count;
+
+ struct platform_skip_entry env_entries[MAX_ENV_ENTRIES];
+ int env_entry_count;
+
+ bool initialized;
+ char current_platform_name[64];
+};
+
+/* Single static instance - initialized on first use */
+static struct platform_filter_context *get_filter_context(void)
+{
+ static struct platform_filter_context ctx = {0};
+
+ return &ctx;
+}
+
+/*
+ * ================================================================
+ * HELPER FUNCTIONS
+ * ================================================================ */
+
+/* Helper: Trim whitespace from string */
+static char *trim(char *str)
+{
+ char *end;
+
+ while (isspace(*str))
+ str++;
+
+ if (*str == 0)
+ return str;
+
+ end = str + strlen(str) - 1;
+ while (end > str && isspace(*end))
+ end--;
+
+ *(end + 1) = 0;
+ return str;
+}
+
+/* Helper: Match wildcard or exact string */
+static bool match_string(const char *pattern, const char *str)
+{
+ if (!pattern || !str)
+ return false;
+
+ if (strcmp(pattern, "*") == 0)
+ return true;
+ return fnmatch(pattern, str, 0) == 0;
+}
+
+/* Helper: Check if entry matches platform/test/subtest */
+static bool entry_matches(const struct platform_filter_context *ctx,
+ const struct platform_skip_entry *entry,
+ const char *test_name,
+ const char *subtest_name)
+{
+ if (entry->platform_data && ctx->ops->match_platform) {
+ if (!ctx->ops->match_platform(ctx->platform_info, entry->platform_data))
+ return false;
+ }
+
+ if (entry->test_name && strcmp(entry->test_name, "*") != 0) {
+ if (!test_name || !match_string(entry->test_name, test_name))
+ return false;
+ }
+
+ if (entry->subtest_glob && strcmp(entry->subtest_glob, "*") != 0) {
+ if (!subtest_name || !match_string(entry->subtest_glob, subtest_name))
+ return false;
+ }
+ return true;
+}
+
+/*
+ * ================================================================
+ * CONFIG FILE PARSER (/etc/igt/platform_skip.conf)
+ * ================================================================ */
+
+/* Parse one line from config file */
+static bool parse_config_line(struct platform_filter_context *ctx,
+ char *line,
+ struct platform_skip_entry *entry)
+{
+ char *platform, *test, *subtest, *reason;
+
+ /* Skip comments and empty lines */
+ line = trim(line);
+ if (line[0] == '#' || line[0] == 0)
+ return false;
+
+ /* Format: platform:test:subtest:reason */
+ platform = strtok(line, ":");
+ test = strtok(NULL, ":");
+ subtest = strtok(NULL, ":");
+ reason = strtok(NULL, "\n");
+
+ if (!platform || !test || !subtest) {
+ igt_warn("Invalid config line format (expected platform:test:subtest:reason)\n");
+ return false;
+ }
+
+ /* Allocate and copy strings */
+ entry->test_name = strdup(trim(test));
+ entry->subtest_glob = strdup(trim(subtest));
+ entry->reason = reason ? strdup(trim(reason)) : strdup("No reason");
+
+ /* Parse platform using vendor callback */
+ platform = trim(platform);
+ if (ctx->ops->parse_platform_config && strcmp(platform, "*") != 0) {
+ /* Vendor-specific platform string */
+ if (!ctx->ops->parse_platform_config(platform, &entry->platform_data)) {
+ igt_warn("Failed to parse platform: %s\n", platform);
+ free((void *)entry->test_name);
+ free((void *)entry->subtest_glob);
+ free((void *)entry->reason);
+ return false;
+ }
+ } else {
+ /* Wildcard or no vendor-specific parsing available */
+ entry->platform_data = NULL;
+ }
+ return true;
+}
+
+/* Load config file */
+static void load_config_file(struct platform_filter_context *ctx, const char *filename)
+{
+ FILE *f;
+ char line[MAX_LINE_LENGTH];
+
+ f = fopen(filename, "r");
+ if (!f) {
+ igt_debug("Config file not found: %s\n", filename);
+
+ return;
+ }
+
+ igt_info("Loading platform skip config from: %s\n", filename);
+
+ while (fgets(line, sizeof(line), f)) {
+ if (ctx->config_entry_count >= MAX_CONFIG_ENTRIES) {
+ igt_warn("Config file has too many entries (max %d)\n",
+ MAX_CONFIG_ENTRIES);
+ break;
+ }
+
+ if (parse_config_line(ctx, line, &ctx->config_entries[ctx->config_entry_count])) {
+ ctx->config_entry_count++;
+ }
+ }
+
+ fclose(f);
+ igt_info("Loaded %d skip rules from config file\n", ctx->config_entry_count);
+}
+
+/*
+ * ================================================================
+ * ENVIRONMENT VARIABLE PARSER (IGT_PLATFORM_SKIP_CONFIG)
+ * ================================================================ */
+
+/* Parse environment variable entries (semicolon-separated) */
+static void load_env_variable(struct platform_filter_context *ctx)
+{
+ char *env, *env_copy, *entry_str, *saveptr;
+ const char *env_value;
+
+ env_value = getenv("IGT_PLATFORM_SKIP_CONFIG");
+ if (!env_value || env_value[0] == 0) {
+ igt_debug("IGT_PLATFORM_SKIP_CONFIG not set\n");
+
+ return;
+ }
+
+ igt_info("Loading platform skip config from IGT_PLATFORM_SKIP_CONFIG\n");
+
+ env_copy = strdup(env_value);
+ env = env_copy;
+
+ /* Parse semicolon-separated entries */
+ while ((entry_str = strtok_r(env, ";", &saveptr)) != NULL) {
+ env = NULL; /* For subsequent strtok_r calls */
+
+ if (ctx->env_entry_count >= MAX_ENV_ENTRIES) {
+ igt_warn("Too many env variable entries (max %d)\n",
+ MAX_ENV_ENTRIES);
+ break;
+ }
+
+ if (parse_config_line(ctx, entry_str, &ctx->env_entries[ctx->env_entry_count])) {
+ ctx->env_entry_count++;
+ }
+ }
+
+ free(env_copy);
+ igt_info("Loaded %d skip rules from environment variable\n", ctx->env_entry_count);
+}
+
+/*
+ * ================================================================
+ * PUBLIC API IMPLEMENTATION
+ * ================================================================ */
+
+/**
+ * igt_platform_filter_init:
+ * @ops: Platform-specific operation callbacks
+ * @platform_info: Vendor-specific platform identification data
+ *
+ * Initialize the platform filtering system with vendor-specific backend.
+ * This sets up the filter context and loads skip rules from three sources
+ * in priority order:
+ * 1. Built-in rules (highest priority, vendor-provided)
+ * 2. Config file /etc/igt/platform_skip.conf
+ * 3. Environment variable IGT_PLATFORM_SKIP_CONFIG (lowest priority)
+ *
+ * The filtering system is vendor-agnostic. Platform matching logic is
+ * provided through the @ops callbacks, allowing each vendor to implement
+ * their own identification scheme (e.g., AMD uses family_id/chip_rev,
+ * Intel could use platform_id/stepping).
+ *
+ * Must be called once before using igt_platform_require().
+ */
+void igt_platform_filter_init(const struct platform_filter_ops *ops,
+ const void *platform_info)
+{
+ struct platform_filter_context *ctx = get_filter_context();
+
+ if (ctx->initialized)
+
+ return;
+
+ if (!ops) {
+ igt_warn("Platform filter ops is NULL, filtering disabled\n");
+
+ return;
+ }
+
+ ctx->ops = ops;
+ ctx->platform_info = platform_info;
+
+ igt_info("Initializing platform filter system (3-tier priority) for vendor: %s\n",
+ ops->name ? ops->name : "unknown");
+
+ /* Get current platform name */
+
+ if (ops->get_platform_name) {
+ const char *pname = ops->get_platform_name(platform_info);
+
+ snprintf(ctx->current_platform_name, sizeof(ctx->current_platform_name),
+ "%s", pname ? pname : "unknown");
+ }
+
+ /* Priority 1: Built-in array (vendor-specific) */
+ igt_debug(" Priority 1: Built-in array (vendor-specific)\n");
+
+ /* Priority 2: Config file */
+ igt_debug(" Priority 2: Config file /etc/igt/platform_skip.conf\n");
+ load_config_file(ctx, "/etc/igt/platform_skip.conf");
+
+ /* Priority 3: Environment variable */
+ igt_debug(" Priority 3: Environment variable IGT_PLATFORM_SKIP_CONFIG\n");
+ load_env_variable(ctx);
+
+ ctx->initialized = true;
+ igt_info("Platform filter initialization complete\n");
+}
+
+/**
+ * igt_platform_should_skip:
+ * @test_name: Name of the test
+ * @subtest_name: Name of the subtest (or NULL for test-level check)
+ *
+ * Check if a test/subtest should be skipped based on platform filtering rules.
+ *
+ * Returns: true if the test should be skipped, false otherwise
+ */
+bool igt_platform_should_skip(const char *test_name,
+ const char *subtest_name,
+ enum skip_source *source,
+ const char **reason)
+{
+ struct platform_filter_context *ctx = get_filter_context();
+ const struct platform_skip_entry *entry;
+ int i, count;
+
+ if (!ctx->initialized) {
+ igt_warn("Platform filter not initialized\n");
+ if (source)
+ *source = SKIP_SOURCE_NONE;
+ if (reason)
+ *reason = NULL;
+ return false;
+ }
+
+ /* Priority 1: Check built-in array FIRST */
+ if (ctx->ops->get_builtin_rules) {
+ const struct platform_skip_entry *builtin = ctx->ops->get_builtin_rules(&count);
+
+ for (i = 0; i < count; i++) {
+ entry = &builtin[i];
+ if (entry_matches(ctx, entry, test_name, subtest_name)) {
+ if (source)
+ *source = SKIP_SOURCE_BUILTIN;
+ if (reason)
+ *reason = entry->reason;
+ igt_debug("Skip (built-in): %s:%s - %s\n",
+ entry->test_name ? entry->test_name : "*",
+ entry->subtest_glob ? entry->subtest_glob : "*",
+ entry->reason ? entry->reason : "no reason");
+ return true;
+ }
+ }
+ }
+
+ /* Priority 2: Check config file */
+ for (i = 0; i < ctx->config_entry_count; i++) {
+ entry = &ctx->config_entries[i];
+ if (entry_matches(ctx, entry, test_name, subtest_name)) {
+ if (source)
+ *source = SKIP_SOURCE_CONFIG;
+ if (reason)
+ *reason = entry->reason;
+ igt_debug("Skip (config): %s:%s - %s\n",
+ entry->test_name, entry->subtest_glob, entry->reason);
+ return true;
+ }
+ }
+
+ /* Priority 3: Check environment variable */
+ for (i = 0; i < ctx->env_entry_count; i++) {
+ entry = &ctx->env_entries[i];
+ if (entry_matches(ctx, entry, test_name, subtest_name)) {
+ if (source)
+ *source = SKIP_SOURCE_ENV;
+ if (reason)
+ *reason = entry->reason;
+ igt_debug("Skip (env): %s:%s - %s\n",
+ entry->test_name, entry->subtest_glob, entry->reason);
+ return true;
+ }
+ }
+
+ if (source)
+ *source = SKIP_SOURCE_NONE;
+ if (reason)
+ *reason = NULL;
+ return false;
+}
+
+/**
+ * igt_platform_require:
+ * @subtest_name: Name of the subtest to check
+ *
+ * Check if current subtest should be skipped and call igt_skip() if matched.
+ * This integrates platform filtering with IGT's standard skip mechanism.
+ *
+ * The function automatically determines the test name from igt_test_name().
+ * If a skip rule matches, calls igt_skip() with the configured reason.
+ */
+void igt_platform_require(const char *subtest_name)
+{
+ enum skip_source source;
+ const char *test_name = igt_test_name();
+ const char *reason;
+
+ if (igt_platform_should_skip(test_name, subtest_name, &source, &reason)) {
+ const char *source_str;
+
+ switch (source) {
+ case SKIP_SOURCE_BUILTIN:
+ source_str = "built-in array";
+ break;
+ case SKIP_SOURCE_CONFIG:
+ source_str = "config file";
+ break;
+ case SKIP_SOURCE_ENV:
+ source_str = "environment variable";
+ break;
+ default:
+ source_str = "unknown";
+ }
+
+ igt_skip("Skipped on this platform [%s]: %s\n",
+ source_str, reason ? reason : "no reason");
+ }
+}
+
+/**
+ * igt_platform_filter_dump:
+ *
+ * Dump the current platform filtering configuration to stdout.
+ * Shows all loaded skip rules from built-in, config file, and environment
+ * variable sources. Useful for debugging which rules are active.
+ */
+void igt_platform_filter_dump(void)
+{
+ struct platform_filter_context *ctx = get_filter_context();
+ const struct platform_skip_entry *entry;
+ int i, total_count, count;
+
+ if (!ctx->initialized) {
+ igt_info("Platform filter not initialized\n");
+
+ return;
+ }
+
+ igt_info("\n");
+ igt_info("═══════════════════════════════════════════════════════════════════\n");
+ igt_info(" PLATFORM SKIP FILTER CONFIGURATION - THREE-TIER PRIORITY SYSTEM\n");
+ igt_info("═══════════════════════════════════════════════════════════════════\n\n");
+
+ igt_info("Vendor: %s\n", ctx->ops->name ? ctx->ops->name : "unknown");
+ if (ctx->current_platform_name[0]) {
+ igt_info("Current Platform: %s\n\n", ctx->current_platform_name);
+ }
+
+ /* Priority 1: Built-in array */
+ igt_info("───────────────────────────────────────────────────────────────────\n");
+ igt_info(" PRIORITY 1: BUILT-IN PRODUCTION ARRAY (VENDOR-SPECIFIC)\n");
+ igt_info(" Source: Vendor implementation\n");
+ igt_info("───────────────────────────────────────────────────────────────────\n");
+
+ total_count = 0;
+ if (ctx->ops->get_builtin_rules) {
+ const struct platform_skip_entry *builtin = ctx->ops->get_builtin_rules(&count);
+
+ for (i = 0; i < count; i++) {
+ entry = &builtin[i];
+ total_count++;
+ igt_info(" %2d. %s : %s\n",
+ total_count,
+ entry->test_name ? entry->test_name : "*",
+ entry->subtest_glob ? entry->subtest_glob : "*");
+ igt_info(" Reason: %s\n", entry->reason ? entry->reason : "no reason");
+
+ /* Print platform data if vendor provides dump callback */
+ if (entry->platform_data && ctx->ops->dump_platform_data) {
+ igt_info(" Platform: ");
+ ctx->ops->dump_platform_data(entry->platform_data);
+ igt_info("\n");
+ }
+ igt_info("\n");
+ }
+ }
+ if (total_count == 0) {
+ igt_info(" (No built-in rules)\n\n");
+ }
+
+ /* Priority 2: Config file */
+ igt_info("───────────────────────────────────────────────────────────────────\n");
+ igt_info(" PRIORITY 2: DEVELOPMENT CONFIG FILE\n");
+ igt_info(" Source: /etc/igt/platform_skip.conf\n");
+ igt_info("───────────────────────────────────────────────────────────────────\n");
+
+ if (ctx->config_entry_count > 0) {
+ for (i = 0; i < ctx->config_entry_count; i++) {
+ entry = &ctx->config_entries[i];
+ igt_info(" %2d. %s : %s\n",
+ i + 1,
+ entry->test_name,
+ entry->subtest_glob);
+ igt_info(" Reason: %s\n\n", entry->reason);
+ }
+ } else {
+ igt_info(" (No config file rules loaded)\n\n");
+ }
+
+ /* Priority 3: Environment variable */
+ igt_info("───────────────────────────────────────────────────────────────────\n");
+ igt_info(" PRIORITY 3: RUNTIME ENVIRONMENT VARIABLE\n");
+ igt_info(" Source: IGT_PLATFORM_SKIP_CONFIG\n");
+ igt_info("───────────────────────────────────────────────────────────────────\n");
+
+ if (ctx->env_entry_count > 0) {
+ for (i = 0; i < ctx->env_entry_count; i++) {
+ entry = &ctx->env_entries[i];
+
+ igt_info(" %2d. %s : %s\n",
+ i + 1,
+ entry->test_name,
+ entry->subtest_glob);
+ igt_info(" Reason: %s\n\n", entry->reason);
+ }
+ } else {
+ igt_info(" (No environment variable rules)\n\n");
+ }
+
+ igt_info("───────────────────────────────────────────────────────────────────\n");
+ igt_info(" SUMMARY\n");
+ igt_info("───────────────────────────────────────────────────────────────────\n");
+ igt_info(" Built-in rules: %d\n", total_count);
+ igt_info(" Config file rules: %d\n", ctx->config_entry_count);
+ igt_info(" Environment rules: %d\n", ctx->env_entry_count);
+ igt_info(" Total skip rules: %d\n", total_count + ctx->config_entry_count + ctx->env_entry_count);
+ igt_info("\n");
+ igt_info("═══════════════════════════════════════════════════════════════════\n\n");
+}
+
+/**
+ * igt_platform_filter_dump_to_file:
+ * @filename: Path to output file
+ *
+ * Dump platform filtering configuration to a file.
+ *
+ * Returns: 0 on success, -1 on error
+ */
+int igt_platform_filter_dump_to_file(const char *filename)
+{
+ FILE *old_stdout;
+ FILE *f;
+
+ f = fopen(filename, "w");
+ if (!f) {
+ igt_warn("Failed to open %s for writing\n", filename);
+ return -1;
+ }
+
+ /* Redirect stdout to file */
+ old_stdout = stdout;
+ stdout = f;
+
+ igt_platform_filter_dump();
+
+ /* Restore stdout */
+ stdout = old_stdout;
+ fclose(f);
+
+ igt_info("Platform filter configuration dumped to: %s\n", filename);
+ return 0;
+}
+
+/**
+ * igt_platform_filter_is_initialized:
+ *
+ * Check if platform filtering has been initialized.
+ *
+ * Returns: true if initialized, false otherwise
+ */
+bool igt_platform_filter_is_initialized(void)
+{
+ struct platform_filter_context *ctx = get_filter_context();
+
+ return ctx && ctx->initialized;
+}
diff --git a/lib/igt_platform_filter.h b/lib/igt_platform_filter.h
new file mode 100644
index 000000000..b83440514
--- /dev/null
+++ b/lib/igt_platform_filter.h
@@ -0,0 +1,124 @@
+/* SPDX-License-Identifier: MIT
+ * Copyright 2026 Advanced Micro Devices, Inc.
+ */
+
+#ifndef IGT_PLATFORM_FILTER_H
+#define IGT_PLATFORM_FILTER_H
+
+#include <stdbool.h>
+
+/**
+ * SECTION: igt_platform_filter
+ * @short_description: Generic platform-based test filtering framework
+ * @title: Platform Filter
+ * @include: igt_platform_filter.h
+ *
+ * Generic test filtering system that allows skipping tests/subtests based
+ * on platform characteristics. Designed to be vendor-agnostic with
+ * vendor-specific backends.
+ *
+ * Three-tier priority system (checked in sequence, first match wins):
+ * 1. PRODUCTION: Built-in compile-time rules (vendor-specific)
+ * 2. DEVELOPMENT: Config file /etc/igt/platform_skip.conf
+ * 3. RUNTIME: Environment variable IGT_PLATFORM_SKIP_CONFIG
+ *
+ * Vendor Implementation:
+ * Each vendor implements platform_filter_ops callbacks to provide:
+ * - Platform identification and matching logic
+ * - Platform-specific data structures
+ * - Built-in skip rules
+ *
+ * Usage in tests:
+ * igt_fixture() {
+ * igt_platform_filter_init(vendor_ops, platform_info);
+ * }
+ *
+ * igt_subtest("my-test") {
+ * // Automatic filtering - no manual call needed!
+ * test_code();
+ * }
+ *
+ * Config file format (/etc/igt/platform_skip.conf):
+ * # Lines starting with # are comments
+ * # Format: platform:test:subtest:reason
+ * # Use * as wildcard
+ *
+ * navi48:*:*:All tests disabled on Navi48
+ * alderlake:i915_pm:*:Power management tests broken
+ *
+ * Environment variable format (IGT_PLATFORM_SKIP_CONFIG):
+ * Same as config file, semicolon-separated entries:
+ * export IGT_PLATFORM_SKIP_CONFIG="navi48:*:*:Testing;navi10:amd_basic:*:Broken"
+ */
+
+/* Maximum platform ranges per skip entry */
+#define MAX_PLATFORM_RANGES 4
+
+/**
+ * enum skip_source - Source of skip rule
+ */
+enum skip_source {
+ SKIP_SOURCE_BUILTIN, /* From vendor built-in array */
+ SKIP_SOURCE_CONFIG, /* From /etc/igt/platform_skip.conf */
+ SKIP_SOURCE_ENV, /* From IGT_PLATFORM_SKIP_CONFIG */
+ SKIP_SOURCE_NONE, /* Not skipped */
+};
+
+/**
+ * struct platform_skip_entry - Generic skip rule entry
+ *
+ * Generic structure for skip rules. Vendor-specific data is stored
+ * in platform_data field and interpreted by vendor callbacks.
+ */
+struct platform_skip_entry {
+ const char *test_name; /* Test binary name or "*" for all */
+ const char *subtest_glob; /* Subtest pattern (fnmatch) or "*" */
+ const char *reason; /* Human-readable reason (required) */
+ void *platform_data; /* Vendor-specific platform matching data */
+};
+
+/**
+ * struct platform_filter_ops - Vendor-specific operations
+ *
+ * Callback structure that vendors implement to provide platform-specific
+ * filtering logic. This allows the core filtering framework to remain
+ * vendor-agnostic.
+ */
+struct platform_filter_ops {
+ /** @name: Vendor name (e.g., "amd", "intel") */
+
+ const char *name;
+
+ /** @get_platform_name: Get current platform name */
+ const char *(*get_platform_name)(const void *platform_info);
+
+ /** @match_platform: Check if skip entry matches current platform */
+ bool (*match_platform)(const void *platform_info, const void *platform_data);
+
+ /** @parse_platform_config: Parse platform string from config file */
+ bool (*parse_platform_config)(const char *platform_str, void **platform_data_out);
+
+ /** @get_builtin_rules: Get vendor-specific built-in skip rules */
+ const struct platform_skip_entry *(*get_builtin_rules)(int *count_out);
+
+ /** @dump_platform_data: Dump platform_data for debugging (optional) */
+ void (*dump_platform_data)(const void *platform_data);
+};
+
+bool igt_platform_filter_is_initialized(void);
+
+void igt_platform_filter_init(const struct platform_filter_ops *ops,
+ const void *platform_info);
+
+void igt_platform_require(const char *subtest_name);
+
+bool igt_platform_should_skip(const char *test_name,
+ const char *subtest_name,
+ enum skip_source *source,
+ const char **reason);
+
+void igt_platform_filter_dump(void);
+
+int igt_platform_filter_dump_to_file(const char *filename);
+
+#endif /* IGT_PLATFORM_FILTER_H */
diff --git a/lib/meson.build b/lib/meson.build
index 3001b473e..1c04ee813 100644
--- a/lib/meson.build
+++ b/lib/meson.build
@@ -38,6 +38,7 @@ lib_sources = [
'igt_params.c',
'igt_perf.c',
'igt_pipe_crc.c',
+ 'igt_platform_filter.c',
'igt_power.c',
'igt_primes.c',
'igt_pci.c',
--
2.43.0
^ permalink raw reply related [flat|nested] 7+ messages in thread* [PATCH v5 2/4] lib/amdgpu: Add AMD platform filtering backend
2026-08-05 20:28 [PATCH v5 0/4] Add platform filtering framework for IGT tests vitaly.prosyak
2026-08-05 20:28 ` [PATCH v5 1/4] lib: Add generic platform filtering framework vitaly.prosyak
@ 2026-08-05 20:28 ` vitaly.prosyak
2026-08-05 20:28 ` [PATCH v5 3/4] lib/igt_core: Enable automatic platform filtering in subtest execution vitaly.prosyak
` (2 subsequent siblings)
4 siblings, 0 replies; 7+ messages in thread
From: vitaly.prosyak @ 2026-08-05 20:28 UTC (permalink / raw)
To: igt-dev
Cc: kamil.konieczny, pawel.sikora, jani.nikula, jesse.zhang,
christian.koenig, alexander.deucher, Vitaly Prosyak,
Krzysztof Karas
From: Vitaly Prosyak <vitaly.prosyak@amd.com>
Implement the AMD-specific backend for the generic platform filtering
framework, providing:
- ASIC identification via amdgpu family_id and chip_rev ranges
- ASIC name table mapping (navi10, navi48, arcturus, etc.)
- AMD-specific built-in skip rules
- amd_platform_filter_init() convenience function for AMD tests
This is a pluggable backend accessed through platform_filter_ops
callbacks. The core framework has zero AMD-specific knowledge.
To add support for another vendor (e.g., Intel):
1. Create lib/i915/intel_platform.c/h
2. Implement platform_filter_ops callbacks
3. Define Intel platform data (platform_id, stepping ranges)
4. Call intel_platform_filter_init() from Intel tests
Usage in AMD tests:
amd_platform_filter_init(&gpu_info);
igt_platform_require(igt_test_name(), my-subtest);
Example skip via environment variable:
export IGT_PLATFORM_SKIP_CONFIG=navi48:amd_basic:*-UMQ:unstable
v3 changes:
- This is now patch 2/6 (was 3/7 in v2) due to squashing of patches 1+2
per Kamil Konieczny's review feedback
- No code changes from v2
v2: Address review feedback from Kamil Konieczny:
- Fixed compilation error: removed extra */ on line 9
- Added missing #include <stddef.h> to fix size_t errors
- Added kernel-doc to amd_platform_filter_init()
- Verified bisect-safety
Cc: Kamil Konieczny <kamil.konieczny@linux.intel.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Krzysztof Karas <krzysztof.karas@intel.com>
Cc: Jesse Zhang <jesse.zhang@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Vitaly Prosyak <vitaly.prosyak@amd.com>
Reviewed-by: Jesse Zhang <jesse.zhang@amd.com>
Change-Id: I578444cd7b3b4d821cf1f3502cd61ea4cae946e3
---
lib/amdgpu/amd_platform.c | 328 ++++++++++++++++++++++++++++++++++++++
lib/amdgpu/amd_platform.h | 53 ++++++
lib/meson.build | 1 +
3 files changed, 382 insertions(+)
create mode 100644 lib/amdgpu/amd_platform.c
create mode 100644 lib/amdgpu/amd_platform.h
diff --git a/lib/amdgpu/amd_platform.c b/lib/amdgpu/amd_platform.c
new file mode 100644
index 000000000..1c6a72a49
--- /dev/null
+++ b/lib/amdgpu/amd_platform.c
@@ -0,0 +1,328 @@
+// SPDX-License-Identifier: MIT
+// Copyright 2026 Advanced Micro Devices, Inc.
+/*
+ * AMD-specific platform filtering backend
+ *
+ * Implements platform_filter_ops callbacks for AMD GPUs, providing
+ * platform identification and matching logic based on ASIC family/chip.
+ */
+
+#include <stddef.h>
+#include <stdlib.h>
+#include <string.h>
+#include <strings.h>
+
+#include "igt.h"
+#include "igt_platform_filter.h"
+#include "amd_platform.h"
+#include "amdgpu_asic_addr.h"
+
+/**
+ * AMD platform data structures
+ *
+ * These structures define how AMD ASICs are matched for filtering.
+ * They use family/chip ranges similar to amd_queue_reset.c
+ */
+
+/* Maximum ASIC family ranges per skip entry */
+#define MAX_ASIC_RANGES 4
+
+/**
+ * struct amd_asic_range - ASIC family range for matching
+ *
+ * Similar to struct used in amd_queue_reset.c for defining ASIC ranges.
+ * Uses definitions from amdgpu_asic_addr.h
+ */
+struct amd_asic_range {
+ int family_id; /* FAMILY_NV, FAMILY_GFX1200, etc. */
+ int chip_id_min; /* Min chip revision */
+ int chip_id_max; /* Max chip revision */
+};
+
+/**
+ * struct amd_platform_data - AMD platform matching data
+ *
+ * This is stored in platform_skip_entry->platform_data field.
+ * Contains array of ASIC ranges to match against.
+ */
+struct amd_platform_data {
+ struct amd_asic_range ranges[MAX_ASIC_RANGES];
+ int num_ranges;
+};
+
+/* ASIC name to family/chip mapping table */
+struct asic_info {
+ const char *name;
+ int family_id;
+ int chip_id_min;
+ int chip_id_max;
+};
+
+static const struct asic_info asic_table[] = {
+ /* GFX12 - using ranges from amdgpu_asic_addr.h */
+ { "navi48", FAMILY_GFX1200, AMDGPU_GFX1200_RANGE },
+ { "navi44", FAMILY_GFX1200, AMDGPU_GFX1200_RANGE },
+
+ /* GFX11.5 */
+ { "gfx1150", FAMILY_GFX1150, AMDGPU_GFX1150_RANGE },
+ { "gfx1151", FAMILY_GFX1150, AMDGPU_GFX1151_RANGE },
+ { "gfx1152", FAMILY_GFX1150, AMDGPU_GFX1152_RANGE },
+ { "gfx1153", FAMILY_GFX1150, AMDGPU_GFX1153_RANGE },
+
+ /* GFX11 */
+ { "gfx1100", FAMILY_GFX1100, AMDGPU_GFX1100_RANGE },
+ { "gfx1101", FAMILY_GFX1100, AMDGPU_GFX1101_RANGE },
+ { "gfx1102", FAMILY_GFX1100, AMDGPU_GFX1102_RANGE },
+ { "gfx1103_r1", FAMILY_GFX1103, AMDGPU_GFX1103_R1_RANGE },
+ { "gfx1103_r2", FAMILY_GFX1103, AMDGPU_GFX1103_R2_RANGE },
+ { "navi31", FAMILY_GFX1100, AMDGPU_GFX1100_RANGE },
+ { "navi32", FAMILY_GFX1100, AMDGPU_GFX1101_RANGE },
+ { "navi33", FAMILY_GFX1100, AMDGPU_GFX1102_RANGE },
+
+ /* GFX10.3 */
+ { "sienna_cichlid", FAMILY_NV, AMDGPU_SIENNA_CICHLID_RANGE },
+ { "navy_flounder", FAMILY_NV, AMDGPU_NAVY_FLOUNDER_RANGE },
+ { "dimgrey_cavefish", FAMILY_NV, AMDGPU_DIMGREY_CAVEFISH_RANGE },
+ { "beige_goby", FAMILY_NV, AMDGPU_BEIGE_GOBY_RANGE },
+ { "yellow_carp", FAMILY_YC, AMDGPU_YELLOW_CARP_RANGE },
+ { "vangogh", FAMILY_VGH, AMDGPU_VANGOGH_RANGE },
+
+ /* GFX10 */
+ { "navi10", FAMILY_NV, AMDGPU_NAVI10_RANGE },
+ { "navi12", FAMILY_NV, AMDGPU_NAVI12_RANGE },
+ { "navi14", FAMILY_NV, AMDGPU_NAVI14_RANGE },
+ { "navi21", FAMILY_NV, AMDGPU_SIENNA_CICHLID_RANGE },
+ { "navi22", FAMILY_NV, AMDGPU_NAVY_FLOUNDER_RANGE },
+ { "navi23", FAMILY_NV, AMDGPU_DIMGREY_CAVEFISH_RANGE },
+ { "navi24", FAMILY_NV, AMDGPU_BEIGE_GOBY_RANGE },
+
+ /* CDNA */
+ { "arcturus", FAMILY_AI, AMDGPU_ARCTURUS_RANGE },
+ { "aldebaran", FAMILY_AI, AMDGPU_ALDEBARAN_RANGE },
+
+ /* GFX9 */
+ { "vega10", FAMILY_AI, AMDGPU_VEGA10_RANGE },
+ { "vega12", FAMILY_AI, AMDGPU_VEGA12_RANGE },
+ { "vega20", FAMILY_AI, AMDGPU_VEGA20_RANGE },
+ { "raven", FAMILY_RV, AMDGPU_RAVEN_RANGE },
+ { "raven2", FAMILY_RV, AMDGPU_RAVEN2_RANGE },
+ { "renoir", FAMILY_RV, AMDGPU_RENOIR_RANGE },
+
+ /* GFX8 (VI/Polaris) */
+ { "polaris10", FAMILY_VI, AMDGPU_POLARIS10_RANGE },
+ { "polaris11", FAMILY_VI, AMDGPU_POLARIS11_RANGE },
+ { "polaris12", FAMILY_VI, AMDGPU_POLARIS12_RANGE },
+ { "fiji", FAMILY_VI, AMDGPU_FIJI_RANGE },
+ { "tonga", FAMILY_VI, AMDGPU_TONGA_RANGE },
+ { "iceland", FAMILY_VI, AMDGPU_ICELAND_RANGE },
+ { "carrizo", FAMILY_CZ, AMDGPU_CARRIZO_RANGE },
+ { "stoney", FAMILY_CZ, AMDGPU_STONEY_RANGE },
+
+ { NULL, 0, 0, 0 }
+};
+
+/* Helper: Get ASIC info by name (case-insensitive) */
+static const struct asic_info *get_asic_info(const char *name)
+{
+ const struct asic_info *info;
+
+ if (!name)
+ return NULL;
+
+ for (info = asic_table; info->name; info++) {
+ if (strcasecmp(info->name, name) == 0)
+ return info;
+ }
+ return NULL;
+}
+
+/* Helper: Get ASIC name by family/chip */
+static const char *get_asic_name(int family_id, int chip_rev)
+{
+ const struct asic_info *info;
+
+ for (info = asic_table; info->name; info++) {
+ if (info->family_id == family_id &&
+ chip_rev >= info->chip_id_min &&
+ chip_rev < info->chip_id_max)
+ return info->name;
+ }
+ return "unknown";
+}
+
+/* ================================================================
+ * AMD PLATFORM FILTER OPS IMPLEMENTATION
+ * ================================================================ */
+
+static const char *amd_get_platform_name(const void *platform_info)
+{
+ const struct amdgpu_gpu_info *gpu_info = platform_info;
+
+ if (!gpu_info)
+ return "unknown";
+
+ return get_asic_name(gpu_info->family_id, gpu_info->chip_rev);
+}
+
+static bool amd_match_platform(const void *platform_info, const void *platform_data)
+{
+ const struct amdgpu_gpu_info *gpu_info = platform_info;
+ const struct amd_platform_data *amd_data = platform_data;
+ int i;
+
+ if (!gpu_info || !amd_data)
+ return false;
+
+ /* If no ranges specified, match all platforms */
+ if (amd_data->num_ranges == 0)
+ return true;
+
+ /* Check if GPU matches any of the ASIC ranges */
+ for (i = 0; i < amd_data->num_ranges && i < MAX_ASIC_RANGES; i++) {
+ if (amd_data->ranges[i].family_id == gpu_info->family_id) {
+ int chip_rev = gpu_info->chip_rev;
+ if (chip_rev >= amd_data->ranges[i].chip_id_min &&
+ chip_rev < amd_data->ranges[i].chip_id_max) {
+ return true;
+ }
+ }
+ }
+
+ return false;
+}
+
+static bool amd_parse_platform_config(const char *platform_str, void **platform_data_out)
+{
+ const struct asic_info *info;
+ struct amd_platform_data *amd_data;
+
+ info = get_asic_info(platform_str);
+ if (!info) {
+ igt_warn("Unknown AMD ASIC name: %s\n", platform_str);
+ return false;
+ }
+
+ amd_data = malloc(sizeof(*amd_data));
+ if (!amd_data)
+ return false;
+
+ memset(amd_data, 0, sizeof(*amd_data));
+ amd_data->ranges[0].family_id = info->family_id;
+ amd_data->ranges[0].chip_id_min = info->chip_id_min;
+ amd_data->ranges[0].chip_id_max = info->chip_id_max;
+ amd_data->num_ranges = 1;
+
+ *platform_data_out = amd_data;
+ return true;
+}
+
+static void amd_dump_platform_data(const void *platform_data)
+{
+ const struct amd_platform_data *amd_data = platform_data;
+ int i;
+
+ if (!amd_data) {
+ printf("(all platforms)");
+ return;
+ }
+
+ for (i = 0; i < amd_data->num_ranges && i < MAX_ASIC_RANGES; i++) {
+ if (i > 0)
+ printf(", ");
+ printf("{0x%02X, 0x%02X-0x%02X}",
+ amd_data->ranges[i].family_id,
+ amd_data->ranges[i].chip_id_min,
+ amd_data->ranges[i].chip_id_max);
+ }
+}
+
+/* ================================================================
+ * AMD BUILT-IN SKIP RULES
+ * ================================================================
+ *
+ * These are production skip rules. They are checked FIRST before
+ * config file or environment variable.
+ *
+ * To add a skip rule:
+ * 1. Define platform data with ASIC ranges
+ * 2. Add entry to builtin_skip_table[]
+ * 3. Rebuild IGT
+ *
+ * Example formats (uncomment to use):
+ *
+ * Single ASIC:
+ * static struct amd_platform_data navi44_data = {
+ * .ranges = { {FAMILY_GFX1200, AMDGPU_GFX1200_RANGE} },
+ * .num_ranges = 1
+ * };
+ * { "amd_basic", "*-UMQ", "UMQ not supported on Navi44", &navi44_data },
+ *
+ * Multiple ASICs:
+ * static struct amd_platform_data navi10_12_14_data = {
+ * .ranges = {
+ * {FAMILY_NV, AMDGPU_NAVI10_RANGE},
+ * {FAMILY_NV, AMDGPU_NAVI12_RANGE},
+ * {FAMILY_NV, AMDGPU_NAVI14_RANGE}
+ * },
+ * .num_ranges = 3
+ * };
+ * { "amd_userq_abort", "*", "Queue reset unstable", &navi10_12_14_data },
+ *
+ * All platforms (no platform restriction):
+ * { "test_name", "subtest", "reason", NULL },
+ */
+
+static const struct platform_skip_entry builtin_skip_table[] = {
+ /* Add production skip rules here */
+
+ /* Sentinel */
+ {}
+};
+
+static const struct platform_skip_entry *amd_get_builtin_rules(int *count_out)
+{
+ int count = 0;
+
+ /* Count entries (stop at sentinel) */
+ while (builtin_skip_table[count].test_name ||
+ builtin_skip_table[count].subtest_glob ||
+ builtin_skip_table[count].reason)
+ count++;
+
+ *count_out = count;
+ return builtin_skip_table;
+}
+
+/* AMD platform filter operations */
+static const struct platform_filter_ops amd_platform_ops = {
+ .name = "amd",
+ .get_platform_name = amd_get_platform_name,
+ .match_platform = amd_match_platform,
+ .parse_platform_config = amd_parse_platform_config,
+ .get_builtin_rules = amd_get_builtin_rules,
+ .dump_platform_data = amd_dump_platform_data,
+};
+
+/* ================================================================
+ * PUBLIC API
+ * ================================================================ */
+
+const struct platform_filter_ops *amd_platform_get_ops(void)
+{
+ return &amd_platform_ops;
+}
+
+/**
+ * amd_platform_filter_init:
+ * @gpu_info: AMD GPU information from amdgpu query
+ *
+ * Initialize platform filtering for AMD GPUs. This is a convenience
+ * wrapper that sets up the generic filtering framework with AMD-specific
+ * callbacks and GPU identification data.
+ *
+ * Must be called before using igt_platform_require() in AMD tests.
+ */
+void amd_platform_filter_init(const struct amdgpu_gpu_info *gpu_info)
+{
+ igt_platform_filter_init(&amd_platform_ops, gpu_info);
+}
diff --git a/lib/amdgpu/amd_platform.h b/lib/amdgpu/amd_platform.h
new file mode 100644
index 000000000..fd233a053
--- /dev/null
+++ b/lib/amdgpu/amd_platform.h
@@ -0,0 +1,53 @@
+/* SPDX-License-Identifier: MIT
+ * Copyright 2026 Advanced Micro Devices, Inc.
+ */
+
+#ifndef AMD_PLATFORM_H
+#define AMD_PLATFORM_H
+
+#include "igt_platform_filter.h"
+#include "amd_ip_blocks.h"
+
+/**
+ * SECTION: amd_platform
+ * @short_description: AMD-specific platform filtering backend
+ * @title: AMD Platform
+ * @include: amd_platform.h
+ *
+ * AMD implementation of platform filtering that plugs into the generic
+ * IGT platform filter framework.
+ *
+ * This backend provides:
+ * - ASIC identification and matching based on family/chip ranges
+ * - Built-in skip rules for AMD GPUs
+ * - Integration with amdgpu_asic_addr.h definitions
+ *
+ * Usage in AMD tests:
+ * igt_fixture() {
+ * setup_amdgpu_ip_blocks(...);
+ * amd_platform_filter_init(&gpu_info);
+ * }
+ *
+ * igt_subtest("my-test") {
+ * // Automatic filtering - no manual call needed!
+ * test_code();
+ * }
+ */
+
+/**
+ * amd_platform_filter_init - Initialize AMD platform filtering
+ * @gpu_info: AMDGPU GPU information structure
+ *
+ * Convenience wrapper that initializes the generic platform filter
+ * with AMD-specific operations and GPU info.
+ */
+void amd_platform_filter_init(const struct amdgpu_gpu_info *gpu_info);
+
+/**
+ * amd_platform_get_ops - Get AMD platform filter operations
+ *
+ * Returns: AMD platform_filter_ops structure
+ */
+const struct platform_filter_ops *amd_platform_get_ops(void);
+
+#endif /* AMD_PLATFORM_H */
diff --git a/lib/meson.build b/lib/meson.build
index 1c04ee813..47b69da19 100644
--- a/lib/meson.build
+++ b/lib/meson.build
@@ -181,6 +181,7 @@ if libdrm_amdgpu.found()
lib_deps += libdrm_amdgpu
lib_sources += [
'amdgpu/amd_memory.c',
+ 'amdgpu/amd_platform.c',
'amdgpu/amd_command_submission.c',
'amdgpu/amd_compute.c',
'amdgpu/amd_cs_radv.c',
--
2.43.0
^ permalink raw reply related [flat|nested] 7+ messages in thread* [PATCH v5 3/4] lib/igt_core: Enable automatic platform filtering in subtest execution
2026-08-05 20:28 [PATCH v5 0/4] Add platform filtering framework for IGT tests vitaly.prosyak
2026-08-05 20:28 ` [PATCH v5 1/4] lib: Add generic platform filtering framework vitaly.prosyak
2026-08-05 20:28 ` [PATCH v5 2/4] lib/amdgpu: Add AMD platform filtering backend vitaly.prosyak
@ 2026-08-05 20:28 ` vitaly.prosyak
2026-08-05 20:28 ` [PATCH v5 4/4] docs: Update platform filtering documentation per review feedback vitaly.prosyak
2026-08-13 16:30 ` [PATCH v5 0/4] Add platform filtering framework for IGT tests vitaly prosyak
4 siblings, 0 replies; 7+ messages in thread
From: vitaly.prosyak @ 2026-08-05 20:28 UTC (permalink / raw)
To: igt-dev
Cc: kamil.konieczny, pawel.sikora, jani.nikula, jesse.zhang,
christian.koenig, alexander.deucher, Vitaly Prosyak,
Krzysztof Karas
From: Vitaly Prosyak <vitaly.prosyak@amd.com>
Hook platform filtering into __igt_run_subtest() so tests automatically
skip subtests based on platform rules without requiring manual
igt_platform_require() calls in each subtest.
This means tests only need to call platform_filter_init() once in their
igt_fixture, and all subtests are automatically checked against the
platform filtering rules before execution.
Example test code:
igt_fixture {
amd_platform_filter_init(&gpu_info);
}
igt_subtest(my-test) {
// Automatic skip if platform rules match - no manual call needed!
test_code();
}
v3 changes:
- This is now patch 4/6 (was 5/7 in v2) due to squashing of patches 1+2
per Kamil Konieczny's review feedback
- No code changes from v2
Cc: Kamil Konieczny <kamil.konieczny@linux.intel.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Jesse Zhang <jesse.zhang@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Vitaly Prosyak <vitaly.prosyak@amd.com>
Reviewed-by: Krzysztof Karas <krzysztof.karas@intel.com>
Change-Id: I2a3b4c5d6e7f8g9h0i1j2k3l4m5n6o7p8q9r0s1t
---
lib/igt_core.c | 18 +++++++++++++++++-
1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/lib/igt_core.c b/lib/igt_core.c
index a7c097d9e..60a432888 100644
--- a/lib/igt_core.c
+++ b/lib/igt_core.c
@@ -80,6 +80,7 @@
#include "igt_rc.h"
#include "igt_list.h"
#include "igt_map.h"
+#include "igt_platform_filter.h"
#include "igt_device_scan.h"
#include "igt_thread.h"
#include "igt_vec.h"
@@ -1572,7 +1573,6 @@ bool __igt_run_subtest(const char *subtest_name, const char *file, const int lin
return false;
}
-
if (skip_subtests_henceforth) {
_subtest_result_message(_SUBTEST_TYPE_NORMAL, subtest_name,
skip_subtests_henceforth == SKIP ? "SKIP" : "FAIL",
@@ -1580,6 +1580,22 @@ bool __igt_run_subtest(const char *subtest_name, const char *file, const int lin
return false;
}
+ /* Automatic platform filtering - if initialized, check if subtest should be skipped */
+ if (igt_platform_filter_is_initialized()) {
+ enum skip_source source;
+ const char *reason;
+
+ if (igt_platform_should_skip(igt_test_name(), subtest_name,
+ &source, &reason)) {
+ _subtest_result_message(_SUBTEST_TYPE_NORMAL, subtest_name,
+ "SKIP", 0.0);
+ igt_info("Platform filtering (%s): %s\n",
+ source == SKIP_SOURCE_BUILTIN ? "built-in" :
+ source == SKIP_SOURCE_CONFIG ? "config" : "env",
+ reason);
+ return false;
+ }
+ }
igt_kmsg(KMSG_INFO "%s: starting subtest %s\n",
command_str, subtest_name);
igt_trace("%s: starting subtest %s\n", command_str, subtest_name);
--
2.43.0
^ permalink raw reply related [flat|nested] 7+ messages in thread* [PATCH v5 4/4] docs: Update platform filtering documentation per review feedback
2026-08-05 20:28 [PATCH v5 0/4] Add platform filtering framework for IGT tests vitaly.prosyak
` (2 preceding siblings ...)
2026-08-05 20:28 ` [PATCH v5 3/4] lib/igt_core: Enable automatic platform filtering in subtest execution vitaly.prosyak
@ 2026-08-05 20:28 ` vitaly.prosyak
2026-08-13 16:30 ` [PATCH v5 0/4] Add platform filtering framework for IGT tests vitaly prosyak
4 siblings, 0 replies; 7+ messages in thread
From: vitaly.prosyak @ 2026-08-05 20:28 UTC (permalink / raw)
To: igt-dev
Cc: kamil.konieczny, pawel.sikora, jani.nikula, jesse.zhang,
christian.koenig, alexander.deucher, Vitaly Prosyak,
Krzysztof Kozlowski
From: Vitaly Prosyak <vitaly.prosyak@amd.com>
Update the platform filtering usage guide to clarify method priority
ordering, replace Advantages/Disadvantages with When-to-Use/Trade-offs,
and add runtime methods for discovering platform names.
Address review comments from Krzysztof Kozlowski:
1. Reordered documentation methods to match priority order:
- Method 1: Built-in Rules (highest priority) - was listed last
- Method 2: Config File (recommended)
- Method 3: Environment Variable (lowest priority)
2. Replaced Advantages/Disadvantages sections with When to Use and
Trade-offs to better reflect that each method has valid use cases
rather than suggesting one is universally better
3. Added positive use cases for environment variable method:
- Quick one-off testing without editing files
- Temporary overrides during debugging
- Testing filter patterns before committing to config
- Was showing only disadvantages before
4. Made platform names list generic with code reference:
- Changed from hardcoded exhaustive list to examples
- Added reference to lib/amdgpu/amd_platform.c for complete list
- Added methods to discover platform name at runtime
- Noted that list may change with new hardware generations
5. Removed redundant checkmark from summary table
6. Updated mkdocs.yml title from "How to filter platforms" to
"How to filter tests per platform" to match "How to" style
of other documentation entries
v5: Address review from Kamil Konieczny:
- Replaced emoji with ASCII [+]/[-] in docs/platform_filtering.md
- Removed Gerrit Change-Id from commit message
- Moved detail below --- separator (not in git log)
- Added Cc: Pawel Sikora per Kamil's request
Suggested-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Cc: Kamil Konieczny <kamil.konieczny@linux.intel.com>
Cc: Pawel Sikora <pawel.sikora@intel.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Jesse Zhang <jesse.zhang@amd.com>
Cc: Christian Koenig <christian.koenig@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Vitaly Prosyak <vitaly.prosyak@amd.com>
---
docs/platform_filtering.md | 351 +++++++++++++++++++++++++++++++++++++
mkdocs.yml | 1 +
2 files changed, 352 insertions(+)
create mode 100644 docs/platform_filtering.md
diff --git a/docs/platform_filtering.md b/docs/platform_filtering.md
new file mode 100644
index 000000000..7d3202a94
--- /dev/null
+++ b/docs/platform_filtering.md
@@ -0,0 +1,351 @@
+# IGT Platform Filtering - Usage Guide
+
+## Overview
+
+The IGT platform filtering framework allows tests to be skipped based on
+platform characteristics without modifying test source code.
+
+**Key Feature**: **Automatic Filtering** - No manual calls needed in subtests!
+
+Tests only need to initialize platform filtering once in `igt_fixture`,
+and the IGT framework automatically checks each subtest before execution.
+
+## Quick Start
+
+### 1. Initialize in Test (One Time)
+
+```c
+#include "lib/amdgpu/amd_platform.h"
+
+int igt_main(void)
+{
+ struct amdgpu_gpu_info gpu_info;
+
+ igt_fixture {
+ fd = drm_open_driver(DRIVER_AMDGPU);
+ amdgpu_query_gpu_info(device, &gpu_info);
+
+ /* Initialize platform filtering - enables automatic filtering */
+ amd_platform_filter_init(&gpu_info);
+ }
+
+ igt_subtest("my-test") {
+ /* No manual filtering call needed - automatic! */
+ test_code();
+ }
+}
+```
+
+### 2. Configure Filtering Rules
+
+Use one of three methods (checked in priority order):
+
+1. **Built-in rules** (highest priority) - Compiled into test
+2. **Config file** (recommended) - `/etc/igt/platform_skip.conf`
+3. **Environment variable** (lowest priority) - `IGT_PLATFORM_SKIP_CONFIG`
+
+---
+
+## Method 1: Built-in Rules (Highest Priority)
+
+**Location**: Vendor implementation (e.g., `lib/amdgpu/amd_platform.c`)
+
+### Example
+
+```c
+static const struct platform_skip_entry amd_builtin_rules[] = {
+ {
+ .test_name = "amd_security",
+ .subtest_glob = "secure-bounce",
+ .reason = "Not supported on APUs",
+ .platform_data = &apu_platforms,
+ },
+};
+```
+
+### When to Use Built-in Rules
+
+- Permanent production exclusions that should never run
+- Platform limitations known at development time
+- Tests that fundamentally cannot work on certain hardware
+- Vendor-specific restrictions that apply globally
+
+**Trade-offs:**
+- [+] Fast (no file I/O at runtime)
+- [+] Guaranteed to be applied
+- [+] Version controlled with code
+- [-] Requires rebuild to change
+- [-] Not flexible for temporary exclusions
+
+---
+
+## Method 2: Config File (RECOMMENDED)
+
+**Location**: `/etc/igt/platform_skip.conf`
+
+**Format**: `platform:test:subtest:reason`
+
+**Note**: The reason field is recommended but can be empty. If omitted, "No reason" is automatically inserted.
+
+### Example Config File
+
+```bash
+cat > /etc/igt/platform_skip.conf << 'EOF'
+# Platform filtering configuration
+# Format: platform:test:subtest:reason
+# Use * as wildcard
+
+# Skip all UMQ tests on Navi48 during platform bringup
+navi48:amd_basic:*-UMQ:SWDEV-88888 - UMQ stabilization in progress
+
+# Skip specific tests with ticket references
+navi31:amd_basic:cs-gfx-with-IP-GFX-UMQ:SWDEV-12345
+navi31:amd_basic:cs-compute-with-IP-COMPUTE-UMQ:SWDEV-12345
+navi31:amd_basic:cs-sdma-with-IP-DMA-UMQ:SWDEV-12346
+
+# Skip tests on early samples
+strix_halo:amd_basic:*:Platform not ready - ES samples
+
+# Skip known flaky test across all platforms
+*:amd_basic:eviction-test-with-IP-DMA:SWDEV-99999 - Intermittent failure
+
+# Skip entire test binary on specific platform
+navi10:amd_vcn:*:VCN encoding issues on Navi10 A0
+
+# Skip all tests on discontinued platform
+vega10:*:*:Platform no longer supported
+EOF
+```
+
+### Run Tests
+
+```bash
+# Config file is loaded automatically - no environment variable needed
+./build/tests/amdgpu/amd_basic
+
+# Output shows:
+# Subtest cs-gfx-with-IP-GFX-UMQ: SKIP
+# Platform filtering (config): SWDEV-12345
+```
+
+### When to Use Config File
+
+- Managing multiple test exclusions
+- Team-wide or CI/CD configurations
+- Persistent filtering rules across sessions
+- Easy add/remove/edit without rebuilding
+- No need to remember environment variables
+- Sharing skip rules across test infrastructure
+
+---
+
+## Method 3: Environment Variable (Lowest Priority)
+
+**Variable**: `IGT_PLATFORM_SKIP_CONFIG`
+
+**Format**: Same as config file, semicolon-separated
+
+### Example - Skip Single Test
+
+```bash
+export IGT_PLATFORM_SKIP_CONFIG="navi48:amd_basic:cs-compute-with-IP-COMPUTE-UMQ:Testing"
+./build/tests/amdgpu/amd_basic
+```
+
+### Example - Skip Multiple Tests
+
+```bash
+export IGT_PLATFORM_SKIP_CONFIG="navi48:amd_basic:*-UMQ:Testing;navi31:amd_basic:cs-gfx-*:Known issue"
+./build/tests/amdgpu/amd_basic
+```
+
+### When to Use Environment Variable
+
+- Quick one-off testing without editing files
+- Temporary overrides during debugging sessions
+- Testing filter patterns before adding to config file
+- Single test runs where config file would be overkill
+- Overriding config file rules for specific test runs
+- CI pipeline job-specific overrides
+
+**Trade-offs:**
+- [+] No file editing required
+- [+] Quick to set and unset
+- [+] Can override config file for testing
+- [-] Not persistent (lost when session ends)
+- [-] Easy to forget it's set
+- [-] Inconvenient for large test lists
+
+---
+
+## Wildcard Patterns
+
+All methods support wildcards (`*`) for flexible matching:
+
+```
+# Platform wildcards
+*:amd_basic:my-test:Reason # All platforms
+navi*:amd_basic:my-test:Reason # All Navi (navi10, navi31, navi48, etc.)
+
+# Test wildcards
+navi48:amd_*:my-test:Reason # All amd_* tests
+
+# Subtest wildcards
+navi48:amd_basic:*-UMQ:Reason # All subtests ending with -UMQ
+navi48:amd_basic:cs-*:Reason # All subtests starting with cs-
+
+# Combined wildcards
+*:*:*-UMQ:Reason # All UMQ tests on all platforms
+```
+
+### Wildcard Examples
+
+```bash
+# Skip all user queue tests during bringup
+navi48:*:*-UMQ:Platform bringup - UMQ not ready
+
+# Skip all VCN tests on specific platform
+navi10:amd_vcn:*:Known VCN issues
+
+# Skip specific test pattern across all platforms
+*:amd_basic:eviction-*:Intermittent failures
+
+# Skip all tests on EOL platform
+vega10:*:*:Platform no longer supported
+```
+
+### Pattern Matching Rules
+
+- `*` matches zero or more characters
+- Patterns are case-sensitive
+- Empty field is NOT a wildcard (use `*` explicitly)
+- Priority order: Built-in > Config file > Environment variable
+
+### Example Subtest Matching
+
+Given config: `navi48:amd_basic:*-UMQ:Testing`
+
+- cs-gfx-with-IP-GFX-UMQ → **Skipped** (matches)
+- cs-compute-with-IP-COMPUTE-UMQ → **Skipped** (matches)
+- cs-sdma-with-IP-DMA → Runs normally (doesn't match)
+
+---
+
+## Skip Message Format
+
+Automatic filtering shows the source in skip messages:
+
+```
+Subtest cs-gfx-with-IP-GFX-UMQ: SKIP
+Platform filtering (config): SWDEV-12345 - UMQ unstable on Navi48
+```
+
+Source indicators:
+- `(built-in)` - From vendor's compiled rules
+- `(config)` - From config file
+- `(env)` - From environment variable
+
+---
+
+## Platform Names
+
+Platform names are vendor-specific and defined in vendor backend code.
+
+**For AMD platforms**, see `lib/amdgpu/amd_platform.c` for the complete list.
+
+**Examples:**
+- RDNA2/3 discrete GPUs: `navi21`, `navi31`, `navi33`
+- RDNA4: `navi48`, `navi44`
+- APUs: `strix_halo`, `phoenix`
+- Data center: `aldebaran` (MI250)
+
+**To find your platform name:**
+
+```bash
+# Method 1: Run any test with debug output
+./build/tests/amdgpu/amd_basic --debug
+# Look for: "Platform detected: <name>"
+
+# Method 2: Check dmesg for GPU info
+dmesg | grep -i amdgpu | grep -i asic
+
+# Method 3: Check /sys
+cat /sys/class/drm/card0/device/asic_name # If available
+```
+
+**Note:** Platform names may change with new hardware generations. Check vendor backend code for current platform definitions. The list above is provided as examples only.
+
+---
+
+## Best Practices
+
+### For Development - Quick Testing
+
+Use environment variable:
+```bash
+# Temporarily skip broken test
+export IGT_PLATFORM_SKIP_CONFIG="*:amd_basic:broken-test:WIP"
+./build/tests/amdgpu/amd_basic
+unset IGT_PLATFORM_SKIP_CONFIG
+```
+
+### For Teams - Shared Exclusions
+
+Use config file with ticket references:
+```
+# /etc/igt/platform_skip.conf
+# Updated: 2026-07-09
+
+# Navi48 bringup exclusions
+navi48:amd_basic:*-UMQ:SWDEV-88888 - UMQ stabilization
+navi48:amd_vcn:vcn-encoder-*:SWDEV-88889 - VCN bringup
+
+# Cross-platform known issues
+*:amd_basic:eviction-test-with-IP-DMA:SWDEV-77777 - Flaky
+```
+
+### For CI/CD
+
+Deploy config file with test infrastructure:
+```bash
+#!/bin/bash
+# CI pipeline setup
+echo "Deploying test exclusions..."
+scp ci-skip-rules.conf test-machine:/etc/igt/platform_skip.conf
+ssh test-machine "./run-igt-suite.sh"
+```
+
+### For Production
+
+Use built-in rules for permanent exclusions:
+```c
+// In lib/amdgpu/amd_platform.c
+static const struct platform_skip_entry amd_builtin_rules[] = {
+ {
+ .test_name = "amd_basic",
+ .subtest_glob = "*-UMQ",
+ .reason = "User queues not supported in production",
+ .platform_data = &all_platforms,
+ },
+};
+```
+
+---
+
+## Summary
+
+| Method | Use Case | Persistent | Rebuild Required |
+|--------|----------|------------|------------------|
+| **Built-in** | Production rules | Yes | Yes |
+| **Config file** | Team/CI exclusions | Yes | No |
+| **Environment** | Quick testing | No | No |
+
+**Recommendation**: Use **config file** for managing test exclusions at scale.
+
+---
+
+## See Also
+
+- `lib/igt_platform_filter.h` - API documentation
+- `lib/igt_platform_filter.c` - Framework implementation
+- `lib/amdgpu/amd_platform.c` - AMD backend reference
diff --git a/mkdocs.yml b/mkdocs.yml
index 0abb76704..1819b7b6c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -29,6 +29,7 @@ nav:
- How to document tests: 'test_documentation.md'
- How to categorize tests: 'test_categories.md'
- How to blocklist tests: 'blocklists.md'
+ - How to filter tests per platform: 'platform_filtering.md'
- How to get code coverage: 'code_coverage.md'
- How to port new IGT driver: 'new_driver.md'
- How to plan a new test: 'test_plan.md'
--
2.43.0
^ permalink raw reply related [flat|nested] 7+ messages in thread* Re: [PATCH v5 0/4] Add platform filtering framework for IGT tests
2026-08-05 20:28 [PATCH v5 0/4] Add platform filtering framework for IGT tests vitaly.prosyak
` (3 preceding siblings ...)
2026-08-05 20:28 ` [PATCH v5 4/4] docs: Update platform filtering documentation per review feedback vitaly.prosyak
@ 2026-08-13 16:30 ` vitaly prosyak
4 siblings, 0 replies; 7+ messages in thread
From: vitaly prosyak @ 2026-08-13 16:30 UTC (permalink / raw)
To: vitaly.prosyak, igt-dev
Cc: kamil.konieczny, pawel.sikora, jani.nikula, jesse.zhang
[-- Attachment #1: Type: text/plain, Size: 1827 bytes --]
Hi Kamil,
I wanted to gently ping this patch thread to see if you've had a chance to look it over. Introducing this filtering feature is quite important for our workflow.
Thanks ,Vitaly
On 2026-08-05 16:28, vitaly.prosyak@amd.com wrote:
> From: Vitaly Prosyak <vitaly.prosyak@amd.com>
>
> This series introduces a generic platform filtering framework for IGT tests,
> allowing tests to be skipped based on platform characteristics without modifying
> test source code. Three filtering methods are supported with priority ordering:
> built-in rules (highest), config file (recommended), and environment variable
> (lowest).
>
> v5 addresses review feedback from Kamil Konieczny:
> - Replaced emoji with ASCII equivalents in documentation
> - Removed Gerrit Change-Id metadata
> - Restructured commit message per upstream standards
> - Added Pawel Sikora to Cc list
>
> Vitaly Prosyak (4):
> lib: Add generic platform filtering framework
> lib/amdgpu: Add AMD platform filtering backend
> lib/igt_core: Enable automatic platform filtering in subtest execution
> docs: Update platform filtering documentation per review feedback
>
> docs/platform_filtering.md | 351 +++++++++++++++++++++++
> lib/amdgpu/amd_platform.c | 328 +++++++++++++++++++++
> lib/amdgpu/amd_platform.h | 53 ++++
> lib/igt_core.c | 18 +-
> lib/igt_platform_filter.c | 574 +++++++++++++++++++++++++++++++++++++
> lib/igt_platform_filter.h | 124 ++++++++
> lib/meson.build | 2 +
> mkdocs.yml | 1 +
> 8 files changed, 1450 insertions(+), 1 deletion(-)
> create mode 100644 docs/platform_filtering.md
> create mode 100644 lib/amdgpu/amd_platform.c
> create mode 100644 lib/amdgpu/amd_platform.h
> create mode 100644 lib/igt_platform_filter.c
> create mode 100644 lib/igt_platform_filter.h
>
[-- Attachment #2: Type: text/html, Size: 3790 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread