plugin_dhtu_gnunet.c

Go to the documentation of this file.

/*
     This file is part of GNUnet
     Copyright (C) 2021, 2026 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#include "gnunet_common.h"
#include "platform.h"
#include "gnunet_dhtu_plugin.h"
#include "gnunet_core_service.h"
#include "gnunet_pils_service.h"
#include "gnunet_transport_application_service.h"
#include "gnunet_hello_uri_lib.h"
#include "gnunet_peerstore_service.h"
#include "gnunet_nse_service.h"
#include "plugin_dhtu_gnunet.h"
 
struct GNUNET_DHTU_Source
{
 
  void *app_ctx;
 
};
 
 
struct GNUNET_DHTU_Target
{
 
  void *app_ctx;
 
  struct Plugin *plugin;
 
  struct GNUNET_MQ_Handle *mq;
 
  struct GNUNET_DHTU_PreferenceHandle *ph_head;
 
  struct GNUNET_DHTU_PreferenceHandle *ph_tail;
 
  struct GNUNET_TRANSPORT_ApplicationSuggestHandle *ash;
 
  struct GNUNET_PeerIdentity pid;
 
  unsigned int ph_count;
 
};
 
 
struct GNUNET_DHTU_PreferenceHandle
{
  struct GNUNET_DHTU_PreferenceHandle *next;
 
  struct GNUNET_DHTU_PreferenceHandle *prev;
 
  struct GNUNET_DHTU_Target *target;
};
 
 
struct Plugin
{
 
  struct GNUNET_DHTU_Source src;
 
  struct GNUNET_DHTU_PluginEnvironment *env;
 
  struct GNUNET_PEERSTORE_Handle *peerstore;
 
  struct GNUNET_CORE_Handle *core;
 
  struct GNUNET_TRANSPORT_ApplicationHandle *transport;
 
  struct GNUNET_NSE_Handle *nse;
 
  struct GNUNET_PEERSTORE_Monitor *peerstore_notify;
 
  struct GNUNET_PILS_Handle *pils;
 
};
 
 
// #include "../peerinfo-tool/gnunet-peerinfo_plugins.c"
 
 
static void
gnunet_try_connect (void *cls,
                    const struct GNUNET_PeerIdentity *pid,
                    const char *address)
{
  struct Plugin *plugin = cls;
  enum GNUNET_NetworkType nt = 0;
  char *addr;
  const char *eou;
  int pfx_len;
 
  eou = strstr (address,
                "://");
  if (NULL == eou)
  {
    GNUNET_break (0);
    return;
  }
  pfx_len = eou - address;
  eou += 3;
  GNUNET_asprintf (&addr,
                   "%.*s-%s",
                   pfx_len,
                   address,
                   eou);
  GNUNET_TRANSPORT_application_validate (plugin->transport,
                                         pid,
                                         nt,
                                         addr);
  GNUNET_free (addr);
}
 
 
static struct GNUNET_DHTU_PreferenceHandle *
gnunet_hold (void *cls,
             struct GNUNET_DHTU_Target *target)
{
  struct Plugin *plugin = cls;
  struct GNUNET_DHTU_PreferenceHandle *ph;
 
  ph = GNUNET_new (struct GNUNET_DHTU_PreferenceHandle);
  ph->target = target;
  GNUNET_CONTAINER_DLL_insert (target->ph_head,
                               target->ph_tail,
                               ph);
  target->ph_count++;
  if (NULL != target->ash)
    GNUNET_TRANSPORT_application_suggest_cancel (target->ash);
  target->ash
    = GNUNET_TRANSPORT_application_suggest (plugin->transport,
                                            &target->pid,
                                            GNUNET_MQ_PRIO_BEST_EFFORT,
                                            GNUNET_BANDWIDTH_ZERO);
  return ph;
}
 
 
static void
gnunet_drop (struct GNUNET_DHTU_PreferenceHandle *ph)
{
  struct GNUNET_DHTU_Target *target = ph->target;
  struct Plugin *plugin = target->plugin;
 
  GNUNET_CONTAINER_DLL_remove (target->ph_head,
                               target->ph_tail,
                               ph);
  target->ph_count--;
  GNUNET_free (ph);
  if (NULL != target->ash)
    GNUNET_TRANSPORT_application_suggest_cancel (target->ash);
  if (0 == target->ph_count)
    target->ash = NULL;
  else
    target->ash
      = GNUNET_TRANSPORT_application_suggest (plugin->transport,
                                              &target->pid,
                                              GNUNET_MQ_PRIO_BEST_EFFORT,
                                              GNUNET_BANDWIDTH_ZERO);
}
 
 
static void
gnunet_send (void *cls,
             struct GNUNET_DHTU_Target *target,
             const void *msg,
             size_t msg_size,
             GNUNET_SCHEDULER_TaskCallback finished_cb,
             void *finished_cb_cls)
{
  struct GNUNET_MQ_Envelope *env;
  struct GNUNET_MessageHeader *cmsg;
 
  env = GNUNET_MQ_msg_extra (cmsg,
                             msg_size,
                             GNUNET_MESSAGE_TYPE_DHT_CORE);
  GNUNET_MQ_notify_sent (env,
                         finished_cb,
                         finished_cb_cls);
  memcpy (&cmsg[1],
          msg,
          msg_size);
  GNUNET_MQ_send (target->mq,
                  env);
}
 
 
static void *
core_connect_cb (void *cls,
                 const struct GNUNET_PeerIdentity *peer,
                 struct GNUNET_MQ_Handle *mq,
                 enum GNUNET_CORE_PeerClass class)
{
  struct Plugin *plugin = cls;
  struct GNUNET_DHTU_Target *target;
 
  target = GNUNET_new (struct GNUNET_DHTU_Target);
  target->plugin = plugin;
  target->mq = mq;
  target->pid = *peer;
  plugin->env->connect_cb (plugin->env->cls,
                           target,
                           &target->pid,
                           &target->app_ctx);
  return target;
}
 
 
static void
core_disconnect_cb (void *cls,
                    const struct GNUNET_PeerIdentity *peer,
                    void *peer_cls)
{
  struct Plugin *plugin = cls;
  struct GNUNET_DHTU_Target *target = peer_cls;
 
  plugin->env->disconnect_cb (target->app_ctx);
  if (NULL != target->ash)
    GNUNET_TRANSPORT_application_suggest_cancel (target->ash);
  GNUNET_free (target);
}
 
 
static void
add_addr (void *cls,
          const struct GNUNET_PeerIdentity *pid,
          const char *addr)
{
  struct Plugin *plugin = cls;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "peerinfo_cb addr %s\n",
              addr);
  plugin->env->address_add_cb (plugin->env->cls,
                               addr,
                               &plugin->src,
                               &plugin->src.app_ctx);
}
 
 
static void
peerinfo_cb (void *cls,
             const struct GNUNET_PEERSTORE_Record *record,
             const char *emsg)
{
  const struct GNUNET_PeerIdentity *my_identity;
  struct Plugin *plugin = cls;
  struct GNUNET_HELLO_Parser *parser;
  struct GNUNET_MessageHeader *hello;
 
  hello = record->value;
  if (NULL == hello)
    return;
  my_identity = GNUNET_PILS_get_identity (plugin->pils);
  if (! my_identity)
    return;
  if (0 != GNUNET_memcmp (&record->peer, my_identity))
  {
    GNUNET_PEERSTORE_monitor_next (plugin->peerstore_notify, 1);
    return;
  }
  parser = GNUNET_HELLO_parser_from_msg (hello, &record->peer);
  if (NULL == parser)
  {
    /* PEERSTORE values are unvalidated blobs from remote peers;
       #GNUNET_HELLO_parser_iterate() would dereference NULL here. */
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "HELLO from PEERSTORE cannot be parsed!\n");
    GNUNET_PEERSTORE_monitor_next (plugin->peerstore_notify, 1);
    return;
  }
  GNUNET_HELLO_parser_iterate (parser,
                               add_addr,
                               plugin);
  GNUNET_HELLO_parser_free (parser);
  GNUNET_PEERSTORE_monitor_next (plugin->peerstore_notify, 1);
}
 
 
static void
error_cb (void *cls)
{
  GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
              "Error in PEERSTORE monitoring\n");
}
 
 
static void
sync_cb (void *cls)
{
  GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
              "Done with initial PEERSTORE iteration during monitoring\n");
}
 
 
static void
core_init_cb (void *cls,
              const struct GNUNET_PeerIdentity *identity)
{
  struct Plugin *plugin = cls;
 
  if (NULL == identity)
    return;
 
  plugin->peerstore_notify = GNUNET_PEERSTORE_monitor_start (plugin->env->cfg,
                                                             GNUNET_YES,
                                                             "peerstore",
                                                             NULL,
                                                             GNUNET_PEERSTORE_HELLO_KEY,
                                                             &error_cb,
                                                             NULL,
                                                             &sync_cb,
                                                             NULL,
                                                             &peerinfo_cb,
                                                             plugin);
}
 
 
static int
check_core_message (void *cls,
                    const struct GNUNET_MessageHeader *msg)
{
  (void) cls;
  (void) msg;
  return GNUNET_OK;
}
 
 
static void
handle_core_message (void *cls,
                     const struct GNUNET_MessageHeader *msg)
{
  struct GNUNET_DHTU_Target *origin = cls;
  struct Plugin *plugin = origin->plugin;
 
  plugin->env->receive_cb (plugin->env->cls,
                           &origin->app_ctx,
                           &plugin->src.app_ctx,
                           &msg[1],
                           ntohs (msg->size) - sizeof (*msg));
}
 
 
static void
nse_cb (void *cls,
        struct GNUNET_TIME_Absolute timestamp,
        double logestimate,
        double std_dev)
{
  struct Plugin *plugin = cls;
 
  plugin->env->network_size_cb (plugin->env->cls,
                                timestamp,
                                logestimate,
                                std_dev);
}
 
 
void *
DHTU_gnunet_done (struct GNUNET_DHTU_PluginFunctions *api)
{
  struct Plugin *plugin = api->cls;
 
  if (NULL != plugin->nse)
    GNUNET_NSE_disconnect (plugin->nse);
  plugin->env->network_size_cb (plugin->env->cls,
                                GNUNET_TIME_UNIT_FOREVER_ABS,
                                0.0,
                                0.0);
  if (NULL != plugin->core)
    GNUNET_CORE_disconnect (plugin->core);
  if (NULL != plugin->transport)
    GNUNET_TRANSPORT_application_done (plugin->transport);
  if (NULL != plugin->peerstore_notify)
    GNUNET_PEERSTORE_monitor_stop (plugin->peerstore_notify);
  if (NULL != plugin->peerstore)
    GNUNET_PEERSTORE_disconnect (plugin->peerstore);
  // GPI_plugins_unload ();
  if (plugin->pils)
    GNUNET_PILS_disconnect (plugin->pils);
  GNUNET_free (plugin);
  GNUNET_free (api);
  return NULL;
}
 
 
struct GNUNET_DHTU_PluginFunctions *
DHTU_gnunet_init (struct GNUNET_DHTU_PluginEnvironment *env)
{
  struct GNUNET_DHTU_PluginFunctions *api;
  struct Plugin *plugin;
  struct GNUNET_MQ_MessageHandler handlers[] = {
    GNUNET_MQ_hd_var_size (core_message,
                           GNUNET_MESSAGE_TYPE_DHT_CORE,
                           struct GNUNET_MessageHeader,
                           NULL),
    GNUNET_MQ_handler_end ()
  };
  const struct GNUNET_CORE_ServiceInfo service_info = {
    .service = GNUNET_CORE_SERVICE_DHT,
    .version = { 1, 0 },
    .version_max = { 1, 0 },
    .version_min = { 1, 0 },
  };
 
  plugin = GNUNET_new (struct Plugin);
  plugin->pils = GNUNET_PILS_connect (
    env->cfg, NULL, NULL);
  plugin->env = env;
  api = GNUNET_new (struct GNUNET_DHTU_PluginFunctions);
  api->cls = plugin;
  api->try_connect = &gnunet_try_connect;
  api->hold = &gnunet_hold;
  api->drop = &gnunet_drop;
  api->send = &gnunet_send;
  plugin->peerstore = GNUNET_PEERSTORE_connect (env->cfg);
  plugin->transport = GNUNET_TRANSPORT_application_init (env->cfg);
  plugin->core = GNUNET_CORE_connect (env->cfg,
                                      plugin,
                                      &core_init_cb,
                                      &core_connect_cb,
                                      &core_disconnect_cb,
                                      handlers,
                                      &service_info);
  plugin->nse = GNUNET_NSE_connect (env->cfg,
                                    &nse_cb,
                                    plugin);
  if ( (NULL == plugin->transport) ||
       (NULL == plugin->core) ||
       (NULL == plugin->nse) )
  {
    GNUNET_break (0);
    DHTU_gnunet_done (api);
    return NULL;
  }
  // GPI_plugins_load (env->cfg);
  return api;
}