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