From: peterz@infradead.org
To: David Howells <dhowells@redhat.com>
Cc: Kees Cook <keescook@chromium.org>,
Xiaoming Ni <nixiaoming@huawei.com>,
David Windsor <dwindsor@gmail.com>,
Hans Liljestrand <ishkamiel@gmail.com>,
Elena Reshetova <elena.reshetova@intel.com>,
Paul Moore <paul@paul-moore.com>,
edumazet@google.com, paulmck@kernel.org, shakeelb@google.com,
James Morris <jamorris@linux.microsoft.com>,
alex.huangjianhui@huawei.com, dylix.dailei@huawei.com,
chenzefeng2@huawei.com, linux-kernel@vger.kernel.org,
Will Deacon <will@kernel.org>
Subject: [RFC][PATCH] locking/refcount: Provide __refcount API to obtain the old value
Date: Wed, 29 Jul 2020 13:11:20 +0200 [thread overview]
Message-ID: <20200729111120.GA2638@hirez.programming.kicks-ass.net> (raw)
In-Reply-To: <3211866.1595933798@warthog.procyon.org.uk>
On Tue, Jul 28, 2020 at 11:56:38AM +0100, David Howells wrote:
> Peter Zijlstra <peterz@infradead.org> wrote:
>
> > > Please do not _undo_ the changes; just add the API you need.
> >
> > add_return and sub_return are horrible interface for refcount, which is
> > the problem.
> >
> > If you meant: refcount_dec(), but want the old value for tracing, you
> > want a different ordering than if you wanted to do
> > refcount_dec_and_test(); dec_return can't know this.
> >
> > David, would something like a __refcount_*() API work where there is a
> > 3rd argument (int *), which, if !NULL, will be assigned the old value?
>
> That would be fine, though the number needs to be something I can interpret
> easily when looking through the traces. It would also be okay if there was an
> interpretation function that I could use in the trace point when setting the
> variable.
I'm not entirely sure what you mean with interpret, provided you don't
trigger a refcount fail, the number will be just what you expect and
would get from refcount_read(). If you do trigger a fail, you'll get a
negative value.
How's the below? I didn't provide __refcount versions for the external
functions, I suppose that can be done too, but wondered if you really
needed those.
---
Subject: locking/refcount: Provide __refcount API to obtain the old value
From: Peter Zijlstra <peterz@infradead.org>
Date: Wed Jul 29 13:00:57 CEST 2020
David requested means to obtain the old/previous value from the
refcount API for tracing purposes.
Duplicate (most of) the API as __refcount*() with an additional
'int *' argument into which, if !NULL, the old value will be stored.
Requested-by: David Howells <dhowells@redhat.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
---
include/linux/refcount.h | 65 +++++++++++++++++++++++++++++++++++++++++------
1 file changed, 57 insertions(+), 8 deletions(-)
--- a/include/linux/refcount.h
+++ b/include/linux/refcount.h
@@ -165,7 +165,7 @@ static inline unsigned int refcount_read
*
* Return: false if the passed refcount is 0, true otherwise
*/
-static inline __must_check bool refcount_add_not_zero(int i, refcount_t *r)
+static inline __must_check bool __refcount_add_not_zero(int i, refcount_t *r, int *oldp)
{
int old = refcount_read(r);
@@ -174,12 +174,20 @@ static inline __must_check bool refcount
break;
} while (!atomic_try_cmpxchg_relaxed(&r->refs, &old, old + i));
+ if (oldp)
+ *oldp = old;
+
if (unlikely(old < 0 || old + i < 0))
refcount_warn_saturate(r, REFCOUNT_ADD_NOT_ZERO_OVF);
return old;
}
+static inline __must_check bool refcount_add_not_zero(int i, refcount_t *r)
+{
+ return __refcount_add_not_zero(i, r, NULL);
+}
+
/**
* refcount_add - add a value to a refcount
* @i: the value to add to the refcount
@@ -196,16 +204,24 @@ static inline __must_check bool refcount
* cases, refcount_inc(), or one of its variants, should instead be used to
* increment a reference count.
*/
-static inline void refcount_add(int i, refcount_t *r)
+static inline void __refcount_add(int i, refcount_t *r, int *oldp)
{
int old = atomic_fetch_add_relaxed(i, &r->refs);
+ if (oldp)
+ *oldp = old;
+
if (unlikely(!old))
refcount_warn_saturate(r, REFCOUNT_ADD_UAF);
else if (unlikely(old < 0 || old + i < 0))
refcount_warn_saturate(r, REFCOUNT_ADD_OVF);
}
+static inline void refcount_add(int i, refcount_t *r)
+{
+ __refcount_add(i, r, NULL);
+}
+
/**
* refcount_inc_not_zero - increment a refcount unless it is 0
* @r: the refcount to increment
@@ -219,9 +235,14 @@ static inline void refcount_add(int i, r
*
* Return: true if the increment was successful, false otherwise
*/
+static inline __must_check bool __refcount_inc_not_zero(refcount_t *r, int *oldp)
+{
+ return __refcount_add_not_zero(1, r, oldp);
+}
+
static inline __must_check bool refcount_inc_not_zero(refcount_t *r)
{
- return refcount_add_not_zero(1, r);
+ return __refcount_inc_not_zero(r, NULL);
}
/**
@@ -236,9 +257,14 @@ static inline __must_check bool refcount
* Will WARN if the refcount is 0, as this represents a possible use-after-free
* condition.
*/
+static inline void __refcount_inc(refcount_t *r, int *oldp)
+{
+ __refcount_add(1, r, oldp);
+}
+
static inline void refcount_inc(refcount_t *r)
{
- refcount_add(1, r);
+ __refcount_inc(r, NULL);
}
/**
@@ -261,10 +287,13 @@ static inline void refcount_inc(refcount
*
* Return: true if the resulting refcount is 0, false otherwise
*/
-static inline __must_check bool refcount_sub_and_test(int i, refcount_t *r)
+static inline __must_check bool __refcount_sub_and_test(int i, refcount_t *r, int *oldp)
{
int old = atomic_fetch_sub_release(i, &r->refs);
+ if (oldp)
+ *oldp = old;
+
if (old == i) {
smp_acquire__after_ctrl_dep();
return true;
@@ -276,6 +305,11 @@ static inline __must_check bool refcount
return false;
}
+static inline __must_check bool refcount_sub_and_test(int i, refcount_t *r)
+{
+ return __refcount_sub_and_test(i, r, NULL);
+}
+
/**
* refcount_dec_and_test - decrement a refcount and test if it is 0
* @r: the refcount
@@ -289,9 +323,14 @@ static inline __must_check bool refcount
*
* Return: true if the resulting refcount is 0, false otherwise
*/
+static inline __must_check bool __refcount_dec_and_test(refcount_t *r, int *oldp)
+{
+ return __refcount_sub_and_test(1, r, oldp);
+}
+
static inline __must_check bool refcount_dec_and_test(refcount_t *r)
{
- return refcount_sub_and_test(1, r);
+ return __refcount_dec_and_test(r, NULL);
}
/**
@@ -304,12 +343,22 @@ static inline __must_check bool refcount
* Provides release memory ordering, such that prior loads and stores are done
* before.
*/
-static inline void refcount_dec(refcount_t *r)
+static inline void __refcount_dec(refcount_t *r, int *oldp)
{
- if (unlikely(atomic_fetch_sub_release(1, &r->refs) <= 1))
+ int old = atomic_fetch_sub_release(1, &r->refs);
+
+ if (oldp)
+ *oldp = old;
+
+ if (unlikely(old <= 1))
refcount_warn_saturate(r, REFCOUNT_DEC_LEAK);
}
+static inline void refcount_dec(refcount_t *r)
+{
+ __refcount_dec(r, NULL);
+}
+
extern __must_check bool refcount_dec_if_one(refcount_t *r);
extern __must_check bool refcount_dec_not_one(refcount_t *r);
extern __must_check bool refcount_dec_and_mutex_lock(refcount_t *r, struct mutex *lock);
next prev parent reply other threads:[~2020-07-29 11:11 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-12 18:34 [PATCH 0/3] Convert nsproxy, groups, and creds to refcount_t Kees Cook
2020-06-12 18:34 ` [PATCH 1/3] nsproxy: convert nsproxy.count " Kees Cook
2020-06-12 18:34 ` [PATCH 2/3] groups: convert group_info.usage " Kees Cook
2020-06-15 0:57 ` [groups] 67467ae141: will-it-scale.per_process_ops 4.3% improvement kernel test robot
2020-06-12 18:34 ` [PATCH 3/3] creds: convert cred.usage to refcount_t Kees Cook
2020-06-15 2:02 ` Xiaoming Ni
2020-06-15 2:10 ` [PATCH 0/3] Convert nsproxy, groups, and creds " Xiaoming Ni
2020-06-15 3:55 ` Kees Cook
2020-06-15 5:35 ` Reshetova, Elena
2020-06-15 18:08 ` Kees Cook
2020-06-18 7:39 ` Reshetova, Elena
2020-07-21 11:02 ` David Howells
2020-07-21 10:51 ` David Howells
2020-07-21 18:44 ` Kees Cook
2020-07-21 19:51 ` Peter Zijlstra
2020-07-28 10:56 ` David Howells
2020-07-29 11:11 ` peterz [this message]
2020-07-29 11:37 ` [RFC][PATCH] locking/refcount: Provide __refcount API to obtain the old value peterz
2020-07-29 19:29 ` Kees Cook
2020-07-29 19:30 ` Kees Cook
2020-08-27 7:54 ` [tip: locking/core] " tip-bot2 for Peter Zijlstra
2020-09-21 11:22 ` [RFC][PATCH] " Will Deacon
2021-01-26 11:25 ` David Howells
2020-07-29 20:41 ` David Howells
2020-07-29 20:52 ` Kees Cook
2020-07-28 11:01 ` [PATCH 0/3] Convert nsproxy, groups, and creds to refcount_t David Howells
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200729111120.GA2638@hirez.programming.kicks-ass.net \
--to=peterz@infradead.org \
--cc=alex.huangjianhui@huawei.com \
--cc=chenzefeng2@huawei.com \
--cc=dhowells@redhat.com \
--cc=dwindsor@gmail.com \
--cc=dylix.dailei@huawei.com \
--cc=edumazet@google.com \
--cc=elena.reshetova@intel.com \
--cc=ishkamiel@gmail.com \
--cc=jamorris@linux.microsoft.com \
--cc=keescook@chromium.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nixiaoming@huawei.com \
--cc=paul@paul-moore.com \
--cc=paulmck@kernel.org \
--cc=shakeelb@google.com \
--cc=will@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).