X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=src%2Fdevtools.h;h=44965c37078e38c11ff5604ba7c4b48b2b6887f5;hb=4b6c01b1d5383b1a7417244a31ad4652aab2d5db;hp=3c5f9433b20cf4cdd4e1d57d0b07b802941d440c;hpb=556532a450e55746e0f5c1c580d109b2744566da;p=meshlink diff --git a/src/devtools.h b/src/devtools.h index 3c5f9433..44965c37 100644 --- a/src/devtools.h +++ b/src/devtools.h @@ -41,7 +41,6 @@ struct devtool_edge { // changed by meshlink. struct sockaddr_storage address;///< The address information associated // with this edge. - uint32_t options; ///< Edge options. @TODO what are edge options? int weight; ///< Weight assigned to this edge. }; @@ -68,11 +67,11 @@ struct devtool_edge { * @return A pointer to an array containing devtool_edge_t elements, * or NULL in case of an error. * If the @a edges @a argument was not NULL, then the - * retun value can be either the same value or a different + * return value can be either the same value or a different * value. If the new values is NULL, then the old array * will have been freed by Meshlink. */ -extern devtool_edge_t *devtool_get_all_edges(meshlink_handle_t *mesh, devtool_edge_t *edges, size_t *nmemb); +devtool_edge_t *devtool_get_all_edges(meshlink_handle_t *mesh, devtool_edge_t *edges, size_t *nmemb); /// Export a list of edges to a file in JSON format. /* @param mesh A handle which represents an instance of MeshLink. @@ -80,14 +79,13 @@ extern devtool_edge_t *devtool_get_all_edges(meshlink_handle_t *mesh, devtool_ed * * @return True in case of success, false otherwise. */ -extern bool devtool_export_json_all_edges_state(meshlink_handle_t *mesh, FILE *stream); +bool devtool_export_json_all_edges_state(meshlink_handle_t *mesh, FILE *stream); /// The status of a node. typedef struct devtool_node_status devtool_node_status_t; /// The status of a node. struct devtool_node_status { - uint32_t options; uint32_t status; struct sockaddr_storage address; uint16_t mtu; @@ -118,7 +116,7 @@ struct devtool_node_status { * The contents of this variable will be changed to reflect * the current status of the node. */ -extern void devtool_get_node_status(meshlink_handle_t *mesh, meshlink_node_t *node, devtool_node_status_t *status); +void devtool_get_node_status(meshlink_handle_t *mesh, meshlink_node_t *node, devtool_node_status_t *status); /// Get the list of all submeshes of a meshlink instance. /** This function returns an array of submesh handles. @@ -132,7 +130,7 @@ extern void devtool_get_node_status(meshlink_handle_t *mesh, meshlink_node_t *no * The contents of this variable will be changed to indicate * the number if array elements. */ -extern meshlink_submesh_t **devtool_get_all_submeshes(meshlink_handle_t *mesh, meshlink_submesh_t **submeshes, size_t *nmemb); +meshlink_submesh_t **devtool_get_all_submeshes(meshlink_handle_t *mesh, meshlink_submesh_t **submeshes, size_t *nmemb); /// Open a MeshLink instance in a given network namespace. /** This function opens MeshLink in the given network namespace. @@ -149,6 +147,52 @@ extern meshlink_submesh_t **devtool_get_all_submeshes(meshlink_handle_t *mesh, m * @return A pointer to a meshlink_handle_t which represents this instance of MeshLink, or NULL in case of an error. * The pointer is valid until meshlink_close() is called. */ -extern meshlink_handle_t *devtool_open_in_netns(const char *confbase, const char *name, const char *appname, dev_class_t devclass, int netns); +meshlink_handle_t *devtool_open_in_netns(const char *confbase, const char *name, const char *appname, dev_class_t devclass, int netns); + +/// Debug function pointer variable for set port API +/** This function pointer variable is a userspace tracepoint or debugger callback for + * set port function @a meshlink_set_port @a. + * On assigning a debug function variable invokes callback when try_bind() succeeds in meshlink_set_port API. + * + */ +extern void (*devtool_trybind_probe)(void); + +/// Debug function pointer variable for encrypted key rotate API +/** This function pointer variable is a userspace tracepoint or debugger callback for + * encrypted key rotation function @a meshlink_encrypted_key_rotate @a. + * On assigning a debug function variable invokes callback for each stage from the key rotate API. + * + * @param stage Debug stage number. + */ +extern void (*devtool_keyrotate_probe)(int stage); + +/// Debug function pointer variable for asynchronous DNS resolving +extern void (*devtool_adns_resolve_probe)(void); + +/// Debug function pointer variable for SPTPS key renewal +/** This function pointer variable is a userspace tracepoint or debugger callback for + * SPTPS key renewal. + * + * @param node The node whose SPTPS key(s) are being renewed + */ +extern void (*devtool_sptps_renewal_probe)(meshlink_node_t *node); + +/// Force renewal of SPTPS sessions with the given node. +/** This causes the SPTPS sessions for both the UDP and TCP connections to renew their keys. + * + * @param mesh A handle which represents an instance of MeshLink. + * @param node The node whose SPTPS key(s) should be renewed + */ +void devtool_force_sptps_renewal(meshlink_handle_t *mesh, meshlink_node_t *node); + +/// Debug function pointer variable for asserting inviter/invitee committing sequence +/** This function pointer variable is a userspace tracepoint or debugger callback which + * invokes either after inviter writing invitees host file into the disk + * or after invitee writing it's main config file and host config files that inviter sent into + * the disk. + * + * @param inviter_commited_first true if inviter committed first else false if invitee committed first the other host file into the disk. + */ +extern void (*devtool_set_inviter_commits_first)(bool inviter_commited_first); #endif