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