]> git.meshlink.io Git - meshlink/blob - src/devtools.h
Add UTCP UDP channel corner cases and test cases on channel get MSS length API
[meshlink] / src / devtools.h
1 #ifndef MESHLINK_DEVTOOLS_H
2 #define MESHLINK_DEVTOOLS_H
3
4 /*
5     devtools.h -- header for devtools.h
6     Copyright (C) 2014, 2017 Guus Sliepen <guus@meshlink.io>
7
8     This program is free software; you can redistribute it and/or modify
9     it under the terms of the GNU General Public License as published by
10     the Free Software Foundation; either version 2 of the License, or
11     (at your option) any later version.
12
13     This program is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16     GNU General Public License for more details.
17
18     You should have received a copy of the GNU General Public License along
19     with this program; if not, write to the Free Software Foundation, Inc.,
20     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 */
22
23 /// \file devtools.h
24 /** This header files declares functions that are only intended for debugging and quality control.
25  *  They are not necessary for the normal operation of MeshLink.
26  *  Applications should not depend on any of these functions for their normal operation.
27  */
28
29 /// An edge in the MeshLink network.
30 typedef struct devtool_edge devtool_edge_t;
31
32 /// An edge in the MeshLink network.
33 struct devtool_edge {
34         struct meshlink_node *from;     ///< Pointer to a node. Node memory is
35         //   owned by meshlink and should not be
36         //   deallocated. Node contents may be
37         //   changed by meshlink.
38         struct meshlink_node *to;       ///< Pointer to a node. Node memory is
39         //   owned by meshlink and should not be
40         //   deallocated. Node contents may be
41         //   changed by meshlink.
42         struct sockaddr_storage address;///< The address information associated
43         //   with this edge.
44         int weight;                     ///< Weight assigned to this edge.
45 };
46
47 /// Get a list of edges.
48 /** This function returns an array with copies of all known bidirectional edges.
49  *  The edges are copied to capture the mesh state at call time, since edges
50  *  mutate frequently. The nodes pointed to within the devtool_edge_t type
51  *  are not copies; these are the same pointers that one would get from a call
52  *  to meshlink_get_all_nodes().
53  *
54  *  @param mesh         A handle which represents an instance of MeshLink.
55  *  @param edges        A pointer to a previously allocated array of
56  *                      devtool_edge_t, or NULL in which case MeshLink will
57  *                      allocate a new array.
58  *                      The application is allowed to call free() on the array whenever it wishes.
59  *                      The pointers in the devtool_edge_t elements are valid until
60  *                      meshlink_close() is called.
61  *  @param nmemb        A pointer to a variable holding the number of elements that
62  *                      are stored in the array. In case the @a edges @a
63  *                      argument is not NULL, MeshLink might call realloc()
64  *                      on the array to change its size.
65  *                      The contents of this variable will be changed to reflect
66  *                      the new size of the array.
67  *  @return             A pointer to an array containing devtool_edge_t elements,
68  *                      or NULL in case of an error.
69  *                      If the @a edges @a argument was not NULL, then the
70  *                      return value can be either the same value or a different
71  *                      value. If the new values is NULL, then the old array
72  *                      will have been freed by Meshlink.
73  */
74 extern devtool_edge_t *devtool_get_all_edges(meshlink_handle_t *mesh, devtool_edge_t *edges, size_t *nmemb);
75
76 /// Export a list of edges to a file in JSON format.
77 /*  @param mesh         A handle which represents an instance of MeshLink.
78  *  @param FILE         An open file descriptor to which a JSON representation of the edges will be written.
79  *
80  *  @return             True in case of success, false otherwise.
81  */
82 extern bool devtool_export_json_all_edges_state(meshlink_handle_t *mesh, FILE *stream);
83
84 /// The status of a node.
85 typedef struct devtool_node_status devtool_node_status_t;
86
87 /// The status of a node.
88 struct devtool_node_status {
89         uint32_t status;
90         struct sockaddr_storage address;
91         uint16_t mtu;
92         uint16_t minmtu;
93         uint16_t maxmtu;
94         int mtuprobes;
95         enum {
96                 DEVTOOL_UDP_FAILED = -2,     /// UDP tried but failed
97                 DEVTOOL_UDP_IMPOSSIBLE = -1, /// UDP not possible (node unreachable)
98                 DEVTOOL_UDP_UNKNOWN = 0,     /// UDP status not known (never tried to communicate with the node)
99                 DEVTOOL_UDP_TRYING,          /// UDP detection in progress
100                 DEVTOOL_UDP_WORKING,         /// UDP communication established
101         } udp_status;
102         uint64_t in_packets;
103         uint64_t in_bytes;
104         uint64_t out_packets;
105         uint64_t out_bytes;
106 };
107
108 /// Get the status of a node.
109 /** This function returns a struct containing extra information about a node.
110  *  The information is a snapshot taken at call time.
111  *
112  *  @param mesh         A handle which represents an instance of MeshLink.
113  *  @param node         A pointer to a meshlink_node_t.
114  *  @param status       A pointer to a devtools_node_status_t variable that has
115  *                      to be provided by the caller.
116  *                      The contents of this variable will be changed to reflect
117  *                      the current status of the node.
118  */
119 extern void devtool_get_node_status(meshlink_handle_t *mesh, meshlink_node_t *node, devtool_node_status_t *status);
120
121 /// Get the list of all submeshes of a meshlink instance.
122 /** This function returns an array of submesh handles.
123  *  These pointers are the same pointers that are present in the submeshes list
124  *  in mesh handle.
125  *
126  *  @param mesh         A handle which represents an instance of MeshLink.
127  *  @param submeshes    A pointer to an array of submesh handles if any allocated previously.
128  *  @param nmemb        A pointer to a size_t variable that has
129  *                      to be provided by the caller.
130  *                      The contents of this variable will be changed to indicate
131  *                      the number if array elements.
132  */
133 extern meshlink_submesh_t **devtool_get_all_submeshes(meshlink_handle_t *mesh, meshlink_submesh_t **submeshes, size_t *nmemb);
134
135 /// Open a MeshLink instance in a given network namespace.
136 /** This function opens MeshLink in the given network namespace.
137  *
138  *  @param confbase The directory in which MeshLink will store its configuration files.
139  *                  After the function returns, the application is free to overwrite or free @a confbase @a.
140  *  @param name     The name which this instance of the application will use in the mesh.
141  *                  After the function returns, the application is free to overwrite or free @a name @a.
142  *  @param appname  The application name which will be used in the mesh.
143  *                  After the function returns, the application is free to overwrite or free @a name @a.
144  *  @param devclass The device class which will be used in the mesh.
145  *  @param netns    A filedescriptor that represents the network namespace.
146  *
147  *  @return         A pointer to a meshlink_handle_t which represents this instance of MeshLink, or NULL in case of an error.
148  *                  The pointer is valid until meshlink_close() is called.
149  */
150 extern meshlink_handle_t *devtool_open_in_netns(const char *confbase, const char *name, const char *appname, dev_class_t devclass, int netns);
151
152 /// Debug function pointer variable for set port API
153 /** This function pointer variable is a userspace tracepoint or debugger callback for
154  *  set port function @a meshlink_set_port @a.
155  *  On assigning a debug function variable invokes callback when try_bind() succeeds in meshlink_set_port API.
156  *
157  */
158 extern void (*devtool_trybind_probe)(void);
159
160 /// Debug function pointer variable for encrypted key rotate API
161 /** This function pointer variable is a userspace tracepoint or debugger callback for
162  *  encrypted key rotation function @a meshlink_encrypted_key_rotate @a.
163  *  On assigning a debug function variable invokes callback for each stage from the key rotate API.
164  *
165  *  @param stage Debug stage number.
166  */
167 extern void (*devtool_keyrotate_probe)(int stage);
168
169 /// Debug function pointer variable for asserting inviter/invitee committing sequence
170 /** This function pointer variable is a userspace tracepoint or debugger callback which
171  *  invokes either after inviter writing invitees host file into the disk
172  *  or after invitee writing it's main config file and host config files that inviter sent into
173  *  the disk.
174  *
175  *  @param inviter_commited_first       true if inviter committed first else false if invitee committed first the other host file into the disk.
176  */
177 extern void (*devtool_set_inviter_commits_first)(bool inviter_commited_first);
178
179 #endif