-
Notifications
You must be signed in to change notification settings - Fork 39
[Feature] Support dynamic-style overload for FFI object types #286
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @DarkSharpness, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the Foreign Function Interface (FFI) by implementing dynamic-style function overloading for object types. This feature allows developers to define multiple C++ methods or constructors with identical names but distinct parameter lists, which can then be seamlessly invoked from FFI bindings. The change improves the usability and expressiveness of FFI object definitions, making them more aligned with standard C++ programming patterns. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a powerful feature to support overloading of FFI object methods, including constructors, instance methods, and static methods. The implementation is well-designed, with good attention to performance by minimizing virtual function calls. The changes are well-structured, with the core logic encapsulated in the new include/tvm/ffi/extra/overload.h header, and necessary supporting changes made to function.h and registry.h. The addition of tests in tests/cpp/test_overload.cc is great and covers the primary use cases. I have a couple of minor suggestions for improvement.
| * under the License. | ||
| */ | ||
| /*! | ||
| * \file tvm/ffi/reflection/registry.h |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| /// TODO: better error message | ||
| TVM_FFI_THROW(TypeError) << "No matching overload found when calling: `" << name_ << "` with " | ||
| << num_args << " arguments."; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current error message for a failed overload resolution is quite generic. To improve debuggability, consider enhancing the error message to include more context, such as the argument types that were provided and a list of the available overloads with their signatures. This would make it much easier for users to identify why a call failed to match any overload.
| #define TVM_FFI_DLL_EXPORT_INCLUDE_METADATA 0 | ||
| #endif | ||
|
|
||
| #if TVM_FFI_DLL_EXPORT_INCLUDE_METADATA |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose it's fine to wildcard include sstream without the guards?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wildcard include sstream is not friendly to clangd, which gives me an annoying warning "Included header sstream is not used directly". It's just a style fix and could be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see.
I’ve got bunch of similar warnings too. I managed to run clangd on this repo on mainline CI, but it only applies to .cc files instead of headers. If you have any ideas how to improve, I’m happy to walk you through what the existing infra looks like.
Related discussion here #265 .
Modification in short:
Function::FromPackedInplaceinfunction.hand generalize some methods inregistry.hextra/overload.h)