| 1 |
// Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 |
// SPDX-License-Identifier: LGPL-2.1-or-later |
| 3 |
|
| 4 |
/** |
| 5 |
* @file |
| 6 |
* |
| 7 |
* Chains of named handlers. |
| 8 |
*/ |
| 9 |
|
| 10 |
#ifndef DRGN_HANDLER_H |
| 11 |
#define DRGN_HANDLER_H |
| 12 |
|
| 13 |
#include <stdbool.h> |
| 14 |
#include <stdlib.h> |
| 15 |
|
| 16 |
// This should be embedded as the first member in a structure containing the |
| 17 |
// handler implementation. |
| 18 |
struct drgn_handler { |
| 19 |
const char *name; |
| 20 |
struct drgn_handler *next; |
| 21 |
bool enabled; |
| 22 |
// Whether this structure and name need to be freed. |
| 23 |
bool free; |
| 24 |
}; |
| 25 |
|
| 26 |
// This is optimized for frequent drgn_handler_list_for_each_enabled() |
| 27 |
// operations; everything else is expected to be rare, so we keep this as small |
| 28 |
// as possible. |
| 29 |
struct drgn_handler_list { |
| 30 |
// All enabled handlers are first, in order, followed by disabled |
| 31 |
// handlers in no particular order. |
| 32 |
struct drgn_handler *head; |
| 33 |
}; |
| 34 |
|
| 35 |
// handler->name and handler->free must be initialized. |
| 36 |
struct drgn_error *drgn_handler_list_register(struct drgn_handler_list *list, |
| 37 |
struct drgn_handler *handler, |
| 38 |
size_t enable_index, |
| 39 |
const char *what); |
| 40 |
|
| 41 |
struct drgn_error *drgn_handler_list_registered(struct drgn_handler_list *list, |
| 42 |
const char ***names_ret, |
| 43 |
size_t *count_ret); |
| 44 |
|
| 45 |
struct drgn_error *drgn_handler_list_set_enabled(struct drgn_handler_list *list, |
| 46 |
const char * const *names, |
| 47 |
size_t count, |
| 48 |
const char *what); |
| 49 |
|
| 50 |
struct drgn_error *drgn_handler_list_enabled(struct drgn_handler_list *list, |
| 51 |
const char ***names_ret, |
| 52 |
size_t *count_ret); |
| 53 |
|
| 54 |
bool drgn_handler_list_disable(struct drgn_handler_list *list, |
| 55 |
const char *name); |
| 56 |
|
| 57 |
static inline bool drgn_handler_is_last_enabled(struct drgn_handler *handler) |
| 58 |
{ |
| 59 |
return handler->enabled && (!handler->next || !handler->next->enabled); |
| 60 |
} |
| 61 |
|
| 62 |
// Helper to simplify the casting and naming in drgn_handler_list_deinit(). |
| 63 |
static inline struct drgn_handler * |
| 64 |
drgn_handler_free_and_next(struct drgn_handler *handler) |
| 65 |
{ |
| 66 |
struct drgn_handler *next = handler->next; |
| 67 |
if (handler->free) { |
| 68 |
free((char *)handler->name); |
| 69 |
free(handler); |
| 70 |
} |
| 71 |
return next; |
| 72 |
} |
| 73 |
|
| 74 |
// Free all registered handlers, optionally executing a statement for each one. |
| 75 |
#define drgn_handler_list_deinit(type, handler, list, ...) do { \ |
| 76 |
type *handler = (type *)(list)->head; \ |
| 77 |
while (handler) { \ |
| 78 |
__VA_ARGS__ \ |
| 79 |
handler = (type *)drgn_handler_free_and_next((struct drgn_handler *)handler);\ |
| 80 |
} \ |
| 81 |
} while (0) |
| 82 |
|
| 83 |
#define drgn_handler_list_for_each_enabled(type, handler, list) \ |
| 84 |
for (type *handler = (type *)(list)->head; \ |
| 85 |
handler && ((struct drgn_handler *)handler)->enabled; \ |
| 86 |
handler = (type *)((struct drgn_handler *)handler)->next) |
| 87 |
|
| 88 |
#endif /* DRGN_HANDLER_H */ |