New option to record renamings in a .h file #357
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This simplifies name handling in the situation where a library and a client are both verified projects, extracting separately, and linking together. Consider Library.A.Base1.fst and Library.A.Base2.fst, extracted with: -bundle Library.A.Base1+Library.A.Base2=[rename=Library_A,rename-prefix] The client, in order to use the library, passes `-library Library.*`, but without any further options, must also replicate the bundle above in order to generate code that references Library_A_foobar instead of Library_A_Base1_foobar; note that the latter would be a linking error. This is onerous: the library must export its bundle options in a format consumable by the client; furthermore, the client is bound by the bundle choices of the library and has no way of grouping, say, in Library.h all of the `extern` declarations pertaining to Library while also at the same time respecting the renamings enabled by rename-prefix. This PR offers an alternate route: the library records in a krmlrenamings.h file all of the name changes that deviate from the default, e.g. ``` ``` This allows the client to replace a litany of bundle/rename options with a mere `-add-include '"library/clients/krmlrenamings.h"'`
|
CC @pnmadelaine, whose life this should greatly simplify |
|
Spurious failure for the red. The other green is 👍 |
|
As a side-effect, this breaks HACL* because it was relying on the -drop option which has been deprecated for many years now. The cross-referenced issue fixes it. |
|
@msprotz thank you very much for this! |
|
I use this in hacl-star/hacl-star#789, everything seems to work fine! thanks again! |
|
The test will be whether this allows client projects of HACL* (merkle-tree, everquic, noise*, and so on) to link against HACL* successfully without running into undefined symbols. But I want to merge this to prevent it from bit-rotting, so I'll send followup fixes for this particular feature as we find them. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This simplifies name handling in the situation where a library and a client are both verified projects, extracting separately, and linking together.
Consider Library.A.Base1.fst and Library.A.Base2.fst, extracted with:
-bundle Library.A.Base1+Library.A.Base2=[rename=Library_A,rename-prefix]
The client, in order to use the library, passes
-library Library.*, but without any further options, must also replicate the bundle above in order to generate code that references Library_A_foobar instead of Library_A_Base1_foobar; note that the latter would be a linking error.This is onerous: the library must export its bundle options in a format consumable by the client; furthermore, the client is bound by the bundle choices of the library and has no way of grouping, say, in Library.h all of the
externdeclarations pertaining to Library while also at the same time respecting the renamings enabled by rename-prefix.This PR offers an alternate route: the library records in a krmlrenamings.h file all of the name changes that deviate from the default, e.g.
This allows the client to replace a litany of bundle/rename options with a mere
-add-include '"library/clients/krmlrenamings.h"'