Repository : ssh://git@open-mesh.org/doc

On branch : master

commit 69435a1cf56ae3a465d25d72530b9570539251cb Author: Sven Eckelmann sven@narfation.org Date: Thu Jul 13 17:28:27 2017 +0200

doc: Fix malformed tables

Signed-off-by: Sven Eckelmann sven@narfation.org

69435a1cf56ae3a465d25d72530b9570539251cb batman-adv/Multicast-optimizations-tech.rst | 40 ++++++++++++------- batman-adv/TT-Flags.rst | 61 +++++++++++++++++------------ 2 files changed, 63 insertions(+), 38 deletions(-)

diff --git a/batman-adv/Multicast-optimizations-tech.rst b/batman-adv/Multicast-optimizations-tech.rst index 3ee708a..30e43d6 100644 --- a/batman-adv/Multicast-optimizations-tech.rst +++ b/batman-adv/Multicast-optimizations-tech.rst @@ -114,20 +114,32 @@ other nodes, there are various limitations and exceptions. If multicast optimization is not supported for whatever reason, the packets will be sent as broadcast as a fallback solution.

-+----------------------------+----------------------------------------------+---------------------------------------------+ -| *address range* | \2=. *address family* | -+----------------------------+----------------------------------------------+---------------------------------------------+ -| | **IPv4** | **IPv6** | -+----------------------------+----------------------------------------------+---------------------------------------------+ -| **all nodes link-scope** | =. supported without bridges¹. | =. supported without bridges¹. | -| | Example: 224.0.0.1 (all nodes) | Example: ff02::1 (all nodes) | -+----------------------------+----------------------------------------------+---------------------------------------------+ -| **link-local** | =. supported without bridges¹. | =. supported². | -| (excl. all nodes addr.) | Example: 224.0.0.251 (mDNS) | Example: ff12::39 (locally administrated) | -+----------------------------+----------------------------------------------+---------------------------------------------+ -| **routable** | =. support planned³. | =. support planned³. | -| | Example: 239.1.2.3 (locally administrated) | Example: ff0e::101 (NTP) | -+----------------------------+----------------------------------------------+---------------------------------------------+ +.. list-table:: + :stub-columns: 1 + :header-rows: 2 + + * - address range + - address family + - address family + * - + - IPv4 + - IPv6 + * - all nodes link-scope + - supported without bridges¹ + Example: 224.0.0.1 (all nodes) + - supported without bridges¹ + Example: ff02::1 (all nodes) + * - link-local + (excl. all nodes addr.) + - supported without bridges¹ + Example: 224.0.0.251 (mDNS) + - supported² + Example: ff12::39 (locally administrated) + * - routable + - support planned³ + Example: 239.1.2.3 (locally administrated) + - support planned³ + Example: ff0e::101 (NTP)

¹: These addresses cannot be considered for optimization towards nodes which have a bridge interface on top of their batman interface as they diff --git a/batman-adv/TT-Flags.rst b/batman-adv/TT-Flags.rst index 8e74190..fa04853 100644 --- a/batman-adv/TT-Flags.rst +++ b/batman-adv/TT-Flags.rst @@ -12,34 +12,47 @@ This section describes the flags used in the TT code, what they mean and where they are used. There are 3 possible locations where the flags field is used:

-| * OGM: there is a flag field within each of the tt_change structs +* OGM: there is a flag field within each of the tt_change structs which are sent along with the OGM frames. -| * tt_global: these structs are stored in the global hash table and +* tt_global: these structs are stored in the global hash table and represent the mapping which originator hosts which client. -| * tt_local: these structs are stored in the local hash table and +* tt_local: these structs are stored in the local hash table and represent the the clients which the own node hosts.

-+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| Name | used in | Description | -+=======================+==============================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================+==========================+ -| TT_CLIENT_DEL | OGM | The TT_CLIENT_DEL flag is used in the OGM tt_change entries to distinguish whether the entry should be added (no DEL flag set) or deleted (DEL flag set). | -| | | It is also set to pass add/deletion information between functions internally. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT_CLIENT_ROAM | OGM, tt_global | The TT_CLIENT_ROAM flag is used to announce in an OGM tt_change entry that a client is deleted because of roaming. The node which receives this entry may still send traffic to this node, which will re-route it to the new destination, until an OGM from the new node now hosting the client is received. The tt_global entry with the old node for this client is then replaced with the new entry. | -| | | Other than thise case, whenever a node receives a Roaming_Advertisement packet, it will add a new tt_global entry which will create a new route to this client. This tt_global entry is marked with the TT_CLIENT_ROAM flag so that it can be eventually deleted if no node will claim the client afterwards (with an ADD event) | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT_CLIENT_WIFI | OGM, tt_local, tt_global | The TT_CLIENT_WIFI flag is used to announce that this client is a WiFi client. This information is used for the AP isolation feature. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT_CLIENT_ISOLA | OGM, tt_local, tt_global | The TT_CLIENT_ISOLA flag is used to announce that packets sent by this client were marked with the isolation mark when received on the soft-interface. A node receiving packets from this client has to mark the related skbs with the configured isolation mark before delivering them to its own soft-interface. Moreover two clients marked with this flag cannot exchange packets over the mesh network (this behavior is part of the [[Extended-isolation | extended isolation]]). | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT_CLIENT_NOPURGE | tt_local | The private TT_CLIENT_NOPURGE is used to mark a local client to not be purged. This is only used for the address of the mesh soft interface, which should always be announced and never deleted/purged. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT_CLIENT_NEW | tt_local | The private TT_CLIENT_NEW flag is used to mark clients which have been added to the local list, but not yet announced within an OGM. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT_CLIENT_PENDING | tt_local | The private TT_CLIENT_PENDING flag is set for local entries which should be removed. These entries are not removed immediately, but when the next OGM is sent, to keep the information sent with the OGM or tt_requests consistent. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| TT_CLIENT_TEMP | tt_global | This flag is used to mark a client that has not been advertised by any node yet, but it has already been detected to be part of the network. | -+-----------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------+ +.. list-table:: + :stub-columns: 1 + :header-rows: 1 + + + * - Name + - used in + - Description + * - TT_CLIENT_DEL + - OGM + - The TT_CLIENT_DEL flag is used in the OGM tt_change entries to distinguish whether the entry should be added (no DEL flag set) or deleted (DEL flag set). + It is also set to pass add/deletion information between functions internally. + * - TT_CLIENT_ROAM + - OGM, tt_global + - The TT_CLIENT_ROAM flag is used to announce in an OGM tt_change entry that a client is deleted because of roaming. The node which receives this entry may still send traffic to this node, which will re-route it to the new destination, until an OGM from the new node now hosting the client is received. The tt_global entry with the old node for this client is then replaced with the new entry. + Other than thise case, whenever a node receives a Roaming_Advertisement packet, it will add a new tt_global entry which will create a new route to this client. This tt_global entry is marked with the TT_CLIENT_ROAM flag so that it can be eventually deleted if no node will claim the client afterwards (with an ADD event) + * - TT_CLIENT_WIFI + - OGM, tt_local, tt_global + - The TT_CLIENT_WIFI flag is used to announce that this client is a WiFi client. This information is used for the AP isolation feature. + * - TT_CLIENT_ISOLA + - OGM, tt_local, tt_global + - The TT_CLIENT_ISOLA flag is used to announce that packets sent by this client were marked with the isolation mark when received on the soft-interface. A node receiving packets from this client has to mark the related skbs with the configured isolation mark before delivering them to its own soft-interface. Moreover two clients marked with this flag cannot exchange packets over the mesh network (this behavior is part of the [[Extended-isolation|extended isolation]]). + * - TT_CLIENT_NOPURGE + - tt_local + - The private TT_CLIENT_NOPURGE is used to mark a local client to not be purged. This is only used for the address of the mesh soft interface, which should always be announced and never deleted/purged. + * - TT_CLIENT_NEW + - tt_local + - The private TT_CLIENT_NEW flag is used to mark clients which have been added to the local list, but not yet announced within an OGM. + * - TT_CLIENT_PENDING + - tt_local + - The private TT_CLIENT_PENDING flag is set for local entries which should be removed. These entries are not removed immediately, but when the next OGM is sent, to keep the information sent with the OGM or tt_requests consistent. + * - TT_CLIENT_TEMP + - tt_global + - This flag is used to mark a client that has not been advertised by any node yet, but it has already been detected to be part of the network.

Changes within in bridge loop avoidance II ------------------------------------------