Put safeguards around Leave & Attach calls
v2 cover Put safeguards around Leave & Attach calls
This set of patches addresses the situation when an application calls Leave() or Attach() methods on a node that has another incomplete method call on Network interface associated with it.
The simple solution is to return error in response to Leave() method if an application still owes the daemon either a reply to GetManagedObjects request in case of Attach() or a reply to JoinComplete() in case of Join(), Create() or Import()
Similarly, a "Busy" error is returned in response to Attach() method if an application still owes the daemon a reply to JoinComplete() in case of pending Join(), Create() or Import()
Inga Stotland (4):
mesh: Make "Busy" and "InProgress" to be distinct errors
mesh: Add destroy callback to dbus_send_with_timeout()
mesh: Add timeout to a get managed objects call
mesh: Add "node is busy" check for Leave() & Attach()
doc/mesh-api.txt | 5 +++- mesh/dbus.c | 14 ++++++++--- mesh/dbus.h | 1 + mesh/error.h | 1 + mesh/manager.c | 11 ++++----- mesh/mesh.c | 22 +++++++++++------ mesh/node.c | 64 +++++++++++++++++++++++++++++++----------------- mesh/node.h | 1 + test/test-mesh | 2 -- 9 files changed, 78 insertions(+), 43 deletions(-)
Signature · 1 line
2.26.2
PATCH v2 1/4 mesh: Make "Busy" and "InProgress" to be distinct errors
This separates "Busy" and "InProgress" error codes:MESH_ERROR_IN_PROGRESS maps to org.bluez.mesh.Error.InProgress MESH_ERROR_BUSY maps to org.bluez.mesh.Error.Busy
Minor API change:UpdateAppKey() returns "InProgress" error instead of "Busy"
--- doc/mesh-api.txt | 2 +- mesh/dbus.c | 3 ++- mesh/error.h | 1 + mesh/manager.c | 11 +++++------ 4 files changed, 9 insertions(+), 8 deletions(-)
doc/mesh-api.txt +1 -1
@@ -654,7 +654,7 @@ Methods: org.bluez.mesh.Error.Failed org.bluez.mesh.Error.InvalidArguments org.bluez.mesh.Error.DoesNotExist - org.bluez.mesh.Error.Busy + org.bluez.mesh.Error.InProgress void DeleteAppKey(uint16 app_index)
mesh/dbus.c +2 -1
@@ -56,7 +56,8 @@ static struct error_entry const error_table[] = { ERROR_INTERFACE ".NotAuthorized", "Permission denied"}, { ERROR_INTERFACE ".NotFound", "Object not found"}, { ERROR_INTERFACE ".InvalidArgs", "Invalid arguments"}, - { ERROR_INTERFACE ".InProgress", "Already in progress"}, + { ERROR_INTERFACE ".InProgress", "Operation already in progress"}, + { ERROR_INTERFACE ".Busy", "Busy"}, { ERROR_INTERFACE ".AlreadyExists", "Already exists"}, { ERROR_INTERFACE ".DoesNotExist", "Does not exist"}, { ERROR_INTERFACE ".Canceled", "Operation canceled"},
mesh/error.h +1 -0
@@ -27,6 +27,7 @@ enum mesh_error {MESH_ERROR_NOT_AUTHORIZED ,MESH_ERROR_NOT_FOUND ,MESH_ERROR_INVALID_ARGS , +MESH_ERROR_IN_PROGRESS ,MESH_ERROR_BUSY ,MESH_ERROR_ALREADY_EXISTS , MESH_ERROR_DOES_NOT_EXIST,
mesh/manager.c +5 -6
@@ -60,7 +60,7 @@ static void scan_cancel(struct l_timeout *timeout, void *user_data)struct mesh_io *io;struct mesh_net *net; -l_debug ("scan_cancel" ); +l_debug ("" );if (scan_timeout)l_timeout_remove (scan_timeout);
@@ -249,11 +249,10 @@ static struct l_dbus_message *add_node_call(struct l_dbus *dbus,return dbus_error (msg,MESH_ERROR_INVALID_ARGS ,NULL );if (!l_dbus_message_iter_get_fixed_array (&iter_uuid, &uuid, &n) - || n !=16 ) { -l_debug ("n = %u" , n); + || n !=16 )return dbus_error (msg,MESH_ERROR_INVALID_ARGS ,"Bad device UUID" ); - } +/* Allow AddNode to cancel Scanning if from the same node */ if (scan_node) {if (scan_node != node)
@@ -263,7 +262,6 @@ static struct l_dbus_message *add_node_call(struct l_dbus *dbus, }/* Invoke Prov Initiator */ - add_pending = l_new(struct add_data, 1);memcpy (add_pending->uuid, uuid,16 ); add_pending->node = node;
@@ -554,7 +552,8 @@ static struct l_dbus_message *update_subnet_call(struct l_dbus *dbus, }/* All other phases mean KR already in progress over-the-air */ -return dbus_error (msg,MESH_ERROR_BUSY ,"Key Refresh in progress" ); +return dbus_error (msg,MESH_ERROR_IN_PROGRESS , +"Key Refresh in progress" ); } static struct l_dbus_message *delete_subnet_call(struct l_dbus *dbus,
Signature · 1 line
2.26.2
PATCH v2 2/4 mesh: Add destroy callback to dbus_send_with_timeout()
In reply to Inga StotlandThis adds a destroy callback as a function parameter to dbus_send_with_timeout() to allow automatic release of user data on either reply or timeout.
--- mesh/dbus.c | 11 ++++++++--- mesh/dbus.h | 1 + mesh/mesh.c | 12 ++++++------ 3 files changed, 15 insertions(+), 9 deletions(-)
mesh/dbus.c +8 -3
@@ -41,6 +41,7 @@ struct send_info {struct l_dbus *dbus;struct l_timeout *timeout;l_dbus_message_func_t cb; +l_dbus_destroy_func_t destroy;void *user_data;uint32_t serial; };
@@ -153,12 +154,14 @@ void dbus_append_dict_entry_basic(struct l_dbus_message_builder *builder,l_dbus_message_builder_leave_dict (builder); } -static void send_reply (struct l_dbus_message *message,void *user_data) +static void send_reply_cb (struct l_dbus_message *message,void *user_data) {struct send_info *info = user_data;l_timeout_remove (info->timeout); info->cb (message, info->user_data); +if (info->destroy) + info->destroy (info->user_data);l_free (info); }
@@ -167,12 +170,13 @@ static void send_timeout(struct l_timeout *timeout, void *user_data)struct send_info *info = user_data;l_dbus_cancel (info->dbus, info->serial); -send_reply (NULL , info); +send_reply_cb (NULL , info); }void dbus_send_with_timeout (struct l_dbus *dbus,struct l_dbus_message *msg,l_dbus_message_func_t cb,void *user_data, +l_dbus_destroy_func_t destroy,unsigned int seconds) { struct send_info *info = l_new(struct send_info, 1);
@@ -180,7 +184,8 @@ void dbus_send_with_timeout(struct l_dbus *dbus, struct l_dbus_message *msg, info->dbus = dbus; info->cb = cb; info->user_data = user_data; - info->serial =l_dbus_send_with_reply (dbus, msg, send_reply, + info->destroy = destroy; + info->serial =l_dbus_send_with_reply (dbus, msg, send_reply_cb, info,NULL ); info->timeout =l_timeout_create (seconds, send_timeout, info,NULL ); }
mesh/dbus.h +1 -0
@@ -36,4 +36,5 @@ struct l_dbus_message *dbus_error(struct l_dbus_message *msg, int err,void dbus_send_with_timeout (struct l_dbus *dbus,struct l_dbus_message *msg,l_dbus_message_func_t cb,void *user_data, +l_dbus_destroy_func_t destroy,unsigned int seconds);
mesh/mesh.c +6 -6
@@ -439,12 +439,12 @@ static void send_join_failed(const char *owner, const char *path,free_pending_join_call (true); } -static void prov_join_complete_reply_cb (struct l_dbus_message *message, +static void prov_join_complete_reply_cb (struct l_dbus_message *msg,void *user_data) {bool failed = false; -if (!message ||l_dbus_message_is_error (message)) +if (!msg ||l_dbus_message_is_error (msg)) failed = true;if (!failed)
@@ -488,7 +488,7 @@ static bool prov_complete_cb(void *user_data, uint8_t status,l_dbus_message_set_arguments (msg,"t" ,l_get_be64 (token));dbus_send_with_timeout (dbus, msg, prov_join_complete_reply_cb, -NULL ,DEFAULT_DBUS_TIMEOUT ); +NULL ,NULL ,DEFAULT_DBUS_TIMEOUT );return true; }
@@ -666,12 +666,12 @@ static struct l_dbus_message *leave_call(struct l_dbus *dbus,return l_dbus_message_new_method_return (msg); } -static void create_join_complete_reply_cb (struct l_dbus_message *message, +static void create_join_complete_reply_cb (struct l_dbus_message *msg,void *user_data) {struct mesh_node *node = user_data; -if (!message ||l_dbus_message_is_error (message)) { +if (!msg ||l_dbus_message_is_error (msg)) {node_remove (node);return ; }
@@ -716,7 +716,7 @@ static void create_node_ready_cb(void *user_data, int status,l_dbus_message_set_arguments (msg,"t" ,l_get_be64 (token));dbus_send_with_timeout (dbus, msg, create_join_complete_reply_cb, - node,DEFAULT_DBUS_TIMEOUT ); + node,NULL ,DEFAULT_DBUS_TIMEOUT );l_dbus_message_unref (pending_msg); }
Signature · 1 line
2.26.2
PATCH v2 3/4 mesh: Add timeout to a get managed objects call
In reply to Inga StotlandSwitch to using dbus_send_with_timeout when making a request to get managed objects from an application.
--- mesh/node.c | 43 ++++++++++++++++++++----------------------- 1 file changed, 20 insertions(+), 23 deletions(-)
mesh/node.c +20 -23
@@ -1459,7 +1459,7 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)struct keyring_net_key net_key;uint8_t dev_key[16 ]; -if (l_dbus_message_is_error (msg)) { +if (!msg ||l_dbus_message_is_error (msg)) {l_error ("Failed to get app's dbus objects" ); goto fail; }
@@ -1616,8 +1616,7 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data) fail:/* Handle failed requests */ -if (node) -node_remove (node); +node_remove (node);if (req->type ==REQUEST_TYPE_JOIN ) req->join_ready_cb (NULL ,NULL );
@@ -1628,6 +1627,20 @@ fail:l_free (req->import); } +static void send_managed_objects_request (const char *destination, +const char *path, +struct managed_obj_request *req) +{ +struct l_dbus_message *msg; + + msg =l_dbus_message_new_method_call (dbus_get_bus (), destination, path, +L_DBUS_INTERFACE_OBJECT_MANAGER , +"GetManagedObjects" ); +l_dbus_message_set_arguments (msg,"" ); +dbus_send_with_timeout (dbus_get_bus (), msg, get_managed_objects_cb, + req, l_free,DEFAULT_DBUS_TIMEOUT ); +} +/* Establish relationship between application and mesh node */ void node_attach (const char *app_root,const char *sender,uint64_t token,node_ready_func_t cb,void *user_data)
@@ -1661,11 +1674,7 @@ void node_attach(const char *app_root, const char *sender, uint64_t token, req->attach = node; req->type =REQUEST_TYPE_ATTACH ; -l_dbus_method_call (dbus_get_bus (), sender, app_root, -L_DBUS_INTERFACE_OBJECT_MANAGER , -"GetManagedObjects" ,NULL , - get_managed_objects_cb, - req, l_free); +send_managed_objects_request (sender, app_root, req); }/* Create a temporary pre-provisioned node */
@@ -1681,11 +1690,7 @@ void node_join(const char *app_root, const char *sender, const uint8_t *uuid, req->join_ready_cb = cb; req->type =REQUEST_TYPE_JOIN ; -l_dbus_method_call (dbus_get_bus (), sender, app_root, -L_DBUS_INTERFACE_OBJECT_MANAGER , -"GetManagedObjects" ,NULL , - get_managed_objects_cb, - req, l_free); +send_managed_objects_request (sender, app_root, req); } void node_import(const char *app_root, const char *sender, const uint8_t *uuid,
@@ -1715,11 +1720,7 @@ void node_import(const char *app_root, const char *sender, const uint8_t *uuid, req->type =REQUEST_TYPE_IMPORT ; -l_dbus_method_call (dbus_get_bus (), sender, app_root, -L_DBUS_INTERFACE_OBJECT_MANAGER , -"GetManagedObjects" ,NULL , - get_managed_objects_cb, - req, l_free); +send_managed_objects_request (sender, app_root, req); } void node_create(const char *app_root, const char *sender, const uint8_t *uuid,
@@ -1735,11 +1736,7 @@ void node_create(const char *app_root, const char *sender, const uint8_t *uuid, req->pending_msg = user_data; req->type =REQUEST_TYPE_CREATE ; -l_dbus_method_call (dbus_get_bus (), sender, app_root, -L_DBUS_INTERFACE_OBJECT_MANAGER , -"GetManagedObjects" ,NULL , - get_managed_objects_cb, - req, l_free); +send_managed_objects_request (sender, app_root, req); }static void build_element_config (void *a,void *b)
Signature · 1 line
2.26.2
PATCH v2 4/4 mesh: Add "node is busy" check for Leave() & Attach()
In reply to Inga StotlandThis introduces the following behavior change for the methods on Network interface that specify node token as an input parameter
Leave() method:
If Leave method is called for a node that is being processed as a result of a Create, Import, Join or Attach method calls in progress, node removal is not allowed and org.bluez.mesh.Error.Busy error is returned.
Attach() method:
If Attach method is called for a node that is being processed as a result of a Create, Import or Join method calls in progress, node attachment is not allowed and org.bluez.mesh.Error.Busy error is returned.
--- doc/mesh-api.txt | 3 +++ mesh/mesh.c | 10 +++++++++- mesh/node.c | 21 +++++++++++++++++++++ mesh/node.h | 1 + test/test-mesh | 2 -- 5 files changed, 34 insertions(+), 3 deletions(-)
doc/mesh-api.txt +3 -0
@@ -116,6 +116,7 @@ Methods: org.bluez.mesh.Error.InvalidArguments org.bluez.mesh.Error.NotFound, org.bluez.mesh.Error.AlreadyExists, + org.bluez.mesh.Error.Busy, org.bluez.mesh.Error.Failed void Leave(uint64 token)
@@ -126,6 +127,8 @@ Methods: PossibleErrors: org.bluez.mesh.Error.InvalidArguments + org.bluez.mesh.Error.NotFound + org.bluez.mesh.Error.Busy void CreateNetwork(object app_root, array{byte}[16] uuid)
mesh/mesh.c +9 -1
@@ -655,13 +655,21 @@ static struct l_dbus_message *leave_call(struct l_dbus *dbus, void *user_data) {uint64_t token; +struct mesh_node *node;l_debug ("Leave" );if (!l_dbus_message_get_arguments (msg,"t" , &token))return dbus_error (msg,MESH_ERROR_INVALID_ARGS ,NULL ); -node_remove (node_find_by_token (token)); + node =node_find_by_token (token); +if (!node) +return dbus_error (msg,MESH_ERROR_NOT_FOUND ,NULL ); + +if (node_is_busy (node)) +return dbus_error (msg,MESH_ERROR_BUSY ,NULL ); + +node_remove (node);return l_dbus_message_new_method_return (msg); }
mesh/node.c +21 -0
@@ -88,6 +88,7 @@ struct mesh_node {char *storage_dir;uint32_t disc_watch;uint32_t seq_number; +bool busy;bool provisioner;uint16_t primary;struct node_composition comp;
@@ -598,6 +599,11 @@ bool node_is_provisioner(struct mesh_node *node)return node->provisioner; } +bool node_is_busy (struct mesh_node *node) +{ +return node->busy; +} +void node_app_key_delete (struct mesh_node *node,uint16_t net_idx,uint16_t app_idx) {
@@ -1352,6 +1358,8 @@ static bool add_local_node(struct mesh_node *node, uint16_t unicast, bool kr,/* Initialize configuration server model */ cfgmod_server_init (node,PRIMARY_ELE_IDX ); + node->busy = true; +return true; }
@@ -1459,6 +1467,9 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)struct keyring_net_key net_key;uint8_t dev_key[16 ]; +if (req->type ==REQUEST_TYPE_ATTACH ) + req->attach->busy = false; +if (!msg ||l_dbus_message_is_error (msg)) {l_error ("Failed to get app's dbus objects" ); goto fail;
@@ -1654,6 +1665,12 @@ void node_attach(const char *app_root, const char *sender, uint64_t token,return ; } +/* Check if there is a pending request associated with this node */ +if (node->busy) { +cb (user_data,MESH_ERROR_BUSY ,NULL ); +return ; + } +/* Check if the node is already in use */ if (node->owner) {l_warn ("The node is already in use" );
@@ -1674,6 +1691,8 @@ void node_attach(const char *app_root, const char *sender, uint64_t token, req->attach = node; req->type =REQUEST_TYPE_ATTACH ; + node->busy = true; +send_managed_objects_request (sender, app_root, req); }
@@ -2347,6 +2366,8 @@ void node_finalize_new_node(struct mesh_node *node, struct mesh_io *io)free_node_dbus_resources (node);mesh_agent_remove (node->agent); + node->busy = false; +/* Register callback for the node's io */ attach_io (node, io); }
mesh/node.h +1 -0
@@ -39,6 +39,7 @@ struct mesh_node *node_find_by_addr(uint16_t addr);struct mesh_node *node_find_by_uuid (uint8_t uuid[16 ]);struct mesh_node *node_find_by_token (uint64_t token);bool node_is_provisioner (struct mesh_node *node); +bool node_is_busy (struct mesh_node *node);void node_app_key_delete (struct mesh_node *node,uint16_t net_idx,uint16_t app_idx);uint16_t node_get_primary (struct mesh_node *node);
test/test-mesh +0 -2
@@ -412,8 +412,6 @@ class Application(dbus.service.Object): token = value have_token = True - if attached == False: - attach(token) @dbus.service.method(MESH_APPLICATION_IFACE, in_signature="s", out_signature="")
Signature · 1 line
2.26.2