Updated documentation to remove references to HPNBufferSize

and TcpRcvBuf. Neither option are supported any more.

Author: rapier1

HPN-README

@@ -51,28 +51,23 @@ metrics from multiplexed sessions will report on the activity of all sessions on
 This will likely result in less clear results and, as such, we suggest only gathering metrics
 from non-multiplexed session.
 
-SCP with Resume functionality
-This feature allows SCP to resume failed transfers. In the event of a failed transfer
+HPNSCP with Resume functionality
+This feature allows hpnscp to resume failed transfers. In the event of a failed transfer
 issues the same scp command with the '-R' option. For example - if you issued:
-'scp myhugefile me@host:~'
+'hpnscp myhugefile me@host:~'
 and it dies halfway through the transfer issuing
-'scp -Z myhugefile me@host:~'
+'hpnscp -Z myhugefile me@host:~'
 will resume the transfer at the point where it left off.
 
 This is implemented by having the source host send a hash (blake2b512) of the file to the
-target host. Teh target host then computes it's own hash of the target file. If the hashes match
+target host. The target host then computes it's own hash of the target file. If the hashes match
 then the file is skipped as this indicates a successful transfer. However, if the hashes do not
 match then the target sends the source its hash along with the size of the file. The source then
 computes the hash of the file *up to* the size of the target file. If those hashes match then
 the source only send the necessary bytes to complete the transfer. If the hashes do not match then
 the entire file is resent. If the target file is larger then the source file then the entire
 source file is sent and any existing target file is overwritten.
 
-SCP however, will use the first scp in the user's path. This might not support the resume
-function and the attempt will fail. In those cases the user can explicitly define the path to the
-resume enabled scp with the '-z' option. For example:
-
-'scp -Z -z /opt/hpnssh/usr/bin/scp myhugefile me@host:~'
 
 MULTI-THREADED AES CIPHER:
 The AES cipher in CTR mode has been multithreaded (MTR-AES-CTR). This will allow ssh installations
@@ -124,63 +119,8 @@ more than 30%.
 
 ex: scp -oNoneSwitch=yes -oNoneEnabled=yes -oNoneMacEnabled=yes file host:~
 
-BUFFER SIZES:
-
-If HPN is disabled the receive buffer size will be set to the
-OpenSSH default of 2MB (for OpenSSH versions before 4.7: 64KB).
-
-If an HPN system connects to a nonHPN system the receive buffer will
-be set to the HPNBufferSize value. The default is 2MB but user adjustable.
-
-If an HPN to HPN connection is established a number of different things might
-happen based on the user options and conditions.
-
-Conditions: HPNBufferSize NOT Set, TCPRcvBufPoll enabled, TCPRcvBuf NOT Set
-HPN Buffer Size = up to 64MB
-This is the default state. The HPN buffer size will grow to a maximum of 64MB
-as the TCP receive buffer grows. The maximum HPN Buffer size of 64MB is
-geared towards 10GigE transcontinental connections.
-
-Conditions: HPNBufferSize NOT Set, TCPRcvBufPoll disabled, TCPRcvBuf NOT Set
-HPN Buffer Size = TCP receive buffer value.
-Users on non-autotuning systems should disable TCPRcvBufPoll in the
-ssh_config and sshd_config
-
-Conditions: HPNBufferSize SET, TCPRcvBufPoll disabled, TCPRcvBuf NOT Set
-HPN Buffer Size = minimum of TCP receive buffer and HPNBufferSize.
-This would be the system defined TCP receive buffer (RWIN).
-
-Conditions: HPNBufferSize SET, TCPRcvBufPoll disabled, TCPRcvBuf SET
-HPN Buffer Size = minimum of TCPRcvBuf and HPNBufferSize.
-Generally there is no need to set both.
-
-Conditions: HPNBufferSize SET, TCPRcvBufPoll enabled, TCPRcvBuf NOT Set
-HPN Buffer Size = grows to HPNBufferSize
-The buffer will grow up to the maximum size specified here.
-
-Conditions: HPNBufferSize SET, TCPRcvBufPoll enabled, TCPRcvBuf SET
-HPN Buffer Size = minimum of TCPRcvBuf and HPNBufferSize.
-Generally there is no need to set both of these, especially on autotuning
-systems. However, if the users wishes to override the autotuning this would be
-one way to do it.
-
-Conditions: HPNBufferSize NOT Set, TCPRcvBufPoll enabled, TCPRcvBuf SET
-HPN Buffer Size = TCPRcvBuf.
-This will override autotuning and set the TCP recieve buffer to the user defined
-value.
-
-
 HPN Specific Configuration options
 
-TcpRcvBuf=[int]KB client
-      Set the TCP socket receive buffer to n Kilobytes. It can be set up to the
-maximum socket size allowed by the system. This is useful in situations where
-the tcp receive window is set low but the maximum buffer size is set
-higher (as is typical). This works on a per TCP connection basis. You can also
-use this to artifically limit the transfer rate of the connection. In these
-cases the throughput will be no more than n/RTT. The minimum buffer size is 1KB.
-Default is the current system wide tcp receive buffer size.
-
 TcpRcvBufPoll=[yes/no] client/server
       Enable of disable the polling of the tcp receive buffer through the life
 of the connection. You would want to make sure that this option is enabled
@@ -214,21 +154,6 @@ HPNDisabled=[yes/no] client/server
 of the HPN code produces a net decrease in performance. In these cases it is
 helpful to disable the HPN functionality. By default HPNDisabled is set to no.
 
-HPNBufferSize=[int]KB client/server
-     This is the default buffer size the HPN functionality uses when interacting
-with nonHPN SSH installations. Conceptually this is similar to the TcpRcvBuf
-option as applied to the internal SSH flow control. This value can range from
-1KB to 64MB (1-65536). Use of oversized or undersized buffers can cause performance
-problems depending on the length of the network path. The default size of this buffer
-is 2MB.
-
-DisableMTAES=[yes/no] client/server
-     Switch the encryption cipher being used from the multithreaded MT-AES-CTR cipher
-back to the stock single-threaded AES-CTR cipher. Useful on modern processors with
-AES-NI instructions which make the stock single-threaded AES-CTR cipher faster than
-the multithreaded MT-AES-CTR cipher. Set to no by default.
-
-
 Credits: This patch was conceived, designed, and led by Chris Rapier ([email protected])
          The majority of the actual coding for versions up to HPN12v1 was performed
          by Michael Stevens ([email protected]). The MT-AES-CTR cipher was
@@ -240,3 +165,6 @@ Credits: This patch was conceived, designed, and led by Chris Rapier (rapier@psc
 
 Sponsors: Thanks to Niklas Hambuchen for being the first sponsor of HPN-SSH
 	  via github's sponsor program!
+
+
+Edited: October 11, 2023

hpnssh.1

@@ -549,7 +549,6 @@ For full details of the options listed below, and their possible values, see
 .It Hostname
 .It HPNDisabled*
 .It HPNBufferLimit*
-.It HPNBufferSize*
 .It IdentitiesOnly
 .It IdentityAgent
 .It IdentityFile
@@ -597,7 +596,6 @@ For full details of the options listed below, and their possible values, see
 .It StreamLocalBindUnlink
 .It StrictHostKeyChecking
 .It TCPKeepAlive
-.It TcpRcvBuf*
 .It TcpRcvBufPoll*
 .It Tunnel
 .It TunnelDevice

hpnssh_config.5

@@ -1015,14 +1015,6 @@ a more stable connection. The option only impacts the receiving side of the conn
 For example, a client receiving data from a server but not a client sending data.
 By default this option is set to 
 .Cm no. HPNSSH only.
-.It Cm HPNBufferSize
-This is the default buffer size, in kilobytes, the HPN functionality uses when interacting
-with nonHPN SSH installations. Conceptually this is similar to the TcpRcvBuf
-option as applied to the internal SSH flow control. This value can range from
-1KB to 64MB (1-65536). Use of oversized or undersized buffers can cause performance
-problems depending on the length of the network path. The default size of this buffer
-is 2MB. 
-.Cm HPNSSH only.
 .It Cm IdentitiesOnly
 Specifies that
 .Xr ssh 1
@@ -2046,15 +2038,6 @@ for protocol-level keepalives.
 Specify a configuration tag name that may be later used by a
 .Cm Match
 directive to select a block of configuration.
-.It Cm TcpRcvBuf
-Set the TCP socket receive buffer to n Kilobytes. It can be set up to the
-maximum socket size allowed by the system. This is useful in situations where
-the tcp receive window is set low but the maximum buffer size is set
-higher (as is typical). This works on a per TCP connection basis. You can also
-use this to artifically limit the transfer rate of the connection. In these
-cases the throughput will be no more than n/RTT. The minimum buffer size is 1KB.
-Default is the current system wide tcp receive buffer size. 
-.Cm HPNSSH only.
 .It Cm TcpRcvBufPoll
 Enable of disable the polling of the tcp receive buffer through the life
 of the connection. You would want to make sure that this option is enabled

hpnsshd_config.5

@@ -892,13 +892,6 @@ For example, a client receiving data from a server but not a client sending data
 enabled on a server this will impact all incoming connections. 
 By default this option is set to 
 .Cm no. HPNSSH only.
-.It Cm HPNBufferSize
-This is the default buffer size, in kilobytes, that HPN functionality uses when interacting
-with nonHPN SSH installations. Conceptually this is similar to the TcpRcvBuf
-option as applied to the internal SSH flow control. This value can range from
-1KB to 64MB (1-65536). Use of oversized or undersized buffers can cause performance
-problems depending on the length of the network path. The default size of this buffer
-is 2MB.
 .It Cm IgnoreRhosts
 Specifies whether to ignore per-user
 .Pa .rhosts
@@ -1861,14 +1854,6 @@ This avoids infinitely hanging sessions.
 .Pp
 To disable TCP keepalive messages, the value should be set to
 .Cm no .
-.It Cm TcpRcvBuf
-Set the TCP socket receive buffer to n Kilobytes. It can be set up to the
-maximum socket size allowed by the system. This is useful in situations where
-the tcp receive window is set low but the maximum buffer size is set
-higher (as is typical). This works on a per TCP connection basis. You can also
-use this to artifically limit the transfer rate of the connection. In these
-cases the throughput will be no more than n/RTT KB/s. The minimum buffer size is 1KB.
-Default is the current system wide tcp receive buffer size.
 .IT Cm TcpRcvBufPoll
 Enable of disable the polling of the tcp receive buffer throughout the life
 of the connection. Make sure that this option is enabled for systems making 

sshd_config

@@ -115,9 +115,6 @@ Subsystem	sftp	/usr/libexec/hpnsftp-server
 # disable hpn performance boosts
 #HPNDisabled no
 
-# buffer size for hpn to non-hpn connections
-#HPNBufferSize 2048
-
 # allow the use of the none cipher
 #NoneEnabled no