colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

auth-chain/trivial: rename nm_auth_chain_unref() to nm_auth_chain_destroy()

Browse Source 
NMAuthChain is not really ref-counted. True, we have an internal ref-counter
to ensure that the instance stays alive while the callback is invoked. However,
the user cannot take additional references as there is no nm_auth_chain_ref().

When the user wants to get rid of the auth-chain, with the current API it
is important that the callback won't be called after that point. From the
name nm_auth_chain_unref(), it sounds like that there could be multiple references
to the auth-chain, and merely unreferencing the object might not guarantee that
the callback is canceled. However, that is luckily not the case, because
there is no real ref-counting involved here.

Just rename the destroy function to make this clearer.
This commit is contained in:
Thomas Haller
2018-04-09 11:52:55 +02:00
parent bfaa291d89
commit 50b74731f6
7 changed files with 32 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/nm-active-connection.c
View File

@@ -1030,7 +1030,7 @@ auth_done (NMAuthChain *chain,
priv->result_func (self, TRUE, NULL, priv->user_data1, priv->user_data2); priv->result_func (self, TRUE, NULL, priv->user_data1, priv->user_data2);
done: done:
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
priv->chain = NULL; priv->chain = NULL;
priv->result_func = NULL; priv->result_func = NULL;
priv->user_data1 = NULL; priv->user_data1 = NULL;
@@ -1388,7 +1388,7 @@ dispose (GObject *object)
_LOGD ("disposing"); _LOGD ("disposing");
if (priv->chain) { if (priv->chain) {
nm_auth_chain_unref (priv->chain); nm_auth_chain_destroy (priv->chain);
priv->chain = NULL; priv->chain = NULL;
} }

13
src/nm-auth-utils.c
View File

@@ -219,7 +219,7 @@ auth_chain_finish (gpointer user_data)
/* Ensure we stay alive across the callback */ /* Ensure we stay alive across the callback */
self->refcount++; self->refcount++;
self->done_func (self, NULL, self->context, self->user_data); self->done_func (self, NULL, self->context, self->user_data);
nm_auth_chain_unref (self); nm_auth_chain_destroy (self);
return FALSE; return FALSE;
} }
@@ -394,17 +394,20 @@ nm_auth_chain_new_subject (NMAuthSubject *subject,
} }
/** /**
* nm_auth_chain_unref: * nm_auth_chain_destroy:
* @self: the auth-chain * @self: the auth-chain
* *
* Unrefs the auth-chain. By unrefing the auth-chain, you also cancel * Destroys the auth-chain. By destroying the auth-chain, you also cancel
* the receipt of the done-callback. IOW, the callback will not be invoked. * the receipt of the done-callback. IOW, the callback will not be invoked.
* *
* The only exception is, if you call nm_auth_chain_unref() from inside * The only exception is, if may call nm_auth_chain_destroy() from inside
* the callback. In this case, @self stays alive until the callback returns. * the callback. In this case, @self stays alive until the callback returns.
*
* Note that you might only destroy an auth-chain exactly once, and never
* after the callback was handled.
*/ */
void void
nm_auth_chain_unref (NMAuthChain *self) nm_auth_chain_destroy (NMAuthChain *self)
{ {
AuthCall *call; AuthCall *call;

2
src/nm-auth-utils.h
View File

@@ -62,7 +62,7 @@ void nm_auth_chain_add_call (NMAuthChain *chain,
const char *permission, const char *permission,
gboolean allow_interaction); gboolean allow_interaction);
void nm_auth_chain_unref (NMAuthChain *chain); void nm_auth_chain_destroy (NMAuthChain *chain);
/* Caller must free returned error description */ /* Caller must free returned error description */
gboolean nm_auth_is_subject_in_acl (NMConnection *connection, gboolean nm_auth_is_subject_in_acl (NMConnection *connection,

20
src/nm-manager.c
View File

@@ -953,7 +953,7 @@ _reload_auth_cb (NMAuthChain *chain,
g_dbus_method_invocation_return_value (context, NULL); g_dbus_method_invocation_return_value (context, NULL);
out: out:
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -2100,7 +2100,7 @@ device_auth_done_cb (NMAuthChain *chain,
nm_auth_chain_get_data (chain, "user-data")); nm_auth_chain_get_data (chain, "user-data"));
g_clear_error (&error); g_clear_error (&error);
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -4796,7 +4796,7 @@ deactivate_net_auth_done_cb (NMAuthChain *chain,
else else
g_dbus_method_invocation_return_value (context, NULL); g_dbus_method_invocation_return_value (context, NULL);
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -5138,7 +5138,7 @@ sleep_auth_done_cb (NMAuthChain *chain,
g_dbus_method_invocation_return_value (context, NULL); g_dbus_method_invocation_return_value (context, NULL);
} }
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
#endif #endif
@@ -5276,7 +5276,7 @@ enable_net_done_cb (NMAuthChain *chain,
g_dbus_method_invocation_take_error (context, ret_error); g_dbus_method_invocation_take_error (context, ret_error);
} }
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -5384,7 +5384,7 @@ get_permissions_done_cb (NMAuthChain *chain,
g_variant_new ("(a{ss})", &results)); g_variant_new ("(a{ss})", &results));
} }
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -5606,7 +5606,7 @@ check_connectivity_auth_done_cb (NMAuthChain *chain,
} }
out: out:
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -6017,7 +6017,7 @@ out:
g_dbus_method_invocation_return_dbus_error (invocation, error_name, error_message); g_dbus_method_invocation_return_dbus_error (invocation, error_name, error_message);
else else
g_dbus_method_invocation_return_value (invocation, NULL); g_dbus_method_invocation_return_value (invocation, NULL);
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
void void
@@ -6152,7 +6152,7 @@ checkpoint_auth_done_cb (NMAuthChain *chain,
else else
g_dbus_method_invocation_return_value (context, variant); g_dbus_method_invocation_return_value (context, variant);
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -6830,7 +6830,7 @@ dispose (GObject *object)
g_slice_free (PlatformLinkCbData, data); g_slice_free (PlatformLinkCbData, data);
} }
g_slist_free_full (priv->auth_chains, (GDestroyNotify) nm_auth_chain_unref); g_slist_free_full (priv->auth_chains, (GDestroyNotify) nm_auth_chain_destroy);
priv->auth_chains = NULL; priv->auth_chains = NULL;
nm_clear_g_source (&priv->devices_inited_id); nm_clear_g_source (&priv->devices_inited_id);

12
src/settings/nm-agent-manager.c
View File

@@ -360,7 +360,7 @@ agent_register_permissions_done (NMAuthChain *chain,
request_add_agent (c_list_entry (iter, Request, lst_request), agent); request_add_agent (c_list_entry (iter, Request, lst_request), agent);
} }
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static NMSecretAgent * static NMSecretAgent *
@@ -539,7 +539,7 @@ request_free (Request *req)
g_object_unref (req->con.connection); g_object_unref (req->con.connection);
g_free (req->con.path); g_free (req->con.path);
if (req->con.chain) if (req->con.chain)
nm_auth_chain_unref (req->con.chain); nm_auth_chain_destroy (req->con.chain);
if (req->request_type == REQUEST_TYPE_CON_GET) { if (req->request_type == REQUEST_TYPE_CON_GET) {
g_free (req->con.get.setting_name); g_free (req->con.get.setting_name);
g_strfreev (req->con.get.hints); g_strfreev (req->con.get.hints);
@@ -810,7 +810,7 @@ request_remove_agent (Request *req, NMSecretAgent *agent)
case REQUEST_TYPE_CON_DEL: case REQUEST_TYPE_CON_DEL:
if (req->con.chain) { if (req->con.chain) {
/* This cancels the pending authorization requests. */ /* This cancels the pending authorization requests. */
nm_auth_chain_unref (req->con.chain); nm_auth_chain_destroy (req->con.chain);
req->con.chain = NULL; req->con.chain = NULL;
} }
break; break;
@@ -1047,7 +1047,7 @@ _con_get_request_start_validated (NMAuthChain *chain,
_con_get_request_start_proceed (req, req->con.current_has_modify); _con_get_request_start_proceed (req, req->con.current_has_modify);
} }
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -1541,7 +1541,7 @@ agent_permissions_changed_done (NMAuthChain *chain,
nm_secret_agent_add_permission (agent, NM_AUTH_PERMISSION_WIFI_SHARE_PROTECTED, share_protected); nm_secret_agent_add_permission (agent, NM_AUTH_PERMISSION_WIFI_SHARE_PROTECTED, share_protected);
nm_secret_agent_add_permission (agent, NM_AUTH_PERMISSION_WIFI_SHARE_OPEN, share_open); nm_secret_agent_add_permission (agent, NM_AUTH_PERMISSION_WIFI_SHARE_OPEN, share_open);
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -1616,7 +1616,7 @@ cancel_more:
goto cancel_more; goto cancel_more;
} }
g_slist_free_full (priv->chains, (GDestroyNotify) nm_auth_chain_unref); g_slist_free_full (priv->chains, (GDestroyNotify) nm_auth_chain_destroy);
priv->chains = NULL; priv->chains = NULL;
if (priv->agents) { if (priv->agents) {

4
src/settings/nm-settings-connection.c
View File

@@ -1408,7 +1408,7 @@ pk_auth_cb (NMAuthChain *chain,
callback (self, context, subject, error, callback_data); callback (self, context, subject, error, callback_data);
g_clear_error (&error); g_clear_error (&error);
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
/** /**
@@ -3024,7 +3024,7 @@ dispose (GObject *object)
g_clear_object (&priv->agent_secrets); g_clear_object (&priv->agent_secrets);
/* Cancel PolicyKit requests */ /* Cancel PolicyKit requests */
g_slist_free_full (priv->pending_auths, (GDestroyNotify) nm_auth_chain_unref); g_slist_free_full (priv->pending_auths, (GDestroyNotify) nm_auth_chain_destroy);
priv->pending_auths = NULL; priv->pending_auths = NULL;
g_clear_pointer (&priv->seen_bssids, g_hash_table_destroy); g_clear_pointer (&priv->seen_bssids, g_hash_table_destroy);

6
src/settings/nm-settings.c
View File

@@ -1205,7 +1205,7 @@ pk_add_cb (NMAuthChain *chain,
send_agent_owned_secrets (self, added, subject); send_agent_owned_secrets (self, added, subject);
g_clear_error (&error); g_clear_error (&error);
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
/* FIXME: remove if/when kernel supports adhoc wpa */ /* FIXME: remove if/when kernel supports adhoc wpa */
@@ -1563,7 +1563,7 @@ pk_hostname_cb (NMAuthChain *chain,
else else
g_dbus_method_invocation_return_value (context, NULL); g_dbus_method_invocation_return_value (context, NULL);
nm_auth_chain_unref (chain); nm_auth_chain_destroy (chain);
} }
static void static void
@@ -1912,7 +1912,7 @@ dispose (GObject *object)
NMSettings *self = NM_SETTINGS (object); NMSettings *self = NM_SETTINGS (object);
NMSettingsPrivate *priv = NM_SETTINGS_GET_PRIVATE (self); NMSettingsPrivate *priv = NM_SETTINGS_GET_PRIVATE (self);
g_slist_free_full (priv->auths, (GDestroyNotify) nm_auth_chain_unref); g_slist_free_full (priv->auths, (GDestroyNotify) nm_auth_chain_destroy);
priv->auths = NULL; priv->auths = NULL;
g_object_unref (priv->agent_mgr); g_object_unref (priv->agent_mgr);