Home | History | Annotate | Line # | Download | only in doc
TODO.compat-module revision 1.2
      1 /* $NetBSD: TODO.compat-module,v 1.2 2019/01/27 02:08:33 pgoyette Exp $ */
      2 
      3 DONE
      4 ----
      5 1.  Removed the building of the compat library - it is no longer needed.
      6 
      7 2.  Reverted some intentional auto-load breakage for loading the sysv_ipc
      8     module; the breakage was introduced as the fix for the above-mentioned
      9     build breakage.
     10 
     11 3.  Split the sysv_ipc compat routines into their own compat_sysv module.
     12 
     13 4.  Resolved some inter-module dependencies.
     14 
     15 5.  Extracted some net/if.c compat routines into the compat module, and
     16     replaced the originals with indirect (vectored) function calls.
     17 
     18 6.  Reconfirmed existing compat-module dependencies, and update the
     19     defopt/defflag lines in the config files* as needed, to insure that
     20     built-in dependencies get resolved.
     21 
     22 7.  Fixed limits on the number of module dependencies and maximum
     23     recursion level (for auto-loading) have been removed.  Previous code
     24     for reporting module status to userland has been versioned and moved
     25     to the (new) compat_80 module.
     26 
     27 8.  The old monolithic compat module has been broken into multiple
     28     modules, one for each old NetBSD version.  The monolithic compat
     29     module is no longer available.
     30 
     31     Similarly, the compat_sysv and compat_netbsd32 modules have also
     32     been split into several version-specific modules, and the mini-
     33     monolithic versions of these modules are no longer provided.
     34 
     35 9.  syscalls.master has been updated to autoload the version-specific
     36     compat modules rather than the monolithic modules.
     37 
     38 10. Separated COMPAT_BSDPTY stuff, allowing the COMPAT_60 module to be
     39     built regardless.
     40 
     41 11. Implemented a MP-safe mechanism for installing and removing function
     42     pointers, preventing them from being unloaded (via modunload) while
     43     in use.  Thanks to riastradh@ for the template code.
     44 
     45 12. Finished splitting the vnd_30 and vnd_50 compat code into separate
     46     modules.
     47 
     48 13. Cleaned up some previous vectored routines (related to if_43.c) to
     49     use the MP-safe mechanism.
     50 
     51 14. Organized (some of) the netbsd32 machine-dependent code to fit a
     52     common build framework, and split version-specific code from baseline
     53     code as needed.  More work may be needed here (see #18 below).
     54 
     55 15. The rtsock.c code has been split into two separate source files,
     56     one for use in -current and one which is shared with COMPAT_50 (the
     57     code is shared with -current, but macros are used to define version-
     58     specific routine names and variable types).  Version-specific parts
     59     of rtsock.c for compat_14 and compat_70 have also been split out and
     60     included in the relevant version-specific compat modules.
     61 
     62 TODO - Not required for branch merge
     63 ------------------------------------
     64 16. Audit the entire code base for any remaining embedded #ifdef's for
     65     COMPAT_xx.  When found, move the actual compat code into the compat
     66     hierarchy and replace originals with indirect (vectored) calls.
     67 
     68 17. The compat_60 module still needs some work for XEN systems.  We
     69     probably need some build infrastructure changes to ensure that
     70     XEN (and, for i386, XEN-PAE) modules are build with the correct
     71     macros defined and with -I directories specified in the same order
     72     as for building kernels. See PR port-xen/53130.  This currently
     73     prevents loading of micro-code updates for amd64 processors running
     74     XEN kernels.  This limitation also exists on HEAD.
     75 
     76 18. There seems to be quite a bit of MD compat_xx code, in the various
     77     sys/arch/ directories.  I haven't yet looked at any of this.  But it
     78     seems to me that the MI compat build infrastructure should have some
     79     mechanism to "reach over" to the MD code, #include a Makefile.inc file,
     80     and perhaps define something to enable the MI modcmd code to call a
     81     compat_xx_MD_init() routine.
     82 
     83     Note also that there are a few bits of MD code that is COMPAT_44
     84     related.  (The only bit of MI COMPAT_44 code is in the single module
     85     shared by COMPAT_43 and COMPAT_09.)  This affects the cesfic, hp300,
     86     news68k, and x68k platforms, all in their respective machdep.c
     87     source file.  Additionally, the zaurus platform defines COMPAT_44 in
     88     its INSTALL kernel configuration - but no other configuration files!
     89 
     90     As far as I can tell, none of the MD compat code is currently built
     91     into the monolithic COMPAT module on HEAD.  Thus, its absence from
     92     any of the version-specific modules is not a regression.
     93 
     94 19. For compat_50, there are some things in dev/gpio and dev/wscons/wsmux
     95     that I haven't been able to cleanly separate.  These items are not
     96     currently included in the monolithic COMPAT module on HEAD, so lack of
     97     integration on the branch is not a regression.
     98 
     99 20. Find all the remaining dependencies on the compat_utils routines and
    100     deal with them appropriately.  For now, we simply ensure that they
    101     are included in every kernel via 'options COMPAT_UTILS' in file
    102     sys/conf/std
    103 
    104 21. The netbsd32_machine32_hook should be moved out of the main kernel
    105     and into the compat_netbsd32 module.  Unfortunately there are some
    106     machines which include the consumer of this hook but do not have a
    107     compat_netbsd32 module (specifically, i386 and sgimips).  This
    108     should be sorted out sometime soon, but does not block merging.
    109 
    110 22. Note that the MPSAFE kernel option is currently not specified for
    111     building modules, nor is it included in any standard kernel
    112     configuration files.  If you build a custom kernel with the MPSAFE
    113     option set, and you also use modules (especially those modules for
    114     network interface device drivers), you'll need to build custom
    115     modules, too.  The MPSAFE stuff needs to be extracted out and made
    116     into "hooks".
    117