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