locks: eliminate false positive conflicts for write lease
Subsystems (4)
PATCH v2 1/1 locks: eliminate false positive conflicts for write lease
check_conflicting_open() is checking for existing fd's open for read or for write before allowing to take a write lease. The check that was implemented using i_count and d_count is an approximation that has several false positives. For example, overlayfs since v4.19, takes an extra reference on the dentry; An open with O_PATH takes a reference on the dentry although the file cannot be read nor written.
Change the implementation to use i_readcount and i_writecount to eliminate the false positive conflicts and allow a write lease to be taken on an overlayfs file.
The change of behavior with existing fd's open with O_PATH is symmetric w.r.t. current behavior of lease breakers - an open with O_PATH currently does not break a write lease.
This increases the size of struct inode by 4 bytes on 32bit archs when CONFIG_FILE_LOCKING is defined and CONFIG_IMA was not already defined.
---
Miklos, Jeff and Bruce,
This patch fixes a v4.19 overlayfs regression with taking write leases. It also provides correct semantics w.r.t RDONLY open counter that Bruce also needed for nfsd.
Since this is locks code that fixes an overlayfs regression which is also needed for nfsd, it could go via either of your trees. I didn't want to pick sides, so first one to grab the patch wins ;-)
I verified the changes using modified LTP F_SETLEASE tests [1], which I ran over xfs and overlayfs.
Thanks,
Amir.
[1] https://github.com/amir73il/ltp/commits/overlayfs-devel
Changes since v1:
- Drop patch to fold i_readcount into i_count
- Make i_readcount depend on CONFIG_FILE_LOCKING
fs/locks.c | 33 ++++++++++++++++++++++----------- include/linux/fs.h | 4 ++-- 2 files changed, 24 insertions(+), 13 deletions(-)
fs/locks.c +22 -11
@@ -1753,10 +1753,10 @@ int fcntl_getlease(struct file *filp) }/** -* check_conflicting_open - see if the given dentry points to a file that has +* check_conflicting_open - see if the given file points to an inode that has * an existing open that would conflict with the * desired lease. -* @dentry: dentry to check +* @filp: file to check * @arg: type of lease that we're trying to acquire * @flags: current lock flags *
@@ -1764,19 +1764,31 @@ int fcntl_getlease(struct file *filp)* conflict with the lease we're trying to set. */ static int -check_conflicting_open (const struct dentry *dentry,const long arg,int flags) +check_conflicting_open (struct file *filp,const long arg,int flags) {int ret =0 ; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp); +int wcount =atomic_read (&inode->i_writecount); +int self_wcount =0 , self_rcount =0 ;if (flags &FL_LAYOUT )return 0 ; -if ((arg ==F_RDLCK ) &&inode_is_open_for_write (inode)) +if (arg ==F_RDLCK && wcount >0 )return -EAGAIN ; -if ((arg ==F_WRLCK ) && ((d_count (dentry) >1 ) || - (atomic_read (&inode->i_count) >1 ))) +/* Eliminate deny writes from actual writers count */ +if (wcount <0 ) + wcount =0 ; + +/* Make sure that only read/write count is from lease requestor */ +if (filp->f_mode &FMODE_WRITE ) + self_wcount =1 ; +else if ((filp->f_mode & (FMODE_READ |FMODE_WRITE )) ==FMODE_READ ) + self_rcount =1 ; + +if (arg ==F_WRLCK && (wcount != self_wcount || +atomic_read (&inode->i_readcount) != self_rcount)) ret = -EAGAIN ;return ret;
@@ -1786,8 +1798,7 @@ static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv) { struct file_lock *fl, *my_fl = NULL, *lease; -struct dentry *dentry = filp->f_path.dentry; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp);struct file_lock_context *ctx;bool is_deleg = (*flp)->fl_flags &FL_DELEG ;int error;
@@ -1822,7 +1833,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **prpercpu_down_read (&file_rwsem);spin_lock (&ctx->flc_lock);time_out_leases (inode, &dispose); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) goto out;
@@ -1879,7 +1890,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **pr* precedes these checks. */ smp_mb (); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) {locks_unlink_lock_ctx (lease); goto out;
include/linux/fs.h +2 -2
@@ -694,7 +694,7 @@ struct inode {atomic_t i_count;atomic_t i_dio_count;atomic_t i_writecount; -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )atomic_t i_readcount;/* struct files open RO */ #endif union {
@@ -2895,7 +2895,7 @@ static inline bool inode_is_open_for_write(const struct inode *inode)return atomic_read (&inode->i_writecount) >0 ; } -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )static inline void i_readcount_dec (struct inode *inode) {BUG_ON (!atomic_read (&inode->i_readcount));
Signature · 1 line
2.17.1
How do opens for execute work? I guess they create a struct file with FMODE_EXEC and FMODE_RDONLY set and they decrement i_writecount. Do they also increment i_readcount? Reading do_open_execat and alloc_file, looks like it does, so, good, they should conflict with write leases, which sounds right.
Looks good to me.--b.
Quoted 155 lines · Amir Goldstein
check_conflicting_open()is checking for existing fd's open for read or for write before allowing to take a write lease. The check that was implemented usingi_countandd_countis an approximation that has several false positives. For example, overlayfs since v4.19, takes an extra reference on the dentry; An open withO_PATHtakes a reference on the dentry although the file cannot be read nor written.Change the implementation to use
i_readcountandi_writecountto eliminate the false positive conflicts and allow a write lease to be taken on an overlayfs file.The change of behavior with existing fd's open with
O_PATHis symmetric w.r.t. current behavior of lease breakers - an open withO_PATHcurrently does not break a write lease.This increases the size of struct inode by 4 bytes on 32bit archs when
CONFIG_FILE_LOCKINGis defined andCONFIG_IMAwas not already defined.Cc <[email protected]> # v4.19Signed-off-by Amir Goldstein <[email protected]>---
Miklos, Jeff and Bruce,
This patch fixes a v4.19 overlayfs regression with taking write leases. It also provides correct semantics w.r.t RDONLY open counter that Bruce also needed for nfsd.
Since this is locks code that fixes an overlayfs regression which is also needed for nfsd, it could go via either of your trees. I didn't want to pick sides, so first one to grab the patch wins ;-)
I verified the changes using modified LTP
F_SETLEASEtests [1], which I ran over xfs and overlayfs.Thanks,
Amir.[1] https://github.com/amir73il/ltp/commits/overlayfs-devel
Changes since v1:
- Drop patch to foldi_readcountintoi_count
- Makei_readcountdepend onCONFIG_FILE_LOCKINGfs/locks.c | 33 ++++++++++++++++++++++----------- include/linux/fs.h | 4 ++-- 2 files changed, 24 insertions(+), 13 deletions(-)fs/locks.c +22
-11@@ -1753,10 +1753,10 @@ int fcntl_getlease(struct file *filp) }/** -* check_conflicting_open - see if the given dentry points to a file that has +* check_conflicting_open - see if the given file points to an inode that has * an existing open that would conflict with the * desired lease. -* @dentry: dentry to check +* @filp: file to check * @arg: type of lease that we're trying to acquire * @flags: current lock flags * @@ -1764,19 +1764,31 @@ int fcntl_getlease(struct file *filp)* conflict with the lease we're trying to set. */ static int -check_conflicting_open (const struct dentry *dentry,const long arg,int flags) +check_conflicting_open (struct file *filp,const long arg,int flags) {int ret =0 ; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp); +int wcount =atomic_read (&inode->i_writecount); +int self_wcount =0 , self_rcount =0 ;if (flags &FL_LAYOUT )return 0 ; -if ((arg ==F_RDLCK ) &&inode_is_open_for_write (inode)) +if (arg ==F_RDLCK && wcount >0 )return -EAGAIN ; -if ((arg ==F_WRLCK ) && ((d_count (dentry) >1 ) || - (atomic_read (&inode->i_count) >1 ))) +/* Eliminate deny writes from actual writers count */ +if (wcount <0 ) + wcount =0 ; + +/* Make sure that only read/write count is from lease requestor */ +if (filp->f_mode &FMODE_WRITE ) + self_wcount =1 ; +else if ((filp->f_mode & (FMODE_READ |FMODE_WRITE )) ==FMODE_READ ) + self_rcount =1 ; + +if (arg ==F_WRLCK && (wcount != self_wcount || +atomic_read (&inode->i_readcount) != self_rcount)) ret = -EAGAIN ;return ret;@@ -1786,8 +1798,7 @@ static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv) { struct file_lock *fl, *my_fl = NULL, *lease; -struct dentry *dentry = filp->f_path.dentry; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp);struct file_lock_context *ctx;bool is_deleg = (*flp)->fl_flags &FL_DELEG ;int error;@@ -1822,7 +1833,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **prpercpu_down_read (&file_rwsem);spin_lock (&ctx->flc_lock);time_out_leases (inode, &dispose); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) goto out;@@ -1879,7 +1890,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **pr* precedes these checks. */ smp_mb (); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) {locks_unlink_lock_ctx (lease); goto out;include/linux/fs.h +2
-2@@ -694,7 +694,7 @@ struct inode {atomic_t i_count;atomic_t i_dio_count;atomic_t i_writecount; -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )atomic_t i_readcount;/* struct files open RO */ #endif union {@@ -2895,7 +2895,7 @@ static inline bool inode_is_open_for_write(const struct inode *inode)return atomic_read (&inode->i_writecount) >0 ; } -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )static inline void i_readcount_dec (struct inode *inode) {BUG_ON (!atomic_read (&inode->i_readcount));Signature · 1 line
2.17.1
Quoted 6 lines · J . Bruce Fields
How do opens for execute work? I guess they create a struct file with
FMODE_EXECandFMODE_RDONLYset and they decrementi_writecount. Do they also incrementi_readcount? Readingdo_open_execatandalloc_file, looks like it does, so, good, they should conflict with write leases, which sounds right.
Right, but then why this:
Quoted 3 lines
fs/locks.c int fcntl_getlease(struct file *filp) · line 1782
Quoted 3 lines
fs/locks.c +3
-0+/* Eliminate deny writes from actual writers count */ +if (wcount <0 ) + wcount =0 ;
It's basically a no-op, as you say. And it doesn't make any sense logically, since denying writes *should* deny write leases as well...
Thanks,
Miklos
Quoted 8 lines · Miklos Szeredi
Quoted 6 lines · J . Bruce Fields
How do opens for execute work? I guess they create a struct file with
FMODE_EXECandFMODE_RDONLYset and they decrementi_writecount. Do they also incrementi_readcount? Readingdo_open_execatandalloc_file, looks like it does, so, good, they should conflict with write leases, which sounds right.
Quoted 8 lines
Right, but then why this:
Quoted 3 lines
Review
Quoted 3 lines
(quoted diff) +3
-0+ /* Eliminate deny writes from actual writers count */ + if (wcount < 0) + wcount = 0;It's basically a no-op, as you say. And it doesn't make any sense logically, since denying writes *should* deny write leases as well...
Yes. I feel like the negative writecount case is a little nonobvious, so maybe replace that by a comment, something like this?:
--b.
fs/locks.c +6 -5
@@ -1772,11 +1772,12 @@ check_conflicting_open(struct file *filp, const long arg, int flags)if (arg ==F_RDLCK && wcount >0 )return -EAGAIN ; -/* Eliminate deny writes from actual writers count */ -if (wcount <0 ) - wcount =0 ; - -/* Make sure that only read/write count is from lease requestor */ +/* +* Make sure that only read/write count is from lease requestor. +* Note that this will result in denying write leases when wcount +* is negative, which is what we want. (We shouldn't grant +* write leases on files open for execution.) +*/ if (filp->f_mode &FMODE_WRITE ) self_wcount =1 ;else if (filp->f_mode &FMODE_READ )
Quoted 36 lines · J . Bruce Fields
Quoted 8 lines · Miklos Szeredi
Quoted 6 lines · J . Bruce Fields
How do opens for execute work? I guess they create a struct file with
FMODE_EXECandFMODE_RDONLYset and they decrementi_writecount. Do they also incrementi_readcount? Readingdo_open_execatandalloc_file, looks like it does, so, good, they should conflict with write leases, which sounds right.Quoted 8 lines
Right, but then why this:
Quoted 3 lines
Review
Quoted 3 lines
(quoted diff) +3
-0+ /* Eliminate deny writes from actual writers count */ + if (wcount < 0) + wcount = 0;It's basically a no-op, as you say. And it doesn't make any sense logically, since denying writes *should* deny write leases as well...
Yes. I feel like the negative writecount case is a little nonobvious, so maybe replace that by a comment, something like this?:
--b.
fs/locks.c +0
-4@@ -1772,11 +1772,12 @@ check_conflicting_open(struct file *filp, const long arg, int flags)if (arg ==F_RDLCK && wcount >0 )return -EAGAIN ; -/* Eliminate deny writes from actual writers count */ -if (wcount <0 ) - wcount =0 ; -
fs/locks.c check_conflicting_open(struct file *filp, const long arg, int flags) · line 1783
Quoted 10 lines
fs/locks.c +6
-1-/* Make sure that only read/write count is from lease requestor */ +/* +* Make sure that only read/write count is from lease requestor. +* Note that this will result in denying write leases when wcount +* is negative, which is what we want. (We shouldn't grant +* write leases on files open for execution.) +*/ if (filp->f_mode &FMODE_WRITE ) self_wcount =1 ;else if (filp->f_mode &FMODE_READ )
I'm fine with targeting 5.3 and I'm fine with all suggested changes and adding some of my own. At this point we no longer need wcount variable and code becomes more readable without it.
See attached patch (also tested).
Thanks,
Amir.
From d1b029a778c9100bf1a295c7035319913ef25333 Mon Sep 17 00:00:00 2001
From: Amir Goldstein <[email protected]>
Date: Fri, 7 Jun 2019 17:24:38 +0300
Subject: [PATCH v3] locks: eliminate false positive conflicts for write lease
check_conflicting_open() is checking for existing fd's open for read or for write before allowing to take a write lease. The check that was implemented using i_count and d_count is an approximation that has several false positives. For example, overlayfs since v4.19, takes an extra reference on the dentry; An open with O_PATH takes a reference on the dentry although the file cannot be read nor written.
Change the implementation to use i_readcount and i_writecount to eliminate the false positive conflicts and allow a write lease to be taken on an overlayfs file.
The change of behavior with existing fd's open with O_PATH is symmetric w.r.t. current behavior of lease breakers - an open with O_PATH currently does not break a write lease.
This increases the size of struct inode by 4 bytes on 32bit archs when CONFIG_FILE_LOCKING is defined and CONFIG_IMA was not already defined.
--- fs/locks.c | 37 +++++++++++++++++++++++++------------ include/linux/fs.h | 4 ++-- 2 files changed, 27 insertions(+), 14 deletions(-)
fs/locks.c +25 -12
@@ -1753,10 +1753,10 @@ int fcntl_getlease(struct file *filp) }/** -* check_conflicting_open - see if the given dentry points to a file that has +* check_conflicting_open - see if the given file points to an inode that has * an existing open that would conflict with the * desired lease. -* @dentry: dentry to check +* @filp: file to check * @arg: type of lease that we're trying to acquire * @flags: current lock flags *
@@ -1764,19 +1764,33 @@ int fcntl_getlease(struct file *filp)* conflict with the lease we're trying to set. */ static int -check_conflicting_open (const struct dentry *dentry,const long arg,int flags) +check_conflicting_open (struct file *filp,const long arg,int flags) {int ret =0 ; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp); +int self_wcount =0 , self_rcount =0 ;if (flags &FL_LAYOUT )return 0 ; -if ((arg ==F_RDLCK ) &&inode_is_open_for_write (inode)) -return -EAGAIN ; +if (arg ==F_RDLCK ) +return inode_is_open_for_write (inode) ? -EAGAIN :0 ; +else if (arg !=F_WRLCK ) +return 0 ; -if ((arg ==F_WRLCK ) && ((d_count (dentry) >1 ) || - (atomic_read (&inode->i_count) >1 ))) +/* +* Make sure that only read/write count is from lease requestor. +* Note that this will result in denying write leases when i_writecount +* is negative, which is what we want. (We shouldn't grant write leases +* on files open for execution.) +*/ +if (filp->f_mode &FMODE_WRITE ) + self_wcount =1 ; +else if (filp->f_mode &FMODE_READ ) + self_rcount =1 ; + +if (atomic_read (&inode->i_writecount) != self_wcount || +atomic_read (&inode->i_readcount) != self_rcount) ret = -EAGAIN ;return ret;
@@ -1786,8 +1800,7 @@ static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv) { struct file_lock *fl, *my_fl = NULL, *lease; -struct dentry *dentry = filp->f_path.dentry; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp);struct file_lock_context *ctx;bool is_deleg = (*flp)->fl_flags &FL_DELEG ;int error;
@@ -1822,7 +1835,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **prpercpu_down_read (&file_rwsem);spin_lock (&ctx->flc_lock);time_out_leases (inode, &dispose); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) goto out;
@@ -1879,7 +1892,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **pr* precedes these checks. */ smp_mb (); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) {locks_unlink_lock_ctx (lease); goto out;
include/linux/fs.h +2 -2
@@ -694,7 +694,7 @@ struct inode {atomic_t i_count;atomic_t i_dio_count;atomic_t i_writecount; -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )atomic_t i_readcount;/* struct files open RO */ #endif union {
@@ -2895,7 +2895,7 @@ static inline bool inode_is_open_for_write(const struct inode *inode)return atomic_read (&inode->i_writecount) >0 ; } -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )static inline void i_readcount_dec (struct inode *inode) {BUG_ON (!atomic_read (&inode->i_readcount));
Signature · 1 line
2.17.1
Jeff Layton
maintainerQuoted 51 lines · Amir Goldstein
Quoted 34 lines · J . Bruce Fields
Quoted 7 lines · Miklos Szeredi
Quoted 5 lines · J . Bruce Fields
How do opens for execute work? I guess they create a struct file with
FMODE_EXECandFMODE_RDONLYset and they decrementi_writecount. Do they also incrementi_readcount? Readingdo_open_execatandalloc_file, looks like it does, so, good, they should conflict with write leases, which sounds right.Quoted 8 lines
Right, but then why this:
Quoted 3 lines
Review
Quoted 3 lines
(quoted diff) +3
-0+ /* Eliminate deny writes from actual writers count */ + if (wcount < 0) + wcount = 0;It's basically a no-op, as you say. And it doesn't make any sense logically, since denying writes *should* deny write leases as well...
Yes. I feel like the negative writecount case is a little nonobvious, so maybe replace that by a comment, something like this?:
--b.
fs/locks.c +0
-4@@ -1772,11 +1772,12 @@ check_conflicting_open(struct file *filp, const long arg, int flags)if (arg ==F_RDLCK && wcount >0 )return -EAGAIN ; -/* Eliminate deny writes from actual writers count */ -if (wcount <0 ) - wcount =0 ; -fs/locks.c check_conflicting_open(struct file *filp, const long arg, int flags) · line 1783
Quoted 10 lines
fs/locks.c +6
-1-/* Make sure that only read/write count is from lease requestor */ +/* +* Make sure that only read/write count is from lease requestor. +* Note that this will result in denying write leases when wcount +* is negative, which is what we want. (We shouldn't grant +* write leases on files open for execution.) +*/ if (filp->f_mode &FMODE_WRITE ) self_wcount =1 ;else if (filp->f_mode &FMODE_READ )I'm fine with targeting 5.3 and I'm fine with all suggested changes and adding some of my own. At this point we no longer need wcount variable and code becomes more readable without it.
See attached patch (also tested).
Quoted 2 lines
Thanks,
Amir.
Thanks Amir. In that case, I'll go ahead and pick this up for v5.3, and will get it into linux-next soon.
Thanks,
Signature · 1 line
Jeff Layton <[email protected]>
Quoted 11 lines
Quoted 7 lines
I'm fine with targeting 5.3 and I'm fine with all suggested changes and adding some of my own. At this point we no longer need wcount variable and code becomes more readable without it.
See attached patch (also tested).Thanks,
Amir.Thanks Amir. In that case, I'll go ahead and pick this up for v5.3, and will get it into linux-next soon.
While we are polishing the patch to perfection, could also get rid of ret variable...
Not a must.
Thanks,
Amir.
From 1cebe862fab4b4eab05353b20cea2441fe1787ca Mon Sep 17 00:00:00 2001
From: Amir Goldstein <[email protected]>
Date: Fri, 7 Jun 2019 17:24:38 +0300
Subject: [PATCH v4] locks: eliminate false positive conflicts for write lease
check_conflicting_open() is checking for existing fd's open for read or for write before allowing to take a write lease. The check that was implemented using i_count and d_count is an approximation that has several false positives. For example, overlayfs since v4.19, takes an extra reference on the dentry; An open with O_PATH takes a reference on the dentry although the file cannot be read nor written.
Change the implementation to use i_readcount and i_writecount to eliminate the false positive conflicts and allow a write lease to be taken on an overlayfs file.
The change of behavior with existing fd's open with O_PATH is symmetric w.r.t. current behavior of lease breakers - an open with O_PATH currently does not break a write lease.
This increases the size of struct inode by 4 bytes on 32bit archs when CONFIG_FILE_LOCKING is defined and CONFIG_IMA was not already defined.
--- fs/locks.c | 42 +++++++++++++++++++++++++++--------------- include/linux/fs.h | 4 ++-- 2 files changed, 29 insertions(+), 17 deletions(-)
fs/locks.c +27 -15
@@ -1753,10 +1753,10 @@ int fcntl_getlease(struct file *filp) }/** -* check_conflicting_open - see if the given dentry points to a file that has +* check_conflicting_open - see if the given file points to an inode that has * an existing open that would conflict with the * desired lease. -* @dentry: dentry to check +* @filp: file to check * @arg: type of lease that we're trying to acquire * @flags: current lock flags *
@@ -1764,30 +1764,42 @@ int fcntl_getlease(struct file *filp)* conflict with the lease we're trying to set. */ static int -check_conflicting_open (const struct dentry *dentry,const long arg,int flags) +check_conflicting_open (struct file *filp,const long arg,int flags) { -int ret =0 ; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp); +int self_wcount =0 , self_rcount =0 ;if (flags &FL_LAYOUT )return 0 ; -if ((arg ==F_RDLCK ) &&inode_is_open_for_write (inode)) -return -EAGAIN ; +if (arg ==F_RDLCK ) +return inode_is_open_for_write (inode) ? -EAGAIN :0 ; +else if (arg !=F_WRLCK ) +return 0 ; + +/* +* Make sure that only read/write count is from lease requestor. +* Note that this will result in denying write leases when i_writecount +* is negative, which is what we want. (We shouldn't grant write leases +* on files open for execution.) +*/ +if (filp->f_mode &FMODE_WRITE ) + self_wcount =1 ; +else if (filp->f_mode &FMODE_READ ) + self_rcount =1 ; -if ((arg ==F_WRLCK ) && ((d_count (dentry) >1 ) || - (atomic_read (&inode->i_count) >1 ))) - ret = -EAGAIN ; +if (atomic_read (&inode->i_writecount) != self_wcount || +atomic_read (&inode->i_readcount) != self_rcount) +return -EAGAIN ; -return ret; +return 0 ; }static int generic_add_lease (struct file *filp,long arg,struct file_lock **flp,void **priv) {struct file_lock *fl, *my_fl =NULL , *lease; -struct dentry *dentry = filp->f_path.dentry; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp);struct file_lock_context *ctx;bool is_deleg = (*flp)->fl_flags &FL_DELEG ;int error;
@@ -1822,7 +1834,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **prpercpu_down_read (&file_rwsem);spin_lock (&ctx->flc_lock);time_out_leases (inode, &dispose); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) goto out;
@@ -1879,7 +1891,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **pr* precedes these checks. */ smp_mb (); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) {locks_unlink_lock_ctx (lease); goto out;
include/linux/fs.h +2 -2
@@ -694,7 +694,7 @@ struct inode {atomic_t i_count;atomic_t i_dio_count;atomic_t i_writecount; -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )atomic_t i_readcount;/* struct files open RO */ #endif union {
@@ -2895,7 +2895,7 @@ static inline bool inode_is_open_for_write(const struct inode *inode)return atomic_read (&inode->i_writecount) >0 ; } -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )static inline void i_readcount_dec (struct inode *inode) {BUG_ON (!atomic_read (&inode->i_readcount));
Signature · 1 line
2.17.1
Quoted 86 lines · Amir Goldstein
check_conflicting_open()is checking for existing fd's open for read or for write before allowing to take a write lease. The check that was implemented usingi_countandd_countis an approximation that has several false positives. For example, overlayfs since v4.19, takes an extra reference on the dentry; An open withO_PATHtakes a reference on the dentry although the file cannot be read nor written.Change the implementation to use
i_readcountandi_writecountto eliminate the false positive conflicts and allow a write lease to be taken on an overlayfs file.The change of behavior with existing fd's open with
O_PATHis symmetric w.r.t. current behavior of lease breakers - an open withO_PATHcurrently does not break a write lease.This increases the size of struct inode by 4 bytes on 32bit archs when
CONFIG_FILE_LOCKINGis defined andCONFIG_IMAwas not already defined.Cc <[email protected]> # v4.19Signed-off-by Amir Goldstein <[email protected]>---
Miklos, Jeff and Bruce,
This patch fixes a v4.19 overlayfs regression with taking write leases. It also provides correct semantics w.r.t RDONLY open counter that Bruce also needed for nfsd.
Since this is locks code that fixes an overlayfs regression which is also needed for nfsd, it could go via either of your trees. I didn't want to pick sides, so first one to grab the patch wins ;-)
I verified the changes using modified LTP
F_SETLEASEtests [1], which I ran over xfs and overlayfs.Thanks,
Amir.[1] https://github.com/amir73il/ltp/commits/overlayfs-devel
Changes since v1:
- Drop patch to foldi_readcountintoi_count
- Makei_readcountdepend onCONFIG_FILE_LOCKINGfs/locks.c | 33 ++++++++++++++++++++++----------- include/linux/fs.h | 4 ++-- 2 files changed, 24 insertions(+), 13 deletions(-)fs/locks.c +7
-5@@ -1753,10 +1753,10 @@ int fcntl_getlease(struct file *filp) }/** -* check_conflicting_open - see if the given dentry points to a file that has +* check_conflicting_open - see if the given file points to an inode that has * an existing open that would conflict with the * desired lease. -* @dentry: dentry to check +* @filp: file to check * @arg: type of lease that we're trying to acquire * @flags: current lock flags * @@ -1764,19 +1764,31 @@ int fcntl_getlease(struct file *filp)* conflict with the lease we're trying to set. */ static int -check_conflicting_open (const struct dentry *dentry,const long arg,int flags) +check_conflicting_open (struct file *filp,const long arg,int flags) {int ret =0 ; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp); +int wcount =atomic_read (&inode->i_writecount); +int self_wcount =0 , self_rcount =0 ;if (flags &FL_LAYOUT )return 0 ; -if ((arg ==F_RDLCK ) &&inode_is_open_for_write (inode)) +if (arg ==F_RDLCK && wcount >0 )return -EAGAIN ;
fs/locks.c int fcntl_getlease(struct file *filp) · line 1787
Quoted 10 lines
fs/locks.c +8
-2-if ((arg ==F_WRLCK ) && ((d_count (dentry) >1 ) || - (atomic_read (&inode->i_count) >1 ))) +/* Eliminate deny writes from actual writers count */ +if (wcount <0 ) + wcount =0 ; + +/* Make sure that only read/write count is from lease requestor */ +if (filp->f_mode &FMODE_WRITE ) + self_wcount =1 ; +else if ((filp->f_mode & (FMODE_READ |FMODE_WRITE )) ==FMODE_READ )
nit: you already checked for FMODE_WRITE and you know that it's not set here, so this is equivalent to:
else if (filp->f_mode & FMODE_READ)
Quoted 49 lines
fs/locks.c +7
-4+ self_rcount =1 ; + +if (arg ==F_WRLCK && (wcount != self_wcount || +atomic_read (&inode->i_readcount) != self_rcount)) ret = -EAGAIN ;return ret;@@ -1786,8 +1798,7 @@ static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv) { struct file_lock *fl, *my_fl = NULL, *lease; -struct dentry *dentry = filp->f_path.dentry; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp);struct file_lock_context *ctx;bool is_deleg = (*flp)->fl_flags &FL_DELEG ;int error;@@ -1822,7 +1833,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **prpercpu_down_read (&file_rwsem);spin_lock (&ctx->flc_lock);time_out_leases (inode, &dispose); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) goto out;@@ -1879,7 +1890,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **pr* precedes these checks. */ smp_mb (); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) {locks_unlink_lock_ctx (lease); goto out;include/linux/fs.h +1
-1@@ -694,7 +694,7 @@ struct inode {atomic_t i_count;atomic_t i_dio_count;atomic_t i_writecount; -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )atomic_t i_readcount;/* struct files open RO */ #endif union {
include/linux/fs.h static inline bool inode_is_open_for_write(const struct inode *inode) · line 2901
Quoted 8 lines
include/linux/fs.h +1
-1@@ -2895,7 +2895,7 @@ static inline bool inode_is_open_for_write(const struct inode *inode)return atomic_read (&inode->i_writecount) >0 ; } -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )static inline void i_readcount_dec (struct inode *inode) {BUG_ON (!atomic_read (&inode->i_readcount));
Looks good to me. Aside from the minor nit above:
I have one file locking patch queued up for v5.3 so far, but nothing for v5.2. Miklos or Bruce, if either of you have anything to send to Linus for v5.2 would you mind taking this one too?
If not I can queue it up and get it to him after letting it soak in linux-next for a bit.
Quoted 102 lines · Jeff Layton
Quoted 86 lines · Amir Goldstein
check_conflicting_open()is checking for existing fd's open for read or for write before allowing to take a write lease. The check that was implemented usingi_countandd_countis an approximation that has several false positives. For example, overlayfs since v4.19, takes an extra reference on the dentry; An open withO_PATHtakes a reference on the dentry although the file cannot be read nor written.Change the implementation to use
i_readcountandi_writecountto eliminate the false positive conflicts and allow a write lease to be taken on an overlayfs file.The change of behavior with existing fd's open with
O_PATHis symmetric w.r.t. current behavior of lease breakers - an open withO_PATHcurrently does not break a write lease.This increases the size of struct inode by 4 bytes on 32bit archs when
CONFIG_FILE_LOCKINGis defined andCONFIG_IMAwas not already defined.Cc <[email protected]> # v4.19Signed-off-by Amir Goldstein <[email protected]>---
Miklos, Jeff and Bruce,
This patch fixes a v4.19 overlayfs regression with taking write leases. It also provides correct semantics w.r.t RDONLY open counter that Bruce also needed for nfsd.
Since this is locks code that fixes an overlayfs regression which is also needed for nfsd, it could go via either of your trees. I didn't want to pick sides, so first one to grab the patch wins ;-)
I verified the changes using modified LTP
F_SETLEASEtests [1], which I ran over xfs and overlayfs.Thanks,
Amir.[1] https://github.com/amir73il/ltp/commits/overlayfs-devel
Changes since v1:
- Drop patch to foldi_readcountintoi_count
- Makei_readcountdepend onCONFIG_FILE_LOCKINGfs/locks.c | 33 ++++++++++++++++++++++----------- include/linux/fs.h | 4 ++-- 2 files changed, 24 insertions(+), 13 deletions(-)fs/locks.c +7
-5@@ -1753,10 +1753,10 @@ int fcntl_getlease(struct file *filp) }/** -* check_conflicting_open - see if the given dentry points to a file that has +* check_conflicting_open - see if the given file points to an inode that has * an existing open that would conflict with the * desired lease. -* @dentry: dentry to check +* @filp: file to check * @arg: type of lease that we're trying to acquire * @flags: current lock flags * @@ -1764,19 +1764,31 @@ int fcntl_getlease(struct file *filp)* conflict with the lease we're trying to set. */ static int -check_conflicting_open (const struct dentry *dentry,const long arg,int flags) +check_conflicting_open (struct file *filp,const long arg,int flags) {int ret =0 ; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp); +int wcount =atomic_read (&inode->i_writecount); +int self_wcount =0 , self_rcount =0 ;if (flags &FL_LAYOUT )return 0 ; -if ((arg ==F_RDLCK ) &&inode_is_open_for_write (inode)) +if (arg ==F_RDLCK && wcount >0 )return -EAGAIN ;fs/locks.c int fcntl_getlease(struct file *filp) · line 1787
Quoted 10 lines
fs/locks.c +8
-2-if ((arg ==F_WRLCK ) && ((d_count (dentry) >1 ) || - (atomic_read (&inode->i_count) >1 ))) +/* Eliminate deny writes from actual writers count */ +if (wcount <0 ) + wcount =0 ; + +/* Make sure that only read/write count is from lease requestor */ +if (filp->f_mode &FMODE_WRITE ) + self_wcount =1 ; +else if ((filp->f_mode & (FMODE_READ |FMODE_WRITE )) ==FMODE_READ )nit: you already checked for
FMODE_WRITEand you know that it's not set here, so this is equivalent to:
Quoted 2 lines
else if (filp->f_mode & FMODE_READ)
Right... I guess you or Miklos could fix this up on commit. Let me know if you want a re-post.
Quoted 61 lines
Quoted 49 lines
fs/locks.c +7
-4+ self_rcount =1 ; + +if (arg ==F_WRLCK && (wcount != self_wcount || +atomic_read (&inode->i_readcount) != self_rcount)) ret = -EAGAIN ;return ret;@@ -1786,8 +1798,7 @@ static int generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **priv) { struct file_lock *fl, *my_fl = NULL, *lease; -struct dentry *dentry = filp->f_path.dentry; -struct inode *inode = dentry->d_inode; +struct inode *inode =locks_inode (filp);struct file_lock_context *ctx;bool is_deleg = (*flp)->fl_flags &FL_DELEG ;int error;@@ -1822,7 +1833,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **prpercpu_down_read (&file_rwsem);spin_lock (&ctx->flc_lock);time_out_leases (inode, &dispose); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) goto out;@@ -1879,7 +1890,7 @@ generic_add_lease(struct file *filp, long arg, struct file_lock **flp, void **pr* precedes these checks. */ smp_mb (); - error =check_conflicting_open (dentry, arg, lease->fl_flags); + error =check_conflicting_open (filp, arg, lease->fl_flags);if (error) {locks_unlink_lock_ctx (lease); goto out;include/linux/fs.h +1
-1@@ -694,7 +694,7 @@ struct inode {atomic_t i_count;atomic_t i_dio_count;atomic_t i_writecount; -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )atomic_t i_readcount;/* struct files open RO */ #endif union {include/linux/fs.h static inline bool inode_is_open_for_write(const struct inode *inode) · line 2901
Quoted 8 lines
include/linux/fs.h +1
-1@@ -2895,7 +2895,7 @@ static inline bool inode_is_open_for_write(const struct inode *inode)return atomic_read (&inode->i_writecount) >0 ; } -#ifdef CONFIG_IMA +#if defined(CONFIG_IMA ) || defined(CONFIG_FILE_LOCKING )static inline void i_readcount_dec (struct inode *inode) {BUG_ON (!atomic_read (&inode->i_readcount));Looks good to me. Aside from the minor nit above:
Quoted 6 lines
Reviewed-by Jeff Layton <[email protected]>I have one file locking patch queued up for v5.3 so far, but nothing for v5.2. Miklos or Bruce, if either of you have anything to send to Linus for v5.2 would you mind taking this one too?
Well. I did send a fix patch to Miklos for a bug introduced in v5.2-rc4, so...
Quoted 3 lines
If not I can queue it up and get it to him after letting it soak in linux-next for a bit.
Thanks for review!
Amir.
Quoted 5 lines · Amir Goldstein
Quoted 4 lines · Jeff Layton
Looks good to me. Aside from the minor nit above:
Reviewed-by Jeff Layton <[email protected]>
Quoted 7 lines
Quoted 4 lines
I have one file locking patch queued up for v5.3 so far, but nothing for v5.2. Miklos or Bruce, if either of you have anything to send to Linus for v5.2 would you mind taking this one too?
Well. I did send a fix patch to Miklos for a bug introduced in v5.2-rc4, so...
I could take it. I've modified it as below.
I'm very happy with the patch, but not so much with the idea of 5.2 and stable.
It seems like a subtle change with some possibility of unintended side effects. (E.g. I don't think this is true any more, but my memory is that for a long time the only thing stopping nfsd from giving out (probably broken) write delegations was an extra reference that it held during processing.) And if the overlayfs bug's been there since 4.19, then waiting a little longer seems OK?
--b.
fs/locks.c +1 -1
@@ -1779,7 +1779,7 @@ check_conflicting_open(struct file *filp, const long arg, int flags)/* Make sure that only read/write count is from lease requestor */ if (filp->f_mode &FMODE_WRITE ) self_wcount =1 ; -else if ((filp->f_mode & (FMODE_READ |FMODE_WRITE )) ==FMODE_READ ) +else if (filp->f_mode &FMODE_READ ) self_rcount =1 ; if (arg == F_WRLCK && (wcount != self_wcount ||
Quoted 20 lines · J . Bruce Fields
Quoted 5 lines · Amir Goldstein
Quoted 4 lines · Jeff Layton
Looks good to me. Aside from the minor nit above:
Reviewed-by Jeff Layton <[email protected]>Quoted 7 lines
Quoted 4 lines
I have one file locking patch queued up for v5.3 so far, but nothing for v5.2. Miklos or Bruce, if either of you have anything to send to Linus for v5.2 would you mind taking this one too?
Well. I did send a fix patch to Miklos for a bug introduced in v5.2-rc4, so...
I could take it. I've modified it as below.
I'm very happy with the patch, but not so much with the idea of 5.2 and stable.
Quoted 7 lines
It seems like a subtle change with some possibility of unintended side effects. (E.g. I don't think this is true any more, but my memory is that for a long time the only thing stopping nfsd from giving out (probably broken) write delegations was an extra reference that it held during processing.) And if the overlayfs bug's been there since 4.19, then waiting a little longer seems OK?
Getting back to this now that the patch is on its way to Linus. Bruce, I was fine with waiting to 5.3 and I also removed CC: stable, but did you mean that patch is not appropriate for stable or just that we'd better wait a bit and let it soak in master before forwarding it to stable?
Thanks,
Amir.
Jeff Layton
maintainerQuoted 28 lines · Amir Goldstein
Quoted 19 lines · J . Bruce Fields
Quoted 5 lines · Amir Goldstein
Quoted 4 lines · Jeff Layton
Looks good to me. Aside from the minor nit above:
Reviewed-by Jeff Layton <[email protected]>Quoted 7 lines
Quoted 4 lines
I have one file locking patch queued up for v5.3 so far, but nothing for v5.2. Miklos or Bruce, if either of you have anything to send to Linus for v5.2 would you mind taking this one too?
Well. I did send a fix patch to Miklos for a bug introduced in v5.2-rc4, so...
I could take it. I've modified it as below.
I'm very happy with the patch, but not so much with the idea of 5.2 and stable.
Quoted 7 lines
It seems like a subtle change with some possibility of unintended side effects. (E.g. I don't think this is true any more, but my memory is that for a long time the only thing stopping nfsd from giving out (probably broken) write delegations was an extra reference that it held during processing.) And if the overlayfs bug's been there since 4.19, then waiting a little longer seems OK?
Quoted 5 lines
Getting back to this now that the patch is on its way to Linus. Bruce, I was fine with waiting to 5.3 and I also removed CC: stable, but did you mean that patch is not appropriate for stable or just that we'd better wait a bit and let it soak in master before forwarding it to stable?
With NFS and SMB, oplocks/leases/delegations are optimizations and you're never guaranteed to get one in the face of competing access.
stable-kernel-rules.rst says:
- It must fix a problem that causes a build error (but not for things marked CONFIG_BROKEN), an oops, a hang, data corruption, a real security issue, or some "oh, that's not good" issue. In short, something critical.
I'm not sure this clears that bar.
Signature · 1 line
Jeff Layton <[email protected]>