From fba669741d6686052308b915203aca8c5788c035 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 6 Sep 2010 20:48:11 +0000 Subject: fixes --- TODO | 5 ++ contrib/gnunet.doxy | 1 - src/arm/gnunet-service-arm.c | 1 + src/core/core_api.c | 1 + src/core/gnunet-service-core.c | 2 +- src/datacache/plugin_datacache_mysql.c | 50 +++++++++--------- src/datastore/plugin_datastore_mysql.c | 86 +++++++++++++++++++++---------- src/datastore/plugin_datastore_postgres.c | 7 +-- 8 files changed, 95 insertions(+), 58 deletions(-) diff --git a/TODO b/TODO index 8ac9a592c..ee4c37b32 100644 --- a/TODO +++ b/TODO @@ -1,4 +1,9 @@ 0.9.0pre2: +* FS: + - namespace_list_updateable testcase [CG] + (currently, updateable content does NOT show in GTK) +* GTK: + - local namespace not listed in fs-search dialog (?) [CG] * CORE: - derived key generation [Nils] - Jun 27 11:51:54 core-7670 ERROR Assertion failed at gnunet-service-core.c:3616. diff --git a/contrib/gnunet.doxy b/contrib/gnunet.doxy index fb959ec2a..2477dcef2 100644 --- a/contrib/gnunet.doxy +++ b/contrib/gnunet.doxy @@ -32,7 +32,6 @@ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 8 diff --git a/src/arm/gnunet-service-arm.c b/src/arm/gnunet-service-arm.c index b63d56a32..31539172f 100644 --- a/src/arm/gnunet-service-arm.c +++ b/src/arm/gnunet-service-arm.c @@ -342,6 +342,7 @@ free_entry (struct ServiceList *pos) * Actually start the process for the given service. * * @param sl identifies service to start + * @param -1 terminated list of listen sockets to pass (systemd style), or NULL */ static void start_process (struct ServiceList *sl, diff --git a/src/core/core_api.c b/src/core/core_api.c index 16aa788f9..c21be318a 100644 --- a/src/core/core_api.c +++ b/src/core/core_api.c @@ -727,6 +727,7 @@ transmit_start (void *cls, size_t size, void *buf) * connected to the core service; note that timeout is only meaningful if init is not NULL * @param connects function to call on peer connect, can be NULL * @param disconnects function to call on peer disconnect / timeout, can be NULL + * @param status_events function to call on changes to peer connection status, can be NULL * @param inbound_notify function to call for all inbound messages, can be NULL * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the * GNUNET_MessageHeader and hence we do not need to give it the full message; diff --git a/src/core/gnunet-service-core.c b/src/core/gnunet-service-core.c index c4643deec..e10d03343 100644 --- a/src/core/gnunet-service-core.c +++ b/src/core/gnunet-service-core.c @@ -833,7 +833,7 @@ send_to_all_clients (const struct GNUNET_MessageHeader *msg, * Function called by transport telling us that a peer * changed status. * - * @param peer the peer that changed status + * @param n the peer that changed status */ static void handle_peer_status_change (struct Neighbour *n) diff --git a/src/datacache/plugin_datacache_mysql.c b/src/datacache/plugin_datacache_mysql.c index 4559a9d39..d83d18cd6 100644 --- a/src/datacache/plugin_datacache_mysql.c +++ b/src/datacache/plugin_datacache_mysql.c @@ -33,24 +33,20 @@ * * and do the following. [You should replace $USER with the username * that will be running the gnunetd process]. - * 
- *
+ * @verbatim
       CREATE DATABASE gnunet;
       GRANT select,insert,update,delete,create,alter,drop,create temporary tables
          ON gnunet.* TO $USER@localhost;
       SET PASSWORD FOR $USER@localhost=PASSWORD('$the_password_you_like');
       FLUSH PRIVILEGES;
- *
- *
+ * @endverbatim * 2) In the $HOME directory of $USER, create a ".my.cnf" file * with the following lines - * 
-
+ * @verbatim
       [client]
       user=$USER
       password=$the_password_you_like
-
- *
+ * @endverbatim * * Thats it -- now you can configure your datastores in GNUnet to * use MySQL. Note that .my.cnf file is a security risk unless its on @@ -62,11 +58,10 @@ * * 3) Still, perhaps you should briefly try if the DB connection * works. First, login as $USER. Then use, - * - * 
- *    $ mysql -u $USER -p $the_password_you_like
- *    mysql> use gnunet;
- *
+ * @verbatim + $ mysql -u $USER -p $the_password_you_like + mysql> use gnunet; + * @endverbatim * * If you get the message "Database changed" it probably works. * @@ -75,19 +70,6 @@ * "ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock" * so there may be some additional trouble depending on your mysql setup.] * - * REPAIRING TABLES: - * - Its probably healthy to check your tables for inconsistencies - * every now and then. - * - If you get odd SEGVs on gnunetd startup, it might be that the mysql - * databases have been corrupted. - * - The tables can be verified/fixed in two ways; - * 1) by running mysqlcheck -A, or - * 2) by executing (inside of mysql using the GNUnet database): - * mysql> SHOW TABLES; - * mysql> REPAIR TABLE gnXXX; - * - * Make sure to replace XXX with the actual names of all tables. - * * PROBLEMS? * * If you have problems related to the mysql module, your best @@ -191,6 +173,8 @@ struct Plugin /** * Obtain the location of ".my.cnf". + * + * @param cfg our configuration * @return NULL on error */ static char * @@ -251,6 +235,9 @@ get_my_cnf_path (const struct GNUNET_CONFIGURATION_Handle *cfg) /** * Free a prepared statement. + * + * @param plugin plugin context + * @param s prepared statement */ static void prepared_statement_destroy (struct Plugin *plugin, @@ -467,6 +454,7 @@ prepare_statement (struct Plugin *plugin, * Bind the parameters for the given MySQL statement * and run it. * + * @param plugin plugin context * @param s statement to bind and run * @param ap arguments for the binding * @return GNUNET_SYSERR on error, GNUNET_OK on success @@ -565,6 +553,8 @@ typedef int (*GNUNET_MysqlDataProcessor) (void *cls, /** * Run a prepared SELECT statement. * + * @param plugin plugin context + * @param s handle to SELECT statment * @param result_size number of elements in results array * @param results pointer to already initialized MYSQL_BIND * array (of sufficient size) for passing results @@ -649,6 +639,8 @@ prepared_statement_run_select (struct Plugin *plugin, /** * Run a prepared statement that does NOT produce results. * + * @param plugin plugin context + * @param s handle to SELECT statment * @param ... pairs and triplets of "MYSQL_TYPE_XXX" keys and their respective * values (size + buffer-reference for pointers); terminated * with "-1" @@ -682,6 +674,12 @@ prepared_statement_run (struct Plugin *plugin, } +/** + * Create temporary table and prepare statements. + * + * @param plugin plugin context + * @return GNUNET_OK on success + */ static int itable (struct Plugin *plugin) { diff --git a/src/datastore/plugin_datastore_mysql.c b/src/datastore/plugin_datastore_mysql.c index ea6cc2322..51a60a1dc 100644 --- a/src/datastore/plugin_datastore_mysql.c +++ b/src/datastore/plugin_datastore_mysql.c @@ -48,36 +48,30 @@ * MANUAL SETUP INSTRUCTIONS * * 1) in /etc/gnunet.conf, set - * 
+ * @verbatim
  *     [datastore]
  *     DATABASE = "mysql"
- *
+ * @endverbatim * 2) Then access mysql as root, - * 
- *
- *    $ mysql -u root -p
- *
- *
+ * @verbatim + $ mysql -u root -p + * @endverbatim * and do the following. [You should replace $USER with the username * that will be running the gnunetd process]. - * 
- *
+ * @verbatim
       CREATE DATABASE gnunet;
       GRANT select,insert,update,delete,create,alter,drop,create temporary tables
          ON gnunet.* TO $USER@localhost;
       SET PASSWORD FOR $USER@localhost=PASSWORD('$the_password_you_like');
       FLUSH PRIVILEGES;
- *
- *
+ * @endverbatim * 3) In the $HOME directory of $USER, create a ".my.cnf" file * with the following lines - * 
-
+ * @verbatim
       [client]
       user=$USER
       password=$the_password_you_like
-
- *
+ * @endverbatim * * Thats it. Note that .my.cnf file is a security risk unless its on * a safe partition etc. The $HOME/.my.cnf can of course be a symbolic @@ -89,10 +83,10 @@ * 4) Still, perhaps you should briefly try if the DB connection * works. First, login as $USER. Then use, * - * 
- *    $ mysql -u $USER -p $the_password_you_like
- *    mysql> use gnunet;
- *
+ * @verbatim + $ mysql -u $USER -p $the_password_you_like + mysql> use gnunet; + * @endverbatim * * If you get the message "Database changed" it probably works. * @@ -110,8 +104,10 @@ * - The tables can be verified/fixed in two ways; * 1) by running mysqlcheck -A, or * 2) by executing (inside of mysql using the GNUnet database): - * mysql> REPAIR TABLE gn090; - * mysql> REPAIR TABLE gn072; + * @verbatim + mysql> REPAIR TABLE gn090; + mysql> REPAIR TABLE gn072; + * @endverbatim * * PROBLEMS? * @@ -353,6 +349,8 @@ struct Plugin /** * Obtain the location of ".my.cnf". + * + * @param cfg our configuration * @return NULL on error */ static char * @@ -414,6 +412,9 @@ get_my_cnf_path (const struct GNUNET_CONFIGURATION_Handle *cfg) /** * Free a prepared statement. + * + * @param plugin plugin context + * @param s prepared statement */ static void prepared_statement_destroy (struct Plugin *plugin, @@ -549,6 +550,8 @@ iopen (struct Plugin *ret) /** * Run the given MySQL statement. * + * @param plugin plugin context + * @param statement SQL statement to run * @return GNUNET_OK on success, GNUNET_SYSERR on error */ static int @@ -572,6 +575,8 @@ run_statement (struct Plugin *plugin, /** * Create a prepared statement. * + * @param plugin plugin context + * @param statement SQL statement text to prepare * @return NULL on error */ static struct GNUNET_MysqlStatementHandle * @@ -592,6 +597,8 @@ prepared_statement_create (struct Plugin *plugin, /** * Prepare a statement for running. * + * @param plugin plugin context + * @param ret handle to prepared statement * @return GNUNET_OK on success */ static int @@ -631,6 +638,7 @@ prepare_statement (struct Plugin *plugin, * Bind the parameters for the given MySQL statement * and run it. * + * @param plugin plugin context * @param s statement to bind and run * @param ap arguments for the binding * @return GNUNET_SYSERR on error, GNUNET_OK on success @@ -729,6 +737,8 @@ typedef int (*GNUNET_MysqlDataProcessor) (void *cls, /** * Run a prepared SELECT statement. * + * @param plugin plugin context + * @param s statement to run * @param result_size number of elements in results array * @param results pointer to already initialized MYSQL_BIND * array (of sufficient size) for passing results @@ -812,11 +822,13 @@ prepared_statement_run_select (struct Plugin *plugin, /** * Run a prepared statement that does NOT produce results. * + * @param plugin plugin context + * @param s statement to run + * @param insert_id NULL or address where to store the row ID of whatever + * was inserted (only for INSERT statements!) * @param ... pairs and triplets of "MYSQL_TYPE_XXX" keys and their respective * values (size + buffer-reference for pointers); terminated * with "-1" - * @param insert_id NULL or address where to store the row ID of whatever - * was inserted (only for INSERT statements!) * @return GNUNET_SYSERR on error, otherwise * the number of successfully affected rows */ @@ -848,6 +860,7 @@ prepared_statement_run (struct Plugin *plugin, /** * Delete an value from the gn072 table. * + * @param plugin plugin context * @param vkey vkey identifying the value to delete * @return GNUNET_OK on success, GNUNET_NO if no such value exists, GNUNET_SYSERR on error */ @@ -883,6 +896,7 @@ do_delete_value (struct Plugin *plugin, /** * Insert a value into the gn072 table. * + * @param plugin plugin context * @param value the value to insert * @param size size of the value * @param vkey vkey identifying the value henceforth (set) @@ -922,6 +936,7 @@ do_insert_value (struct Plugin *plugin, /** * Delete an entry from the gn090 table. * + * @param plugin plugin context * @param vkey vkey identifying the entry to delete * @return GNUNET_OK on success, GNUNET_NO if no such value exists, GNUNET_SYSERR on error */ @@ -955,6 +970,14 @@ do_delete_entry_by_vkey (struct Plugin *plugin, } +/** + * Function that simply returns GNUNET_OK + * + * @param cls closure, not used + * @param num_values not used + * @param values not used + * @return GNUNET_OK + */ static int return_ok (void *cls, unsigned int num_values, @@ -964,6 +987,13 @@ return_ok (void *cls, } +/** + * FIXME. + * + * @param cls FIXME + * @param ncr FIXME + * @return FIXME + */ static int iterator_helper_prepare (void *cls, struct NextRequestClosure *nrc) @@ -1059,7 +1089,7 @@ iterator_helper_prepare (void *cls, */ static void mysql_next_request_cont (void *next_cls, - const struct GNUNET_SCHEDULER_TaskContext *tc) + const struct GNUNET_SCHEDULER_TaskContext *tc) { struct NextRequestClosure *nrc = next_cls; struct Plugin *plugin; @@ -1239,14 +1269,16 @@ mysql_plugin_next_request (void *next_cls, * using the given query to select and order * the items. * + * @param plugin plugin context * @param type entries of which type should be considered? - * Use 0 for any type. - * @param iter never NULL + * @param iter_select which iterator statement are we using * @param is_asc are we using ascending order? + * @param dviter function to call on each matching item + * @param dviter_cls closure for dviter */ static void iterateHelper (struct Plugin *plugin, - unsigned int type, + enum GNUNET_BLOCK_Type type, int is_asc, unsigned int iter_select, PluginIterator dviter, diff --git a/src/datastore/plugin_datastore_postgres.c b/src/datastore/plugin_datastore_postgres.c index a5f4b2c4b..3ec38c371 100644 --- a/src/datastore/plugin_datastore_postgres.c +++ b/src/datastore/plugin_datastore_postgres.c @@ -276,6 +276,7 @@ pq_exec (struct Plugin *plugin, * Prepare SQL statement. * * @param plugin global context + * @param name name for the prepared SQL statement * @param sql SQL code to prepare * @param nparams number of parameters in sql * @param line code line for error reporting @@ -283,10 +284,10 @@ pq_exec (struct Plugin *plugin, */ static int pq_prepare (struct Plugin *plugin, - const char *name, const char *sql, int nparms, int line) + const char *name, const char *sql, int nparams, int line) { PGresult *ret; - ret = PQprepare (plugin->dbh, name, sql, nparms, NULL); + ret = PQprepare (plugin->dbh, name, sql, nparams, NULL); if (GNUNET_OK != check_result (plugin, ret, PGRES_COMMAND_OK, "PQprepare", sql, line)) @@ -648,7 +649,7 @@ postgres_plugin_put (void *cls, * asking the database plugin to call the iterator * with the next item. * - * @param cls the 'struct NextRequestClosure' + * @param next_cls the 'struct NextRequestClosure' * @param tc scheduler context */ static void -- cgit v1.2.3