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