Harden public struct ABI for future extensions. - #155
Merged
Conversation
Signed-off-by: romerojosh <joshr@nvidia.com>
Collaborator
Author
|
/build |
|
🚀 Build workflow triggered! View run |
|
❌ Build workflow failed! View run |
Signed-off-by: romerojosh <joshr@nvidia.com>
Collaborator
Author
|
/build |
|
🚀 Build workflow triggered! View run |
|
✅ Build workflow passed! View run |
Signed-off-by: romerojosh <joshr@nvidia.com>
This file contains hidden or 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
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.
Over the development history of cuDecomp, I have on several occasions modified the content of the public structure types (
cudecompGridDescConfig_t,cudecompGridDescAutotuneOptions_t, andcudecompPencilInfo_t) which caused ABI breakages. For example, in this upcoming release, #154 and #119 added new fields to the config and autotune options structs.While many users of this library rebuild their applications along with updating cuDecomp versions, this is not always convenient. This PR introduces an internal redesign to the public structure types, allowing future field additions without breaking the ABI. This will provide a forward ABI compatibility moving forward (e.g. applications built against cuDecomp v 0.y.z can link against v0.y.z+ but not the other way around). This PR itself is an ABI break, but starting with the next release, this PR will allow us to better maintain ABI stability.