Clean up src/coreclr/src/inc : remove private implementation details

[sdmaclea]

An audit of the types used in the Cross DAC revealed MD data types in the DBI build.

Root cause seems to be src/coreclr/src/inc indirectly including private header files.

git grep "#include .*\.\." -- src/coreclr/src/inc

src/coreclr/src/inc/eventtracebase.h:#include "../gc/env/etmdummy.h"
src/coreclr/src/inc/formattype.h:#include "../ildasm/dynamicarray.h"
src/coreclr/src/inc/metadata.h:#include "../md/inc/metamodelro.h"
src/coreclr/src/inc/metadata.h:#include "../md/inc/liteweightstgdb.h"
src/coreclr/src/inc/metadata.h:#include "../md/inc/metamodel.h"
src/coreclr/src/inc/stgpool.h:#include "../md/hotdata/hotheap.h"
src/coreclr/src/inc/stgpool.h:#include "../md/debug_metadata.h"

[sdmaclea]

#35621 will fix

src/coreclr/src/inc/metadata.h:#include "../md/inc/metamodelro.h"
src/coreclr/src/inc/metadata.h:#include "../md/inc/liteweightstgdb.h"
src/coreclr/src/inc/metadata.h:#include "../md/inc/metamodel.h"
src/coreclr/src/inc/stgpool.h:#include "../md/debug_metadata.h"

[sdmaclea]

I looked at

src/coreclr/src/inc/stgpool.h:#include "../md/hotdata/hotheap.h"

It looks like this could be acceptable as part of the public interface.

It indirectly includes

../md/datablob.h
../md/datablob.inl
../md/datatable.h
../md/datatable.inl
../md/debug_metadata.h
../md/error_metadata.h

I think these could all be part of the public API, but should be moved into inc

[sdmaclea]

Before moving more files to inc I wanted to discuss design a bit.

One approach would be to move these files to different folders.

Something like either src/coreclr/src/inc/md or src/coreclr/src/md/public/.

[jkotas]

stgpool* is an implementation details of the ../md . It is not used by anything else. It does not really belong to utilcode. I think it would be be more preferable to move stdpool* under ../md .

[sdmaclea]

That has its own problems

git grep stgpool.h
src/debug/ildbsymlib/symwrite.h:#include "stgpool.h"
src/inc/metamodelpub.h:#include <stgpool.h>
src/md/...
...
src/md/...
src/utilcode/stgpool.cpp:#include <stgpool.h>                    // Our interface definitions.
src/utilcode/stgpooli.cpp:#include <stgpool.h>                                  // Our interface definitions.
src/utilcode/stgpoolreadonly.cpp:#include <stgpool.h>                    // Our interface definitions.

[sdmaclea]

Oh I guess I understand a bit more....
So the only current issue would be

git grep stgpool.h
src/debug/ildbsymlib/symwrite.h:#include "stgpool.h"
src/inc/metamodelpub.h:#include <stgpool.h>

I'll look at it. Seems like it might be feasible.

[jkotas]

Right. ildbsymlib should really be under md as well.

[mangod9]

@sdmaclea is this something which is required for 5, or could be moved to 6?

[sdmaclea]

This is just cleanup backlog. Moved to future for now.