GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
#define GNUNET_TESTING_LIB_H
#include "gnunet_util_lib.h"
+#include "gnunet_statistics_service.h"
#ifdef __cplusplus
extern "C"
*/
struct GNUNET_TESTING_Daemon;
+/**
+ * Linked list of hostnames and ports to use for starting daemons.
+ */
+struct GNUNET_TESTING_Host
+{
+ /**
+ * Pointer to next item in the list.
+ */
+ struct GNUNET_TESTING_Host *next;
+
+ /**
+ * Hostname to connect to.
+ */
+ char *hostname;
+
+ /**
+ * Username to use when connecting (may be null).
+ */
+ char *username;
+
+ /**
+ * Port to use for SSH connection (used for ssh
+ * connection forwarding, 0 to let ssh decide)
+ */
+ uint16_t port;
+};
+
/**
* Prototype of a function that will be called whenever
* a daemon was started by the testing library.
*/
char *hostname;
+ /**
+ * Port to use for ssh, NULL to let system choose default.
+ */
+ char *ssh_port_str;
+
/**
* Result of GNUNET_i2s of this peer,
* for printing
* @param cls closure
* @param first peer id for first daemon
* @param second peer id for the second daemon
+ * @param distance distance between the connected peers
* @param first_cfg config for the first daemon
* @param second_cfg config for the second daemon
* @param first_daemon handle for the first daemon
* @param emsg error message (NULL on success)
*/
typedef void (*GNUNET_TESTING_NotifyConnection)(void *cls,
- const struct GNUNET_PeerIdentity *first,
- const struct GNUNET_PeerIdentity *second,
- const struct GNUNET_CONFIGURATION_Handle *first_cfg,
- const struct GNUNET_CONFIGURATION_Handle *second_cfg,
- struct GNUNET_TESTING_Daemon *first_daemon,
- struct GNUNET_TESTING_Daemon *second_daemon,
- const char *emsg);
+ const struct GNUNET_PeerIdentity *first,
+ const struct GNUNET_PeerIdentity *second,
+ uint32_t distance,
+ const struct GNUNET_CONFIGURATION_Handle *first_cfg,
+ const struct GNUNET_CONFIGURATION_Handle *second_cfg,
+ struct GNUNET_TESTING_Daemon *first_daemon,
+ struct GNUNET_TESTING_Daemon *second_daemon,
+ const char *emsg);
+
+/**
+ * Prototype of a callback function indicating that two peers
+ * are currently connected.
+ *
+ * @param cls closure
+ * @param first peer id for first daemon
+ * @param second peer id for the second daemon
+ * @param distance distance between the connected peers
+ * @param emsg error message (NULL on success)
+ */
+typedef void (*GNUNET_TESTING_NotifyTopology)(void *cls,
+ const struct GNUNET_PeerIdentity *first,
+ const struct GNUNET_PeerIdentity *second,
+ struct GNUNET_TIME_Relative latency,
+ uint32_t distance,
+ const char *emsg);
/**
* Starts a GNUnet daemon. GNUnet must be installed on the target
* @param timeout how long to wait starting up peers
* @param hostname name of the machine where to run GNUnet
* (use NULL for localhost).
+ * @param ssh_username ssh username to use when connecting to hostname
+ * @param sshport port to pass to ssh process when connecting to hostname
* @param hostkey_callback function to call once the hostkey has been
* generated for this peer, but it hasn't yet been started
* (NULL to start immediately, otherwise waits on GNUNET_TESTING_daemon_continue_start)
* @param hostkey_cls closure for hostkey callback
- * @param cb function to call with the result
+ * @param cb function to call once peer is up, or failed to start
* @param cb_cls closure for cb
* @return handle to the daemon (actual start will be completed asynchronously)
*/
const struct GNUNET_CONFIGURATION_Handle *cfg,
struct GNUNET_TIME_Relative timeout,
const char *hostname,
+ const char *ssh_username,
+ uint16_t sshport,
GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback,
void *hostkey_cls,
GNUNET_TESTING_NotifyDaemonRunning cb,
void
GNUNET_TESTING_daemon_continue_startup(struct GNUNET_TESTING_Daemon *daemon);
+/**
+ * Check whether the given daemon is running.
+ *
+ * @param daemon the daemon to check
+ *
+ * @return GNUNET_YES if the daemon is up, GNUNET_NO if the
+ * daemon is down, GNUNET_SYSERR on error.
+ */
+int
+GNUNET_TESTING_daemon_running (struct GNUNET_TESTING_Daemon *daemon);
+
/**
* Restart (stop and start) a GNUnet daemon.
*
* @param position the number of the peer to return
*/
struct GNUNET_TESTING_Daemon *
-GNUNET_TESTING_daemon_get (struct GNUNET_TESTING_PeerGroup *pg, unsigned int position);
+GNUNET_TESTING_daemon_get (struct GNUNET_TESTING_PeerGroup *pg,
+ unsigned int position);
+/*
+ * Get a daemon by peer identity, so callers can
+ * retrieve the daemon without knowing it's offset.
+ *
+ * @param pg the peer group to retrieve the daemon from
+ * @param peer_id the peer identity of the daemon to retrieve
+ *
+ * @return the daemon on success, or NULL if no such peer identity is found
+ */
+struct GNUNET_TESTING_Daemon *
+GNUNET_TESTING_daemon_get_by_id (struct GNUNET_TESTING_PeerGroup *pg,
+ struct GNUNET_PeerIdentity *peer_id);
/**
* Stops a GNUnet daemon.
* @param cb_cls closure for cb
* @param connect_callback function to call each time two hosts are connected
* @param connect_callback_cls closure for connect_callback
- * @param hostnames space-separated list of hostnames to use; can be NULL (to run
- * everything on localhost).
+ * @param hostnames linked list of hosts to use to start peers on (NULL to run on localhost only)
+ *
* @return NULL on error, otherwise handle to control peer group
*/
struct GNUNET_TESTING_PeerGroup *
void *cb_cls,
GNUNET_TESTING_NotifyConnection
connect_callback, void *connect_callback_cls,
- const char *hostnames);
+ const struct GNUNET_TESTING_Host *hostnames);
/**
* Function which continues a peer group starting up
*
* @param pg handle to the peer group
* @param timeout how long to wait for shutdown
+ * @param cb callback to notify upon success or failure
+ * @param cb_cls closure for cb
*/
void
GNUNET_TESTING_daemons_stop (struct GNUNET_TESTING_PeerGroup *pg,
- struct GNUNET_TIME_Relative timeout);
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_TESTING_NotifyCompletion cb,
+ void *cb_cls);
+/**
+ * Count the number of running peers.
+ *
+ * @param pg handle for the peer group
+ *
+ * @return the number of currently running peers in the peer group
+ */
+unsigned int
+GNUNET_TESTING_daemons_running (struct GNUNET_TESTING_PeerGroup *pg);
+
/**
* Simulate churn by stopping some peers (and possibly
* re-starting others if churn is called multiple times). This
GNUNET_TESTING_NotifyCompletion cb,
void *cb_cls);
+/**
+ * Callback function to process statistic values.
+ *
+ * @param cls closure
+ * @param peer the peer the statistics belong to
+ * @param subsystem name of subsystem that created the statistic
+ * @param name the name of the datum
+ * @param value the current value
+ * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
+ * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
+ */
+typedef int (*GNUNET_TESTING_STATISTICS_Iterator) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const char *subsystem,
+ const char *name,
+ uint64_t value,
+ int is_persistent);
+
+/**
+ * Iterate over all (running) peers in the peer group, retrieve
+ * all statistics from each.
+ */
+void
+GNUNET_TESTING_get_statistics (struct GNUNET_TESTING_PeerGroup *pg,
+ GNUNET_STATISTICS_Callback cont,
+ GNUNET_TESTING_STATISTICS_Iterator proc, void *cls);
/**
* Topologies supported for testbeds.
*/
GNUNET_TESTING_TOPOLOGY_SCALE_FREE,
+ /**
+ * Straight line topology.
+ */
+ GNUNET_TESTING_TOPOLOGY_LINE,
+
/**
* All peers are disconnected.
*/
*/
GNUNET_TESTING_TOPOLOGY_OPTION_DFS,
+ /**
+ * Find the N closest peers to each allowed peer in the
+ * topology and make sure a connection to those peers
+ * exists in the connect topology.
+ */
+ GNUNET_TESTING_TOPOLOGY_OPTION_ADD_CLOSEST,
+
/**
* No options specified.
*/
/**
* Get connect topology option from string input.
*
- * @param topology where to write the retrieved topology
+ * @param topology_option where to write the retrieved topology
* @param topology_string The string to attempt to
* get a configuration value from
* @return GNUNET_YES if topology string matched a
* known topology, GNUNET_NO if not
*/
int
-GNUNET_TESTING_topology_option_get(enum GNUNET_TESTING_TopologyOption *topology, char * topology_string);
+GNUNET_TESTING_topology_option_get(enum GNUNET_TESTING_TopologyOption *topology_option,
+ char * topology_string);
/**
enum GNUNET_TESTING_Topology restrict_topology,
char *restrict_transports);
+/**
+ * Iterate over all (running) peers in the peer group, retrieve
+ * all connections that each currently has.
+ *
+ * @param pg the peer group we are concerned with
+ * @param cb callback for topology information
+ * @param cls closure for callback
+ */
+void
+GNUNET_TESTING_get_topology (struct GNUNET_TESTING_PeerGroup *pg, GNUNET_TESTING_NotifyTopology cb, void *cls);
+
/**
* There are many ways to connect peers that are supported by this function.
* To connect peers in the same topology that was created via the
void *cb_cls);
-/**
- * Start "count" GNUnet daemons with a particular topology.
- *
- * @param sched scheduler to use
- * @param cfg configuration template to use
- * @param count number of peers the testbed should have
- * @param topology desired topology (enforced via F2F)
- * @param cb function to call on each daemon that was started
- * @param cb_cls closure for cb
- * @param hostname where to run the peers; can be NULL (to run
- * everything on localhost). Additional
- * hosts can be specified using a NULL-terminated list of
- * varargs, hosts will then be used round-robin from that
- * list.
- * @return handle to control the testbed
- */
-struct GNUNET_TESTING_Testbed *
-GNUNET_TESTING_testbed_start (struct GNUNET_SCHEDULER_Handle *sched,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
- unsigned int count,
- enum GNUNET_TESTING_Topology topology,
- GNUNET_TESTING_NotifyDaemonRunning cb,
- void *cb_cls,
- const char *hostname,
- ...);
-
-
-/**
- * Stop all of the daemons started with the start function.
- *
- * @param tb handle for the testbed
- * @param cb function to call when done
- * @param cb_cls closure for cb
- */
-void
-GNUNET_TESTING_testbed_stop (struct GNUNET_TESTING_Testbed *tb,
- GNUNET_TESTING_NotifyCompletion cb,
- void *cb_cls );
-
-
-/**
- * Simulate churn in the testbed by stopping some peers (and possibly
- * re-starting others if churn is called multiple times). This
- * function can only be used to create leave-join churn (peers "never"
- * leave for good). First "voff" random peers that are currently
- * online will be taken offline; then "von" random peers that are then
- * offline will be put back online. No notifications will be
- * generated for any of these operations except for the callback upon
- * completion. Note that the implementation is at liberty to keep
- * the ARM service itself (but none of the other services or daemons)
- * running even though the "peer" is being varied offline.
- *
- * @param tb handle for the testbed
- * @param voff number of peers that should go offline
- * @param von number of peers that should come back online;
- * must be zero on first call (since "testbed_start"
- * always starts all of the peers)
- * @param cb function to call at the end
- * @param cb_cls closure for cb
- */
-void
-GNUNET_TESTING_testbed_churn (struct GNUNET_TESTING_Testbed *tb,
- unsigned int voff,
- unsigned int von,
- GNUNET_TESTING_NotifyCompletion cb,
- void *cb_cls);
-
-
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
projects / oweals / gnunet.git / blobdiff