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