Skip to content

Commit 85e50e3

Browse files
ereshetovajfvogel
authored andcommitted
kcov: convert kcov.refcount to refcount_t
atomic_t variables are currently used to implement reference counters with the following properties: - counter is initialized to 1 using atomic_set() - a resource is freed upon counter reaching zero - once counter reaches zero, its further increments aren't allowed - counter schema uses basic atomic operations (set, inc, inc_not_zero, dec_and_test, etc.) Such atomic variables should be converted to a newly provided refcount_t type and API that prevents accidental counter overflows and underflows. This is important since overflows and underflows can lead to use-after-free situation and be exploitable. The variable kcov.refcount is used as pure reference counter. Convert it to refcount_t and fix up the operations. **Important note for maintainers: Some functions from refcount_t API defined in lib/refcount.c have different memory ordering guarantees than their atomic counterparts. The full comparison can be seen in https://lkml.org/lkml/2017/11/15/57 and it is hopefully soon in state to be merged to the documentation tree. Normally the differences should not matter since refcount_t provides enough guarantees to satisfy the refcounting use cases, but in some rare cases it might matter. Please double check that you don't have some undocumented memory guarantees for this variable usage. For the kcov.refcount it might make a difference in following places: - kcov_put(): decrement in refcount_dec_and_test() only provides RELEASE ordering and control dependency on success vs. fully ordered atomic counterpart Link: http://lkml.kernel.org/r/[email protected] Signed-off-by: Elena Reshetova <[email protected]> Suggested-by: Kees Cook <[email protected]> Reviewed-by: David Windsor <[email protected]> Reviewed-by: Hans Liljestrand <[email protected]> Reviewed-by: Dmitry Vyukov <[email protected]> Reviewed-by: Andrea Parri <[email protected]> Cc: Mark Rutland <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]> (cherry picked from commit 39e07cb) Orabug: 29558684 Signed-off-by: George Kennedy <[email protected]> Reviewed-by: John Donnelly <[email protected]>
1 parent a4abeb0 commit 85e50e3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

kernel/kcov.c

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
#include <linux/debugfs.h>
2121
#include <linux/uaccess.h>
2222
#include <linux/kcov.h>
23+
#include <linux/refcount.h>
2324
#include <asm/setup.h>
2425

2526
/* Number of 64-bit words written per one comparison: */
@@ -44,7 +45,7 @@ struct kcov {
4445
* - opened file descriptor
4546
* - task with enabled coverage (we can't unwire it from another task)
4647
*/
47-
atomic_t refcount;
48+
refcount_t refcount;
4849
/* The lock protects mode, size, area and t. */
4950
spinlock_t lock;
5051
enum kcov_mode mode;
@@ -228,12 +229,12 @@ EXPORT_SYMBOL(__sanitizer_cov_trace_switch);
228229

229230
static void kcov_get(struct kcov *kcov)
230231
{
231-
atomic_inc(&kcov->refcount);
232+
refcount_inc(&kcov->refcount);
232233
}
233234

234235
static void kcov_put(struct kcov *kcov)
235236
{
236-
if (atomic_dec_and_test(&kcov->refcount)) {
237+
if (refcount_dec_and_test(&kcov->refcount)) {
237238
vfree(kcov->area);
238239
kfree(kcov);
239240
}
@@ -312,7 +313,7 @@ static int kcov_open(struct inode *inode, struct file *filep)
312313
if (!kcov)
313314
return -ENOMEM;
314315
kcov->mode = KCOV_MODE_DISABLED;
315-
atomic_set(&kcov->refcount, 1);
316+
refcount_set(&kcov->refcount, 1);
316317
spin_lock_init(&kcov->lock);
317318
filep->private_data = kcov;
318319
return nonseekable_open(inode, filep);

0 commit comments

Comments
 (0)