mesh: Always deliver tokens via JoinComplete
v4 cover mesh: Always deliver tokens via JoinComplete
This patchset implements API change discussed in
https://marc.info/?l=linux-bluetooth&m=157660821400352&w=2
v4:
- Restore original C parameters on the response for dbus send_with_reply. Any parameters can now be "returned" by the App, and a NULL message indicates an internally generated time-out
v3:
- Add distribution independant timeout for JoinComplete() method calls such that a 30 second timeout of the call is treated as failure, so stale nodes clean up correctly
v2:
- Fix mesh-cfgclient to send JoinComplete reply before calling Attach
Brian Gix (1):
mesh: Add Time-outs to critical dbus send-with-replies
Michał Lowas-Rzechonek (1):
doc/mesh: Change API to deliver tokens via JoinComplete
Przemysław Fierek (2):
mesh: Change API to deliver tokens via JoinComplete tools/mesh-cfgclient: Add waiting for 'JoinComplete'
doc/mesh-api.txt | 22 ++++++++---- mesh/dbus.c | 40 ++++++++++++++++++++++ mesh/dbus.h | 6 ++++ mesh/mesh.c | 68 ++++++++++++++++++++++++++++-------- tools/mesh-cfgclient.c | 78 +++++++++++++++++++++++++----------------- 5 files changed, 160 insertions(+), 54 deletions(-)
Signature · 1 line
2.21.1
PATCH v4 1/4 doc/mesh: Change API to deliver tokens via JoinComplete
From: Michał Lowas-Rzechonek <[email protected]>
If Application is not be able to reliably store the token, the daemon will end up with a uncontrollable node in its database.
Let's fix the issue by always delivering tokens using JoinComplete call, and expecting a reply - if the application return an error, daemon will get rid of the node.
--- doc/mesh-api.txt | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-)
doc/mesh-api.txt +15 -7
@@ -29,6 +29,10 @@ Methods: therefore attempting to call this function using already registered UUID results in an error. + When provisioning finishes, the daemon will call either + JoinComplete or JoinFailed method on object implementing + org.bluez.mesh.Application1 interface. + PossibleErrors: org.bluez.mesh.Error.InvalidArguments org.bluez.mesh.Error.AlreadyExists,
@@ -123,7 +127,7 @@ Methods: PossibleErrors: org.bluez.mesh.Error.InvalidArguments - uint64 token CreateNetwork(object app_root, array{byte}[16] uuid) + void CreateNetwork(object app_root, array{byte}[16] uuid) This is the first method that an application calls to become a Provisioner node, and a Configuration Client on a newly
@@ -155,11 +159,14 @@ Methods: unicast address (0x0001), and create and assign a net_key as the primary network net_index (0x000). + When creation finishes, the daemon will call JoinComplete method + on object implementing org.bluez.mesh.Application1 interface. + PossibleErrors: org.bluez.mesh.Error.InvalidArguments org.bluez.mesh.Error.AlreadyExists, - uint64 token Import(object app_root, array{byte}[16] uuid, + void Import(object app_root, array{byte}[16] uuid, array{byte}[16] dev_key, array{byte}[16] net_key, uint16 net_index, dict flags, uint32 iv_index, uint16 unicast)
@@ -204,11 +211,8 @@ Methods: The unicast parameter is the primary unicast address of the imported node. - The returned token must be preserved by the application in - order to authenticate itself to the mesh daemon and attach to - the network as a mesh node by calling Attach() method or - permanently remove the identity of the mesh node by calling - Leave() method. + When import finishes, the daemon will call JoinComplete method + on object implementing org.bluez.mesh.Application1 interface. PossibleErrors: org.bluez.mesh.Error.InvalidArguments,
@@ -758,6 +762,10 @@ Methods: permanently remove the identity of the mesh node by calling Leave() method. + If this method returns an error, the daemon will assume that the + application failed to preserve the token, and will remove the + freshly created node. + void JoinFailed(string reason) This method is called when the node provisioning initiated by
Signature · 1 line
2.21.1
PATCH v4 2/4 mesh: Change API to deliver tokens via JoinComplete
In reply to Brian GixFrom: Przemysław Fierek <[email protected]>
This patch changes Import and CreateNetwork API to deliver tokens via the JoinComplete method call. When application doesn't raise any error during handling JoinComplete then it is assumed that the token has been saved, otherwise when application replies with an error message then the node is removed.
--- mesh/mesh.c | 63 ++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 48 insertions(+), 15 deletions(-)
mesh/mesh.c +48 -15
@@ -429,6 +429,17 @@ 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, +void *user_data) +{ +bool failed =l_dbus_message_is_error (message); + +if (!failed) +node_attach_io (join_pending->node, mesh.io); + +free_pending_join_call (failed); +} +static bool prov_complete_cb (void *user_data,uint8_t status,struct mesh_prov_node_info *info) {
@@ -455,7 +466,6 @@ static bool prov_complete_cb(void *user_data, uint8_t status,return false; } -node_attach_io (join_pending->node, mesh.io); token =node_get_token (join_pending->node); msg = l_dbus_message_new_method_call(dbus, owner, path,
@@ -463,10 +473,8 @@ static bool prov_complete_cb(void *user_data, uint8_t status, "JoinComplete");l_dbus_message_set_arguments (msg,"t" ,l_get_be64 (token)); - -l_dbus_send (dbus, msg); - -free_pending_join_call (false); +l_dbus_send_with_reply (dbus, msg, + prov_join_complete_reply_cb,NULL ,NULL );return true; }
@@ -660,11 +668,28 @@ 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, +void *user_data) +{ +struct mesh_node *node = user_data; + +if (l_dbus_message_is_error (message)) { +node_remove (node); +return ; + } + +node_attach_io (node, mesh.io); +} +static void create_node_ready_cb (void *user_data,int status,struct mesh_node *node) { +struct l_dbus *dbus =dbus_get_bus ();struct l_dbus_message *reply;struct l_dbus_message *pending_msg; +struct l_dbus_message *msg; +const char *owner; +const char *path;const uint8_t *token; pending_msg =l_queue_find (pending_queue, simple_match, user_data);
@@ -673,20 +698,28 @@ static void create_node_ready_cb(void *user_data, int status,if (status !=MESH_ERROR_NONE ) { reply =dbus_error (pending_msg, status,NULL ); - goto done; - } -node_attach_io (node, mesh.io); +l_dbus_send (dbus_get_bus (), reply); +l_queue_remove (pending_queue, pending_msg); +return ; + } reply =l_dbus_message_new_method_return (pending_msg); + +l_dbus_send (dbus, reply); +l_queue_remove (pending_queue, pending_msg); + + owner =l_dbus_message_get_sender (pending_msg); + path =node_get_app_path (node); token =node_get_token (node); -l_debug (); -l_dbus_message_set_arguments (reply,"t" ,l_get_be64 (token)); + msg =l_dbus_message_new_method_call (dbus, owner, path, +MESH_APPLICATION_INTERFACE , +"JoinComplete" ); -done: -l_dbus_send (dbus_get_bus (), reply); -l_queue_remove (pending_queue, pending_msg); +l_dbus_message_set_arguments (msg,"t" ,l_get_be64 (token)); +l_dbus_send_with_reply (dbus, msg, + create_join_complete_reply_cb, node,NULL ); } static struct l_dbus_message *create_network_call(struct l_dbus *dbus,
@@ -840,11 +873,11 @@ static void setup_network_interface(struct l_dbus_interface *iface) "token");l_dbus_interface_method (iface,"CreateNetwork" ,0 , create_network_call, -"t" ,"oay" ,"token" ,"app" ,"uuid" ); +"" ,"oay" ,"app" ,"uuid" );l_dbus_interface_method (iface,"Import" ,0 , import_call, -"t" ,"oayayayqa{sv}uq" ,"token" , +"" ,"oayayayqa{sv}uq" ,"app" ,"uuid" ,"dev_key" ,"net_key" ,"net_index" ,"flags" ,"iv_index" ,"unicast" );
Signature · 1 line
2.21.1
PATCH v4 3/4 tools/mesh-cfgclient: Add waiting for 'JoinComplete'
In reply to Brian GixFrom: Przemysław Fierek <[email protected]>
--- tools/mesh-cfgclient.c | 78 +++++++++++++++++++++++++----------------- 1 file changed, 46 insertions(+), 32 deletions(-)
tools/mesh-cfgclient.c +46 -32
@@ -707,44 +707,13 @@ static void attach_node_setup(struct l_dbus_message *msg, void *user_data)static void create_net_reply (struct l_dbus_proxy *proxy,struct l_dbus_message *msg,void *user_data) { -char *str; -uint64_t tmp; -if (l_dbus_message_is_error (msg)) {const char *name;l_dbus_message_get_error (msg, &name,NULL );l_error ("Failed to create network: %s" , name);return ; - - } - -if (!l_dbus_message_get_arguments (msg,"t" , &tmp)) -return ; - - local = l_new(struct meshcfg_node, 1); - local->token.u64 =l_get_be64 (&tmp); - str =l_util_hexstring (&local->token.u8[0 ],8 ); -bt_shell_printf ("Created new node with token %s\n" , str); -l_free (str); - -if (!mesh_db_create (cfg_fname, local->token.u8, -"Mesh Config Client Network" )) { -l_free (local); - local =NULL ; -return ; } - -mesh_db_set_addr_range (low_addr, high_addr); -keys_add_net_key (PRIMARY_NET_IDX ); -mesh_db_net_key_add (PRIMARY_NET_IDX ); - -remote_add_node (app.uuid,0x0001 ,1 ,PRIMARY_NET_IDX ); -mesh_db_add_node (app.uuid,0x0001 ,1 ,PRIMARY_NET_IDX ); - -l_dbus_proxy_method_call (net_proxy,"Attach" , attach_node_setup, - attach_node_reply,NULL , -NULL ); }static void create_net_setup (struct l_dbus_message *msg,void *user_data)
@@ -1727,7 +1696,7 @@ static struct l_dbus_message *add_node_fail_call(struct l_dbus *dbus,static void setup_prov_iface (struct l_dbus_interface *iface) {l_dbus_interface_method (iface,"ScanResult" ,0 , scan_result_call,"" , -"naya{sv}" ,"rssi" ,"data" ,"options" ); +"naya{sv}" ,"rssi" ,"data" ,"options" );l_dbus_interface_method (iface,"RequestProvData" ,0 , req_prov_call,"qq" ,"y" ,"net_index" ,"unicast" ,"count" );
@@ -1779,6 +1748,48 @@ static bool crpl_getter(struct l_dbus *dbus,return true; } +static void attach_node (void *user_data) +{ +l_dbus_proxy_method_call (net_proxy,"Attach" , attach_node_setup, + attach_node_reply,NULL , +NULL ); +} + +static struct l_dbus_message *join_complete (struct l_dbus *dbus, +struct l_dbus_message *message, +void *user_data) +{ +char *str; +uint64_t tmp; + +if (!l_dbus_message_get_arguments (message,"t" , &tmp)) +return l_dbus_message_new_error (message, dbus_err_args,NULL ); + + local = l_new(struct meshcfg_node, 1); + local->token.u64 =l_get_be64 (&tmp); + str =l_util_hexstring (&local->token.u8[0 ],8 ); +bt_shell_printf ("Created new node with token %s\n" , str); +l_free (str); + +if (!mesh_db_create (cfg_fname, local->token.u8, +"Mesh Config Client Network" )) { +l_free (local); + local =NULL ; +return l_dbus_message_new_error (message, dbus_err_fail,NULL ); + } + +mesh_db_set_addr_range (low_addr, high_addr); +keys_add_net_key (PRIMARY_NET_IDX ); +mesh_db_net_key_add (PRIMARY_NET_IDX ); + +remote_add_node (app.uuid,0x0001 ,1 ,PRIMARY_NET_IDX ); +mesh_db_add_node (app.uuid,0x0001 ,1 ,PRIMARY_NET_IDX ); + +l_idle_oneshot (attach_node,NULL ,NULL ); + +return l_dbus_message_new_method_return (message); +} +static void setup_app_iface (struct l_dbus_interface *iface) { l_dbus_interface_property(iface, "CompanyID", 0, "q", cid_getter,
@@ -1789,6 +1800,9 @@ static void setup_app_iface(struct l_dbus_interface *iface) NULL);l_dbus_interface_property (iface,"CRPL" ,0 ,"q" , crpl_getter,NULL ); +l_dbus_interface_method (iface,"JoinComplete" ,0 , join_complete, +"" ,"t" ,"token" ); +/* TODO: Methods */ }
Signature · 1 line
2.21.1
PATCH v4 4/4 mesh: Add Time-outs to critical dbus send-with-replies
In reply to Brian GixJoinComplete() dbus method calls are the only time that node tokens are delivered to client Applications, so if the call fails for any reason (including time-outs) the daemon has a way to clean-up the stale unused node data.
--- mesh/dbus.c | 40 ++++++++++++++++++++++++++++++++++++++++ mesh/dbus.h | 6 ++++++ mesh/mesh.c | 19 ++++++++++++------- 3 files changed, 58 insertions(+), 7 deletions(-)
mesh/dbus.c +40 -0
@@ -37,6 +37,14 @@ struct error_entry {const char *default_desc; }; +struct send_info { +struct l_dbus *dbus; +struct l_timeout *timeout; +l_dbus_message_func_t cb; +void *user_data; +uint32_t serial; +}; +/* * Important: The entries in this table follow the order of * enumerated values in mesh_error (file error.h)
@@ -143,3 +151,35 @@ void dbus_append_dict_entry_basic(struct l_dbus_message_builder *builder,l_dbus_message_builder_leave_variant (builder);l_dbus_message_builder_leave_dict (builder); } + +static void send_reply (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); +l_free (info); +} + +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); +} + +void dbus_send_with_timeout (struct l_dbus *dbus,struct l_dbus_message *msg, +l_dbus_message_func_t cb, +void *user_data, +unsigned int seconds) +{ + struct send_info *info = l_new(struct send_info, 1); + + info->dbus = dbus; + info->cb = cb; + info->user_data = user_data; + info->serial =l_dbus_send_with_reply (dbus, msg, send_reply, + info,NULL ); + info->timeout =l_timeout_create (seconds, send_timeout, info,NULL ); +}
mesh/dbus.h +6 -0
@@ -20,6 +20,8 @@#define BLUEZ_MESH_PATH "/org/bluez/mesh"#define BLUEZ_MESH_SERVICE "org.bluez.mesh" +#define DEFAULT_DBUS_TIMEOUT 30 +bool dbus_init (struct l_dbus *dbus);struct l_dbus *dbus_get_bus (void ); void dbus_append_byte_array(struct l_dbus_message_builder *builder,
@@ -31,3 +33,7 @@ bool dbus_match_interface(struct l_dbus_message_iter *interfaces, const char *match);struct l_dbus_message *dbus_error (struct l_dbus_message *msg,int err,const char *description); +void dbus_send_with_timeout (struct l_dbus *dbus,struct l_dbus_message *msg, +l_dbus_message_func_t cb, +void *user_data, +unsigned int seconds);
mesh/mesh.c +12 -7
@@ -430,9 +430,12 @@ static void send_join_failed(const char *owner, const char *path, }static void prov_join_complete_reply_cb (struct l_dbus_message *message, -void *user_data) +void *user_data) { -bool failed =l_dbus_message_is_error (message); +bool failed = false; + +if (!message ||l_dbus_message_is_error (message)) + failed = true;if (!failed)node_attach_io (join_pending->node, mesh.io);
@@ -468,13 +471,14 @@ static bool prov_complete_cb(void *user_data, uint8_t status, token =node_get_token (join_pending->node); +l_debug ("Calling JoinComplete (prov)" ); msg =l_dbus_message_new_method_call (dbus, owner, path,MESH_APPLICATION_INTERFACE ,"JoinComplete" );l_dbus_message_set_arguments (msg,"t" ,l_get_be64 (token)); -l_dbus_send_with_reply (dbus, msg, - prov_join_complete_reply_cb,NULL ,NULL ); +dbus_send_with_timeout (dbus, msg, prov_join_complete_reply_cb, +NULL ,DEFAULT_DBUS_TIMEOUT );return true; }
@@ -673,7 +677,7 @@ static void create_join_complete_reply_cb(struct l_dbus_message *message, {struct mesh_node *node = user_data; -if (l_dbus_message_is_error (message)) { +if (!message ||l_dbus_message_is_error (message)) {node_remove (node);return ; }
@@ -713,13 +717,14 @@ static void create_node_ready_cb(void *user_data, int status, path =node_get_app_path (node); token =node_get_token (node); +l_debug ("Calling JoinComplete (create)" ); msg =l_dbus_message_new_method_call (dbus, owner, path,MESH_APPLICATION_INTERFACE ,"JoinComplete" );l_dbus_message_set_arguments (msg,"t" ,l_get_be64 (token)); -l_dbus_send_with_reply (dbus, msg, - create_join_complete_reply_cb, node,NULL ); +dbus_send_with_timeout (dbus, msg, create_join_complete_reply_cb, + node,DEFAULT_DBUS_TIMEOUT ); } static struct l_dbus_message *create_network_call(struct l_dbus *dbus,
Signature · 1 line
2.21.1