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