]> git.proxmox.com Git - mirror_ubuntu-kernels.git/commit
net: add net device refcount tracker infrastructure
authorEric Dumazet <edumazet@google.com>
Sun, 5 Dec 2021 04:21:57 +0000 (20:21 -0800)
committerJakub Kicinski <kuba@kernel.org>
Tue, 7 Dec 2021 00:05:07 +0000 (16:05 -0800)
commit4d92b95ff2f95f13df9bad0b5a25a9f60e72758d
tree0e0fa4c1662c49b683170ed02da58ab253da23d7
parent914a7b5000d08f1487e0efa52f27c4b7ea75b893
net: add net device refcount tracker infrastructure

net device are refcounted. Over the years we had numerous bugs
caused by imbalanced dev_hold() and dev_put() calls.

The general idea is to be able to precisely pair each decrement with
a corresponding prior increment. Both share a cookie, basically
a pointer to private data storing stack traces.

This patch adds dev_hold_track() and dev_put_track().

To use these helpers, each data structure owning a refcount
should also use a "netdevice_tracker" to pair the hold and put.

netdevice_tracker dev_tracker;
...
dev_hold_track(dev, &dev_tracker, GFP_ATOMIC);
...
dev_put_track(dev, &dev_tracker);

Whenever a leak happens, we will get precise stack traces
of the point dev_hold_track() happened, at device dismantle phase.

We will also get a stack trace if too many dev_put_track() for the same
netdevice_tracker are attempted.

This is guarded by CONFIG_NET_DEV_REFCNT_TRACKER option.

Signed-off-by: Eric Dumazet <edumazet@google.com>
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
include/linux/netdevice.h
lib/Kconfig.debug
net/Kconfig.debug [new file with mode: 0644]
net/core/dev.c