From patchwork Tue Mar 23 13:56:17 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Vaittinen, Matti" X-Patchwork-Id: 12158051 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 89268C433E4 for ; Tue, 23 Mar 2021 13:57:15 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 3D471619C0 for ; Tue, 23 Mar 2021 13:57:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231462AbhCWN4n (ORCPT ); Tue, 23 Mar 2021 09:56:43 -0400 Received: from mail-lj1-f175.google.com ([209.85.208.175]:37554 "EHLO mail-lj1-f175.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231264AbhCWN42 (ORCPT ); Tue, 23 Mar 2021 09:56:28 -0400 Received: by mail-lj1-f175.google.com with SMTP id r20so25744028ljk.4; Tue, 23 Mar 2021 06:56:27 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=YkgDIkTmim/5O1glQvMKfNSxF6ObBNcULBvb2FB6ZQQ=; b=bJFEAz74eKHvKE2ulO63o7LNI8KJZk/auj0Gl+MmNsuhy9/YEDeRnC4i93gpz9+8lf 4jUdc3W18bMJk2GsfTOXwG/ZxY4kZGQix1kdMzOih7ga8vEwKiBFJXZPyBHEwBfaMQSv bqs4C0goMBqJ5VWFJLYWqQNHrDjfW+cSmyU11zKjjc2KBDg7m40ulRz1K5DKH+PsFrkV 06eMIL1J3hBU6gPkYfxARI4orX1ny3LOy/w/gHwpmp71MvFOulLQUkIZYCYkUnLSD0Hi HDG0vULZ0boG4Q9uVwRGI42pjVI2Hqmm4FMgg+3p0nVVwIFHGTXff07jzTOhbTHGhD6N FB5g== X-Gm-Message-State: AOAM531SiPiZRRIa5aOeMUcj6PrGQeotjO5lN8wQapbfKqmr6/ZPRBhb mTVk/kCj5YEzB+SL0oo/y+k= X-Google-Smtp-Source: ABdhPJyq5feOEictEeFvfmt8qtd4uPXsGM6InICgywJruZvfoOZLCjpQIM+ajmYsqEt7lv77ngAV4g== X-Received: by 2002:a2e:9310:: with SMTP id e16mr3265214ljh.226.1616507785244; Tue, 23 Mar 2021 06:56:25 -0700 (PDT) Received: from localhost.localdomain (dc7vkhyyyyyyyyyyyyyby-3.rev.dnainternet.fi. [2001:14ba:16e2:8300::2]) by smtp.gmail.com with ESMTPSA id u11sm1863085lfm.78.2021.03.23.06.56.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Mar 2021 06:56:24 -0700 (PDT) Date: Tue, 23 Mar 2021 15:56:17 +0200 From: Matti Vaittinen To: Matti Vaittinen , Matti Vaittinen Cc: MyungJoo Ham , Chanwoo Choi , Andy Gross , Bjorn Andersson , Jean Delvare , Guenter Roeck , Hans de Goede , Mark Gross , Sebastian Reichel , Chen-Yu Tsai , Liam Girdwood , Mark Brown , Wim Van Sebroeck , Matti Vaittinen , gregkh@linuxfoundation.org, linux-kernel@vger.kernel.org, linux-arm-msm@vger.kernel.org, linux-hwmon@vger.kernel.org, platform-driver-x86@vger.kernel.org, linux-pm@vger.kernel.org, linux-watchdog@vger.kernel.org Subject: [PATCH v3 1/8] workqueue: Add resource managed version of delayed work init Message-ID: <51769ea4668198deb798fe47fcfb5f5288d61586.1616506559.git.matti.vaittinen@fi.rohmeurope.com> References: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: linux-watchdog@vger.kernel.org A few drivers which need a delayed work-queue must cancel work at driver detach. Some of those implement remove() solely for this purpose. Help drivers to avoid unnecessary remove and error-branch implementation by adding managed verision of delayed work initialization. This will also help drivers to avoid mixing manual and devm based unwinding when other resources are handled by devm. Signed-off-by: Matti Vaittinen Reviewed-by: Hans de Goede --- Changelog from RFCv2: - RFC dropped. No functional changes. include/linux/devm-helpers.h | 53 ++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 include/linux/devm-helpers.h diff --git a/include/linux/devm-helpers.h b/include/linux/devm-helpers.h new file mode 100644 index 000000000000..f64e0c9f3763 --- /dev/null +++ b/include/linux/devm-helpers.h @@ -0,0 +1,53 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +#ifndef __LINUX_DEVM_HELPERS_H +#define __LINUX_DEVM_HELPERS_H + +/* + * Functions which do automatically cancel operations or release resources upon + * driver detach. + * + * These should be helpful to avoid mixing the manual and devm-based resource + * management which can be source of annoying, rarely occurring, + * hard-to-reproduce bugs. + * + * Please take into account that devm based cancellation may be performed some + * time after the remove() is ran. + * + * Thus mixing devm and manual resource management can easily cause problems + * when unwinding operations with dependencies. IRQ scheduling a work in a queue + * is typical example where IRQs are often devm-managed and WQs are manually + * cleaned at remove(). If IRQs are not manually freed at remove() (and this is + * often the case when we use devm for IRQs) we have a period of time after + * remove() - and before devm managed IRQs are freed - where new IRQ may fire + * and schedule a work item which won't be cancelled because remove() was + * already ran. + */ + +#include +#include + +static inline void devm_delayed_work_drop(void *res) +{ + cancel_delayed_work_sync(res); +} + +/** + * devm_delayed_work_autocancel - Resource-managed work allocation + * @dev: Device which lifetime work is bound to + * @pdata: work to be cancelled when driver is detached + * + * Initialize work which is automatically cancelled when driver is detached. + * A few drivers need delayed work which must be cancelled before driver + * is detached to avoid accessing removed resources. + * devm_delayed_work_autocancel() can be used to omit the explicit + * cancelleation when driver is detached. + */ +static inline int devm_delayed_work_autocancel(struct device *dev, + struct delayed_work *w, + work_func_t worker) +{ + INIT_DELAYED_WORK(w, worker); + return devm_add_action(dev, devm_delayed_work_drop, w); +} + +#endif