93de748cdebf869962927e8ad42edbc637e38540
[olsrd.git] / CHANGELOG
1 This file states changes as of version 0.2.4:
2 $Id: CHANGELOG,v 1.82 2007/09/07 09:07:25 bernd67 Exp $
3
4 0.5.4 ---------------------------------------------------------------------
5
6 QUAGGA
7 updated to svn version 33
8
9 PATCH by Hannes Gredler <hannes@gredler.at> which rewrites the route handling.
10 To quote him:
11 ----  snip  ----
12 change list:
13 - get rid of separate routing tables for HNA and per-node routes, everything is
14   now unified in an AVL routing tree (&routingtree)
15
16 - introduce walking macros (OLSR_FOR_ALL_RT_ENTRIES()) that hide the internal
17   structure of the RIB for making life of the plugin authors easier.
18
19 - get rid of different SPF implementations for LQ and non-LQ code paths. a
20   non-LQ edge is simply substituted with a cost of 1.0
21
22 - get rid of host masks - a new data type olsr_prefix is introduced which is
23   basically an ip address plus a prefix length.
24
25   do not install the metric in the kernel FIB - for the kernel its pointless
26   if the route gets installed with a metric of N or M.
27
28   we do not need to update the kernel FIB if we have hop count only changes
29   (for example if there is a reroute action further downstream)
30
31   the only things which triggers a kernel FIB route update is a next hop
32   change (a next hop is neighboring gateway router plus an interface).
33
34   all OLSR routes are installed with a metric of 2
35
36 - separate between rt_entry and rt_path - the former is a route installed in the
37   kernel with an next hop. the latter is a candidate for best path selection
38   after SPF calculation has been done. in the rt_entry we keep a pointer to the
39   best_path and also to the next hop that was installed in the kernel FIB.
40
41   we always keep all originator of a route, if a route originator goes away we
42   can easy recompute the best path for the route.
43
44   the next hop in the rt_entry gets only updated upon a successful route_add
45   call - that way we always remember what next hop to delete.
46
47   stray routes should be history now.
48
49 - tweak the linked list toolkit to operate on circular lists.
50
51 - get rid of malloc calls for building the kernel update list. the list node is
52   now embedded in the rt_entry.
53
54 - introduce three queues (add/chg/del) for kernel updates.
55
56 - for neighbor route dependency tracking the neighbor routes are queued first or
57   last (depending on which queue you work on)
58
59 - rework all the plugins which directly manipulate rt entries.
60
61 - rework the plugins that read from the routing table (most notably nameserver,
62   httpinfo and quagga plugin)
63
64 - lots of comments that explains the intentions and purpose of this code-piece.
65
66 non RT related stuff:
67 - use a list rather than a tree for storing the post-SPF results, which further
68   improves the raw-SPF runtime.
69
70 - add display of SPF runtime (masked behind #ifdef SPF_PROFILING)
71 ----  snip  ----
72 And Sven-Ola Tuecke <mail2news@commando.de> fixed an instability issue on interface
73 up/down operations (see 102-olsrd-rt-refactoring-fixes.patch below).
74
75 PATCHES by Sven-Ola Tuecke to be found on from
76 http://download-master.berlin.freifunk.net/sven-ola/nylon/packages/olsrd/files/
77 - 102-olsrd-rt-refactoring-fixes.patch
78   Because you changed a lot of basics: It's time to handle a general
79   flaw in the routing system. Plase take a look at chk_if_changed(). This
80   will free() any "struct interface" pointer without warning at any time.
81   This is why it's possile to SEGV olsrd with a simple "ifdown xxx". 
82   The patch replaces the (maybe) invalid pointer with an index reference
83   "iif_index". You can always ask the OS for a name. Please note, that I do
84   not have a working BSD toolchain, so I've placed an #error in the IPv6
85   BSD-part where the author/porter has started to hack something funny.
86
87 - 110-olsrd-double-wlancard-neigh-hack.patch:
88   This is a hack for Nodes having to wifi cards with the same channel,
89   bssid, IP-Range etc. If two nodes can see each other by means of two
90   possible links (here: two wifi cards with equal config), a bug is  triggered
91   with the Neigh-is-SYM detections. This small little hack prevents this.
92
93 - 112-olsrd-nameservice-fixemptyname.patch:
94   This is an addon to my lat/lon stuff which will prevent olsrd from
95   running (oops?) if no hostname is given and the nameservice plugin
96   is loaded.
97
98 - 113-olsrd-dyngwplain-pluginvers5.patch:
99   This updates the dyngwplain plugin to the new Plugin Iface
100
101 - 140-olsrd-arprefreshed.patch:
102   This is a new one. Opens a packet socket and listen to UDP(698), extract
103   the sender MAC and refreshes the ARP cache whith that. Should speedup
104   especially in cases, if you initially try to use a longer routing path which
105   normally triggers a "ARP-Lookup-Chain".
106 - 106-olsrd-nameserviceparams.patch:
107   This patch converts more plugins to the new interface version.
108
109 PATCH by Arnd Hannemann <hannemann@i4.informatik.rwth-aachen.de>
110 olsr_makefile_make_use_of_exename.patch
111 - This patch makes sure that the EXENAME variable of Makefile.inc is used
112   in Makefile.
113
114 PATCHES and CLEANUPS by Bernd Petrovitsch <bernd@firmix.at>
115 - Made a function from the ME_TO_DOUBLE() macro (in src/mantissa.h).
116   This saves code throughout the code even on i386 and will even more
117   on architectures without floating point units and "-msoft-float".
118 - And the mathemathics in src/mantissa.h is reformulated to minimize
119   floating point operations to save CPU power - especially on embedded
120   devices.
121 - I rewrote the half of src/lq_packet.[ch] which deals with incoming
122   packets. This was triggered with performance output of gcc produced
123   by Sven-Ola Tuecke at CCCamp07.
124   This kills *lots* of (more than) superflous malloc()s and the same
125   number of (free()s). And it also kills some code and copying around of
126   data.
127
128 PATCHES by John Hay <jhay@meraka.org.za>
129 - update to new FreeBSD WLAN API
130 - do not require /bin/bash, use /bin/sh
131
132 - paving the way to activate -Wshadow, much more to do
133 - const-ify parameters here and there
134 - use NULL for pointers (and not "0")
135 - Killed "extern" declarations in (not generated) .c files
136
137 - Based on a patch by Gianni Costanzi <gianni.costanzi@gmail.com> (so credits
138   and thanks have to go there):
139   added OS_CFLAG_PTHREAD Makefile variable since gcc (on Linux) requests this
140   in the manual page.
141   Changes/additions:
142   - I added definitions to all OS-specific Makefile.$OS with the value similar
143     to the value in OS_LIB_PTHREAD (either empty or "-pthread").
144   - The variable is added to CPPFLAGS (and not CFLAGS) since CPPFLAGS is used
145     for all cpp and gcc calls (and gcc's man page indicates that it sets
146     variables for both of them).
147
148 0.5.3 ---------------------------------------------------------------------
149
150 URGENT BUG FIX
151 Ignacio García Pérez <iggarpe@terra.es> found a serious bug in the dot-draw
152 plugin and identified it's source.
153
154 BUG FIX
155 The bmf plugin wanted to kill a not-started thread and this causes a segmentation
156 violation. This happens if the old plugin interface support is not compiled in
157 and one uses - or more asccurate: wants to use - the bmf plugin which uses that
158 ATM. Thanks to Cedric Krier <ced@ced.homedns.org> for reporting this.
159
160 DEPENDENCIES FIXED
161 The dependencies (*.d files) are now properly generated and used. And they also
162 dependen on the Makefile in the current directory and the Makefile.inc so that
163 changes there also lead to new compilation.
164 Remember: We support "ccache" so install it to save lot of meaningless recompiles
165 if nothing (as seen by the real C compiler, i.e. after the C preprocessor) has
166 changed.
167
168 BUILD FIX
169 Linux/IA64 and Linux/HPPA also need "-fPIC".
170
171 CLEANUPS
172 - olsr_switch does no longer generate warnings
173 - olsr_switch is also built with "build_all" and cleaned with "uberclean"
174 - More "const" all over the place.
175 - More "static" for local functions and variables.
176 - Killed an unnecessary "static" variable.
177
178 0.5.2 ---------------------------------------------------------------------
179
180 URGENT BUG FIX
181 Sven-Ola Tuecke found a serious bug of the class "show stopper" and sent a patch.
182
183 PLUGIN CLEANUP
184 Plugins handle parameters quite individually (case-sensitive vs case-insensitive,
185 different parsing functions for the same values, etc.). Plugin Interface version 5
186 now exports a table of { parameter-name, parsing-function, addr-of-storage } and
187 it's size. Common functions should be shared.
188
189 0.5.1 ---------------------------------------------------------------------
190
191 MISC
192 Upgrade to olsr-bmf 1.5 from Erik Tromp <erik_tromp@hotmail.com>
193
194 latitude/longitude support is now in the nameservice plugin done by
195 Sven-Ola Tuecke <mail2news@commando.de>
196
197 added the spf refactoring patch from  Hannes Gredler <hannes@gredler.at> which
198 saves a noteworthy amount of CPU time. To quote him:
199 ----  snip  ----
200 1. use of an AVL tree as a min-heap implementation
201
202    as a means for efficient sorting.
203    (the etx metric is used as the key in the candidate tree)
204
205 2. next-hop propagation
206
207    rather than tracking the previous node in olsr_relax()
208    i have changed that model and pre-populate all one-hop neighbors
209    with their own IP adress as 'next-hop' and pull that
210    pointer up once new paths are explored.
211
212    as a result no walker for counting hops and extracting next-hops
213    is required - it turns out at this is slighly more efficient
214    than the existing behaviour (even with the cache applied).
215 ----  snip  ----
216
217 CLEANUPS
218 * moved a only locally needed hack from "union olsr_ip_addr" into the only place
219   where it is needed in hashing.c
220
221 0.5.0 ---------------------------------------------------------------------
222
223 APPLIED PATCHES FROM FREIFUNK-FIRMWARE
224 libsmake, dyngwplain, nameservices+services, tzxtinfo, quagga, quagga-routehandler,
225 optimize, fixes from Eric Tromp and Sven-Ola Tuecke, CPU-optimize, secure key, HNA-IP
226
227 CLEANUPS
228 removed hardcoded limit on the number of interfaces (at least in the Unix part)
229 made Makefile targets much more consistent
230
231 MISC
232 put Bmf-1.3 plugin into it
233
234 FreeBSD IPv6 SUPPORT
235
236 Patch from John Hay applied.
237
238 BUGFIXES
239
240 0.4.10 --------------------------------------------------------------------
241
242 OLSR NETWORK SIMULATOR
243
244 An application called olsr_switch(sorry for the nameclash with the win32 
245 GUI) has been added. If olsrd is ran using the -hint option it can now
246 connect to olsr_switch and be part of a virtual network. This means
247 that multiple instances can be ran at the same host! The olsr_switch
248 application allows the user to define link variables on all viritual
249 links in the network, creating all possible topologies. Read more in 
250 the readme file.
251
252 EXPERIMENTAL FISH EYE ALGORITHM
253
254 An experimental algorithm for TTL settings on TC messages has
255 been added. Read more in the corresponding README file.
256
257 OPENBSD SUPPORT
258
259 olsrd now also compiles on OpenBSD systems. Thanks a lot to Holger
260 Mauermann for the patches! 
261
262 BUILDSYSTEM REWRITE
263
264 Bruno has rewritten the make system. OS detection is now done
265 automagically and the general design is much improved.
266
267 IP ADDRESS VALIDATION
268
269 Olsrd now maintains a set of IP addresses that is considered
270 invalid. Checks against this set is done on all received
271 OLSR packets announced originator addresses. The dataset can
272 be updated dynamically.
273
274 PLUGIN INTERFACE
275
276 Updated interface version to 3 and added more noticeable warning 
277 for version missmatch.
278
279 MATH LIB DEPENDENCY
280
281 The dependency on the math lib came from the use of pow(3) in the
282 mantissa/exponent calculation. The calls to pow in this long forgotten 
283 code, was very unnessecarry. The pow calls are replaced with bitwise 
284 shifts and -lm is no longer needed.
285
286 ICMP REDIRECTS ON LINUX
287
288 On Linux systems "0" is now also written to the all/send_redirects
289 procfile and not only the pr. interface ones. Hopefully this resolves
290 problems reported with systems still sending ICMP redirects.
291
292 BUGFIXES
293
294 - Fixed init of IPv6 addrtype variable. It used to be uninitialized,
295   causing it to default to site-local and have some weird side-effects.
296 - Fixed crash when changing IPv6 address at run-time
297 - Fixed a bug that prevented setting willingness 0 in the configfile
298 - Fixed bad handling of missing command line arguments
299 - Did various updates to prevent assertion when a neighbor
300   has changed IP and sends HELLO before its olsrd precess has detected
301   the change.
302 - Fixed return value check on times(2) calls in the scheduler
303 - Fixed bug(s) that could cause crash when an interface was brought
304   down while olsrd was running.
305 - Removed the silent (read: unchecked) hard limit of 16 interfaces.
306 - Compiles now cleanly on 64bit (e.g. x86_64).
307
308 0.4.9 ---------------------------------------------------------------------
309
310 OPTIMIZATIONS
311
312 The MID database is now also indexed by alias addresses. this makes
313 look-ups of main addresses based on alias addresses _much_ faster.
314 The mid_lookup_main_addr function alone has gone from >30% of the
315 total CPU time used by olsrd to <1%.
316 PLUGIN DEVELOPERS: datatypes for MID entries has been changed.
317
318 Routing table calculation in the LQ case now uses balanced binary
319 trees instead of linked lists, which makes look-ups much faster.
320
321 The debug output function olsr_printf() is not used by olsrd
322 internals any more. Instead the macro OLSR_PRINTF is to be used.
323 This macro does debug level testing _before_ doing any function
324 calls(both printf itself and parameters to printf). This is a much 
325 more optimized way of doing debug output. In addition olsrd can
326 be built without any debug output code if doing 'make NODEBUG=1'.
327
328 TIMEOUT OF DATASETS
329
330 Validity times for dataset entries are now set using the clock_t type
331 (used to be struct timeval). This data is now fetched from the times(2)
332 function instead of gettimeofday(2). This prevents possible problems
333 if the system time is changed.
334 PLUGIN DEVELOPERS: Note that datatypes for close to all dataset entries
335 (link, neighbor, mid, hna, tc etc.) has been changed!!
336
337 CONFIGURATION FILE
338
339 Multiple interfaces can now use the same interface configuration block.
340 Example:
341 Interface "if0" "if1" "if2"
342 {
343         .....
344 }
345
346 Interface configurations now also support the "Weight" directive. When
347 olsrd finds multiple links to a neighbor it will choose the link
348 going via the interface with the lowest weight. Olsrd normally
349 sets this weight dynamically based on interface characteristics,
350 but if the user wishes to set a fixed weight in a interface(or
351 a group of interfaces), this directive is now available.
352
353 Moreover, interface configurations now support the "LinkQualityMult"
354 directive. It takes an IP address and a multiplier as arguments.
355
356 Example:
357
358 Interface "if0"
359 {
360   [...]
361
362   LinkQualityMult 192.168.0.1 0.7
363   LinkQualityMult default 0.5
364
365   [...]
366 }
367
368 The idea is to make certain links via the configured interface
369 artificially worse or better than they really are. The first parameter
370 specifies the IP address of a neighbour interface. The second
371 parameter is the multiplier to be applied to the link to the specified
372 neighbour interface.
373
374 After we have derived the link quality from the packet loss among the
375 packets received from the specified neighbour interface, we multiply
376 the link quality by the given multiplier. So, the multiplier changes
377 the LQ value that we use when determining the ETX, which is 1 / (LQ *
378 NLQ).
379
380 If "default" is given as the IP address then the multiplier applies to
381 all links via the configured interface. Note, however, that olsrd only
382 assigns one multiplier to each link. It does so in the following way.
383
384 * If there is a "LinkQualityMult" line that matches the IP address of
385   the link's neighbour interface, then use the multiplier in this
386   line.
387
388 * If there isn't any matching line, then look for a "default" line. If
389   there is a "default" line, then use the multiplier in this "default"
390   line.
391
392 * Otherwise use 1.0, i.e. do not modify the LQ value at all.
393
394 Hence, a line with an IP address has priority over a "default" line.
395
396 In the above example, the LQ value of the link between the local
397 interface if0 and the neighbour interface 192.168.0.1 would be
398 multiplied by 0.7. All other links between the local interface if0 and
399 a neighbour interface would be multiplied by 0.5.
400
401 IPV6 SOCKETS
402
403 The socket option IPV6_V6ONLY is now set on IPv6 sockets in linux.
404 This means that olsrd will no longer receive IPv4 traffic when
405 running in IPv6 mode.
406 This should enable users to actually run one olsrd instance using
407 IPv6 and one using IPv4 at the same time :)
408
409 PLUGINS
410
411 The httpinfo, dyn_gw and dot_draw plugins now all include olsrd
412 headerfiles directly. A plugin should define OLSR_PLUGIN before
413 including olsrd headers. Doing things this way removed the 
414 redundant datatype definitions that has so often caused trouble
415 when things has been updated in olsrd.
416
417 NETBSD SUPPORT
418
419 olsrd now also compiles on NetBSD systems. Use 'make OS=nbsd' to
420 build. This port is not very well tested and feedback is greatly
421 appreciated.
422
423 EXPERIMENTAL MULTI-INTERFACE CODE FOR FREEBSD
424
425 Experimental code using libnet can be compiled in allowing multiple
426 interfaces to be used in FreeBSD.  You enable this by compiling using
427 OS=fbsd-ll.  You must have libnet-devel installed for this to work
428 (/usr/ports/net/libnet-devel).
429
430 OTHER UPDATES
431
432 - WLAN devices are now detected in FreeBSD
433 - First specified interfaces IP is used as main address.
434 - Broadcastflag is not checked on interface if fixed broadcast is
435   set in config.
436 - Removed Linux link layer code as this was not really in use.
437 - Added -nofork command line option
438
439 BUGFIXES
440
441 - Link sensing now works according to announced vtime from
442   neighbors. Previously links going symmetric->asymmetric
443   were not necessarily detected until the holding time expired.
444 - A bug in route addition/removal that could lead to routes
445   using GWs being added before the actual route to the GW
446   was set up, has been fixed.
447 - A bug in the interface selection in route calculation has been
448   fixed. New routes are no longer added prior to deleting old ones,
449   since this caused trouble.
450 - A bug in the IPv6 multicast address configuration has been fixed.
451   This caused olsrd not to work with global IPv6 addresses.
452 - A bug in the IPv6 prefix-from IPaddr function has been fixed. This
453   bug caused HNA prefixes to always be calculated to 0.
454 - If a 2-hop neighbor is also a 1-hop neighbor, a bug made olsrd
455   prefer a bad direct link to a better link via an MPR.
456 - If a link or interface lookup failed, olsrd crashed.
457 - Fixed a crash in the LQ packet generation code based on a
458   signed/unsigned integer comparison.
459
460
461 0.4.8 ---------------------------------------------------------------------
462
463 LICENSE CHANGE
464
465 Olsrd is now distributed under a BSD style license. We believe olsrd will
466 be better off using this license as it opens up for commercial players
467 to use olsrd freely in their products. In the end this will lead to
468 this kind of users doing serious testing and bug fixing of olsrd. 
469
470 ETX-LIKE LINK QUALITY DETECTION
471
472 We can now determine the packet loss on a link by looking at the serial
473 numbers of the OLSR messages received from a neighbor. This tells us how
474 many packets get through from our neighbor to us. We use a new extended
475 kind of HELLO messages (LQ_HELLO messages, LQ = link quality) to broadcast
476 the link quality that we have determined on our end of the link to our
477 neighbors. So do our neighbors, and we as well as they end up with an
478 idea of how good the link is in both directions. From the LQ_HELLOs we
479 also learn the link quality between our neighbors and our two-hop neigh-
480 bors. In this way we can select those neighbors as MPRs that have the
481 best links to our two-hop neighbors. To distribute the link quality
482 throughout the network, we use a new extended version of TC messages
483 (LQ_TC messages). They contain the qualities at both ends of each of our
484 links. Nodes can then run Dijkstra's algorithm to find a path between
485 themselves and other nodes that minimizes the packet loss.
486
487 If the newly introduced "LinkQualityLevel" is set to zero in the
488 configuration file, link quality is not used and the daemon behaves as
489 before, i.e. as specified by the OLSR RFC. If this parameter is set
490 to 1, LQ_HELLOs and LQ_TCs are used instead of HELLOs and TCs, link
491 quality is measured and MPRs are selected based on the link qualities.
492 If this parameter is set to 2, the routing table is additionally
493 calculated based on the link qualities.
494
495 Setting "LinkQualityLevel" to a non-zero value BREAKS COMPATIBILITY. You
496 will then not be able to participate in RFC-conformant OLSR networks
497 any longer. This is because we use LQ_HELLOs and LQ_TCs instead of HELLOs
498 and TCs in this case.
499
500 It's best practice to set "LinkQualityLevel" to the same value on all
501 nodes in a network.
502
503 When determining the quality of a link olsrd only considers a given
504 number of most recent OLSR packets received from its neighbors. By
505 default, olsrd looks at the 10 most recent OLSR packets. This can be
506 changed via the "LinkQualityWinSize" configuration option. Values
507 between 3 and 128 are legal.
508
509 NEW CONFIGFILE PARSER/FORMAT/SCHEME
510
511 A whole new config file syntax and parser is introduced with this
512 release. The parser is generated using flex and bison and it is 
513 designed to be very modular. The parser can be compiled as either
514 a standalone binary, a shared library or as part of olsrd. This way
515 other applications can parse and generate olsrd configuration files
516 only by linking to the dynamic library.
517 In the new configfile options can be set pr. interface, plugin
518 parameters can be set, more IPC options can be set...and more.
519 The syntax is documented in the olsrd.conf(5) manual page found
520 in the files/ directory.
521 Olsrd internals now uses a single struct, as returned by the config
522 parser, for all configuration in runtime. this means that updating
523 values in this struct will dynamically update olsrd operation. It
524 also means that all configuration is now kept in one place instead
525 of spread all across the place.
526
527 FREEBSD AND MAC OSX PORT
528
529 This version offers an initial port of olsrd to FreeBSD and Mac OS
530 X. Like the Windows port it currently does not support IPv6. As this
531 is a very first try at supporting FreeBSD and Mac OS X, this port is
532 probably not as reliable as the Linux version. We'd greatly appreciate
533 feedback and bug reports. To compile you need GNU make. Then simply
534 run "gmake OS=fbsd" to build the executable.
535
536 NEW MAKEFILE(S)
537
538 The makefiles used to build olsrd have been rewritten and now includes
539 dependency file generation using makedep.
540
541 DEBUG OUTPUT
542
543 Tables are now only printed if changes occur, so there are no longer 
544 any periodical output when using a debuglevel >0. A "heartbeat" is 
545 now printed to STDOUT(if it is a terminal) in the form of a rotating 
546 line to show that olsrd is actually operating.
547 Adding "ClearScreen yes" to the configuration file clears the screen
548 each time before the debug output shows updated information. This
549 makes the debug output easier to read in many cases. "ClearScreen no"
550 is the default, if no "ClearScreen" directive is given in the
551 configuration file.
552
553 PLUGIN INTERFACE
554
555 There are some changes in the plugin interface. It is now at
556 version 2. Plugin specific parameters from the configfile 
557 using the PlParam option, will now be passed on to plugins.
558 To receive such parameters a plugin must implement a function:
559 int
560 register_olsr_param(char *key, char *value)
561 to which parameter pairs will be passed.
562
563 NO MORE THREADS
564
565 Olsrd no longer uses any thread library on its operation. Everything
566 now happens in the main thread allowing for use of olsrd on platforms
567 with no thread library.
568
569 ACPI SUPPORT IN WILLINGNESS CALCULATION(LINUX)
570
571 The willingness calculation for Linux, now also supports the more
572 modern ACPI proc interface in addition to APM. This is not well
573 tested and feedback is appreciated!
574
575 IPC OPTIONS
576
577 Various options regarding IPC connections can now be set in the 
578 configfile. The options are max connections, allowed unicast
579 hosts and allowed net-ranges.
580
581 CODE REWRITES
582
583 Much of the message generation and net output code is rewritten.
584 Sending of partial messages should now work 100%. Also TC, MID 
585 and HNA messages are now cached for a random amount of time
586 before transmitted - this often leads to the situation where these
587 messages are sent together with an HELLO message, which is highly
588 desirable since it saves network resources.
589 PLUGIN DEVELOPERS must note that the buffers and size variables
590 used in net output is no longer directly accessible!
591
592 NET OUTPUT CODE REWRITTEN
593
594 Every interface now has one outputbuffer registered. This allows
595 messages to be "cached" as explained above, so that multiple
596 messages are stacked together.
597 Also the outputbuffer and size are no longer accessible directly,
598 an API is available to plugins(and olsr code).
599
600 OS DEPENDENT NETWORK INTERFACE
601
602 The OS dependent network functions are now defined in net_os.h
603 instead of being mixed up with internal network functions
604 in net.h.
605
606 BUGFIXES
607
608 A bug that caused the announced ANSN sequence number to never stop
609 being increased when a change in the MPR selector set was detected
610 has been fixed. Another TC related bug that caused timed out TC
611 entries not to be deleted from the routing table in certain cases
612 has also been fixed. These bugs could cause unstable routes.
613 A bug that in many cases caused the wrong routes to be deleted 
614 when using IPv6 has been fixed.
615
616
617 0.4.7 ---------------------------------------------------------------------
618
619 NATIVE WINDOWS GUI AND INSTALLER
620
621 We now have a native Windows GUI. The GTK+ version is no longer
622 supported on Windows. The new native GUI is pretty compact as it does
623 not require the GTK+ runtime DLLs. In addition to monitoring olsrds
624 state the GUI offers an easy way for novice users to configure
625 olsrd. It's pretty self-explanatory. Have a look at README-WIN32.txt
626 for details. The Windows version now also comes with an installer
627 based on the freely available Nullsoft Scriptable Install System
628 (NSIS). Looks like the Windows port is becoming more and more
629 Windows-ish. :-)
630
631 WIRELESS INTERFACE DETECTION ON WINDOWS
632
633 Like the Linux version the Windows port is now able to tell WLAN
634 interfaces from wired interfaces. We can now, for example, set
635 different HELLO intervals for WLAN interfaces and wired interfaces,
636 respectively.
637
638 ROUTE UPDATES
639
640 The order of updates of calculated routes is swapped. Now new routes
641 are added prior to deleting old ones. This could fix issues where
642 in some very very few cases one could experiment loss of routes.
643
644 BUGFIXES
645
646 There were quite some bugs in IPv6 operation in 0.4.6. These are
647 the bugs that were fixed:
648 - HNA message parsing did not work.
649 - Some IPv6 addresses were printed as IPv4 addresses in the
650   debug output.
651 - The '-dispin' option now works again.
652 - A filedescriptor leak in the IPv6 interface detection caused
653   olsrd to crash.
654
655
656 0.4.6 ---------------------------------------------------------------------
657
658 WINDOWS PORT!
659
660 Read the README-WIN32.txt file!
661
662 DYNAMIC NETWORK INTERFACE UPDATES
663
664 Network interfaces can now be updated and removed/added at
665 runtime. Olsrd will check all interfaces specified in the config 
666 file or on the command-line, every 5 seconds. If updates
667 occur, olsrd will register this and update the necessary data.
668 If interfaces are removed or added, olsrd will detect this
669 and configure the interfaces. If an interface is removed
670 olsrd will continue to check the interface, so if say, a PCMCIA
671 card is removed and later on reinserted(and given the same name),
672 olsrd will detect this and start running on it again.
673
674 Note that olsrd will now run even if no interfaces are detected.
675
676 ROUTE CALCULATION UPDATE
677
678 All 1 hop neighbor addresses that are not directly reachable trough
679 a symmetric link in the link set will now be added with a GW in the 
680 routing table. this GW will be an interface address from a registered
681 symmetric link to the neighbor.
682
683 MID UPDATE
684
685 Alias addresses are now registered in the link set processing
686 if available. This is not to pretty(since the vtime has to
687 be a mere guess) but it gives faster initial route updates.
688 If a HELLO is received(at initial registration) from an IP 
689 that is not the same as the one set as main address in the 
690 received HELLO header, then the IP from which the HELLO was 
691 received will be registered as an alias of the main address 
692 set in the HELLO header. The default vtime is set to 15 secs.
693
694 CODE RESTRUCTURING
695
696 All OS dependent interface configuration code is now located in
697 OS/ifnet.c(that would be linux/ifnet.c if using GNU/Linux).
698 The functions are available trough the headerfile src/ifnet.h
699
700 CODE CLEANUPS
701
702 - Some timer issues fixed
703 - Got rid of the global socket descriptors
704 - Updated indexing of network interfaces
705 - Introduced a global socket to use for ioctl calls(ioctl_s)
706 - Removed upper limit for interfaces to use
707 - Point-to-point interfaces are now allowed
708 - The main select(2) loop now uses a timeout
709 - A small bugfix in the select fd-set update code
710 - Some bugfixes in the configuration file parsing
711 - stdout/stderr are now set to not be buffered
712 - A bugfix in the MID generation regarding seq. numbering
713
714 PLUGIN INTERFCAE
715
716 A new set of functions that are called whenever a change in the 
717 interface configuration(update, addition, removal) is made is 
718 introduced.
719 These functions are added and removed very much like the ptf
720 functions. Available trough the functions add_ifchgf and del_ifchgf.
721
722 OBS OBS OBS!!! PLUGIN DEVELOPERS READ THIS!!!!
723
724 The interface struct(declared in interfaces.h) has changed.
725 Plugin developers must update plugins that uses the interface
726 struct!
727
728 The headerfile olsr_plugin_io.h which contains the plugin interface
729 commands now contains a revision list where all changes are
730 stated.
731
732
733 0.4.5 ---------------------------------------------------------------------
734
735 PLUGIN: SECURE OLSR
736
737 A plugin that generates and checks message signatures is added.
738 Check lib/secure
739
740 PLUGIN: TOPOLOGY GRAPH
741
742 A plugin that generates output of the topology in the dot format
743 is added. See lib/dot_draw
744
745 OPTIMIZATIONS
746
747 Some optimizations done that should cause fewer route recalculations.
748
749 BUGFIXES
750
751 Some bugs reported by Takafumi Tanaka fixed.
752
753 RESTORATION OF NETWORK SETTINGS
754
755 Network settings like disabling of ICMP redirects and spoof filter, are
756 now restored at exit by olsrd.
757
758 RFC COMPLIANCE FIX
759
760 Nodes would in certain scenarios retransmit messages originating for
761 themselves. This was a RFC incompliance. Reported by Ingmar Baumgart.
762
763 NON-WLAN TIMERS
764
765 No longer setting the HELLO interval of non-wlan interfaces as a multiplier
766 of the wlan interval. The interval is set seperatly now.
767 Due to this there are some updates in the configfile imperatives.
768
769 CODE CLEANUPS
770
771 Some new macros introduced for table insertion and removal and IP
772 copying and comparison.
773
774 FRONT END BUGFIXES
775
776 IPv6 bugfixes in the GUI.
777
778
779 0.4.4 ---------------------------------------------------------------------
780
781 ROUTE CALCULATION
782
783 Routes are no longer added via neighbors declaring a willingness
784 of WILL_NEVER.
785
786 LINK SENSING AND ROUTE CALCULATION
787
788 Link sensing and route calculation has been updated to handle
789 multiple links between hosts in a sane way.
790
791 IP SPOOF FILTERING
792
793 IP spoof filtering is disabled on the interfaces which olsrd runs.
794 These settings are not restored!
795
796 ICMP REDIRECTS
797
798 ICMP redirect message generation is disabled on the interfaces
799 which olsrd runs.
800 These settings are not restored!
801
802 CONFIGFILE OPTIONS FOR MID AND HNA ADDED
803
804 Options to set the MID and HNA emission intervals and
805 validity time in the configfile added.
806
807 IPv6 ADDRESS SCOPE
808
809 Option to set what IPv6 address type(scope) to use in the 
810 configfile added. It can be set to either global or site-local.
811
812 IPv6 MULTICAST
813
814 Options to set site-local and global multicast addresses
815 in the configfile added.
816
817 EMISSION INTERVAL FUNCTION
818
819 Functions to set emission intervals at runtime added.
820
821 LINK LAYER NOTIFICATIONS
822
823 If started with the -llinfo switch olsrd will collect and display
824 link-layer information on neighbors. This is no longer limited to
825 one interface. But no action is taken based on this info - and
826 there is a upper limit of 8 neighbors from which this info can
827 be collected pr. interface. This limitation is inherited from the
828 WLAN drivers and is not something imposed by the olsrd code!
829
830 IPv6 HNA MESSAGE FORMAT
831
832 IPv6 HNA messages now contains 128-bit netmask instead of prefix.
833
834 PLUGIN FUNCTIONS
835
836 Added "packet transform functions" which allow plugins to alter all
837 outgoing OLSR traffic.
838
839 RESTRUCTURING
840
841 Moved most headers out of OS dependent directories. The tunneling
842 and link-layer notification interface is not yet separated from
843 the /linux directory.
844
845 MANUALPAGE
846
847 A manpage(olsrd(8)) describing olsrd has been created. It is installed
848 when using 'make install'.
849
850
851 0.4.3 ---------------------------------------------------------------------
852
853 PLUGIN SUPPORT
854
855 Olsrd now supports runtime-loadable plugins! A couple of example plugins
856 are located in the lib/ directory. Read the README files in the various 
857 plugin directories for more info. A directive to load plugins have been
858 added to the configfile as well. 
859 Documentation of the plugin interface can be fount at http://www.olsr.org.
860
861 The plugin interface is designed to be extendable. But it should _always_
862 be backwards compatible with the interface used in this release!
863
864 LINK-LAYER NOTIFICATION
865
866 Some preliminary link-layer notification code has been added. Link quality
867 can be written to stdout if olsrd is started with the -llinfo switch.
868 No action is currently taken based on this info. And info will only
869 be retrieved from the interface named "eth1".
870 This code is not usable for users as of yet!
871
872 MPR UPDATES
873
874 Neighbors with willingness set to WILL_ALWAYS is now always added. The
875 MPR selection is optimized as described in RFC3626 section 8.3.1
876 point 5.
877
878 MPR BUGS
879
880 There was a couple of bugs in the MPR selection code. All fixed.
881
882 LINUX 2.6 BUG
883
884 Users could not run olsrd on multiple interfaces using the Linux 2.6 kernel
885 series. This is now fixed.
886
887 MINOR BUGS
888
889 One small bug in link hysteresis initialization and one in HNA route
890 deletion.
891
892 MESSAGE-SEQUENCENUMBER INCOMPLIANCE
893
894 Message-seqnos was implemented on a pr. messagetype and pr. interface
895 basis. This is not RFC3626 compliant and has been updates. All messages
896 and interfaces now uses a global seuencenumber.
897
898 RANDOM SEQUENCENUMBERS
899
900 Sequencenumbers are now initialized using a random value.
901
902 DAEMON MODE
903
904 Fixes for running olsrd in daemon mode(debug 0).
905
906 OPTIMIZATIONS
907
908 Optimizations based on profiling implemented.
909
910 SANITATION
911
912 Message size is checked for every message before passing it to the
913 appropriate message parsing function. If the size is bigger than the
914 remaining size of the olsr packet then the message is discarded.
915
916 GUI FRONT-END
917
918 Some minor modifications done to the gui.
919
920 INTERNAL CHANGES
921
922 Lots of changes in handling of registration and unregistration of
923 scheduler, socketparser, parser and local hna set.
924 Some restructuring and movement of functions.
925
926
927 0.4.2 ---------------------------------------------------------------------
928
929 No public release
930
931 0.4.1 ---------------------------------------------------------------------
932
933 No public release
934
935 0.4.0 ---------------------------------------------------------------------
936
937 LINK HYSTERESIS
938
939 Link hysteresis as described in the RFC added.
940
941 TC REDUNDANCY
942
943 TC redundancy as described in the RFC added
944
945 MPR REDUNDANCY
946
947 MPR redundancy as described in the RFC added
948
949 SCHEDULER REWRITE
950
951 The scheduler has been rewritten to register scheduled
952 events(function pointers) dynamically.
953
954 PARSER REWRITE
955
956 The parser has been rewritten to register parse functions
957 on a pr. messagetype dynamically
958
959 MALLOC WRAPPER
960
961 A wrapper for the malloc(3) syscal has been introduced.
962 olsr_malloc(size_t, const char *) should ALWAYS be used.
963
964 CODE RESTRUCTURING
965
966 Lots of restructuring in headerfiles.
967 Linux spesific code moved to subdirectory linux/
968 FreeBSD code to be put in freebsd/
969 LOTS of code restructured due to the rexrite of the scheduler
970 and parser.
971
972 MPR CALCULATION
973
974 Optimizing the MPR set as suggested in the RFC section
975 8.3.1 point 5 added.
976
977 BUGFIXES
978
979 Some bugs in MPR selection fixed.
980
981
982 0.3.8 ---------------------------------------------------------------------
983
984 CODE REWRITES
985
986 HNA code completely rewritten!
987 The old code was really bad! Now it is much cleaner implemented and
988 should work fine.
989 One- and two-hop neighbor list structures rewritten. They now use
990 the same hashed double-linked lists as the rest of the information
991 sets use.
992
993 CODE RESTRUCTURING
994
995 Some code restructuring which resulted in the new files: timer.h,
996 mantissa.c, mantissa.h, hashing.c, hashing.h, linux/net.c 
997 linux/net.h, linux/kernel_routes.c, linux/kernel_routes.h and some 
998 renamed files
999
1000 BUG FIXES
1001
1002 The bug causing errormessages on exit is fixed.
1003 The bug that caused initial HNA routes in the GUI to display a hopcount
1004 of 0 fixed.
1005 IPv6 HNA netmasks were all added as /128. It's fixed now.
1006
1007 IPv6
1008
1009 Turns out sitelocal address had to be preferred to avoid IPv6 header
1010 messing up link-sensing. Bug fixed
1011
1012
1013 0.3.7 ---------------------------------------------------------------------
1014
1015 CODE REWRITES
1016
1017 The entire TC set and MPR selector set code rewritten. Hashing and
1018 double linked lists added to the MID code.
1019 Lots of HNA code has been rewritten as well.
1020
1021 HNA bugfix
1022
1023 When a node lost connectivity to a HNA GW all HNA entries to that gw
1024 was deleted. This has been fixed - and HNA entries only gets deleted
1025 on timeout now.
1026 Other HNA bugs have been fixed as well. But the whole HNA implementation
1027 needs a rewrite!
1028
1029 Holdingtime BUGfix
1030
1031 There was a bug that caused holdingtime not to be properly recalculated
1032 when using non-default emission intervals.
1033
1034 Forwarding and symmetric neighbors
1035
1036 Seems I had misread the RFC on what a 1-hop symmetric neighbor is.
1037 Now the link-set is checked when a check for a symmetric neighbor
1038 is done. Not the 1 hop neighbor set as it used to be. This way
1039 the hack when receiving MID messages could be removed.
1040
1041 IPv6
1042
1043 Global addresses are now preferred. Sitelocal addresses are only used
1044 if no global addresses are found. There have been problems where
1045 the address set in the IP header of IPv6 packets do not match the
1046 address chosen by OLSR.
1047
1048 GUI - 0.2.5
1049
1050 The GUI is finally updated! It can now handle piggybacked messages
1051 and link sensing HELLO message format.
1052
1053
1054 0.3.6 ---------------------------------------------------------------------
1055
1056 HNA support using IPv6
1057
1058 HNA now works using IPv6 as well! Just add the network address and
1059 prefix in the HNA6 section in the configfile. The IPv6 HNA packets differ
1060 some from the IPv4 as they don't send the netmask but the prefix.
1061
1062
1063 NEW FILENAME FOR THE BINARY AND CONFIG FILE
1064
1065 They are now called olsrd and olsrd.conf. I figured I'd use the olsrd
1066 name before somebody else started using it ;-)
1067
1068
1069 Config file
1070
1071 New options: DEBUG, HNA6 and IPC-CONNECT added to config file.
1072
1073
1074 Output
1075
1076 A printf-wrapper has been introduced - debug level output handling
1077 is much more uniform now.
1078 The daemon should run fine in detached mode now(DEBUG 0)
1079
1080 GUI front-end
1081
1082 The GUI front-end can now connect and disconnect at any time while the
1083 daemon is running, if started using the -ipc switch or with IPC set to
1084 'yes' in the configfile.
1085
1086
1087 BUGS
1088
1089 A small HNA bug fixed.
1090
1091
1092 0.3.5 ---------------------------------------------------------------------
1093
1094 Forwarding jitter
1095
1096 Forwarding jitter added. Messages are piggybacked if they arrive(and are to 
1097 be forwarded) while there is data to be forwarded buffered.
1098 Added some bugfixes to support parsing of piggybacked messages as well.
1099
1100 Route calculation
1101
1102 Fixed route calculation so that 2 hop neighbors are added. This smooths
1103 changes from 1 hop to 2 hop neighbor out. The old way one had to wait for 
1104 a TC before the 2 hop neighbors were added.
1105
1106 2 hop neighbor set
1107
1108 All neighbors received in HELLO messages are added to the two hop 
1109 neighborhood. This helps smoothing out the 1-to-2 hop transition as well.
1110
1111 MID calculation
1112
1113 MID calculation had to be updated due to the registering of two hop neighbors
1114 that are already one hop neighbors. They should not be considered when calculating
1115 two hop coverage.
1116
1117 Optimizations
1118
1119 Deletion of possible one hop neighbors registered on non main-addresses when
1120 first registering MID info from a node removed. This can not occur due
1121 to the fact that registering of neighbor nodes are done on main addresses
1122 from link-sensing
1123 Option to not forward messages on wired links on which they arrived removed.
1124 This is no longer usable to any degree when adding support for piggybacking
1125 of forwarded messages is to be implemented.
1126
1127 Cleanups
1128
1129 Some unused parameters and commandline options were removed.
1130
1131
1132
1133 0.3.3 ---------------------------------------------------------------------
1134
1135 TC MESSAGEING
1136
1137 Added sending of empty TC messages if all MPR selectors are removed. Empty
1138 TC messages are sent for a TC_HOLD_TIME period as described in section
1139 9.3 in the RFC.
1140
1141 HNA
1142
1143 Fixed HNA route calculations for IPv6. I forgot to upgrade this in 0.3.2
1144
1145 OPTIONS
1146
1147 -hnaint and -midint command line optionas added to set the interval
1148 of HNA and MID generation.
1149
1150 FORWARDING
1151
1152 As an optimization messages have not been forwarded on the received interface
1153 if this is registered as a non-WLAN interface. This causes problems for
1154 people using Ethernet-to-WLAN adapters. This optimization is now turned
1155 off by default. It can be activated using the -nofwlan option.
1156
1157 BUGS
1158
1159 THERE ARE SOME NASTY BUGS IN 0.3.2!
1160 Fixed a bug that caused 2 hop neighbors not to time out.
1161 Fixed a bug that caused a 1 hop neighbor timeout not to recalculate
1162 the routing table.
1163 Fixed a small memleak in the MID set
1164 Fixed some smaller bugs.
1165
1166 IPv6 functioning is not well tested in this release.
1167
1168 0.3.2 ---------------------------------------------------------------------
1169
1170 HNA
1171
1172 Updated HNA to be RFC compliant. This means that all received HNA tuples
1173 are registered and only the subset of unique entries(net/netmask) with
1174 the smallest hopcount is inserted into the routing table.
1175
1176 Config file
1177
1178 User can specify configfile name using the -f switch.
1179
1180 Bugs
1181
1182 Fixed a link-sensing bug that caused problems when using MID nodes.
1183
1184 0.3.1 ---------------------------------------------------------------------
1185
1186 MPR calculation
1187
1188 MPR calculation is now based on the willingness announced by nodes.
1189
1190 Neighbor set
1191
1192 The neighbor set does not have timeouts on entries any more. Creation
1193 and deletion of neighbor entries is done from the link-set as suggested
1194 in the RFC.
1195
1196 Cleanups
1197
1198 Gotten rid of a lot of code that became more or less obsolete due to
1199 all the changes introduced in 0.3.0.
1200
1201 Bugs
1202
1203 Fixed a nasty bug concerning the sequence numbering of TC packets.
1204 Fixed some bugs regarding MPR calculation - and probably introduced 
1205 a whole new species when implementing the willingness-based calculation ;-)
1206
1207
1208 0.3.0 ---------------------------------------------------------------------
1209
1210 Due to the extensive amount of updates this release is versioned 0.3.0
1211
1212 Duplicate table and forwarding
1213
1214 The duplicate table functionality is totally rewritten in 100% RFC
1215 compliance. The forward algorithm specified in the RFC is implemented
1216 this meant rewriting much of the packet processing code. The daemon
1217 also forwards unknown packettypes now.
1218
1219 Link sensing and neighbor processing
1220
1221 Link sensing and neighbor processing was done in the same operation in the
1222 old code. Link sensing is now a mechanism of its own which is 100% RFC
1223 compliant. Neighbor processing and HELLO generation has been partly 
1224 rewritten to be RFC compliant. Neighbors are now registered as either
1225 SYN or NOT_SYM. The NOT_NEIGH, SYM_NEIGH and MPR_NEIGH values are only
1226 used when building HELLO messages. Links are in one of the following states:
1227 UNSPEC_LINK, ASYM_LINK or SYM_LINK.
1228 HELLO messages now advertise link status of neighbors on the interface
1229 the message is transmitted.
1230
1231 Willingness
1232
1233 A node now dynamically calculates willingness based on powersource and
1234 possibly battery power. If the node is AC powered it announces a willingness
1235 of 6. If batterypowered the willingness is calculated as:
1236 P / 26
1237 Where P is percentage of power left.
1238
1239 Configuration file
1240
1241 The daemon now tries to read its configuration from the file /etc/uolsrd.conf
1242 A "standard" configuration file is installed when doing 'make install'.
1243 This file should be edited to fit your needs.
1244 Command-line options can still be used to override the configuration form
1245 the file(ore if no config file is present).
1246 The -f switch can also be used to specify a configuration file.
1247
1248 Willingness
1249
1250 If AdvancedPowerManagemant(APM) is supported on your system the willingness
1251 of the node is dynamically calculated based upon the powerstatus of the node.
1252 MPR calculation based upon willingness is not done as of yet.
1253
1254 TC ANSN
1255
1256 A bugs in the TC processing fixed.
1257
1258 HNA
1259
1260 Some serious HNA bugs fixed. These bugs caused a node to always choos the 
1261 gateway with the larges hopcout :) More seriously - a bug caused looping
1262 of HNA messages in certain scenarios.
1263
1264 Package sequence numbers
1265
1266 These were added. Not much use as of now - but they're there(as specified 
1267 in the RFC).
1268
1269 Broadcast address
1270
1271 Users can now specify the broadcast address to use. Useful if one wishes to
1272 use the 255.255.255.255 broadcast.
1273
1274
1275
1276 0.2.5 ---------------------------------------------------------------------
1277
1278 Htime and Vtime
1279
1280 Htime and Vtime processing and handling added. Holding times used to be 
1281 a static value for all nodes. Now every node can signal its vlidity time
1282 to others.
1283 To achieve this mantissa/exponent calculation functionality was added.
1284 Messages now include Vtime(and Htime in HELLO) values in mantissa/exponent
1285 format instead of just zero. These values are as stated above, used as holding
1286 time for nodes.
1287 the GUI should be upgraded as well...
1288
1289 Jitter
1290
1291 The use of jitter in message generation intervals vere fixed.
1292
1293
1294 0.2.4 ---------------------------------------------------------------------
1295
1296 Seqno bugs
1297
1298 Some bugs concerning sequence numbers in HELLO and MID message handling 
1299 was fixed. Newly registered nodes in the neighbor and MID sets were
1300 initialized with a seqno of 0. When using a "wraparound" sequencenumber
1301 check(as defined in olsr_protocol.h) this can produce errors if a new
1302 node joins a network where existing nodes has seqnos >0x00FF.
1303
1304 IPv6 related bugs
1305
1306 Some checks and copying of node addresses where done using sizeof(u_olsr32_t)
1307 which is 32 bits. This caused only the 32 firs bits of IPv6 addresses to
1308 be copied and checked.