Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

lockd: convert nlm_rqst.a_count from atomic_t 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 nlm_rqst.a_count 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 nlm_rqst.a_count it might make a difference
in following places:
- nlmclnt_release_call() and nlmsvc_release_call(): decrement
in refcount_dec_and_test() only
provides RELEASE ordering and control dependency on success
vs. fully ordered atomic counterpart

Suggested-by: Kees Cook <keescook@chromium.org>
Reviewed-by: David Windsor <dwindsor@gmail.com>
Reviewed-by: Hans Liljestrand <ishkamiel@gmail.com>
Signed-off-by: Elena Reshetova <elena.reshetova@intel.com>
Signed-off-by: Trond Myklebust <trond.myklebust@primarydata.com>

authored by

Elena Reshetova and committed by
Trond Myklebust
fbca30c5 431f125b

+6 -6
+4 -4
fs/lockd/clntproc.c
··· 204 204 for(;;) { 205 205 call = kzalloc(sizeof(*call), GFP_KERNEL); 206 206 if (call != NULL) { 207 - atomic_set(&call->a_count, 1); 207 + refcount_set(&call->a_count, 1); 208 208 locks_init_lock(&call->a_args.lock.fl); 209 209 locks_init_lock(&call->a_res.lock.fl); 210 210 call->a_host = nlm_get_host(host); ··· 222 222 { 223 223 const struct nlmclnt_operations *nlmclnt_ops = call->a_host->h_nlmclnt_ops; 224 224 225 - if (!atomic_dec_and_test(&call->a_count)) 225 + if (!refcount_dec_and_test(&call->a_count)) 226 226 return; 227 227 if (nlmclnt_ops && nlmclnt_ops->nlmclnt_release_call) 228 228 nlmclnt_ops->nlmclnt_release_call(call->a_callback_data); ··· 678 678 goto out; 679 679 } 680 680 681 - atomic_inc(&req->a_count); 681 + refcount_inc(&req->a_count); 682 682 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req, 683 683 NLMPROC_UNLOCK, &nlmclnt_unlock_ops); 684 684 if (status < 0) ··· 769 769 nlmclnt_setlockargs(req, fl); 770 770 req->a_args.block = block; 771 771 772 - atomic_inc(&req->a_count); 772 + refcount_inc(&req->a_count); 773 773 status = nlmclnt_async_call(nfs_file_cred(fl->fl_file), req, 774 774 NLMPROC_CANCEL, &nlmclnt_cancel_ops); 775 775 if (status == 0 && req->a_res.status == nlm_lck_denied)
+1 -1
fs/lockd/svcproc.c
··· 295 295 296 296 void nlmsvc_release_call(struct nlm_rqst *call) 297 297 { 298 - if (!atomic_dec_and_test(&call->a_count)) 298 + if (!refcount_dec_and_test(&call->a_count)) 299 299 return; 300 300 nlmsvc_release_host(call->a_host); 301 301 kfree(call);
+1 -1
include/linux/lockd/lockd.h
··· 137 137 */ 138 138 #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u) 139 139 struct nlm_rqst { 140 - atomic_t a_count; 140 + refcount_t a_count; 141 141 unsigned int a_flags; /* initial RPC task flags */ 142 142 struct nlm_host * a_host; /* host handle */ 143 143 struct nlm_args a_args; /* arguments */