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_mysql_dump_load.c
23 * @brief MySQL logging plugin to record DHT operations to MySQL server,
24 * but write all queries to file instead of the actual server
25 * so that they can be imported later. Since the first attempt
26 * (writing out SQL queries) seemed rather time consuming on insert,
27 * this plugin writes out tab separated values instead.
29 * @author Nathan Evans
35 #include "gnunet_util_lib.h"
39 #define DEBUG_DHTLOG GNUNET_NO
42 * Maximum number of supported parameters for a prepared
43 * statement. Increase if needed.
48 static unsigned long max_varchar_len;
51 * The configuration the DHT service is running with
53 static const struct GNUNET_CONFIGURATION_Handle *cfg;
55 #define DATE_STR_SIZE 50
57 static unsigned int topology_count;
60 * File(s) to dump all sql statements to.
63 FILE *generic_stat_outfile;
69 FILE *extended_topology_outfile;
74 static char date[DATE_STR_SIZE];
79 memset (date, 0, DATE_STR_SIZE);
80 tmptr = localtime (&timetmp);
82 strftime (date, DATE_STR_SIZE, "%Y-%m-%d %H:%M:%S", tmptr);
90 * Records the current topology (number of connections, time, trial)
92 * @param num_connections how many connections are in the topology
94 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
97 add_topology (int num_connections)
101 return GNUNET_SYSERR;
103 ret = fprintf(outfile, "insert into topology (trialuid, date, connections) values (@temp_trial, \"%s\", %d);\n", get_sql_time(), num_connections);
105 return GNUNET_SYSERR;
106 ret = fprintf(outfile, "select max(topology_uid) from topology into @temp_topology;\n");
109 return GNUNET_SYSERR;
113 * Records a connection between two peers in the current topology
115 * @param first one side of the connection
116 * @param second other side of the connection
118 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
121 add_extended_topology (const struct GNUNET_PeerIdentity *first, const struct GNUNET_PeerIdentity *second)
125 return GNUNET_SYSERR;
127 ret = fprintf(extended_topology_outfile, "insert into extended_topology (topology_uid, uid_first, uid_second) values (%u, %s,", topology_count, GNUNET_h2s_full(&first->hashPubKey));
129 return GNUNET_SYSERR;
130 ret = fprintf(extended_topology_outfile, "%s);\n", GNUNET_h2s_full(&second->hashPubKey));
134 return GNUNET_SYSERR;
139 * Inserts the specified trial into the dhttests.trials table
141 * @param trial_info struct containing the data to insert about this trial
143 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
145 int add_trial (struct GNUNET_DHTLOG_TrialInfo *trial_info)
148 trial_info->trialuid = 0;
150 return GNUNET_SYSERR;
152 ret = fprintf(outfile, "INSERT INTO trials "
153 "(starttime, other_trial_identifier, numnodes, topology,"
154 "blacklist_topology, connect_topology, connect_topology_option,"
155 "connect_topology_option_modifier, topology_percentage, topology_probability,"
157 "concurrent, settle_time, num_rounds, malicious_getters,"
158 "malicious_putters, malicious_droppers, malicious_get_frequency,"
159 "malicious_put_frequency, stop_closest, stop_found, strict_kademlia, "
160 "gets_succeeded, message) "
161 "VALUES (\"%s\", %u, %u, %u, %u, %u, %u, %f, %f, %f, %u, %u, %u, %u, %u, %u, %u, %u, %u, %u, %u, %u, %u, %u, \"%s\");\n",
162 get_sql_time(), trial_info->other_identifier, trial_info->num_nodes, trial_info->topology,
163 trial_info->blacklist_topology, trial_info->connect_topology,
164 trial_info->connect_topology_option, trial_info->connect_topology_option_modifier,
165 trial_info->topology_percentage, trial_info->topology_probability,
166 trial_info->puts, trial_info->gets, trial_info->concurrent, trial_info->settle_time,
167 trial_info->num_rounds, trial_info->malicious_getters, trial_info->malicious_putters,
168 trial_info->malicious_droppers, trial_info->malicious_get_frequency, trial_info->malicious_put_frequency,
169 trial_info->stop_closest, trial_info->stop_found, trial_info->strict_kademlia, trial_info->gets_succeeded, trial_info->message);
172 return GNUNET_SYSERR;
174 ret = fprintf(outfile, "SELECT MAX( trialuid ) FROM trials into @temp_trial;\n");
179 return GNUNET_SYSERR;
184 * Inserts the specified stats into the dhttests.generic_stats table
186 * @param peer the peer inserting the statistic
187 * @param name the name of the statistic
188 * @param section the section of the statistic
189 * @param value the value of the statistic
191 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
194 add_generic_stat (const struct GNUNET_PeerIdentity *peer,
196 const char *section, uint64_t value)
199 return GNUNET_SYSERR;
202 fprintf(generic_stat_outfile, "TRIALUID\t%s\t%s\t%s\t%llu\n", GNUNET_h2s_full(&peer->hashPubKey), section, name, (unsigned long long)value);
209 * Inserts the specified stats into the dhttests.node_statistics table
211 * @param peer the peer inserting the statistic
212 * @param route_requests route requests seen
213 * @param route_forwards route requests forwarded
214 * @param result_requests route result requests seen
215 * @param client_requests client requests initiated
216 * @param result_forwards route results forwarded
217 * @param gets get requests handled
218 * @param puts put requests handle
219 * @param data_inserts data inserted at this node
220 * @param find_peer_requests find peer requests seen
221 * @param find_peers_started find peer requests initiated at this node
222 * @param gets_started get requests initiated at this node
223 * @param puts_started put requests initiated at this node
224 * @param find_peer_responses_received find peer responses received locally
225 * @param get_responses_received get responses received locally
226 * @param find_peer_responses_sent find peer responses sent from this node
227 * @param get_responses_sent get responses sent from this node
229 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
232 add_stat (const struct GNUNET_PeerIdentity *peer, unsigned int route_requests,
233 unsigned int route_forwards, unsigned int result_requests,
234 unsigned int client_requests, unsigned int result_forwards,
235 unsigned int gets, unsigned int puts,
236 unsigned int data_inserts, unsigned int find_peer_requests,
237 unsigned int find_peers_started, unsigned int gets_started,
238 unsigned int puts_started, unsigned int find_peer_responses_received,
239 unsigned int get_responses_received, unsigned int find_peer_responses_sent,
240 unsigned int get_responses_sent)
244 return GNUNET_SYSERR;
247 ret = fprintf(stat_outfile, "TRIALUID\t%s\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\t%u\n",
248 GNUNET_h2s_full(&peer->hashPubKey),
249 route_requests, route_forwards, result_requests,
250 client_requests, result_forwards, gets, puts,
251 data_inserts, find_peer_requests, find_peers_started,
252 gets_started, puts_started, find_peer_responses_received,
253 get_responses_received, find_peer_responses_sent,
257 return GNUNET_SYSERR;
262 return GNUNET_SYSERR;
265 * Inserts the specified dhtkey into the dhttests.dhtkeys table,
266 * stores return value of dhttests.dhtkeys.dhtkeyuid into dhtkeyuid
268 * @param dhtkeyuid return value
269 * @param dhtkey hashcode of key to insert
271 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
274 add_dhtkey (unsigned long long *dhtkeyuid, const GNUNET_HashCode * dhtkey)
277 if (dhtkeyuid != NULL)
280 if ((dhtkey_outfile == NULL) || (dhtkey == NULL))
281 return GNUNET_SYSERR;
283 ret = fprintf(dhtkey_outfile, "TRIALUID\t%s\n", GNUNET_h2s_full(dhtkey));
288 return GNUNET_SYSERR;
292 * Inserts the specified node into the dhttests.nodes table
294 * @param nodeuid the inserted node uid
295 * @param node the node to insert
297 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
300 add_node (unsigned long long *nodeuid, struct GNUNET_PeerIdentity * node)
304 if ((node == NULL) || (node_outfile == NULL))
305 return GNUNET_SYSERR;
307 ret = fprintf(node_outfile, "TRIALUID\t%s\n", GNUNET_h2s_full(&node->hashPubKey));
311 return GNUNET_SYSERR;
315 * Update dhttests.trials table with current server time as end time
317 * @param trialuid trial to update
318 * @param gets_succeeded how many gets did the testcase report as successful
320 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
323 update_trials (unsigned long long trialuid,
324 unsigned int gets_succeeded)
328 if (trialuid != current_trial)
331 _("Trialuid to update is not equal to current_trial\n"));
336 return GNUNET_SYSERR;
338 ret = fprintf(outfile, "update trials set endtime=\"%s\", gets_succeeded=%u where trialuid = @temp_trial;\n", get_sql_time(), gets_succeeded);
343 return GNUNET_SYSERR;
348 * Update dhttests.nodes table setting the identified
349 * node as a malicious dropper.
351 * @param peer the peer that was set to be malicious
353 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
356 set_malicious (struct GNUNET_PeerIdentity *peer)
361 return GNUNET_SYSERR;
363 ret = fprintf(outfile, "update nodes set malicious_dropper = 1 where trialuid = @temp_trial and nodeid = \"%s\";\n", GNUNET_h2s_full(&peer->hashPubKey));
368 return GNUNET_SYSERR;
373 * Update dhttests.trials table with total connections information
375 * @param trialuid the trialuid to update
376 * @param totalConnections the number of connections
378 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
381 add_connections (unsigned long long trialuid, unsigned int totalConnections)
385 if (trialuid != current_trial)
388 _("Trialuid to update is not equal to current_trial(!)(?)\n"));
392 return GNUNET_SYSERR;
394 ret = fprintf(outfile, "update trials set totalConnections = %u where trialuid = @temp_trial;\n", totalConnections);
399 return GNUNET_SYSERR;
404 * Update dhttests.topology table with total connections information
406 * @param connections the number of connections
408 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
411 update_topology (unsigned int connections)
415 return GNUNET_SYSERR;
417 ret = fprintf(outfile, "update topology set connections = %u where topology_uid = @temp_topology;\n", connections);
422 return GNUNET_SYSERR;
426 * Inserts the specified query into the dhttests.queries table
428 * @param sqlqueruid inserted query uid
429 * @param queryid dht query id
430 * @param type type of the query
431 * @param hops number of hops query traveled
432 * @param succeeded whether or not query was successful
433 * @param node the node the query hit
434 * @param key the key of the query
436 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
439 add_query (unsigned long long *sqlqueryuid, unsigned long long queryid,
440 unsigned int type, unsigned int hops, int succeeded,
441 const struct GNUNET_PeerIdentity * node, const GNUNET_HashCode * key)
445 if ((outfile == NULL) || (node == NULL) || (key == NULL))
446 return GNUNET_SYSERR;
448 if (sqlqueryuid != NULL)
451 ret = fprintf(query_outfile, "TRIALUID\t%s\t", GNUNET_h2s_full(key));
454 return GNUNET_SYSERR;
456 ret = fprintf(query_outfile, "%s\t%llu\t%u\t%u\t%u\n", GNUNET_h2s_full(&node->hashPubKey), queryid, type, hops, succeeded);
461 return GNUNET_SYSERR;
465 * Inserts the specified route information into the dhttests.routes table
467 * @param sqlqueruid inserted query uid
468 * @param queryid dht query id
469 * @param type type of the query
470 * @param hops number of hops query traveled
471 * @param succeeded whether or not query was successful
472 * @param node the node the query hit
473 * @param key the key of the query
474 * @param from_node the node that sent the message to node
475 * @param to_node next node to forward message to
477 * @return GNUNET_OK on success, GNUNET_SYSERR on failure.
480 add_route (unsigned long long *sqlqueryuid, unsigned long long queryid,
481 unsigned int type, unsigned int hops,
482 int succeeded, const struct GNUNET_PeerIdentity * node,
483 const GNUNET_HashCode * key, const struct GNUNET_PeerIdentity * from_node,
484 const struct GNUNET_PeerIdentity * to_node)
488 if ((outfile == NULL) || (node == NULL) || (key == NULL))
489 return GNUNET_SYSERR;
491 if (sqlqueryuid != NULL)
494 ret = fprintf(route_outfile, "TRIALUID\t%s\t", GNUNET_h2s_full(key));
496 return GNUNET_SYSERR;
498 ret = fprintf(route_outfile, "%s\t", GNUNET_h2s_full(&node->hashPubKey));
500 return GNUNET_SYSERR;
501 if (from_node == NULL)
502 ret = fprintf(route_outfile, "0\t");
504 ret = fprintf(route_outfile, "%s\t", GNUNET_h2s_full(&from_node->hashPubKey));
506 return GNUNET_SYSERR;
509 ret = fprintf(route_outfile, "0\t%llu\t%u\t%u\t%d\n", queryid, type, hops, succeeded);
511 ret = fprintf(route_outfile, "%s\t%llu\t%u\t%u\t%d\n", GNUNET_h2s_full(&to_node->hashPubKey), queryid, type, hops, succeeded);
516 return GNUNET_SYSERR;
520 * Provides the dhtlog api
522 * @param c the configuration to use to connect to a server
524 * @return the handle to the server, or NULL on error
527 libgnunet_plugin_dhtlog_mysql_dump_load_init (void * cls)
529 struct GNUNET_DHTLOG_Plugin *plugin = cls;
536 max_varchar_len = 255;
538 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "MySQL (DUMP) DHT Logger: initializing\n");
540 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (plugin->cfg,
544 outfile_path = GNUNET_strdup("");
547 GNUNET_asprintf (&outfile_name,
553 fn = GNUNET_STRINGS_filename_expand (outfile_name);
557 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to get full path for `%s'\n"), outfile_name);
558 GNUNET_free(outfile_path);
559 GNUNET_free(outfile_name);
563 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
564 outfile = FOPEN (fn, "w");
568 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
570 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
571 _("Failed to create or access directory for log file `%s'\n"),
573 GNUNET_free(outfile_path);
574 GNUNET_free(outfile_name);
579 GNUNET_asprintf (&outfile_name,
585 fn = GNUNET_STRINGS_filename_expand (outfile_name);
589 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to get full path for `%s'\n"), outfile_name);
590 GNUNET_free(outfile_path);
591 GNUNET_free(outfile_name);
595 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
596 node_outfile = FOPEN (fn, "w");
598 if (node_outfile == NULL)
600 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
602 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
603 _("Failed to create or access directory for log file `%s'\n"),
605 GNUNET_free(outfile_path);
606 GNUNET_free(outfile_name);
611 GNUNET_asprintf (&outfile_name,
617 fn = GNUNET_STRINGS_filename_expand (outfile_name);
621 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to get full path for `%s'\n"), outfile_name);
622 GNUNET_free(outfile_path);
623 GNUNET_free(outfile_name);
627 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
628 route_outfile = FOPEN (fn, "w");
630 if (route_outfile == NULL)
632 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
634 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
635 _("Failed to create or access directory for log file `%s'\n"),
637 GNUNET_free(outfile_path);
638 GNUNET_free(outfile_name);
643 GNUNET_asprintf (&outfile_name,
649 fn = GNUNET_STRINGS_filename_expand (outfile_name);
653 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to get full path for `%s'\n"), outfile_name);
654 GNUNET_free(outfile_path);
655 GNUNET_free(outfile_name);
659 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
660 query_outfile = FOPEN (fn, "w");
662 if (query_outfile == NULL)
664 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
666 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
667 _("Failed to create or access directory for log file `%s'\n"),
669 GNUNET_free(outfile_path);
670 GNUNET_free(outfile_name);
675 GNUNET_asprintf (&outfile_name,
681 fn = GNUNET_STRINGS_filename_expand (outfile_name);
685 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to get full path for `%s'\n"), outfile_name);
686 GNUNET_free(outfile_path);
687 GNUNET_free(outfile_name);
691 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
692 stat_outfile = FOPEN (fn, "w");
694 if (stat_outfile == NULL)
696 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
698 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
699 _("Failed to create or access directory for log file `%s'\n"),
701 GNUNET_free(outfile_path);
702 GNUNET_free(outfile_name);
707 GNUNET_asprintf (&outfile_name,
710 "mysqldump_generic_stats",
713 fn = GNUNET_STRINGS_filename_expand (outfile_name);
717 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to get full path for `%s'\n"), outfile_name);
718 GNUNET_free(outfile_path);
719 GNUNET_free(outfile_name);
723 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
724 generic_stat_outfile = FOPEN (fn, "w");
726 if (generic_stat_outfile == NULL)
728 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
730 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
731 _("Failed to create or access directory for log file `%s'\n"),
733 GNUNET_free(outfile_path);
734 GNUNET_free(outfile_name);
739 GNUNET_asprintf (&outfile_name,
745 fn = GNUNET_STRINGS_filename_expand (outfile_name);
749 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to get full path for `%s'\n"), outfile_name);
750 GNUNET_free(outfile_path);
751 GNUNET_free(outfile_name);
755 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
756 dhtkey_outfile = FOPEN (fn, "w");
758 if (dhtkey_outfile == NULL)
760 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
762 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
763 _("Failed to create or access directory for log file `%s'\n"),
765 GNUNET_free(outfile_path);
766 GNUNET_free(outfile_name);
771 GNUNET_asprintf (&outfile_name,
774 "mysqldump_extended_topology",
777 fn = GNUNET_STRINGS_filename_expand (outfile_name);
781 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to get full path for `%s'\n"), outfile_name);
782 GNUNET_free(outfile_path);
783 GNUNET_free(outfile_name);
787 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
788 extended_topology_outfile = FOPEN (fn, "w");
790 if (extended_topology_outfile == NULL)
792 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
794 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
795 _("Failed to create or access directory for log file `%s'\n"),
797 GNUNET_free(outfile_path);
798 GNUNET_free(outfile_name);
803 GNUNET_free (outfile_path);
804 GNUNET_free (outfile_name);
807 GNUNET_assert(plugin->dhtlog_api == NULL);
808 plugin->dhtlog_api = GNUNET_malloc(sizeof(struct GNUNET_DHTLOG_Handle));
809 plugin->dhtlog_api->insert_trial = &add_trial;
810 plugin->dhtlog_api->insert_stat = &add_stat;
811 plugin->dhtlog_api->insert_query = &add_query;
812 plugin->dhtlog_api->update_trial = &update_trials;
813 plugin->dhtlog_api->insert_route = &add_route;
814 plugin->dhtlog_api->insert_node = &add_node;
815 plugin->dhtlog_api->insert_dhtkey = &add_dhtkey;
816 plugin->dhtlog_api->update_connections = &add_connections;
817 plugin->dhtlog_api->insert_topology = &add_topology;
818 plugin->dhtlog_api->insert_extended_topology = &add_extended_topology;
819 plugin->dhtlog_api->update_topology = &update_topology;
820 plugin->dhtlog_api->set_malicious = &set_malicious;
821 plugin->dhtlog_api->add_generic_stat = &add_generic_stat;
827 * Shutdown the plugin.
830 libgnunet_plugin_dhtlog_mysql_dump_load_done (void * cls)
832 struct GNUNET_DHTLOG_Handle *dhtlog_api = cls;
833 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
834 "MySQL DHT Logger: database shutdown\n");
835 GNUNET_assert(dhtlog_api != NULL);
838 fclose(node_outfile);
839 fclose(query_outfile);
840 fclose(route_outfile);
841 fclose(stat_outfile);
842 fclose(generic_stat_outfile);
843 fclose(extended_topology_outfile);
844 GNUNET_free(dhtlog_api);
848 /* end of plugin_dhtlog_mysql_dump_load.c */