GNUnet  0.11.x
gnunet-service-fs_push.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2011, 2016 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-service-fs.h"
29 #include "gnunet-service-fs_cp.h"
31 #include "gnunet-service-fs_push.h"
32 
33 
37 #define MAX_MIGRATION_QUEUE 8
38 
43 #define MIGRATION_LIST_SIZE 2
44 
52 #define MIN_MIGRATION_CONTENT_LIFETIME GNUNET_TIME_relative_multiply ( \
53  GNUNET_TIME_UNIT_MINUTES, 30)
54 
55 
60 {
65 
70 
75 
80 
86 
90  size_t size;
91 
95  unsigned int used_targets;
96 
101 };
102 
103 
108 {
113 
118 
123 
128 };
129 
130 
135 
140 
145 
150 
155 
160 
166 
170 static unsigned int mig_size;
171 
175 static int enabled;
176 
180 static int value_found;
181 
182 
188 static void
190 {
191  GNUNET_CONTAINER_DLL_remove (mig_head,
192  mig_tail,
193  mb);
196  mig_size--;
197  GNUNET_free (mb);
198 }
199 
200 
206 static void
207 find_content (void *cls);
208 
209 
217 static int
219  struct MigrationReadyBlock *block)
220 {
221  struct PutMessage *msg;
222  unsigned int i;
223  struct GSF_PeerPerformanceData *ppd;
224  int ret;
225 
227  GNUNET_assert (NULL == mrp->env);
228  mrp->env = GNUNET_MQ_msg_extra (msg,
229  block->size,
231  msg->type = htonl (block->type);
233  GNUNET_memcpy (&msg[1],
234  &block[1],
235  block->size);
236  for (i = 0; i < MIGRATION_LIST_SIZE; i++)
237  {
238  if (block->target_list[i] == 0)
239  {
240  block->target_list[i] = ppd->pid;
242  1);
243  break;
244  }
245  }
246  if (MIGRATION_LIST_SIZE == i)
247  {
248  delete_migration_block (block);
249  ret = GNUNET_YES;
250  }
251  else
252  {
253  ret = GNUNET_NO;
254  }
256  &find_content,
257  mrp);
258  GSF_peer_transmit_ (mrp->peer,
259  GNUNET_NO,
260  0 /* priority */,
261  mrp->env);
262  return ret;
263 }
264 
265 
273 static unsigned int
275 {
276  unsigned int i;
277 
278  for (i = 0; i < MIGRATION_LIST_SIZE; i++)
279  if (block->target_list[i] == 0)
280  return i;
281  return i;
282 }
283 
284 
293 static long
295  struct MigrationReadyBlock *block)
296 {
297  unsigned int i;
298  struct GSF_PeerPerformanceData *ppd;
299  struct GNUNET_PeerIdentity id;
300  struct GNUNET_HashCode hc;
301  uint32_t dist;
302 
304  for (i = 0; i < MIGRATION_LIST_SIZE; i++)
305  if (block->target_list[i] == ppd->pid)
306  return -1;
307  GNUNET_assert (0 != ppd->pid);
308  GNUNET_PEER_resolve (ppd->pid,
309  &id);
310  GNUNET_CRYPTO_hash (&id,
311  sizeof(struct GNUNET_PeerIdentity),
312  &hc);
313  dist = GNUNET_CRYPTO_hash_distance_u32 (&block->query,
314  &hc);
315  /* closer distance, higher score: */
316  return UINT32_MAX - dist;
317 }
318 
319 
324 static void
325 consider_gathering (void);
326 
327 
333 static void
334 find_content (void *cls)
335 {
336  struct MigrationReadyPeer *mrp = cls;
337  struct MigrationReadyBlock *pos;
338  long score;
339  long best_score;
340  struct MigrationReadyBlock *best;
341 
342  mrp->env = NULL;
343  best = NULL;
344  best_score = -1;
345  pos = mig_head;
346  while (NULL != pos)
347  {
348  score = score_content (mrp, pos);
349  if (score > best_score)
350  {
351  best_score = score;
352  best = pos;
353  }
354  pos = pos->next;
355  }
356  if (NULL == best)
357  {
359  {
361  "No content found for pushing, waiting for queue to fill\n");
362  return; /* will fill up eventually... */
363  }
365  "No suitable content found, purging content from full queue\n");
366  /* failed to find migration target AND
367  * queue is full, purge most-forwarded
368  * block from queue to make room for more */
369  pos = mig_head;
370  while (NULL != pos)
371  {
372  score = count_targets (pos);
373  if (score >= best_score)
374  {
375  best_score = score;
376  best = pos;
377  }
378  pos = pos->next;
379  }
380  GNUNET_assert (NULL != best);
381  delete_migration_block (best);
383  return;
384  }
386  "Preparing to push best content to peer\n");
387  transmit_content (mrp,
388  best);
389 }
390 
391 
398 static void
399 gather_migration_blocks (void *cls);
400 
401 
406 static void
408 {
409  struct GNUNET_TIME_Relative delay;
410 
411  if (NULL == GSF_dsh)
412  return;
413  if (NULL != mig_qe)
414  return;
415  if (NULL != mig_task)
416  return;
418  return;
420  mig_size);
421  delay = GNUNET_TIME_relative_divide (delay,
423  delay = GNUNET_TIME_relative_max (delay,
425  if (GNUNET_NO == value_found)
426  {
427  /* wait at least 5s if the datastore is empty */
428  delay = GNUNET_TIME_relative_max (delay,
431  5));
432  }
434  "Scheduling gathering task (queue size: %u)\n",
435  mig_size);
436  mig_task = GNUNET_SCHEDULER_add_delayed (delay,
438  NULL);
439 }
440 
441 
457 static void
459  const struct GNUNET_HashCode *key,
460  size_t size,
461  const void *data,
462  enum GNUNET_BLOCK_Type type,
463  uint32_t priority,
464  uint32_t anonymity,
465  uint32_t replication,
467  uint64_t uid)
468 {
469  struct MigrationReadyBlock *mb;
470  struct MigrationReadyPeer *pos;
471 
472  mig_qe = NULL;
473  if (NULL == key)
474  {
476  "No content found for migration...\n");
478  return;
479  }
481  if (GNUNET_TIME_absolute_get_remaining (expiration).rel_value_us <
482  MIN_MIGRATION_CONTENT_LIFETIME.rel_value_us)
483  {
484  /* content will expire soon, don't bother */
486  return;
487  }
488  if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
489  {
490  if (GNUNET_OK !=
492  size,
493  data,
494  type,
495  priority,
496  anonymity,
497  replication,
498  expiration,
499  uid,
501  NULL))
503  return;
504  }
506  "Retrieved block `%s' of type %u for migration (queue size: %u/%u)\n",
507  GNUNET_h2s (key),
508  type, mig_size + 1,
510  mb = GNUNET_malloc (sizeof(struct MigrationReadyBlock) + size);
511  mb->query = *key;
512  mb->expiration = expiration;
513  mb->size = size;
514  mb->type = type;
515  GNUNET_memcpy (&mb[1], data, size);
517  mig_tail,
518  mig_tail,
519  mb);
520  mig_size++;
521  for (pos = peer_head; NULL != pos; pos = pos->next)
522  {
524  "Preparing to push best content to peer %s\n",
526  if ((NULL == pos->env) &&
527  (GNUNET_YES == transmit_content (pos,
528  mb)))
529  {
530  break; /* 'mb' was freed! */
531  }
532  }
534 }
535 
536 
543 static void
545 {
546  mig_task = NULL;
548  return;
549  if (NULL == GSF_dsh)
550  return;
552  "Asking datastore for content for replication (queue size: %u)\n",
553  mig_size);
556  0,
557  UINT_MAX,
559  NULL);
560  if (NULL == mig_qe)
562 }
563 
564 
571 void
573 {
574  struct MigrationReadyPeer *mrp;
575 
576  if (GNUNET_YES != enabled)
577  return;
578  for (mrp = peer_head; NULL != mrp; mrp = mrp->next)
579  if (mrp->peer == peer)
580  break;
581  if (NULL != mrp)
582  {
583  /* same peer added twice, must not happen */
584  GNUNET_break (0);
585  return;
586  }
587 
589  "Adding peer %s to list for pushing\n",
591 
592  mrp = GNUNET_new (struct MigrationReadyPeer);
593  mrp->peer = peer;
594  find_content (mrp);
595  GNUNET_CONTAINER_DLL_insert (peer_head,
596  peer_tail,
597  mrp);
598 }
599 
600 
607 void
609 {
610  struct MigrationReadyPeer *pos;
611 
612  for (pos = peer_head; NULL != pos; pos = pos->next)
613  if (pos->peer == peer)
614  break;
615  if (NULL == pos)
616  return;
617  if (NULL != pos->env)
618  GNUNET_MQ_send_cancel (pos->env);
619  GNUNET_CONTAINER_DLL_remove (peer_head,
620  peer_tail,
621  pos);
622  GNUNET_free (pos);
623 }
624 
625 
629 void
631 {
632  enabled =
634  "FS",
635  "CONTENT_PUSHING");
636  if (GNUNET_YES != enabled)
637  return;
638 
639  if (GNUNET_OK !=
641  "fs",
642  "MIN_MIGRATION_DELAY",
644  {
646  "fs",
647  "MIN_MIGRATION_DELAY",
648  _ ("time required, content pushing disabled"));
649  return;
650  }
652 }
653 
654 
658 void
660 {
661  if (NULL != mig_task)
662  {
663  GNUNET_SCHEDULER_cancel (mig_task);
664  mig_task = NULL;
665  }
666  if (NULL != mig_qe)
667  {
668  GNUNET_DATASTORE_cancel (mig_qe);
669  mig_qe = NULL;
670  }
671  while (NULL != mig_head)
672  delete_migration_block (mig_head);
673  GNUNET_assert (0 == mig_size);
674 }
675 
676 
677 /* end of gnunet-service-fs_push.c */
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
API to handle &#39;connected peers&#39;.
static long score_content(struct MigrationReadyPeer *mrp, struct MigrationReadyBlock *block)
Check if sending this block to this peer would be a good idea.
#define MIGRATION_LIST_SIZE
Blocks are at most migrated to this number of peers plus one, each time they are fetched from the dat...
struct GSF_ConnectedPeer * peer
Handle to peer.
#define MAX_MIGRATION_QUEUE
Maximum number of blocks we keep in memory for migration.
int GNUNET_CONFIGURATION_get_value_time(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, struct GNUNET_TIME_Relative *time)
Get a configuration value that should be a relative time.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
struct GNUNET_MQ_Envelope * env
Envelope of the currently pushed message.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
void GSF_push_stop_(struct GSF_ConnectedPeer *peer)
A peer disconnected from us.
static struct GNUNET_DATASTORE_QueueEntry * mig_qe
Request to datastore for migration (or NULL).
Response from FS service with a result for a previous FS search.
Definition: fs.h:328
struct GNUNET_TIME_AbsoluteNBO expiration
When does this result expire?
Definition: fs.h:343
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
struct GNUNET_TIME_Absolute expiration
When does this block expire?
struct GNUNET_TIME_Relative GNUNET_TIME_relative_max(struct GNUNET_TIME_Relative t1, struct GNUNET_TIME_Relative t2)
Return the maximum of two relative time values.
Definition: time.c:287
static struct MigrationReadyPeer * peer_tail
Tail of linked list of peers.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
void GSF_peer_transmit_(struct GSF_ConnectedPeer *cp, int is_query, uint32_t priority, struct GNUNET_MQ_Envelope *env)
Transmit a message to the given peer as soon as possible.
#define GNUNET_TIME_UNIT_SECONDS
One second.
static unsigned int replication
Information about a peer waiting for migratable data.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
static int transmit_content(struct MigrationReadyPeer *mrp, struct MigrationReadyBlock *block)
Send the given block to the given peer.
#define GNUNET_NO
Definition: gnunet_common.h:78
enum GNUNET_BLOCK_Type type
Type of the block.
shared data structures of gnunet-service-fs.c
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#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.
static struct MigrationReadyBlock * mig_head
Head of linked list of blocks that can be migrated.
void GNUNET_log_config_invalid(enum GNUNET_ErrorType kind, const char *section, const char *option, const char *required)
Log error message about invalid configuration option value.
static struct GNUNET_SCHEDULER_Task * mig_task
ID of task that collects blocks for migration.
static int enabled
Is this module enabled?
uint32_t GNUNET_CRYPTO_hash_distance_u32(const struct GNUNET_HashCode *a, const struct GNUNET_HashCode *b)
Compute the distance between 2 hashcodes.
Definition: crypto_hash.c:127
static struct GNUNET_TIME_Relative min_migration_delay
What is the maximum frequency at which we are allowed to poll the datastore for migration content...
Block that is ready for migration to other peers.
static struct MigrationReadyBlock * mig_tail
Tail of linked list of blocks that can be migrated.
void GNUNET_PEER_resolve(GNUNET_PEER_Id id, struct GNUNET_PeerIdentity *pid)
Convert an interned PID to a normal peer identity.
Definition: peer.c:225
const struct GNUNET_CONFIGURATION_Handle * GSF_cfg
Our configuration.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
Type of a block representing a block to be encoded on demand from disk.
static void delete_migration_block(struct MigrationReadyBlock *mb)
Delete the given migration block.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static void consider_gathering(void)
If the migration task is not currently running, consider (re)scheduling it with the appropriate delay...
void GSF_push_init_()
Setup the module.
struct MigrationReadyPeer * prev
This is a doubly-linked list.
GNUNET_PEER_Id target_list[2]
Peers we already forwarded this block to.
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct...
Definition: gnunet_mq_lib.h:52
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1253
#define MIN_MIGRATION_CONTENT_LIFETIME
How long must content remain valid for us to consider it for migration? If content will expire too so...
Entry in our priority queue.
Definition: datastore_api.c:99
unsigned int GNUNET_PEER_Id
A GNUNET_PEER_Id is simply a shorter version of a "struct GNUNET_PeerIdentifier" that can be used ins...
unsigned int used_targets
Number of targets already used.
void GNUNET_MQ_notify_sent(struct GNUNET_MQ_Envelope *ev, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
Call a callback once the envelope has been sent, that is, sending it can not be canceled anymore...
Definition: mq.c:774
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:48
struct MigrationReadyBlock * next
This is a doubly-linked list.
struct GSF_PeerPerformanceData * GSF_get_peer_performance_data_(struct GSF_ConnectedPeer *cp)
Return the performance data record for the given peer.
struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply(struct GNUNET_TIME_Relative rel, unsigned long long factor)
Multiply relative time by a given factor.
Definition: time.c:442
#define GNUNET_CONTAINER_DLL_insert_after(head, tail, other, element)
Insert an element into a DLL after the given other element.
static int value_found
Did we find anything in the datastore?
A 512-bit hashcode.
struct GNUNET_DATASTORE_Handle * GSF_dsh
Our connection to the datastore.
void GNUNET_PEER_decrement_rcs(const GNUNET_PEER_Id *ids, unsigned int count)
Decrement multiple RCs of peer identities by one.
Definition: peer.c:162
struct MigrationReadyPeer * next
This is a doubly-linked list.
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
struct GNUNET_HashCode key
The key used in the DHT.
static void process_migration_content(void *cls, const struct GNUNET_HashCode *key, size_t size, const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority, uint32_t anonymity, uint32_t replication, struct GNUNET_TIME_Absolute expiration, uint64_t uid)
Process content offered for migration.
indexing for the file-sharing service
uint32_t type
Type of the block (in big endian).
Definition: fs.h:338
GNUNET_PEER_Id pid
The peer&#39;s identity (interned version).
void GSF_push_start_(struct GSF_ConnectedPeer *peer)
A peer connected to us.
void GNUNET_DATASTORE_cancel(struct GNUNET_DATASTORE_QueueEntry *qe)
Cancel a datastore operation.
The identity of the host (wraps the signing key of the peer).
static unsigned int mig_size
Size of the doubly-linked list of migration blocks.
Performance data kept for a peer.
const struct GNUNET_PeerIdentity * GSF_connected_peer_get_identity2_(const struct GSF_ConnectedPeer *cp)
Obtain the identity of a connected peer.
void GNUNET_PEER_change_rc(GNUNET_PEER_Id id, int delta)
Change the reference counter of an interned PID.
Definition: peer.c:197
#define GNUNET_log(kind,...)
Entry in list of pending tasks.
Definition: scheduler.c:134
A connected peer.
void GSF_push_done_()
Shutdown the module.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
struct GNUNET_TIME_Relative GNUNET_TIME_relative_divide(struct GNUNET_TIME_Relative rel, unsigned long long factor)
Divide relative time by a given factor.
Definition: time.c:527
static unsigned int count_targets(struct MigrationReadyBlock *block)
Count the number of peers this block has already been forwarded to.
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_YES
Definition: gnunet_common.h:77
static unsigned int anonymity
struct GNUNET_HashCode query
Query for the block.
static void find_content(void *cls)
Find content for migration to this peer.
int GNUNET_FS_handle_on_demand_block(const struct GNUNET_HashCode *key, uint32_t size, const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority, uint32_t anonymity, uint32_t replication, struct GNUNET_TIME_Absolute expiration, uint64_t uid, GNUNET_DATASTORE_DatumProcessor cont, void *cont_cls)
We&#39;ve received an on-demand encoded block from the datastore.
support for pushing out content
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".
uint32_t data
The data value.
struct GNUNET_TIME_AbsoluteNBO GNUNET_TIME_absolute_hton(struct GNUNET_TIME_Absolute a)
Convert absolute time to network byte order.
Definition: time.c:657
struct GNUNET_DATASTORE_QueueEntry * GNUNET_DATASTORE_get_for_replication(struct GNUNET_DATASTORE_Handle *h, unsigned int queue_priority, unsigned int max_queue_size, GNUNET_DATASTORE_DatumProcessor proc, void *proc_cls)
Get a random value from the datastore for content replication.
static void gather_migration_blocks(void *cls)
Task that is run periodically to obtain blocks for content migration.
void GNUNET_MQ_send_cancel(struct GNUNET_MQ_Envelope *ev)
Cancel sending the message.
Definition: mq.c:916
#define GNUNET_MESSAGE_TYPE_FS_PUT
P2P response with content or active migration of content.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
static struct MigrationReadyPeer * peer_head
Head of linked list of peers.
size_t size
Size of the block.
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
struct MigrationReadyBlock * prev
This is a doubly-linked list.
Time for relative time used by GNUnet, in microseconds.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:966