Projecte

General

Perfil

Wiki » Historial » Versió 11

Axel Neumann, 26-08-2012 16:52

1 6 Axel Neumann
{{>toc}}
2 1 Pau Escrich
3
4 8 Axel Neumann
h1. BMX6
5 6 Axel Neumann
6
Bmx6 is a routing protocol for Linux based operating systems.
7 1 Pau Escrich
The following intro provides kind of tutorial to get started.
8
9 8 Axel Neumann
h2. Installation
10 6 Axel Neumann
11 8 Axel Neumann
h3. Requirements
12 7 Axel Neumann
13 6 Axel Neumann
The following tools are needed to obtain, compile, and install bmx6
14
* git (debian package: git-core)
15
* gcc
16
* make
17
18
19 8 Axel Neumann
h3. Downloading
20 6 Axel Neumann
21
Latest development sources are available from bmx6 git repository
22
<pre>
23
git clone git://qmp.cat/bmx6.git
24
cd bmx6
25
</pre>
26
27 8 Axel Neumann
h3. Compile and Install
28 6 Axel Neumann
29 7 Axel Neumann
To only compile the main bmx6 daemon (no bmx6 plugins)
30 6 Axel Neumann
<pre>
31
make
32
sudo make install
33
</pre>
34
35
36 8 Axel Neumann
h2. Usage (hello mesh)
37 6 Axel Neumann
38 3 Axel Neumann
39
In its most simple configuration, the only required parameter are the interfaces names that should be used for meshing.
40
The following example starts bmx6 on interface wlan0:
41
<pre>
42 9 Axel Neumann
root@mlc1001:~# bmx6 dev=eth0
43 3 Axel Neumann
</pre>
44
45
However, to let this simple command work as expected also check the following basic requirements:
46
47 9 Axel Neumann
* bmx6 must be executed in root context (with super user permissions). If you are not already root, prepend all commands with sudo (eg: @ sudo bmx6 dev=eth0 @ ).
48 3 Axel Neumann
49 9 Axel Neumann
* NO IP address needs to be configured. By default bmx6 assumes IPv6 and autoconfigures an ULA based IPv6 address for each interface based on the MAC address of the device. Just, the interfaces must be UP. The linux ip command can do this for you (eg: @ ip link set wlan0 up @). Also, if you are using a wireless interface, the wireless interface settings must be set correctly so that link-layer connectivity is given with bmx6 daemons running on other nodes (computers). The good old iwconfig command may help to achieve that. For example @ iwconfig wlan0 mode ad-hoc ap 02:ca:ff:ee:ba:be channel 11 essid my-mesh-network @ is a typical configuration for a wireless mesh setup.
50 3 Axel Neumann
51 9 Axel Neumann
* Bmx6 (by default) works in daemon mode, thus sends itself to background and gives back a prompt. To let it run in foreground specify a debug level with the startup command like: @ bmx6 debug=0 dev=eth0 @ . Of course you may need to kill a previously started bmx6 daemon beforehand (@ killall bmx6 @)
52 3 Axel Neumann
53 9 Axel Neumann
If everything went fine bmx6 is running now, searching for neighboring bmx6 daemons via the configured link, and coordinates with them to learn about existence-of and routes-to all other bmx6 nodes in the network.
54
 
55 4 Axel Neumann
To access status information of the bmx6 daemon which has just been started, a second bmx6 process can be launched in client mode (with the --connect or -c parameter) to connect to the main bmx6 daemon and retrieve the desired information.
56 9 Axel Neumann
57 4 Axel Neumann
In the following, a few example will be discussed:
58
<pre>
59 1 Pau Escrich
root@mlc1001:~# bmx6 -c status
60
version        compatibility codeVersion globalId                     primaryIp                       myLocalId uptime     cpu nodes 
61
BMX6-0.1-alpha 16            9           mlc1001.E0F9E33CD42EF2980443 fd66:66:66:0:a2cd:efff:fe10:101 24100101  0:00:56:37 0.3 3
62
</pre>
63
64
So apart from version, compatibility number, and code, the status reveals the daemon's global and local ID, its primary (self-configured) IPv6 address, the time since when it is running (56 minutes), its current cpu consumption (0.3%) and the total number of learned nodes in the network (including itself).
65 5 Axel Neumann
66 9 Axel Neumann
Typical types of accessible information are: status, interfaces, links, originators, descriptions, tunnels
67
These required types can be combined. Also the above given example shows kind of shortcut. The long argument would be
68
@ bmx6 connect show=status @. So a more informative case using the long form would be:
69 1 Pau Escrich
<pre>
70 9 Axel Neumann
root@mlc1001:~# bmx6 connect show=status show=interfaces show=links show=originators show=tunnels
71 1 Pau Escrich
status:
72
version        compatibility codeVersion globalId                     primaryIp                       myLocalId uptime     cpu nodes 
73
BMX6-0.1-alpha 16            9           mlc1001.6480B336E87B8F8DA8D7 fd66:66:66:0:a2cd:efff:fe10:102 8C100101  0:04:14:15 0.7 3    
74
interfaces:
75
devName state type     rateMin rateMax llocalIp                    globalIp                           multicastIp primary 
76 9 Axel Neumann
eth0    UP    ethernet 1000M   1000M   fe80::a2cd:efff:fe10:101/64 fd66:66:66:0:a2cd:efff:fe10:101/64 ff02::2     1       
77 1 Pau Escrich
links:
78
globalId                     llocalIp                 viaDev  rxRate txRate bestTxLink routes wantsOgms nbLocalId 
79 9 Axel Neumann
mlc1002.4CA9926CF823599148DF fe80::a2cd:efff:fe10:201 eth0    100    100    1          1      1         3D100201  
80
mlc1000.2C4BA11B70E50B889B90 fe80::a2cd:efff:fe10:1   eth0    100    100    1          1      1         DA100001  
81 1 Pau Escrich
originators:
82
globalId                     blocked primaryIp                       routes viaIp                    viaDev  metric lastDesc lastRef 
83 9 Axel Neumann
mlc1000.2C4BA11B70E50B889B90 0       fd66:66:66:0:a2cd:efff:fe10:1   1      fe80::a2cd:efff:fe10:1   eth0    999M   14925    2      
84 1 Pau Escrich
mlc1001.6480B336E87B8F8DA8D7 0       fd66:66:66:0:a2cd:efff:fe10:101 0      ::                       ---     128G   14928    0      
85 9 Axel Neumann
mlc1002.4CA9926CF823599148DF 0       fd66:66:66:0:a2cd:efff:fe10:201 1      fe80::a2cd:efff:fe10:201 eth0    999M   14928    2      
86 1 Pau Escrich
</pre>
87
88 9 Axel Neumann
Only if relevant information for a requested type is available it will be shown.
89
In this example no tunnels are configured nor offered by other nodes and therefore no tunnel information is shown.
90 1 Pau Escrich
91 9 Axel Neumann
The loop argument can be prepended to the connect argument to continuously show the requested information.
92
Many of the long arguments are usable via a short notation, like l for loop, c for connect, s for show, d for debug.
93
And there is another shortcut summarizing my current favorite information types via debug level 8
94
The following commands do the same as above: @ bmx6 -lc status interfaces links originators tunnels @ or just @ bmx6 -lcd8 @.
95 1 Pau Escrich
96 9 Axel Neumann
Reviewing the provided info:
97
* interfaces: followed by one line per configured interface
98
** dev: the interface name
99
** state and type: whether the interface is UP or DOWN and its assumed link-layer type.
100
** rateMin and rateMax: the min and maximum transmit rates assumed for this interface.
101
** llocalIp: the IPv6 link-local address (used as source address for all outgoing protocol data).
102
** globalIp: the autoconfigured address used for sending network traffic via this interface and which is propagated to other nodes.
103
** multicastIp: the multicast IP (used as destination address for all bmx6 protocol traffic send via this interface).
104
** primary: indicates whether the global ip of this interface is used as primary ip for this daemon.
105
* links: followed by one line per detected neighboring bmx6 node.
106
** globalId: the globalId of that neighbor.
107
** llocalIp: the llocalIp of the neighbor's interface building the other side of the link.
108
** viaDev: the interface of this node for the link.
109
** rxRate: the measured receive rate in percent for the link.
110
** txRate: the measured transmit rate in percent for the link.
111
** bestTxLink: indicates whether this link is the best link to a neighboring nodes.
112
** routes: indicates for how much routes to other nodes this link is used.
113
** wantsOgms: indicates whether the neighboring node has requested (this node) to propagate originator messsages (OGMs) via this link.
114
** nbLocalId: the neighbors local ID.
115
* originators: followed by one line per aware originator in the network (including itself).
116
** globalId: the globalId of that neighbor.
117 11 Axel Neumann
** blocked: indicates whether this node is currently blocked (see: [[ #Blocked ]] ).
118 9 Axel Neumann
** primaryIp:
119
** routes:
120
** viaIp:
121
** viaDev:
122
** metric:
123
** lastDesc:
124 1 Pau Escrich
** lastRef:
125 10 Axel Neumann
126
127
128
129
h2. Concepts
130
131
h3. Global ID
132
133
h3. Blocked
134
135
Nodes may be blocked by other nodes.
136
137
The decision for blocking another node is done locally based on the detection of duplicate claimed unique resources.
138
This happens if two nodes are declaring themselves as the owner of a unique resource. Then one of those two nodes (usually the latter) is blocked to avoid the propagation of conflicting state. Duplicate address usage is the most common reason for such events which happens if two nodes are using (and announcing) the same primary IPs. Another typical reason for such events is the rebooting of a node. Once the bmx6 daemon restarts it appears as a new node to the network but announcing the same address as the previous process. Since the resources allocated by the previous resources are still in the database of other nodes in the mesh they will block the new process until this information expires (by default after 100 seconds).
139
140
h3. Unicast Host Network Announcements (UHNA)
141
142
h3. Tunnel Announcements
143
144
h3. Descriptions
145
146
147
148
149 1 Pau Escrich
150
151
152
153
154
155 8 Axel Neumann
h2. Bmx6 Plugins
156 1 Pau Escrich
157
158 8 Axel Neumann
h3. Config Plugin
159 1 Pau Escrich
160
161 8 Axel Neumann
h4. Requirements
162 1 Pau Escrich
163 8 Axel Neumann
uci libs are needed for the bmx6-config plugin.
164
To install it do:
165
<pre>
166
wget http://downloads.openwrt.org/sources/uci-0.7.5.tar.gz
167
tar xzvf uci-0.7.5.tar.gz
168
cd uci-0.7.5
169
make
170
sudo make install
171
</pre>
172 1 Pau Escrich
173 8 Axel Neumann
Depending on your system there happens to be an error during compilation.
174
Then edit cli.c and change line 465 to: @ char *argv[MAX_ARGS+2]; @
175
176
h4. Compile and Install
177
178
To compile the bmx6 daemon and bmx6 plugins
179
<pre>
180
make build_all
181
sudo make install_all
182
</pre>
183
184
185
h4. Usage
186
187
188
189
h3. Json Plugin
190
191
192
h4. Requirements
193
194
* json-c for bmx6_json plugin (debian package: libjson0 libjson0-dev)
195
196
197
json-c developer libs are needed!
198
For further reading check: http://json.org/ or https://github.com/jehiah/json-c
199
200
Note for debian sid:
201
The debian package libjson0-dev 0.10-1 seems to miss the file /usr/include/json/json_object_iterator.h
202
Manually copying it from the below mentioned json-c_0.10.orig.tar.gz archive helps.
203
204
205
To install manually (only if NOT installed via debian or other package management system):
206
<pre>
207
wget http://ftp.de.debian.org/debian/pool/main/j/json-c/json-c_0.10.orig.tar.gz
208
tar xzvf json-c_0.10.orig.tar.gz
209
cd json-c..
210
./configure ; make ; make install; ldconfig
211
</pre>
212
213
214
h4. Compile and Install
215
216
To compile the bmx6 daemon and bmx6 plugins
217
<pre>
218
make build_all
219
sudo make install_all
220
</pre>
221
222
223
h4. Usage
224
225
226
227
h3. SMS Plugin
228
229
230
231
h3. Quagga Plugin
232
233
234 3 Axel Neumann
235
236
*Misc*
237
238
239 2 Pau Escrich
[[Tunnel]]