Added install of olsrd.conf manpage

[olsrd.git] / CHANGELOG

This file states changes as of version 0.2.4:
$Id: CHANGELOG,v 1.15 2004/11/22 01:22:31 tlopatic Exp $

0.4.8 ---------------------------------------------------------------------

LICENSE CHANGE

Olsrd is now distributed under a BSD style license. We belive olsrd will
be better off using this license as it opens up for commercial players
to use olsrd freely in their products. In the end this will lead to
this kind of users doing serious testing and bugfixing of olsrd. 

NO MORE THREADS

Olsrd no longer uses any thread library on its operation. Everything
now happens in the main thread allowing for use of olsrd on platforms
with no thread library.

ETX-LIKE LINK QUALITY DETECTION

We can now determine the packet loss on a link by looking at the serial
numbers of the OLSR messages received from a neighbour. This tells us how
many packets get through from our neighbour to us. We use a new extended
kind of HELLO messages (LQ_HELLO messages, LQ = link quality) to broadcast
the link quality that we have determined on our end of the link to our
neighbours. So do our neighbours, and we as well as they end up with an
idea of how good the link is in both directions. From the LQ_HELLOs we
also learn the link quality between our neighbours and our two-hop neigh-
bours. In this way we can select those neighbours as MPRs that have the
best links to our two-hop neighbours. To distribute the link quality
throughout the network, we use a new extended version of TC messages
(LQ_TC messages). They contain the qualities at both ends of each of our
links. Nodes can then run Dijkstra's algorithm to find a path between
themselves and other nodes that minimizes the packet loss.

If the newly introduced "LinkQualityLevel" is set to zero in the
configuration file, link quality is not used and the daemon behaves as
before, i.e. as specified by the OLSR RFC. If this parameter is set
to 1, LQ_HELLOs and LQ_TCs are used instead of HELLOs and TCs, link
quality is measured and MPRs are selected based on the link qualities.
If this parameter is set to 2, the routing table is additionally
calculated based on the link qualities.

Setting "LinkQualityLevel" to a non-zero value BREAKS COMPATIBILITY. You
will then not be able to participate in RFC-conformant OLSR networks
any longer. This is because we use LQ_HELLOs and LQ_TCs instead of HELLOs
and TCs in this case.

It's best practice to set "LinkQualityLevel" to the same value on all
nodes in a network.

When determining the quality of a link olsrd only considers a given
number of most recent OLSR packets received from its neighbours. By
default, olsrd looks at the 10 most recent OLSR packets. This can be
changed via the "LinkQualityWinSize" configuration option. Values
between 3 and 128 are legal.

NEW CONFIGFILE PARSER/FORMAT/SCHEME

ToDo

FREEBSD AND MAC OSX PORT

This version offers an initial port of olsrd to FreeBSD and Mac OS
X. Like the Windows port it currently does not support IPv6. As this
is a very first try at supporting FreeBSD and Mac OS X, this port is
probably not as reliable as the Linux version. We'd greatly appreciate
feedback and bug reports. To compile you need GNU make. Then simply
run "gmake OS=fbsd" to build the executable.

CLEAR SCREEN

Adding "ClearScreen yes" to the configuration file clears the screen
each time before the debug output shows updated information. This
makes the debug output easier to read in many cases. "ClearScreen no"
is the default, if no "ClearScreen" directive is given in the
configuration file.

PLUGIN INTERFACE

There are some changes in the plugin interface. It is now at
version 2. Plugin specific parameters from the configfile 
will now be passed on to plugins.

ACPI SUPPORT IN WILLINGNESS CALCULATION(LINUX)

The willingness calculation for Linux, now also supports the more
modern ACPI proc interface in addittion to APM.

IPC OPTIONS

Various options regarding IPC connections can now be set in the 
configfile. The options are max connections, allowed unicast
hosts and allowed net-ranges.

CODE REWRITES

Much of the message generation and net output code is rewritten.
Sending of partial messages should now work 100%. Also TC, MID 
and HNA messages are now cached for a random amount of time
before transmitted - this often leads to the situation where these
messages are sent together with an HELLO maessage, which is highly
desireable since it saves network resources.
PLUGIN DEVELOPERS must note that the buffers and size variables
used in net output is no longer directly accessible!

NET OUTPUT CODE REWRITTEN

Every interface now has one outputbuffer registered. This allows
messages to be "cached" as explained above, so that multiple
messages are stacked together.
Also the outputbuffer and size are no longer accessable directly,
an API is available to plugins(and olsr code).

OS DEPENDENT NETWORK INTERFACE

The OS dependen network functions are now defined in net_os.h
instead of beeing mixed up with internal network functions
in net.h.

NEW MAKEFILE

The common makefile now includes automatic dependency generation 
using makedepend.

BUGFIXES

A bug that caused the announced ANSN sequence number to never stop
beeing increased when a change in the MPR selector set was detected
has been fixed. This bug could cause unstable routes.
A bug that in many cases caused the wrong routes to be deleted 
when using IPv6 has been fixed.

PLUGINS

There are a lot of changes that affects plugins in this release.
This has mainly to do with the new outputbuffering and
configuration schemes.

0.4.7 ---------------------------------------------------------------------

NATIVE WINDOWS GUI AND INSTALLER

We now have a native Windows GUI. The GTK+ version is no longer
supported on Windows. The new native GUI is pretty compact as it does
not require the GTK+ runtime DLLs. In addition to monitoring olsrd's
state the GUI offers an easy way for novice users to configure
olsrd. It's pretty self-explanatory. Have a look at README-WIN32.txt
for details. The Windows version now also comes with an installer
based on the freely available Nullsoft Scriptable Install System
(NSIS). Looks like the Windows port is becoming more and more
Windows-ish. :-)

WIRELESS INTERFACE DETECTION ON WINDOWS

Like the Linux version the Windows port is now able to tell WLAN
interfaces from wired interfaces. We can now, for example, set
different HELLO intervals for WLAN interfaces and wired interfaces,
respectively.

ROUTE UPDATES

The order of updates of calculated routes is swapped. Now new routes
are added prior to deleting old ones. This could fix issues where
in some very very few cases one could experiment loss of routes.

BUGFIXES

There were quite some bugs in IPv6 operation in 0.4.6. These are
the bugs that were fixed:
- HNA message parsing did not work.
- Some IPv6 addresses were printed as IPv4 addresses in the
  debug output.
- The '-dispin' option now works again.
- A filedescriptor leak in the IPv6 interface detection caused
  olsrd to crash.


0.4.6 ---------------------------------------------------------------------

WINDOWS PORT!

Read the README-WIN32.txt file!

DYNAMIC NETWORK INTERFACE UPDATES

Network interfaces can now be updated and removed/added at
runtime. Olsrd will check all interfaces specified in the config 
file or on the command-line, every 5 seconds. If updates
occure, olsrd will register this and update the necessary data.
If interfaces are removed or added, olsrd will detect this
and configure the interfaces. If an interface is removed
olsrd will continue to check the interface, so if say, a PCMCIA
card is removed and later on reinserted(and given the same name),
olsrd will detect this and start running on it again.

Note that olsrd will now run even if no interfaces are detected.

ROUTE CALCULATION UPDATE

All 1 hop neighbor addresses that are not directly reachable trough
a symmetric link in the link set will now be added with a GW in the 
routing table. this GW will be an interface address from a registered
symmetric link to the neighbor.

MID UPDATE

Alias addresses are now registered in the link set processing
if available. This is not to pretty(since the vtime has to
be a mere guess) but it gives faster initial route updates.
If a HELLO is received(at initial registration) from an IP 
that is not the same as the one set as main address in the 
received HELLO header, then the IP from which the HELLO was 
received will be registered as an alias of the main address 
set in the HELLO header. The default vtime is set to 15 secs.

CODE RESTRUCTURING

All OS dependent interface configuration code is now located in
OS/ifnet.c(that would be linux/ifnet.c if using GNU/Linux).
The functions are available trough the headerfile src/ifnet.h

CODE CLEANUPS

- Some timer issues fixed
- Got rid of the global socket descriptors
- Updated indexing of network interfaces
- Introduced a global socket to use for ioctl calls(ioctl_s)
- Removed upper limit for interfaces to use
- Point-to-point interfaces are now allowed
- The main select(2) loop now uses a timeout
- A small bugfix in the select fd-set update code
- Some bugfixes in the configuration file parsing
- stdout/stderr are now set to not be buffered
- A bugfix in the MID generation regarding seq. numbering

PLUGIN INTERFCAE

A new set of functions that are called whenever a change in the 
interface configuration(update, addittion, removal) is made is 
introduced.
These functions are added and removed very much like the ptf
functions. Available trough the functions add_ifchgf and del_ifchgf.

OBS OBS OBS!!! PLUGIN DEVELOPERS READ THIS!!!!

The interface struct(declared in interfaces.h) has changed.
Plugin developers must update plugins that uses the interface
struct!

The headerfile olsr_plugin_io.h which contains the plugin interface
commands now contains a revision list where all changes are
stated.


0.4.5 ---------------------------------------------------------------------

PLUGIN: SECURE OLSR

A plugin that generates and checks message signatures is added.
Check lib/secure

PLUGIN: TOPOLOGY GRAPH

A plugin that generates output of the topology in the dot format
is added. See lib/dot_draw

OPTIMIZATIONS

Some optimizations done that should cause fewer route recalculations.

BUGFIXES

Some bugs reported by Takafumi Tanaka fixed.

RESTORATION OF NETWORK SETTINGS

Network settings like disabling of ICMP redirects and spoof filter, are
now restored at exit by olsrd.

RFC COMPLIANCE FIX

Nodes would in certain scenarios retransmit messages originating for
themselves. This was a RFC incompliance. Reported by Ingmar Baumgart.

NON-WLAN TIMERS

No longer setting the HELLO interval of non-wlan interfaces as a multiplier
of the wlan interval. The interval is set seperatly now.
Due to this there are some updates in the configfile imperatives.

CODE CLEANUPS

Some new macros introduced for table insertion and removal and IP
copying and comparision.

FRONT END BUGFIXES

IPv6 bugfixes in the GUI.


0.4.4 ---------------------------------------------------------------------

ROUTE CALCULATION

Routes are no longer added via neighbors declaring a willingness
of WILL_NEVER.

LINK SENSING AND ROUTE CALCULATION

Link sensing and route calculation has been updated to handle
multiple links between hosts in a sane way.

IP SPOOF FILTERING

IP spoof filtering is disabled on the interfaces which olsrd runs.
These settings are not restored!

ICMP REDIRECTS

ICMP redirect message generation is disabled on the interfaces
which olsrd runs.
These settings are not restored!

CONFIGFILE OPTIONS FOR MID AND HNA ADDED

Options to set the MID and HNA emission intervals and
validitytime in the configfile added.

IPv6 ADDRESS SCOPE

Option to set what IPv6 address type(scope) to use in the 
configfile added. It can be set to either global or site-local.

IPv6 MULTICAST

Options to set site-local and global multicast addresses
in the configfile added.

EMISSION INTERVAL FUNCTION

Functions to set emission intervals at runtime added.

LINK LAYER NOTIFICATIONS

If started with the -llinfo switch olsrd will collect and display
link-layer information on neighbors. This is no longer limited to
one interface. But no action is taken based on this info - and
there is a upper limit of 8 neighbors from which this info can
be collected pr. interface. This limitation is inherited from the
WLAN drivers and is not something imposed by the olsrd code!

IPv6 HNA MESSAGE FORMAT

IPv6 HNA messages now contains 128-bit netmask instead of prefix.

PLUGIN FUNCTIONS

Added "packet transform functions" which allow plugins to alter all
outgoing OLSR traffic.

RESTRUCTURING

Moved most headers out of OS dependent directories. The tunneling
and link-layer notification interface is not yet seperated from
the /linux directory.

MANUALPAGE

A manpage(olsrd(8)) describing olsrd has been created. It is installed
when using 'make install'.


0.4.3 ---------------------------------------------------------------------

PLUGIN SUPPORT

Olsrd now supports runtime-loadable plugins! A couple of example plugins
are located in the lib/ directory. Read the README files in the various 
plugin directories for more info. A directive to load plugins have been
added to the configfile as well. 
Documentation of the plugin interface can be fount at http://www.olsr.org.

The plugin interface is designed to be extendable. But it should _always_
be backwards compatible with the interface used in this release!

LINK-LAYER NOTIFICATION

Some preliminary link-layer notification code has been added. Link quality
can be written to stdout if olsrd is started with the -llinfo switch.
No action is currently taken based on this info. And info will only
be retreived from the interface named "eth1".
This code is not usable for users as of yet!

MPR UPDATES

Neighbors with willingness set to WILL_ALWAYS is now always added. The
MPR selection is optimized as described in RFC3626 section 8.3.1
point 5.

MPR BUGS

There was a couple of bugs in the MPR selection code. All fixed.

LINUX 2.6 BUG

Users could not run olsrd on multiple inerface using the Linux 2.6 kernel
series. This is now fixed.

MINOR BUGS

One small bug in link hysteresis initialization and one in HNA route
deletion.

MESSAGE-SEQUENCENUMBER INCOMPLIANCE

Message-seqnos was implementaed on a pr. messagetype and pr. interface
basis. This is not RFC3626 compliant and has been updates. All messages
and interfaces now uses a global seuencenumber.

RANDOM SEQUENCENUMBERS

Sequencenumbers are now initialized using a random value.

DAEMON MODE

Fixes for running olsrd in daemon mode(debug 0).

OPTIMIZATIONS

Optimizations based on profiling implemented.

SANITATION

Message size is checked for every massege before passing it to the
appropriate message persing function. If the size is bigger than the
remaining size of the olsr packet then the message is discarded.

GUI FRONT-END

Some minor modifications done to the gui.

INTERNAL CHANGES

Lots of changes in handling of registration and unregistration of
scheduler, socketparser, parser and local hna set.
Some restructuring and movement of functions.


0.4.2 ---------------------------------------------------------------------

No public release

0.4.1 ---------------------------------------------------------------------

No public release

0.4.0 ---------------------------------------------------------------------

LINK HYSTERESIS

Link hysteresis as described in the RFC added.

TC REDUNDANCY

TC redundancy as described in the RFC added

MPR REDUNDANCY

MPR redundancy as described in the RFC added

SCHEDULER REWRITE

The scheduler has been rewritten to register scheduled
events(function pointers) dynamically.

PARSER REWRITE

The parser has been rewritten to register parse functions
on a pr. messagetype dynamically

MALLOC WRAPPER

A wrapper for the malloc(3) syscal has been introduced.
olsr_malloc(size_t, const char *) should ALWAYS be used.

CODE RESTRUCTURING

Lots of restructuring in headerfiles.
Linux spesific code moved to subdirectory linux/
FreeBSD code to be put in freebsd/
LOTS of code restructured due to the rexrite of the scheduler
and parser.

MPR CALCULATION

Optimizing the MPR set as suggested in the RFC section
8.3.1 point 5 added.

BUGFIXES

Some bugs in MPR selection fixed.


0.3.8 ---------------------------------------------------------------------

CODE REWRITES

HNA code completeley rewritten!
The old code was really bad! Now it is much cleaner implemented and
should work fine.
One- and two-hop neighbor list structures rewritten. They now use
the same hashed double-linked lists as the rest of the information
sets use.

CODE RESTRUCTURING

Some code restructuing which resulted in the new files: timer.h,
mantissa.c, mantissa.h, hashing.c, hashing.h, linux/net.c 
linux/net.h, linux/kernel_routes.c, linux/kernel_routes.h and some 
renamed files

BUG FIXES

The bug causing errormessages on exit is fixed.
The bug that caused initial HNA routes in the GUI to display a hopcount
of 0 fixed.
IPv6 HNA netmasks were all added as /128. It's fixed now.

IPv6

Turns out sitelocal address had to be preferred to avoid IPv6 header
messing up link-sensing. Bug fixed


0.3.7 ---------------------------------------------------------------------

CODE REWRITES

The entire TC set and MPR selector set code rewritten. Hashing and
double linked lists added to the MID code.
Lots of HNA code has been rewriteen as well.

HNA bugfix

When a node lost connectivity to a HNA GW all HNA entries to that gw
was deleted. This has been fixed - and HNA entries only gets deleted
on timeout now.
Other HNA bugs have been fixed as well. But the whole HNA implementation
needs a rewrite!

Holdingtime BUGfix

There was a bug that caused holdingtime not to be properly recalculated
when using non-default emission intervals.

Forwarding and symmetric neighbors

Seems I had misread the RFC on what a 1-hop symmetric neighbor is.
Now the link-set is checked when a check for a symmetric neighbor
is done. Not the 1 hop neighbor set as it used to be. This way
the hack when receiving MID messages could be removed.

IPv6

Global addresses are now preferred. Sitelocal addresses are only used
if no global adresses are found. There have been problems where
the address set in the IP header of IPv6 packets do not match the
address chosen by OLSR.

GUI - 0.2.5

The GUI is finally updated! It can now handle piggybacked messages
and link sensing HELLO message format.


0.3.6 ---------------------------------------------------------------------

HNA support using IPv6

HNA now works using IPv6 as well! Just add the netwrok address and
prefix in the HNA6 section in the configfile. The IPv6 HNA packets differ
some from the IPv4 as they don't send the netmask but the prefix.


NEW FILENAME FOR THE BINARY AND CONFIG FILE

They are now called olsrd and olsrd.conf. I figured I'd use the olsrd
name before somebody else started using it ;-)


Config file

New options: DEBUG, HNA6 and IPC-CONNECT added to config file.


Output

A printf-wrapper hans been introduced - debug level output handeling
is much more uniform now.
The daemon sould run fine in detatched mode now(DEBUG 0)

GUI front-end

The GUI front-end can now connect and dissconnect at any time while the
daemon is running, if started using the -ipc switch or with IPC set to
'yes' in the configfile.


BUGS

A small HNA bug fixed.


0.3.5 ---------------------------------------------------------------------

Forwarding jitter

Forwarding jitter added. Messages are piggibacked if they arrive(and are to 
be forwarded) while there is data to be forwarded buffered.
Added some bugfixes to support parsing of piggybacked messages as well.

Route calculation

Fixed route calculation so that 2 hop neighbors are added. This smooths
changes from 1 hop to 2 hop neighbor out. The old way one had to wait for 
a TC before the 2 hop neighbors were added.

2 hop neighbor set

All neighbors recieved in HELLO messages are added to the two hop 
neighborhood. This helps smoothing out the 1-to-2 hop transition as well.

MID calculation

MID calculation had to be updated due to the registering of two hop neighbors
that are already one hop neighbors. They sould not be considered when calculatin
two hop coverage.

Optimalizations

Deletion of possible one hop neighbors registered on non main-addresses when
first registering MID info from a node removed. This can not occure due
to the fact that registering of neighbor nodes are done on main addresses
from link-sensing
Option to not forward messages on wired links on which they arrived removed.
This is no longer usable to any degree when adding support for piggybacking
of forwarded messages is to be implemented.

Cleanups

Some unused parameters and commandline options were removed.



0.3.3 ---------------------------------------------------------------------

TC MESSAGEING

Added sending of empty TC messages if all MPR selectors are removed. Empty
TC messages are sent for a TC_HOLD_TIME period as described in section
9.3 in the RFC.

HNA

Fixed HNA route calculations for IPv6. I forgot to upgrade this in 0.3.2

OPTIONS

-hnaint and -midint command line optionas added to set the interval
of HNA and MID generation.

FORWARDING

As an optimization messages have not been forwarded on the recieved interface
if this is registered as a non-WLAN interface. This causes problems for
people using ethernet-to-WLAN adapters. This optimalization is now turned
off by default. It can be activated using the -nofwlan option.

BUGS

THERE ARE SOME NASTY BUGS IN 0.3.2!
Fixed a bug that caused 2 hop neighbors not to time out.
Fixed a bug that caused a 1 hop neighbor timeout not to recalculate
the routing table.
Fixed a small memleak in the MID set
Fixed some smaller bugs.

IPv6 functioning is not well tested in this release.

0.3.2 ---------------------------------------------------------------------

HNA

Updated HNA to be RFC compliant. This means that all recieved HNA tuples
are registered and only the subset of uniqe entries(net/netmask) with
the smallest hocount is inserted into the routing table.

Config file

User can specify configfile name using the -f switch.

Bugs

Fixed a link-sensing bug that caused problems when using MID nodes.

0.3.1 ---------------------------------------------------------------------

MPR calculation

MPR calculation is now based on the willingness announced by nodes.

Neighbor set

The neighbor set does not have timeouts on entries any more. Creation
and deletion af neighbor entries is done from the link-set as suggested
in the RFC.

Cleanups

Gotten rid of a lot of code that became more or less obsolete due to
all the changes introduced in 0.3.0.

Bugs

Fixed a nasty bug concerning the sequence numbering of TC packets.
Fixed some bugs regarding MPR calculation - and probably introduced 
a whole new species when implementing the willingness-based calculation ;-)


0.3.0 ---------------------------------------------------------------------

Due to the extensive amount of updates this release is versioned 0.3.0

Duplicate table and forwarding

The duplicate table functionallity is totally rewritten in 100% RFC
compliance. The forward algorithm specified in the RFC is implmented
this meant rewriting much of the packet processing code. The daemon
also forwards unknown packettypes now.

Link sensing and neighbor processing

Link sensing and neighbor processing was done in the same operation in the
old code. Link sensing is now a mechanism of its own which is 100% RFC
compliant. Neighbor processing and HELLO generation has been partly 
rewritten to be RFC compliant. Neighbors are now registered as either
SYN or NOT_SYM. The NOT_NEIGH, SYM_NEIGH and MPR_NEIGH values are only
used when building HELLO messages. Links are in one of the following states:
UNSPEC_LINK, ASYM_LINK or SYM_LINK.
HELLO messages now advertise link status of neighbors on the interface
the message is transmitted.

Willingness

A node now dynamically calculates willingness based on powersource and
possibly battery power. If the node is AC powered it announces a willingness
of 6. If batterypowered the willingness is calculated as:
P / 26
Where P is percentage of power left.

Configuration file

The daemon now tries to read its configuration from the file /etc/uolsrd.conf
A "standard" configuration file is installed when doing 'make install'.
This file should be edited to fit your needs.
Command-line options can still be used to override the configuration form
the file(ore if no config file is present).
The -f switch can also be used to specify a configuration file.

Willingness

If AdvancedPowerManagemant(APM) is supported on your system the willingness
of the node is dynamically calculated based upon the powerstatus of the node.
MPR calculation based upon willingness is not done as of yet.

TC ANSN

A bugs in the TC processing fixed.

HNA

Some serious HNA bugs fixed. These bugs caused a node to always choos the 
gateway with the larges hopcout :) More seriousley - a bug caused looping
of HNA messages in certain scenarios.

Package sequence numbers

These were added. Not much use as of now - but they're there(as specified 
in the RFC).

Broadcast address

Users can now specify the broadcast address to use. Usefull if one wishes to
use the 255.255.255.255 broadcast.



0.2.5 ---------------------------------------------------------------------

Htime and Vtime

Htime and Vtime processing and handeling added. Holding times used to be 
a static value for all nodes. Now every node can signal its vlidity time
to others.
To achieve this mantissa/exponent calculation functionality was added.
Messages now include Vtime(and Htime in HELLO) values in mantissa/exponent
format instead of just zero. These values are as stated above, used as holding
time for nodes.
the GUI should be upgraded as well...

Jitter

The use of jitter in message generation intervals vere fixed.


0.2.4 ---------------------------------------------------------------------

Seqno bugs

Some bugs concerning sequence numbers in HELLO and MID message handling 
was fixed. Newly registered nodes in the neighbor and MID sets were
initialized with a seqno of 0. When using a "wraparound" sequencenumber
check(as defined in olsr_protocol.h) this can produce errors if a new
node joins a network where existing nodes has seqnos >0x00FF.

IPv6 related bugs

Some checks and copying of node addresses where done using sizeof(u_olsr32_t)
which is 32 bits. This caused only the 32 firs bits of IPv6 addresses to
be copied and checked.