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

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

Documentation/networking/eql.txt→Documentation/networking/eql.rst

+144 −299
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



==========================================

EQL Driver: Serial IP Load Balancing HOWTO

==========================================



  Simon "Guru Aleph-Null" Janes, simon@ncm.com



  v1.1, February 27, 1995



  This is the manual for the EQL device driver. EQL is a software device
@@ -13,6 +19,7 @@ 
  source trees. (Yes, it worked fine.)



1. Introduction

===============



  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,
@@ -42,46 +49,39 @@ 




2. Kernel Configuration

=======================



  Here I describe the general steps of getting a kernel up and working

  with the eql driver.	From patching, building, to installing.





2.1. Patching The Kernel

------------------------



  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

  ftp://slaughter.ncm.com/pub/Linux/LOAD_BALANCING/eql-1.1.tar.gz.

  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	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

       -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

  like say /usr/src/linux-1.1.92.eql. Use symbolic links to point

  /usr/src/linux to this development directory.





  Apply the patch by running the commands:



  Apply the patch by running the commands::



       ______________________________________________________________________

       cd /usr/src

       patch </usr/local/src/eql-1.1/eql-1.1.patch

       ______________________________________________________________________











2.2. Building The Kernel

------------------------



  After patching the kernel, run make config and configure the kernel

  for your hardware.
@@ -91,6 +91,7 @@ 




3. Network Configuration

========================



  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
@@ -101,36 +102,26 @@ 




3.1. /etc/rc.d/rc.inet1

-----------------------



  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

  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

  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

       ______________________________________________________________________











  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

  life so much easier:





  life so much easier::



       ______________________________________________________________________

       route add default eql

       ______________________________________________________________________





3.2. Enslaving Devices By Hand

------------------------------



  Enslaving devices by hand requires two utility programs: eql_enslave

  and eql_emancipate (-- eql_emancipate hasn't been written because when
@@ -140,63 +131,35 @@ 




  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 ppp0 14400

       eql_enslave eql sl1 57600

       ______________________________________________________________________











  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

  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

  for you.--)





  for you.--)::



       ______________________________________________________________________

       eql_emancipate eql sl0

       eql_emancipate eql ppp0

       eql_emancipate eql sl1

       ______________________________________________________________________











3.3. DSLIP Configuration for the eql Device

-------------------------------------------



  The general idea is to bring up and keep up as many SLIP connections

  as you need, automatically.





3.3.1.  /etc/slip/runslip.conf

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



  Here is an example runslip.conf:











  Here is an example runslip.conf::





















  ______________________________________________________________________

	  name		sl-line-1

	  enabled

	  baud		38400
@@ -214,13 +177,10 @@ 
	  command	 eql_enslave eql $interface 28800

	  address	 198.67.33.239

	  line		/dev/cua3

  ______________________________________________________________________











3.4. Using PPP and the eql Device

---------------------------------



  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
@@ -236,6 +196,7 @@ 




4. About the Slave Scheduler Algorithm

======================================



  The slave scheduler probably could be replaced with a dozen other

  things and push traffic much faster.	The formula in the current set
@@ -255,6 +216,7 @@ 




5. Testers' Reports

===================



  Some people have experimented with the eql device with newer

  kernels (than 1.1.75).  I have since updated the driver to patch
@@ -262,71 +224,13 @@ 
  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.



5.1. Randolph Bentson's Test Report

-----------------------------------



























































































































  ::



    From bentson@grieg.seaslug.org Wed Feb  8 19:08:09 1995

    Date: Tue, 7 Feb 95 22:57 PST
@@ -342,7 +246,7 @@ 
    Randolph Bentson

    bentson@grieg.seaslug.org



  ---------------------------------------------------------

------------------------------------------------------------------





  A pseudo-device driver, EQL, written by Simon Janes, can be used
@@ -363,7 +267,7 @@ 
  Once a link was established, I timed a binary ftp transfer of

  289284 bytes of data.	If there were no overhead (packet headers,

  inter-character and inter-packet delays, etc.) the transfers

  would take the following times:

  would take the following times::



      bits/sec	seconds

      345600	8.3
@@ -388,8 +292,10 @@ 
  that the connection establishment seemed fragile for the higher

  speeds.  Once established, the connection seemed robust enough.)



  ======  ========	===  ========   ======= ======= ===

  #lines  speed		mtu  seconds	theory  actual  %of

	  kbit/sec	     duration	speed	speed	max

  ======  ========	===  ========   ======= ======= ===

  3	  115200	900	_	345600

  3	  115200	400	18.1	345600  159825  46

  2	  115200	900	_	230400
@@ -447,18 +353,12 @@ 
  1	  9600		900	305	9600	9484.72 98

  1	  9600		600	314	9600	9212.87 95

  1	  9600		400	332	9600	8713.37 90









  ======  ========	===  ========   ======= ======= ===



5.2. Anthony Healy's Report

---------------------------













  ::



    Date: Mon, 13 Feb 1995 16:17:29 +1100 (EST)

    From: Antony Healey <ahealey@st.nepean.uws.edu.au>
@@ -471,58 +371,3 @@ 
	  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

	  6.4 Kbyte/s, which I think is pretty cool.  :)

Documentation/networking/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -54,6 +54,7 @@ Contents: 
   defza

   dns_resolver

   driver

   eql



.. only::  subproject and html

drivers/net/Kconfig

+1 −1
Original line number Diff line number Diff line
@@ -126,7 +126,7 @@ config EQUALIZER 
	  Linux driver or with a Livingston Portmaster 2e.



	  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

	  <http://www.tldp.org/docs.html#howto>.