Commit d7851dc1 authored by Steve French's avatar Steve French
Browse files

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

Documentation/admin-guide/cifs/todo.rst

+20 −16
Original line number Diff line number Diff line
@@ -2,7 +2,8 @@ 
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

==================================
@@ -12,19 +13,19 @@ for visible, important contributions to this module. Here 
is a partial list of the known problems and missing 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

   - directory leases (improved metadata caching). Currently only implemented for root dir

   - T10 copy offload ie "ODX" (copy chunk, and "Duplicate Extents" ioctl

     currently the only two server side copy mechanisms supported)

b) Better optimized compounding and error handling for sparse file support,

   perhaps addition of new optional SMB3.1.1 fsctls to make collapse range

   and insert range more atomic



b) improved sparse file support (fiemap and SEEK_HOLE are implemented

   but additional features would be supportable by the protocol such

   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

c) Support for SMB3.1.1 over QUIC (and perhaps other socket based protocols

   like SCTP)



d) quota support (needs minor kernel change since quota calls otherwise

   won't make it to network filesystems or deviceless filesystems).
@@ -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



w) Add support for additional strong encryption types, and additional spnego

   authentication mechanisms (see MS-SMB2).  GCM-256 is now partially implemented.

w) Support for the Mac SMB3.1.1 extensions to improve interop with Apple servers



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

==========

Documentation/admin-guide/cifs/usage.rst

+7 −1
Original line number Diff line number Diff line
@@ -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

and encrypted shares and stronger signing and authentication algorithms.

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``)
@@ -715,6 +715,7 @@ DebugData Displays information about active CIFS sessions and 
Stats			Lists summary resource usage information as well as per

			share statistics.

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:
@@ -864,6 +865,11 @@ i.e.:: 


    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.

		  [Y/y/1]. To disable use any of [N/n/0].