2 This file is part of GNUnet.
3 Copyright (C) 2012, 2013, 2014, 2017, 2018 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file zonemaster/gnunet-service-zonemaster-monitor.c
23 * @brief monitor namestore changes and publish them immediately to GNUnet name system
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_dht_service.h"
29 #include "gnunet_namestore_service.h"
30 #include "gnunet_statistics_service.h"
33 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
37 * How often should we (re)publish each record before
40 #define PUBLISH_OPS_PER_EXPIRATION 4
43 * How many pending DHT operations do we allow at most?
45 #define DHT_QUEUE_LIMIT 2000
48 * How many events may the namestore give us before it has to wait
51 #define NAMESTORE_QUEUE_LIMIT 5
54 * What replication level do we use for DHT PUT operations?
56 #define DHT_GNS_REPLICATION_LEVEL 5
60 * Handle for DHT PUT activity triggered from the namestore monitor.
67 struct DhtPutActivity *next;
72 struct DhtPutActivity *prev;
75 * Handle for the DHT PUT operation.
77 struct GNUNET_DHT_PutHandle *ph;
80 * When was this PUT initiated?
82 struct GNUNET_TIME_Absolute start_date;
87 * Handle to the statistics service
89 static struct GNUNET_STATISTICS_Handle *statistics;
92 * Our handle to the DHT
94 static struct GNUNET_DHT_Handle *dht_handle;
97 * Our handle to the namestore service
99 static struct GNUNET_NAMESTORE_Handle *namestore_handle;
102 * Handle to monitor namestore changes to instant propagation.
104 static struct GNUNET_NAMESTORE_ZoneMonitor *zmon;
107 * Head of monitor activities; kept in a DLL.
109 static struct DhtPutActivity *ma_head;
112 * Tail of monitor activities; kept in a DLL.
114 static struct DhtPutActivity *ma_tail;
117 * Number of entries in the DHT queue #ma_head.
119 static unsigned int ma_queue_length;
122 * Optimize block insertion by caching map of private keys to
123 * public keys in memory?
125 static int cache_keys;
129 * Task run during shutdown.
135 shutdown_task (void *cls)
137 struct DhtPutActivity *ma;
140 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
142 while (NULL != (ma = ma_head))
144 GNUNET_DHT_put_cancel (ma->ph);
146 GNUNET_CONTAINER_DLL_remove (ma_head,
151 if (NULL != statistics)
153 GNUNET_STATISTICS_destroy (statistics,
159 GNUNET_NAMESTORE_zone_monitor_stop (zmon);
162 if (NULL != namestore_handle)
164 GNUNET_NAMESTORE_disconnect (namestore_handle);
165 namestore_handle = NULL;
167 if (NULL != dht_handle)
169 GNUNET_DHT_disconnect (dht_handle);
176 * Continuation called from DHT once the PUT operation triggered
177 * by a monitor is done.
179 * @param cls a `struct DhtPutActivity`
182 dht_put_monitor_continuation (void *cls)
184 struct DhtPutActivity *ma = cls;
186 GNUNET_NAMESTORE_zone_monitor_next (zmon,
189 GNUNET_CONTAINER_DLL_remove (ma_head,
197 * Convert namestore records from the internal format to that
198 * suitable for publication (removes private records, converts
199 * to absolute expiration time).
201 * @param rd input records
202 * @param rd_count size of the @a rd and @a rd_public arrays
203 * @param rd_public where to write the converted records
204 * @return number of records written to @a rd_public
207 convert_records_for_export (const struct GNUNET_GNSRECORD_Data *rd,
208 unsigned int rd_count,
209 struct GNUNET_GNSRECORD_Data *rd_public)
211 struct GNUNET_TIME_Absolute now;
212 unsigned int rd_public_count;
215 now = GNUNET_TIME_absolute_get ();
216 for (unsigned int i=0;i<rd_count;i++)
218 if (0 != (rd[i].flags & GNUNET_GNSRECORD_RF_PRIVATE))
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];
225 return rd_public_count;
230 * Store GNS records in the DHT.
232 * @param key key of the zone
233 * @param label label to store under
234 * @param rd_public public record data
235 * @param rd_public_count number of records in @a rd_public
236 * @param ma handle for the PUT operation
237 * @return DHT PUT handle, NULL on error
239 static struct GNUNET_DHT_PutHandle *
240 perform_dht_put (const struct GNUNET_CRYPTO_EcdsaPrivateKey *key,
242 const struct GNUNET_GNSRECORD_Data *rd_public,
243 unsigned int rd_public_count,
244 struct DhtPutActivity *ma)
246 struct GNUNET_GNSRECORD_Block *block;
247 struct GNUNET_HashCode query;
248 struct GNUNET_TIME_Absolute expire;
250 struct GNUNET_DHT_PutHandle *ret;
252 expire = GNUNET_GNSRECORD_record_get_expiration_time (rd_public_count,
255 block = GNUNET_GNSRECORD_block_create2 (key,
261 block = GNUNET_GNSRECORD_block_create (key,
269 return NULL; /* whoops */
271 block_size = ntohl (block->purpose.size)
272 + sizeof (struct GNUNET_CRYPTO_EcdsaSignature)
273 + sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey);
274 GNUNET_GNSRECORD_query_from_private_key (key,
277 GNUNET_STATISTICS_update (statistics,
278 "DHT put operations initiated",
281 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
282 "Storing %u record(s) for label `%s' in DHT with expiration `%s' under key %s\n",
285 GNUNET_STRINGS_absolute_time_to_string (expire),
286 GNUNET_h2s (&query));
287 ret = GNUNET_DHT_put (dht_handle,
289 DHT_GNS_REPLICATION_LEVEL,
290 GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
291 GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
295 &dht_put_monitor_continuation,
303 * Process a record that was stored in the namestore
304 * (invoked by the monitor).
306 * @param cls closure, NULL
307 * @param zone private key of the zone; NULL on disconnect
308 * @param label label of the records; NULL on disconnect
309 * @param rd_count number of entries in @a rd array, 0 if label was deleted
310 * @param rd array of records with data to store
313 handle_monitor_event (void *cls,
314 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
316 unsigned int rd_count,
317 const struct GNUNET_GNSRECORD_Data *rd)
319 struct GNUNET_GNSRECORD_Data rd_public[rd_count];
320 unsigned int rd_public_count;
321 struct DhtPutActivity *ma;
324 GNUNET_STATISTICS_update (statistics,
325 "Namestore monitor events received",
328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
329 "Received %u records for label `%s' via namestore monitor\n",
332 /* filter out records that are not public, and convert to
333 absolute expiration time. */
334 rd_public_count = convert_records_for_export (rd,
337 if (0 == rd_public_count)
339 GNUNET_NAMESTORE_zone_monitor_next (zmon,
341 return; /* nothing to do */
343 ma = GNUNET_new (struct DhtPutActivity);
344 ma->start_date = GNUNET_TIME_absolute_get ();
345 ma->ph = perform_dht_put (zone,
352 /* PUT failed, do not remember operation */
354 GNUNET_NAMESTORE_zone_monitor_next (zmon,
358 GNUNET_CONTAINER_DLL_insert_tail (ma_head,
362 if (ma_queue_length > DHT_QUEUE_LIMIT)
365 GNUNET_CONTAINER_DLL_remove (ma_head,
368 GNUNET_DHT_put_cancel (ma->ph);
370 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
371 "DHT PUT unconfirmed after %s, aborting PUT\n",
372 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (ma->start_date),
380 * The zone monitor encountered an IPC error trying to to get in
381 * sync. Restart from the beginning.
386 handle_monitor_error (void *cls)
389 GNUNET_STATISTICS_update (statistics,
390 "Namestore monitor errors encountered",
397 * Performe zonemaster duties: watch namestore, publish records.
400 * @param server the initialized server
401 * @param c configuration to use
405 const struct GNUNET_CONFIGURATION_Handle *c,
406 struct GNUNET_SERVICE_Handle *service)
408 unsigned long long max_parallel_bg_queries = 128;
412 namestore_handle = GNUNET_NAMESTORE_connect (c);
413 if (NULL == namestore_handle)
415 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
416 _("Failed to connect to the namestore!\n"));
417 GNUNET_SCHEDULER_shutdown ();
420 cache_keys = GNUNET_CONFIGURATION_get_value_yesno (c,
424 GNUNET_CONFIGURATION_get_value_number (c,
426 "MAX_PARALLEL_BACKGROUND_QUERIES",
427 &max_parallel_bg_queries))
429 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
430 "Number of allowed parallel background queries: %llu\n",
431 max_parallel_bg_queries);
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)
439 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
440 _("Could not connect to DHT!\n"));
441 GNUNET_SCHEDULER_add_now (&shutdown_task,
446 /* Schedule periodic put for our records. */
447 statistics = GNUNET_STATISTICS_create ("zonemaster-mon",
449 zmon = GNUNET_NAMESTORE_zone_monitor_start (c,
452 &handle_monitor_error,
454 &handle_monitor_event,
458 GNUNET_NAMESTORE_zone_monitor_next (zmon,
459 NAMESTORE_QUEUE_LIMIT - 1);
460 GNUNET_break (NULL != zmon);
461 GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
467 * Define "main" method using service macro.
470 ("zonemaster-monitor",
471 GNUNET_SERVICE_OPTION_NONE,
476 GNUNET_MQ_handler_end());
479 /* end of gnunet-service-zonemaster-monitor.c */