Re: libification: how to avoid symbol collisions?

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 9, 2024, 17:09 UTC
Message-ID: <xmqqil2ximxq.fsf@gitster.g>
In-Reply-To: <CAO_smVji5aGjx1V-EGbumRRpOuGY0SkXZUn9g4LxKmMO3aw=Sg@mail.gmail.com>

Kyle Lippincott <spectral@google.com> writes:

Show 11 quoted lines

> If I'm right that this is an issue, does this imply that we'd need to
> rename every non-static function in the git codebase that's part of a
> library to have a `git_` prefix, even if it won't be used outside of
> the git project's own .c files? Is there a solution that doesn't
> involve making it so that we have to type `git_` a billion times a day
> that's also maintainable? We could try to guess at how likely a name
> collision would be and only do this for ones where it's obviously
> going to collide, but if we get it wrong, I'm concerned that we'll run
> into subtle ODR violations that *at best* erode confidence in our
> library, and can actually cause outages, data corruption, and
> security/privacy issues.

If you end up with a helper function name "foo" that is defined in our X.c and used by our Y.c but is not part of the published "git library API", we may want to rename it so that such a common name can be used by programs that link with the "git library". We may choose to rename it to "GitLib_foo".

Do we want to keep the source of our library code, which defines the helper function "foo" in X.c and calls it in Y.c, intact so that the helper is still named "foo" as far as we are concerned? Or do we "bite the bullet" and bulk modify both the callers and the callee?

I'd imagine that we would rather avoid such a churn at all cost [*]. After all, "foo" is *not* supposed to be callable by any human written code, and that is why we rename it to a name "GitLib_foo" that is unlikely to overlap with any sane human would use.

	Side note: if a public API function that we want our library
	clients to call is misnamed, we want to rename it so that we
	would both internally and externally use the same public
	name, I would imagine.

The mechanics to rename should be a solved problem, I think, as we are obviously not the first project that wants to build a library.

If the names are all simple, we could do this in CPP, i.e. invent a header file that has bunch of such renames like

    #define foo GitLib_foo

and include it in both X.c and Y.c. But "foo" may also appear as the name of a type, a member in a structure, etc., where we may not want to touch, so in a project larger than toy scale, this approach may not work well.

"objcopy --redefine-sym" would probably be a better way. I haven't written a linker script, but I heard rumors that there is RENAME() to rename symbols, and using that might be another avenue.