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