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