docs: networking: convert ila.txt to ReST

Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

kernel os linux

- 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: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Mauro Carvalho Chehab and committed by

David S. Miller 6 years ago 1d2698fa 3c3a2fde

+47 -35

2 changed files

expand all

Documentation

networking

ila.rst

index.rst

+46 -35

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

··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + =================================== 1 4 Identifier Locator Addressing (ILA) 5 + =================================== 2 6 3 7 4 8 Introduction ··· 30 26 ILA terminology 31 27 =============== 32 28 33 - - Identifier A number that identifies an addressable node in the network 29 + - Identifier 30 + A number that identifies an addressable node in the network 34 31 independent of its location. ILA identifiers are sixty-four 35 32 bit values. 36 33 37 - - Locator A network prefix that routes to a physical host. Locators 34 + - Locator 35 + A network prefix that routes to a physical host. Locators 38 36 provide the topological location of an addressed node. ILA 39 37 locators are sixty-four bit prefixes. 40 38 ··· 57 51 bits) and an identifier (low order sixty-four bits). ILA 58 52 addresses are never visible to an application. 59 53 60 - - ILA host An end host that is capable of performing ILA translations 54 + - ILA host 55 + An end host that is capable of performing ILA translations 61 56 on transmit or receive. 62 57 63 - - ILA router A network node that performs ILA translation and forwarding 58 + - ILA router 59 + A network node that performs ILA translation and forwarding 64 60 of translated packets. 65 61 66 62 - ILA forwarding cache 67 63 A type of ILA router that only maintains a working set 68 64 cache of mappings. 69 65 70 - - ILA node A network node capable of performing ILA translations. This 66 + - ILA node 67 + A network node capable of performing ILA translations. This 71 68 can be an ILA router, ILA forwarding cache, or ILA host. 72 69 73 70 ··· 91 82 different. 92 83 93 84 The diagram below illustrates the flow of packets through ILA as well 94 - as showing ILA hosts and routers. 85 + as showing ILA hosts and routers:: 95 86 96 87 +--------+ +--------+ 97 88 | Host A +-+ +--->| Host B | 98 89 | | | (2) ILA (') | | 99 90 +--------+ | ...addressed.... ( ) +--------+ 100 - V +---+--+ . packet . +---+--+ (_) 91 + V +---+--+ . packet . +---+--+ (_) 101 92 (1) SIR | | ILA |----->-------->---->| ILA | | (3) SIR 102 93 addressed +->|router| . . |router|->-+ addressed 103 94 packet +---+--+ . IPv6 . +---+--+ packet 104 - / . Network . 105 - / . . +--+-++--------+ 95 + / . Network . 96 + / . . +--+-++--------+ 106 97 +--------+ / . . |ILA || Host | 107 98 | Host +--+ . .- -|host|| | 108 99 | | . . +--+-++--------+ ··· 182 173 183 174 In the simplest format the identifier types, C-bit, and checksum 184 175 adjustment value are not present so an identifier is considered an 185 - unstructured sixty-four bit value. 176 + unstructured sixty-four bit value:: 186 177 187 178 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 188 179 | Identifier | ··· 193 184 The checksum neutral adjustment may be configured to always be 194 185 present using neutral-map-auto. In this case there is no C-bit, but the 195 186 checksum adjustment is in the low order 16 bits. The identifier is 196 - still sixty-four bits. 187 + still sixty-four bits:: 197 188 198 189 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 199 190 | Identifier | ··· 202 193 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 203 194 204 195 The C-bit may used to explicitly indicate that checksum neutral 205 - mapping has been applied to an ILA address. The format is: 196 + mapping has been applied to an ILA address. The format is:: 206 197 207 198 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 208 199 | |C| Identifier | ··· 213 204 The identifier type field may be present to indicate the identifier 214 205 type. If it is not present then the type is inferred based on mapping 215 206 configuration. The checksum neutral adjustment may automatically 216 - used with the identifier type as illustrated below. 207 + used with the identifier type as illustrated below:: 217 208 218 209 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 219 210 | Type| Identifier | ··· 222 213 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 223 214 224 215 If the identifier type and the C-bit can be present simultaneously so 225 - the identifier format would be: 216 + the identifier format would be:: 226 217 227 218 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 228 219 | Type|C| Identifier | ··· 267 258 Some examples 268 259 ============= 269 260 270 - # Configure an ILA route that uses checksum neutral mapping as well 271 - # as type field. Note that the type field is set in the SIR address 272 - # (the 2000 implies type is 1 which is LUID). 273 - ip route add 3333:0:0:1:2000:0:1:87/128 encap ila 2001:0:87:0 \ 274 - csum-mode neutral-map ident-type use-format 261 + :: 275 262 276 - # Configure an ILA LWT route that uses auto checksum neutral mapping 277 - # (no C-bit) and configure identifier type to be LUID so that the 278 - # identifier type field will not be present. 279 - ip route add 3333:0:0:1:2000:0:2:87/128 encap ila 2001:0:87:1 \ 280 - csum-mode neutral-map-auto ident-type luid 263 + # Configure an ILA route that uses checksum neutral mapping as well 264 + # as type field. Note that the type field is set in the SIR address 265 + # (the 2000 implies type is 1 which is LUID). 266 + ip route add 3333:0:0:1:2000:0:1:87/128 encap ila 2001:0:87:0 \ 267 + csum-mode neutral-map ident-type use-format 281 268 282 - ila_xlat configuration 269 + # Configure an ILA LWT route that uses auto checksum neutral mapping 270 + # (no C-bit) and configure identifier type to be LUID so that the 271 + # identifier type field will not be present. 272 + ip route add 3333:0:0:1:2000:0:2:87/128 encap ila 2001:0:87:1 \ 273 + csum-mode neutral-map-auto ident-type luid 283 274 284 - # Configure an ILA to SIR mapping that matches a locator and overwrites 285 - # it with a SIR address (3333:0:0:1 in this example). The C-bit and 286 - # identifier field are used. 287 - ip ila add loc_match 2001:0:119:0 loc 3333:0:0:1 \ 288 - csum-mode neutral-map-auto ident-type use-format 275 + ila_xlat configuration 289 276 290 - # Configure an ILA to SIR mapping where checksum neutral is automatically 291 - # set without the C-bit and the identifier type is configured to be LUID 292 - # so that the identifier type field is not present. 293 - ip ila add loc_match 2001:0:119:0 loc 3333:0:0:1 \ 294 - csum-mode neutral-map-auto ident-type use-format 277 + # Configure an ILA to SIR mapping that matches a locator and overwrites 278 + # it with a SIR address (3333:0:0:1 in this example). The C-bit and 279 + # identifier field are used. 280 + ip ila add loc_match 2001:0:119:0 loc 3333:0:0:1 \ 281 + csum-mode neutral-map-auto ident-type use-format 282 + 283 + # Configure an ILA to SIR mapping where checksum neutral is automatically 284 + # set without the C-bit and the identifier type is configured to be LUID 285 + # so that the identifier type field is not present. 286 + ip ila add loc_match 2001:0:119:0 loc 3333:0:0:1 \ 287 + csum-mode neutral-map-auto ident-type use-format

Documentation/networking/index.rst

··· 64 64 gen_stats 65 65 gtp 66 66 hinic 67 + ila 67 68 68 69 .. only:: subproject and html 69 70