GNUnet  0.11.x
gnunet-daemon-latency-logger.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2008--2014 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
27 #include "platform.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_ats_service.h"
30 #include <sqlite3.h>
31 
32 
36 #define LOG(type, ...) \
37  GNUNET_log (type, __VA_ARGS__)
38 
42 #define DEBUG(...) \
43  LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
44 
50 #define LOG_SQLITE(db, msg, level, cmd) \
51  do { \
52  GNUNET_log_from (level, "sqlite", _ ( \
53  "`%s' failed at %s:%d with error: %s\n"), \
54  cmd, __FILE__, __LINE__, sqlite3_errmsg (db)); \
55  if (msg != NULL) \
56  GNUNET_asprintf (msg, _ ("`%s' failed at %s:%u with error: %s"), cmd, \
57  __FILE__, __LINE__, sqlite3_errmsg (db)); \
58  } while (0)
59 
60 
64 struct Entry
65 {
70 
75  unsigned int latency;
76 };
77 
78 
83 
87 static struct sqlite3 *db;
88 
93 
97 static struct sqlite3_stmt *stmt_insert;
98 
99 
111 static int
112 free_iterator (void *cls,
113  const struct GNUNET_PeerIdentity *key,
114  void *value)
115 {
116  struct Entry *e = cls;
117 
120  GNUNET_free (e);
121  return GNUNET_YES;
122 }
123 
124 
131 static void
132 do_shutdown (void *cls)
133 {
135  ats = NULL;
136  if (NULL != stmt_insert)
137  {
138  sqlite3_finalize (stmt_insert);
139  stmt_insert = NULL;
140  }
141  GNUNET_break (SQLITE_OK == sqlite3_close (db));
142  db = NULL;
143  if (NULL != map)
144  {
147  NULL));
149  map = NULL;
150  }
151 }
152 
153 
167 static void
168 addr_info_cb (void *cls,
169  const struct GNUNET_HELLO_Address *address,
170  int address_active,
171  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
172  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
173  const struct GNUNET_ATS_Properties *prop)
174 {
175  static const char *query_insert =
176  "INSERT INTO ats_info("
177  " id,"
178  " val,"
179  " timestamp"
180  ") VALUES ("
181  " ?1,"
182  " ?2,"
183  " datetime('now')"
184  ");";
185  struct Entry *entry;
186  int latency; /* FIXME: type!? */
187 
188  if (NULL == address)
189  {
190  /* ATS service temporarily disconnected */
191  return;
192  }
193 
194  GNUNET_assert (NULL != db);
195  if (GNUNET_YES != address_active)
196  return;
197  latency = (int) prop->delay.rel_value_us;
198  entry = NULL;
200  &address->peer))
201  {
202  entry = GNUNET_CONTAINER_multipeermap_get (map, &address->peer);
203  GNUNET_assert (NULL != entry);
204  if (latency == entry->latency)
205  return;
206  }
207  if (NULL == stmt_insert)
208  {
209  if (SQLITE_OK != sqlite3_prepare_v2 (db, query_insert, -1, &stmt_insert,
210  NULL))
211  {
212  LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_prepare_v2");
213  goto err_shutdown;
214  }
215  }
216  if ((SQLITE_OK != sqlite3_bind_text (stmt_insert, 1,
217  GNUNET_i2s (&address->peer), -1,
218  SQLITE_STATIC)) ||
219  (SQLITE_OK != sqlite3_bind_int (stmt_insert, 2, latency)))
220  {
221  LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_bind_text");
222  goto err_shutdown;
223  }
224  if (SQLITE_DONE != sqlite3_step (stmt_insert))
225  {
226  LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_step");
227  goto err_shutdown;
228  }
229  if (SQLITE_OK != sqlite3_reset (stmt_insert))
230  {
231  LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_insert");
232  goto err_shutdown;
233  }
234  if (NULL == entry)
235  {
236  entry = GNUNET_new (struct Entry);
237  entry->id = address->peer;
239  &entry->id, entry,
241  }
242  entry->latency = latency;
243  return;
244 
245 err_shutdown:
247 }
248 
249 
258 static void
259 run (void *cls, char *const *args, const char *cfgfile,
260  const struct GNUNET_CONFIGURATION_Handle *c)
261 {
262  const char *query_create =
263  "CREATE TABLE ats_info ("
264  "id TEXT,"
265  "val INTEGER,"
266  "timestamp NUMERIC"
267  ");";
268  char *dbfile;
269 
270  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c, "LATENCY-LOGGER",
271  "DBFILE",
272  &dbfile))
273  {
274  GNUNET_break (0);
275  return;
276  }
277  if (SQLITE_OK != sqlite3_open (dbfile, &db))
278  {
279  if (NULL != db)
280  {
281  LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite_open_v2");
282  GNUNET_break (SQLITE_OK == sqlite3_close (db));
283  }
284  else
285  LOG (GNUNET_ERROR_TYPE_ERROR, "Cannot open sqlite file %s\n", dbfile);
286  GNUNET_free (dbfile);
287  return;
288  }
289  if (0 != sqlite3_exec (db, query_create, NULL, NULL, NULL))
290  DEBUG ("SQLite Error: %d. Perhaps the database `%s' already exits.\n",
291  sqlite3_errcode (db), dbfile);
292  DEBUG ("Opened database %s\n", dbfile);
293  GNUNET_free (dbfile);
294  dbfile = NULL;
295  ats = GNUNET_ATS_performance_init (c, &addr_info_cb, NULL);
298 }
299 
300 
304 int
305 main (int argc, char *const *argv)
306 {
307  static const struct GNUNET_GETOPT_CommandLineOption options[] = {
309  };
310  int ret;
311 
312  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
313  return 2;
314  ret =
315  (GNUNET_OK ==
316  GNUNET_PROGRAM_run (argc, argv, "gnunet-daemon-latency-logger",
317  _ (
318  "Daemon to log latency values of connections to neighbours"),
319  options, &run, NULL)) ? 0 : 1;
320  GNUNET_free ((void*) argv);
321  return ret;
322 }
uint64_t rel_value_us
The actual value.
unsigned int latency
The last known value for latency.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1300
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1438
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
void GNUNET_ATS_performance_done(struct GNUNET_ATS_PerformanceHandle *ph)
Client is done using the ATS performance subsystem, release resources.
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
static struct Experiment * e
#define LOG_SQLITE(db, msg, level, cmd)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; on file &#39;file...
int GNUNET_CONTAINER_multipeermap_remove(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, const void *value)
Remove the given key-value pair from the map.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition of a command line option.
int main(int argc, char *const *argv)
Execution entry point.
struct GNUNET_CONTAINER_MultiPeerMap * GNUNET_CONTAINER_multipeermap_create(unsigned int len, int do_not_copy_keys)
Create a multi peer map (hash map for public keys of peers).
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:526
static void addr_info_cb(void *cls, const struct GNUNET_HELLO_Address *address, int address_active, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in, const struct GNUNET_ATS_Properties *prop)
Signature of a function that is called with QoS information about an address.
ATS performance characteristics for an address.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
void GNUNET_CONTAINER_multipeermap_destroy(struct GNUNET_CONTAINER_MultiPeerMap *map)
Destroy a hash map.
struct GNUNET_PeerIdentity id
The peer&#39;s identity.
static struct GNUNET_CONTAINER_MultiPeerMap * map
Handle to the map used to store old latency values for peers.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
, &#39; bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_...
static char * value
Value of the record to add/remove.
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
Main function that will be run.
static struct sqlite3 * db
The SQLite database handle.
static struct sqlite3_stmt * stmt_insert
Prepared statement for inserting values into the database table.
struct GNUNET_TIME_Relative delay
Delay.
static struct GNUNET_ATS_PerformanceHandle * ats
Handle to the ATS performance subsystem.
Internal representation of the hash map.
struct GNUNET_HashCode key
The key used in the DHT.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
struct GNUNET_PeerIdentity peer
For which peer is this an address?
32-bit bandwidth used for network exchange by GNUnet, in bytes per second.
ATS Handle to obtain and/or modify performance information.
struct GNUNET_ATS_PerformanceHandle * GNUNET_ATS_performance_init(const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_ATS_AddressInformationCallback addr_info_cb, void *addr_info_cb_cls)
Get handle to access performance API of the ATS subsystem.
int GNUNET_CONTAINER_multipeermap_put(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
int GNUNET_CONTAINER_multipeermap_iterate(struct GNUNET_CONTAINER_MultiPeerMap *map, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map.
The identity of the host (wraps the signing key of the peer).
configuration data
Definition: configuration.c:85
An address for communicating with a peer.
void * GNUNET_CONTAINER_multipeermap_get(const struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key)
Given a key find a value in the map matching the key.
Automatic transport selection and outbound bandwidth determination.
static void do_shutdown(void *cls)
Shutdown.
int GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:367
#define GNUNET_YES
Definition: gnunet_common.h:77
#define DEBUG(...)
Debug logging shorthand.
int GNUNET_CONTAINER_multipeermap_contains(const struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key)
Check if the map contains any value under the given key (including values that are NULL)...
static char * address
GNS address for this phone.
static int free_iterator(void *cls, const struct GNUNET_PeerIdentity *key, void *value)
Iterator over hash map entries.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
Entry type to be used in the map to store old latency values.
Definition: gnunet-bcd.c:84
#define GNUNET_free(ptr)
Wrapper around free.
#define LOG(type,...)
Logging shorthand.