2 * linux/fs/vfat/namei.c
4 * Written 1992,1993 by Werner Almesberger
6 * Windows95/Windows NT compatible extended MSDOS filesystem
7 * by Gordon Chaffee Copyright (C) 1995. Send bug reports for the
9 * what file operation caused you trouble and if you can duplicate
10 * the problem, send a script that demonstrates it.
14 * Support Multibyte characters and cleanup by
18 #include <linux/module.h>
19 #include <linux/jiffies.h>
20 #include <linux/ctype.h>
21 #include <linux/slab.h>
22 #include <linux/buffer_head.h>
23 #include <linux/namei.h>
27 * If new entry was created in the parent, it could create the 8.3
28 * alias (the shortname of logname). So, the parent may have the
29 * negative-dentry which matches the created 8.3 alias.
31 * If it happened, the negative dentry isn't actually negative
32 * anymore. So, drop it.
34 static int vfat_revalidate_shortname(struct dentry *dentry)
37 spin_lock(&dentry->d_lock);
38 if (dentry->d_time != dentry->d_parent->d_inode->i_version)
40 spin_unlock(&dentry->d_lock);
44 static int vfat_revalidate(struct dentry *dentry, struct nameidata *nd)
46 /* This is not negative dentry. Always valid. */
49 return vfat_revalidate_shortname(dentry);
52 static int vfat_revalidate_ci(struct dentry *dentry, struct nameidata *nd)
55 * This is not negative dentry. Always valid.
57 * Note, rename() to existing directory entry will have ->d_inode,
58 * and will use existing name which isn't specified name by user.
60 * We may be able to drop this positive dentry here. But dropping
61 * positive dentry isn't good idea. So it's unsupported like
62 * rename("filename", "FILENAME") for now.
68 * This may be nfsd (or something), anyway, we can't see the
69 * intent of this. So, since this can be for creation, drop it.
75 * Drop the negative dentry, in order to make sure to use the
76 * case sensitive name which is specified by user if this is
79 if (!(nd->flags & (LOOKUP_CONTINUE | LOOKUP_PARENT))) {
80 if (nd->flags & (LOOKUP_CREATE | LOOKUP_RENAME_TARGET))
84 return vfat_revalidate_shortname(dentry);
87 /* returns the length of a struct qstr, ignoring trailing dots */
88 static unsigned int vfat_striptail_len(struct qstr *qstr)
90 unsigned int len = qstr->len;
92 while (len && qstr->name[len - 1] == '.')
98 * Compute the hash for the vfat name corresponding to the dentry.
99 * Note: if the name is invalid, we leave the hash code unchanged so
100 * that the existing dentry can be used. The vfat fs routines will
101 * return ENOENT or EINVAL as appropriate.
103 static int vfat_hash(struct dentry *dentry, struct qstr *qstr)
105 qstr->hash = full_name_hash(qstr->name, vfat_striptail_len(qstr));
110 * Compute the hash for the vfat name corresponding to the dentry.
111 * Note: if the name is invalid, we leave the hash code unchanged so
112 * that the existing dentry can be used. The vfat fs routines will
113 * return ENOENT or EINVAL as appropriate.
115 static int vfat_hashi(struct dentry *dentry, struct qstr *qstr)
117 struct nls_table *t = MSDOS_SB(dentry->d_inode->i_sb)->nls_io;
118 const unsigned char *name;
123 len = vfat_striptail_len(qstr);
125 hash = init_name_hash();
127 hash = partial_name_hash(nls_tolower(t, *name++), hash);
128 qstr->hash = end_name_hash(hash);
134 * Case insensitive compare of two vfat names.
136 static int vfat_cmpi(struct dentry *dentry, struct qstr *a, struct qstr *b)
138 struct nls_table *t = MSDOS_SB(dentry->d_inode->i_sb)->nls_io;
139 unsigned int alen, blen;
141 /* A filename cannot end in '.' or we treat it like it has none */
142 alen = vfat_striptail_len(a);
143 blen = vfat_striptail_len(b);
145 if (nls_strnicmp(t, a->name, b->name, alen) == 0)
152 * Case sensitive compare of two vfat names.
154 static int vfat_cmp(struct dentry *dentry, struct qstr *a, struct qstr *b)
156 unsigned int alen, blen;
158 /* A filename cannot end in '.' or we treat it like it has none */
159 alen = vfat_striptail_len(a);
160 blen = vfat_striptail_len(b);
162 if (strncmp(a->name, b->name, alen) == 0)
168 static const struct dentry_operations vfat_ci_dentry_ops = {
169 .d_revalidate = vfat_revalidate_ci,
170 .d_hash = vfat_hashi,
171 .d_compare = vfat_cmpi,
174 static const struct dentry_operations vfat_dentry_ops = {
175 .d_revalidate = vfat_revalidate,
177 .d_compare = vfat_cmp,
180 /* Characters that are undesirable in an MS-DOS file name */
182 static inline wchar_t vfat_bad_char(wchar_t w)
185 || (w == '*') || (w == '?') || (w == '<') || (w == '>')
186 || (w == '|') || (w == '"') || (w == ':') || (w == '/')
190 static inline wchar_t vfat_replace_char(wchar_t w)
192 return (w == '[') || (w == ']') || (w == ';') || (w == ',')
193 || (w == '+') || (w == '=');
196 static wchar_t vfat_skip_char(wchar_t w)
198 return (w == '.') || (w == ' ');
201 static inline int vfat_is_used_badchars(const wchar_t *s, int len)
205 for (i = 0; i < len; i++)
206 if (vfat_bad_char(s[i]))
209 if (s[i - 1] == ' ') /* last character cannot be space */
215 static int vfat_find_form(struct inode *dir, unsigned char *name)
217 struct fat_slot_info sinfo;
218 int err = fat_scan(dir, name, &sinfo);
226 * 1) Valid characters for the 8.3 format alias are any combination of
227 * letters, uppercase alphabets, digits, any of the
228 * following special characters:
229 * $ % ' ` - @ { } ~ ! # ( ) & _ ^
230 * In this case Longfilename is not stored in disk.
233 * File name and extension name is contain uppercase/lowercase
234 * only. And it is expressed by CASE_LOWER_BASE and CASE_LOWER_EXT.
236 * 2) File name is 8.3 format, but it contain the uppercase and
237 * lowercase char, muliti bytes char, etc. In this case numtail is not
238 * added, but Longfilename is stored.
240 * 3) When the one except for the above, or the following special
241 * character are contained:
243 * numtail is added, and Longfilename must be stored in disk .
245 struct shortname_info {
246 unsigned char lower:1,
250 #define INIT_SHORTNAME_INFO(x) do { \
256 static inline int to_shortname_char(struct nls_table *nls,
257 unsigned char *buf, int buf_size,
258 wchar_t *src, struct shortname_info *info)
262 if (vfat_skip_char(*src)) {
266 if (vfat_replace_char(*src)) {
272 len = nls->uni2char(*src, buf, buf_size);
277 } else if (len == 1) {
278 unsigned char prev = buf[0];
280 if (buf[0] >= 0x7F) {
285 buf[0] = nls_toupper(nls, buf[0]);
286 if (isalpha(buf[0])) {
301 * Given a valid longname, create a unique shortname. Make sure the
302 * shortname does not exist
303 * Returns negative number on error, 0 for a normal
304 * return, and 1 for valid shortname
306 static int vfat_create_shortname(struct inode *dir, struct nls_table *nls,
307 wchar_t *uname, int ulen,
308 unsigned char *name_res, unsigned char *lcase)
310 struct fat_mount_options *opts = &MSDOS_SB(dir->i_sb)->options;
311 wchar_t *ip, *ext_start, *end, *name_start;
312 unsigned char base[9], ext[4], buf[8], *p;
313 unsigned char charbuf[NLS_MAX_CHARSET_SIZE];
315 int sz = 0, extlen, baselen, i, numtail_baselen, numtail2_baselen;
317 struct shortname_info base_info, ext_info;
320 INIT_SHORTNAME_INFO(&base_info);
321 INIT_SHORTNAME_INFO(&ext_info);
323 /* Now, we need to create a shortname from the long name */
324 ext_start = end = &uname[ulen];
325 while (--ext_start >= uname) {
326 if (*ext_start == 0x002E) { /* is `.' */
327 if (ext_start == end - 1) {
335 if (ext_start == uname - 1) {
338 } else if (ext_start) {
340 * Names which start with a dot could be just
341 * an extension eg. "...test". In this case Win95
342 * uses the extension as the name and sets no extension.
344 name_start = &uname[0];
345 while (name_start < ext_start) {
346 if (!vfat_skip_char(*name_start))
350 if (name_start != ext_start) {
351 sz = ext_start - uname;
360 numtail2_baselen = 2;
361 for (baselen = i = 0, p = base, ip = uname; i < sz; i++, ip++) {
362 chl = to_shortname_char(nls, charbuf, sizeof(charbuf),
367 if (baselen < 2 && (baselen + chl) > 2)
368 numtail2_baselen = baselen;
369 if (baselen < 6 && (baselen + chl) > 6)
370 numtail_baselen = baselen;
371 for (chi = 0; chi < chl; chi++) {
378 if ((chi < chl - 1) || (ip + 1) - uname < sz)
389 for (p = ext, ip = ext_start; extlen < 3 && ip < end; ip++) {
390 chl = to_shortname_char(nls, charbuf, sizeof(charbuf),
395 if ((extlen + chl) > 3) {
399 for (chi = 0; chi < chl; chi++) {
411 base[baselen] = '\0';
413 /* Yes, it can happen. ".\xe5" would do it. */
414 if (base[0] == DELETED_FLAG)
417 /* OK, at this point we know that base is not longer than 8 symbols,
418 * ext is not longer than 3, base is nonempty, both don't contain
419 * any bad symbols (lowercase transformed to uppercase).
422 memset(name_res, ' ', MSDOS_NAME);
423 memcpy(name_res, base, baselen);
424 memcpy(name_res + 8, ext, extlen);
426 if (is_shortname && base_info.valid && ext_info.valid) {
427 if (vfat_find_form(dir, name_res) == 0)
430 if (opts->shortname & VFAT_SFN_CREATE_WIN95) {
431 return (base_info.upper && ext_info.upper);
432 } else if (opts->shortname & VFAT_SFN_CREATE_WINNT) {
433 if ((base_info.upper || base_info.lower) &&
434 (ext_info.upper || ext_info.lower)) {
435 if (!base_info.upper && base_info.lower)
436 *lcase |= CASE_LOWER_BASE;
437 if (!ext_info.upper && ext_info.lower)
438 *lcase |= CASE_LOWER_EXT;
447 if (opts->numtail == 0)
448 if (vfat_find_form(dir, name_res) < 0)
452 * Try to find a unique extension. This used to
453 * iterate through all possibilities sequentially,
454 * but that gave extremely bad performance. Windows
455 * only tries a few cases before using random
456 * values for part of the base.
460 baselen = numtail_baselen;
463 name_res[baselen] = '~';
464 for (i = 1; i < 10; i++) {
465 name_res[baselen + 1] = i + '0';
466 if (vfat_find_form(dir, name_res) < 0)
470 i = jiffies & 0xffff;
471 sz = (jiffies >> 16) & 0x7;
473 baselen = numtail2_baselen;
476 name_res[baselen + 4] = '~';
477 name_res[baselen + 5] = '1' + sz;
479 sprintf(buf, "%04X", i);
480 memcpy(&name_res[baselen], buf, 4);
481 if (vfat_find_form(dir, name_res) < 0)
488 /* Translate a string, including coded sequences into Unicode */
490 xlate_to_uni(const unsigned char *name, int len, unsigned char *outname,
491 int *longlen, int *outlen, int escape, int utf8,
492 struct nls_table *nls)
494 const unsigned char *ip;
502 int name_len = strlen(name);
504 *outlen = utf8s_to_utf16s(name, PATH_MAX, (wchar_t *) outname);
507 * We stripped '.'s before and set len appropriately,
508 * but utf8s_to_utf16s doesn't care about len
510 *outlen -= (name_len - len);
513 return -ENAMETOOLONG;
515 op = &outname[*outlen * sizeof(wchar_t)];
518 for (i = 0, ip = name, op = outname, *outlen = 0;
519 i < len && *outlen <= 255;
522 if (escape && (*ip == ':')) {
526 for (k = 1; k < 5; k++) {
529 if (nc >= '0' && nc <= '9') {
533 if (nc >= 'a' && nc <= 'f') {
534 ec |= nc - ('a' - 10);
537 if (nc >= 'A' && nc <= 'F') {
538 ec |= nc - ('A' - 10);
548 if ((charlen = nls->char2uni(ip, len - i, (wchar_t *)op)) < 0)
556 return -ENAMETOOLONG;
558 for (i = 0, ip = name, op = outname, *outlen = 0;
559 i < len && *outlen <= 255;
566 return -ENAMETOOLONG;
576 fill = 13 - (*outlen % 13);
577 for (i = 0; i < fill; i++) {
588 static int vfat_build_slots(struct inode *dir, const unsigned char *name,
589 int len, int is_dir, int cluster,
591 struct msdos_dir_slot *slots, int *nr_slots)
593 struct msdos_sb_info *sbi = MSDOS_SB(dir->i_sb);
594 struct fat_mount_options *opts = &sbi->options;
595 struct msdos_dir_slot *ps;
596 struct msdos_dir_entry *de;
597 unsigned char cksum, lcase;
598 unsigned char msdos_name[MSDOS_NAME];
602 int err, ulen, usize, i;
611 err = xlate_to_uni(name, len, (unsigned char *)uname, &ulen, &usize,
612 opts->unicode_xlate, opts->utf8, sbi->nls_io);
616 err = vfat_is_used_badchars(uname, ulen);
620 err = vfat_create_shortname(dir, sbi->nls_disk, uname, ulen,
625 de = (struct msdos_dir_entry *)slots;
630 /* build the entry of long file name */
631 cksum = fat_checksum(msdos_name);
633 *nr_slots = usize / 13;
634 for (ps = slots, i = *nr_slots; i > 0; i--, ps++) {
638 ps->alias_checksum = cksum;
640 offset = (i - 1) * 13;
641 fatwchar_to16(ps->name0_4, uname + offset, 5);
642 fatwchar_to16(ps->name5_10, uname + offset + 5, 6);
643 fatwchar_to16(ps->name11_12, uname + offset + 11, 2);
646 de = (struct msdos_dir_entry *)ps;
649 /* build the entry of 8.3 alias name */
651 memcpy(de->name, msdos_name, MSDOS_NAME);
652 de->attr = is_dir ? ATTR_DIR : ATTR_ARCH;
654 fat_time_unix2fat(sbi, ts, &time, &date, &time_cs);
655 de->time = de->ctime = time;
656 de->date = de->cdate = de->adate = date;
657 de->ctime_cs = time_cs;
658 de->start = cpu_to_le16(cluster);
659 de->starthi = cpu_to_le16(cluster >> 16);
666 static int vfat_add_entry(struct inode *dir, struct qstr *qname, int is_dir,
667 int cluster, struct timespec *ts,
668 struct fat_slot_info *sinfo)
670 struct msdos_dir_slot *slots;
674 len = vfat_striptail_len(qname);
678 slots = kmalloc(sizeof(*slots) * MSDOS_SLOTS, GFP_NOFS);
682 err = vfat_build_slots(dir, qname->name, len, is_dir, cluster, ts,
687 err = fat_add_entries(dir, slots, nr_slots, sinfo);
691 /* update timestamp */
692 dir->i_ctime = dir->i_mtime = dir->i_atime = *ts;
694 (void)fat_sync_inode(dir);
696 mark_inode_dirty(dir);
702 static int vfat_find(struct inode *dir, struct qstr *qname,
703 struct fat_slot_info *sinfo)
705 unsigned int len = vfat_striptail_len(qname);
708 return fat_search_long(dir, qname->name, len, sinfo);
711 static struct dentry *vfat_lookup(struct inode *dir, struct dentry *dentry,
712 struct nameidata *nd)
714 struct super_block *sb = dir->i_sb;
715 struct fat_slot_info sinfo;
717 struct dentry *alias;
722 err = vfat_find(dir, &dentry->d_name, &sinfo);
724 if (err == -ENOENT) {
731 inode = fat_build_inode(sb, sinfo.de, sinfo.i_pos);
734 err = PTR_ERR(inode);
738 alias = d_find_alias(inode);
739 if (alias && !(alias->d_flags & DCACHE_DISCONNECTED)) {
741 * This inode has non DCACHE_DISCONNECTED dentry. This
742 * means, the user did ->lookup() by an another name
743 * (longname vs 8.3 alias of it) in past.
745 * Switch to new one for reason of locality if possible.
747 BUG_ON(d_unhashed(alias));
748 if (!S_ISDIR(inode->i_mode))
749 d_move(alias, dentry);
756 dentry->d_op = sb->s_root->d_op;
757 dentry->d_time = dentry->d_parent->d_inode->i_version;
758 dentry = d_splice_alias(inode, dentry);
760 dentry->d_op = sb->s_root->d_op;
761 dentry->d_time = dentry->d_parent->d_inode->i_version;
770 static int vfat_create(struct inode *dir, struct dentry *dentry, int mode,
771 struct nameidata *nd)
773 struct super_block *sb = dir->i_sb;
775 struct fat_slot_info sinfo;
781 ts = CURRENT_TIME_SEC;
782 err = vfat_add_entry(dir, &dentry->d_name, 0, 0, &ts, &sinfo);
787 inode = fat_build_inode(sb, sinfo.de, sinfo.i_pos);
790 err = PTR_ERR(inode);
794 inode->i_mtime = inode->i_atime = inode->i_ctime = ts;
795 /* timestamp is already written, so mark_inode_dirty() is unneeded. */
797 dentry->d_time = dentry->d_parent->d_inode->i_version;
798 d_instantiate(dentry, inode);
804 static int vfat_rmdir(struct inode *dir, struct dentry *dentry)
806 struct inode *inode = dentry->d_inode;
807 struct super_block *sb = dir->i_sb;
808 struct fat_slot_info sinfo;
813 err = fat_dir_empty(inode);
816 err = vfat_find(dir, &dentry->d_name, &sinfo);
820 err = fat_remove_entries(dir, &sinfo); /* and releases bh */
826 inode->i_mtime = inode->i_atime = CURRENT_TIME_SEC;
834 static int vfat_unlink(struct inode *dir, struct dentry *dentry)
836 struct inode *inode = dentry->d_inode;
837 struct super_block *sb = dir->i_sb;
838 struct fat_slot_info sinfo;
843 err = vfat_find(dir, &dentry->d_name, &sinfo);
847 err = fat_remove_entries(dir, &sinfo); /* and releases bh */
851 inode->i_mtime = inode->i_atime = CURRENT_TIME_SEC;
859 static int vfat_mkdir(struct inode *dir, struct dentry *dentry, int mode)
861 struct super_block *sb = dir->i_sb;
863 struct fat_slot_info sinfo;
869 ts = CURRENT_TIME_SEC;
870 cluster = fat_alloc_new_dir(dir, &ts);
875 err = vfat_add_entry(dir, &dentry->d_name, 1, cluster, &ts, &sinfo);
881 inode = fat_build_inode(sb, sinfo.de, sinfo.i_pos);
884 err = PTR_ERR(inode);
885 /* the directory was completed, just return a error */
890 inode->i_mtime = inode->i_atime = inode->i_ctime = ts;
891 /* timestamp is already written, so mark_inode_dirty() is unneeded. */
893 dentry->d_time = dentry->d_parent->d_inode->i_version;
894 d_instantiate(dentry, inode);
900 fat_free_clusters(dir, cluster);
906 static int vfat_rename(struct inode *old_dir, struct dentry *old_dentry,
907 struct inode *new_dir, struct dentry *new_dentry)
909 struct buffer_head *dotdot_bh;
910 struct msdos_dir_entry *dotdot_de;
911 struct inode *old_inode, *new_inode;
912 struct fat_slot_info old_sinfo, sinfo;
914 loff_t dotdot_i_pos, new_i_pos;
915 int err, is_dir, update_dotdot, corrupt = 0;
916 struct super_block *sb = old_dir->i_sb;
918 old_sinfo.bh = sinfo.bh = dotdot_bh = NULL;
919 old_inode = old_dentry->d_inode;
920 new_inode = new_dentry->d_inode;
922 err = vfat_find(old_dir, &old_dentry->d_name, &old_sinfo);
926 is_dir = S_ISDIR(old_inode->i_mode);
927 update_dotdot = (is_dir && old_dir != new_dir);
929 if (fat_get_dotdot_entry(old_inode, &dotdot_bh, &dotdot_de,
930 &dotdot_i_pos) < 0) {
936 ts = CURRENT_TIME_SEC;
939 err = fat_dir_empty(new_inode);
943 new_i_pos = MSDOS_I(new_inode)->i_pos;
944 fat_detach(new_inode);
946 err = vfat_add_entry(new_dir, &new_dentry->d_name, is_dir, 0,
950 new_i_pos = sinfo.i_pos;
952 new_dir->i_version++;
954 fat_detach(old_inode);
955 fat_attach(old_inode, new_i_pos);
956 if (IS_DIRSYNC(new_dir)) {
957 err = fat_sync_inode(old_inode);
961 mark_inode_dirty(old_inode);
964 int start = MSDOS_I(new_dir)->i_logstart;
965 dotdot_de->start = cpu_to_le16(start);
966 dotdot_de->starthi = cpu_to_le16(start >> 16);
967 mark_buffer_dirty_inode(dotdot_bh, old_inode);
968 if (IS_DIRSYNC(new_dir)) {
969 err = sync_dirty_buffer(dotdot_bh);
978 err = fat_remove_entries(old_dir, &old_sinfo); /* and releases bh */
982 old_dir->i_version++;
983 old_dir->i_ctime = old_dir->i_mtime = ts;
984 if (IS_DIRSYNC(old_dir))
985 (void)fat_sync_inode(old_dir);
987 mark_inode_dirty(old_dir);
990 drop_nlink(new_inode);
992 drop_nlink(new_inode);
993 new_inode->i_ctime = ts;
998 brelse(old_sinfo.bh);
1004 /* data cluster is shared, serious corruption */
1007 if (update_dotdot) {
1008 int start = MSDOS_I(old_dir)->i_logstart;
1009 dotdot_de->start = cpu_to_le16(start);
1010 dotdot_de->starthi = cpu_to_le16(start >> 16);
1011 mark_buffer_dirty_inode(dotdot_bh, old_inode);
1012 corrupt |= sync_dirty_buffer(dotdot_bh);
1015 fat_detach(old_inode);
1016 fat_attach(old_inode, old_sinfo.i_pos);
1018 fat_attach(new_inode, new_i_pos);
1020 corrupt |= fat_sync_inode(new_inode);
1023 * If new entry was not sharing the data cluster, it
1024 * shouldn't be serious corruption.
1026 int err2 = fat_remove_entries(new_dir, &sinfo);
1032 fat_fs_error(new_dir->i_sb,
1033 "%s: Filesystem corrupted (i_pos %lld)",
1034 __func__, sinfo.i_pos);
1039 static const struct inode_operations vfat_dir_inode_operations = {
1040 .create = vfat_create,
1041 .lookup = vfat_lookup,
1042 .unlink = vfat_unlink,
1043 .mkdir = vfat_mkdir,
1044 .rmdir = vfat_rmdir,
1045 .rename = vfat_rename,
1046 .setattr = fat_setattr,
1047 .getattr = fat_getattr,
1050 static int vfat_fill_super(struct super_block *sb, void *data, int silent)
1054 res = fat_fill_super(sb, data, silent, &vfat_dir_inode_operations, 1);
1058 if (MSDOS_SB(sb)->options.name_check != 's')
1059 sb->s_root->d_op = &vfat_ci_dentry_ops;
1061 sb->s_root->d_op = &vfat_dentry_ops;
1066 static int vfat_get_sb(struct file_system_type *fs_type,
1067 int flags, const char *dev_name,
1068 void *data, struct vfsmount *mnt)
1070 return get_sb_bdev(fs_type, flags, dev_name, data, vfat_fill_super,
1074 static struct file_system_type vfat_fs_type = {
1075 .owner = THIS_MODULE,
1077 .get_sb = vfat_get_sb,
1078 .kill_sb = kill_block_super,
1079 .fs_flags = FS_REQUIRES_DEV,
1082 static int __init init_vfat_fs(void)
1084 return register_filesystem(&vfat_fs_type);
1087 static void __exit exit_vfat_fs(void)
1089 unregister_filesystem(&vfat_fs_type);
1092 MODULE_LICENSE("GPL");
1093 MODULE_DESCRIPTION("VFAT filesystem support");
1094 MODULE_AUTHOR("Gordon Chaffee");
1096 module_init(init_vfat_fs)
1097 module_exit(exit_vfat_fs)