src/testbed/testbed_api_hosts.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008--2012 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 3, or (at your
   8       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       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file testbed/testbed_api_hosts.h
  23  * @brief internal API to access the 'hosts' subsystem
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef NEW_TESTING_API_HOSTS_H
  28 #define NEW_TESTING_API_HOSTS_H
  29
  30 #include "gnunet_testbed_service.h"
  31 #include "testbed_helper.h"
  32
  33
  34 /**
  35  * Lookup a host by ID.
  36  *
  37  * @param id global host ID assigned to the host; 0 is
  38  *        reserved to always mean 'localhost'
  39  * @return handle to the host, NULL on error
  40  */
  41 struct GNUNET_TESTBED_Host *
  42 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id);
  43
  44
  45 /**
  46  * Create a host by ID; given this host handle, we could not
  47  * run peers at the host, but we can talk about the host
  48  * internally.
  49  *
  50  * @param id global host ID assigned to the host; 0 is
  51  *        reserved to always mean 'localhost'
  52  * @return handle to the host, NULL on error
  53  */
  54 struct GNUNET_TESTBED_Host *
  55 GNUNET_TESTBED_host_create_by_id_ (uint32_t id);
  56
  57
  58 /**
  59  * Obtain a host's unique global ID.
  60  *
  61  * @param host handle to the host, NULL means 'localhost'
  62  * @return id global host ID assigned to the host (0 is
  63  *         'localhost', but then obviously not globally unique)
  64  */
  65 uint32_t
  66 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host);
  67
  68
  69 /**
  70  * Obtain the host's username
  71  *
  72  * @param host handle to the host, NULL means 'localhost'
  73  * @return username to login to the host
  74  */
  75 const char *
  76 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host);
  77
  78
  79 /**
  80  * Obtain the host's ssh port
  81  *
  82  * @param host handle to the host, NULL means 'localhost'
  83  * @return username to login to the host
  84  */
  85 uint16_t
  86 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host);
  87
  88
  89 /**
  90  * Marks a host as registered with a controller
  91  *
  92  * @param host the host to mark
  93  * @param controller the controller at which this host is registered
  94  */
  95 void
  96 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
  97                                          const struct GNUNET_TESTBED_Controller
  98                                          *controller);
  99
 100
 101 /**
 102  * Checks whether a host has been registered with the given controller
 103  *
 104  * @param host the host to check
 105  * @param controller the controller at which host's registration is checked
 106  * @return GNUNET_YES if registered; GNUNET_NO if not
 107  */
 108 int
 109 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
 110                                     const struct GNUNET_TESTBED_Controller
 111                                     *controller);
 112
 113
 114 /**
 115  * (re)sets the operation queue for parallel overlay connects
 116  *
 117  * @param h the host handle
 118  * @param npoc the number of parallel overlay connects - the queue size
 119  */
 120 void
 121 GNUNET_TESTBED_set_num_parallel_overlay_connects_ (struct
 122                                                    GNUNET_TESTBED_Host *h,
 123                                                    unsigned int npoc);
 124
 125
 126 /**
 127  * Releases a time slot thus making it available for be used again
 128  *
 129  * @param h the host handle
 130  * @param index the index of the the time slot
 131  * @param key the key to prove ownership of the timeslot
 132  * @return GNUNET_YES if the time slot is successfully removed; GNUNET_NO if the
 133  *           time slot cannot be removed - this could be because of the index
 134  *           greater than existing number of time slots or `key' being different
 135  */
 136 int
 137 GNUNET_TESTBED_release_time_slot_ (struct GNUNET_TESTBED_Host *h,
 138                                    unsigned int index, void *key);
 139
 140
 141 /**
 142  * Function to update a time slot
 143  *
 144  * @param h the host handle
 145  * @param index the index of the time slot to update
 146  * @param key the key to identify ownership of the slot
 147  * @param time the new time
 148  * @param failed should this reading be treated as coming from a fail event
 149  */
 150 void
 151 GNUNET_TESTBED_update_time_slot_ (struct GNUNET_TESTBED_Host *h,
 152                                   unsigned int index, void *key,
 153                                   struct GNUNET_TIME_Relative time, int failed);
 154
 155
 156 /**
 157  * Returns a timing slot which will be exclusively locked
 158  *
 159  * @param h the host handle
 160  * @param key a pointer which is associated to the returned slot; should not be
 161  *          NULL. It serves as a key to determine the correct owner of the slot
 162  * @return the time slot index in the array of time slots in the controller
 163  *           handle
 164  */
 165 unsigned int
 166 GNUNET_TESTBED_get_tslot_ (struct GNUNET_TESTBED_Host *h, void *key);
 167
 168
 169 /**
 170  * Queues the given operation in the queue for parallel overlay connects of the
 171  * given host
 172  *
 173  * @param h the host handle
 174  * @param op the operation to queue in the given host's parally overlay connect
 175  *          queue
 176  */
 177 void
 178 GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h,
 179                                struct GNUNET_TESTBED_Operation *op);
 180
 181 #endif
 182 /* end of testbed_api_hosts.h */