kmod/TODO

Features:
=========

* config: configs that do not need to be matched by fnmatch() could be using a
  vector instead of a list. This way we could search in it by calling
  bsearch().

* index: drop the "open(), seek(), read()" implementation and use another one
  with mmap(). When lookup() is called and the file is not mmaped, mmap it.

* create test-mock library to be LD_PRELOAD'ed before running the binaries
  so we're able to create unit tests

* Add functions to dump configuration

* Add functions list all modules known by modules.dep

* provide 1:1 compatibility with module-init-tools's modprobe
   - dump configuration
   - 'modprobe -r' should remove modules which usecount became 0 because of
     module's removal

* provide depmod:
   - 1:1 compatible kmod-depmod.c
   - add missing -F and -E

* review API, maybe unify all of these setters:
   - kmod_module_version_get_symbol()
   - kmod_module_version_get_crc()
   - kmod_module_symbol_get_symbol()
   - kmod_module_symbol_get_crc()
   - kmod_module_dependency_symbol_get_symbol()
   - kmod_module_dependency_symbol_get_crc()
   - kmod_module_versions_free_list()
   - kmod_module_symbols_free_list()
   - kmod_module_dependency_symbols_free_list()

* provide modules.archive, a cache file with all modules compressed
  and a fast access. It's like a tar.gz, but with each entry
  compressed as opposed to the whole tar compressed, easy to pick
  individual entries, that is, more like .gz.tar. As zlib compression
  does not store the uncompressed file size, this could provide
  it. The file format should be something like:
     MAGIC-ID
     DIRECTORY-ENTRY-SIZE
     DIRECTORY (hash-like format, points to file offset and size)
     ENTRIES (each is a compressed module)
  Helper binary to:
     kmod-archive list
     kmod-archive add path.ko
     kmod-archive rm path.ko
     kmod-archive get path.ko
     kmod-archive exists path.ko

Known Bugs:
===========


Things to be added removed in kernel (check what is really needed):
===================================================================

* list of currently loaded modules

* module's size should be available under /sys

* kill /proc/modules ?
Add TODO file with a few items 2011-12-02 03:23:47 +07:00			`Features:`
TODO: add new tasks and notes to future development 2011-12-16 11:02:58 +07:00			`=========`
Add TODO file with a few items 2011-12-02 03:23:47 +07:00
			`* config: configs that do not need to be matched by fnmatch() could be using a`
			`vector instead of a list. This way we could search in it by calling`
			`bsearch().`

TODO: update tasks 2011-12-02 23:49:57 +07:00			`* index: drop the "open(), seek(), read()" implementation and use another one`
			`with mmap(). When lookup() is called and the file is not mmaped, mmap it.`

tools: add modprobe try to mimic original module-init-tools' modprobe as much as possible, but this exposed some missing features in libkmod, these are now listed in TODO. 2011-12-12 04:36:18 +07:00			`* create test-mock library to be LD_PRELOAD'ed before running the binaries`
update TODO 2011-12-10 22:32:27 +07:00			`so we're able to create unit tests`
tools: add modprobe try to mimic original module-init-tools' modprobe as much as possible, but this exposed some missing features in libkmod, these are now listed in TODO. 2011-12-12 04:36:18 +07:00
TODO: update tasks 2011-12-14 23:02:28 +07:00			`* Add functions to dump configuration`

			`* Add functions list all modules known by modules.dep`

			`* provide 1:1 compatibility with module-init-tools's modprobe`
			`- dump configuration`
TODO: add task in modprobe's compatibility 2011-12-27 01:05:19 +07:00			`- 'modprobe -r' should remove modules which usecount became 0 because of`
			`module's removal`
coding style: fix lines over 80 chars Lines should not go over 80 chars with a few exceptions: - headers - function definitions with only 1 argument - long strings, otherwise we break grep This should go later in a coding-style file 2011-12-12 19:48:02 +07:00
elf: implement kmod_module_get_dependency_symbols() Uses kmod_elf_get_dependency_symbols() that looks into ".symtab" for UNDEF symbols and matches the name from ".strtab" to "__versions" to get crc. Likely the public API should unify the symbol information getters and list release, they are almost the same. 2011-12-20 20:54:53 +07:00			`* provide depmod:`
			`- 1:1 compatible kmod-depmod.c`
update TODO depmod was done, and without map support 2011-12-24 10:45:23 +07:00			`- add missing -F and -E`
elf: implement kmod_module_get_dependency_symbols() Uses kmod_elf_get_dependency_symbols() that looks into ".symtab" for UNDEF symbols and matches the name from ".strtab" to "__versions" to get crc. Likely the public API should unify the symbol information getters and list release, they are almost the same. 2011-12-20 20:54:53 +07:00
			`* review API, maybe unify all of these setters:`
			`- kmod_module_version_get_symbol()`
			`- kmod_module_version_get_crc()`
			`- kmod_module_symbol_get_symbol()`
			`- kmod_module_symbol_get_crc()`
			`- kmod_module_dependency_symbol_get_symbol()`
			`- kmod_module_dependency_symbol_get_crc()`
			`- kmod_module_versions_free_list()`
			`- kmod_module_symbols_free_list()`
			`- kmod_module_dependency_symbols_free_list()`

TODO: add idea about single file with all compressed modules. 2011-12-19 20:37:08 +07:00			`* provide modules.archive, a cache file with all modules compressed`
			`and a fast access. It's like a tar.gz, but with each entry`
			`compressed as opposed to the whole tar compressed, easy to pick`
			`individual entries, that is, more like .gz.tar. As zlib compression`
			`does not store the uncompressed file size, this could provide`
			`it. The file format should be something like:`
			`MAGIC-ID`
			`DIRECTORY-ENTRY-SIZE`
			`DIRECTORY (hash-like format, points to file offset and size)`
			`ENTRIES (each is a compressed module)`
			`Helper binary to:`
			`kmod-archive list`
			`kmod-archive add path.ko`
			`kmod-archive rm path.ko`
			`kmod-archive get path.ko`
			`kmod-archive exists path.ko`

kmod_module: use 'modname/aliasname' as key for hash 1 alias may correspond to more than 1 module. This would cause a conflict in the hash table when inserting a module there and bad things could happen. Now we use 'modname/aliasname' as key, '/aliasname' part being optional. Internally kmod_module_new_from_alias() will setup a 'modname/aliasname' string and pass to kmod_module_new_from_name() that will treat the case with a '/' in the name. User might call kmod_module_new_from_name() without any slashes, so the key my not contain it. 2011-12-15 00:21:10 +07:00			`Known Bugs:`
TODO: add new tasks and notes to future development 2011-12-16 11:02:58 +07:00			`===========`


			`Things to be added removed in kernel (check what is really needed):`
			`===================================================================`

			`* list of currently loaded modules`

			`* module's size should be available under /sys`
TODO: update tasks 2011-12-14 23:02:28 +07:00
TODO: add new tasks and notes to future development 2011-12-16 11:02:58 +07:00			`* kill /proc/modules ?`