From patchwork Tue Nov 22 17:45:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Gleixner X-Patchwork-Id: 24486 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp2353468wrr; Tue, 22 Nov 2022 09:47:36 -0800 (PST) X-Google-Smtp-Source: AA0mqf5Mzlh0iTOmC5kjWGbdtJ1iBaggkxreCezfn7hAYFYrUV11/nnoKjwr7jVChIEB8EfcNS9/ X-Received: by 2002:a17:902:7683:b0:186:9fc8:6672 with SMTP id m3-20020a170902768300b001869fc86672mr4763497pll.65.1669139256221; Tue, 22 Nov 2022 09:47:36 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669139256; cv=none; d=google.com; s=arc-20160816; b=T3gI3JiZZB9TXquUl77eytKOFiAkxVnrcSZwR724NaLzD8NQL+8kxRwBKgysCvAmOU pXvfkY4tKpI0CG1vWc83Z6NFj8QH8RRs+lgKJqc1KFrnl/+Zy5tq5lJwPTollT6LvHnc 7aiEyTU0ESznnlqsd0VkSBwsNBDY2TbrUTnXOKYXFI0Bn3PbLsrM8mPUseKI3R0t4m+9 7OVFjWHE7Hf/5/LVshdsrNwItTH09nLhuppowtq+FJNopl9vfoTwoQjTKhTUQt7cUoaG PwVZJJLdXiqQPB0L2C8VG+e5j62+Gg9eS+aLufmdsjVM9yC6RAbaLlMYfrhV0AWjGsnY nNBQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:date:mime-version:references:subject:cc:to:from :dkim-signature:dkim-signature:message-id; bh=EajXJEzifJO2k3UDHuOk2BYCYQZRqzlObtc+LJK0BY4=; b=sk7fY0aI6wnfgRVsSy17orcJy8Z9/gTW/jKk9cRS6d+a+KehhLEROOYwmf0j1t5Qvw 0aFIru8TxyGoCN97CwC7P2nxsPcRfooqCkXV8LGaEsq3epRJDFHAvDKmMDMvDTsQXgZt 3c03XHWK3rk4Ay/P7r0xlab1bYeUEBCqovhvgxKj2dCm0huJURKNVOo3Qn4qLzXnPdkY 567sUTnD4kc9naLFIxRmaJ3eCevL2uOueFNwV2QGNbify+3ryNDtf84ptXXVcrBkQFKU 0xuExORmw+QuEWtB3yXrX9ESxFMWJcZcBNqZWAyKYWOSa+WCTmCXXQpZQjpHKG1sCaw6 LNSw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=4qp6Ri4H; dkim=neutral (no key) header.i=@linutronix.de; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id s35-20020a635263000000b00460f2778437si14541885pgl.366.2022.11.22.09.47.21; Tue, 22 Nov 2022 09:47:36 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=4qp6Ri4H; dkim=neutral (no key) header.i=@linutronix.de; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234599AbiKVRqR (ORCPT + 99 others); Tue, 22 Nov 2022 12:46:17 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59340 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234281AbiKVRpl (ORCPT ); Tue, 22 Nov 2022 12:45:41 -0500 Received: from galois.linutronix.de (Galois.linutronix.de [IPv6:2a0a:51c0:0:12e:550::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 624A77D501; Tue, 22 Nov 2022 09:45:05 -0800 (PST) Message-ID: <20221122173648.793640919@linutronix.de> DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1669139104; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: references:references; bh=EajXJEzifJO2k3UDHuOk2BYCYQZRqzlObtc+LJK0BY4=; b=4qp6Ri4H+/fn2hAu4yl6rudwb18lvNrlDHP1RAa1J3h7fh8X3hnSoEEpTRSXuZsbGJD0cO U+TTXU2Oosy7AA3wOXkhWY83jco6qccmDLHM0Q87uQDUzXSbubDb9JLaZIECZ8/+6CHDfY I8S7c7yKbRvqStUVlThPnz/x+WzRq2dTVAUSkC56MiT0cyi6UpxhJZbLFfo6Qqo+9bjtYx U180hmYUzyFzFk+3OZHhkKncuWBOCwGC333cReiWhLR8I4XCqnLZLLwBGpmaNtJVqTxgAC GPVxGKu09LBmHZbaqIX6XVcdkx/wWn2neu3/aiZmud+unE0XGp6S8kNBt/4XKw== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1669139104; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: references:references; bh=EajXJEzifJO2k3UDHuOk2BYCYQZRqzlObtc+LJK0BY4=; b=JpNvIWeSy9xrBPNn4gfk7Ak7Gpwm4IyMV6VPS/4JjGs3JpEGB2IJHu29W7xv/tTc/XRnZA VPZ+uOAvYzFPUyCQ== From: Thomas Gleixner To: LKML Cc: Linus Torvalds , Steven Rostedt , Anna-Maria Behnsen , Peter Zijlstra , Stephen Boyd , Guenter Roeck , Andrew Morton , Julia Lawall , Arnd Bergmann , Viresh Kumar , Marc Zyngier , Marcel Holtmann , Johan Hedberg , Luiz Augusto von Dentz , linux-bluetooth@vger.kernel.org, "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , netdev@vger.kernel.org Subject: [patch V2 12/17] timers: Silently ignore timers with a NULL function References: <20221122171312.191765396@linutronix.de> MIME-Version: 1.0 Date: Tue, 22 Nov 2022 18:45:03 +0100 (CET) X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1750219364833572482?= X-GMAIL-MSGID: =?utf-8?q?1750219364833572482?= Tearing down timers which have circular dependencies to other functionality, e.g. workqueues, where the timer can schedule work and work can arm timers is not trivial. In those cases it is desired to shutdown the timer in a way which prevents rearming of the timer. The mechanism to do so it to set timer->function to NULL and use this as an indicator for the timer arming functions to ignore the (re)arm request. In preparation for that replace the warnings in the relevant code pathes with checks for timer->function == NULL and discard the rearm request silently. Add debug_assert_init() instead of the WARN_ON_ONCE(!timer->function) checks so that debug objects can warn about non-initialized timers. If developers fail to enable debug objects and then waste lots of time to figure out why their non-initialized timer is not firing, they deserve it. Co-developed-by: Steven Rostedt Signed-off-by: Steven Rostedt Signed-off-by: Thomas Gleixner Tested-by: Guenter Roeck Link: https://lore.kernel.org/all/20220407161745.7d6754b3@gandalf.local.home Link: https://lore.kernel.org/all/20221110064101.429013735@goodmis.org --- V2: Use continue instead of return and amend the return value docs (Steven) --- kernel/time/timer.c | 60 +++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 55 insertions(+), 5 deletions(-) --- a/kernel/time/timer.c +++ b/kernel/time/timer.c @@ -1017,7 +1017,7 @@ static inline int unsigned int idx = UINT_MAX; int ret = 0; - BUG_ON(!timer->function); + debug_assert_init(timer); /* * This is a common optimization triggered by the networking code - if @@ -1044,6 +1044,14 @@ static inline int * dequeue/enqueue dance. */ base = lock_timer_base(timer, &flags); + /* + * Has @timer been shutdown? This needs to be evaluated + * while holding base lock to prevent a race against the + * shutdown code. + */ + if (!timer->function) + goto out_unlock; + forward_timer_base(base); if (timer_pending(timer) && (options & MOD_TIMER_REDUCE) && @@ -1070,6 +1078,14 @@ static inline int } } else { base = lock_timer_base(timer, &flags); + /* + * Has @timer been shutdown? This needs to be evaluated + * while holding base lock to prevent a race against the + * shutdown code. + */ + if (!timer->function) + goto out_unlock; + forward_timer_base(base); } @@ -1128,8 +1144,12 @@ static inline int * mod_timer_pending() is the same for pending timers as mod_timer(), but * will not activate inactive timers. * + * If @timer->function == NULL then the start operation is silently + * discarded. + * * Return: - * * %0 - The timer was inactive and not modified + * * %0 - The timer was inactive and not modified or was is in + * shutdown state and the operation was discarded * * %1 - The timer was active and requeued to expire at @expires */ int mod_timer_pending(struct timer_list *timer, unsigned long expires) @@ -1155,8 +1175,12 @@ EXPORT_SYMBOL(mod_timer_pending); * same timer, then mod_timer() is the only safe way to modify the timeout, * since add_timer() cannot modify an already running timer. * + * If @timer->function == NULL then the start operation is silently + * discarded, the return value is 0 and meaningless. + * * Return: - * * %0 - The timer was inactive and started + * * %0 - The timer was inactive and started or was is in shutdown + * state and the operation was discarded * * %1 - The timer was active and requeued to expire at @expires or * the timer was active and not modified because @expires did * not change the effective expiry time @@ -1176,8 +1200,12 @@ EXPORT_SYMBOL(mod_timer); * modify an enqueued timer if that would reduce the expiration time. If * @timer is not enqueued it starts the timer. * + * If @timer->function == NULL then the start operation is silently + * discarded. + * * Return: - * * %0 - The timer was inactive and started + * * %0 - The timer was inactive and started or was is in shutdown + * state and the operation was discarded * * %1 - The timer was active and requeued to expire at @expires or * the timer was active and not modified because @expires * did not change the effective expiry time such that the @@ -1202,6 +1230,9 @@ EXPORT_SYMBOL(timer_reduce); * * If @timer->expires is already in the past @timer will be queued to * expire at the next timer tick. + * + * If @timer->function == NULL then the start operation is silently + * discarded. */ void add_timer(struct timer_list *timer) { @@ -1218,13 +1249,18 @@ EXPORT_SYMBOL(add_timer); * * This can only operate on an inactive timer. Attempts to invoke this on * an active timer are rejected with a warning. + * + * If @timer->function == NULL then the start operation is silently + * discarded. */ void add_timer_on(struct timer_list *timer, int cpu) { struct timer_base *new_base, *base; unsigned long flags; - if (WARN_ON_ONCE(timer_pending(timer) || !timer->function)) + debug_assert_init(timer); + + if (WARN_ON_ONCE(timer_pending(timer))) return; new_base = get_timer_cpu_base(timer->flags, cpu); @@ -1235,6 +1271,13 @@ void add_timer_on(struct timer_list *tim * wrong base locked. See lock_timer_base(). */ base = lock_timer_base(timer, &flags); + /* + * Has @timer been shutdown? This needs to be evaluated while + * holding base lock to prevent a race against the shutdown code. + */ + if (!timer->function) + goto out_unlock; + if (base != new_base) { timer->flags |= TIMER_MIGRATING; @@ -1248,6 +1291,7 @@ void add_timer_on(struct timer_list *tim debug_timer_activate(timer); internal_add_timer(base, timer); +out_unlock: raw_spin_unlock_irqrestore(&base->lock, flags); } EXPORT_SYMBOL_GPL(add_timer_on); @@ -1537,6 +1581,12 @@ static void expire_timers(struct timer_b fn = timer->function; + if (WARN_ON_ONCE(!fn)) { + /* Should never happen. Emphasis on should! */ + base->running_timer = NULL; + continue; + } + if (timer->flags & TIMER_IRQSAFE) { raw_spin_unlock(&base->lock); call_timer_fn(timer, fn, baseclk);