bird/TODO

Core
~~~~
- config: when parsing prefix, check zero bits

- static: check validity of route destination?
- static: allow specifying a per-route filter program for setting route attributes?

- configure: default CFLAGS?

- daemonization

- netlink: realms

- filters: deletion of mandatory attributes?
- filters: user defined attributes?

- cli: show tables?
- cli: show route count (like stats, but doesn't print the routes)
- cli: show where is routed given IP address?

- client: Ctrl-R eats one more enter
- client: paging?
- client: data losses on large dumps?

- table: ocassional core dumps in rt_prune()

- bgp: timing of updates?
- bgp: dump and get_route_info

- proto: Don't show repeated `Changed state to ...' messages if only internal states change

Documentation
~~~~~~~~~~~~~
- write doctool
- write documentation :|

Globals
~~~~~~~
- right usage of DBG vs. debug
- kill preconfigs?
- check dump functions
- cleanup debugging calls
- 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.
- replace all NUM, IPA and expr tokens by constant filter expressions
- try compiling with -Wunused
- does everybody test return value of sk_open?
- doc: references to RFC's we did follow
- 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
~~~~~~~~~~~~~
- netlink: import Linux route attributes to our rta's, so that they can be filtered?
- config: executable config files
- 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)


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
First look at data structures. More to come tomorrow... 1998-04-22 20:58:34 +08:00			`Core`
			`~~~~`
Fixed a bunch of FIXME's by removing them :) 2000-03-13 06:53:05 +08:00			`- config: when parsing prefix, check zero bits`

All static routes except for device ones should work and appear/disappear when their destination comes on/off link. Deserves better testing :) See example in bird.conf. 1998-12-07 07:13:31 +08:00			`- static: check validity of route destination?`
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-04 03:36:06 +08:00			`- static: allow specifying a per-route filter program for setting route attributes?`
Finer grained logging levels: #define L_DEBUG "\001" /* Debugging messages / #define L_INFO "\002" / Informational messages / #define L_WARN "\003" / Warnings / #define L_ERR "\004" / Errors / #define L_AUTH "\005" / Authorization failed etc. / #define L_FATAL "\006" / Fatal errors / #define L_TRACE "\002" / Protocol tracing / #define L_INFO "\003" / Informational messages / #define L_REMOTE "\004" / Remote protocol errors / #define L_WARN "\004" / Local warnings / #define L_ERR "\005" / Local errors / #define L_AUTH "\006" / Authorization failed etc. / #define L_FATAL "\007" / Fatal errors / #define L_BUG "\010" / BIRD bugs */ Introduced bug() which is like die(), but with level L_BUG. Protocols should _never_ call die() as it should be used only during initialization and on irrecoverable catastrophic events like out of memory. Also introduced ASSERT() which behaves like normal assert(), but it calls bug() when assertion fails. When !defined(DEBUGGING), it gets ignored. 1998-12-20 22:24:35 +08:00
Updated TODO. 2000-05-08 22:18:33 +08:00			`- configure: default CFLAGS?`
Pruned the TODO list. 1999-08-04 03:35:01 +08:00
Updated TODO. 2000-05-08 22:18:33 +08:00			`- daemonization`
Connected the `doc' subtree to global makefiles. All documentation is built in obj/doc (resp. doc/ if you do a stand-alone build). Use `make docs' to make the whole documentation or `make userdocs' resp. `make progdocs' for user manual resp. developer's guide. 2000-05-06 01:15:56 +08:00
Updated. 2000-05-05 04:49:45 +08:00			`- netlink: realms`

Added commands `show route protocol <p>' and `show route import <p>' which show the routing table as exported to the protocol given resp. as returned from its import control hook. To get handling of filtered extended attributes right (even in the old `show route where <filter>' command), the get_route_info hook gets an attribute list and all protocol specific rte attributes are contained there as temporary ones. Updated RIP to do that. Added ea_append() which joins two ea_list's. 2000-05-07 06:57:39 +08:00			`- filters: deletion of mandatory attributes?`
Implemented `show route <...> stats'. 2000-05-07 19:28:59 +08:00			`- filters: user defined attributes?`

			`- cli: show tables?`
Updated TODO. 2000-05-08 22:18:33 +08:00			`- cli: show route count (like stats, but doesn't print the routes)`
			`- cli: show where is routed given IP address?`

			`- client: Ctrl-R eats one more enter`
			`- client: paging?`
			`- client: data losses on large dumps?`

Don't crash when the socket gets closed between updates. Also, this time not only update `remains', but update it right :) 2000-05-08 22:53:22 +08:00			`- table: ocassional core dumps in rt_prune()`

Updated TODO. 2000-05-08 22:18:33 +08:00			`- bgp: timing of updates?`
			`- bgp: dump and get_route_info`

Update `remains' counter correctly. 2000-05-08 22:32:19 +08:00			- proto: Don't show repeated `Changed state to ...' messages if only internal states change
Updated. 2000-05-05 04:49:45 +08:00
Minor cleanups. 1999-12-16 21:51:43 +08:00			`Documentation`
			`~~~~~~~~~~~~~`
			`- write doctool`
			`- write documentation :\|`
Added skeleton of command tree. Please inspect. 1999-11-17 22:58:21 +08: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 20:30:19 +08:00			`Globals`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-14 06:13:04 +08:00			`~~~~~~~`
			`- right usage of DBG vs. debug`
Changed initialization of protocol list -- now we call proto_build() instead of calling the protocols manually. Implemented printing of dynamic attributes in `show route all'. Each protocol can now register its own attribute class (protocol->attr_class, set to EAP_xxx) and also a callback for naming and formatting of attributes. The callback can return one of the following results: GA_UNKNOWN Attribute not recognized. GA_NAME Attribute name recognized and put to the buffer, generic code should format the value. GA_FULL Both attribute name and value put to the buffer. Please update protocols generating dynamic attributes to provide the attr_class and formatting hook. 2000-04-01 18:19:47 +08:00			`- kill preconfigs?`
			`- check dump functions`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-14 06:13:04 +08:00			`- cleanup debugging calls`
			`- 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-13 05:54:39 +08: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-14 06:13:04 +08:00			`- check if all protocols set proper packet priorities and TTL's.`
Updated the TODO list. 1999-03-30 04:46:00 +08:00			`- replace all NUM, IPA and expr tokens by constant filter expressions`
Implemented netlink protocol parsing functions. More to come tomorrow. 1999-03-02 06:31:27 +08: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 22:57:46 +08: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 20:30:19 +08:00			`- doc: references to RFC's we did follow`
			`- 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 19:52:50 +08:00			`- protocols: implement reconfigure hook`
TODO entries and FIXME's. 1999-12-16 20:18:33 +08:00			`- protocols: use locking`
Use bsprintf() instead of sprintf(). 2000-04-01 07:33:03 +08:00			`- check use of system includes and sprintf()`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-14 06:13:04 +08:00
			`Various ideas`
			`~~~~~~~~~~~~~`
Reimplemented neighbor cache. Now uses real hashing. 2000-03-01 22:51:47 +08: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 19:42:13 +08:00			`- config: executable config files`
Support expansion of command abbreviations. Client considered finished (modulo bugs). 2000-02-28 06:00:19 +08:00			`- client: access control`
Reimplemented neighbor cache. Now uses real hashing. 2000-03-01 22:51:47 +08:00			`- io: use poll if available`
Support expansion of command abbreviations. Client considered finished (modulo bugs). 2000-02-28 06:00:19 +08:00			`- IPv6 router advertisements`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-14 06:13:04 +08:00			`- real multipath (doesn't seem to be simple at all :()`
			`- fake multipath (even less simple)`
Pruned the TODO list. 1999-03-02 01:51:29 +08: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-04 03:36:06 +08:00			`- aggregate engine: standard route aggregation and summarization [RFC2519]`
Cleaned up TODO file. That's all for today, midnight gets closer. 1999-02-14 06:13:04 +08: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-04 03:36:06 +08:00			`- look at RFC 2386 (QoS-based routing)`
First look at data structures. More to come tomorrow... 1998-04-22 20:58:34 +08:00

BIRD library: The story continues. Complete resource manages and IP address handling. 1998-05-04 00:43:39 +08: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 21:06:13 +08:00			`- refuse running on non-multicast devices`
BIRD library: The story continues. Complete resource manages and IP address handling. 1998-05-04 00:43:39 +08:00			`- importing of device routes for networks where we don't run OSPF`
Pruned the TODO list. 1999-03-02 01:51:29 +08: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-04 00:43:39 +08:00			`- automatic generation of external route tags (RFC1403)`
Pruned the TODO list. 1999-03-02 01:51:29 +08:00			`- RFC1587 NSSA areas`
			`- RFC2370 opaque LSA's`
			`- respect interface MTU and try not to create larger packets unless unavoidable`