Config is written to file insteadof stdout
[olsrd.git] / CHANGELOG
1 This file states changes as of version 0.2.4:
2
3 0.4.8 ---------------------------------------------------------------------
4
5 ACPI SUPPORT IN WILLINGNESS CALCULATION(LINUX)
6
7 The willingness calculation for Linux, now also supports the more
8 modern ACPI proc interface in addittion to APM.
9
10 CODE REWRITES
11
12 Much of the message generation and net output code is rewritten.
13 Sending of partial messages should now work 100%. Also TC, MID 
14 and HNA messages are now cached for a random amount of time
15 before transmitted - this often leads to the situation where these
16 messages are sent together with an HELLO maessage, which is highly
17 desireable since it saves network resources.
18 PLUGIN DEVELOPERS must note that the buffers and size variables
19 used in net output is no longer directly accessible!
20
21 NET OUTPUT CODE REWRITTEN
22
23 Every interface now has one outputbuffer registered. This allows
24 messages to be "cached" as explained above, so that multiple
25 messages are stacked together.
26 Also the outputbuffer and size are no longer accessable directly,
27 an API is available to plugins(and olsr code).
28
29 OS DEPENDENT NETWORK INTERFACE
30
31 The OS dependen ntework functions are now defined in net_os.h
32 instead of beeing mixed up with internal network functions
33 in net.h.
34
35 COMPILER WARNINGS
36
37 In the Linux makefile the '-Wmissing-prototypes -Wstrict-prototypes'
38 arguments has been added. All the warnings issued by gcc after
39 giving these arguments have been fixed for general- and Linux-code.
40
41 BUGFIXES
42
43 A bug that in many cases caused the wrong routes to be deleted 
44 when using IPv6 has been fixed.
45
46
47 0.4.7 ---------------------------------------------------------------------
48
49 NATIVE WINDOWS GUI AND INSTALLER
50
51 We now have a native Windows GUI. The GTK+ version is no longer
52 supported on Windows. The new native GUI is pretty compact as it does
53 not require the GTK+ runtime DLLs. In addition to monitoring olsrd's
54 state the GUI offers an easy way for novice users to configure
55 olsrd. It's pretty self-explanatory. Have a look at README-WIN32.txt
56 for details. The Windows version now also comes with an installer
57 based on the freely available Nullsoft Scriptable Install System
58 (NSIS). Looks like the Windows port is becoming more and more
59 Windows-ish. :-)
60
61 WIRELESS INTERFACE DETECTION ON WINDOWS
62
63 Like the Linux version the Windows port is now able to tell WLAN
64 interfaces from wired interfaces. We can now, for example, set
65 different HELLO intervals for WLAN interfaces and wired interfaces,
66 respectively.
67
68 ROUTE UPDATES
69
70 The order of updates of calculated routes is swapped. Now new routes
71 are added prior to deleting old ones. This could fix issues where
72 in some very very few cases one could experiment loss of routes.
73
74 BUGFIXES
75
76 There were quite some bugs in IPv6 operation in 0.4.6. These are
77 the bugs that were fixed:
78 - HNA message parsing did not work.
79 - Some IPv6 addresses were printed as IPv4 addresses in the
80   debug output.
81 - The '-dispin' option now works again.
82 - A filedescriptor leak in the IPv6 interface detection caused
83   olsrd to crash.
84
85
86 0.4.6 ---------------------------------------------------------------------
87
88 WINDOWS PORT!
89
90 Read the README-WIN32.txt file!
91
92 DYNAMIC NETWORK INTERFACE UPDATES
93
94 Network interfaces can now be updated and removed/added at
95 runtime. Olsrd will check all interfaces specified in the config 
96 file or on the command-line, every 5 seconds. If updates
97 occure, olsrd will register this and update the necessary data.
98 If interfaces are removed or added, olsrd will detect this
99 and configure the interfaces. If an interface is removed
100 olsrd will continue to check the interface, so if say, a PCMCIA
101 card is removed and later on reinserted(and given the same name),
102 olsrd will detect this and start running on it again.
103
104 Note that olsrd will now run even if no interfaces are detected.
105
106 ROUTE CALCULATION UPDATE
107
108 All 1 hop neighbor addresses that are not directly reachable trough
109 a symmetric link in the link set will now be added with a GW in the 
110 routing table. this GW will be an interface address from a registered
111 symmetric link to the neighbor.
112
113 MID UPDATE
114
115 Alias addresses are now registered in the link set processing
116 if available. This is not to pretty(since the vtime has to
117 be a mere guess) but it gives faster initial route updates.
118 If a HELLO is received(at initial registration) from an IP 
119 that is not the same as the one set as main address in the 
120 received HELLO header, then the IP from which the HELLO was 
121 received will be registered as an alias of the main address 
122 set in the HELLO header. The default vtime is set to 15 secs.
123
124 CODE RESTRUCTURING
125
126 All OS dependent interface configuration code is now located in
127 OS/ifnet.c(that would be linux/ifnet.c if using GNU/Linux).
128 The functions are available trough the headerfile src/ifnet.h
129
130 CODE CLEANUPS
131
132 - Some timer issues fixed
133 - Got rid of the global socket descriptors
134 - Updated indexing of network interfaces
135 - Introduced a global socket to use for ioctl calls(ioctl_s)
136 - Removed upper limit for interfaces to use
137 - Point-to-point interfaces are now allowed
138 - The main select(2) loop now uses a timeout
139 - A small bugfix in the select fd-set update code
140 - Some bugfixes in the configuration file parsing
141 - stdout/stderr are now set to not be buffered
142 - A bugfix in the MID generation regarding seq. numbering
143
144 PLUGIN INTERFCAE
145
146 A new set of functions that are called whenever a change in the 
147 interface configuration(update, addittion, removal) is made is 
148 introduced.
149 These functions are added and removed very much like the ptf
150 functions. Available trough the functions add_ifchgf and del_ifchgf.
151
152 OBS OBS OBS!!! PLUGIN DEVELOPERS READ THIS!!!!
153
154 The interface struct(declared in interfaces.h) has changed.
155 Plugin developers must update plugins that uses the interface
156 struct!
157
158 The headerfile olsr_plugin_io.h which contains the plugin interface
159 commands now contains a revision list where all changes are
160 stated.
161
162
163 0.4.5 ---------------------------------------------------------------------
164
165 PLUGIN: SECURE OLSR
166
167 A plugin that generates and checks message signatures is added.
168 Check lib/secure
169
170 PLUGIN: TOPOLOGY GRAPH
171
172 A plugin that generates output of the topology in the dot format
173 is added. See lib/dot_draw
174
175 OPTIMIZATIONS
176
177 Some optimizations done that should cause fewer route recalculations.
178
179 BUGFIXES
180
181 Some bugs reported by Takafumi Tanaka fixed.
182
183 RESTORATION OF NETWORK SETTINGS
184
185 Network settings like disabling of ICMP redirects and spoof filter, are
186 now restored at exit by olsrd.
187
188 RFC COMPLIANCE FIX
189
190 Nodes would in certain scenarios retransmit messages originating for
191 themselves. This was a RFC incompliance. Reported by Ingmar Baumgart.
192
193 NON-WLAN TIMERS
194
195 No longer setting the HELLO interval of non-wlan interfaces as a multiplier
196 of the wlan interval. The interval is set seperatly now.
197 Due to this there are some updates in the configfile imperatives.
198
199 CODE CLEANUPS
200
201 Some new macros introduced for table insertion and removal and IP
202 copying and comparision.
203
204 FRONT END BUGFIXES
205
206 IPv6 bugfixes in the GUI.
207
208
209 0.4.4 ---------------------------------------------------------------------
210
211 ROUTE CALCULATION
212
213 Routes are no longer added via neighbors declaring a willingness
214 of WILL_NEVER.
215
216 LINK SENSING AND ROUTE CALCULATION
217
218 Link sensing and route calculation has been updated to handle
219 multiple links between hosts in a sane way.
220
221 IP SPOOF FILTERING
222
223 IP spoof filtering is disabled on the interfaces which olsrd runs.
224 These settings are not restored!
225
226 ICMP REDIRECTS
227
228 ICMP redirect message generation is disabled on the interfaces
229 which olsrd runs.
230 These settings are not restored!
231
232 CONFIGFILE OPTIONS FOR MID AND HNA ADDED
233
234 Options to set the MID and HNA emission intervals and
235 validitytime in the configfile added.
236
237 IPv6 ADDRESS SCOPE
238
239 Option to set what IPv6 address type(scope) to use in the 
240 configfile added. It can be set to either global or site-local.
241
242 IPv6 MULTICAST
243
244 Options to set site-local and global multicast addresses
245 in the configfile added.
246
247 EMISSION INTERVAL FUNCTION
248
249 Functions to set emission intervals at runtime added.
250
251 LINK LAYER NOTIFICATIONS
252
253 If started with the -llinfo switch olsrd will collect and display
254 link-layer information on neighbors. This is no longer limited to
255 one interface. But no action is taken based on this info - and
256 there is a upper limit of 8 neighbors from which this info can
257 be collected pr. interface. This limitation is inherited from the
258 WLAN drivers and is not something imposed by the olsrd code!
259
260 IPv6 HNA MESSAGE FORMAT
261
262 IPv6 HNA messages now contains 128-bit netmask instead of prefix.
263
264 PLUGIN FUNCTIONS
265
266 Added "packet transform functions" which allow plugins to alter all
267 outgoing OLSR traffic.
268
269 RESTRUCTURING
270
271 Moved most headers out of OS dependent directories. The tunneling
272 and link-layer notification interface is not yet seperated from
273 the /linux directory.
274
275 MANUALPAGE
276
277 A manpage(olsrd(8)) describing olsrd has been created. It is installed
278 when using 'make install'.
279
280
281 0.4.3 ---------------------------------------------------------------------
282
283 PLUGIN SUPPORT
284
285 Olsrd now supports runtime-loadable plugins! A couple of example plugins
286 are located in the lib/ directory. Read the README files in the various 
287 plugin directories for more info. A directive to load plugins have been
288 added to the configfile as well. 
289 Documentation of the plugin interface can be fount at http://www.olsr.org.
290
291 The plugin interface is designed to be extendable. But it should _always_
292 be backwards compatible with the interface used in this release!
293
294 LINK-LAYER NOTIFICATION
295
296 Some preliminary link-layer notification code has been added. Link quality
297 can be written to stdout if olsrd is started with the -llinfo switch.
298 No action is currently taken based on this info. And info will only
299 be retreived from the interface named "eth1".
300 This code is not usable for users as of yet!
301
302 MPR UPDATES
303
304 Neighbors with willingness set to WILL_ALWAYS is now always added. The
305 MPR selection is optimized as described in RFC3626 section 8.3.1
306 point 5.
307
308 MPR BUGS
309
310 There was a couple of bugs in the MPR selection code. All fixed.
311
312 LINUX 2.6 BUG
313
314 Users could not run olsrd on multiple inerface using the Linux 2.6 kernel
315 series. This is now fixed.
316
317 MINOR BUGS
318
319 One small bug in link hysteresis initialization and one in HNA route
320 deletion.
321
322 MESSAGE-SEQUENCENUMBER INCOMPLIANCE
323
324 Message-seqnos was implementaed on a pr. messagetype and pr. interface
325 basis. This is not RFC3626 compliant and has been updates. All messages
326 and interfaces now uses a global seuencenumber.
327
328 RANDOM SEQUENCENUMBERS
329
330 Sequencenumbers are now initialized using a random value.
331
332 DAEMON MODE
333
334 Fixes for running olsrd in daemon mode(debug 0).
335
336 OPTIMIZATIONS
337
338 Optimizations based on profiling implemented.
339
340 SANITATION
341
342 Message size is checked for every massege before passing it to the
343 appropriate message persing function. If the size is bigger than the
344 remaining size of the olsr packet then the message is discarded.
345
346 GUI FRONT-END
347
348 Some minor modifications done to the gui.
349
350 INTERNAL CHANGES
351
352 Lots of changes in handling of registration and unregistration of
353 scheduler, socketparser, parser and local hna set.
354 Some restructuring and movement of functions.
355
356
357 0.4.2 ---------------------------------------------------------------------
358
359 No public release
360
361 0.4.1 ---------------------------------------------------------------------
362
363 No public release
364
365 0.4.0 ---------------------------------------------------------------------
366
367 LINK HYSTERESIS
368
369 Link hysteresis as described in the RFC added.
370
371 TC REDUNDANCY
372
373 TC redundancy as described in the RFC added
374
375 MPR REDUNDANCY
376
377 MPR redundancy as described in the RFC added
378
379 SCHEDULER REWRITE
380
381 The scheduler has been rewritten to register scheduled
382 events(function pointers) dynamically.
383
384 PARSER REWRITE
385
386 The parser has been rewritten to register parse functions
387 on a pr. messagetype dynamically
388
389 MALLOC WRAPPER
390
391 A wrapper for the malloc(3) syscal has been introduced.
392 olsr_malloc(size_t, const char *) should ALWAYS be used.
393
394 CODE RESTRUCTURING
395
396 Lots of restructuring in headerfiles.
397 Linux spesific code moved to subdirectory linux/
398 FreeBSD code to be put in freebsd/
399 LOTS of code restructured due to the rexrite of the scheduler
400 and parser.
401
402 MPR CALCULATION
403
404 Optimizing the MPR set as suggested in the RFC section
405 8.3.1 point 5 added.
406
407 BUGFIXES
408
409 Some bugs in MPR selection fixed.
410
411
412 0.3.8 ---------------------------------------------------------------------
413
414 CODE REWRITES
415
416 HNA code completeley rewritten!
417 The old code was really bad! Now it is much cleaner implemented and
418 should work fine.
419 One- and two-hop neighbor list structures rewritten. They now use
420 the same hashed double-linked lists as the rest of the information
421 sets use.
422
423 CODE RESTRUCTURING
424
425 Some code restructuing which resulted in the new files: timer.h,
426 mantissa.c, mantissa.h, hashing.c, hashing.h, linux/net.c 
427 linux/net.h, linux/kernel_routes.c, linux/kernel_routes.h and some 
428 renamed files
429
430 BUG FIXES
431
432 The bug causing errormessages on exit is fixed.
433 The bug that caused initial HNA routes in the GUI to display a hopcount
434 of 0 fixed.
435 IPv6 HNA netmasks were all added as /128. It's fixed now.
436
437 IPv6
438
439 Turns out sitelocal address had to be preferred to avoid IPv6 header
440 messing up link-sensing. Bug fixed
441
442
443 0.3.7 ---------------------------------------------------------------------
444
445 CODE REWRITES
446
447 The entire TC set and MPR selector set code rewritten. Hashing and
448 double linked lists added to the MID code.
449 Lots of HNA code has been rewriteen as well.
450
451 HNA bugfix
452
453 When a node lost connectivity to a HNA GW all HNA entries to that gw
454 was deleted. This has been fixed - and HNA entries only gets deleted
455 on timeout now.
456 Other HNA bugs have been fixed as well. But the whole HNA implementation
457 needs a rewrite!
458
459 Holdingtime BUGfix
460
461 There was a bug that caused holdingtime not to be properly recalculated
462 when using non-default emission intervals.
463
464 Forwarding and symmetric neighbors
465
466 Seems I had misread the RFC on what a 1-hop symmetric neighbor is.
467 Now the link-set is checked when a check for a symmetric neighbor
468 is done. Not the 1 hop neighbor set as it used to be. This way
469 the hack when receiving MID messages could be removed.
470
471 IPv6
472
473 Global addresses are now preferred. Sitelocal addresses are only used
474 if no global adresses are found. There have been problems where
475 the address set in the IP header of IPv6 packets do not match the
476 address chosen by OLSR.
477
478 GUI - 0.2.5
479
480 The GUI is finally updated! It can now handle piggybacked messages
481 and link sensing HELLO message format.
482
483
484 0.3.6 ---------------------------------------------------------------------
485
486 HNA support using IPv6
487
488 HNA now works using IPv6 as well! Just add the netwrok address and
489 prefix in the HNA6 section in the configfile. The IPv6 HNA packets differ
490 some from the IPv4 as they don't send the netmask but the prefix.
491
492
493 NEW FILENAME FOR THE BINARY AND CONFIG FILE
494
495 They are now called olsrd and olsrd.conf. I figured I'd use the olsrd
496 name before somebody else started using it ;-)
497
498
499 Config file
500
501 New options: DEBUG, HNA6 and IPC-CONNECT added to config file.
502
503
504 Output
505
506 A printf-wrapper hans been introduced - debug level output handeling
507 is much more uniform now.
508 The daemon sould run fine in detatched mode now(DEBUG 0)
509
510 GUI front-end
511
512 The GUI front-end can now connect and dissconnect at any time while the
513 daemon is running, if started using the -ipc switch or with IPC set to
514 'yes' in the configfile.
515
516
517 BUGS
518
519 A small HNA bug fixed.
520
521
522 0.3.5 ---------------------------------------------------------------------
523
524 Forwarding jitter
525
526 Forwarding jitter added. Messages are piggibacked if they arrive(and are to 
527 be forwarded) while there is data to be forwarded buffered.
528 Added some bugfixes to support parsing of piggybacked messages as well.
529
530 Route calculation
531
532 Fixed route calculation so that 2 hop neighbors are added. This smooths
533 changes from 1 hop to 2 hop neighbor out. The old way one had to wait for 
534 a TC before the 2 hop neighbors were added.
535
536 2 hop neighbor set
537
538 All neighbors recieved in HELLO messages are added to the two hop 
539 neighborhood. This helps smoothing out the 1-to-2 hop transition as well.
540
541 MID calculation
542
543 MID calculation had to be updated due to the registering of two hop neighbors
544 that are already one hop neighbors. They sould not be considered when calculatin
545 two hop coverage.
546
547 Optimalizations
548
549 Deletion of possible one hop neighbors registered on non main-addresses when
550 first registering MID info from a node removed. This can not occure due
551 to the fact that registering of neighbor nodes are done on main addresses
552 from link-sensing
553 Option to not forward messages on wired links on which they arrived removed.
554 This is no longer usable to any degree when adding support for piggybacking
555 of forwarded messages is to be implemented.
556
557 Cleanups
558
559 Some unused parameters and commandline options were removed.
560
561
562
563 0.3.3 ---------------------------------------------------------------------
564
565 TC MESSAGEING
566
567 Added sending of empty TC messages if all MPR selectors are removed. Empty
568 TC messages are sent for a TC_HOLD_TIME period as described in section
569 9.3 in the RFC.
570
571 HNA
572
573 Fixed HNA route calculations for IPv6. I forgot to upgrade this in 0.3.2
574
575 OPTIONS
576
577 -hnaint and -midint command line optionas added to set the interval
578 of HNA and MID generation.
579
580 FORWARDING
581
582 As an optimization messages have not been forwarded on the recieved interface
583 if this is registered as a non-WLAN interface. This causes problems for
584 people using ethernet-to-WLAN adapters. This optimalization is now turned
585 off by default. It can be activated using the -nofwlan option.
586
587 BUGS
588
589 THERE ARE SOME NASTY BUGS IN 0.3.2!
590 Fixed a bug that caused 2 hop neighbors not to time out.
591 Fixed a bug that caused a 1 hop neighbor timeout not to recalculate
592 the routing table.
593 Fixed a small memleak in the MID set
594 Fixed some smaller bugs.
595
596 IPv6 functioning is not well tested in this release.
597
598 0.3.2 ---------------------------------------------------------------------
599
600 HNA
601
602 Updated HNA to be RFC compliant. This means that all recieved HNA tuples
603 are registered and only the subset of uniqe entries(net/netmask) with
604 the smallest hocount is inserted into the routing table.
605
606 Config file
607
608 User can specify configfile name using the -f switch.
609
610 Bugs
611
612 Fixed a link-sensing bug that caused problems when using MID nodes.
613
614 0.3.1 ---------------------------------------------------------------------
615
616 MPR calculation
617
618 MPR calculation is now based on the willingness announced by nodes.
619
620 Neighbor set
621
622 The neighbor set does not have timeouts on entries any more. Creation
623 and deletion af neighbor entries is done from the link-set as suggested
624 in the RFC.
625
626 Cleanups
627
628 Gotten rid of a lot of code that became more or less obsolete due to
629 all the changes introduced in 0.3.0.
630
631 Bugs
632
633 Fixed a nasty bug concerning the sequence numbering of TC packets.
634 Fixed some bugs regarding MPR calculation - and probably introduced 
635 a whole new species when implementing the willingness-based calculation ;-)
636
637
638 0.3.0 ---------------------------------------------------------------------
639
640 Due to the extensive amount of updates this release is versioned 0.3.0
641
642 Duplicate table and forwarding
643
644 The duplicate table functionallity is totally rewritten in 100% RFC
645 compliance. The forward algorithm specified in the RFC is implmented
646 this meant rewriting much of the packet processing code. The daemon
647 also forwards unknown packettypes now.
648
649 Link sensing and neighbor processing
650
651 Link sensing and neighbor processing was done in the same operation in the
652 old code. Link sensing is now a mechanism of its own which is 100% RFC
653 compliant. Neighbor processing and HELLO generation has been partly 
654 rewritten to be RFC compliant. Neighbors are now registered as either
655 SYN or NOT_SYM. The NOT_NEIGH, SYM_NEIGH and MPR_NEIGH values are only
656 used when building HELLO messages. Links are in one of the following states:
657 UNSPEC_LINK, ASYM_LINK or SYM_LINK.
658 HELLO messages now advertise link status of neighbors on the interface
659 the message is transmitted.
660
661 Willingness
662
663 A node now dynamically calculates willingness based on powersource and
664 possibly battery power. If the node is AC powered it announces a willingness
665 of 6. If batterypowered the willingness is calculated as:
666 P / 26
667 Where P is percentage of power left.
668
669 Configuration file
670
671 The daemon now tries to read its configuration from the file /etc/uolsrd.conf
672 A "standard" configuration file is installed when doing 'make install'.
673 This file should be edited to fit your needs.
674 Command-line options can still be used to override the configuration form
675 the file(ore if no config file is present).
676 The -f switch can also be used to specify a configuration file.
677
678 Willingness
679
680 If AdvancedPowerManagemant(APM) is supported on your system the willingness
681 of the node is dynamically calculated based upon the powerstatus of the node.
682 MPR calculation based upon willingness is not done as of yet.
683
684 TC ANSN
685
686 A bugs in the TC processing fixed.
687
688 HNA
689
690 Some serious HNA bugs fixed. These bugs caused a node to always choos the 
691 gateway with the larges hopcout :) More seriousley - a bug caused looping
692 of HNA messages in certain scenarios.
693
694 Package sequence numbers
695
696 These were added. Not much use as of now - but they're there(as specified 
697 in the RFC).
698
699 Broadcast address
700
701 Users can now specify the broadcast address to use. Usefull if one wishes to
702 use the 255.255.255.255 broadcast.
703
704
705
706 0.2.5 ---------------------------------------------------------------------
707
708 Htime and Vtime
709
710 Htime and Vtime processing and handeling added. Holding times used to be 
711 a static value for all nodes. Now every node can signal its vlidity time
712 to others.
713 To achieve this mantissa/exponent calculation functionality was added.
714 Messages now include Vtime(and Htime in HELLO) values in mantissa/exponent
715 format instead of just zero. These values are as stated above, used as holding
716 time for nodes.
717 the GUI should be upgraded as well...
718
719 Jitter
720
721 The use of jitter in message generation intervals vere fixed.
722
723
724 0.2.4 ---------------------------------------------------------------------
725
726 Seqno bugs
727
728 Some bugs concerning sequence numbers in HELLO and MID message handling 
729 was fixed. Newly registered nodes in the neighbor and MID sets were
730 initialized with a seqno of 0. When using a "wraparound" sequencenumber
731 check(as defined in olsr_protocol.h) this can produce errors if a new
732 node joins a network where existing nodes has seqnos >0x00FF.
733
734 IPv6 related bugs
735
736 Some checks and copying of node addresses where done using sizeof(u_olsr32_t)
737 which is 32 bits. This caused only the 32 firs bits of IPv6 addresses to
738 be copied and checked.