mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-09-30 22:26:55 +00:00
Code Issues Releases Wiki Activity

docs: filesystems: convert ntfs.txt to ReST

Browse source 
- Add a SPDX header;
- Adjust document title;
- Comment out text-only ToC;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/f09ca6c9bdd4e7aa7208f3dba0b8753080b38d03.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2020-02-17 17:12:13 +01:00 committed by Jonathan Corbet
parent 2640c19dca
commit 461f2c8f13
2 changed files with 81 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Documentation/filesystems/index.rst
View file

@ -74,7 +74,8 @@ Documentation for filesystem implementations.
inotify inotify
isofs isofs
nilfs2 nilfs2
nfs/index
ntfs
overlayfs overlayfs
virtiofs virtiofs
vfat vfat
nfs/index

143
Documentation/filesystems/ntfs.txt → Documentation/filesystems/ntfs.rst
View file

@ -1,19 +1,21 @@
.. SPDX-License-Identifier: GPL-2.0
================================
The Linux NTFS filesystem driver The Linux NTFS filesystem driver
================================ ================================
Table of contents .. Table of contents
=================
- Overview - Overview
- Web site - Web site
- Features - Features
- Supported mount options - Supported mount options
- Known bugs and (mis-)features - Known bugs and (mis-)features
- Using NTFS volume and stripe sets - Using NTFS volume and stripe sets
- The Device-Mapper driver - The Device-Mapper driver
- The Software RAID / MD driver - The Software RAID / MD driver
- Limitations when using the MD driver - Limitations when using the MD driver
Overview Overview
@ -66,8 +68,10 @@ Features
partition by creating a large file while in Windows and then loopback partition by creating a large file while in Windows and then loopback
mounting the file while in Linux and creating a Linux filesystem on it that mounting the file while in Linux and creating a Linux filesystem on it that
is used to install Linux on it. is used to install Linux on it.
- A comparison of the two drivers using: - A comparison of the two drivers using::
time find . -type f -exec md5sum "{}" \; time find . -type f -exec md5sum "{}" \;
run three times in sequence with each driver (after a reboot) on a 1.4GiB run three times in sequence with each driver (after a reboot) on a 1.4GiB
NTFS partition, showed the new driver to be 20% faster in total time elapsed NTFS partition, showed the new driver to be 20% faster in total time elapsed
(from 9:43 minutes on average down to 7:53). The time spent in user space (from 9:43 minutes on average down to 7:53). The time spent in user space
@ -104,6 +108,7 @@ In addition to the generic mount options described by the manual page for the
mount command (man 8 mount, also see man 5 fstab), the NTFS driver supports the mount command (man 8 mount, also see man 5 fstab), the NTFS driver supports the
following mount options: following mount options:
======================= =======================================================
iocharset=name Deprecated option. Still supported but please use iocharset=name Deprecated option. Still supported but please use
nls=name in the future. See description for nls=name. nls=name in the future. See description for nls=name.
@ -175,16 +180,22 @@ disable_sparse=<BOOL> If disable_sparse is specified, creation of sparse
errors=opt What to do when critical filesystem errors are found. errors=opt What to do when critical filesystem errors are found.
Following values can be used for "opt": Following values can be used for "opt":
continue: DEFAULT, try to clean-up as much as
======== =========================================
continue DEFAULT, try to clean-up as much as
possible, e.g. marking a corrupt inode as possible, e.g. marking a corrupt inode as
bad so it is no longer accessed, and then bad so it is no longer accessed, and then
continue. continue.
recover: At present only supported is recovery of recover At present only supported is recovery of
the boot sector from the backup copy. the boot sector from the backup copy.
If read-only mount, the recovery is done If read-only mount, the recovery is done
in memory only and not written to disk. in memory only and not written to disk.
Note that the options are additive, i.e. specifying: ======== =========================================
Note that the options are additive, i.e. specifying::
errors=continue,errors=recover errors=continue,errors=recover
means the driver will attempt to recover and if that means the driver will attempt to recover and if that
fails it will clean-up as much as possible and fails it will clean-up as much as possible and
continue. continue.
@ -202,12 +213,18 @@ mft_zone_multiplier= Set the MFT zone multiplier for the volume (this
In general use the default. If you have a lot of small In general use the default. If you have a lot of small
files then use a higher value. The values have the files then use a higher value. The values have the
following meaning: following meaning:
===== =================================
Value MFT zone size (% of volume size) Value MFT zone size (% of volume size)
===== =================================
1 12.5% 1 12.5%
2 25% 2 25%
3 37.5% 3 37.5%
4 50% 4 50%
===== =================================
Note this option is irrelevant for read-only mounts. Note this option is irrelevant for read-only mounts.
======================= =======================================================
Known bugs and (mis-)features Known bugs and (mis-)features
@ -252,18 +269,18 @@ To create the table describing your volume you will need to know each of its
components and their sizes in sectors, i.e. multiples of 512-byte blocks. components and their sizes in sectors, i.e. multiples of 512-byte blocks.
For NT4 fault tolerant volumes you can obtain the sizes using fdisk. So for For NT4 fault tolerant volumes you can obtain the sizes using fdisk. So for
example if one of your partitions is /dev/hda2 you would do: example if one of your partitions is /dev/hda2 you would do::
$ fdisk -ul /dev/hda $ fdisk -ul /dev/hda
Disk /dev/hda: 81.9 GB, 81964302336 bytes Disk /dev/hda: 81.9 GB, 81964302336 bytes
255 heads, 63 sectors/track, 9964 cylinders, total 160086528 sectors 255 heads, 63 sectors/track, 9964 cylinders, total 160086528 sectors
Units = sectors of 1 * 512 = 512 bytes Units = sectors of 1 * 512 = 512 bytes
Device Boot Start End Blocks Id System Device Boot Start End Blocks Id System
/dev/hda1 * 63 4209029 2104483+ 83 Linux /dev/hda1 * 63 4209029 2104483+ 83 Linux
/dev/hda2 4209030 37768814 16779892+ 86 NTFS /dev/hda2 4209030 37768814 16779892+ 86 NTFS
/dev/hda3 37768815 46170809 4200997+ 83 Linux /dev/hda3 37768815 46170809 4200997+ 83 Linux
And you would know that /dev/hda2 has a size of 37768814 - 4209030 + 1 = And you would know that /dev/hda2 has a size of 37768814 - 4209030 + 1 =
33559785 sectors. 33559785 sectors.
@ -271,15 +288,17 @@ And you would know that /dev/hda2 has a size of 37768814 - 4209030 + 1 =
For Win2k and later dynamic disks, you can for example use the ldminfo utility For Win2k and later dynamic disks, you can for example use the ldminfo utility
which is part of the Linux LDM tools (the latest version at the time of which is part of the Linux LDM tools (the latest version at the time of
writing is linux-ldm-0.0.8.tar.bz2). You can download it from: writing is linux-ldm-0.0.8.tar.bz2). You can download it from:
http://www.linux-ntfs.org/ http://www.linux-ntfs.org/
Simply extract the downloaded archive (tar xvjf linux-ldm-0.0.8.tar.bz2), go Simply extract the downloaded archive (tar xvjf linux-ldm-0.0.8.tar.bz2), go
into it (cd linux-ldm-0.0.8) and change to the test directory (cd test). You into it (cd linux-ldm-0.0.8) and change to the test directory (cd test). You
will find the precompiled (i386) ldminfo utility there. NOTE: You will not be will find the precompiled (i386) ldminfo utility there. NOTE: You will not be
able to compile this yourself easily so use the binary version! able to compile this yourself easily so use the binary version!
Then you would use ldminfo in dump mode to obtain the necessary information: Then you would use ldminfo in dump mode to obtain the necessary information::
$ ./ldminfo --dump /dev/hda $ ./ldminfo --dump /dev/hda
This would dump the LDM database found on /dev/hda which describes all of your This would dump the LDM database found on /dev/hda which describes all of your
dynamic disks and all the volumes on them. At the bottom you will see the dynamic disks and all the volumes on them. At the bottom you will see the
@ -305,42 +324,36 @@ give you the correct information to do this.
Assuming you know all your devices and their sizes things are easy. Assuming you know all your devices and their sizes things are easy.
For a linear raid the table would look like this (note all values are in For a linear raid the table would look like this (note all values are in
512-byte sectors): 512-byte sectors)::
--- cut here --- # Offset into Size of this Raid type Device Start sector
# Offset into Size of this Raid type Device Start sector # volume device of device
# volume device of device 0 1028161 linear /dev/hda1 0
0 1028161 linear /dev/hda1 0 1028161 3903762 linear /dev/hdb2 0
1028161 3903762 linear /dev/hdb2 0 4931923 2103211 linear /dev/hdc1 0
4931923 2103211 linear /dev/hdc1 0
--- cut here ---
For a striped volume, i.e. raid level 0, you will need to know the chunk size For a striped volume, i.e. raid level 0, you will need to know the chunk size
you used when creating the volume. Windows uses 64kiB as the default, so it you used when creating the volume. Windows uses 64kiB as the default, so it
will probably be this unless you changes the defaults when creating the array. will probably be this unless you changes the defaults when creating the array.
For a raid level 0 the table would look like this (note all values are in For a raid level 0 the table would look like this (note all values are in
512-byte sectors): 512-byte sectors)::
--- cut here --- # Offset Size Raid Number Chunk 1st Start 2nd Start
# Offset Size Raid Number Chunk 1st Start 2nd Start # into of the type of size Device in Device in
# into of the type of size Device in Device in # volume volume stripes device device
# volume volume stripes device device 0 2056320 striped 2 128 /dev/hda1 0 /dev/hdb1 0
0 2056320 striped 2 128 /dev/hda1 0 /dev/hdb1 0
--- cut here ---
If there are more than two devices, just add each of them to the end of the If there are more than two devices, just add each of them to the end of the
line. line.
Finally, for a mirrored volume, i.e. raid level 1, the table would look like Finally, for a mirrored volume, i.e. raid level 1, the table would look like
this (note all values are in 512-byte sectors): this (note all values are in 512-byte sectors)::
--- cut here --- # Ofs Size Raid Log Number Region Should Number Source Start Target Start
# Ofs Size Raid Log Number Region Should Number Source Start Target Start # in of the type type of log size sync? of Device in Device in
# in of the type type of log size sync? of Device in Device in # vol volume params mirrors Device Device
# vol volume params mirrors Device Device 0 2056320 mirror core 2 16 nosync 2 /dev/hda1 0 /dev/hdb1 0
0 2056320 mirror core 2 16 nosync 2 /dev/hda1 0 /dev/hdb1 0
--- cut here ---
If you are mirroring to multiple devices you can specify further targets at the If you are mirroring to multiple devices you can specify further targets at the
end of the line. end of the line.
@ -353,17 +366,17 @@ to the "Target Device" or if you specified multiple target devices to all of
them. them.
Once you have your table, save it in a file somewhere (e.g. /etc/ntfsvolume1), Once you have your table, save it in a file somewhere (e.g. /etc/ntfsvolume1),
and hand it over to dmsetup to work with, like so: and hand it over to dmsetup to work with, like so::
$ dmsetup create myvolume1 /etc/ntfsvolume1 $ dmsetup create myvolume1 /etc/ntfsvolume1
You can obviously replace "myvolume1" with whatever name you like. You can obviously replace "myvolume1" with whatever name you like.
If it all worked, you will now have the device /dev/device-mapper/myvolume1 If it all worked, you will now have the device /dev/device-mapper/myvolume1
which you can then just use as an argument to the mount command as usual to which you can then just use as an argument to the mount command as usual to
mount the ntfs volume. For example: mount the ntfs volume. For example::
$ mount -t ntfs -o ro /dev/device-mapper/myvolume1 /mnt/myvol1 $ mount -t ntfs -o ro /dev/device-mapper/myvolume1 /mnt/myvol1
(You need to create the directory /mnt/myvol1 first and of course you can use (You need to create the directory /mnt/myvol1 first and of course you can use
anything you like instead of /mnt/myvol1 as long as it is an existing anything you like instead of /mnt/myvol1 as long as it is an existing
@ -395,18 +408,18 @@ Windows by default uses a stripe chunk size of 64k, so you probably want the
"chunk-size 64k" option for each raid-disk, too. "chunk-size 64k" option for each raid-disk, too.
For example, if you have a stripe set consisting of two partitions /dev/hda5 For example, if you have a stripe set consisting of two partitions /dev/hda5
and /dev/hdb1 your /etc/raidtab would look like this: and /dev/hdb1 your /etc/raidtab would look like this::
raiddev /dev/md0 raiddev /dev/md0
raid-level 0 raid-level 0
nr-raid-disks 2 nr-raid-disks 2
nr-spare-disks 0 nr-spare-disks 0
persistent-superblock 0 persistent-superblock 0
chunk-size 64k chunk-size 64k
device /dev/hda5 device /dev/hda5
raid-disk 0 raid-disk 0
device /dev/hdb1 device /dev/hdb1
raid-disk 1 raid-disk 1
For linear raid, just change the raid-level above to "raid-level linear", for For linear raid, just change the raid-level above to "raid-level linear", for
mirrors, change it to "raid-level 1", and for stripe sets with parity, change mirrors, change it to "raid-level 1", and for stripe sets with parity, change
@ -427,7 +440,9 @@ Once the raidtab is setup, run for example raid0run -a to start all devices or
raid0run /dev/md0 to start a particular md device, in this case /dev/md0. raid0run /dev/md0 to start a particular md device, in this case /dev/md0.
Then just use the mount command as usual to mount the ntfs volume using for Then just use the mount command as usual to mount the ntfs volume using for
example: mount -t ntfs -o ro /dev/md0 /mnt/myntfsvolume example::
mount -t ntfs -o ro /dev/md0 /mnt/myntfsvolume
It is advisable to do the mount read-only to see if the md volume has been It is advisable to do the mount read-only to see if the md volume has been
setup correctly to avoid the possibility of causing damage to the data on the setup correctly to avoid the possibility of causing damage to the data on the