Limited "generics" in C without macros or UB
source link: https://drewdevault.com/2017/06/05/Limited-generics-in-C.html
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Limited "generics" in C without macros or UB June 5, 2017 on Drew DeVault's blog
I should start this post off by clarifying that what I have to show you today is
not, in fact, generics. However, it’s useful in some situations to solve the
same problems that generics might. This is a pattern I’ve started using to
reduce the number of void* pointers floating around in my code: multiple
definitions of a struct.
Errata: we rolled this approach back in wlroots because it causes problems with LTO. I no longer recommend it.
Let’s take a look at a specific example. In
wlroots, wlr_output is a generic type
that can be implemented by any number of backends, like DRM (direct rendering
manager), wayland windows, X11 windows, RDP outputs, etc. The wlr/types.h
header includes this structure:
struct wlr_output_impl;
struct wlr_output_state;
struct wlr_output {
const struct wlr_output_impl *impl;
struct wlr_output_state *state;
// [...]
};
void wlr_output_enable(struct wlr_output *output, bool enable);
bool wlr_output_set_mode(struct wlr_output *output,
struct wlr_output_mode *mode);
void wlr_output_destroy(struct wlr_output *output);
wlr_output_impl is defined elsewhere:
struct wlr_output_impl {
void (*enable)(struct wlr_output_state *state, bool enable);
bool (*set_mode)(struct wlr_output_state *state,
struct wlr_output_mode *mode);
void (*destroy)(struct wlr_output_state *state);
};
struct wlr_output *wlr_output_create(struct wlr_output_impl *impl,
struct wlr_output_state *state);
void wlr_output_free(struct wlr_output *output);
Nowhere, however, is wlr_output_state defined. It’s left an incomplete type
throughout all of the common wlr_output code. The “generic” part is that each
output implementation, in its own private headers, defines the
wlr_output_state struct for itself, like the DRM backend:
struct wlr_output_state {
uint32_t connector;
char name[16];
uint32_t crtc;
drmModeCrtc *old_crtc;
struct wlr_drm_renderer *renderer;
struct gbm_surface *gbm;
EGLSurface *egl;
bool pageflip_pending;
enum wlr_drm_output_state state;
// [...]
};
This allows implementations of the enable, set_mode, and destroy functions
to avoid casting a void* to the appropriate type:
static struct wlr_output_impl output_impl = {
.enable = wlr_drm_output_enable,
// [...]
};
static void wlr_drm_output_enable(struct wlr_output_state *output,
bool enable) {
struct wlr_backend_state *state =
wl_container_of(output->renderer, state, renderer);
if (output->state != DRM_OUTPUT_CONNECTED) {
return;
}
if (enable) {
drmModeConnectorSetProperty(state->fd,
output->connector,
output->props.dpms,
DRM_MODE_DPMS_ON);
// [...]
} else {
drmModeConnectorSetProperty(state->fd,
output->connector,
output->props.dpms,
DRM_MODE_DPMS_STANDBY);
}
}
// [...]
struct wlr_output output = wlr_output_create(&output_impl, output);
The limitations of this approach are apparent: you cannot work with multiple
definitions of wlr_output_state in the same file. However, you get improved
type safety, have to write less code, and improve readability.
Have a comment on one of my posts? Start a discussion in my public inbox by sending an email to ~sircmpwn/[email protected] [mailing list etiquette]
Articles from blogs I read Generated by openring
Go on ARM and Beyond
The industry is abuzz about non-x86 processors recently, so we thought it would be worth a brief post about Go’s support for them. It has always been important to us for Go to be portable, not overfitting to any particular operating sys…
via The Go Programming Language Blog December 17, 2020Status update, December 2020
Hi all! This status update is the 24th one, so it’s been 2 years I’ve started writing those now (ignoring a little hiatus). Time flies! This month I’ve invested a lot of time into wlroots. My main focus has been renderer v6, which has now been internally rol…
via emersion December 16, 2020What's cooking on Sourcehut? December 2020
A brisk wind of winter chill sets a stir down my spine, as I sit down with a fresh cup of coffee to yarn a story of careful engineering and passionate spirit that took place over the course of 30 days. The last 30 days. Cause this is the monthly “what’s cook…
via Blogs on Sourcehut December 15, 2020Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK