From patchwork Tue Nov 22 18:55:30 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dmitry Safonov X-Patchwork-Id: 24506 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp2388492wrr; Tue, 22 Nov 2022 11:02:42 -0800 (PST) X-Google-Smtp-Source: AA0mqf5JluH6g0IHGW/JdLJv9QYepd3G6iXgEQFvBP3YGttXAl3ZaNAA9EzBxtqHPLCl9nw7LoFO X-Received: by 2002:a17:902:b40b:b0:188:75bb:36d4 with SMTP id x11-20020a170902b40b00b0018875bb36d4mr5992364plr.55.1669143762228; Tue, 22 Nov 2022 11:02:42 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669143762; cv=none; d=google.com; s=arc-20160816; b=EKBYPSrxpflILPIKw9Iy3+kLipilsWDNPP/cI0BxVNQ6evxtyIfHFm0+kHw7sh4INz zCNzV6MUaRrVepZwv/WIhy4wgHXUXYeV7fVs559iB6PuNH38Io3ESP7RywZqT/cRpMgO Z+QHz8w6MmirWrhsOF2IJIkNXc0nYamD+2VhZHp2LZK2wFyqUptOnCRsnNcguFwJen8D cJNqGlhu7T75zG17nVAUVIiSwLJKz5ZDqDoJ1q88OKrKAmvkl0Kbbs+dKVSKlkBUUGEW 7bTjwMCZq3h3J8eUTXEt9hZK6QXXgsPCb4QANUUvZR84qMn8TIQyFsn2BVHl0F2/bGIS ytJg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=HvKmf8QkEDqM5bOgMSE5Lyq5esRkdcJRdtODvTTixyM=; b=Pi+hdpXC+0quwsIERebYbkc3SahYjDdkn8VAemr41hjt6LOYLQzv3M6SuGhny2cTf2 KmInp40ftZFcJmQM7M/IOaIoE1INx0raeYz4+FZSM0e9Pjg++Us3d/MD9OqlV4XHmNLY MahmV+r3slMrNCmSMxSG5QNMyRm8/ZLIV5nuNnoh/D8NPW065TaALkbv0ACUPLaq8ypw NgKXfSNQrdV72WzaRWE/4fb8MHsaKJS+rc/CwWMKcDKy1j+aaQY2O4QlYf4Z+XWnzF6r cggnPaDJ88kzNwxfUb6fzwRqK8dund2cQNt2IzptqxpySavOnKlTBYN0ulIpJZ0QfrOS I2eA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@arista.com header.s=google header.b="hBw/+9L4"; 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=REJECT sp=REJECT dis=NONE) header.from=arista.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id z18-20020a63e552000000b00476a08c5d68si14918943pgj.822.2022.11.22.11.02.27; Tue, 22 Nov 2022 11:02:42 -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=@arista.com header.s=google header.b="hBw/+9L4"; 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=REJECT sp=REJECT dis=NONE) header.from=arista.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234632AbiKVSz4 (ORCPT + 99 others); Tue, 22 Nov 2022 13:55:56 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54718 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234470AbiKVSzq (ORCPT ); Tue, 22 Nov 2022 13:55:46 -0500 Received: from mail-wr1-x42b.google.com (mail-wr1-x42b.google.com [IPv6:2a00:1450:4864:20::42b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0C39C7FF32 for ; Tue, 22 Nov 2022 10:55:45 -0800 (PST) Received: by mail-wr1-x42b.google.com with SMTP id d1so14003591wrs.12 for ; Tue, 22 Nov 2022 10:55:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=arista.com; s=google; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=HvKmf8QkEDqM5bOgMSE5Lyq5esRkdcJRdtODvTTixyM=; b=hBw/+9L4EZL/aiqvkrB5TAyD3y/O0/0QjkftTfqA4937+/nNf4uEMM5ZMz5YIsAF56 qvojkyFz9LFmOpSU3VK16EcO7Azp14KafzU3tmkch0zgMgkEm+CcYrrSO15/mwxjwvYX kXJRqYkglrr2udytY7dEl92qDUMHYjvtjeA+m9x2ncnkPpxHlc3vG5JnD3eqn9F52cLp 6xMtNgk7VcVcjHh1BaJq+AhZKBH3CytGaLvsZA6ygdmc3PEkK/uFAtLWXEM8vawVI18V sxJ7N6/Y/3/vASRsiTnWtWSXzGOC+W/G7D7g6IP1KIpAcCEot6u2nn2KsCe9kxa7Xfgc hGHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=HvKmf8QkEDqM5bOgMSE5Lyq5esRkdcJRdtODvTTixyM=; b=4+wZoLOgemK6mVtwVFlBe2WEFtXWiA8uYPzM1iucMOalawc2HxZeBEOXLZ9Y75GvYp 3+KPa/wWvVBritAQ7TkJUjrWjcDJ0e5JSgicAkRDF/ViOB6dz5PT2VAz19E/sOarFVyk Wkfq6S5zxanV+zXW+9kePDyq+/xtA6/ZC/m2OAY9o+8zqCUOnt0EYly0LZmCHKAOSrpg 7YO6wVrLdDPP3JI8mpPLHlMGyr4SXnfQbWleb56ZjsTHIPV+WT3deiX5TkRU6fnuIW/G mury3tesEbAxKNxJd/dLeAsnmTkFrlQ3K22/LFWBvaiEnyR0TDf15CbPX7qRez63nM9X eeWQ== X-Gm-Message-State: ANoB5ple9hbf4p1IkhdRcVEklb/w35n+WkrwHUAC3L51u7gVQ2+cYpxX 9N1LAzI1UKg5gEbecqQUozTGyPxLYbNktA== X-Received: by 2002:a5d:698c:0:b0:236:4930:2465 with SMTP id g12-20020a5d698c000000b0023649302465mr15170230wru.235.1669143343288; Tue, 22 Nov 2022 10:55:43 -0800 (PST) Received: from Mindolluin.ire.aristanetworks.com ([217.173.96.166]) by smtp.gmail.com with ESMTPSA id c18-20020adffb12000000b002365730eae8sm14478044wrr.55.2022.11.22.10.55.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 22 Nov 2022 10:55:42 -0800 (PST) From: Dmitry Safonov To: linux-kernel@vger.kernel.org, David Ahern , Eric Dumazet , Peter Zijlstra Cc: Dmitry Safonov , Ard Biesheuvel , Bob Gilligan , "David S. Miller" , Dmitry Safonov <0x7f454c46@gmail.com>, Francesco Ruggeri , Hideaki YOSHIFUJI , Jakub Kicinski , Jason Baron , Josh Poimboeuf , Paolo Abeni , Salam Noureddine , Steven Rostedt , netdev@vger.kernel.org Subject: [PATCH v5 1/5] jump_label: Prevent key->enabled int overflow Date: Tue, 22 Nov 2022 18:55:30 +0000 Message-Id: <20221122185534.308643-2-dima@arista.com> X-Mailer: git-send-email 2.38.1 In-Reply-To: <20221122185534.308643-1-dima@arista.com> References: <20221122185534.308643-1-dima@arista.com> MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_NONE autolearn=unavailable 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?1750224089415068937?= X-GMAIL-MSGID: =?utf-8?q?1750224089415068937?= 1. With CONFIG_JUMP_LABEL=n static_key_slow_inc() doesn't have any protection against key->enabled refcounter overflow. 2. With CONFIG_JUMP_LABEL=y static_key_slow_inc_cpuslocked() still may turn the refcounter negative as (v + 1) may overflow. key->enabled is indeed a ref-counter as it's documented in multiple places: top comment in jump_label.h, Documentation/staging/static-keys.rst, etc. As -1 is reserved for static key that's in process of being enabled, functions would break with negative key->enabled refcount: - for CONFIG_JUMP_LABEL=n negative return of static_key_count() breaks static_key_false(), static_key_true() - the ref counter may become 0 from negative side by too many static_key_slow_inc() calls and lead to use-after-free issues. These flaws result in that some users have to introduce an additional mutex and prevent the reference counter from overflowing themselves, see bpf_enable_runtime_stats() checking the counter against INT_MAX / 2. Prevent the reference counter overflow by checking if (v + 1) > 0. Change functions API to return whether the increment was successful. Signed-off-by: Dmitry Safonov Acked-by: Jakub Kicinski --- include/linux/jump_label.h | 19 +++++++++++--- kernel/jump_label.c | 54 +++++++++++++++++++++++++++++--------- 2 files changed, 57 insertions(+), 16 deletions(-) diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h index 570831ca9951..c0a02d4c2ea2 100644 --- a/include/linux/jump_label.h +++ b/include/linux/jump_label.h @@ -224,9 +224,9 @@ extern bool arch_jump_label_transform_queue(struct jump_entry *entry, enum jump_label_type type); extern void arch_jump_label_transform_apply(void); extern int jump_label_text_reserved(void *start, void *end); -extern void static_key_slow_inc(struct static_key *key); +extern bool static_key_slow_inc(struct static_key *key); extern void static_key_slow_dec(struct static_key *key); -extern void static_key_slow_inc_cpuslocked(struct static_key *key); +extern bool static_key_slow_inc_cpuslocked(struct static_key *key); extern void static_key_slow_dec_cpuslocked(struct static_key *key); extern int static_key_count(struct static_key *key); extern void static_key_enable(struct static_key *key); @@ -278,10 +278,21 @@ static __always_inline bool static_key_true(struct static_key *key) return false; } -static inline void static_key_slow_inc(struct static_key *key) +static inline bool static_key_slow_inc(struct static_key *key) { + int v; + STATIC_KEY_CHECK_USE(key); - atomic_inc(&key->enabled); + /* + * Prevent key->enabled getting negative to follow the same semantics + * as for CONFIG_JUMP_LABEL=y, see kernel/jump_label.c comment. + */ + v = atomic_read(&key->enabled); + do { + if (v < 0 || (v + 1) < 0) + return false; + } while (!likely(atomic_try_cmpxchg(&key->enabled, &v, v + 1))); + return true; } static inline void static_key_slow_dec(struct static_key *key) diff --git a/kernel/jump_label.c b/kernel/jump_label.c index 4d6c6f5f60db..677a6674c130 100644 --- a/kernel/jump_label.c +++ b/kernel/jump_label.c @@ -113,9 +113,38 @@ int static_key_count(struct static_key *key) } EXPORT_SYMBOL_GPL(static_key_count); -void static_key_slow_inc_cpuslocked(struct static_key *key) +/*** + * static_key_fast_inc_not_negative - adds a user for a static key + * @key: static key that must be already enabled + * + * The caller must make sure that the static key can't get disabled while + * in this function. It doesn't patch jump labels, only adds a user to + * an already enabled static key. + * + * Returns true if the increment was done. + */ +static bool static_key_fast_inc_not_negative(struct static_key *key) { + int v; + STATIC_KEY_CHECK_USE(key); + /* + * Negative key->enabled has a special meaning: it sends + * static_key_slow_inc() down the slow path, and it is non-zero + * so it counts as "enabled" in jump_label_update(). Note that + * atomic_inc_unless_negative() checks >= 0, so roll our own. + */ + v = atomic_read(&key->enabled); + do { + if (v <= 0 || (v + 1) < 0) + return false; + } while (!likely(atomic_try_cmpxchg(&key->enabled, &v, v + 1))); + + return true; +} + +bool static_key_slow_inc_cpuslocked(struct static_key *key) +{ lockdep_assert_cpus_held(); /* @@ -124,15 +153,9 @@ void static_key_slow_inc_cpuslocked(struct static_key *key) * jump_label_update() process. At the same time, however, * the jump_label_update() call below wants to see * static_key_enabled(&key) for jumps to be updated properly. - * - * So give a special meaning to negative key->enabled: it sends - * static_key_slow_inc() down the slow path, and it is non-zero - * so it counts as "enabled" in jump_label_update(). Note that - * atomic_inc_unless_negative() checks >= 0, so roll our own. */ - for (int v = atomic_read(&key->enabled); v > 0; ) - if (likely(atomic_try_cmpxchg(&key->enabled, &v, v + 1))) - return; + if (static_key_fast_inc_not_negative(key)) + return true; jump_label_lock(); if (atomic_read(&key->enabled) == 0) { @@ -144,16 +167,23 @@ void static_key_slow_inc_cpuslocked(struct static_key *key) */ atomic_set_release(&key->enabled, 1); } else { - atomic_inc(&key->enabled); + if (WARN_ON_ONCE(!static_key_fast_inc_not_negative(key))) { + jump_label_unlock(); + return false; + } } jump_label_unlock(); + return true; } -void static_key_slow_inc(struct static_key *key) +bool static_key_slow_inc(struct static_key *key) { + bool ret; + cpus_read_lock(); - static_key_slow_inc_cpuslocked(key); + ret = static_key_slow_inc_cpuslocked(key); cpus_read_unlock(); + return ret; } EXPORT_SYMBOL_GPL(static_key_slow_inc);