Netplan api iterator #306
Merged
Netplan api iterator #306
Conversation
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
The new NetplanStateIterator struct keeps the iterator state (basically the front of the netdefs_ordered list) and netplan_state_iterator_next() will return the next netdef in the list and update the iterator to point to the next netdef. Sometimes it is useful to iterate through netdefs, specially when you don't know the netdef ID. One first consumer for this API would probably be the NetworkManager + Netplan integration. When NetworkManager loads the keyfile to the netplan state, we might don't know if the netdef ID is the interface name or the NM-<UUID> string. With this API we don't need to know, we can just get the first netdef in the list. As the new Netplan API doesn't expose internal structures, some API like this one is necessary.
In order to enable consumers to place the interator at the stack, the type can't be an opaque struct. The idea is based on glib's implementation of iterators. Also, use some glib helpers for simplicity and clarity when accessing GList elements.
slyon
approved these changes
Jan 3, 2023
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.
Description
The Netplan state iterator API is intended to enable consumers to walk through the ordered list of network definitions. It is useful, for instance, when you need to save the netdefs to files but you don't know the netdef ID to lookup for it.
The idea of having a non-opaque struct exposed to consumers was borrowed from Glib (here and here). By doing this, the iterator can be placed at the stack, which is much more convenient.
This API was integrated and tested with the NetworkManager+Netplan integration code base.
Checklist
make checksuccessfully.make check-coverage).