From patchwork Thu Oct 24 04:35:25 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Muchun Song X-Patchwork-Id: 13848298 Received: from mail-pg1-f179.google.com (mail-pg1-f179.google.com [209.85.215.179]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8BD1E158862 for ; Thu, 24 Oct 2024 04:36:50 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1729744614; cv=none; b=FNW4aQRqam8ikSCvz7p7McwW93Y8AJrbHBPdJS1IFJ6W1BtAso1IZy9pTMVYnZZKKLp5nKGjwTZ81ZYBSM/o43UsNiLGyExE3g+d4jth1YhH1YgyurKtJuWO+/GKXVAlJqRAgU/h7WJP1EA59povdJF4wPcWnSSJGf/vEOQ+hfE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1729744614; c=relaxed/simple; bh=0xHsIDR9nQXTWPtVCvWpad1re8GISE2n+yQsKhnNEsA=; h=From:To:Cc:Subject:Date:Message-Id:MIME-Version; b=dBaiimlgqUHb48FhURJiYksIMbT9hAB9fVQNcNLwN/rXnMi6b2dUMIS4O1HXJ2uwvgT1pqu+q+g2A2LMuK1nKm7MQIxi48kncIuai+Dwu4LxFpqNsf7VqDt68TkKLovIKLUgTWOSXXeWYiyyEtE5aYfKpC6ujV81OD7EPbaRzB8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=bytedance.com; spf=pass smtp.mailfrom=bytedance.com; dkim=pass (2048-bit key) header.d=bytedance.com header.i=@bytedance.com header.b=T3qqcq2v; arc=none smtp.client-ip=209.85.215.179 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=bytedance.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=bytedance.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=bytedance.com header.i=@bytedance.com header.b="T3qqcq2v" Received: by mail-pg1-f179.google.com with SMTP id 41be03b00d2f7-7ea76a12c32so307642a12.1 for ; Wed, 23 Oct 2024 21:36:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1729744610; x=1730349410; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=MXl2e78MmAfJ5YnG8JHxdcmasUVncNg3So4LAyflpt8=; b=T3qqcq2vYyFE+GH3nI2tKXxDs8STXWub5jAQes3AI6+1hJZ+1Kbz2SLRHzUsAOECOD 9b8MXidtImnGQmWoqBKm8JfDgKaj4B0Vx1o/QS3CID5j/2lLLXvxpssuP4KB1VWDK6vv XN/s6ZPOVNzt9tNcfsACxGR+qLrIvyIt5fH2YpX2AXQdXbfz1FhfR6mQgA88DObynV1q HiP9IPCN/a+CFmm60CWYFjU+BErRDYDl6bnkM/hVJ6NfAX/NGRCeXLGipQGzKAggkjeU yq0TeT3XBhcPAfQ1UJgEcJzTvOUmUgPO57YkWAignsDhesaHFWDvsJ5tungDv6HZ0a9M Rv5w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1729744610; x=1730349410; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=MXl2e78MmAfJ5YnG8JHxdcmasUVncNg3So4LAyflpt8=; b=WFnDvQVoKaJ/rsiKxd2S04l9WK9Tejz5ayChH5zVSh2CbHqUN3pGBWUvU6hS5InCb2 JqM6KQ0/4NxLZf0hRTdLEtMyAUv9SCubf00bixKXRv1JYaY3mrymcOyFDqfeHF/ELA2p 8TCOYgkXEys2O8uZQN/jPv6RxSVd5bd1RGSGwBYHkk97RWivBRAzfjUo6vjeP6vy0H53 XqpqsxMEEVVNc16zooeA+KcmjHDZZyEynZqehfAtbrErDT/67B9Nmz05X3+4bd3Yo5CB vFuPfRdQY0/oNLm6xFUMHLRi0tNW7FHD/HDPyEJKvXvnqjDWS5nUgPU3EDgS3Q3QDnFX I8Bg== X-Forwarded-Encrypted: i=1; AJvYcCXmfGRgxgUqVJ2DysDm+2ktulgeh3sJaKNqEVJeTBDh24FmcopUOn3gPgTgFq7Nr7osYXF8pZFYC1+yUQ==@vger.kernel.org X-Gm-Message-State: AOJu0YwmgA4NBs28G9yW+Hyg+R0BPUsRm3Q+NyppoympFO3EKktOhBBn ESqAhU19A7m3K6Y52sQF+RAaLYqmvUPDh4m8BzHJvd6NsFWOqxZdmYk2ND17G4U= X-Google-Smtp-Source: AGHT+IF44oDg1FP3y1VznBP3ivYT9eDUaI/+kOtvTPpJ5x2Ur7GrKayMV/LDqaW8iBQzwmVJx2t2uw== X-Received: by 2002:a17:903:2302:b0:207:1675:6709 with SMTP id d9443c01a7336-20fa70773c8mr68102745ad.0.1729744609767; Wed, 23 Oct 2024 21:36:49 -0700 (PDT) Received: from PXLDJ45XCM.bytedance.net ([61.213.176.8]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-20e7ef0bda3sm65239735ad.91.2024.10.23.21.36.46 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 23 Oct 2024 21:36:49 -0700 (PDT) From: Muchun Song To: axboe@kernel.dk Cc: mingo@redhat.com, peterz@infradead.org, chengming.zhou@linux.dev, muchun.song@linux.dev, linux-block@vger.kernel.org, linux-kernel@vger.kernel.org, Muchun Song Subject: [PATCH] block: refactor rq_qos_wait() Date: Thu, 24 Oct 2024 12:35:25 +0800 Message-Id: <20241024043525.98663-1-songmuchun@bytedance.com> X-Mailer: git-send-email 2.39.5 (Apple Git-154) Precedence: bulk X-Mailing-List: linux-block@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 When rq_qos_wait() is first introduced, it is easy to understand. But with some bug fixes applied, it is not easy for newcomers to understand the whole logic under those fixes. In this patch, rq_qos_wait() is refactored and more comments are added for better understanding. There are 4 points for the improvement: 1) Use waitqueue_active() instead of wq_has_sleeper() to eliminate unnecessary memory barrier in wq_has_sleeper() which is supposed to be used in waker side. In this case, we do need the barrier. So use the cheaper one to locklessly test for waiters on the queue. 2) There is already a macro DEFINE_WAIT_FUNC() to declare a wait_queue_entry with a specified waking function. But there is not a counterpart for initializing one wait_queue_entry with a specified waking function. So introducing init_wait_func() for this, which also could be used elsewhere (like filemap.c). It can be used in rq_qos_wait() to use default_wake_function() to wake up waiters, which could remove ->task field from rq_qos_wait_data. 3) Remove acquire_inflight_cb() logic for the first waiter out of the while loop to make the code clear. 4) Add more comments to explain how to sync with different waiters and the waker. Signed-off-by: Muchun Song Reviewed-by: Yu Kuai --- block/blk-rq-qos.c | 82 +++++++++++++++++++++++++++++--------------- include/linux/wait.h | 6 ++-- 2 files changed, 58 insertions(+), 30 deletions(-) diff --git a/block/blk-rq-qos.c b/block/blk-rq-qos.c index 9b0aa7dd6779f..5d995d389eaf5 100644 --- a/block/blk-rq-qos.c +++ b/block/blk-rq-qos.c @@ -196,7 +196,6 @@ bool rq_depth_scale_down(struct rq_depth *rqd, bool hard_throttle) struct rq_qos_wait_data { struct wait_queue_entry wq; - struct task_struct *task; struct rq_wait *rqw; acquire_inflight_cb_t *cb; void *private_data; @@ -218,7 +217,20 @@ static int rq_qos_wake_function(struct wait_queue_entry *curr, return -1; data->got_token = true; - wake_up_process(data->task); + /* + * autoremove_wake_function() removes the wait entry only when it + * actually changed the task state. We want the wait always removed. + * Remove explicitly and use default_wake_function(). + */ + default_wake_function(curr, mode, wake_flags, key); + /* + * Note that the order of operations is important as finish_wait() + * tests whether @curr is removed without grabbing the lock. This + * should be the last thing to do to make sure we will not have a + * UAF access to @data. And the semantics of memory barrier in it + * also make sure the waiter will see the latest @data->got_token + * once list_empty_careful() in finish_wait() returns true. + */ list_del_init_careful(&curr->entry); return 1; } @@ -244,41 +256,55 @@ void rq_qos_wait(struct rq_wait *rqw, void *private_data, cleanup_cb_t *cleanup_cb) { struct rq_qos_wait_data data = { - .wq = { - .func = rq_qos_wake_function, - .entry = LIST_HEAD_INIT(data.wq.entry), - }, - .task = current, - .rqw = rqw, - .cb = acquire_inflight_cb, - .private_data = private_data, + .rqw = rqw, + .cb = acquire_inflight_cb, + .private_data = private_data, + .got_token = false, }; - bool has_sleeper; + bool first_waiter; - has_sleeper = wq_has_sleeper(&rqw->wait); - if (!has_sleeper && acquire_inflight_cb(rqw, private_data)) + /* + * If there are no waiters in the waiting queue, try to increase the + * inflight counter if we can. Otherwise, prepare for adding ourselves + * to the waiting queue. + */ + if (!waitqueue_active(&rqw->wait) && acquire_inflight_cb(rqw, private_data)) return; - has_sleeper = !prepare_to_wait_exclusive(&rqw->wait, &data.wq, + init_wait_func(&data.wq, rq_qos_wake_function); + first_waiter = prepare_to_wait_exclusive(&rqw->wait, &data.wq, TASK_UNINTERRUPTIBLE); + /* + * Make sure there is at least one inflight process; otherwise, waiters + * will never be woken up. Since there may be no inflight process before + * adding ourselves to the waiting queue above, we need to try to + * increase the inflight counter for ourselves. And it is sufficient to + * guarantee that at least the first waiter to enter the waiting queue + * will re-check the waiting condition before going to sleep, thus + * ensuring forward progress. + */ + if (!data.got_token && first_waiter && acquire_inflight_cb(rqw, private_data)) { + finish_wait(&rqw->wait, &data.wq); + /* + * We raced with rq_qos_wake_function() getting a token, + * which means we now have two. Put our local token + * and wake anyone else potentially waiting for one. + * + * Enough memory barrier in list_empty_careful() in + * finish_wait() is paired with list_del_init_careful() + * in rq_qos_wake_function() to make sure we will see + * the latest @data->got_token. + */ + if (data.got_token) + cleanup_cb(rqw, private_data); + return; + } + + /* we are now relying on the waker to increase our inflight counter. */ do { - /* The memory barrier in set_task_state saves us here. */ if (data.got_token) break; - if (!has_sleeper && acquire_inflight_cb(rqw, private_data)) { - finish_wait(&rqw->wait, &data.wq); - - /* - * We raced with rq_qos_wake_function() getting a token, - * which means we now have two. Put our local token - * and wake anyone else potentially waiting for one. - */ - if (data.got_token) - cleanup_cb(rqw, private_data); - return; - } io_schedule(); - has_sleeper = true; set_current_state(TASK_UNINTERRUPTIBLE); } while (1); finish_wait(&rqw->wait, &data.wq); diff --git a/include/linux/wait.h b/include/linux/wait.h index 8aa3372f21a08..b008ca42b5903 100644 --- a/include/linux/wait.h +++ b/include/linux/wait.h @@ -1206,14 +1206,16 @@ int autoremove_wake_function(struct wait_queue_entry *wq_entry, unsigned mode, i #define DEFINE_WAIT(name) DEFINE_WAIT_FUNC(name, autoremove_wake_function) -#define init_wait(wait) \ +#define init_wait_func(wait, function) \ do { \ (wait)->private = current; \ - (wait)->func = autoremove_wake_function; \ + (wait)->func = function; \ INIT_LIST_HEAD(&(wait)->entry); \ (wait)->flags = 0; \ } while (0) +#define init_wait(wait) init_wait_func(wait, autoremove_wake_function) + typedef int (*task_call_f)(struct task_struct *p, void *arg); extern int task_call_func(struct task_struct *p, task_call_f func, void *arg);