* more fixups for the generated .c file
[olsrd.git] / README
1
2 +====================================================================+
3 | README - olsr.org OLSR daemon 0.5.0, 02.04.2007                    |
4 +====================================================================+
5
6 Andreas Tonnesen(andreto@olsr.org)
7 Thomas Lopatic  (thomas@lopatic.de)
8
9 http://www.olsr.org
10
11 CONTENTS:
12
13 I.   - GENERAL INFORMATION
14      * ABOUT
15      * GETTING HOLD OF OLSRD
16      * RELEASE NOTES
17      * RFC COMPLIANCE
18      * PLUGINS
19      * LINK QUALITY ROUTING
20      * KNOWN PROBLEMS
21      * FUTURE WORK
22
23 II.  - BUILDING AND RUNNING OLSRD
24      * GENERAL INFORMATION
25      * PLUGINS
26      * GUI FRONTENDS
27
28      * LINUX
29      * WINDOWS
30      * FREEBSD
31      * OSX
32   
33
34
35 ----------------------------------------------------------------------
36  I.   - GENERAL INFORMATION
37 ----------------------------------------------------------------------
38
39 =========
40  * ABOUT
41 =========
42
43 The olsr.org OLSR daemon is an implementation of the Optimized Link State
44 routing protocol. The protocol is documented in RFC3626. The website
45 of olsrd is http://www.olsr.org
46
47 Olsrd is designed to be a modular an extensible implementation. It features
48 a plugin interface, allowing for developers to extend OLSR operation without
49 interfering with the core code. It also features a experimental link quality
50 routing scheme.
51
52 To ask questions or make comments, join up with the mailing lists:
53 olsr-dev@olsr.org   - development discussion
54 olsr-users@olsr.org - usage discussion
55
56 A bug tracker is also available at the sourceforge project site
57 http://sourceforge.net/projects/olsrd/
58
59 Olsrd source or binaries can be downloaded from olsr.org. CVS is available
60 for the cutting edge features ;-)
61
62
63 =================
64  * RELEASE NOTES
65 =================
66
67
68
69 ==================
70  * RFC COMPLIANCE
71 ==================
72
73 If olsrd is ran without using link-quality routing/MPR selection it is RFC3626
74 compliant in that it will inter-operate with other RFC3626 implementations.
75 Internally there are a few things that are solved differently that proposed 
76 in the RFC. Check out the "Conclusions" section of the "Implementing And
77 Extending The Optimized Link State routing Protocol" thesis available at
78 olsr.org.
79
80
81 ===========
82  * PLUGINS
83 ===========
84
85 Olsrd supports dynamic loading of plugins(dynamically loaded libraries) for 
86 functions like generation and processing of private package types, setting
87 olsrd configurations in run-time and much more. This design is chosen for
88 amongst others, the following reasons:
89
90  * No need to change any code in the olsr daemon to add custom packages or 
91    functionality.
92  * Users are free to implement olsrd plugins and license them under whatever 
93    terms they like.
94  * The plugins can be written in any language that can be compiled as 
95    a dynamic library. Linux even allows scripts!
96  * No need for people with extended OLSR versions to rely on heavy patching 
97    to maintain functionality when new olsrd versions are released.
98
99 OLSR provides a default forwarding algorithm that allows for forwarding of OLSR 
100 messages of unknown types. This is really neat - because it means that even if 
101 only a subset of the nodes in the network actually known how to interpret 
102 a certain message type - all nodes will forward them according to the MPR 
103 pragma. A user may want to use the optimized flooding technique in OLSR to 
104 broadcast certain information, routing related or not, to all nodes that knows 
105 how to handle this message. Services that needs to broadcast/multicast data can 
106 encapsulate data in a private OLSR message type using a olsrd plugin. 
107
108 The design of the various entities of OLSR allows one to easily add special 
109 functionality into most aspects of OLSR. One can both register functions and 
110 unregister them with the socket parser, packet parser, scheduler and HNA set etc. 
111 This opens up for possibilities like intercepting current operation and replacing 
112 it with custom actions.
113
114   Plugins that are part of this release(can be found in the lib/ directory):
115
116   - Tiny Application Server(TAS).
117
118   - HttpInfo. This plugin implements a simple HTTP server that serves dynamic
119     pages with lots of information about the running olsrd process.
120
121   - Mini.
122
123   - Nameservice.
124
125   - Dynamic Internet gateway. A plugin that dynamically adds and removes Internet
126     HNA transmissions based on if there exists a default gateway to Internet
127     with hop count = 0(non OLSR gateway). It has been extended to be able to
128     ping Internet nodes to check for connectivity as well.
129
130   - Dot draw. A plugin that produces output in the dot format representing
131     the network topology.
132
133   - Secure OLSR plugin. This plugin adds a signature to all messages
134     to ensure data integrity. This way only nodes with access to the
135     shared key can participate in the routing.
136     You need to have the OpenSSL libs installed to use this plugin.
137
138 ========================
139  * LINK QUALITY ROUTING
140 ========================
141
142 Release 0.4.8 is the first version of olsrd that implements the ETX
143 link quality metric. This enables olsrd to prefer routes that have a
144 superior overall quality to routes that are worse but consist of less
145 hops. Have a look at the README-Link-Quality.html file for details.
146
147 ==================
148  * KNOWN PROBLEMS
149 ==================
150
151 There is no synchronization concept (and thus - and for Gods sake -  no
152 code). Some plugins use threads for concurrency so this should be solved.
153
154 ===============
155  * FUTURE WORK
156 ===============
157
158 Future work concentrates on reduction of ressource (ab)use nad to make
159 it more scalable. Of course additional useful plugins are always
160 appreciated.
161
162 Future releases of the 0.4 series will be maintainance releases focused
163 on bugfixing. Work will soon begin on a 0.5 series where we will focus
164 much more on new ideas. 0.4 and 0.5 might coexist for some time. 
165
166 ----------------------------------------------------------------------
167  II.  - BUILDING AND RUNNING OLSRD
168 ----------------------------------------------------------------------
169
170 =======================
171  * GENERAL INFORMATION
172 =======================
173
174 Olsrd is implemented in pure C with very few dependencies. Olsrd is 
175 known to run on various hardware like:
176  * x86    - your regular PC
177  * PPC    - Macintosh hardware
178  * MIPSEL - Embedded systems like the LinkSys WRT54g
179  * ARM    - Embedded systems like Compaq/HP iPaq
180 A binary tarball featuring x86, MIPSEL and ARM binaries is available
181 for download at olsr.org
182
183 ===========
184  * PLUGINS
185 ===========
186
187 All the available plugins are also implemented in C and requires gcc/libc
188 to build. the dot_draw plugin compiles for Windows and GNU/Linux. the rest
189 of the plugins will only compile for GNU/Linux.
190 Building the plugins are just a matter of executing:
191 make
192 while installing requires(as root):
193 make install
194 To use the plugins add them to the olsrd configuration file.
195
196 =====================
197  * OS SUPPORT STATUS
198 =====================
199
200 COMPONENT/OS    Linux   Win32   FreeBSD NetBSD  OpenBSD OSX
201 ------------------------------------------------------------
202 olsrd           +/+     +/+     +/+     +/+     +/+     ?
203 olsr_switch     +/+     +/+     +/+     +/+     +/+     ?
204 ------------------------------------------------------------
205 PLUGINS
206 bmf             +/+     +/?     +/+     +/+     +/+     ?
207 dot_draw        +/+     +/?     +/+     +/+     +/+     ?
208 dyn_gw          +/+     +/?     +/-     +/-     +/-     ?
209 dyn_gw_plain    +/+     +/?     +/-     +/-     +/-     ?
210 httpinfo        +/+     +/+     +/+     +/+     +/+     ?
211 mini            +/+     +/?     +/+     +/+     +/+     ?
212 nameservice     +/+     +/?     +/+     +/+     +/+     ?
213 pgraph          +/+     +/+     +/+     +/+     +/+     ?
214 quagga          +/+     -/-     +/+     +/+     +/+     ?
215 secure          +/+     +/+     +/+     +/+     +/+     ?
216 tas             +/+     -       -       -       -       ?
217 txtinfo         +/+     +/+     +/+     +/+     +/+     ?
218 ------------------------------------------------------------
219
220 LEGEND:   +/+ = compiles/runs
221           +/- = compiles/does not work
222           -   = does not compile
223           ?   = unknown
224
225 =================
226  * GUI FRONTENDS
227 =================
228
229 A GUI front end for GNU/Linux using GTK is available in the gui/ 
230 directory. This implementation is no longer supported, and might
231 not work any more. It will be completly removed in a future release.
232
233 There currently is, however, a native MFC-based Windows GUI. Unlike
234 olsrd the GUI has to be compiled with Visual C++ 6. It can be found in
235 the gui/win32/ directory. Simply open the "Frontend.dsw" workspace in
236 the Visual C++ 6 IDE. Then compile "Frontend" and "Shim", which
237 creates "Switch.exe" and "Shim.exe".
238
239 To run the Windows GUI simply make sure that "Switch.exe", "Shim.exe",
240 "olsrd.exe", "olsrd_cfgparser.dll", and "Default.olsr" are located in
241 the same directory and run "Switch.exe". "Shim.exe" is just an
242 auxiliary console application that is required by "Switch.exe".
243
244 The GUI is pretty self-explanatory. The three buttons on the lower
245 right of the GUI window start the OLSR server, stop the OLSR server,
246 and exit the GUI.
247
248 Use the "Settings" tab to specify the options that the GUI uses to run
249 the OLSR server "olsrd.exe". When you click "Start" the GUI generates
250 a temporary configuration file from the information given by the
251 "Settings" tab. This temporary configuration file is passed to the
252 OLSR server via its "-f" option.
253
254 "Offer Internet connection" is only available if you have an Internet
255 connection, i.e. if you have a default route configured. If you tick
256 this option an HNA entry for the default route is added to the
257 temporary configuration file, allowing other nodes in the OLSR network
258 to use your Internet connection.
259
260 IP version 6 cannot currently be selected, as support for IPv6 is not
261 yet complete in the Windows version.
262
263 "Enable ETX link quality" tells the OLSR server to detect the quality
264 of its links to its neighbors using a variant of the ETX
265 metric. "Window size" specifies the number of most recent packets to
266 be used when calculating the packet loss. If, for example, this
267 parameter is set to 10, then the OLSR server will calculate the packet
268 loss among the most recent 10 OLSR packets received from each
269 neighbor. If "For MPR selection only" is active, the link quality
270 information is only used to select MPRs that offer the best paths to
271 your two-hop neighbors. If "For MPR selection and routing" is active,
272 the link quality is additionally used to create the routing table.
273
274 WARNING - Enabling ETX breaks compliance with the OLSR
275 standard. ETX-enabled nodes do not inter-operate with nodes that have
276 ETX switched off. DO NOT USE NODES WITH DIFFERENT ETX SETTINGS IN A
277 SINGLE NETWORK!
278
279 The three buttons on the lower right of the "Settings" tab open
280 previously saved settings, save the current settings to a
281 configuration file, and reset the current settings to default values.
282
283 If you start the GUI with the path to a configuration file as the only
284 command line argument, the GUI opens the given configuration file and
285 runs the OLSR server with this configuration. So, saving a
286 configuration file with a ".olsr" extension, for example, and making
287 "Switch.exe" the handler for ".olsr" files enables you to run the OLSR
288 server with a simple double click on the configuration file.
289
290 The "Output" tab shows the output of the currently running OLSR
291 server. The output is limited to 1000 lines. The 1001st line will make
292 the first line disappear and so on. When you click "Start" The GUI
293 simply invokes the OLSR server "olsrd.exe" and intercepts its console
294 output. Use the four buttons on the upper right of the tab to freeze
295 the output, resume frozen output, save the output to a file, or clear
296 the output.
297
298 The "Nodes" tab contains information about the nodes that the OLSR
299 server currently knows about. If you click on the address of a node in
300 the "Node list" list box, the GUI populates the three "Node
301 information" list boxes on the right with the multi-point relays of
302 the selected node (MPR), the interfaces of the selected node (MID),
303 and the non-OLSR networks accessible via the selected node (HNA).
304
305 The "Routes" tab shows the routes that the currently running OLSR
306 server has added.
307
308 The default settings for the "Settings" tab are taken from the
309 "Default.olsr" file. The configuration of the last interface in this
310 file is used to populate the per-interface settings (HELLO interval,
311 etc.) in the "Settings" tab. If you do not want to specify any
312 interface in "Default.olsr", the problem arises that you do not have
313 such a last interface. In this case simply create an interface with
314 the special name of "GUI". This tells the GUI to use the configuration
315 of the interface for the per-interface settings and to forget about
316 this interface afterward. See the comments in the "Default.olsr" file
317 for details.
318
319
320 =========
321  * LINUX
322 =========
323
324 To build olsrd you need to have all the regular development tools 
325 installed. This includes gcc, make, glibc, makedep etc.
326 To install to a directory different from /(/etc, /usr/bin) use 
327 DESTDIR=targetdir. To use other compilers set CC=yourcompiler.
328
329 To build:
330  make
331 To install(as root):
332  make install
333 To delete object files run:
334  make clean
335 Optionally, to clean all generated files:
336  make uberclean
337
338 Before running olsrd you must edit the default configuration file 
339 /etc/olsrd.conf adding at least what interfaces olsrd is to run on. 
340 Options in the config file can also be overridden by command line 
341 options. See the manual pages olsrd(8) and olsrd.conf(5) for details.
342 The binary is named 'olsrd' and is installed in (PREFIX)/usr/sbin. 
343 You must have root privileges to run olsrd!
344 To run olsrd just type:
345 olsrd
346
347 If debug level is set to 0 olsrd will detach and run in the background, 
348 if not it will keep running in your shell.
349
350 ===========
351  * WINDOWS
352 ===========
353
354 *** COMPILING
355
356 To compile the Windows version of the OLSR server or the dot_draw
357 plugin you need a Cygwin installation with a current version of GCC
358 and Mingw32. Simply use
359
360   make
361
362 to build the olsrd executable. Building the dot_draw plugin works
363 slightly different, we do not yet have a unified makefile for all
364 architectures here. Switch to the dot_draw directory lib/dot_draw/ and
365 generate the Windows makefile by saying
366
367   ./mkmf.sh
368
369 This will generate "Makefile.win32" by adding dependencies to
370 "Makefile.win32.in". Then just say
371
372   make -f Makefile.win32
373
374 to build the dot_draw plugin. However, make sure that you have build
375 olsrd before that, as the dot_draw plugin requires some object files
376 that are only generated when olsrd is built.
377
378 *** INTERFACE NAMING
379
380 On Linux network interfaces have nice names like "eth0". In contrast,
381 Windows internally identifies network interfaces by pretty awkward
382 names, for example:
383
384   "{EECD2AB6-C2FC-4826-B92E-CAA53B29D67C}"
385
386 Hence, the Windows version implements its own naming scheme that maps
387 each internal name to a made-up name like "if03", which is easier to
388 memorize. Simply invoke the OLSR server as follows to obtain its view
389 of your interfaces:
390
391   olsrd.exe -int
392
393 This lists the made-up interface names along with their current IP
394 addresses to enable you to find out which made-up interface name
395 corresponds to which of your physical interfaces.
396
397 "+" in front of the IP addresses means that the OLSR server has
398 identified the interface as a WLAN interface. "-" indicates that the
399 OLSR server considers this interface to be a wired interface. "?"
400 means "no idea". Detection currently only works on NT, 2000, and
401 XP. Windows 9x and ME will always display "?".
402
403 For techies: The made-up names consist of the string "if" followed by
404 a two-digit hex representation of the least significant byte of the
405 Windows-internal interface index, which should be different for each
406 interface and thus make each made-up name unique. Again, this is
407 undocumented and this assumption may be wrong in certain cases. So, if
408 the "-int" option reports two interfaces that have the same name,
409 please do let me know.
410
411 *** CONFIGURATION FILE
412
413 If you do not specify a configuration file, the OLSR server
414 ("olsrd.exe") by default attempts to use "olsrd.conf" in your Windows
415 directory, e.g. "C:\WINDOWS\olsrd.conf".
416
417
418 =========================
419  * FREEBSD/NETBSD/OPENBSD
420 =========================
421
422 The FreeBSD port should be relativley stable at this point.
423 The OpenBSD and NetBSD versions are pretty much untested. They have 
424 not been extensively tested beyond "doesn't core dump and it looks 
425 like it adds routes". In order to build it, you need GNU make. Then 
426 use:
427
428   gmake
429
430 to build the olsrd executable. Then do:
431
432   gmake install
433
434 to install the executable, the default configuration file, and the
435 manual pages. So, basically it's the same as on Linux. Have a look at
436 the Linux section for details.
437
438 =======
439  * OSX
440 =======
441
442 The OS X port is a direct descendant of the FreeBSD port. So, the same
443 limitations with respect to testing and maturity apply. Building and
444 installing works in the same was as on FreeBSD.
445
446
447 $Id: README,v 1.18 2007/04/03 08:46:44 bernd67 Exp $