| Message ID | 20220518172320.333617-4-krisman@collabora.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Clean up the case-insensitive lookup path | expand |
On Wed, May 18, 2022 at 01:23:15PM -0400, Gabriel Krisman Bertazi wrote: > generic_ci_match can be used by case-insensitive filesystems to compare > strings under lookup with dirents in a case-insensitive way. This > function is currently reimplemented by each filesystem supporting > casefolding, so this reduces code duplication in filesystem-specific > code. > > Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.com> > --- > fs/libfs.c | 65 ++++++++++++++++++++++++++++++++++++++++++++++ > include/linux/fs.h | 4 +++ > 2 files changed, 69 insertions(+) > > diff --git a/fs/libfs.c b/fs/libfs.c > index 974125270a42..6861d43563be 100644 > --- a/fs/libfs.c > +++ b/fs/libfs.c > @@ -1465,6 +1465,71 @@ static const struct dentry_operations generic_ci_dentry_ops = { > .d_hash = generic_ci_d_hash, > .d_compare = generic_ci_d_compare, > }; > + > +/** > + * generic_ci_match() - Match a name (case-insensitively) name with a dirent. > + * @parent: Inode of the parent of the dirent under comparison > + * @name: name under lookup. > + * @folded_name: Optional pre-folded name under lookup > + * @de_name: Dirent name. > + * @de_name_len: dirent name length. > + * > + * > + * Test whether a case-insensitive directory entry matches the filename > + * being searched. If @folded_name is provided, it is used instead of > + * recalculating the casefold of @name. > + * > + * Return: > 0 if the directory entry matches, 0 if it doesn't match, or > + * < 0 on error. > + */ > +int generic_ci_match(const struct inode *parent, > + const struct qstr *name, > + const struct qstr *folded_name, > + const u8 *de_name, size_t de_name_len) > +{ > + const struct super_block *sb = parent->i_sb; > + const struct unicode_map *um = sb->s_encoding; > + struct fscrypt_str decrypted_name = FSTR_INIT(NULL, de_name_len); de_name_len is getting truncated to u32, so the parameter itself should be a u32, like f2fs_match_ci_name(). > + struct qstr dirent = QSTR_INIT(de_name, de_name_len); > + int err, match = false; > + > + if (IS_ENCRYPTED(parent)) { > + const struct fscrypt_str encrypted_name = > + FSTR_INIT((u8 *) de_name, de_name_len); The 'if (WARN_ON_ONCE(!fscrypt_has_encryption_key(parent))) return -EINVAL;' from f2fs_match_ci_name() should be kept here, as this is not going to work as intended if the encryption key is unavailable. (Unless the name is "." or "..", as you saw in my recent patch, but that should be avoided anyway.) > + > + decrypted_name.name = kmalloc(de_name_len, GFP_KERNEL); > + if (!decrypted_name.name) > + return -ENOMEM; > + err = fscrypt_fname_disk_to_usr(parent, 0, 0, &encrypted_name, > + &decrypted_name); > + if (err < 0) > + goto out; > + dirent.name = decrypted_name.name; > + dirent.len = decrypted_name.len; > + } > + > + if (folded_name->name) > + err = utf8_strncasecmp_folded(um, folded_name, &dirent); > + else > + err = utf8_strncasecmp(um, name, &dirent); Variables called 'err' conventionally store either 0 or a negative error value. Here, 'err' can store a positive value. It would be better to call it something else, such as 'res' which f2fs_match_ci_name() uses. - Eric
diff --git a/fs/libfs.c b/fs/libfs.c index 974125270a42..6861d43563be 100644 --- a/fs/libfs.c +++ b/fs/libfs.c @@ -1465,6 +1465,71 @@ static const struct dentry_operations generic_ci_dentry_ops = { .d_hash = generic_ci_d_hash, .d_compare = generic_ci_d_compare, }; + +/** + * generic_ci_match() - Match a name (case-insensitively) name with a dirent. + * @parent: Inode of the parent of the dirent under comparison + * @name: name under lookup. + * @folded_name: Optional pre-folded name under lookup + * @de_name: Dirent name. + * @de_name_len: dirent name length. + * + * + * Test whether a case-insensitive directory entry matches the filename + * being searched. If @folded_name is provided, it is used instead of + * recalculating the casefold of @name. + * + * Return: > 0 if the directory entry matches, 0 if it doesn't match, or + * < 0 on error. + */ +int generic_ci_match(const struct inode *parent, + const struct qstr *name, + const struct qstr *folded_name, + const u8 *de_name, size_t de_name_len) +{ + const struct super_block *sb = parent->i_sb; + const struct unicode_map *um = sb->s_encoding; + struct fscrypt_str decrypted_name = FSTR_INIT(NULL, de_name_len); + struct qstr dirent = QSTR_INIT(de_name, de_name_len); + int err, match = false; + + if (IS_ENCRYPTED(parent)) { + const struct fscrypt_str encrypted_name = + FSTR_INIT((u8 *) de_name, de_name_len); + + decrypted_name.name = kmalloc(de_name_len, GFP_KERNEL); + if (!decrypted_name.name) + return -ENOMEM; + err = fscrypt_fname_disk_to_usr(parent, 0, 0, &encrypted_name, + &decrypted_name); + if (err < 0) + goto out; + dirent.name = decrypted_name.name; + dirent.len = decrypted_name.len; + } + + if (folded_name->name) + err = utf8_strncasecmp_folded(um, folded_name, &dirent); + else + err = utf8_strncasecmp(um, name, &dirent); + + if (!err) + match = true; + else if (err < 0 && !sb_has_strict_encoding(sb)) { + /* + * In non-strict mode, fallback to a byte comparison if + * the names have invalid characters. + */ + err = 0; + match = ((name->len == dirent.len) && + !memcmp(name->name, dirent.name, dirent.len)); + } + +out: + kfree(decrypted_name.name); + return (err >= 0) ? match : err; +} +EXPORT_SYMBOL(generic_ci_match); #endif #ifdef CONFIG_FS_ENCRYPTION diff --git a/include/linux/fs.h b/include/linux/fs.h index e2d892b201b0..7a0214bfac34 100644 --- a/include/linux/fs.h +++ b/include/linux/fs.h @@ -3359,6 +3359,10 @@ extern int generic_file_fsync(struct file *, loff_t, loff_t, int); extern int generic_check_addressable(unsigned, u64); extern void generic_set_encrypted_ci_d_ops(struct dentry *dentry); +extern int generic_ci_match(const struct inode *parent, + const struct qstr *name, + const struct qstr *folded_name, + const u8 *de_name, size_t de_name_len); #ifdef CONFIG_MIGRATION extern int buffer_migrate_page(struct address_space *,
generic_ci_match can be used by case-insensitive filesystems to compare strings under lookup with dirents in a case-insensitive way. This function is currently reimplemented by each filesystem supporting casefolding, so this reduces code duplication in filesystem-specific code. Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.com> --- fs/libfs.c | 65 ++++++++++++++++++++++++++++++++++++++++++++++ include/linux/fs.h | 4 +++ 2 files changed, 69 insertions(+)