Blame view
Documentation/networking/batman-adv.txt
7.02 KB
c6c8fea29 net: Add batman-a... |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
BATMAN-ADV ---------- Batman advanced is a new approach to wireless networking which does no longer operate on the IP basis. Unlike the batman daemon, which exchanges information using UDP packets and sets routing tables, batman-advanced operates on ISO/OSI Layer 2 only and uses and routes (or better: bridges) Ethernet Frames. It emulates a virtual network switch of all nodes participating. Therefore all nodes appear to be link local, thus all higher operating proto- cols won't be affected by any changes within the network. You can run almost any protocol above batman advanced, prominent examples are: IPv4, IPv6, DHCP, IPX. Batman advanced was implemented as a Linux kernel driver to re- duce the overhead to a minimum. It does not depend on any (other) network driver, and can be used on wifi as well as ethernet lan, vpn, etc ... (anything with ethernet-style layer 2). |
2dafb49d8 batman-adv: renam... |
19 |
|
c6c8fea29 net: Add batman-a... |
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
CONFIGURATION ------------- Load the batman-adv module into your kernel: # insmod batman-adv.ko The module is now waiting for activation. You must add some in- terfaces on which batman can operate. After loading the module batman advanced will scan your systems interfaces to search for compatible interfaces. Once found, it will create subfolders in the /sys directories of each supported interface, e.g. # ls /sys/class/net/eth0/batman_adv/ # iface_status mesh_iface If an interface does not have the "batman_adv" subfolder it prob- ably is not supported. Not supported interfaces are: loopback, non-ethernet and batman's own interfaces. Note: After the module was loaded it will continuously watch for new interfaces to verify the compatibility. There is no need to reload the module if you plug your USB wifi adapter into your ma- chine after batman advanced was initially loaded. To activate a given interface simply write "bat0" into its "mesh_iface" file inside the batman_adv subfolder: # echo bat0 > /sys/class/net/eth0/batman_adv/mesh_iface Repeat this step for all interfaces you wish to add. Now batman starts using/broadcasting on this/these interface(s). By reading the "iface_status" file you can check its status: # cat /sys/class/net/eth0/batman_adv/iface_status # active To deactivate an interface you have to write "none" into its "mesh_iface" file: # echo none > /sys/class/net/eth0/batman_adv/mesh_iface All mesh wide settings can be found in batman's own interface folder: |
23721387c batman-adv: add b... |
66 |
# ls /sys/class/net/bat0/mesh/ |
c28c0b6b1 batman-adv: add m... |
67 68 69 70 |
#aggregated_ogms distributed_arp_table gw_sel_class orig_interval #ap_isolation fragmentation hop_penalty routing_algo #bonding gw_bandwidth isolation_mark vlan0 #bridge_loop_avoidance gw_mode log_level |
c6c8fea29 net: Add batman-a... |
71 |
|
f65e51d74 Documentation: fi... |
72 |
There is a special folder for debugging information: |
c6c8fea29 net: Add batman-a... |
73 |
|
536a23f11 batman-adv: Add t... |
74 75 76 |
# ls /sys/kernel/debug/batman_adv/bat0/ # bla_backbone_table log transtable_global # bla_claim_table originators transtable_local |
9f4980e68 batman-adv: remov... |
77 |
# gateways socket |
c6c8fea29 net: Add batman-a... |
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
Some of the files contain all sort of status information regard- ing the mesh network. For example, you can view the table of originators (mesh participants) with: # cat /sys/kernel/debug/batman_adv/bat0/originators Other files allow to change batman's behaviour to better fit your requirements. For instance, you can check the current originator interval (value in milliseconds which determines how often batman sends its broadcast packets): # cat /sys/class/net/bat0/mesh/orig_interval # 1000 and also change its value: # echo 3000 > /sys/class/net/bat0/mesh/orig_interval In very mobile scenarios, you might want to adjust the originator interval to a lower value. This will make the mesh more respon- sive to topology changes, but will also increase the overhead. USAGE ----- To make use of your newly created mesh, batman advanced provides a new interface "bat0" which you should use from this point on. All interfaces added to batman advanced are not relevant any longer because batman handles them for you. Basically, one "hands over" the data by using the batman interface and batman will make sure it reaches its destination. The "bat0" interface can be used like any other regular inter- face. It needs an IP address which can be either statically con- figured or dynamically (by using DHCP or similar services): # NodeA: ifconfig bat0 192.168.0.1 # NodeB: ifconfig bat0 192.168.0.2 # NodeB: ping 192.168.0.1 Note: In order to avoid problems remove all IP addresses previ- ously assigned to interfaces now used by batman advanced, e.g. # ifconfig eth0 0.0.0.0 |
c6c8fea29 net: Add batman-a... |
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
LOGGING/DEBUGGING ----------------- All error messages, warnings and information messages are sent to the kernel log. Depending on your operating system distribution this can be read in one of a number of ways. Try using the com- mands: dmesg, logread, or looking in the files /var/log/kern.log or /var/log/syslog. All batman-adv messages are prefixed with "batman-adv:" So to see just these messages try # dmesg | grep batman-adv When investigating problems with your mesh network it is some- times necessary to see more detail debug messages. This must be enabled when compiling the batman-adv module. When building bat- man-adv as part of kernel, use "make menuconfig" and enable the option "B.A.T.M.A.N. debugging". Those additional debug messages can be accessed using a special file in debugfs # cat /sys/kernel/debug/batman_adv/bat0/log The additional debug output is by default disabled. It can be en- abled during run time. Following log_levels are defined: 0 - All debug output disabled 1 - Enable messages related to routing / flooding / broadcasting |
1a9848973 batman-adv: readm... |
152 153 |
2 - Enable messages related to route added / changed / deleted 4 - Enable messages related to translation table operations |
23721387c batman-adv: add b... |
154 |
8 - Enable messages related to bridge loop avoidance |
0e861a3c4 batman-adv: Distr... |
155 156 |
16 - Enable messaged related to DAT, ARP snooping and parsing 31 - Enable all messages |
c6c8fea29 net: Add batman-a... |
157 158 159 |
The debug output can be changed at runtime using the file /sys/class/net/bat0/mesh/log_level. e.g. |
23721387c batman-adv: add b... |
160 |
# echo 6 > /sys/class/net/bat0/mesh/log_level |
c6c8fea29 net: Add batman-a... |
161 |
|
1a9848973 batman-adv: readm... |
162 |
will enable debug messages for when routes change. |
c6c8fea29 net: Add batman-a... |
163 |
|
f8214865a batman-adv: Add g... |
164 165 166 167 |
Counters for different types of packets entering and leaving the batman-adv module are available through ethtool: # ethtool --statistics bat0 |
c6c8fea29 net: Add batman-a... |
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
BATCTL ------ As batman advanced operates on layer 2 all hosts participating in the virtual switch are completely transparent for all protocols above layer 2. Therefore the common diagnosis tools do not work as expected. To overcome these problems batctl was created. At the moment the batctl contains ping, traceroute, tcpdump and interfaces to the kernel module settings. For more information, please see the manpage (man batctl). batctl is available on http://www.open-mesh.org/ CONTACT ------- Please send us comments, experiences, questions, anything :) IRC: #batman on irc.freenode.org |
091b94830 batman-adv: Merge... |
190 191 |
Mailing-list: b.a.t.m.a.n@open-mesh.org (optional subscription at https://lists.open-mesh.org/mm/listinfo/b.a.t.m.a.n) |
c6c8fea29 net: Add batman-a... |
192 193 |
You can also contact the Authors: |
bc58eeef7 batman-adv: updat... |
194 |
Marek Lindner <mareklindner@neomailbox.ch> |
c679ff8fb batman-adv: updat... |
195 |
Simon Wunderlich <sw@simonwunderlich.de> |