Skip to content

L
linux
Commit 06df6572 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller
Browse files
Options

docs: networking: convert eql.txt to ReST 

- add SPDX header;
- add a document title;
- adjust titles and chapters, adding proper markups;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 28d23311
Show whitespace changes
Inline Side-by-side
Showing with 146 additions and 300 deletions
Documentation/networking/eql.txt → Documentation/networking/eql.rst
View file @ 06df6572
EQL Driver: Serial IP Load Balancing HOWTO .. SPDX-License-Identifier: GPL-2.0
==========================================
EQL Driver: Serial IP Load Balancing HOWTO
==========================================
Simon "Guru Aleph-Null" Janes, simon@ncm.com Simon "Guru Aleph-Null" Janes, simon@ncm.com
v1.1, February 27, 1995 v1.1, February 27, 1995
This is the manual for the EQL device driver. EQL is a software device This is the manual for the EQL device driver. EQL is a software device
...@@ -12,7 +18,8 @@ ...@@ -12,7 +18,8 @@
which was only created to patch cleanly in the very latest kernel which was only created to patch cleanly in the very latest kernel
source trees. (Yes, it worked fine.) source trees. (Yes, it worked fine.)
1. Introduction 1. Introduction
===============
Which is worse? A huge fee for a 56K leased line or two phone lines? Which is worse? A huge fee for a 56K leased line or two phone lines?
It's probably the former. If you find yourself craving more bandwidth, It's probably the former. If you find yourself craving more bandwidth,
...@@ -41,47 +48,40 @@ ...@@ -41,47 +48,40 @@
Hey, we can all dream you know... Hey, we can all dream you know...
2. Kernel Configuration 2. Kernel Configuration
=======================
Here I describe the general steps of getting a kernel up and working Here I describe the general steps of getting a kernel up and working
with the eql driver. From patching, building, to installing. with the eql driver. From patching, building, to installing.
2.1. Patching The Kernel 2.1. Patching The Kernel
------------------------
If you do not have or cannot get a copy of the kernel with the eql If you do not have or cannot get a copy of the kernel with the eql
driver folded into it, get your copy of the driver from driver folded into it, get your copy of the driver from
ftp://slaughter.ncm.com/pub/Linux/LOAD_BALANCING/eql-1.1.tar.gz. ftp://slaughter.ncm.com/pub/Linux/LOAD_BALANCING/eql-1.1.tar.gz.
Unpack this archive someplace obvious like /usr/local/src/. It will Unpack this archive someplace obvious like /usr/local/src/. It will
create the following files: create the following files::
______________________________________________________________________
-rw-r--r-- guru/ncm 198 Jan 19 18:53 1995 eql-1.1/NO-WARRANTY -rw-r--r-- guru/ncm 198 Jan 19 18:53 1995 eql-1.1/NO-WARRANTY
-rw-r--r-- guru/ncm 30620 Feb 27 21:40 1995 eql-1.1/eql-1.1.patch -rw-r--r-- guru/ncm 30620 Feb 27 21:40 1995 eql-1.1/eql-1.1.patch
-rwxr-xr-x guru/ncm 16111 Jan 12 22:29 1995 eql-1.1/eql_enslave -rwxr-xr-x guru/ncm 16111 Jan 12 22:29 1995 eql-1.1/eql_enslave
-rw-r--r-- guru/ncm 2195 Jan 10 21:48 1995 eql-1.1/eql_enslave.c -rw-r--r-- guru/ncm 2195 Jan 10 21:48 1995 eql-1.1/eql_enslave.c
______________________________________________________________________
Unpack a recent kernel (something after 1.1.92) someplace convenient Unpack a recent kernel (something after 1.1.92) someplace convenient
like say /usr/src/linux-1.1.92.eql. Use symbolic links to point like say /usr/src/linux-1.1.92.eql. Use symbolic links to point
/usr/src/linux to this development directory. /usr/src/linux to this development directory.
Apply the patch by running the commands: Apply the patch by running the commands::
______________________________________________________________________
cd /usr/src cd /usr/src
patch </usr/local/src/eql-1.1/eql-1.1.patch patch </usr/local/src/eql-1.1/eql-1.1.patch
______________________________________________________________________
2.2. Building The Kernel
------------------------
2.2. Building The Kernel
After patching the kernel, run make config and configure the kernel After patching the kernel, run make config and configure the kernel
for your hardware. for your hardware.
...@@ -90,7 +90,8 @@ ...@@ -90,7 +90,8 @@
After configuration, make and install according to your habit. After configuration, make and install according to your habit.
3. Network Configuration 3. Network Configuration
========================
So far, I have only used the eql device with the DSLIP SLIP connection So far, I have only used the eql device with the DSLIP SLIP connection
manager by Matt Dillon (-- "The man who sold his soul to code so much manager by Matt Dillon (-- "The man who sold his soul to code so much
...@@ -100,37 +101,27 @@ ...@@ -100,37 +101,27 @@
connection. connection.
3.1. /etc/rc.d/rc.inet1 3.1. /etc/rc.d/rc.inet1
-----------------------
In rc.inet1, ifconfig the eql device to the IP address you usually use In rc.inet1, ifconfig the eql device to the IP address you usually use
for your machine, and the MTU you prefer for your SLIP lines. One for your machine, and the MTU you prefer for your SLIP lines. One
could argue that MTU should be roughly half the usual size for two could argue that MTU should be roughly half the usual size for two
modems, one-third for three, one-fourth for four, etc... But going modems, one-third for three, one-fourth for four, etc... But going
too far below 296 is probably overkill. Here is an example ifconfig too far below 296 is probably overkill. Here is an example ifconfig
command that sets up the eql device: command that sets up the eql device::
______________________________________________________________________
ifconfig eql 198.67.33.239 mtu 1006 ifconfig eql 198.67.33.239 mtu 1006
______________________________________________________________________
Once the eql device is up and running, add a static default route to Once the eql device is up and running, add a static default route to
it in the routing table using the cool new route syntax that makes it in the routing table using the cool new route syntax that makes
life so much easier: life so much easier::
______________________________________________________________________
route add default eql route add default eql
______________________________________________________________________
3.2. Enslaving Devices By Hand 3.2. Enslaving Devices By Hand
------------------------------
Enslaving devices by hand requires two utility programs: eql_enslave Enslaving devices by hand requires two utility programs: eql_enslave
and eql_emancipate (-- eql_emancipate hasn't been written because when and eql_emancipate (-- eql_emancipate hasn't been written because when
...@@ -140,63 +131,35 @@ ...@@ -140,63 +131,35 @@
The syntax for enslaving a device is "eql_enslave <master-name> The syntax for enslaving a device is "eql_enslave <master-name>
<slave-name> <estimated-bps>". Here are some example enslavings: <slave-name> <estimated-bps>". Here are some example enslavings::
______________________________________________________________________
eql_enslave eql sl0 28800 eql_enslave eql sl0 28800
eql_enslave eql ppp0 14400 eql_enslave eql ppp0 14400
eql_enslave eql sl1 57600 eql_enslave eql sl1 57600
______________________________________________________________________
When you want to free a device from its life of slavery, you can When you want to free a device from its life of slavery, you can
either down the device with ifconfig (eql will automatically bury the either down the device with ifconfig (eql will automatically bury the
dead slave and remove it from its queue) or use eql_emancipate to free dead slave and remove it from its queue) or use eql_emancipate to free
it. (-- Or just ifconfig it down, and the eql driver will take it out it. (-- Or just ifconfig it down, and the eql driver will take it out
for you.--) for you.--)::
______________________________________________________________________
eql_emancipate eql sl0 eql_emancipate eql sl0
eql_emancipate eql ppp0 eql_emancipate eql ppp0
eql_emancipate eql sl1 eql_emancipate eql sl1
______________________________________________________________________
3.3. DSLIP Configuration for the eql Device 3.3. DSLIP Configuration for the eql Device
-------------------------------------------
The general idea is to bring up and keep up as many SLIP connections The general idea is to bring up and keep up as many SLIP connections
as you need, automatically. as you need, automatically.
3.3.1. /etc/slip/runslip.conf 3.3.1. /etc/slip/runslip.conf
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Here is an example runslip.conf:
Here is an example runslip.conf::
______________________________________________________________________
name sl-line-1 name sl-line-1
enabled enabled
baud 38400 baud 38400
...@@ -214,13 +177,10 @@ ...@@ -214,13 +177,10 @@
command eql_enslave eql $interface 28800 command eql_enslave eql $interface 28800
address 198.67.33.239 address 198.67.33.239
line /dev/cua3 line /dev/cua3
______________________________________________________________________
3.4. Using PPP and the eql Device
---------------------------------
3.4. Using PPP and the eql Device
I have not yet done any load-balancing testing for PPP devices, mainly I have not yet done any load-balancing testing for PPP devices, mainly
because I don't have a PPP-connection manager like SLIP has with because I don't have a PPP-connection manager like SLIP has with
...@@ -235,7 +195,8 @@ ...@@ -235,7 +195,8 @@
year. year.
4. About the Slave Scheduler Algorithm 4. About the Slave Scheduler Algorithm
======================================
The slave scheduler probably could be replaced with a dozen other The slave scheduler probably could be replaced with a dozen other
things and push traffic much faster. The formula in the current set things and push traffic much faster. The formula in the current set
...@@ -254,7 +215,8 @@ ...@@ -254,7 +215,8 @@
traffic and the "slower" modem starved. traffic and the "slower" modem starved.
5. Testers' Reports 5. Testers' Reports
===================
Some people have experimented with the eql device with newer Some people have experimented with the eql device with newer
kernels (than 1.1.75). I have since updated the driver to patch kernels (than 1.1.75). I have since updated the driver to patch
...@@ -262,71 +224,13 @@ ...@@ -262,71 +224,13 @@
balancing" driver config option. balancing" driver config option.
o icee from LinuxNET patched 1.1.86 without any rejects and was able - icee from LinuxNET patched 1.1.86 without any rejects and was able
to boot the kernel and enslave a couple of ISDN PPP links. to boot the kernel and enslave a couple of ISDN PPP links.
5.1. Randolph Bentson's Test Report 5.1. Randolph Bentson's Test Report
-----------------------------------
::
From bentson@grieg.seaslug.org Wed Feb 8 19:08:09 1995 From bentson@grieg.seaslug.org Wed Feb 8 19:08:09 1995
Date: Tue, 7 Feb 95 22:57 PST Date: Tue, 7 Feb 95 22:57 PST
...@@ -342,7 +246,7 @@ ...@@ -342,7 +246,7 @@
Randolph Bentson Randolph Bentson
bentson@grieg.seaslug.org bentson@grieg.seaslug.org
--------------------------------------------------------- ------------------------------------------------------------------
A pseudo-device driver, EQL, written by Simon Janes, can be used A pseudo-device driver, EQL, written by Simon Janes, can be used
...@@ -363,7 +267,7 @@ ...@@ -363,7 +267,7 @@
Once a link was established, I timed a binary ftp transfer of Once a link was established, I timed a binary ftp transfer of
289284 bytes of data. If there were no overhead (packet headers, 289284 bytes of data. If there were no overhead (packet headers,
inter-character and inter-packet delays, etc.) the transfers inter-character and inter-packet delays, etc.) the transfers
would take the following times: would take the following times::
bits/sec seconds bits/sec seconds
345600 8.3 345600 8.3
...@@ -388,8 +292,10 @@ ...@@ -388,8 +292,10 @@
that the connection establishment seemed fragile for the higher that the connection establishment seemed fragile for the higher
speeds. Once established, the connection seemed robust enough.) speeds. Once established, the connection seemed robust enough.)
====== ======== === ======== ======= ======= ===
#lines speed mtu seconds theory actual %of #lines speed mtu seconds theory actual %of
kbit/sec duration speed speed max kbit/sec duration speed speed max
====== ======== === ======== ======= ======= ===
3 115200 900 _ 345600 3 115200 900 _ 345600
3 115200 400 18.1 345600 159825 46 3 115200 400 18.1 345600 159825 46
2 115200 900 _ 230400 2 115200 900 _ 230400
...@@ -447,18 +353,12 @@ ...@@ -447,18 +353,12 @@
1 9600 900 305 9600 9484.72 98 1 9600 900 305 9600 9484.72 98
1 9600 600 314 9600 9212.87 95 1 9600 600 314 9600 9212.87 95
1 9600 400 332 9600 8713.37 90 1 9600 400 332 9600 8713.37 90
====== ======== === ======== ======= ======= ===
5.2. Anthony Healy's Report
---------------------------
::
5.2. Anthony Healy's Report
Date: Mon, 13 Feb 1995 16:17:29 +1100 (EST) Date: Mon, 13 Feb 1995 16:17:29 +1100 (EST)
From: Antony Healey <ahealey@st.nepean.uws.edu.au> From: Antony Healey <ahealey@st.nepean.uws.edu.au>
...@@ -471,58 +371,3 @@ ...@@ -471,58 +371,3 @@
able to data at over 48Kb/s [ISDN link -Simon]. I managed a able to data at over 48Kb/s [ISDN link -Simon]. I managed a
transfer of up to 7.5 Kbyte/s on one go, but averaged around transfer of up to 7.5 Kbyte/s on one go, but averaged around
6.4 Kbyte/s, which I think is pretty cool. :) 6.4 Kbyte/s, which I think is pretty cool. :)
Documentation/networking/index.rst
View file @ 06df6572
...@@ -54,6 +54,7 @@ Contents: ...@@ -54,6 +54,7 @@ Contents:
defza defza
dns_resolver dns_resolver
driver driver
eql
.. only:: subproject and html .. only:: subproject and html
......
drivers/net/Kconfig
View file @ 06df6572
...@@ -126,7 +126,7 @@ config EQUALIZER ...@@ -126,7 +126,7 @@ config EQUALIZER
Linux driver or with a Livingston Portmaster 2e. Linux driver or with a Livingston Portmaster 2e.
Say Y if you want this and read Say Y if you want this and read
<file:Documentation/networking/eql.txt>. You may also want to read <file:Documentation/networking/eql.rst>. You may also want to read
section 6.2 of the NET-3-HOWTO, available from section 6.2 of the NET-3-HOWTO, available from
<http://www.tldp.org/docs.html#howto>. <http://www.tldp.org/docs.html#howto>.
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7