// 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.
};
* @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.
*
* @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;
uint16_t minmtu;
uint16_t maxmtu;
int mtuprobes;
+
enum {
DEVTOOL_UDP_FAILED = -2, /// UDP tried but failed
DEVTOOL_UDP_IMPOSSIBLE = -1, /// UDP not possible (node unreachable)
DEVTOOL_UDP_TRYING, /// UDP detection in progress
DEVTOOL_UDP_WORKING, /// UDP communication established
} udp_status;
- uint64_t in_packets;
- uint64_t in_bytes;
- uint64_t out_packets;
- uint64_t out_bytes;
+
+ uint64_t in_data; /// Bytes received from channels
+ uint64_t out_data; /// Bytes sent via channels
+ uint64_t in_forward; /// Bytes received for channels that need to be forwarded to other nodes
+ uint64_t out_forward; /// Bytes forwarded from channel from other nodes
+ uint64_t in_meta; /// Bytes received from meta-connections, heartbeat packets etc.
+ uint64_t out_meta; /// Bytes sent on meta-connections, heartbeat packets etc.
};
/// Get the status of a node.
* 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);
+
+/// Reset the traffic counters of a node.
+/** This function resets the byte counters for the given node to zero.
+ * It also returns the status containing the counters right before they are zeroed.
+ *
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param node A pointer to a meshlink_node_t.
+ * @param status A pointer to a devtools_node_status_t variable that has
+ * to be provided by the caller.
+ * The contents of this variable will be changed to reflect
+ * the current status of the node before the counters are zeroed.
+ * If a NULL pointers is passed, no status will be written.
+ */
+void devtool_reset_node_counters(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.
+ * These pointers are the same pointers that are present in the submeshes list
+ * in mesh handle.
+ *
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param submeshes A pointer to an array of submesh handles if any allocated previously.
+ * @param nmemb A pointer to a size_t variable that has
+ * to be provided by the caller.
+ * The contents of this variable will be changed to indicate
+ * the number if array elements.
+ */
+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.
* @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);
+
+/// Set the meta-connection status callback.
+/** This functions sets the callback that is called whenever a meta-connection is made or closed.
+ * The callback is run in MeshLink's own thread.
+ * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
+ * to hand the data over to the application's thread.
+ * The callback should also not block itself and return as quickly as possible.
+ *
+ * \memberof meshlink_handle
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param cb A pointer to the function which will be called when a node's meta-connection status changes.
+ * If a NULL pointer is given, the callback will be disabled.
+ */
+void devtool_set_meta_status_cb(struct meshlink_handle *mesh, meshlink_node_status_cb_t cb);
#endif
projects / meshlink / blobdiff