Re: genksyms vs. opaque struct *

[Philipp Hahn <phahn-oss@avm.de>]

Hello,

to answer my own question from last year:

Am Thu, Nov 13, 2025 at 09:40:15PM +0100 schrieb Philipp Hahn:
> while building a Linux kernel module I stumbled over an issue with 'genksyms': Basically my modules uses an "opaque struct" and only gets a pointer to such an object. The header file declaring that struct did *not* #include all needed header files recursively, so some types remained unresolved.
> For compiling the module this was not an issue as the compiler only needs to allocate space for an pointer to that nested struct and does not need more details.
> Another module exists which uses that symbol and recorded the calculated CRC.
>
> Then I changed my module and added some more #includes, which resulted into `genksyms` getting *more* details on the next run while the implementation actually did not change.
...
> I wonder, why that option is not enabled by default or if there is another solution to prevent such breaking changed by including more/less #includes? Are there any good/recommended practices?

That problem is and can mostly be ignored:
- The CRC only tries to capture the ABI, but it is not perfect. You
  could also use a number and ask the developer to increment that
  manually each time the relevant ABI changes; just like it is done with
  the version number of shared libraries.
- You as the developer decide, how much of the ABI shoule be tracked:
  - if you include more header files, you get a deeper dependency tree
    and will detect more breaking changes - wanted or unwanted
  - if you include less header files, you will detect fewer changes.
- The CRC is only calculated when the experting module is "modpost"ed:
  The CRC is simply recorded then and any other module using it will
  just use that CRC. Including more or less headers at those using
  modules will not change anything as the CRC only depends on what was
  back than.

In summary you might change the CRC is you include more or less headers
when you re-compile the exporting module, but that is expected as the
detail level changes. Consider that part of the ABI.
If you do that you then have to just re-compile/link/modpost all
downstream modules so they can pick up the new CRC.

Philipp Hahn