bird/TODO

Core
~~~~

Globals
~~~~~~~
- right usage of DBG vs. debug
- logging and tracing; use appropriate log levels
- check incoming packets and log errors!!
- check log calls for trailing newlines and log levels followed by comma
- check if all protocols set proper packet priorities and TTL's.
- try compiling with -Wunused
- does everybody test return value of sk_open?
- protocols: implement CLI hooks and per-procotol CLI commands
- protocols: implement reconfigure hook
- protocols: use locking
- check use of system includes and sprintf()

Various ideas
~~~~~~~~~~~~~
- static: allow specifying a per-route filter program for setting route attributes?
- client: paging of output
- client: Ctrl-R eats one more enter
- bgp: timing of updates?
- netlink: realms
- netlink: import Linux route attributes to our rta's, so that they can be filtered?
- config: executable config files
- filters: user defined attributes?
- client: access control
- io: use poll if available
- IPv6 router advertisements
- real multipath (doesn't seem to be simple at all :()
- fake multipath (even less simple)
- route recalculation timing and flap dampening [see RFC2439 for algorithms]
- aggregate engine: standard route aggregation and summarization [RFC2519]
- aggregate engine: injection of manually configured pseudo-static routes
- generate default route if any working BGP connection exists (aggregate engine again?)
- generate default route to IGP's (aggregate engine yet another time?)
- look at RFC 2386 (QoS-based routing)
- cli: show tables?

OSPF
~~~~
	- refuse running on non-multicast devices
	- importing of device routes for networks where we don't run OSPF
	- check incoming packets using neighbor cache
	- RFC2328 appendix E: Use a better algorithm
	- automatic generation of external route tags (RFC1403)
	- RFC1587 NSSA areas
	- RFC2370 opaque LSA's
	- respect interface MTU and try not to create larger packets unless unavoidable

Documentation (sorry, its in czech)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Filtry:

o  Vysvetlit nesting a zastinovani.

Protocols:

o  passwords: syntaxe data uz, tusim, davno vypada jinak.

Struktura dokumentace:

o  Na konci (nebo ve zvlast sekci pro kazdy protokol?) by mel byt seznam referenci
   na vsechny mozne dokumenty, zejmena vsak vsechna RFC, kterymi se ridime nebo
   ktera maji neco spolecneho s tim, co delame (napriklad RPSL).

K jazyku:

o  K "BIRD Internet Routing Daemon" by mel patrit urcity clen.
o  Pokud je v zavorce cela veta, patri pred ')' tecka, pokud neni, tak
   nepatri.
o  Davej si pozor na rody -- router je vzdycky `it', nikdy `he'.

Jeste by to chtelo trosku podrobneji:

(1) zminit se o atributech, rici, co vsechno o route rikaji a odkazat  
    na kapitolu o filtrech, kde jsou presne nadefinovany
(2) kdyz mluvis o preferenci, mel bys rici, co to je (ze to je atribut)
    a kdo jej vlastne nastavuje (ze existuje globalni default pro typ
    protokolu, ktery muzes overridovat v konfiguraci protokolu, coz
    muzes pro konkretni routu overridovat filtrem).
(3) popsat spojeni mezi routovacimi tabulkami, filtry a protokoly


Last minute stuff:
~~~~~~~~~~~~~~~~~~
Martin:	DOC: korektury
	DOC: typograficky doladit, vyrobit titulni stranku (ta, co ji vygeneruji SGMLtools, vypada priserne)
	Zinscenovat jeste jeden poradny test OSPF
	Zjistit, kde se bude tisknout a vazat dokumentace
	DOC: Linux 2.2 je ten, kdo podporuje vice routing tables

Pavel:	RIP: programatorska dokumentace (finish)
	filtry: programatorska dokumentace
	filtry: opravit chybove hlasky !!!
	DOC: dokoncit uzivatelskou dokumentaci (viz predchozi maily)
	DOC: Pridat odkazy na RFC apod.
	Zjistit, v jake forme ma byt projekt odevzdan (kolik kopii dokumentace atd.)

Feela:	OSPF: locking
	OSPF: tracing (a zkontrolovat vsechny debug()-y), u log() uvadet kategorie a jmeno instance
	OSPF: vypnout LOCAL_DEBUG
	OSPF: ze vsech die() udelat bug() a zkontrolovat, ze to jsou opravdu interni bugy
	OSPF: reconfiguration hook
	OSPF: uzivatelska dokumentace
	OSPF: programatorska dokumentace
	OSPF: autentikace (kdyz se nestihne, nijak to nevadi)
First look at data structures. More to come tomorrow... 1998-04-22 12:58:34 +00:00			`Core`
			`~~~~`
Added skeleton of command tree. Please inspect. 1999-11-17 14:58:21 +00:00
Split off general commands to cmds.c. Added `show symbols' command which dumps whole symbol table together with symbol types etc. 2000-01-19 12:30:19 +00:00			`Globals`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-13 22:13:04 +00:00			`~~~~~~~`
			`- right usage of DBG vs. debug`
			`- logging and tracing; use appropriate log levels`
			`- check incoming packets and log errors!!`
Cleaned up debugging in kernel syncer. Netlink has still LOCAL_DEBUG turned on, but after some testing I'll gag it. 2000-03-12 21:54:39 +00:00			`- check log calls for trailing newlines and log levels followed by comma`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-13 22:13:04 +00:00			`- check if all protocols set proper packet priorities and TTL's.`
Implemented netlink protocol parsing functions. More to come tomorrow. 1999-03-01 22:31:27 +00:00			`- try compiling with -Wunused`
Fixed a couple of bugs in handling of multicast sockets. See comments in lib/socket.h for a detailed guide on how to use them. 1999-04-12 14:57:46 +00:00			`- does everybody test return value of sk_open?`
Split off general commands to cmds.c. Added `show symbols' command which dumps whole symbol table together with symbol types etc. 2000-01-19 12:30:19 +00:00			`- protocols: implement CLI hooks and per-procotol CLI commands`
Separated `official protocol names' used in status dumps from name templates used for automatic generation of instance names. protocol->name is the official name protocol->template is the name template (usually "name%d"), should be all lowercase. Updated all protocols to define the templates, checked that their configuration grammar includes proto_name which generates the name and interns it in the symbol table. 2000-01-17 11:52:50 +00:00			`- protocols: implement reconfigure hook`
TODO entries and FIXME's. 1999-12-16 12:18:33 +00:00			`- protocols: use locking`
Use bsprintf() instead of sprintf(). 2000-03-31 23:33:03 +00:00			`- check use of system includes and sprintf()`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-13 22:13:04 +00:00
			`Various ideas`
			`~~~~~~~~~~~~~`
Generated first public alpha release. Unless you object, I'll announce it today (9.5.) at noon. 2000-05-08 22:37:16 +00:00			`- static: allow specifying a per-route filter program for setting route attributes?`
Updated the TODO list with our last-minute stuff. Moved the rest to "Various ideas". 2000-06-04 20:06:42 +00:00			`- client: paging of output`
			`- client: Ctrl-R eats one more enter`
Asynchronous feeding of protocols. 2000-05-19 10:46:26 +00:00			`- bgp: timing of updates?`
Generated first public alpha release. Unless you object, I'll announce it today (9.5.) at noon. 2000-05-08 22:37:16 +00:00			`- netlink: realms`
Reimplemented neighbor cache. Now uses real hashing. 2000-03-01 14:51:47 +00:00			`- netlink: import Linux route attributes to our rta's, so that they can be filtered?`
Made `datetime' more user friendly. Now it should be a quoted string of type "dd-mm-yyyy". 2000-03-01 11:42:13 +00:00			`- config: executable config files`
When in persist mode, don't delete routes from kernel tables even if they cease to exist in our routing tables due to protocols having shut down. 2000-05-16 13:36:38 +00:00			`- filters: user defined attributes?`
Support expansion of command abbreviations. Client considered finished (modulo bugs). 2000-02-27 22:00:19 +00:00			`- client: access control`
Reimplemented neighbor cache. Now uses real hashing. 2000-03-01 14:51:47 +00:00			`- io: use poll if available`
Support expansion of command abbreviations. Client considered finished (modulo bugs). 2000-02-27 22:00:19 +00:00			`- IPv6 router advertisements`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-13 22:13:04 +00:00			`- real multipath (doesn't seem to be simple at all :()`
			`- fake multipath (even less simple)`
Pruned the TODO list. 1999-03-01 17:51:29 +00:00			`- route recalculation timing and flap dampening [see RFC2439 for algorithms]`
Basic support for IPv6. The system-dependent part doesn't work yet, but the core routines are there and seem to be working. o lib/ipv6.[ch] written o Lexical analyser recognizes IPv6 addresses and when in IPv6 mode, treats pure IPv4 addresses as router IDs. o Router ID must be configured manually on IPv6 systems. o Added SCOPE_ORGANIZATION for org-scoped IPv6 multicasts. o Fixed few places where ipa_(hton\|ntoh) was called as a function returning converted address. 1999-08-03 19:36:06 +00:00			`- aggregate engine: standard route aggregation and summarization [RFC2519]`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-13 22:13:04 +00:00			`- aggregate engine: injection of manually configured pseudo-static routes`
			`- generate default route if any working BGP connection exists (aggregate engine again?)`
			`- generate default route to IGP's (aggregate engine yet another time?)`
Basic support for IPv6. The system-dependent part doesn't work yet, but the core routines are there and seem to be working. o lib/ipv6.[ch] written o Lexical analyser recognizes IPv6 addresses and when in IPv6 mode, treats pure IPv4 addresses as router IDs. o Router ID must be configured manually on IPv6 systems. o Added SCOPE_ORGANIZATION for org-scoped IPv6 multicasts. o Fixed few places where ipa_(hton\|ntoh) was called as a function returning converted address. 1999-08-03 19:36:06 +00:00			`- look at RFC 2386 (QoS-based routing)`
When in persist mode, don't delete routes from kernel tables even if they cease to exist in our routing tables due to protocols having shut down. 2000-05-16 13:36:38 +00:00			`- cli: show tables?`
First look at data structures. More to come tomorrow... 1998-04-22 12:58:34 +00:00
BIRD library: The story continues. Complete resource manages and IP address handling. 1998-05-03 16:43:39 +00:00			`OSPF`
			`~~~~`
Tried to clean up multicast handling. Now we don't try to guess multicast abilities depending on definedness of symbols and use hard-wired system-dependent configuration defines instead. Please test whereever you can. 1999-12-16 13:06:13 +00:00			`- refuse running on non-multicast devices`
BIRD library: The story continues. Complete resource manages and IP address handling. 1998-05-03 16:43:39 +00:00			`- importing of device routes for networks where we don't run OSPF`
Pruned the TODO list. 1999-03-01 17:51:29 +00:00			`- check incoming packets using neighbor cache`
			`- RFC2328 appendix E: Use a better algorithm`
BIRD library: The story continues. Complete resource manages and IP address handling. 1998-05-03 16:43:39 +00:00			`- automatic generation of external route tags (RFC1403)`
Pruned the TODO list. 1999-03-01 17:51:29 +00:00			`- RFC1587 NSSA areas`
			`- RFC2370 opaque LSA's`
			`- respect interface MTU and try not to create larger packets unless unavoidable`
Documentation update. 2000-05-28 19:11:08 +00:00
			`Documentation (sorry, its in czech)`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
			`Filtry:`

			`o Vysvetlit nesting a zastinovani.`

			`Protocols:`

			`o passwords: syntaxe data uz, tusim, davno vypada jinak.`

			`Struktura dokumentace:`

			`o Na konci (nebo ve zvlast sekci pro kazdy protokol?) by mel byt seznam referenci`
			`na vsechny mozne dokumenty, zejmena vsak vsechna RFC, kterymi se ridime nebo`
			`ktera maji neco spolecneho s tim, co delame (napriklad RPSL).`

			`K jazyku:`

			`o K "BIRD Internet Routing Daemon" by mel patrit urcity clen.`
			`o Pokud je v zavorce cela veta, patri pred ')' tecka, pokud neni, tak`
			`nepatri.`
			o Davej si pozor na rody -- router je vzdycky `it', nikdy `he'.

More todo in documentation. 2000-05-30 10:13:15 +00:00			`Jeste by to chtelo trosku podrobneji:`

			`(1) zminit se o atributech, rici, co vsechno o route rikaji a odkazat`
			`na kapitolu o filtrech, kde jsou presne nadefinovany`
			`(2) kdyz mluvis o preferenci, mel bys rici, co to je (ze to je atribut)`
			`a kdo jej vlastne nastavuje (ze existuje globalni default pro typ`
			`protokolu, ktery muzes overridovat v konfiguraci protokolu, coz`
			`muzes pro konkretni routu overridovat filtrem).`
			`(3) popsat spojeni mezi routovacimi tabulkami, filtry a protokoly`
Updated the TODO list with our last-minute stuff. Moved the rest to "Various ideas". 2000-06-04 20:06:42 +00:00

			`Last minute stuff:`
			`~~~~~~~~~~~~~~~~~~`
			`Martin: DOC: korektury`
			`DOC: typograficky doladit, vyrobit titulni stranku (ta, co ji vygeneruji SGMLtools, vypada priserne)`
			`Zinscenovat jeste jeden poradny test OSPF`
			`Zjistit, kde se bude tisknout a vazat dokumentace`
Description of protocol module moved to where it belongs. If documentation of standard modules is stored in their source, such auxilliary files should be as well. 2000-06-05 09:51:24 +00:00			`DOC: Linux 2.2 je ten, kdo podporuje vice routing tables`
Updated the TODO list with our last-minute stuff. Moved the rest to "Various ideas". 2000-06-04 20:06:42 +00:00
			`Pavel: RIP: programatorska dokumentace (finish)`
			`filtry: programatorska dokumentace`
			`filtry: opravit chybove hlasky !!!`
			`DOC: dokoncit uzivatelskou dokumentaci (viz predchozi maily)`
			`DOC: Pridat odkazy na RFC apod.`
			`Zjistit, v jake forme ma byt projekt odevzdan (kolik kopii dokumentace atd.)`

			`Feela: OSPF: locking`
			`OSPF: tracing (a zkontrolovat vsechny debug()-y), u log() uvadet kategorie a jmeno instance`
			`OSPF: vypnout LOCAL_DEBUG`
			`OSPF: ze vsech die() udelat bug() a zkontrolovat, ze to jsou opravdu interni bugy`
			`OSPF: reconfiguration hook`
			`OSPF: uzivatelska dokumentace`
			`OSPF: programatorska dokumentace`
			`OSPF: autentikace (kdyz se nestihne, nijak to nevadi)`