Skip to content

Commit d7851dc

Browse files
committed
smb3: minor documentation updates
Update the usage documentation to include some missing configuration options. Update the todo list documentation for cifs.ko Reviewed-by: Bharath SM <[email protected]> Signed-off-by: Steve French <[email protected]>
1 parent c3365ce commit d7851dc

File tree

2 files changed

+27
-17
lines changed

2 files changed

+27
-17
lines changed

Documentation/admin-guide/cifs/todo.rst

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
TODO
33
====
44

5-
Version 2.14 December 21, 2018
5+
As of 6.7 kernel. See https://wiki.samba.org/index.php/LinuxCIFSKernel
6+
for list of features added by release
67

78
A Partial List of Missing Features
89
==================================
@@ -12,22 +13,22 @@ for visible, important contributions to this module. Here
1213
is a partial list of the known problems and missing features:
1314

1415
a) SMB3 (and SMB3.1.1) missing optional features:
16+
multichannel performance optimizations, algorithmic channel selection,
17+
directory leases optimizations,
18+
support for faster packet signing (GMAC),
19+
support for compression over the network,
20+
T10 copy offload ie "ODX" (copy chunk, and "Duplicate Extents" ioctl
21+
are currently the only two server side copy mechanisms supported)
1522

16-
- multichannel (partially integrated), integration of multichannel with RDMA
17-
- directory leases (improved metadata caching). Currently only implemented for root dir
18-
- T10 copy offload ie "ODX" (copy chunk, and "Duplicate Extents" ioctl
19-
currently the only two server side copy mechanisms supported)
23+
b) Better optimized compounding and error handling for sparse file support,
24+
perhaps addition of new optional SMB3.1.1 fsctls to make collapse range
25+
and insert range more atomic
2026

21-
b) improved sparse file support (fiemap and SEEK_HOLE are implemented
22-
but additional features would be supportable by the protocol such
23-
as FALLOC_FL_COLLAPSE_RANGE and FALLOC_FL_INSERT_RANGE)
24-
25-
c) Directory entry caching relies on a 1 second timer, rather than
26-
using Directory Leases, currently only the root file handle is cached longer
27-
by leveraging Directory Leases
27+
c) Support for SMB3.1.1 over QUIC (and perhaps other socket based protocols
28+
like SCTP)
2829

2930
d) quota support (needs minor kernel change since quota calls otherwise
30-
won't make it to network filesystems or deviceless filesystems).
31+
won't make it to network filesystems or deviceless filesystems).
3132

3233
e) Additional use cases can be optimized to use "compounding" (e.g.
3334
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
9293

9394
v) Additional testing of POSIX Extensions for SMB3.1.1
9495

95-
w) Add support for additional strong encryption types, and additional spnego
96-
authentication mechanisms (see MS-SMB2). GCM-256 is now partially implemented.
96+
w) Support for the Mac SMB3.1.1 extensions to improve interop with Apple servers
97+
98+
x) Support for additional authentication options (e.g. IAKERB, peer-to-peer
99+
Kerberos, SCRAM and others supported by existing servers)
97100

98-
x) Finish support for SMB3.1.1 compression
101+
y) Improved tracing, more eBPF trace points, better scripts for performance
102+
analysis
99103

100104
Known Bugs
101105
==========

Documentation/admin-guide/cifs/usage.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ much older and less secure than the default dialect SMB3 which includes
8181
many advanced security features such as downgrade attack detection
8282
and encrypted shares and stronger signing and authentication algorithms.
8383
There are additional mount options that may be helpful for SMB3 to get
84-
improved POSIX behavior (NB: can use vers=3.0 to force only SMB3, never 2.1):
84+
improved POSIX behavior (NB: can use vers=3 to force SMB3 or later, never 2.1):
8585

8686
``mfsymlinks`` and either ``cifsacl`` or ``modefromsid`` (usually with ``idsfromsid``)
8787

@@ -715,6 +715,7 @@ DebugData Displays information about active CIFS sessions and
715715
Stats Lists summary resource usage information as well as per
716716
share statistics.
717717
open_files List all the open file handles on all active SMB sessions.
718+
mount_params List of all mount parameters available for the module
718719
======================= =======================================================
719720

720721
Configuration pseudo-files:
@@ -864,6 +865,11 @@ i.e.::
864865

865866
echo "value" > /sys/module/cifs/parameters/<param>
866867

868+
More detailed descriptions of the available module parameters and their values
869+
can be seen by doing:
870+
871+
modinfo cifs (or modinfo smb3)
872+
867873
================= ==========================================================
868874
1. enable_oplocks Enable or disable oplocks. Oplocks are enabled by default.
869875
[Y/y/1]. To disable use any of [N/n/0].

0 commit comments

Comments
 (0)