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
8 * VFAT filesystem to <chaffee@cs.berkeley.edu>. Specify
9 * what file operation caused you trouble and if you can duplicate
10 * the problem, send a script that demonstrates it.
12 * Short name translation 1999, 2001 by Wolfram Pienkoss <wp@bszh.de>
14 * Support Multibyte characters and cleanup by
15 * OGAWA Hirofumi <hirofumi@mail.parknet.co.jp>
18 #include <linux/module.h>
20 #include <linux/jiffies.h>
21 #include <linux/msdos_fs.h>
22 #include <linux/ctype.h>
23 #include <linux/slab.h>
24 #include <linux/smp_lock.h>
25 #include <linux/buffer_head.h>
26 #include <linux/namei.h>
28 static int vfat_revalidate(struct dentry *dentry, struct nameidata *nd)
32 if (!dentry->d_inode &&
33 nd && !(nd->flags & LOOKUP_CONTINUE) && (nd->flags & LOOKUP_CREATE))
35 * negative dentry is dropped, in order to make sure
36 * to use the name which a user desires if this is
41 spin_lock(&dentry->d_lock);
42 if (dentry->d_time != dentry->d_parent->d_inode->i_version)
44 spin_unlock(&dentry->d_lock);
49 /* returns the length of a struct qstr, ignoring trailing dots */
50 static unsigned int vfat_striptail_len(struct qstr *qstr)
52 unsigned int len = qstr->len;
54 while (len && qstr->name[len - 1] == '.')
60 * Compute the hash for the vfat name corresponding to the dentry.
61 * Note: if the name is invalid, we leave the hash code unchanged so
62 * that the existing dentry can be used. The vfat fs routines will
63 * return ENOENT or EINVAL as appropriate.
65 static int vfat_hash(struct dentry *dentry, struct qstr *qstr)
67 qstr->hash = full_name_hash(qstr->name, vfat_striptail_len(qstr));
72 * Compute the hash for the vfat name corresponding to the dentry.
73 * Note: if the name is invalid, we leave the hash code unchanged so
74 * that the existing dentry can be used. The vfat fs routines will
75 * return ENOENT or EINVAL as appropriate.
77 static int vfat_hashi(struct dentry *dentry, struct qstr *qstr)
79 struct nls_table *t = MSDOS_SB(dentry->d_inode->i_sb)->nls_io;
80 const unsigned char *name;
85 len = vfat_striptail_len(qstr);
87 hash = init_name_hash();
89 hash = partial_name_hash(nls_tolower(t, *name++), hash);
90 qstr->hash = end_name_hash(hash);
96 * Case insensitive compare of two vfat names.
98 static int vfat_cmpi(struct dentry *dentry, struct qstr *a, struct qstr *b)
100 struct nls_table *t = MSDOS_SB(dentry->d_inode->i_sb)->nls_io;
101 unsigned int alen, blen;
103 /* A filename cannot end in '.' or we treat it like it has none */
104 alen = vfat_striptail_len(a);
105 blen = vfat_striptail_len(b);
107 if (nls_strnicmp(t, a->name, b->name, alen) == 0)
114 * Case sensitive compare of two vfat names.
116 static int vfat_cmp(struct dentry *dentry, struct qstr *a, struct qstr *b)
118 unsigned int alen, blen;
120 /* A filename cannot end in '.' or we treat it like it has none */
121 alen = vfat_striptail_len(a);
122 blen = vfat_striptail_len(b);
124 if (strncmp(a->name, b->name, alen) == 0)
130 static struct dentry_operations vfat_dentry_ops[4] = {
132 .d_hash = vfat_hashi,
133 .d_compare = vfat_cmpi,
136 .d_revalidate = vfat_revalidate,
137 .d_hash = vfat_hashi,
138 .d_compare = vfat_cmpi,
142 .d_compare = vfat_cmp,
145 .d_revalidate = vfat_revalidate,
147 .d_compare = vfat_cmp,
151 /* Characters that are undesirable in an MS-DOS file name */
153 static inline wchar_t vfat_bad_char(wchar_t w)
156 || (w == '*') || (w == '?') || (w == '<') || (w == '>')
157 || (w == '|') || (w == '"') || (w == ':') || (w == '/')
161 static inline wchar_t vfat_replace_char(wchar_t w)
163 return (w == '[') || (w == ']') || (w == ';') || (w == ',')
164 || (w == '+') || (w == '=');
167 static wchar_t vfat_skip_char(wchar_t w)
169 return (w == '.') || (w == ' ');
172 static inline int vfat_is_used_badchars(const wchar_t *s, int len)
176 for (i = 0; i < len; i++)
177 if (vfat_bad_char(s[i]))
182 static int vfat_valid_longname(const unsigned char *name, unsigned int len)
184 if (name[len - 1] == ' ')
187 return -ENAMETOOLONG;
189 /* MS-DOS "device special files" */
190 if (len == 3 || (len > 3 && name[3] == '.')) { /* basename == 3 */
191 if (!strnicmp(name, "aux", 3) ||
192 !strnicmp(name, "con", 3) ||
193 !strnicmp(name, "nul", 3) ||
194 !strnicmp(name, "prn", 3))
197 if (len == 4 || (len > 4 && name[4] == '.')) { /* basename == 4 */
198 /* "com1", "com2", ... */
199 if ('1' <= name[3] && name[3] <= '9') {
200 if (!strnicmp(name, "com", 3) ||
201 !strnicmp(name, "lpt", 3))
209 static int vfat_find_form(struct inode *dir, unsigned char *name)
211 struct fat_slot_info sinfo;
212 int err = fat_scan(dir, name, &sinfo);
220 * 1) Valid characters for the 8.3 format alias are any combination of
221 * letters, uppercase alphabets, digits, any of the
222 * following special characters:
223 * $ % ' ` - @ { } ~ ! # ( ) & _ ^
224 * In this case Longfilename is not stored in disk.
227 * File name and extension name is contain uppercase/lowercase
228 * only. And it is expressed by CASE_LOWER_BASE and CASE_LOWER_EXT.
230 * 2) File name is 8.3 format, but it contain the uppercase and
231 * lowercase char, muliti bytes char, etc. In this case numtail is not
232 * added, but Longfilename is stored.
234 * 3) When the one except for the above, or the following special
235 * character are contained:
237 * numtail is added, and Longfilename must be stored in disk .
239 struct shortname_info {
240 unsigned char lower:1,
244 #define INIT_SHORTNAME_INFO(x) do { \
250 static inline int to_shortname_char(struct nls_table *nls,
251 unsigned char *buf, int buf_size,
252 wchar_t *src, struct shortname_info *info)
256 if (vfat_skip_char(*src)) {
260 if (vfat_replace_char(*src)) {
266 len = nls->uni2char(*src, buf, buf_size);
271 } else if (len == 1) {
272 unsigned char prev = buf[0];
274 if (buf[0] >= 0x7F) {
279 buf[0] = nls_toupper(nls, buf[0]);
280 if (isalpha(buf[0])) {
295 * Given a valid longname, create a unique shortname. Make sure the
296 * shortname does not exist
297 * Returns negative number on error, 0 for a normal
298 * return, and 1 for valid shortname
300 static int vfat_create_shortname(struct inode *dir, struct nls_table *nls,
301 wchar_t *uname, int ulen,
302 unsigned char *name_res, unsigned char *lcase)
304 struct fat_mount_options *opts = &MSDOS_SB(dir->i_sb)->options;
305 wchar_t *ip, *ext_start, *end, *name_start;
306 unsigned char base[9], ext[4], buf[8], *p;
307 unsigned char charbuf[NLS_MAX_CHARSET_SIZE];
309 int sz = 0, extlen, baselen, i, numtail_baselen, numtail2_baselen;
311 struct shortname_info base_info, ext_info;
314 INIT_SHORTNAME_INFO(&base_info);
315 INIT_SHORTNAME_INFO(&ext_info);
317 /* Now, we need to create a shortname from the long name */
318 ext_start = end = &uname[ulen];
319 while (--ext_start >= uname) {
320 if (*ext_start == 0x002E) { /* is `.' */
321 if (ext_start == end - 1) {
329 if (ext_start == uname - 1) {
332 } else if (ext_start) {
334 * Names which start with a dot could be just
335 * an extension eg. "...test". In this case Win95
336 * uses the extension as the name and sets no extension.
338 name_start = &uname[0];
339 while (name_start < ext_start) {
340 if (!vfat_skip_char(*name_start))
344 if (name_start != ext_start) {
345 sz = ext_start - uname;
354 numtail2_baselen = 2;
355 for (baselen = i = 0, p = base, ip = uname; i < sz; i++, ip++) {
356 chl = to_shortname_char(nls, charbuf, sizeof(charbuf),
361 if (baselen < 2 && (baselen + chl) > 2)
362 numtail2_baselen = baselen;
363 if (baselen < 6 && (baselen + chl) > 6)
364 numtail_baselen = baselen;
365 for (chi = 0; chi < chl; chi++) {
372 if ((chi < chl - 1) || (ip + 1) - uname < sz)
383 for (p = ext, ip = ext_start; extlen < 3 && ip < end; ip++) {
384 chl = to_shortname_char(nls, charbuf, sizeof(charbuf),
389 if ((extlen + chl) > 3) {
393 for (chi = 0; chi < chl; chi++) {
405 base[baselen] = '\0';
407 /* Yes, it can happen. ".\xe5" would do it. */
408 if (base[0] == DELETED_FLAG)
411 /* OK, at this point we know that base is not longer than 8 symbols,
412 * ext is not longer than 3, base is nonempty, both don't contain
413 * any bad symbols (lowercase transformed to uppercase).
416 memset(name_res, ' ', MSDOS_NAME);
417 memcpy(name_res, base, baselen);
418 memcpy(name_res + 8, ext, extlen);
420 if (is_shortname && base_info.valid && ext_info.valid) {
421 if (vfat_find_form(dir, name_res) == 0)
424 if (opts->shortname & VFAT_SFN_CREATE_WIN95) {
425 return (base_info.upper && ext_info.upper);
426 } else if (opts->shortname & VFAT_SFN_CREATE_WINNT) {
427 if ((base_info.upper || base_info.lower) &&
428 (ext_info.upper || ext_info.lower)) {
429 if (!base_info.upper && base_info.lower)
430 *lcase |= CASE_LOWER_BASE;
431 if (!ext_info.upper && ext_info.lower)
432 *lcase |= CASE_LOWER_EXT;
441 if (opts->numtail == 0)
442 if (vfat_find_form(dir, name_res) < 0)
446 * Try to find a unique extension. This used to
447 * iterate through all possibilities sequentially,
448 * but that gave extremely bad performance. Windows
449 * only tries a few cases before using random
450 * values for part of the base.
454 baselen = numtail_baselen;
457 name_res[baselen] = '~';
458 for (i = 1; i < 10; i++) {
459 name_res[baselen + 1] = i + '0';
460 if (vfat_find_form(dir, name_res) < 0)
464 i = jiffies & 0xffff;
465 sz = (jiffies >> 16) & 0x7;
467 baselen = numtail2_baselen;
470 name_res[baselen + 4] = '~';
471 name_res[baselen + 5] = '1' + sz;
473 sprintf(buf, "%04X", i);
474 memcpy(&name_res[baselen], buf, 4);
475 if (vfat_find_form(dir, name_res) < 0)
482 /* Translate a string, including coded sequences into Unicode */
484 xlate_to_uni(const unsigned char *name, int len, unsigned char *outname,
485 int *longlen, int *outlen, int escape, int utf8,
486 struct nls_table *nls)
488 const unsigned char *ip;
496 int name_len = strlen(name);
498 *outlen = utf8_mbstowcs((wchar_t *)outname, name, PAGE_SIZE);
501 * We stripped '.'s before and set len appropriately,
502 * but utf8_mbstowcs doesn't care about len
504 *outlen -= (name_len - len);
506 op = &outname[*outlen * sizeof(wchar_t)];
509 for (i = 0, ip = name, op = outname, *outlen = 0;
510 i < len && *outlen <= 260;
513 if (escape && (*ip == ':')) {
517 for (k = 1; k < 5; k++) {
520 if (nc >= '0' && nc <= '9') {
524 if (nc >= 'a' && nc <= 'f') {
525 ec |= nc - ('a' - 10);
528 if (nc >= 'A' && nc <= 'F') {
529 ec |= nc - ('A' - 10);
539 if ((charlen = nls->char2uni(ip, len - i, (wchar_t *)op)) < 0)
547 for (i = 0, ip = name, op = outname, *outlen = 0;
548 i < len && *outlen <= 260;
557 return -ENAMETOOLONG;
565 fill = 13 - (*outlen % 13);
566 for (i = 0; i < fill; i++) {
577 static int vfat_build_slots(struct inode *dir, const unsigned char *name,
578 int len, int is_dir, int cluster,
580 struct msdos_dir_slot *slots, int *nr_slots)
582 struct msdos_sb_info *sbi = MSDOS_SB(dir->i_sb);
583 struct fat_mount_options *opts = &sbi->options;
584 struct msdos_dir_slot *ps;
585 struct msdos_dir_entry *de;
587 unsigned char cksum, lcase;
588 unsigned char msdos_name[MSDOS_NAME];
591 int err, ulen, usize, i;
595 err = vfat_valid_longname(name, len);
599 page = __get_free_page(GFP_KERNEL);
603 uname = (wchar_t *)page;
604 err = xlate_to_uni(name, len, (unsigned char *)uname, &ulen, &usize,
605 opts->unicode_xlate, opts->utf8, sbi->nls_io);
609 err = vfat_is_used_badchars(uname, ulen);
613 err = vfat_create_shortname(dir, sbi->nls_disk, uname, ulen,
618 de = (struct msdos_dir_entry *)slots;
623 /* build the entry of long file name */
624 cksum = fat_checksum(msdos_name);
626 *nr_slots = usize / 13;
627 for (ps = slots, i = *nr_slots; i > 0; i--, ps++) {
631 ps->alias_checksum = cksum;
633 offset = (i - 1) * 13;
634 fatwchar_to16(ps->name0_4, uname + offset, 5);
635 fatwchar_to16(ps->name5_10, uname + offset + 5, 6);
636 fatwchar_to16(ps->name11_12, uname + offset + 11, 2);
639 de = (struct msdos_dir_entry *)ps;
642 /* build the entry of 8.3 alias name */
644 memcpy(de->name, msdos_name, MSDOS_NAME);
645 de->attr = is_dir ? ATTR_DIR : ATTR_ARCH;
647 fat_date_unix2dos(ts->tv_sec, &time, &date);
648 de->time = de->ctime = time;
649 de->date = de->cdate = de->adate = date;
651 de->start = cpu_to_le16(cluster);
652 de->starthi = cpu_to_le16(cluster >> 16);
659 static int vfat_add_entry(struct inode *dir, struct qstr *qname, int is_dir,
660 int cluster, struct timespec *ts,
661 struct fat_slot_info *sinfo)
663 struct msdos_dir_slot *slots;
667 len = vfat_striptail_len(qname);
671 slots = kmalloc(sizeof(*slots) * MSDOS_SLOTS, GFP_KERNEL);
675 err = vfat_build_slots(dir, qname->name, len, is_dir, cluster, ts,
680 err = fat_add_entries(dir, slots, nr_slots, sinfo);
684 /* update timestamp */
685 dir->i_ctime = dir->i_mtime = dir->i_atime = *ts;
687 (void)fat_sync_inode(dir);
689 mark_inode_dirty(dir);
695 static int vfat_find(struct inode *dir, struct qstr *qname,
696 struct fat_slot_info *sinfo)
698 unsigned int len = vfat_striptail_len(qname);
701 return fat_search_long(dir, qname->name, len, sinfo);
704 static struct dentry *vfat_lookup(struct inode *dir, struct dentry *dentry,
705 struct nameidata *nd)
707 struct super_block *sb = dir->i_sb;
708 struct fat_slot_info sinfo;
709 struct inode *inode = NULL;
710 struct dentry *alias;
714 table = (MSDOS_SB(sb)->options.name_check == 's') ? 2 : 0;
715 dentry->d_op = &vfat_dentry_ops[table];
717 err = vfat_find(dir, &dentry->d_name, &sinfo);
722 inode = fat_build_inode(sb, sinfo.de, sinfo.i_pos);
726 return ERR_PTR(PTR_ERR(inode));
728 alias = d_find_alias(inode);
730 if (d_invalidate(alias) == 0)
741 dentry->d_op = &vfat_dentry_ops[table];
742 dentry->d_time = dentry->d_parent->d_inode->i_version;
743 dentry = d_splice_alias(inode, dentry);
745 dentry->d_op = &vfat_dentry_ops[table];
746 dentry->d_time = dentry->d_parent->d_inode->i_version;
751 static int vfat_create(struct inode *dir, struct dentry *dentry, int mode,
752 struct nameidata *nd)
754 struct super_block *sb = dir->i_sb;
756 struct fat_slot_info sinfo;
762 ts = CURRENT_TIME_SEC;
763 err = vfat_add_entry(dir, &dentry->d_name, 0, 0, &ts, &sinfo);
768 inode = fat_build_inode(sb, sinfo.de, sinfo.i_pos);
771 err = PTR_ERR(inode);
775 inode->i_mtime = inode->i_atime = inode->i_ctime = ts;
776 /* timestamp is already written, so mark_inode_dirty() is unneeded. */
778 dentry->d_time = dentry->d_parent->d_inode->i_version;
779 d_instantiate(dentry, inode);
785 static int vfat_rmdir(struct inode *dir, struct dentry *dentry)
787 struct inode *inode = dentry->d_inode;
788 struct fat_slot_info sinfo;
793 err = fat_dir_empty(inode);
796 err = vfat_find(dir, &dentry->d_name, &sinfo);
800 err = fat_remove_entries(dir, &sinfo); /* and releases bh */
806 inode->i_mtime = inode->i_atime = CURRENT_TIME_SEC;
814 static int vfat_unlink(struct inode *dir, struct dentry *dentry)
816 struct inode *inode = dentry->d_inode;
817 struct fat_slot_info sinfo;
822 err = vfat_find(dir, &dentry->d_name, &sinfo);
826 err = fat_remove_entries(dir, &sinfo); /* and releases bh */
830 inode->i_mtime = inode->i_atime = CURRENT_TIME_SEC;
838 static int vfat_mkdir(struct inode *dir, struct dentry *dentry, int mode)
840 struct super_block *sb = dir->i_sb;
842 struct fat_slot_info sinfo;
848 ts = CURRENT_TIME_SEC;
849 cluster = fat_alloc_new_dir(dir, &ts);
854 err = vfat_add_entry(dir, &dentry->d_name, 1, cluster, &ts, &sinfo);
860 inode = fat_build_inode(sb, sinfo.de, sinfo.i_pos);
863 err = PTR_ERR(inode);
864 /* the directory was completed, just return a error */
869 inode->i_mtime = inode->i_atime = inode->i_ctime = ts;
870 /* timestamp is already written, so mark_inode_dirty() is unneeded. */
872 dentry->d_time = dentry->d_parent->d_inode->i_version;
873 d_instantiate(dentry, inode);
879 fat_free_clusters(dir, cluster);
885 static int vfat_rename(struct inode *old_dir, struct dentry *old_dentry,
886 struct inode *new_dir, struct dentry *new_dentry)
888 struct buffer_head *dotdot_bh;
889 struct msdos_dir_entry *dotdot_de;
890 struct inode *old_inode, *new_inode;
891 struct fat_slot_info old_sinfo, sinfo;
893 loff_t dotdot_i_pos, new_i_pos;
894 int err, is_dir, update_dotdot, corrupt = 0;
896 old_sinfo.bh = sinfo.bh = dotdot_bh = NULL;
897 old_inode = old_dentry->d_inode;
898 new_inode = new_dentry->d_inode;
900 err = vfat_find(old_dir, &old_dentry->d_name, &old_sinfo);
904 is_dir = S_ISDIR(old_inode->i_mode);
905 update_dotdot = (is_dir && old_dir != new_dir);
907 if (fat_get_dotdot_entry(old_inode, &dotdot_bh, &dotdot_de,
908 &dotdot_i_pos) < 0) {
914 ts = CURRENT_TIME_SEC;
917 err = fat_dir_empty(new_inode);
921 new_i_pos = MSDOS_I(new_inode)->i_pos;
922 fat_detach(new_inode);
924 err = vfat_add_entry(new_dir, &new_dentry->d_name, is_dir, 0,
928 new_i_pos = sinfo.i_pos;
930 new_dir->i_version++;
932 fat_detach(old_inode);
933 fat_attach(old_inode, new_i_pos);
934 if (IS_DIRSYNC(new_dir)) {
935 err = fat_sync_inode(old_inode);
939 mark_inode_dirty(old_inode);
942 int start = MSDOS_I(new_dir)->i_logstart;
943 dotdot_de->start = cpu_to_le16(start);
944 dotdot_de->starthi = cpu_to_le16(start >> 16);
945 mark_buffer_dirty(dotdot_bh);
946 if (IS_DIRSYNC(new_dir)) {
947 err = sync_dirty_buffer(dotdot_bh);
956 err = fat_remove_entries(old_dir, &old_sinfo); /* and releases bh */
960 old_dir->i_version++;
961 old_dir->i_ctime = old_dir->i_mtime = ts;
962 if (IS_DIRSYNC(old_dir))
963 (void)fat_sync_inode(old_dir);
965 mark_inode_dirty(old_dir);
969 new_inode->i_nlink -= 2;
971 new_inode->i_nlink--;
972 new_inode->i_ctime = ts;
977 brelse(old_sinfo.bh);
983 /* data cluster is shared, serious corruption */
987 int start = MSDOS_I(old_dir)->i_logstart;
988 dotdot_de->start = cpu_to_le16(start);
989 dotdot_de->starthi = cpu_to_le16(start >> 16);
990 mark_buffer_dirty(dotdot_bh);
991 corrupt |= sync_dirty_buffer(dotdot_bh);
994 fat_detach(old_inode);
995 fat_attach(old_inode, old_sinfo.i_pos);
997 fat_attach(new_inode, new_i_pos);
999 corrupt |= fat_sync_inode(new_inode);
1002 * If new entry was not sharing the data cluster, it
1003 * shouldn't be serious corruption.
1005 int err2 = fat_remove_entries(new_dir, &sinfo);
1011 fat_fs_panic(new_dir->i_sb,
1012 "%s: Filesystem corrupted (i_pos %lld)",
1013 __FUNCTION__, sinfo.i_pos);
1018 static struct inode_operations vfat_dir_inode_operations = {
1019 .create = vfat_create,
1020 .lookup = vfat_lookup,
1021 .unlink = vfat_unlink,
1022 .mkdir = vfat_mkdir,
1023 .rmdir = vfat_rmdir,
1024 .rename = vfat_rename,
1025 .setattr = fat_notify_change,
1028 static int vfat_fill_super(struct super_block *sb, void *data, int silent)
1032 res = fat_fill_super(sb, data, silent, &vfat_dir_inode_operations, 1);
1036 if (MSDOS_SB(sb)->options.name_check != 's')
1037 sb->s_root->d_op = &vfat_dentry_ops[0];
1039 sb->s_root->d_op = &vfat_dentry_ops[2];
1044 static struct super_block *vfat_get_sb(struct file_system_type *fs_type,
1045 int flags, const char *dev_name,
1048 return get_sb_bdev(fs_type, flags, dev_name, data, vfat_fill_super);
1051 static struct file_system_type vfat_fs_type = {
1052 .owner = THIS_MODULE,
1054 .get_sb = vfat_get_sb,
1055 .kill_sb = kill_block_super,
1056 .fs_flags = FS_REQUIRES_DEV,
1059 static int __init init_vfat_fs(void)
1061 return register_filesystem(&vfat_fs_type);
1064 static void __exit exit_vfat_fs(void)
1066 unregister_filesystem(&vfat_fs_type);
1069 MODULE_LICENSE("GPL");
1070 MODULE_DESCRIPTION("VFAT filesystem support");
1071 MODULE_AUTHOR("Gordon Chaffee");
1073 module_init(init_vfat_fs)
1074 module_exit(exit_vfat_fs)