2 This file is part of GNUnet.
3 (C) 2006 - 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 2, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file src/dht/plugin_dhtlog_dummy.c
23 * @brief Dummy logging plugin to test logging calls
24 * @author Nathan Evans
30 #include "gnunet_util_lib.h"
33 #define DEBUG_DHTLOG GNUNET_NO
36 * Inserts the specified trial into the dhttests.trials table
38 * @param trial_info struct containing the data to insert about this trial
40 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
42 int add_trial (struct GNUNET_DHTLOG_TrialInfo *trial_info)
44 trial_info->trialuid = 42;
49 * Inserts the specified round into the dhttests.rounds table
51 * @param round_type the type of round that is being started
52 * @param round_count counter for the round (if applicable)
54 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
56 int add_round (unsigned int round_type, unsigned int round_count)
62 * Inserts the specified dhtkey into the dhttests.dhtkeys table,
63 * stores return value of dhttests.dhtkeys.dhtkeyuid into dhtkeyuid
65 * @param dhtkeyuid return value
66 * @param dhtkey hashcode of key to insert
68 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
71 add_dhtkey (unsigned long long *dhtkeyuid, const GNUNET_HashCode * dhtkey)
79 * Inserts the specified node into the dhttests.nodes table
81 * @param nodeuid the inserted node uid
82 * @param node the node to insert
84 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
87 add_node (unsigned long long *nodeuid, struct GNUNET_PeerIdentity * node)
94 * Update dhttests.trials table with current server time as end time
96 * @param trialuid trial to update
97 * @param gets_succeeded how many gets did the testcase report as successful
99 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
102 update_trials (unsigned long long trialuid,
103 unsigned int gets_succeeded)
110 * Inserts the specified stats into the dhttests.generic_stats table
112 * @param peer the peer inserting the statistic
113 * @param name the name of the statistic
114 * @param section the section of the statistic
115 * @param value the value of the statistic
117 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
120 add_generic_stat (const struct GNUNET_PeerIdentity *peer,
122 const char *section, uint64_t value)
128 * Update dhttests.trials table with total connections information
130 * @param trialuid the trialuid to update
131 * @param totalConnections the number of connections
133 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
136 add_connections (unsigned long long trialuid, unsigned int totalConnections)
142 * Inserts the specified query into the dhttests.queries table
144 * @param sqlqueruid inserted query uid
145 * @param queryid dht query id
146 * @param type type of the query
147 * @param hops number of hops query traveled
148 * @param succeeded whether or not query was successful
149 * @param node the node the query hit
150 * @param key the key of the query
152 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
155 add_query (unsigned long long *sqlqueryuid, unsigned long long queryid,
156 unsigned int type, unsigned int hops, int succeeded,
157 const struct GNUNET_PeerIdentity * node, const GNUNET_HashCode * key)
164 * Inserts the specified route information into the dhttests.routes table
166 * @param sqlqueruid inserted query uid
167 * @param queryid dht query id
168 * @param type type of the query
169 * @param hops number of hops query traveled
170 * @param succeeded whether or not query was successful
171 * @param node the node the query hit
172 * @param key the key of the query
173 * @param from_node the node that sent the message to node
174 * @param to_node next node to forward message to
176 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
179 add_route (unsigned long long *sqlqueryuid, unsigned long long queryid,
180 unsigned int type, unsigned int hops,
181 int succeeded, const struct GNUNET_PeerIdentity * node,
182 const GNUNET_HashCode * key, const struct GNUNET_PeerIdentity * from_node,
183 const struct GNUNET_PeerIdentity * to_node)
191 * Records the current topology (number of connections, time, trial)
193 * @param num_connections how many connections are in the topology
195 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
198 add_topology (int num_connections)
204 * Records a connection between two peers in the current topology
206 * @param first one side of the connection
207 * @param second other side of the connection
209 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
212 add_extended_topology (const struct GNUNET_PeerIdentity *first, const struct GNUNET_PeerIdentity *second)
218 * Update dhttests.topology table with total connections information
220 * @param totalConnections the number of connections
222 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
225 update_topology (unsigned int connections)
231 * Update dhttests.nodes table setting the identified
232 * node as a malicious dropper.
234 * @param peer the peer that was set to be malicious
236 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
239 set_malicious (struct GNUNET_PeerIdentity *peer)
245 * Inserts the specified stats into the dhttests.node_statistics table
247 * @param peer the peer inserting the statistic
248 * @param route_requests route requests seen
249 * @param route_forwards route requests forwarded
250 * @param result_requests route result requests seen
251 * @param client_requests client requests initiated
252 * @param result_forwards route results forwarded
253 * @param gets get requests handled
254 * @param puts put requests handle
255 * @param data_inserts data inserted at this node
256 * @param find_peer_requests find peer requests seen
257 * @param find_peers_started find peer requests initiated at this node
258 * @param gets_started get requests initiated at this node
259 * @param puts_started put requests initiated at this node
260 * @param find_peer_responses_received find peer responses received locally
261 * @param get_responses_received get responses received locally
262 * @param find_peer_responses_sent find peer responses sent from this node
263 * @param get_responses_sent get responses sent from this node
265 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
268 (const struct GNUNET_PeerIdentity *peer, unsigned int route_requests,
269 unsigned int route_forwards, unsigned int result_requests,
270 unsigned int client_requests, unsigned int result_forwards,
271 unsigned int gets, unsigned int puts,
272 unsigned int data_inserts, unsigned int find_peer_requests,
273 unsigned int find_peers_started, unsigned int gets_started,
274 unsigned int puts_started, unsigned int find_peer_responses_received,
275 unsigned int get_responses_received, unsigned int find_peer_responses_sent,
276 unsigned int get_responses_sent)
282 * Provides the dhtlog api
284 * @param c the configuration to use to connect to a server
286 * @return the handle to the server, or NULL on error
289 libgnunet_plugin_dhtlog_dummy_init (void * cls)
291 struct GNUNET_DHTLOG_Plugin *plugin = cls;
293 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "DUMMY DHT Logger: initializing.\n");
295 GNUNET_assert(plugin->dhtlog_api == NULL);
296 plugin->dhtlog_api = GNUNET_malloc(sizeof(struct GNUNET_DHTLOG_Handle));
297 plugin->dhtlog_api->add_generic_stat = &add_generic_stat;
298 plugin->dhtlog_api->insert_round = &add_round;
299 plugin->dhtlog_api->insert_stat = &insert_stat;
300 plugin->dhtlog_api->insert_trial = &add_trial;
301 plugin->dhtlog_api->insert_query = &add_query;
302 plugin->dhtlog_api->update_trial = &update_trials;
303 plugin->dhtlog_api->set_malicious = &set_malicious;
304 plugin->dhtlog_api->insert_route = &add_route;
305 plugin->dhtlog_api->insert_node = &add_node;
306 plugin->dhtlog_api->insert_dhtkey = &add_dhtkey;
307 plugin->dhtlog_api->update_connections = &add_connections;
308 plugin->dhtlog_api->insert_topology = &add_topology;
309 plugin->dhtlog_api->update_topology = &update_topology;
310 plugin->dhtlog_api->insert_extended_topology = &add_extended_topology;
315 * Shutdown the plugin.
318 libgnunet_plugin_dhtlog_dummy_done (void * cls)
321 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
322 "DUMMY DHT Logger: shutdown\n");
327 /* end of plugin_dhtlog_dummy.c */