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

docs: networking: convert ila.txt to ReST 



- add SPDX header;
- adjust title markup;
- mark code blocks and literals 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 3c3a2fde

Documentation/networking/ila.txt→Documentation/networking/ila.rst

+50 −39
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



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

Identifier Locator Addressing (ILA)

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





Introduction
@@ -26,11 +30,13 @@ The ILA protocol is described in Internet-Draft draft-herbert-intarea-ila. 
ILA terminology

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



  - Identifier	A number that identifies an addressable node in the network

  - Identifier

		A number that identifies an addressable node in the network

		independent of its location. ILA identifiers are sixty-four

		bit values.



  - Locator	A network prefix that routes to a physical host. Locators

  - Locator

		A network prefix that routes to a physical host. Locators

		provide the topological location of an addressed node. ILA

		locators are sixty-four bit prefixes.
@@ -51,17 +57,20 @@ ILA terminology 
		bits) and an identifier (low order sixty-four bits). ILA

		addresses are never visible to an application.



  - ILA host	An end host that is capable of performing ILA translations

  - ILA host

		An end host that is capable of performing ILA translations

		on transmit or receive.



  - ILA router	A network node that performs ILA translation and forwarding

  - ILA router

		A network node that performs ILA translation and forwarding

		of translated packets.



  - ILA forwarding cache

		A type of ILA router that only maintains a working set

		cache of mappings.



  - ILA node	A network node capable of performing ILA translations. This

  - ILA node

		A network node capable of performing ILA translations. This

		can be an ILA router, ILA forwarding cache, or ILA host.
@@ -82,7 +91,7 @@ Configuration and datapath for these two points of deployment is somewhat 
different.



The diagram below illustrates the flow of packets through ILA as well

as showing ILA hosts and routers.

as showing ILA hosts and routers::



    +--------+                                                +--------+

    | Host A +-+                                         +--->| Host B |
@@ -173,7 +182,7 @@ ILA address, never a SIR address. 


In the simplest format the identifier types, C-bit, and checksum

adjustment value are not present so an identifier is considered an

unstructured sixty-four bit value.

unstructured sixty-four bit value::



     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

     |                            Identifier                         |
@@ -184,7 +193,7 @@ unstructured sixty-four bit value. 
The checksum neutral adjustment may be configured to always be

present using neutral-map-auto. In this case there is no C-bit, but the

checksum adjustment is in the low order 16 bits. The identifier is

still sixty-four bits.

still sixty-four bits::



     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

     |                            Identifier                         |
@@ -193,7 +202,7 @@ still sixty-four bits. 
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+



The C-bit may used to explicitly indicate that checksum neutral

mapping has been applied to an ILA address. The format is:

mapping has been applied to an ILA address. The format is::



     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

     |     |C|                    Identifier                         |
@@ -204,7 +213,7 @@ mapping has been applied to an ILA address. The format is: 
The identifier type field may be present to indicate the identifier

type. If it is not present then the type is inferred based on mapping

configuration. The checksum neutral adjustment may automatically

used with the identifier type as illustrated below.

used with the identifier type as illustrated below::



     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

     | Type|                      Identifier                         |
@@ -213,7 +222,7 @@ used with the identifier type as illustrated below. 
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+



If the identifier type and the C-bit can be present simultaneously so

the identifier format would be:

the identifier format would be::



     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

     | Type|C|                    Identifier                         |
@@ -258,6 +267,8 @@ same meanings as described above. 
Some examples

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



::



     # Configure an ILA route that uses checksum neutral mapping as well

     # as type field. Note that the type field is set in the SIR address

     # (the 2000 implies type is 1 which is LUID).

Documentation/networking/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -64,6 +64,7 @@ Contents: 
   gen_stats

   gtp

   hinic

   ila



.. only::  subproject and html

CRA Git | Maintained and supported by SUSTech CRA and CCSE