diff options
| -rw-r--r-- | docs/manpages/smb.conf.5 | 27 | ||||
| -rw-r--r-- | docs/textdocs/Speed.txt | 26 |
2 files changed, 53 insertions, 0 deletions
diff --git a/docs/manpages/smb.conf.5 b/docs/manpages/smb.conf.5 index 6761445b89..7a1631bb3d 100644 --- a/docs/manpages/smb.conf.5 +++ b/docs/manpages/smb.conf.5 @@ -472,6 +472,8 @@ dont descend exec +fake oplocks + force group force user @@ -1569,6 +1571,31 @@ of the user. .B Example: only user = True +.SS fake oplocks (S) + +Oplocks are the way that SMB clients get permission from a server to +locally cache file operations. If a server grants an oplock +(opportunistic lock) then the client is free to assume that it is the +only one accessing the file and it will agressively cache file +data. With some oplock types the client may even cache file open/close +operations. This can give enormous performance benefits. + +Samba does not support opportunistic locks because they are very +difficult to do under Unix. Samba can fake them, however, by granting +a oplock whenever a client asks for one. This is controlled using the +smb.conf option "fake oplocks". If you set "fake oplocks = yes" then +you are telling the client that it may agressively cache the file +data. + +By enabling this option on all read-only shares or shares that you know +will only be accessed from one client at a time you will see a big +performance improvement on many operations. If you enable this option +on shares where multiple clients may be accessing the files read-write +at the same time you can get data corruption. Use this option +carefully! + +This option is disabled by default. + .SS message command (G) This specifies what command to run when the server receives a WinPopup diff --git a/docs/textdocs/Speed.txt b/docs/textdocs/Speed.txt index 28bceb658f..b62e408922 100644 --- a/docs/textdocs/Speed.txt +++ b/docs/textdocs/Speed.txt @@ -30,6 +30,32 @@ hardware Samba should certainly be competitive in speed with other systems. +OPLOCKS +------- + +Oplocks are the way that SMB clients get permission from a server to +locally cache file operations. If a server grants an oplock +(opportunistic lock) then the client is free to assume that it is the +only one accessing the file and it will agressively cache file +data. With some oplock types the client may even cache file open/close +operations. This can give enormous performance benefits. + +Samba does not support opportunistic locks because they are very +difficult to do under Unix. Samba can fake them, however, by granting +a oplock whenever a client asks for one. This is controlled using the +smb.conf option "fake oplocks". If you set "fake oplocks = yes" then +you are telling the client that it may agressively cache the file +data. + +By enabling this option on all read-only shares or shares that you know +will only be accessed from one client at a time you will see a big +performance improvement on many operations. If you enable this option +on shares where multiple clients may be accessing the files read-write +at the same time you can get data corruption. Use this option +carefully! + +This option is disabled by default. + SOCKET OPTIONS -------------- |