Skip to contentSkip to conversation

stackdepot: Make max number of pools boot-time configurable

PATCH Applied Matt Fleming 3 participants 3 messages Jul 18, 2025 – Jul 21, 2025

Subsystems (2)

v4 of 5 Applied 1/1 Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 stackdepot: Make max number of pools boot-time configurable

From: Matt Fleming <[email protected]>

We're hitting the WARN in depot_init_pool() about reaching the stack depot limit because we have long stacks that don't dedup very well.

Introduce a new start-up parameter to allow users to set the number of maximum stack depot pools.

---

Changes in v4:
- Simplify initial stack_max_pools value courtesy of akpm

Changes in v3:
- Switch from build-time to boot-time parameter

Changes in v2:
- Replace BUILD_BUG_ON with static_assert()
- Hide STACKDEPOT_MAX_POOLS behind EXPERT

 .../admin-guide/kernel-parameters.txt         |  5 ++
 lib/stackdepot.c                              | 67 ++++++++++++++++---
 2 files changed, 63 insertions(+), 9 deletions(-)
Documentation/admin-guide/kernel-parameters.txt +5 -0
index 07e22ba5bfe3..273f6bbd56c2 100644
@@ -6988,6 +6988,11 @@
 			consumed by the stack hash table. By default this is set
 			to false.
 
+	stack_depot_max_pools= [KNL,EARLY]
+			Specify the maximum number of pools to use for storing
+			stack traces. Pools are allocated on-demand up to this
+			limit. Default value is 8191 pools.
+
 	stacktrace	[FTRACE]
 			Enabled the stack tracer on boot up.
 
lib/stackdepot.c +58 -9

110 lines not on this page · raw message

Signature · 1 line
2.34.1
Acked-by on v4 1/1
#1 lore raw
Quoted 10 lines · Matt Fleming

From: Matt Fleming <[email protected]>

We're hitting the WARN in depot_init_pool() about reaching the stack depot limit because we have long stacks that don't dedup very well.

Introduce a new start-up parameter to allow users to set the number of maximum stack depot pools.

Minor improvement suggestions below (at your discretion).

Thanks!

Quoted 39 lines

---

Changes in v4:
- Simplify initial stack_max_pools value courtesy of akpm

Changes in v3:
- Switch from build-time to boot-time parameter

Changes in v2:
- Replace BUILD_BUG_ON with static_assert()
- Hide STACKDEPOT_MAX_POOLS behind EXPERT

 .../admin-guide/kernel-parameters.txt         |  5 ++
 lib/stackdepot.c                              | 67 ++++++++++++++++---
 2 files changed, 63 insertions(+), 9 deletions(-)
Documentation/admin-guide/kernel-parameters.txt +5 -0
index 07e22ba5bfe3..273f6bbd56c2 100644
@@ -6988,6 +6988,11 @@
                        consumed by the stack hash table. By default this is set
                        to false.
 
+       stack_depot_max_pools= [KNL,EARLY]
+                       Specify the maximum number of pools to use for storing
+                       stack traces. Pools are allocated on-demand up to this
+                       limit. Default value is 8191 pools.
+
        stacktrace      [FTRACE]
                        Enabled the stack tracer on boot up.
 
lib/stackdepot.c +0 -0
index 73d7b50924ef..de0b0025af2b 100644
@@ -36,11 +36,11 @@
 #include <linux/memblock.h>
 #include <linux/kasan-enabled.h>

lib/stackdepot.c line 42

Quoted 10 lines
lib/stackdepot.c +4 -5
 
-#define DEPOT_POOLS_CAP 8192
-/* The pool_index is offset by 1 so the first record does not have a 0 handle. */
-#define DEPOT_MAX_POOLS \
-       (((1LL << (DEPOT_POOL_INDEX_BITS)) - 1 < DEPOT_POOLS_CAP) ? \
-        (1LL << (DEPOT_POOL_INDEX_BITS)) - 1 : DEPOT_POOLS_CAP)
+/*
+ * The pool_index is offset by 1 so the first record does not have a 0 handle.
+ */
+static unsigned int stack_max_pools __read_mostly =

This could be __ro_after_init.

Quoted 20 lines
lib/stackdepot.c +5 -1
+       MIN((1LL << DEPOT_POOL_INDEX_BITS) - 1, 8192);
 
 static bool stack_depot_disabled;
 static bool __stack_depot_early_init_requested __initdata = IS_ENABLED(CONFIG_STACKDEPOT_ALWAYS_INIT);
@@ -62,7 +62,7 @@ static unsigned int stack_bucket_number_order;
 static unsigned int stack_hash_mask;
 
 /* Array of memory regions that store stack records. */
-static void *stack_pools[DEPOT_MAX_POOLS];
+static void **stack_pools;
 /* Newly allocated pool that is not yet added to stack_pools. */
 static void *new_pool;
 /* Number of pools in stack_pools. */
@@ -101,6 +101,34 @@ static int __init disable_stack_depot(char *str)
 }
 early_param("stack_depot_disable", disable_stack_depot);
 
+static int __init parse_max_pools(char *str)
+{
+       const long long limit = (1LL << (DEPOT_POOL_INDEX_BITS)) - 1;

lib/stackdepot.c static int __init disable_stack_depot(char *str) · line 116

Quoted 10 lines
lib/stackdepot.c +10 -0
+       unsigned int max_pools;
+       int rv;
+
+       rv = kstrtouint(str, 0, &max_pools);
+       if (rv)
+               return rv;
+
+       if (max_pools < 1024) {
+               pr_err("stack_depot_max_pools below 1024, using default of %u\n",
+                      stack_max_pools);

nit: I feel the choice of 1024 should be somewhat more documented, because right now it looks like a magic value.

Quoted 19 lines
lib/stackdepot.c +15 -0
+               goto out;
+       }
+
+       if (max_pools > limit) {
+               pr_err("stack_depot_max_pools exceeds %lld, using default of %u\n",
+                      limit, stack_max_pools);
+               goto out;
+       }
+
+       stack_max_pools = max_pools;
+out:
+       return 0;
+}
+early_param("stack_depot_max_pools", parse_max_pools);
+
 void __init stack_depot_request_early_init(void)
 {
        /* Too late to request early init now. */

lib/stackdepot.c int __init stack_depot_early_init(void) · line 216

Quoted 7 lines
lib/stackdepot.c +4 -0
@@ -182,6 +210,17 @@ int __init stack_depot_early_init(void)
        }
        init_stack_table(entries);
 
+       pr_info("allocating space for %u stack pools via memblock\n",
+               stack_max_pools);
+       stack_pools =
+               memblock_alloc(stack_max_pools * sizeof(void *), PAGE_SIZE);

Bike-shedding territory: Kernel allows up to 120 cols if it helps readability. Line-break-assignments just look wrong and clang-format should be fixed. Regardless, I know some folks just want to follow what clang-format suggests without much consideration for readability.

Quoted 51 lines
lib/stackdepot.c +20 -4
+       if (!stack_pools) {
+               pr_err("stack pools allocation failed, disabling\n");
+               memblock_free(stack_table, entries * sizeof(struct list_head));
+               stack_depot_disabled = true;
+               return -ENOMEM;
+       }
+
        return 0;
 }
 
@@ -231,6 +270,16 @@ int stack_depot_init(void)
        stack_hash_mask = entries - 1;
        init_stack_table(entries);
 
+       pr_info("allocating space for %u stack pools via kvcalloc\n",
+               stack_max_pools);
+       stack_pools = kvcalloc(stack_max_pools, sizeof(void *), GFP_KERNEL);
+       if (!stack_pools) {
+               pr_err("stack pools allocation failed, disabling\n");
+               kvfree(stack_table);
+               stack_depot_disabled = true;
+               ret = -ENOMEM;
+       }
+
 out_unlock:
        mutex_unlock(&stack_depot_init_mutex);
 
@@ -245,9 +294,9 @@ static bool depot_init_pool(void **prealloc)
 {
        lockdep_assert_held(&pool_lock);
 
-       if (unlikely(pools_num >= DEPOT_MAX_POOLS)) {
+       if (unlikely(pools_num >= stack_max_pools)) {
                /* Bail out if we reached the pool limit. */
-               WARN_ON_ONCE(pools_num > DEPOT_MAX_POOLS); /* should never happen */
+               WARN_ON_ONCE(pools_num > stack_max_pools); /* should never happen */
                WARN_ON_ONCE(!new_pool); /* to avoid unnecessary pre-allocation */
                WARN_ONCE(1, "Stack depot reached limit capacity");
                return false;
@@ -273,7 +322,7 @@ static bool depot_init_pool(void **prealloc)
         * NULL; do not reset to NULL if we have reached the maximum number of
         * pools.
         */
-       if (pools_num < DEPOT_MAX_POOLS)
+       if (pools_num < stack_max_pools)
                WRITE_ONCE(new_pool, NULL);
        else
                WRITE_ONCE(new_pool, STACK_DEPOT_POISON);
--

2.34.1

Acked-by on v4 1/1
#2 lore raw
In reply to Matt Fleming
Quoted 9 lines · Matt Fleming

From: Matt Fleming <[email protected]>

We're hitting the WARN in depot_init_pool() about reaching the stack depot limit because we have long stacks that don't dedup very well.

Introduce a new start-up parameter to allow users to set the number of maximum stack depot pools.

Quoted 20 lines
lib/stackdepot.c +5 -5
@@ -36,11 +36,11 @@
 #include <linux/memblock.h>
 #include <linux/kasan-enabled.h>
 
-#define DEPOT_POOLS_CAP 8192
-/* The pool_index is offset by 1 so the first record does not have a 0 handle. */
-#define DEPOT_MAX_POOLS \
-	(((1LL << (DEPOT_POOL_INDEX_BITS)) - 1 < DEPOT_POOLS_CAP) ? \
-	 (1LL << (DEPOT_POOL_INDEX_BITS)) - 1 : DEPOT_POOLS_CAP)
+/*
+ * The pool_index is offset by 1 so the first record does not have a 0 handle.
+ */
+static unsigned int stack_max_pools __read_mostly =
+	MIN((1LL << DEPOT_POOL_INDEX_BITS) - 1, 8192);
 
 static bool stack_depot_disabled;
 static bool __stack_depot_early_init_requested __initdata = IS_ENABLED(CONFIG_STACKDEPOT_ALWAYS_INIT);

lib/stackdepot.c static unsigned int stack_bucket_number_order; · line 65

Quoted 5 lines
lib/stackdepot.c +1 -1
@@ -62,7 +62,7 @@ static unsigned int stack_bucket_number_order;
 static unsigned int stack_hash_mask;
 
 /* Array of memory regions that store stack records. */
-static void *stack_pools[DEPOT_MAX_POOLS];
+static void **stack_pools;

Also nice that (AFAIU) we now save this previously statically allocated array's memory if stackdepot is built-in but not used by anything.

Quoted 18 lines
lib/stackdepot.c +11 -0
 /* Newly allocated pool that is not yet added to stack_pools. */
 static void *new_pool;
 /* Number of pools in stack_pools. */
@@ -101,6 +101,34 @@ static int __init disable_stack_depot(char *str)
 }
 early_param("stack_depot_disable", disable_stack_depot);
 
+static int __init parse_max_pools(char *str)
+{
+	const long long limit = (1LL << (DEPOT_POOL_INDEX_BITS)) - 1;
+	unsigned int max_pools;
+	int rv;
+
+	rv = kstrtouint(str, 0, &max_pools);
+	if (rv)
+		return rv;
+
+	if (max_pools < 1024) {

lib/stackdepot.c static int __init disable_stack_depot(char *str) · line 124

Quoted 10 lines
lib/stackdepot.c +10 -0
+		pr_err("stack_depot_max_pools below 1024, using default of %u\n",
+		       stack_max_pools);
+		goto out;
+	}
+
+	if (max_pools > limit) {
+		pr_err("stack_depot_max_pools exceeds %lld, using default of %u\n",
+		       limit, stack_max_pools);
+		goto out;
+	}

Maybe we could bound the requested value to between 1024 and limit instead of falling back to the default and completely ignoring it when it's out of the range?

Quoted 6 lines
lib/stackdepot.c +6 -0
+	stack_max_pools = max_pools;
+out:
+	return 0;
+}
+early_param("stack_depot_max_pools", parse_max_pools);
+