tweak watcher structure, add external watcher construction interface #1082
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
Add a function to return watcher implementation pointer (impl) and use this function in watcher constructors to simplify the generic flux_watcher_create() call.
Make the 'ops' vtable member of flux_watcher into a pointer to an watcher_ops structure, instead of copying the vtable into each instance of the watcher class. This then obviates the need for watcher "signatures", because the address of the operations structure can be used to uniquely identify each "class" of watcher. Besides, since the signatures were defined inside the source of reactor.c, there was no way to guarauntee that any externally created watchers would have a different signature from existing watchers;
Allow code outside of reactor.c to create watchers, and expose flux_watcher_create(), flux_watcher_ops, etc. as part of the Flux API.
There's no need to pass watcher implementation pointer `impl` to the watcher interface functions. Watchers internally defined in reactor.c can use w->impl, and externally defined watchers can use the flux_watcher_impl () accessor.
|
This looks like a good cleanup to me! |
Codecov Report
@@ Coverage Diff @@
## master #1082 +/- ##
==========================================
- Coverage 77.93% 77.93% -0.01%
==========================================
Files 150 150
Lines 25954 25934 -20
==========================================
- Hits 20228 20212 -16
+ Misses 5726 5722 -4
|
|
Discussed this briefly wtih @grondo in the hallway, and we agreed this could be merged if tests passed. Thanks for the cleanup! |
Closed
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 PR is not intended to be merged, but just to get feedback.
Following up on @garlick's similar changes to allow creation of custom watchers outside of
reactor.c, these changes slightly modify watcher internals and exposeflux_watcher_createand some accessors for the opaque watcher type.However, I'm not sure if the approach goes too far, or not far enough, or if we should try something else.
The changes are pretty simple, however, highlights are:
signaturewas dropped because it didn't seem like there was a feasible way to guarantee uniqueness for new and/or custom watchers.flux_watcher_opsstructure, since there should just be one global/static operations structure per "class" not per watcher. (If there is a good reason to copy in theopsstructure to the watcher, I'm sorry I didn't know it)void *implimplementation data as well as the address of the operations structureimpl, both the return by reference argument toflux_watcher_createand the explicitvoid * implargument to the watcherstart,stop,destroymethods were dropped.