Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dpll: fix possible deadlock during netlink dump operation

Recently, I've been hitting following deadlock warning during dpll pin
dump:

[52804.637962] ======================================================
[52804.638536] WARNING: possible circular locking dependency detected
[52804.639111] 6.8.0-rc2jiri+ #1 Not tainted
[52804.639529] ------------------------------------------------------
[52804.640104] python3/2984 is trying to acquire lock:
[52804.640581] ffff88810e642678 (nlk_cb_mutex-GENERIC){+.+.}-{3:3}, at: netlink_dump+0xb3/0x780
[52804.641417]
but task is already holding lock:
[52804.642010] ffffffff83bde4c8 (dpll_lock){+.+.}-{3:3}, at: dpll_lock_dumpit+0x13/0x20
[52804.642747]
which lock already depends on the new lock.

[52804.643551]
the existing dependency chain (in reverse order) is:
[52804.644259]
-> #1 (dpll_lock){+.+.}-{3:3}:
[52804.644836] lock_acquire+0x174/0x3e0
[52804.645271] __mutex_lock+0x119/0x1150
[52804.645723] dpll_lock_dumpit+0x13/0x20
[52804.646169] genl_start+0x266/0x320
[52804.646578] __netlink_dump_start+0x321/0x450
[52804.647056] genl_family_rcv_msg_dumpit+0x155/0x1e0
[52804.647575] genl_rcv_msg+0x1ed/0x3b0
[52804.648001] netlink_rcv_skb+0xdc/0x210
[52804.648440] genl_rcv+0x24/0x40
[52804.648831] netlink_unicast+0x2f1/0x490
[52804.649290] netlink_sendmsg+0x36d/0x660
[52804.649742] __sock_sendmsg+0x73/0xc0
[52804.650165] __sys_sendto+0x184/0x210
[52804.650597] __x64_sys_sendto+0x72/0x80
[52804.651045] do_syscall_64+0x6f/0x140
[52804.651474] entry_SYSCALL_64_after_hwframe+0x46/0x4e
[52804.652001]
-> #0 (nlk_cb_mutex-GENERIC){+.+.}-{3:3}:
[52804.652650] check_prev_add+0x1ae/0x1280
[52804.653107] __lock_acquire+0x1ed3/0x29a0
[52804.653559] lock_acquire+0x174/0x3e0
[52804.653984] __mutex_lock+0x119/0x1150
[52804.654423] netlink_dump+0xb3/0x780
[52804.654845] __netlink_dump_start+0x389/0x450
[52804.655321] genl_family_rcv_msg_dumpit+0x155/0x1e0
[52804.655842] genl_rcv_msg+0x1ed/0x3b0
[52804.656272] netlink_rcv_skb+0xdc/0x210
[52804.656721] genl_rcv+0x24/0x40
[52804.657119] netlink_unicast+0x2f1/0x490
[52804.657570] netlink_sendmsg+0x36d/0x660
[52804.658022] __sock_sendmsg+0x73/0xc0
[52804.658450] __sys_sendto+0x184/0x210
[52804.658877] __x64_sys_sendto+0x72/0x80
[52804.659322] do_syscall_64+0x6f/0x140
[52804.659752] entry_SYSCALL_64_after_hwframe+0x46/0x4e
[52804.660281]
other info that might help us debug this:

[52804.661077] Possible unsafe locking scenario:

[52804.661671] CPU0 CPU1
[52804.662129] ---- ----
[52804.662577] lock(dpll_lock);
[52804.662924] lock(nlk_cb_mutex-GENERIC);
[52804.663538] lock(dpll_lock);
[52804.664073] lock(nlk_cb_mutex-GENERIC);
[52804.664490]

The issue as follows: __netlink_dump_start() calls control->start(cb)
with nlk->cb_mutex held. In control->start(cb) the dpll_lock is taken.
Then nlk->cb_mutex is released and taken again in netlink_dump(), while
dpll_lock still being held. That leads to ABBA deadlock when another
CPU races with the same operation.

Fix this by moving dpll_lock taking into dumpit() callback which ensures
correct lock taking order.

Fixes: 9d71b54b65b1 ("dpll: netlink: Add DPLL framework base functions")
Signed-off-by: Jiri Pirko <jiri@nvidia.com>
Reviewed-by: Arkadiusz Kubalewski <arkadiusz.kubalewski@intel.com>
Link: https://lore.kernel.org/r/20240207115902.371649-1-jiri@resnulli.us
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Jiri Pirko and committed by
Jakub Kicinski
53c0441d 1f719a2f

+6 -24
-4
Documentation/netlink/specs/dpll.yaml
··· 384 384 - type 385 385 386 386 dump: 387 - pre: dpll-lock-dumpit 388 - post: dpll-unlock-dumpit 389 387 reply: *dev-attrs 390 388 391 389 - ··· 471 473 - fractional-frequency-offset 472 474 473 475 dump: 474 - pre: dpll-lock-dumpit 475 - post: dpll-unlock-dumpit 476 476 request: 477 477 attributes: 478 478 - id
+6 -14
drivers/dpll/dpll_netlink.c
··· 1199 1199 unsigned long i; 1200 1200 int ret = 0; 1201 1201 1202 + mutex_lock(&dpll_lock); 1202 1203 xa_for_each_marked_start(&dpll_pin_xa, i, pin, DPLL_REGISTERED, 1203 1204 ctx->idx) { 1204 1205 if (!dpll_pin_available(pin)) ··· 1219 1218 } 1220 1219 genlmsg_end(skb, hdr); 1221 1220 } 1221 + mutex_unlock(&dpll_lock); 1222 + 1222 1223 if (ret == -EMSGSIZE) { 1223 1224 ctx->idx = i; 1224 1225 return skb->len; ··· 1376 1373 unsigned long i; 1377 1374 int ret = 0; 1378 1375 1376 + mutex_lock(&dpll_lock); 1379 1377 xa_for_each_marked_start(&dpll_device_xa, i, dpll, DPLL_REGISTERED, 1380 1378 ctx->idx) { 1381 1379 hdr = genlmsg_put(skb, NETLINK_CB(cb->skb).portid, ··· 1393 1389 } 1394 1390 genlmsg_end(skb, hdr); 1395 1391 } 1392 + mutex_unlock(&dpll_lock); 1393 + 1396 1394 if (ret == -EMSGSIZE) { 1397 1395 ctx->idx = i; 1398 1396 return skb->len; ··· 1443 1437 struct genl_info *info) 1444 1438 { 1445 1439 mutex_unlock(&dpll_lock); 1446 - } 1447 - 1448 - int dpll_lock_dumpit(struct netlink_callback *cb) 1449 - { 1450 - mutex_lock(&dpll_lock); 1451 - 1452 - return 0; 1453 - } 1454 - 1455 - int dpll_unlock_dumpit(struct netlink_callback *cb) 1456 - { 1457 - mutex_unlock(&dpll_lock); 1458 - 1459 - return 0; 1460 1440 } 1461 1441 1462 1442 int dpll_pin_pre_doit(const struct genl_split_ops *ops, struct sk_buff *skb,
-4
drivers/dpll/dpll_nl.c
··· 95 95 }, 96 96 { 97 97 .cmd = DPLL_CMD_DEVICE_GET, 98 - .start = dpll_lock_dumpit, 99 98 .dumpit = dpll_nl_device_get_dumpit, 100 - .done = dpll_unlock_dumpit, 101 99 .flags = GENL_ADMIN_PERM | GENL_CMD_CAP_DUMP, 102 100 }, 103 101 { ··· 127 129 }, 128 130 { 129 131 .cmd = DPLL_CMD_PIN_GET, 130 - .start = dpll_lock_dumpit, 131 132 .dumpit = dpll_nl_pin_get_dumpit, 132 - .done = dpll_unlock_dumpit, 133 133 .policy = dpll_pin_get_dump_nl_policy, 134 134 .maxattr = DPLL_A_PIN_ID, 135 135 .flags = GENL_ADMIN_PERM | GENL_CMD_CAP_DUMP,
-2
drivers/dpll/dpll_nl.h
··· 30 30 void 31 31 dpll_pin_post_doit(const struct genl_split_ops *ops, struct sk_buff *skb, 32 32 struct genl_info *info); 33 - int dpll_lock_dumpit(struct netlink_callback *cb); 34 - int dpll_unlock_dumpit(struct netlink_callback *cb); 35 33 36 34 int dpll_nl_device_id_get_doit(struct sk_buff *skb, struct genl_info *info); 37 35 int dpll_nl_device_get_doit(struct sk_buff *skb, struct genl_info *info);