Commit d7851dc1 authored by Steve French's avatar Steve French

smb3: minor documentation updates

Update the usage documentation to include some missing
configuration options.  Update the todo list documentation
for cifs.ko
Reviewed-by: default avatarBharath SM <bharathsm@microsoft.com>
Signed-off-by: default avatarSteve French <stfrench@microsoft.com>
parent c3365ced
...@@ -2,7 +2,8 @@ ...@@ -2,7 +2,8 @@
TODO TODO
==== ====
Version 2.14 December 21, 2018 As of 6.7 kernel. See https://wiki.samba.org/index.php/LinuxCIFSKernel
for list of features added by release
A Partial List of Missing Features A Partial List of Missing Features
================================== ==================================
...@@ -12,22 +13,22 @@ for visible, important contributions to this module. Here ...@@ -12,22 +13,22 @@ for visible, important contributions to this module. Here
is a partial list of the known problems and missing features: is a partial list of the known problems and missing features:
a) SMB3 (and SMB3.1.1) missing optional features: a) SMB3 (and SMB3.1.1) missing optional features:
multichannel performance optimizations, algorithmic channel selection,
directory leases optimizations,
support for faster packet signing (GMAC),
support for compression over the network,
T10 copy offload ie "ODX" (copy chunk, and "Duplicate Extents" ioctl
are currently the only two server side copy mechanisms supported)
- multichannel (partially integrated), integration of multichannel with RDMA b) Better optimized compounding and error handling for sparse file support,
- directory leases (improved metadata caching). Currently only implemented for root dir perhaps addition of new optional SMB3.1.1 fsctls to make collapse range
- T10 copy offload ie "ODX" (copy chunk, and "Duplicate Extents" ioctl and insert range more atomic
currently the only two server side copy mechanisms supported)
b) improved sparse file support (fiemap and SEEK_HOLE are implemented c) Support for SMB3.1.1 over QUIC (and perhaps other socket based protocols
but additional features would be supportable by the protocol such like SCTP)
as FALLOC_FL_COLLAPSE_RANGE and FALLOC_FL_INSERT_RANGE)
c) Directory entry caching relies on a 1 second timer, rather than
using Directory Leases, currently only the root file handle is cached longer
by leveraging Directory Leases
d) quota support (needs minor kernel change since quota calls otherwise d) quota support (needs minor kernel change since quota calls otherwise
won't make it to network filesystems or deviceless filesystems). won't make it to network filesystems or deviceless filesystems).
e) Additional use cases can be optimized to use "compounding" (e.g. e) Additional use cases can be optimized to use "compounding" (e.g.
open/query/close and open/setinfo/close) to reduce the number of open/query/close and open/setinfo/close) to reduce the number of
...@@ -92,10 +93,13 @@ t) split cifs and smb3 support into separate modules so legacy (and less ...@@ -92,10 +93,13 @@ t) split cifs and smb3 support into separate modules so legacy (and less
v) Additional testing of POSIX Extensions for SMB3.1.1 v) Additional testing of POSIX Extensions for SMB3.1.1
w) Add support for additional strong encryption types, and additional spnego w) Support for the Mac SMB3.1.1 extensions to improve interop with Apple servers
authentication mechanisms (see MS-SMB2). GCM-256 is now partially implemented.
x) Support for additional authentication options (e.g. IAKERB, peer-to-peer
Kerberos, SCRAM and others supported by existing servers)
x) Finish support for SMB3.1.1 compression y) Improved tracing, more eBPF trace points, better scripts for performance
analysis
Known Bugs Known Bugs
========== ==========
......
...@@ -81,7 +81,7 @@ much older and less secure than the default dialect SMB3 which includes ...@@ -81,7 +81,7 @@ much older and less secure than the default dialect SMB3 which includes
many advanced security features such as downgrade attack detection many advanced security features such as downgrade attack detection
and encrypted shares and stronger signing and authentication algorithms. and encrypted shares and stronger signing and authentication algorithms.
There are additional mount options that may be helpful for SMB3 to get There are additional mount options that may be helpful for SMB3 to get
improved POSIX behavior (NB: can use vers=3.0 to force only SMB3, never 2.1): improved POSIX behavior (NB: can use vers=3 to force SMB3 or later, never 2.1):
``mfsymlinks`` and either ``cifsacl`` or ``modefromsid`` (usually with ``idsfromsid``) ``mfsymlinks`` and either ``cifsacl`` or ``modefromsid`` (usually with ``idsfromsid``)
...@@ -715,6 +715,7 @@ DebugData Displays information about active CIFS sessions and ...@@ -715,6 +715,7 @@ DebugData Displays information about active CIFS sessions and
Stats Lists summary resource usage information as well as per Stats Lists summary resource usage information as well as per
share statistics. share statistics.
open_files List all the open file handles on all active SMB sessions. open_files List all the open file handles on all active SMB sessions.
mount_params List of all mount parameters available for the module
======================= ======================================================= ======================= =======================================================
Configuration pseudo-files: Configuration pseudo-files:
...@@ -864,6 +865,11 @@ i.e.:: ...@@ -864,6 +865,11 @@ i.e.::
echo "value" > /sys/module/cifs/parameters/<param> echo "value" > /sys/module/cifs/parameters/<param>
More detailed descriptions of the available module parameters and their values
can be seen by doing:
modinfo cifs (or modinfo smb3)
================= ========================================================== ================= ==========================================================
1. enable_oplocks Enable or disable oplocks. Oplocks are enabled by default. 1. enable_oplocks Enable or disable oplocks. Oplocks are enabled by default.
[Y/y/1]. To disable use any of [N/n/0]. [Y/y/1]. To disable use any of [N/n/0].
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment