Skip to contentSkip to conversation

net/mlx5: FW tracer, clamp firmware-reported num_string_db

PATCH In review Tariq Toukan 2 participants 2 messages Jul 17 – Jul 20

Subsystems (4)
lore
Share & tools
lore

Tariq Toukan

author maintainer
#0 lore raw

PATCH 1/1 net/mlx5: FW tracer, clamp firmware-reported num_string_db

From: Akiva Goldberger <[email protected]>

mlx5_query_mtrc_caps() reads num_string_db from the MTRC capabilities register and uses it directly as a loop bound to populate the fixed-size base_address_out[STRINGS_DB_SECTIONS_NUM] and size_out[STRINGS_DB_SECTIONS_NUM] arrays in the tracer's str_db structure (STRINGS_DB_SECTIONS_NUM == 8).

The field is 4 bits wide, so firmware can report up to 15. A value greater than STRINGS_DB_SECTIONS_NUM makes the loop write past the end of those arrays, corrupting adjacent fields of the fw_tracer structure on the kernel heap. Clamp the firmware-reported value before it is used.

Fixes f53aaa31cce7 ("net/mlx5: FW tracer, implement tracer logic")
---
 drivers/net/ethernet/mellanox/mlx5/core/diag/fw_tracer.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/net/ethernet/mellanox/mlx5/core/diag/fw_tracer.c +7 -0
index adcc73e2a5b3..404736c46adf 100644
@@ -64,6 +64,13 @@ static int mlx5_query_mtrc_caps(struct mlx5_fw_tracer *tracer)
 	tracer->str_db.num_string_trace =
 			MLX5_GET(mtrc_cap, out, num_string_trace);
 	tracer->str_db.num_string_db = MLX5_GET(mtrc_cap, out, num_string_db);
+	if (tracer->str_db.num_string_db > STRINGS_DB_SECTIONS_NUM) {
+		mlx5_core_warn(dev,
+			       "FWTracer: Firmware reports num_string_db (%u) > (%u), clamping\n",
+			       tracer->str_db.num_string_db,
+			       STRINGS_DB_SECTIONS_NUM);
+		tracer->str_db.num_string_db = STRINGS_DB_SECTIONS_NUM;
+	}
 	tracer->owner = !!MLX5_GET(mtrc_cap, out, trace_owner);
 	tracer->str_db.loaded = false;
 

base-commit: 3f1f755366687d051174739fb99f7d560202f60b

Signature · 1 line
2.44.0
#1 lore raw
Quoted 26 lines · Tariq Toukan

From: Akiva Goldberger <[email protected]>

mlx5_query_mtrc_caps() reads num_string_db from the MTRC capabilities register and uses it directly as a loop bound to populate the fixed-size base_address_out[STRINGS_DB_SECTIONS_NUM] and size_out[STRINGS_DB_SECTIONS_NUM] arrays in the tracer's str_db structure (STRINGS_DB_SECTIONS_NUM == 8).

The field is 4 bits wide, so firmware can report up to 15. A value greater than STRINGS_DB_SECTIONS_NUM makes the loop write past the end of those arrays, corrupting adjacent fields of the fw_tracer structure on the kernel heap. Clamp the firmware-reported value before it is used.

Fixes f53aaa31cce7 ("net/mlx5: FW tracer, implement tracer logic")
---
 drivers/net/ethernet/mellanox/mlx5/core/diag/fw_tracer.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/net/ethernet/mellanox/mlx5/core/diag/fw_tracer.c +0 -0
index adcc73e2a5b3..404736c46adf 100644

drivers/net/ethernet/mellanox/mlx5/core/diag/fw_tracer.c static int mlx5_query_mtrc_caps(struct mlx5_fw_tracer *tracer) · line 73

Quoted 10 lines
drivers/net/ethernet/mellanox/mlx5/core/diag/fw_tracer.c +7 -0
@@ -64,6 +64,13 @@ static int mlx5_query_mtrc_caps(struct mlx5_fw_tracer *tracer)
 	tracer->str_db.num_string_trace =
 			MLX5_GET(mtrc_cap, out, num_string_trace);
 	tracer->str_db.num_string_db = MLX5_GET(mtrc_cap, out, num_string_db);
+	if (tracer->str_db.num_string_db > STRINGS_DB_SECTIONS_NUM) {
+		mlx5_core_warn(dev,
+			       "FWTracer: Firmware reports num_string_db (%u) > (%u), clamping\n",
+			       tracer->str_db.num_string_db,
+			       STRINGS_DB_SECTIONS_NUM);
+		tracer->str_db.num_string_db = STRINGS_DB_SECTIONS_NUM;
+	}

First, these lines are:

"tracer->str_db.num_string_db = min(tracer->str_db.num_string_db,
STRINGS_DB_SECTIONS_NUM);"

Second, this is a very naive approach to "securing" the system. Everything originates from the firmware: registers, DMA, and data. You cannot single out one field and claim the system is now "secure".

I am aware of another large vendor that added similar "clamping" throughout their driver. That does not make the implementation correct or particularly useful.

Thanks

Quoted 9 lines
drivers/net/ethernet/mellanox/mlx5/core/diag/fw_tracer.c +0 -0
 	tracer->owner = !!MLX5_GET(mtrc_cap, out, trace_owner);
 	tracer->str_db.loaded = false;
 

base-commit: 3f1f755366687d051174739fb99f7d560202f60b

Signature · 1 line
2.44.0