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