History

lib: add reference counting tracking infrastructure

It can be hard to track where references are taken and released. In networking, we have annoying issues at device or netns dismantles, and we had various proposals to ease root causing them. This patch adds new infrastructure pairing refcount increases and decreases. This will self document code, because programmers will have to associate increments/decrements. This is controled by CONFIG_REF_TRACKER which can be selected by users of this feature. This adds both cpu and memory costs, and thus should probably be used with care.

Eric Dumazet committed 4 years ago

Commit 4e669341 parent ce832784 files · +220 −0Browse files

Unified · Split

4 files
  1. include/linux/ref_tracker.h +73 −0
  2. lib/Kconfig +5 −0
  3. lib/Makefile +2 −0
  4. lib/ref_tracker.c +140 −0
include/linux/ref_tracker.h+73−0
@@ -0,0 +1,73 @@
1// SPDX-License-Identifier: GPL-2.0-or-later
2#ifndef _LINUX_REF_TRACKER_H
3#define _LINUX_REF_TRACKER_H
4#include <linux/refcount.h>
5#include <linux/types.h>
6#include <linux/spinlock.h>
7
8struct ref_tracker;
9
10struct ref_tracker_dir {
11#ifdef CONFIG_REF_TRACKER
12 spinlock_t lock;
13 unsigned int quarantine_avail;
14 refcount_t untracked;
15 struct list_head list; /* List of active trackers */
16 struct list_head quarantine; /* List of dead trackers */
17#endif
18};
19
20#ifdef CONFIG_REF_TRACKER
21static inline void ref_tracker_dir_init(struct ref_tracker_dir *dir,
22 unsigned int quarantine_count)
23{
24 INIT_LIST_HEAD(&dir->list);
25 INIT_LIST_HEAD(&dir->quarantine);
26 spin_lock_init(&dir->lock);
27 dir->quarantine_avail = quarantine_count;
28 refcount_set(&dir->untracked, 1);
29}
30
31void ref_tracker_dir_exit(struct ref_tracker_dir *dir);
32
33void ref_tracker_dir_print(struct ref_tracker_dir *dir,
34 unsigned int display_limit);
35
36int ref_tracker_alloc(struct ref_tracker_dir *dir,
37 struct ref_tracker **trackerp, gfp_t gfp);
38
39int ref_tracker_free(struct ref_tracker_dir *dir,
40 struct ref_tracker **trackerp);
41
42#else /* CONFIG_REF_TRACKER */
43
44static inline void ref_tracker_dir_init(struct ref_tracker_dir *dir,
45 unsigned int quarantine_count)
46{
47}
48
49static inline void ref_tracker_dir_exit(struct ref_tracker_dir *dir)
50{
51}
52
53static inline void ref_tracker_dir_print(struct ref_tracker_dir *dir,
54 unsigned int display_limit)
55{
56}
57
58static inline int ref_tracker_alloc(struct ref_tracker_dir *dir,
59 struct ref_tracker **trackerp,
60 gfp_t gfp)
61{
62 return 0;
63}
64
65static inline int ref_tracker_free(struct ref_tracker_dir *dir,
66 struct ref_tracker **trackerp)
67{
68 return 0;
69}
70
71#endif
72
73#endif /* _LINUX_REF_TRACKER_H */
lib/Kconfig+5−0
@@ -680,6 +680,11 @@ config STACK_HASH_ORDER · 679 unmodified lines
680 Select the hash size as a power of 2 for the stackdepot hash table.680 Select the hash size as a power of 2 for the stackdepot hash table.
681 Choose a lower value to reduce the memory impact.681 Choose a lower value to reduce the memory impact.
682 682
683config REF_TRACKER
684 bool
685 depends on STACKTRACE_SUPPORT
686 select STACKDEPOT
687
683config SBITMAP688config SBITMAP
684 bool689 bool
685 690
lib/Makefile+2−0
@@ -270,6 +270,8 @@ obj-$(CONFIG_STACKDEPOT) += stackdepot.o · 269 unmodified lines
270KASAN_SANITIZE_stackdepot.o := n270KASAN_SANITIZE_stackdepot.o := n
271KCOV_INSTRUMENT_stackdepot.o := n271KCOV_INSTRUMENT_stackdepot.o := n
272 272
273obj-$(CONFIG_REF_TRACKER) += ref_tracker.o
274
273libfdt_files = fdt.o fdt_ro.o fdt_wip.o fdt_rw.o fdt_sw.o fdt_strerror.o \275libfdt_files = fdt.o fdt_ro.o fdt_wip.o fdt_rw.o fdt_sw.o fdt_strerror.o \
274 fdt_empty_tree.o fdt_addresses.o276 fdt_empty_tree.o fdt_addresses.o
275$(foreach file, $(libfdt_files), \277$(foreach file, $(libfdt_files), \
lib/ref_tracker.c+140−0
@@ -0,0 +1,140 @@
1// SPDX-License-Identifier: GPL-2.0-or-later
2#include <linux/export.h>
3#include <linux/ref_tracker.h>
4#include <linux/slab.h>
5#include <linux/stacktrace.h>
6#include <linux/stackdepot.h>
7
8#define REF_TRACKER_STACK_ENTRIES 16
9
10struct ref_tracker {
11 struct list_head head; /* anchor into dir->list or dir->quarantine */
12 bool dead;
13 depot_stack_handle_t alloc_stack_handle;
14 depot_stack_handle_t free_stack_handle;
15};
16
17void ref_tracker_dir_exit(struct ref_tracker_dir *dir)
18{
19 struct ref_tracker *tracker, *n;
20 unsigned long flags;
21 bool leak = false;
22
23 spin_lock_irqsave(&dir->lock, flags);
24 list_for_each_entry_safe(tracker, n, &dir->quarantine, head) {
25 list_del(&tracker->head);
26 kfree(tracker);
27 dir->quarantine_avail++;
28 }
29 list_for_each_entry_safe(tracker, n, &dir->list, head) {
30 pr_err("leaked reference.\n");
31 if (tracker->alloc_stack_handle)
32 stack_depot_print(tracker->alloc_stack_handle);
33 leak = true;
34 list_del(&tracker->head);
35 kfree(tracker);
36 }
37 spin_unlock_irqrestore(&dir->lock, flags);
38 WARN_ON_ONCE(leak);
39 WARN_ON_ONCE(refcount_read(&dir->untracked) != 1);
40}
41EXPORT_SYMBOL(ref_tracker_dir_exit);
42
43void ref_tracker_dir_print(struct ref_tracker_dir *dir,
44 unsigned int display_limit)
45{
46 struct ref_tracker *tracker;
47 unsigned long flags;
48 unsigned int i = 0;
49
50 spin_lock_irqsave(&dir->lock, flags);
51 list_for_each_entry(tracker, &dir->list, head) {
52 if (i < display_limit) {
53 pr_err("leaked reference.\n");
54 if (tracker->alloc_stack_handle)
55 stack_depot_print(tracker->alloc_stack_handle);
56 i++;
57 } else {
58 break;
59 }
60 }
61 spin_unlock_irqrestore(&dir->lock, flags);
62}
63EXPORT_SYMBOL(ref_tracker_dir_print);
64
65int ref_tracker_alloc(struct ref_tracker_dir *dir,
66 struct ref_tracker **trackerp,
67 gfp_t gfp)
68{
69 unsigned long entries[REF_TRACKER_STACK_ENTRIES];
70 struct ref_tracker *tracker;
71 unsigned int nr_entries;
72 unsigned long flags;
73
74 *trackerp = tracker = kzalloc(sizeof(*tracker), gfp | __GFP_NOFAIL);
75 if (unlikely(!tracker)) {
76 pr_err_once("memory allocation failure, unreliable refcount tracker.\n");
77 refcount_inc(&dir->untracked);
78 return -ENOMEM;
79 }
80 nr_entries = stack_trace_save(entries, ARRAY_SIZE(entries), 1);
81 nr_entries = filter_irq_stacks(entries, nr_entries);
82 tracker->alloc_stack_handle = stack_depot_save(entries, nr_entries, gfp);
83
84 spin_lock_irqsave(&dir->lock, flags);
85 list_add(&tracker->head, &dir->list);
86 spin_unlock_irqrestore(&dir->lock, flags);
87 return 0;
88}
89EXPORT_SYMBOL_GPL(ref_tracker_alloc);
90
91int ref_tracker_free(struct ref_tracker_dir *dir,
92 struct ref_tracker **trackerp)
93{
94 unsigned long entries[REF_TRACKER_STACK_ENTRIES];
95 struct ref_tracker *tracker = *trackerp;
96 depot_stack_handle_t stack_handle;
97 unsigned int nr_entries;
98 unsigned long flags;
99
100 if (!tracker) {
101 refcount_dec(&dir->untracked);
102 return -EEXIST;
103 }
104 nr_entries = stack_trace_save(entries, ARRAY_SIZE(entries), 1);
105 nr_entries = filter_irq_stacks(entries, nr_entries);
106 stack_handle = stack_depot_save(entries, nr_entries, GFP_ATOMIC);
107
108 spin_lock_irqsave(&dir->lock, flags);
109 if (tracker->dead) {
110 pr_err("reference already released.\n");
111 if (tracker->alloc_stack_handle) {
112 pr_err("allocated in:\n");
113 stack_depot_print(tracker->alloc_stack_handle);
114 }
115 if (tracker->free_stack_handle) {
116 pr_err("freed in:\n");
117 stack_depot_print(tracker->free_stack_handle);
118 }
119 spin_unlock_irqrestore(&dir->lock, flags);
120 WARN_ON_ONCE(1);
121 return -EINVAL;
122 }
123 tracker->dead = true;
124
125 tracker->free_stack_handle = stack_handle;
126
127 list_move_tail(&tracker->head, &dir->quarantine);
128 if (!dir->quarantine_avail) {
129 tracker = list_first_entry(&dir->quarantine, struct ref_tracker, head);
130 list_del(&tracker->head);
131 } else {
132 dir->quarantine_avail--;
133 tracker = NULL;
134 }
135 spin_unlock_irqrestore(&dir->lock, flags);
136
137 kfree(tracker);
138 return 0;
139}
140EXPORT_SYMBOL_GPL(ref_tracker_free);

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t