gnunet/src/ats/gnunet-service-ats_scheduling.c

/*
     This file is part of GNUnet.
     Copyright (C) 2011-2016 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
 */

/**
 * @file ats/gnunet-service-ats_scheduling.c
 * @brief ats service, interaction with 'scheduling' API
 * @author Matthias Wachs
 * @author Christian Grothoff
 */
#include "platform.h"
#include "gnunet-service-ats_addresses.h"
#include "gnunet-service-ats_scheduling.h"
#include "ats.h"

/**
 * Actual handle to the client.
 */
static struct GNUNET_SERVICE_Client *my_client;


/**
 * Register a new scheduling client.
 *
 * @param client handle of the new client
 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 */
int
GAS_scheduling_add_client (struct GNUNET_SERVICE_Client *client)
{
  if (NULL != my_client)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "This ATS already has a scheduling client, refusing new scheduling client for now.\n");
    return GNUNET_SYSERR;
  }
  my_client = client;
  return GNUNET_OK;
}


/**
 * Unregister a client (which may have been a scheduling client,
 * but this is not assured).
 *
 * @param client handle of the (now dead) client
 */
void
GAS_scheduling_remove_client (struct GNUNET_SERVICE_Client *client)
{
  if (my_client != client)
    return;
  GAS_addresses_destroy_all ();
  my_client = NULL;
}


/**
 * Transmit the given address suggestion and bandwidth update to all scheduling
 * clients.
 *
 * @param peer peer for which this is an address suggestion
 * @param session_id session ID to use for the given client
 * @param bandwidth_out assigned outbound bandwidth
 * @param bandwidth_in assigned inbound bandwidth
 */
void
GAS_scheduling_transmit_address_suggestion (const struct
                                            GNUNET_PeerIdentity *peer,
                                            uint32_t session_id,
                                            struct GNUNET_BANDWIDTH_Value32NBO
                                            bandwidth_out,
                                            struct GNUNET_BANDWIDTH_Value32NBO
                                            bandwidth_in)
{
  struct GNUNET_MQ_Envelope *env;
  struct AddressSuggestionMessage *msg;

  if (NULL == my_client)
    return;
  GNUNET_STATISTICS_update (GSA_stats,
                            "# address suggestions made",
                            1,
                            GNUNET_NO);
  env = GNUNET_MQ_msg (msg,
                       GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION);
  msg->peer = *peer;
  msg->session_id = htonl (session_id);
  msg->bandwidth_out = bandwidth_out;
  msg->bandwidth_in = bandwidth_in;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "ATS sends quota for peer `%s': (in/out) %u/%u\n",
              GNUNET_i2s (peer),
              (unsigned int) ntohl (bandwidth_in.value__),
              (unsigned int) ntohl (bandwidth_out.value__));
  GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (my_client),
                  env);
}


/**
 * Handle 'address add' messages from clients.
 *
 * @param m the request message
 */
void
GAS_handle_address_add (const struct AddressAddMessage *m)
{
  const char *address;
  const char *plugin_name;
  uint16_t address_length;
  uint16_t plugin_name_length;
  struct GNUNET_ATS_Properties prop;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Received `%s' message\n",
              "ADDRESS_ADD");
  address_length = ntohs (m->address_length);
  plugin_name_length = ntohs (m->plugin_name_length);
  address = (const char *) &m[1];
  if (plugin_name_length != 0)
    plugin_name = &address[address_length];
  else
    plugin_name = "";
  GNUNET_STATISTICS_update (GSA_stats,
                            "# addresses created",
                            1,
                            GNUNET_NO);
  GNUNET_ATS_properties_ntoh (&prop,
                              &m->properties);
  GNUNET_break (GNUNET_NT_UNSPECIFIED != prop.scope);
  GAS_addresses_add (&m->peer,
                     plugin_name,
                     address,
                     address_length,
                     ntohl (m->address_local_info),
                     ntohl (m->session_id),
                     &prop);
}


/**
 * Handle 'address update' messages from clients.
 *
 * @param m the request message
 */
void
GAS_handle_address_update (const struct AddressUpdateMessage *m)
{
  struct GNUNET_ATS_Properties prop;

  GNUNET_STATISTICS_update (GSA_stats,
                            "# address updates received",
                            1,
                            GNUNET_NO);
  GNUNET_ATS_properties_ntoh (&prop,
                              &m->properties);
  GAS_addresses_update (&m->peer,
                        ntohl (m->session_id),
                        &prop);
}


/**
 * Handle 'address destroyed' messages from clients.
 *
 * @param m the request message
 */
void
GAS_handle_address_destroyed (const struct AddressDestroyedMessage *m)
{
  struct GNUNET_MQ_Envelope *env;
  struct GNUNET_ATS_SessionReleaseMessage *srm;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Received `%s' message\n",
              "ADDRESS_DESTROYED");
  GNUNET_STATISTICS_update (GSA_stats,
                            "# addresses destroyed",
                            1,
                            GNUNET_NO);
  GAS_addresses_destroy (&m->peer,
                         ntohl (m->session_id));
  env = GNUNET_MQ_msg (srm,
                       GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE);
  srm->session_id = m->session_id;
  srm->peer = m->peer;
  GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (my_client),
                  env);
}


/* end of gnunet-service-ats_scheduling.c */