1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/fs/msdos/namei.c
5 * Written 1992,1993 by Werner Almesberger
6 * Hidden files 1995 by Albert Cahalan <albert@ccs.neu.edu> <adc@coe.neu.edu>
7 * Rewritten for constant inumbers 1999 by Al Viro
10 #include <linux/module.h>
11 #include <linux/iversion.h>
14 /* Characters that are undesirable in an MS-DOS file name */
15 static unsigned char bad_chars
[] = "*?<>|\"";
16 static unsigned char bad_if_strict
[] = "+=,; ";
18 /***** Formats an MS-DOS file name. Rejects invalid names. */
19 static int msdos_format_name(const unsigned char *name
, int len
,
20 unsigned char *res
, struct fat_mount_options
*opts
)
22 * name is the proposed name, len is its length, res is
23 * the resulting name, opts->name_check is either (r)elaxed,
24 * (n)ormal or (s)trict, opts->dotsOK allows dots at the
25 * beginning of name (for hidden files)
32 if (name
[0] == '.') { /* dotfile because . and .. already done */
34 /* Get rid of dot - test for it elsewhere */
41 * disallow names that _really_ start with a dot
45 for (walk
= res
; len
&& walk
- res
< 8; walk
++) {
48 if (opts
->name_check
!= 'r' && strchr(bad_chars
, c
))
50 if (opts
->name_check
== 's' && strchr(bad_if_strict
, c
))
52 if (c
>= 'A' && c
<= 'Z' && opts
->name_check
== 's')
54 if (c
< ' ' || c
== ':' || c
== '\\')
57 * 0xE5 is legal as a first character, but we must substitute
58 * 0x05 because 0xE5 marks deleted files. Yes, DOS really
60 * It seems that Microsoft hacked DOS to support non-US
61 * characters after the 0xE5 character was already in use to
64 if ((res
== walk
) && (c
== 0xE5))
69 *walk
= (!opts
->nocase
&& c
>= 'a' && c
<= 'z') ? c
- 32 : c
;
73 if (opts
->name_check
== 's' && len
&& c
!= '.') {
79 while (c
!= '.' && len
--)
82 while (walk
- res
< 8)
84 while (len
> 0 && walk
- res
< MSDOS_NAME
) {
87 if (opts
->name_check
!= 'r' && strchr(bad_chars
, c
))
89 if (opts
->name_check
== 's' &&
90 strchr(bad_if_strict
, c
))
92 if (c
< ' ' || c
== ':' || c
== '\\')
95 if (opts
->name_check
== 's')
99 if (c
>= 'A' && c
<= 'Z' && opts
->name_check
== 's')
102 if (!opts
->nocase
&& c
>= 'a' && c
<= 'z')
109 if (opts
->name_check
== 's' && len
)
112 while (walk
- res
< MSDOS_NAME
)
118 /***** Locates a directory entry. Uses unformatted name. */
119 static int msdos_find(struct inode
*dir
, const unsigned char *name
, int len
,
120 struct fat_slot_info
*sinfo
)
122 struct msdos_sb_info
*sbi
= MSDOS_SB(dir
->i_sb
);
123 unsigned char msdos_name
[MSDOS_NAME
];
126 err
= msdos_format_name(name
, len
, msdos_name
, &sbi
->options
);
130 err
= fat_scan(dir
, msdos_name
, sinfo
);
131 if (!err
&& sbi
->options
.dotsOK
) {
132 if (name
[0] == '.') {
133 if (!(sinfo
->de
->attr
& ATTR_HIDDEN
))
136 if (sinfo
->de
->attr
& ATTR_HIDDEN
)
146 * Compute the hash for the msdos name corresponding to the dentry.
147 * Note: if the name is invalid, we leave the hash code unchanged so
148 * that the existing dentry can be used. The msdos fs routines will
149 * return ENOENT or EINVAL as appropriate.
151 static int msdos_hash(const struct dentry
*dentry
, struct qstr
*qstr
)
153 struct fat_mount_options
*options
= &MSDOS_SB(dentry
->d_sb
)->options
;
154 unsigned char msdos_name
[MSDOS_NAME
];
157 error
= msdos_format_name(qstr
->name
, qstr
->len
, msdos_name
, options
);
159 qstr
->hash
= full_name_hash(dentry
, msdos_name
, MSDOS_NAME
);
164 * Compare two msdos names. If either of the names are invalid,
165 * we fall back to doing the standard name comparison.
167 static int msdos_cmp(const struct dentry
*dentry
,
168 unsigned int len
, const char *str
, const struct qstr
*name
)
170 struct fat_mount_options
*options
= &MSDOS_SB(dentry
->d_sb
)->options
;
171 unsigned char a_msdos_name
[MSDOS_NAME
], b_msdos_name
[MSDOS_NAME
];
174 error
= msdos_format_name(name
->name
, name
->len
, a_msdos_name
, options
);
177 error
= msdos_format_name(str
, len
, b_msdos_name
, options
);
180 error
= memcmp(a_msdos_name
, b_msdos_name
, MSDOS_NAME
);
186 if (name
->len
== len
)
187 error
= memcmp(name
->name
, str
, len
);
191 static const struct dentry_operations msdos_dentry_operations
= {
192 .d_hash
= msdos_hash
,
193 .d_compare
= msdos_cmp
,
197 * AV. Wrappers for FAT sb operations. Is it wise?
200 /***** Get inode using directory and name */
201 static struct dentry
*msdos_lookup(struct inode
*dir
, struct dentry
*dentry
,
204 struct super_block
*sb
= dir
->i_sb
;
205 struct fat_slot_info sinfo
;
209 mutex_lock(&MSDOS_SB(sb
)->s_lock
);
210 err
= msdos_find(dir
, dentry
->d_name
.name
, dentry
->d_name
.len
, &sinfo
);
216 inode
= fat_build_inode(sb
, sinfo
.de
, sinfo
.i_pos
);
220 inode
= ERR_PTR(err
);
222 mutex_unlock(&MSDOS_SB(sb
)->s_lock
);
223 return d_splice_alias(inode
, dentry
);
226 /***** Creates a directory entry (name is already formatted). */
227 static int msdos_add_entry(struct inode
*dir
, const unsigned char *name
,
228 int is_dir
, int is_hid
, int cluster
,
229 struct timespec64
*ts
, struct fat_slot_info
*sinfo
)
231 struct msdos_sb_info
*sbi
= MSDOS_SB(dir
->i_sb
);
232 struct msdos_dir_entry de
;
236 memcpy(de
.name
, name
, MSDOS_NAME
);
237 de
.attr
= is_dir
? ATTR_DIR
: ATTR_ARCH
;
239 de
.attr
|= ATTR_HIDDEN
;
241 fat_time_unix2fat(sbi
, ts
, &time
, &date
, NULL
);
242 de
.cdate
= de
.adate
= 0;
247 fat_set_start(&de
, cluster
);
250 err
= fat_add_entries(dir
, &de
, 1, sinfo
);
254 fat_truncate_time(dir
, ts
, S_CTIME
|S_MTIME
);
256 (void)fat_sync_inode(dir
);
258 mark_inode_dirty(dir
);
263 /***** Create a file */
264 static int msdos_create(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
,
267 struct super_block
*sb
= dir
->i_sb
;
268 struct inode
*inode
= NULL
;
269 struct fat_slot_info sinfo
;
270 struct timespec64 ts
;
271 unsigned char msdos_name
[MSDOS_NAME
];
274 mutex_lock(&MSDOS_SB(sb
)->s_lock
);
276 err
= msdos_format_name(dentry
->d_name
.name
, dentry
->d_name
.len
,
277 msdos_name
, &MSDOS_SB(sb
)->options
);
280 is_hid
= (dentry
->d_name
.name
[0] == '.') && (msdos_name
[0] != '.');
281 /* Have to do it due to foo vs. .foo conflicts */
282 if (!fat_scan(dir
, msdos_name
, &sinfo
)) {
288 ts
= current_time(dir
);
289 err
= msdos_add_entry(dir
, msdos_name
, 0, is_hid
, 0, &ts
, &sinfo
);
292 inode
= fat_build_inode(sb
, sinfo
.de
, sinfo
.i_pos
);
295 err
= PTR_ERR(inode
);
298 fat_truncate_time(inode
, &ts
, S_ATIME
|S_CTIME
|S_MTIME
);
299 /* timestamp is already written, so mark_inode_dirty() is unneeded. */
301 d_instantiate(dentry
, inode
);
303 mutex_unlock(&MSDOS_SB(sb
)->s_lock
);
305 err
= fat_flush_inodes(sb
, dir
, inode
);
309 /***** Remove a directory */
310 static int msdos_rmdir(struct inode
*dir
, struct dentry
*dentry
)
312 struct super_block
*sb
= dir
->i_sb
;
313 struct inode
*inode
= d_inode(dentry
);
314 struct fat_slot_info sinfo
;
317 mutex_lock(&MSDOS_SB(sb
)->s_lock
);
318 err
= fat_dir_empty(inode
);
321 err
= msdos_find(dir
, dentry
->d_name
.name
, dentry
->d_name
.len
, &sinfo
);
325 err
= fat_remove_entries(dir
, &sinfo
); /* and releases bh */
331 fat_truncate_time(inode
, NULL
, S_CTIME
);
334 mutex_unlock(&MSDOS_SB(sb
)->s_lock
);
336 err
= fat_flush_inodes(sb
, dir
, inode
);
341 /***** Make a directory */
342 static int msdos_mkdir(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
)
344 struct super_block
*sb
= dir
->i_sb
;
345 struct fat_slot_info sinfo
;
347 unsigned char msdos_name
[MSDOS_NAME
];
348 struct timespec64 ts
;
349 int err
, is_hid
, cluster
;
351 mutex_lock(&MSDOS_SB(sb
)->s_lock
);
353 err
= msdos_format_name(dentry
->d_name
.name
, dentry
->d_name
.len
,
354 msdos_name
, &MSDOS_SB(sb
)->options
);
357 is_hid
= (dentry
->d_name
.name
[0] == '.') && (msdos_name
[0] != '.');
358 /* foo vs .foo situation */
359 if (!fat_scan(dir
, msdos_name
, &sinfo
)) {
365 ts
= current_time(dir
);
366 cluster
= fat_alloc_new_dir(dir
, &ts
);
371 err
= msdos_add_entry(dir
, msdos_name
, 1, is_hid
, cluster
, &ts
, &sinfo
);
376 inode
= fat_build_inode(sb
, sinfo
.de
, sinfo
.i_pos
);
379 err
= PTR_ERR(inode
);
380 /* the directory was completed, just return a error */
384 fat_truncate_time(inode
, &ts
, S_ATIME
|S_CTIME
|S_MTIME
);
385 /* timestamp is already written, so mark_inode_dirty() is unneeded. */
387 d_instantiate(dentry
, inode
);
389 mutex_unlock(&MSDOS_SB(sb
)->s_lock
);
390 fat_flush_inodes(sb
, dir
, inode
);
394 fat_free_clusters(dir
, cluster
);
396 mutex_unlock(&MSDOS_SB(sb
)->s_lock
);
400 /***** Unlink a file */
401 static int msdos_unlink(struct inode
*dir
, struct dentry
*dentry
)
403 struct inode
*inode
= d_inode(dentry
);
404 struct super_block
*sb
= inode
->i_sb
;
405 struct fat_slot_info sinfo
;
408 mutex_lock(&MSDOS_SB(sb
)->s_lock
);
409 err
= msdos_find(dir
, dentry
->d_name
.name
, dentry
->d_name
.len
, &sinfo
);
413 err
= fat_remove_entries(dir
, &sinfo
); /* and releases bh */
417 fat_truncate_time(inode
, NULL
, S_CTIME
);
420 mutex_unlock(&MSDOS_SB(sb
)->s_lock
);
422 err
= fat_flush_inodes(sb
, dir
, inode
);
427 static int do_msdos_rename(struct inode
*old_dir
, unsigned char *old_name
,
428 struct dentry
*old_dentry
,
429 struct inode
*new_dir
, unsigned char *new_name
,
430 struct dentry
*new_dentry
, int is_hid
)
432 struct buffer_head
*dotdot_bh
;
433 struct msdos_dir_entry
*dotdot_de
;
434 struct inode
*old_inode
, *new_inode
;
435 struct fat_slot_info old_sinfo
, sinfo
;
436 struct timespec64 ts
;
438 int err
, old_attrs
, is_dir
, update_dotdot
, corrupt
= 0;
440 old_sinfo
.bh
= sinfo
.bh
= dotdot_bh
= NULL
;
441 old_inode
= d_inode(old_dentry
);
442 new_inode
= d_inode(new_dentry
);
444 err
= fat_scan(old_dir
, old_name
, &old_sinfo
);
450 is_dir
= S_ISDIR(old_inode
->i_mode
);
451 update_dotdot
= (is_dir
&& old_dir
!= new_dir
);
453 if (fat_get_dotdot_entry(old_inode
, &dotdot_bh
, &dotdot_de
)) {
459 old_attrs
= MSDOS_I(old_inode
)->i_attrs
;
460 err
= fat_scan(new_dir
, new_name
, &sinfo
);
463 /* "foo" -> ".foo" case. just change the ATTR_HIDDEN */
464 if (sinfo
.de
!= old_sinfo
.de
) {
469 MSDOS_I(old_inode
)->i_attrs
|= ATTR_HIDDEN
;
471 MSDOS_I(old_inode
)->i_attrs
&= ~ATTR_HIDDEN
;
472 if (IS_DIRSYNC(old_dir
)) {
473 err
= fat_sync_inode(old_inode
);
475 MSDOS_I(old_inode
)->i_attrs
= old_attrs
;
479 mark_inode_dirty(old_inode
);
481 inode_inc_iversion(old_dir
);
482 fat_truncate_time(old_dir
, NULL
, S_CTIME
|S_MTIME
);
483 if (IS_DIRSYNC(old_dir
))
484 (void)fat_sync_inode(old_dir
);
486 mark_inode_dirty(old_dir
);
491 ts
= current_time(old_inode
);
496 err
= fat_dir_empty(new_inode
);
500 new_i_pos
= MSDOS_I(new_inode
)->i_pos
;
501 fat_detach(new_inode
);
503 err
= msdos_add_entry(new_dir
, new_name
, is_dir
, is_hid
, 0,
507 new_i_pos
= sinfo
.i_pos
;
509 inode_inc_iversion(new_dir
);
511 fat_detach(old_inode
);
512 fat_attach(old_inode
, new_i_pos
);
514 MSDOS_I(old_inode
)->i_attrs
|= ATTR_HIDDEN
;
516 MSDOS_I(old_inode
)->i_attrs
&= ~ATTR_HIDDEN
;
517 if (IS_DIRSYNC(new_dir
)) {
518 err
= fat_sync_inode(old_inode
);
522 mark_inode_dirty(old_inode
);
525 fat_set_start(dotdot_de
, MSDOS_I(new_dir
)->i_logstart
);
526 mark_buffer_dirty_inode(dotdot_bh
, old_inode
);
527 if (IS_DIRSYNC(new_dir
)) {
528 err
= sync_dirty_buffer(dotdot_bh
);
537 err
= fat_remove_entries(old_dir
, &old_sinfo
); /* and releases bh */
541 inode_inc_iversion(old_dir
);
542 fat_truncate_time(old_dir
, &ts
, S_CTIME
|S_MTIME
);
543 if (IS_DIRSYNC(old_dir
))
544 (void)fat_sync_inode(old_dir
);
546 mark_inode_dirty(old_dir
);
549 drop_nlink(new_inode
);
551 drop_nlink(new_inode
);
552 fat_truncate_time(new_inode
, &ts
, S_CTIME
);
557 brelse(old_sinfo
.bh
);
561 /* data cluster is shared, serious corruption */
565 fat_set_start(dotdot_de
, MSDOS_I(old_dir
)->i_logstart
);
566 mark_buffer_dirty_inode(dotdot_bh
, old_inode
);
567 corrupt
|= sync_dirty_buffer(dotdot_bh
);
570 fat_detach(old_inode
);
571 fat_attach(old_inode
, old_sinfo
.i_pos
);
572 MSDOS_I(old_inode
)->i_attrs
= old_attrs
;
574 fat_attach(new_inode
, new_i_pos
);
576 corrupt
|= fat_sync_inode(new_inode
);
579 * If new entry was not sharing the data cluster, it
580 * shouldn't be serious corruption.
582 int err2
= fat_remove_entries(new_dir
, &sinfo
);
588 fat_fs_error(new_dir
->i_sb
,
589 "%s: Filesystem corrupted (i_pos %lld)",
590 __func__
, sinfo
.i_pos
);
595 /***** Rename, a wrapper for rename_same_dir & rename_diff_dir */
596 static int msdos_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
597 struct inode
*new_dir
, struct dentry
*new_dentry
,
600 struct super_block
*sb
= old_dir
->i_sb
;
601 unsigned char old_msdos_name
[MSDOS_NAME
], new_msdos_name
[MSDOS_NAME
];
604 if (flags
& ~RENAME_NOREPLACE
)
607 mutex_lock(&MSDOS_SB(sb
)->s_lock
);
609 err
= msdos_format_name(old_dentry
->d_name
.name
,
610 old_dentry
->d_name
.len
, old_msdos_name
,
611 &MSDOS_SB(old_dir
->i_sb
)->options
);
614 err
= msdos_format_name(new_dentry
->d_name
.name
,
615 new_dentry
->d_name
.len
, new_msdos_name
,
616 &MSDOS_SB(new_dir
->i_sb
)->options
);
621 (new_dentry
->d_name
.name
[0] == '.') && (new_msdos_name
[0] != '.');
623 err
= do_msdos_rename(old_dir
, old_msdos_name
, old_dentry
,
624 new_dir
, new_msdos_name
, new_dentry
, is_hid
);
626 mutex_unlock(&MSDOS_SB(sb
)->s_lock
);
628 err
= fat_flush_inodes(sb
, old_dir
, new_dir
);
632 static const struct inode_operations msdos_dir_inode_operations
= {
633 .create
= msdos_create
,
634 .lookup
= msdos_lookup
,
635 .unlink
= msdos_unlink
,
636 .mkdir
= msdos_mkdir
,
637 .rmdir
= msdos_rmdir
,
638 .rename
= msdos_rename
,
639 .setattr
= fat_setattr
,
640 .getattr
= fat_getattr
,
641 .update_time
= fat_update_time
,
644 static void setup(struct super_block
*sb
)
646 MSDOS_SB(sb
)->dir_ops
= &msdos_dir_inode_operations
;
647 sb
->s_d_op
= &msdos_dentry_operations
;
648 sb
->s_flags
|= SB_NOATIME
;
651 static int msdos_fill_super(struct super_block
*sb
, void *data
, int silent
)
653 return fat_fill_super(sb
, data
, silent
, 0, setup
);
656 static struct dentry
*msdos_mount(struct file_system_type
*fs_type
,
657 int flags
, const char *dev_name
,
660 return mount_bdev(fs_type
, flags
, dev_name
, data
, msdos_fill_super
);
663 static struct file_system_type msdos_fs_type
= {
664 .owner
= THIS_MODULE
,
666 .mount
= msdos_mount
,
667 .kill_sb
= kill_block_super
,
668 .fs_flags
= FS_REQUIRES_DEV
,
670 MODULE_ALIAS_FS("msdos");
672 static int __init
init_msdos_fs(void)
674 return register_filesystem(&msdos_fs_type
);
677 static void __exit
exit_msdos_fs(void)
679 unregister_filesystem(&msdos_fs_type
);
682 MODULE_LICENSE("GPL");
683 MODULE_AUTHOR("Werner Almesberger");
684 MODULE_DESCRIPTION("MS-DOS filesystem support");
686 module_init(init_msdos_fs
)
687 module_exit(exit_msdos_fs
)