GNUnet  0.10.x
gnunet-service-zonemaster-monitor.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2012, 2013, 2014, 2017, 2018 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 
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_dht_service.h"
31 
32 
33 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
34 
35 
40 #define PUBLISH_OPS_PER_EXPIRATION 4
41 
45 #define DHT_QUEUE_LIMIT 2000
46 
51 #define NAMESTORE_QUEUE_LIMIT 5
52 
56 #define DHT_GNS_REPLICATION_LEVEL 5
57 
58 
63 {
68 
73 
78 
83 };
84 
85 
90 
95 
100 
105 
109 static struct DhtPutActivity *ma_head;
110 
114 static struct DhtPutActivity *ma_tail;
115 
119 static unsigned int ma_queue_length;
120 
125 static int cache_keys;
126 
127 
134 static void
135 shutdown_task (void *cls)
136 {
137  struct DhtPutActivity *ma;
138 
139  (void) cls;
141  "Shutting down!\n");
142  while (NULL != (ma = ma_head))
143  {
145  ma_queue_length--;
147  ma_tail,
148  ma);
149  GNUNET_free (ma);
150  }
151  if (NULL != statistics)
152  {
153  GNUNET_STATISTICS_destroy (statistics,
154  GNUNET_NO);
155  statistics = NULL;
156  }
157  if (NULL != zmon)
158  {
160  zmon = NULL;
161  }
162  if (NULL != namestore_handle)
163  {
164  GNUNET_NAMESTORE_disconnect (namestore_handle);
165  namestore_handle = NULL;
166  }
167  if (NULL != dht_handle)
168  {
169  GNUNET_DHT_disconnect (dht_handle);
170  dht_handle = NULL;
171  }
172 }
173 
174 
181 static void
183 {
184  struct DhtPutActivity *ma = cls;
185 
187  1);
188  ma_queue_length--;
190  ma_tail,
191  ma);
192  GNUNET_free (ma);
193 }
194 
195 
206 static unsigned int
208  unsigned int rd_count,
209  struct GNUNET_GNSRECORD_Data *rd_public)
210 {
211  struct GNUNET_TIME_Absolute now;
212  unsigned int rd_public_count;
213 
214  rd_public_count = 0;
215  now = GNUNET_TIME_absolute_get ();
216  for (unsigned int i=0;i<rd_count;i++)
217  {
218  if (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_PRIVATE))
219  continue;
220  if ( (0 == (rd[i].flags & GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION)) &&
221  (rd[i].expiration_time < now.abs_value_us) )
222  continue; /* record already expired, skip it */
223  rd_public[rd_public_count++] = rd[i];
224  }
225  return rd_public_count;
226 }
227 
228 
239 static struct GNUNET_DHT_PutHandle *
241  const char *label,
242  const struct GNUNET_GNSRECORD_Data *rd_public,
243  unsigned int rd_public_count,
244  struct DhtPutActivity *ma)
245 {
246  struct GNUNET_GNSRECORD_Block *block;
247  struct GNUNET_HashCode query;
248  struct GNUNET_TIME_Absolute expire;
249  size_t block_size;
250  struct GNUNET_DHT_PutHandle *ret;
251 
252  expire = GNUNET_GNSRECORD_record_get_expiration_time (rd_public_count,
253  rd_public);
254  if (cache_keys)
255  block = GNUNET_GNSRECORD_block_create2 (key,
256  expire,
257  label,
258  rd_public,
259  rd_public_count);
260  else
261  block = GNUNET_GNSRECORD_block_create (key,
262  expire,
263  label,
264  rd_public,
265  rd_public_count);
266  if (NULL == block)
267  {
268  GNUNET_break (0);
269  return NULL; /* whoops */
270  }
271  block_size = ntohl (block->purpose.size)
272  + sizeof (struct GNUNET_CRYPTO_EcdsaSignature)
273  + sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey);
275  label,
276  &query);
277  GNUNET_STATISTICS_update (statistics,
278  "DHT put operations initiated",
279  1,
280  GNUNET_NO);
282  "Storing %u record(s) for label `%s' in DHT with expiration `%s' under key %s\n",
283  rd_public_count,
284  label,
286  GNUNET_h2s (&query));
287  ret = GNUNET_DHT_put (dht_handle,
288  &query,
292  block_size,
293  block,
294  expire,
296  ma);
297  GNUNET_free (block);
298  return ret;
299 }
300 
301 
312 static void
314  const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
315  const char *label,
316  unsigned int rd_count,
317  const struct GNUNET_GNSRECORD_Data *rd)
318 {
319  struct GNUNET_GNSRECORD_Data rd_public[rd_count];
320  unsigned int rd_public_count;
321  struct DhtPutActivity *ma;
322 
323  (void) cls;
324  GNUNET_STATISTICS_update (statistics,
325  "Namestore monitor events received",
326  1,
327  GNUNET_NO);
329  "Received %u records for label `%s' via namestore monitor\n",
330  rd_count,
331  label);
332  /* filter out records that are not public, and convert to
333  absolute expiration time. */
334  rd_public_count = convert_records_for_export (rd,
335  rd_count,
336  rd_public);
337  if (0 == rd_public_count)
338  {
340  1);
341  return; /* nothing to do */
342  }
343  ma = GNUNET_new (struct DhtPutActivity);
345  ma->ph = perform_dht_put (zone,
346  label,
347  rd,
348  rd_count,
349  ma);
350  if (NULL == ma->ph)
351  {
352  /* PUT failed, do not remember operation */
353  GNUNET_free (ma);
355  1);
356  return;
357  }
359  ma_tail,
360  ma);
361  ma_queue_length++;
363  {
364  ma = ma_head;
366  ma_tail,
367  ma);
369  ma_queue_length--;
371  "DHT PUT unconfirmed after %s, aborting PUT\n",
373  GNUNET_YES));
374  GNUNET_free (ma);
375  }
376 }
377 
378 
385 static void
387 {
388  (void) cls;
389  GNUNET_STATISTICS_update (statistics,
390  "Namestore monitor errors encountered",
391  1,
392  GNUNET_NO);
393 }
394 
395 
403 static void
404 run (void *cls,
405  const struct GNUNET_CONFIGURATION_Handle *c,
407 {
408  unsigned long long max_parallel_bg_queries = 128;
409 
410  (void) cls;
411  (void) service;
412  namestore_handle = GNUNET_NAMESTORE_connect (c);
413  if (NULL == namestore_handle)
414  {
416  _("Failed to connect to the namestore!\n"));
418  return;
419  }
421  "namestore",
422  "CACHE_KEYS");
423  if (GNUNET_OK ==
425  "zonemaster",
426  "MAX_PARALLEL_BACKGROUND_QUERIES",
427  &max_parallel_bg_queries))
428  {
430  "Number of allowed parallel background queries: %llu\n",
431  max_parallel_bg_queries);
432  }
433  if (0 == max_parallel_bg_queries)
434  max_parallel_bg_queries = 1;
435  dht_handle = GNUNET_DHT_connect (c,
436  (unsigned int) max_parallel_bg_queries);
437  if (NULL == dht_handle)
438  {
440  _("Could not connect to DHT!\n"));
442  NULL);
443  return;
444  }
445 
446  /* Schedule periodic put for our records. */
447  statistics = GNUNET_STATISTICS_create ("zonemaster-mon",
448  c);
450  NULL,
451  GNUNET_NO,
453  NULL,
455  NULL,
456  NULL /* sync_cb */,
457  NULL);
460  GNUNET_break (NULL != zmon);
462  NULL);
463 }
464 
465 
470 ("zonemaster-monitor",
472  &run,
473  NULL,
474  NULL,
475  NULL,
477 
478 
479 /* end of gnunet-service-zonemaster-monitor.c */
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
static struct GNUNET_SERVICE_Handle * service
Handle to our service instance.
struct GNUNET_DHT_PutHandle * ph
Handle for the DHT PUT operation.
struct DhtPutActivity * prev
Kept in a DLL.
int GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
static int cache_keys
Optimize block insertion by caching map of private keys to public keys in memory? ...
void GNUNET_DHT_put_cancel(struct GNUNET_DHT_PutHandle *ph)
Cancels a DHT PUT operation.
Definition: dht_api.c:1040
static void shutdown_task(void *cls)
Task run during shutdown.
static struct GNUNET_STATISTICS_Handle * statistics
Handle to the statistics service.
static struct GNUNET_NAMESTORE_ZoneMonitor * zmon
Handle to monitor namestore changes to instant propagation.
struct GNUNET_NAMESTORE_ZoneMonitor * GNUNET_NAMESTORE_zone_monitor_start(const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, int iterate_first, GNUNET_SCHEDULER_TaskCallback error_cb, void *error_cb_cls, GNUNET_NAMESTORE_RecordMonitor monitor, void *monitor_cls, GNUNET_SCHEDULER_TaskCallback sync_cb, void *sync_cb_cls)
Begin monitoring a zone for changes.
struct GNUNET_GNSRECORD_Block * GNUNET_GNSRECORD_block_create(const struct GNUNET_CRYPTO_EcdsaPrivateKey *key, struct GNUNET_TIME_Absolute expire, const char *label, const struct GNUNET_GNSRECORD_Data *rd, unsigned int rd_count)
Sign name and records.
Handle to a service.
Definition: service.c:116
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:1293
struct GNUNET_STATISTICS_Handle * GNUNET_STATISTICS_create(const char *subsystem, const struct GNUNET_CONFIGURATION_Handle *cfg)
Get handle for the statistics service.
struct GNUNET_GNSRECORD_Block * GNUNET_GNSRECORD_block_create2(const struct GNUNET_CRYPTO_EcdsaPrivateKey *key, struct GNUNET_TIME_Absolute expire, const char *label, const struct GNUNET_GNSRECORD_Data *rd, unsigned int rd_count)
Sign name and records, cache derived public key (also keeps the private key in static memory...
struct GNUNET_TIME_Absolute start_date
When was this PUT initiated?
#define DHT_GNS_REPLICATION_LEVEL
What replication level do we use for DHT PUT operations?
void GNUNET_NAMESTORE_zone_monitor_stop(struct GNUNET_NAMESTORE_ZoneMonitor *zm)
Stop monitoring a zone for changes.
#define GNUNET_NO
Definition: gnunet_common.h:81
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Private ECC key encoded for transmission.
Information we have in an encrypted block with record data (i.e.
void GNUNET_STATISTICS_destroy(struct GNUNET_STATISTICS_Handle *h, int sync_first)
Destroy a handle (free all state associated with it).
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:524
static int ret
Final status code.
Definition: gnunet-arm.c:89
Handle for the service.
uint64_t abs_value_us
The actual value.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
Handle for DHT PUT activity triggered from the namestore monitor.
Connection to the DHT service.
Definition: dht_api.c:205
#define _(String)
GNU gettext support macro.
Definition: platform.h:208
#define DHT_QUEUE_LIMIT
How many pending DHT operations do we allow at most?
static char * zone
Name of the zone we manage.
void GNUNET_GNSRECORD_query_from_private_key(const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, const char *label, struct GNUNET_HashCode *query)
Calculate the DHT query for a given label in a given zone.
static struct GNUNET_NAMESTORE_Handle * namestore_handle
Our handle to the namestore service.
void GNUNET_NAMESTORE_disconnect(struct GNUNET_NAMESTORE_Handle *h)
Disconnect from the namestore service (and free associated resources).
Handle for a monitoring activity.
static void handle_monitor_error(void *cls)
The zone monitor encountered an IPC error trying to to get in sync.
GNUNET_SERVICE_MAIN("zonemaster-monitor", GNUNET_SERVICE_OPTION_NONE, &run, NULL, NULL, NULL, GNUNET_MQ_handler_end())
Define "main" method using service macro.
Connection to the NAMESTORE service.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1273
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:727
an ECC signature using ECDSA
This is a private record of this peer and it should thus not be handed out to other peers...
uint32_t size
How many bytes does this signature sign? (including this purpose header); in network byte order (!)...
Block for storing record data.
A 512-bit hashcode.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
struct GNUNET_TIME_Absolute GNUNET_GNSRECORD_record_get_expiration_time(unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd)
Returns the expiration time of the given block of records.
struct GNUNET_HashCode key
The key used in the DHT.
struct GNUNET_DHT_PutHandle * GNUNET_DHT_put(struct GNUNET_DHT_Handle *handle, const struct GNUNET_HashCode *key, uint32_t desired_replication_level, enum GNUNET_DHT_RouteOption options, enum GNUNET_BLOCK_Type type, size_t size, const void *data, struct GNUNET_TIME_Absolute exp, GNUNET_SCHEDULER_TaskCallback cont, void *cont_cls)
Perform a PUT operation storing data in the DHT.
Definition: dht_api.c:971
#define NAMESTORE_QUEUE_LIMIT
How many events may the namestore give us before it has to wait for us to keep up?
struct GNUNET_DHT_Handle * GNUNET_DHT_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned int ht_len)
Initialize the connection with the DHT service.
Definition: dht_api.c:895
struct GNUNET_NAMESTORE_Handle * GNUNET_NAMESTORE_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Connect to the namestore service.
void GNUNET_DHT_disconnect(struct GNUNET_DHT_Handle *handle)
Shutdown connection with the DHT service.
Definition: dht_api.c:923
#define GNUNET_CONTAINER_DLL_insert_tail(head, tail, element)
Insert an element at the tail of a DLL.
static struct DhtPutActivity * ma_head
Head of monitor activities; kept in a DLL.
Handle to a PUT request.
Definition: dht_api.c:43
static struct DhtPutActivity * ma_tail
Tail of monitor activities; kept in a DLL.
configuration data
Definition: configuration.c:85
static void handle_monitor_event(void *cls, const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, const char *label, unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd)
Process a record that was stored in the namestore (invoked by the monitor).
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration(struct GNUNET_TIME_Absolute whence)
Get the duration of an operation as the difference of the current time and the given start time "henc...
Definition: time.c:373
static void run(void *cls, const struct GNUNET_CONFIGURATION_Handle *c, struct GNUNET_SERVICE_Handle *service)
Performe zonemaster duties: watch namestore, publish records.
#define GNUNET_log(kind,...)
static struct GNUNET_DHT_Handle * dht_handle
Our handle to the DHT.
static unsigned int ma_queue_length
Number of entries in the DHT queue ma_head.
static struct GNUNET_DHT_PutHandle * perform_dht_put(const struct GNUNET_CRYPTO_EcdsaPrivateKey *key, const char *label, const struct GNUNET_GNSRECORD_Data *rd_public, unsigned int rd_public_count, struct DhtPutActivity *ma)
Store GNS records in the DHT.
static unsigned int convert_records_for_export(const struct GNUNET_GNSRECORD_Data *rd, unsigned int rd_count, struct GNUNET_GNSRECORD_Data *rd_public)
Convert namestore records from the internal format to that suitable for publication (removes private ...
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_YES
Definition: gnunet_common.h:80
static void dht_put_monitor_continuation(void *cls)
Continuation called from DHT once the PUT operation triggered by a monitor is done.
This flag is currently unused; former RF_PENDING flag.
const char * GNUNET_STRINGS_absolute_time_to_string(struct GNUNET_TIME_Absolute t)
Like asctime, except for GNUnet time.
Definition: strings.c:792
int GNUNET_CONFIGURATION_get_value_yesno(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Get a configuration value that should be in a set of "YES" or "NO".
struct GNUNET_CRYPTO_EccSignaturePurpose purpose
Number of bytes signed; also specifies the number of bytes of encrypted data that follow...
struct DhtPutActivity * next
Kept in a DLL.
void GNUNET_NAMESTORE_zone_monitor_next(struct GNUNET_NAMESTORE_ZoneMonitor *zm, uint64_t limit)
Calls the monitor processor specified in GNUNET_NAMESTORE_zone_monitor_start for the next record(s)...
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
Each peer along the way should look at &#39;enc&#39; (otherwise only the k-peers closest to the key should lo...
#define GNUNET_free(ptr)
Wrapper around free.