^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) ==========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) batman-adv
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) ==========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) Batman advanced is a new approach to wireless networking which does no longer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) operate on the IP basis. Unlike the batman daemon, which exchanges information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) using UDP packets and sets routing tables, batman-advanced operates on ISO/OSI
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) Layer 2 only and uses and routes (or better: bridges) Ethernet Frames. It
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) emulates a virtual network switch of all nodes participating. Therefore all
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) nodes appear to be link local, thus all higher operating protocols won't be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) affected by any changes within the network. You can run almost any protocol
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) above batman advanced, prominent examples are: IPv4, IPv6, DHCP, IPX.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) Batman advanced was implemented as a Linux kernel driver to reduce the overhead
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) to a minimum. It does not depend on any (other) network driver, and can be used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) on wifi as well as ethernet lan, vpn, etc ... (anything with ethernet-style
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) layer 2).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) Configuration
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) =============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) Load the batman-adv module into your kernel::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) $ insmod batman-adv.ko
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) The module is now waiting for activation. You must add some interfaces on which
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) batman-adv can operate. The batman-adv soft-interface can be created using the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) iproute2 tool ``ip``::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) $ ip link add name bat0 type batadv
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) To activate a given interface simply attach it to the ``bat0`` interface::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) $ ip link set dev eth0 master bat0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) Repeat this step for all interfaces you wish to add. Now batman-adv starts
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) using/broadcasting on this/these interface(s).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) To deactivate an interface you have to detach it from the "bat0" interface::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) $ ip link set dev eth0 nomaster
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) The same can also be done using the batctl interface subcommand::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) batctl -m bat0 interface create
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) batctl -m bat0 interface add -M eth0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) To detach eth0 and destroy bat0::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) batctl -m bat0 interface del -M eth0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) batctl -m bat0 interface destroy
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) There are additional settings for each batadv mesh interface, vlan and hardif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) which can be modified using batctl. Detailed information about this can be found
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) in its manual.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) For instance, you can check the current originator interval (value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) in milliseconds which determines how often batman-adv sends its broadcast
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) packets)::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) $ batctl -M bat0 orig_interval
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) 1000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) and also change its value::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) $ batctl -M bat0 orig_interval 3000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) In very mobile scenarios, you might want to adjust the originator interval to a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) lower value. This will make the mesh more responsive to topology changes, but
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) will also increase the overhead.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) Information about the current state can be accessed via the batadv generic
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) netlink family. batctl provides a human readable version via its debug tables
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) subcommands.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) Usage
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) =====
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) To make use of your newly created mesh, batman advanced provides a new
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) interface "bat0" which you should use from this point on. All interfaces added
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) to batman advanced are not relevant any longer because batman handles them for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) you. Basically, one "hands over" the data by using the batman interface and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) batman will make sure it reaches its destination.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) The "bat0" interface can be used like any other regular interface. It needs an
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) IP address which can be either statically configured or dynamically (by using
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) DHCP or similar services)::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) NodeA: ip link set up dev bat0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) NodeA: ip addr add 192.168.0.1/24 dev bat0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) NodeB: ip link set up dev bat0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) NodeB: ip addr add 192.168.0.2/24 dev bat0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) NodeB: ping 192.168.0.1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) Note: In order to avoid problems remove all IP addresses previously assigned to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) interfaces now used by batman advanced, e.g.::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) $ ip addr flush dev eth0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) Logging/Debugging
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) =================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) All error messages, warnings and information messages are sent to the kernel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) log. Depending on your operating system distribution this can be read in one of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) a number of ways. Try using the commands: ``dmesg``, ``logread``, or looking in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) the files ``/var/log/kern.log`` or ``/var/log/syslog``. All batman-adv messages
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) are prefixed with "batman-adv:" So to see just these messages try::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) $ dmesg | grep batman-adv
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) When investigating problems with your mesh network, it is sometimes necessary to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) see more detailed debug messages. This must be enabled when compiling the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) batman-adv module. When building batman-adv as part of the kernel, use "make
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) menuconfig" and enable the option ``B.A.T.M.A.N. debugging``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) (``CONFIG_BATMAN_ADV_DEBUG=y``).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) Those additional debug messages can be accessed using the perf infrastructure::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) $ trace-cmd stream -e batadv:batadv_dbg
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) The additional debug output is by default disabled. It can be enabled during
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) run time::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) $ batctl -m bat0 loglevel routes tt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) will enable debug messages for when routes and translation table entries change.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) Counters for different types of packets entering and leaving the batman-adv
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) module are available through ethtool::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) $ ethtool --statistics bat0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) batctl
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) ======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) As batman advanced operates on layer 2, all hosts participating in the virtual
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) switch are completely transparent for all protocols above layer 2. Therefore
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) the common diagnosis tools do not work as expected. To overcome these problems,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) batctl was created. At the moment the batctl contains ping, traceroute, tcpdump
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) and interfaces to the kernel module settings.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) For more information, please see the manpage (``man batctl``).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) batctl is available on https://www.open-mesh.org/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) Contact
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) Please send us comments, experiences, questions, anything :)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) IRC:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) #batman on irc.freenode.org
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) Mailing-list:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) b.a.t.m.a.n@open-mesh.org (optional subscription at
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) https://lists.open-mesh.org/mailman3/postorius/lists/b.a.t.m.a.n.lists.open-mesh.org/)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) You can also contact the Authors:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) * Marek Lindner <mareklindner@neomailbox.ch>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) * Simon Wunderlich <sw@simonwunderlich.de>
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags