cifs: add attribute cache timeout (actimeo) tunable
Subsystems (2)
PATCH 1/1 cifs: add attribute cache timeout (actimeo) tunable
Currently, the attribute cache timeout for CIFS is hardcoded to 1 second. This means that the client might have to issue a QPATHINFO/QFILEINFO call every 1 second to verify if something has changes, which seems too expensive. On the other hand, if the timeout is hardcoded to a higher value, workloads that expect strict cache coherency might see unexpected results.
Making attribute cache timeout as a tunable will allow us to make a tradeoff between performance and cache metadata correctness depending on the application/workload needs.
Add 'actimeo' tunable that can be used to tune the attribute cache timeout. The default timeout is set to 1 second. Also, display actimeo option value in /proc/mounts.
It appears to me that 'actimeo' and the proposed (but not yet merged) 'strictcache' option cannot coexist, so care must be taken that we reset the other option if one of them is set.
Changes since last post:
- guard against wraparound issues with a max timeout value in jiffies (2^30)
- raise error if too large a actimeo value is specified
- handle actimeo=0 correctly
--- fs/cifs/README | 9 +++++++++ fs/cifs/cifs_fs_sb.h | 1 + fs/cifs/cifsfs.c | 2 ++ fs/cifs/cifsglob.h | 10 ++++++++++ fs/cifs/connect.c | 18 ++++++++++++++++++ fs/cifs/inode.c | 7 ++++--- 6 files changed, 44 insertions(+), 3 deletions(-)
fs/cifs/README +9 -0
@@ -337,6 +337,15 @@ A partial list of the supported mount options follows: wsize default write size (default 57344) maximum wsize currently allowed by CIFS is 57344 (fourteen 4096 byte pages) + actimeo=n attribute cache timeout in seconds (default 1 second). + After this timeout, the cifs client requests fresh attribute + information from the server. This option allows to tune the + attribute cache timeout to suit the workload needs. Shorter + timeouts mean better the cache coherency, but increased number + of calls to the server. Longer timeouts mean reduced number + of calls to the server at the expense of less stricter cache + coherency checks (i.e. incorrect attribute cache for a short + period of time). rw mount the network share read-write (note that the server may still consider the share read-only) ro mount network share read-only
fs/cifs/cifs_fs_sb.h +1 -0
@@ -48,6 +48,7 @@ struct cifs_sb_info {struct nls_table *local_nls;unsigned int rsize;unsigned int wsize; +unsigned long actimeo;/* attribute cache timeout (jiffies) */ atomic_t active;uid_t mnt_uid;gid_t mnt_gid;
fs/cifs/cifsfs.c +2 -0
@@ -463,6 +463,8 @@ cifs_show_options(struct seq_file *s, struct vfsmount *m)seq_printf (s,",rsize=%d" , cifs_sb->rsize);seq_printf (s,",wsize=%d" , cifs_sb->wsize); +/* convert actimeo and display it in seconds */ +seq_printf (s,",actimeo=%lu" , cifs_sb->actimeo /HZ );return 0 ; }
fs/cifs/cifsglob.h +10 -0
@@ -45,6 +45,16 @@#define CIFS_MIN_RCV_POOL 4/* +* default attribute cache timeout (jiffies) +*/ +#define CIFS_DEF_ACTIMEO (1 * HZ) + +/* +* max attribute cache timeout (jiffies) - 2^30 +*/ +#define CIFS_MAX_ACTIMEO (1 << 30) + +/* * MAX_REQ is the maximum number of requests that WE will send * on one socket concurrently. It also matches the most common * value of max multiplex returned by servers. We may
fs/cifs/connect.c +18 -0
@@ -105,6 +105,7 @@ struct smb_vol {unsigned int wsize; bool sockopt_tcp_nodelay:1;unsigned short int port; +unsigned long actimeo;/* attribute cache timeout (jiffies) */ char *prepath;struct sockaddr_storage srcaddr;/* allow binding to a local IP */ struct nls_table *local_nls;
@@ -1214,6 +1215,18 @@ cifs_parse_mount_options(char *options, const char *devname,printk (KERN_WARNING "CIFS: server net" "biosname longer than 15 truncated.\n" ); } + }else if (strnicmp (data,"actimeo" ,7 ) ==0 ) { +if (value && *value) { +if ((*value) *HZ >CIFS_MAX_ACTIMEO ) { +cERROR (1 ,"CIFS: attribute cache" +"timeout too large" ); +return 1 ; + }else + vol->actimeo = +simple_strtoul (value, + &value,0 ) *HZ ; + }else /* actimeo not specified, use default */ + vol->actimeo =CIFS_DEF_ACTIMEO ; }else if (strnicmp (data,"credentials" ,4 ) ==0 ) {/* ignore */ }else if (strnicmp (data,"version" ,3 ) ==0 ) {
@@ -2571,6 +2584,11 @@ static void setup_cifs_sb(struct smb_vol *pvolume_info,cFYI (1 ,"file mode: 0x%x dir mode: 0x%x" , cifs_sb->mnt_file_mode, cifs_sb->mnt_dir_mode); +if (pvolume_info->actimeo !=CIFS_DEF_ACTIMEO ) + cifs_sb->actimeo = pvolume_info->actimeo; +else + cifs_sb->actimeo =CIFS_DEF_ACTIMEO ; +if (pvolume_info->noperm) cifs_sb->mnt_cifs_flags |=CIFS_MOUNT_NO_PERM ;if (pvolume_info->setuids)
fs/cifs/inode.c +4 -3
@@ -1653,6 +1653,7 @@ static bool cifs_inode_needs_reval(struct inode *inode) {struct cifsInodeInfo *cifs_i =CIFS_I (inode); +struct cifs_sb_info *cifs_sb =CIFS_SB (inode->i_sb);if (cifs_i->clientCanCacheRead)return false;
@@ -1663,12 +1664,12 @@ cifs_inode_needs_reval(struct inode *inode)if (cifs_i->time ==0 )return true; -/* FIXME: the actimeo should be tunable */ -if (time_after_eq (jiffies, cifs_i->time +HZ )) +if (!time_in_range (jiffies, cifs_i->time, + cifs_i->time + cifs_sb->actimeo))return true;/* hardlinked files w/ noserverino get "special" treatment */ -if (!(CIFS_SB (inode->i_sb)->mnt_cifs_flags &CIFS_MOUNT_SERVER_INUM ) && +if (!(cifs_sb->mnt_cifs_flags &CIFS_MOUNT_SERVER_INUM ) &&S_ISREG (inode->i_mode) && inode->i_nlink !=1 )return true;
A message that is not in the archive (sent off-list or not yet received): 1291142743-9316-1-git-send-email-sjayaraman-l3A5Bk7waGM@public.gmane.org
Quoted 113 lines · On Wed, 1 Dec 2010 00:15:43 +0530 Suresh Jayaraman…
Currently, the attribute cache timeout for CIFS is hardcoded to 1 second. This means that the client might have to issue a QPATHINFO/QFILEINFO call every 1 second to verify if something has changes, which seems too expensive. On the other hand, if the timeout is hardcoded to a higher value, workloads that expect strict cache coherency might see unexpected results.
Making attribute cache timeout as a tunable will allow us to make a tradeoff between performance and cache metadata correctness depending on the application/workload needs.
Add 'actimeo' tunable that can be used to tune the attribute cache timeout. The default timeout is set to 1 second. Also, display actimeo option value in
/proc/mounts.It appears to me that 'actimeo' and the proposed (but not yet merged) 'strictcache' option cannot coexist, so care must be taken that we reset the other option if one of them is set.
Changes since last post:
- guard against wraparound issues with a max timeout value in jiffies (2^30)
- raise error if too large a actimeo value is specified
- handle actimeo=0 correctlyCc Jeff Layton <[email protected]>Signed-off-by Suresh Jayaraman <[email protected]>--- fs/cifs/README | 9 +++++++++ fs/cifs/cifs_fs_sb.h | 1 + fs/cifs/cifsfs.c | 2 ++ fs/cifs/cifsglob.h | 10 ++++++++++ fs/cifs/connect.c | 18 ++++++++++++++++++ fs/cifs/inode.c | 7 ++++--- 6 files changed, 44 insertions(+), 3 deletions(-)fs/cifs/README +9
-0@@ -337,6 +337,15 @@ A partial list of the supported mount options follows: wsize default write size (default 57344) maximum wsize currently allowed by CIFS is 57344 (fourteen 4096 byte pages) + actimeo=n attribute cache timeout in seconds (default 1 second). + After this timeout, the cifs client requests fresh attribute + information from the server. This option allows to tune the + attribute cache timeout to suit the workload needs. Shorter + timeouts mean better the cache coherency, but increased number + of calls to the server. Longer timeouts mean reduced number + of calls to the server at the expense of less stricter cache + coherency checks (i.e. incorrect attribute cache for a short + period of time). rw mount the network share read-write (note that the server may still consider the share read-only) ro mount network share read-onlyfs/cifs/cifs_fs_sb.h +1
-0@@ -48,6 +48,7 @@ struct cifs_sb_info {struct nls_table *local_nls;unsigned int rsize;unsigned int wsize; +unsigned long actimeo;/* attribute cache timeout (jiffies) */ atomic_t active;uid_t mnt_uid;gid_t mnt_gid;fs/cifs/cifsfs.c +2
-0@@ -463,6 +463,8 @@ cifs_show_options(struct seq_file *s, struct vfsmount *m)seq_printf (s,",rsize=%d" , cifs_sb->rsize);seq_printf (s,",wsize=%d" , cifs_sb->wsize); +/* convert actimeo and display it in seconds */ +seq_printf (s,",actimeo=%lu" , cifs_sb->actimeo /HZ );return 0 ; }fs/cifs/cifsglob.h +10
-0@@ -45,6 +45,16 @@#define CIFS_MIN_RCV_POOL 4/* +* default attribute cache timeout (jiffies) +*/ +#define CIFS_DEF_ACTIMEO (1 * HZ) + +/* +* max attribute cache timeout (jiffies) - 2^30 +*/ +#define CIFS_MAX_ACTIMEO (1 << 30) + +/* * MAX_REQ is the maximum number of requests that WE will send * on one socket concurrently. It also matches the most common * value of max multiplex returned by servers. We may fs/cifs/connect.c +1
-0@@ -105,6 +105,7 @@ struct smb_vol {unsigned int wsize; bool sockopt_tcp_nodelay:1;unsigned short int port; +unsigned long actimeo;/* attribute cache timeout (jiffies) */ char *prepath;struct sockaddr_storage srcaddr;/* allow binding to a local IP */ struct nls_table *local_nls;
fs/cifs/connect.c cifs_parse_mount_options(char *options, const char *devname, · line 1220
Quoted 6 lines
fs/cifs/connect.c +3
-0@@ -1214,6 +1215,18 @@ cifs_parse_mount_options(char *options, const char *devname,printk (KERN_WARNING "CIFS: server net" "biosname longer than 15 truncated.\n" ); } + }else if (strnicmp (data,"actimeo" ,7 ) ==0 ) { +if (value && *value) { +if ((*value) *HZ >CIFS_MAX_ACTIMEO ) {
You're multiplying the integer value of the first character of "value" times HZ and checking that against CIFS_MAX_ACTIMEO. That doesn't look right. You need to do the simple_strtoul first and then check the result.
Quoted 13 lines
fs/cifs/connect.c +9
-0+cERROR (1 ,"CIFS: attribute cache" +"timeout too large" ); +return 1 ; + }else + vol->actimeo = +simple_strtoul (value, + &value,0 ) *HZ ; + }else /* actimeo not specified, use default */ + vol->actimeo =CIFS_DEF_ACTIMEO ; }else if (strnicmp (data,"credentials" ,4 ) ==0 ) {/* ignore */ }else if (strnicmp (data,"version" ,3 ) ==0 ) {
fs/cifs/connect.c static void setup_cifs_sb(struct smb_vol *pvolume_info, · line 2591
Quoted 8 lines
fs/cifs/connect.c +5
-0@@ -2571,6 +2584,11 @@ static void setup_cifs_sb(struct smb_vol *pvolume_info,cFYI (1 ,"file mode: 0x%x dir mode: 0x%x" , cifs_sb->mnt_file_mode, cifs_sb->mnt_dir_mode); +if (pvolume_info->actimeo !=CIFS_DEF_ACTIMEO ) + cifs_sb->actimeo = pvolume_info->actimeo; +else + cifs_sb->actimeo =CIFS_DEF_ACTIMEO ; +
Hmm...so if I don't specify actimeo= at all, then it'll be set to 0, and I'll get cifs_sb->actimeo=0. I don't think that's what you want.
I think you can solve this by initializing vol->actimeo to CIFS_DEF_ACTIMEO before you parse any options. Then just do this afterward:
cifs_sb->actimeo = pvolume_info->actimeo;
Quoted 31 lines
fs/cifs/connect.c +0
-0if (pvolume_info->noperm) cifs_sb->mnt_cifs_flags |=CIFS_MOUNT_NO_PERM ;if (pvolume_info->setuids)fs/cifs/inode.c +4
-3@@ -1653,6 +1653,7 @@ static bool cifs_inode_needs_reval(struct inode *inode) {struct cifsInodeInfo *cifs_i =CIFS_I (inode); +struct cifs_sb_info *cifs_sb =CIFS_SB (inode->i_sb);if (cifs_i->clientCanCacheRead)return false;@@ -1663,12 +1664,12 @@ cifs_inode_needs_reval(struct inode *inode)if (cifs_i->time ==0 )return true; -/* FIXME: the actimeo should be tunable */ -if (time_after_eq (jiffies, cifs_i->time +HZ )) +if (!time_in_range (jiffies, cifs_i->time, + cifs_i->time + cifs_sb->actimeo))return true;/* hardlinked files w/ noserverino get "special" treatment */ -if (!(CIFS_SB (inode->i_sb)->mnt_cifs_flags &CIFS_MOUNT_SERVER_INUM ) && +if (!(cifs_sb->mnt_cifs_flags &CIFS_MOUNT_SERVER_INUM ) &&S_ISREG (inode->i_mode) && inode->i_nlink !=1 )return true;
Signature · 1 line
Jeff Layton <[email protected]>