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