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