ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

qga: Replace 'blacklist' and 'whitelist' in the guest agent sources 

Let's use better, more inclusive wording here.

Message-Id: <20220727092135.302915-3-thuth@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
This commit is contained in:
Thomas Huth 2022-07-27 11:21:34 +02:00
parent 582a098e6c
commit 0e4ef702e8
5 changed files with 46 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
qga/commands-posix.c
View File

@ -3356,8 +3356,8 @@ qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
} }
#endif #endif
/* add unsupported commands to the blacklist */ /* add unsupported commands to the list of blocked RPCs */
GList *ga_command_blacklist_init(GList *blacklist) GList *ga_command_init_blockedrpcs(GList *blockedrpcs)
{ {
#if !defined(__linux__) #if !defined(__linux__)
{ {
@ -3370,13 +3370,13 @@ GList *ga_command_blacklist_init(GList *blacklist)
char **p = (char **)list; char **p = (char **)list;
while (*p) { while (*p) {
blacklist = g_list_append(blacklist, g_strdup(*p++)); blockedrpcs = g_list_append(blockedrpcs, g_strdup(*p++));
} }
} }
#endif #endif
#if !defined(HAVE_GETIFADDRS) #if !defined(HAVE_GETIFADDRS)
blacklist = g_list_append(blacklist, blockedrpcs = g_list_append(blockedrpcs,
g_strdup("guest-network-get-interfaces")); g_strdup("guest-network-get-interfaces"));
#endif #endif
@ -3390,18 +3390,18 @@ GList *ga_command_blacklist_init(GList *blacklist)
char **p = (char **)list; char **p = (char **)list;
while (*p) { while (*p) {
blacklist = g_list_append(blacklist, g_strdup(*p++)); blockedrpcs = g_list_append(blockedrpcs, g_strdup(*p++));
} }
} }
#endif #endif
#if !defined(CONFIG_FSTRIM) #if !defined(CONFIG_FSTRIM)
blacklist = g_list_append(blacklist, g_strdup("guest-fstrim")); blockedrpcs = g_list_append(blockedrpcs, g_strdup("guest-fstrim"));
#endif #endif
blacklist = g_list_append(blacklist, g_strdup("guest-get-devices")); blockedrpcs = g_list_append(blockedrpcs, g_strdup("guest-get-devices"));
return blacklist; return blockedrpcs;
} }
/* register init/cleanup routines for stateful command groups */ /* register init/cleanup routines for stateful command groups */

10
qga/commands-win32.c
View File

@ -2005,8 +2005,8 @@ GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
return NULL; return NULL;
} }
/* add unsupported commands to the blacklist */ /* add unsupported commands to the list of blocked RPCs */
GList *ga_command_blacklist_init(GList *blacklist) GList *ga_command_init_blockedrpcs(GList *blockedrpcs)
{ {
const char *list_unsupported[] = { const char *list_unsupported[] = {
"guest-suspend-hybrid", "guest-suspend-hybrid",
@ -2017,7 +2017,7 @@ GList *ga_command_blacklist_init(GList *blacklist)
char **p = (char **)list_unsupported; char **p = (char **)list_unsupported;
while (*p) { while (*p) {
blacklist = g_list_append(blacklist, g_strdup(*p++)); blockedrpcs = g_list_append(blockedrpcs, g_strdup(*p++));
} }
if (!vss_init(true)) { if (!vss_init(true)) {
@ -2028,11 +2028,11 @@ GList *ga_command_blacklist_init(GList *blacklist)
p = (char **)list; p = (char **)list;
while (*p) { while (*p) {
blacklist = g_list_append(blacklist, g_strdup(*p++)); blockedrpcs = g_list_append(blockedrpcs, g_strdup(*p++));
} }
} }
return blacklist; return blockedrpcs;
} }
/* register init/cleanup routines for stateful command groups */ /* register init/cleanup routines for stateful command groups */

2
qga/guest-agent-core.h
View File

@ -24,7 +24,7 @@ typedef struct GACommandState GACommandState;
extern GAState *ga_state; extern GAState *ga_state;
extern QmpCommandList ga_commands; extern QmpCommandList ga_commands;
GList *ga_command_blacklist_init(GList *blacklist); GList *ga_command_init_blockedrpcs(GList *blockedrpcs);
void ga_command_state_init(GAState *s, GACommandState *cs); void ga_command_state_init(GAState *s, GACommandState *cs);
void ga_command_state_add(GACommandState *cs, void ga_command_state_add(GACommandState *cs,
void (*init)(void), void (*init)(void),

57
qga/main.c
View File

@ -87,7 +87,7 @@ struct GAState {
#endif #endif
bool delimit_response; bool delimit_response;
bool frozen; bool frozen;
GList *blacklist; GList *blockedrpcs;
char *state_filepath_isfrozen; char *state_filepath_isfrozen;
struct { struct {
const char *log_filepath; const char *log_filepath;
@ -107,7 +107,7 @@ struct GAState *ga_state;
QmpCommandList ga_commands; QmpCommandList ga_commands;
/* commands that are safe to issue while filesystems are frozen */ /* commands that are safe to issue while filesystems are frozen */
static const char *ga_freeze_whitelist[] = { static const char *ga_freeze_allowlist[] = {
"guest-ping", "guest-ping",
"guest-info", "guest-info",
"guest-sync", "guest-sync",
@ -363,31 +363,31 @@ static gint ga_strcmp(gconstpointer str1, gconstpointer str2)
} }
/* disable commands that aren't safe for fsfreeze */ /* disable commands that aren't safe for fsfreeze */
static void ga_disable_non_whitelisted(const QmpCommand *cmd, void *opaque) static void ga_disable_not_allowed(const QmpCommand *cmd, void *opaque)
{ {
bool whitelisted = false; bool allowed = false;
int i = 0; int i = 0;
const char *name = qmp_command_name(cmd); const char *name = qmp_command_name(cmd);
while (ga_freeze_whitelist[i] != NULL) { while (ga_freeze_allowlist[i] != NULL) {
if (strcmp(name, ga_freeze_whitelist[i]) == 0) { if (strcmp(name, ga_freeze_allowlist[i]) == 0) {
whitelisted = true; allowed = true;
} }
i++; i++;
} }
if (!whitelisted) { if (!allowed) {
g_debug("disabling command: %s", name); g_debug("disabling command: %s", name);
qmp_disable_command(&ga_commands, name, "the agent is in frozen state"); qmp_disable_command(&ga_commands, name, "the agent is in frozen state");
} }
} }
/* [re-]enable all commands, except those explicitly blacklisted by user */ /* [re-]enable all commands, except those explicitly blocked by user */
static void ga_enable_non_blacklisted(const QmpCommand *cmd, void *opaque) static void ga_enable_non_blocked(const QmpCommand *cmd, void *opaque)
{ {
GList *blacklist = opaque; GList *blockedrpcs = opaque;
const char *name = qmp_command_name(cmd); const char *name = qmp_command_name(cmd);
if (g_list_find_custom(blacklist, name, ga_strcmp) == NULL && if (g_list_find_custom(blockedrpcs, name, ga_strcmp) == NULL &&
!qmp_command_is_enabled(cmd)) { !qmp_command_is_enabled(cmd)) {
g_debug("enabling command: %s", name); g_debug("enabling command: %s", name);
qmp_enable_command(&ga_commands, name); qmp_enable_command(&ga_commands, name);
@ -426,8 +426,8 @@ void ga_set_frozen(GAState *s)
if (ga_is_frozen(s)) { if (ga_is_frozen(s)) {
return; return;
} }
/* disable all non-whitelisted (for frozen state) commands */ /* disable all forbidden (for frozen state) commands */
qmp_for_each_command(&ga_commands, ga_disable_non_whitelisted, NULL); qmp_for_each_command(&ga_commands, ga_disable_not_allowed, NULL);
g_warning("disabling logging due to filesystem freeze"); g_warning("disabling logging due to filesystem freeze");
ga_disable_logging(s); ga_disable_logging(s);
s->frozen = true; s->frozen = true;
@ -465,8 +465,8 @@ void ga_unset_frozen(GAState *s)
s->deferred_options.pid_filepath = NULL; s->deferred_options.pid_filepath = NULL;
} }
/* enable all disabled, non-blacklisted commands */ /* enable all disabled, non-blocked commands */
qmp_for_each_command(&ga_commands, ga_enable_non_blacklisted, s->blacklist); qmp_for_each_command(&ga_commands, ga_enable_non_blocked, s->blockedrpcs);
s->frozen = false; s->frozen = false;
if (!ga_delete_file(s->state_filepath_isfrozen)) { if (!ga_delete_file(s->state_filepath_isfrozen)) {
g_warning("unable to delete %s, fsfreeze may not function properly", g_warning("unable to delete %s, fsfreeze may not function properly",
@ -896,7 +896,8 @@ int64_t ga_get_fd_handle(GAState *s, Error **errp)
int64_t handle; int64_t handle;
g_assert(s->pstate_filepath); g_assert(s->pstate_filepath);
/* we blacklist commands and avoid operations that potentially require /*
* We block commands and avoid operations that potentially require
* writing to disk when we're in a frozen state. this includes opening * writing to disk when we're in a frozen state. this includes opening
* new files, so we should never get here in that situation * new files, so we should never get here in that situation
*/ */
@ -950,8 +951,8 @@ struct GAConfig {
#ifdef _WIN32 #ifdef _WIN32
const char *service; const char *service;
#endif #endif
gchar *bliststr; /* blacklist may point to this string */ gchar *bliststr; /* blockedrpcs may point to this string */
GList *blacklist; GList *blockedrpcs;
int daemonize; int daemonize;
GLogLevelFlags log_level; GLogLevelFlags log_level;
int dumpconf; int dumpconf;
@ -1019,7 +1020,7 @@ static void config_load(GAConfig *config)
if (g_key_file_has_key(keyfile, "general", blockrpcs_key, NULL)) { if (g_key_file_has_key(keyfile, "general", blockrpcs_key, NULL)) {
config->bliststr = config->bliststr =
g_key_file_get_string(keyfile, "general", blockrpcs_key, &gerr); g_key_file_get_string(keyfile, "general", blockrpcs_key, &gerr);
config->blacklist = g_list_concat(config->blacklist, config->blockedrpcs = g_list_concat(config->blockedrpcs,
split_list(config->bliststr, ",")); split_list(config->bliststr, ","));
} }
@ -1079,7 +1080,7 @@ static void config_dump(GAConfig *config)
config->log_level == G_LOG_LEVEL_MASK); config->log_level == G_LOG_LEVEL_MASK);
g_key_file_set_boolean(keyfile, "general", "retry-path", g_key_file_set_boolean(keyfile, "general", "retry-path",
config->retry_path); config->retry_path);
tmp = list_join(config->blacklist, ','); tmp = list_join(config->blockedrpcs, ',');
g_key_file_set_string(keyfile, "general", "block-rpcs", tmp); g_key_file_set_string(keyfile, "general", "block-rpcs", tmp);
g_free(tmp); g_free(tmp);
@ -1171,7 +1172,7 @@ static void config_parse(GAConfig *config, int argc, char **argv)
qmp_for_each_command(&ga_commands, ga_print_cmd, NULL); qmp_for_each_command(&ga_commands, ga_print_cmd, NULL);
exit(EXIT_SUCCESS); exit(EXIT_SUCCESS);
} }
config->blacklist = g_list_concat(config->blacklist, config->blockedrpcs = g_list_concat(config->blockedrpcs,
split_list(optarg, ",")); split_list(optarg, ","));
break; break;
} }
@ -1226,7 +1227,7 @@ static void config_free(GAConfig *config)
#ifdef CONFIG_FSFREEZE #ifdef CONFIG_FSFREEZE
g_free(config->fsfreeze_hook); g_free(config->fsfreeze_hook);
#endif #endif
g_list_free_full(config->blacklist, g_free); g_list_free_full(config->blockedrpcs, g_free);
g_free(config); g_free(config);
} }
@ -1310,7 +1311,7 @@ static GAState *initialize_agent(GAConfig *config, int socket_activation)
s->deferred_options.log_filepath = config->log_filepath; s->deferred_options.log_filepath = config->log_filepath;
} }
ga_disable_logging(s); ga_disable_logging(s);
qmp_for_each_command(&ga_commands, ga_disable_non_whitelisted, NULL); qmp_for_each_command(&ga_commands, ga_disable_not_allowed, NULL);
} else { } else {
if (config->daemonize) { if (config->daemonize) {
become_daemon(config->pid_filepath); become_daemon(config->pid_filepath);
@ -1334,10 +1335,10 @@ static GAState *initialize_agent(GAConfig *config, int socket_activation)
return NULL; return NULL;
} }
config->blacklist = ga_command_blacklist_init(config->blacklist); config->blockedrpcs = ga_command_init_blockedrpcs(config->blockedrpcs);
if (config->blacklist) { if (config->blockedrpcs) {
GList *l = config->blacklist; GList *l = config->blockedrpcs;
s->blacklist = config->blacklist; s->blockedrpcs = config->blockedrpcs;
do { do {
g_debug("disabling command: %s", (char *)l->data); g_debug("disabling command: %s", (char *)l->data);
qmp_disable_command(&ga_commands, l->data, NULL); qmp_disable_command(&ga_commands, l->data, NULL);

4
qga/qapi-schema.json
View File

@ -16,8 +16,8 @@
{ 'pragma': { 'doc-required': true } } { 'pragma': { 'doc-required': true } }
# Whitelists to permit QAPI rule violations; think twice before you # Lists with items allowed to permit QAPI rule violations; think twice
# add to them! # before you add to them!
{ 'pragma': { { 'pragma': {
# Types whose member names may use '_' # Types whose member names may use '_'
'member-name-exceptions': [ 'member-name-exceptions': [