testbed_api_hosts.h File Reference

internal API to access the 'hosts' subsystem More...

#include "testbed.h"

Include dependency graph for testbed_api_hosts.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_TESTBED_HostRegistrationHandle
	handle for host registration More...

Functions
struct GNUNET_TESTBED_Host *	GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id)
	Lookup a host by ID. More...
struct GNUNET_TESTBED_Host *	GNUNET_TESTBED_host_create_by_id_ (uint32_t id, const struct GNUNET_CONFIGURATION_Handle *cfg)
	Create a host by ID; given this host handle, we could not run peers at the host, but we can talk about the host internally. More...
uint32_t	GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host)
	Obtain a host's unique global ID. More...
const char *	GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host)
	Obtain the host's username. More...
uint16_t	GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host)
	Obtain the host's ssh port. More...
const struct GNUNET_CONFIGURATION_Handle *	GNUNET_TESTBED_host_get_cfg_ (const struct GNUNET_TESTBED_Host *host)
	Obtain the host's configuration template. More...
void	GNUNET_TESTBED_host_replace_cfg_ (struct GNUNET_TESTBED_Host *host, const struct GNUNET_CONFIGURATION_Handle *new_cfg)
	Function to replace host's configuration. More...
void	GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host, const struct GNUNET_TESTBED_Controller *controller)
	Marks a host as registered with a controller. More...
void	GNUNET_TESTBED_deregister_host_at_ (struct GNUNET_TESTBED_Host *host, const struct GNUNET_TESTBED_Controller *const controller)
	Unmarks a host registered at a controller. More...
int	GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host, const struct GNUNET_TESTBED_Controller *controller)
	Checks whether a host has been registered with the given controller. More...
void	GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h, struct GNUNET_TESTBED_Operation *op)
	Queues the given operation in the queue for parallel overlay connects of the given host. More...
void	GNUNET_TESTBED_controller_kill_ (struct GNUNET_TESTBED_ControllerProc *cproc)
	Sends termination signal to the controller's helper process. More...
void	GNUNET_TESTBED_controller_destroy_ (struct GNUNET_TESTBED_ControllerProc *cproc)
	Cleans-up the controller's helper process handle. More...
void	GNUNET_TESTBED_host_resolve_ (struct GNUNET_TESTBED_Host *host)
	Resolves the hostname of the host to an ip address. More...
void	GNUNET_TESTBED_extract_cfg (struct GNUNET_TESTBED_Host *host, const struct GNUNET_MessageHeader *message)

Detailed Description

internal API to access the 'hosts' subsystem

Author

Christian Grothoff

Definition in file testbed_api_hosts.h.

Function Documentation

GNUNET_TESTBED_host_lookup_by_id_()

struct GNUNET_TESTBED_Host* GNUNET_TESTBED_host_lookup_by_id_

(

uint32_t

id

)

Lookup a host by ID.

Parameters

id	global host ID assigned to the host; 0 is reserved to always mean 'localhost'

Returns

handle to the host, NULL on error

Parameters

id	global host ID assigned to the host; 0 is reserved to always mean 'localhost'

Returns

handle to the host, NULL if host not found

Definition at line 189 of file testbed_api_hosts.c.

{
  if (host_list_size <= id)
    return NULL;
  return host_list[id];
}

References host_list, host_list_size, and id.

Referenced by handle_link_controllers_result().

Here is the caller graph for this function:

GNUNET_TESTBED_host_create_by_id_()

struct GNUNET_TESTBED_Host* GNUNET_TESTBED_host_create_by_id_	(	uint32_t	id,
		const struct GNUNET_CONFIGURATION_Handle *	cfg
	)

Create a host by ID; given this host handle, we could not run peers at the host, but we can talk about the host internally.

Parameters

id	global host ID assigned to the host; 0 is reserved to always mean 'localhost'
cfg	the configuration to use as a template while starting a controller on this host. Operation queue sizes specific to a host are also read from this configuration handle

Returns

handle to the host, NULL on error

Definition at line 210 of file testbed_api_hosts.c.

{
  return GNUNET_TESTBED_host_create_with_id (id, NULL, NULL, cfg, 0);
}

References cfg, and GNUNET_TESTBED_host_create_with_id().

Here is the call graph for this function:

GNUNET_TESTBED_host_get_id_()

uint32_t GNUNET_TESTBED_host_get_id_

(

const struct GNUNET_TESTBED_Host *

host

)

Obtain a host's unique global ID.

Parameters

host	handle to the host, NULL means 'localhost'

Returns

id global host ID assigned to the host (0 is 'localhost', but then obviously not globally unique)

Definition at line 219 of file testbed_api_hosts.c.

{
  return host->id;
}

References GNUNET_TESTBED_Host::id.

Referenced by GNUNET_TESTBED_controller_connect(), GNUNET_TESTBED_controller_link(), GNUNET_TESTBED_controller_start(), GNUNET_TESTBED_get_next_op_id(), GNUNET_TESTBED_get_slave_config(), GNUNET_TESTBED_hosts_load_from_file(), GNUNET_TESTBED_register_host(), GST_create_neighbour(), GST_queue_host_registration(), handle_add_host_confirm(), host_list_add(), hr_completion(), opstart_overlay_connect(), opstart_peer_create(), and register_next_host().

Here is the caller graph for this function:

GNUNET_TESTBED_host_get_username_()

const char* GNUNET_TESTBED_host_get_username_

(

const struct GNUNET_TESTBED_Host *

host

)

Obtain the host's username.

Parameters

host	handle to the host, NULL means 'localhost'

Returns

username to login to the host

Definition at line 245 of file testbed_api_hosts.c.

{
  return host->username;
}

References GNUNET_TESTBED_Host::username.

Referenced by GNUNET_TESTBED_register_host().

Here is the caller graph for this function:

GNUNET_TESTBED_host_get_ssh_port_()

uint16_t GNUNET_TESTBED_host_get_ssh_port_

(

const struct GNUNET_TESTBED_Host *

host

)

Obtain the host's ssh port.

Parameters

host	handle to the host, NULL means 'localhost'

Returns

username to login to the host

Definition at line 258 of file testbed_api_hosts.c.

{
  return host->port;
}

References GNUNET_TESTBED_Host::port.

Referenced by GNUNET_TESTBED_register_host().

Here is the caller graph for this function:

GNUNET_TESTBED_host_get_cfg_()

const struct GNUNET_CONFIGURATION_Handle* GNUNET_TESTBED_host_get_cfg_

(

const struct GNUNET_TESTBED_Host *

host

)

Obtain the host's configuration template.

Parameters

host	handle to the host

Returns

the host's configuration template

Definition at line 284 of file testbed_api_hosts.c.

{
  return host->cfg;
}

References GNUNET_TESTBED_Host::cfg.

Referenced by GNUNET_TESTBED_controller_connect(), GNUNET_TESTBED_controller_start(), handle_slave_get_config(), and slave_event_cb().

Here is the caller graph for this function:

GNUNET_TESTBED_host_replace_cfg_()

void GNUNET_TESTBED_host_replace_cfg_	(	struct GNUNET_TESTBED_Host *	host,
		const struct GNUNET_CONFIGURATION_Handle *	new_cfg
	)

Function to replace host's configuration.

Parameters

host	the host handle
new_cfg	the new configuration to replace the old one

Definition at line 297 of file testbed_api_hosts.c.

{
  GNUNET_CONFIGURATION_destroy (host->cfg);
  host->cfg = GNUNET_CONFIGURATION_dup (new_cfg);
}

References GNUNET_TESTBED_Host::cfg, GNUNET_CONFIGURATION_destroy(), and GNUNET_CONFIGURATION_dup().

Referenced by handle_link_controllers_result().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTBED_mark_host_registered_at_()

void GNUNET_TESTBED_mark_host_registered_at_	(	struct GNUNET_TESTBED_Host *	host,
		const struct GNUNET_TESTBED_Controller *const	controller
	)

Marks a host as registered with a controller.

Parameters

host	the host to mark
controller	the controller at which this host is registered

Definition at line 605 of file testbed_api_hosts.c.

{
  struct RegisteredController *rc;
 
  for (rc = host->rc_head; NULL != rc; rc = rc->next)
  {
    if (controller == rc->controller)   /* already registered at controller */
    {
      GNUNET_break (0);
      return;
    }
  }
  rc = GNUNET_new (struct RegisteredController);
  rc->controller = controller;
  GNUNET_CONTAINER_DLL_insert_tail (host->rc_head, host->rc_tail, rc);
}

References RegisteredController::controller, GNUNET_break, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_new, RegisteredController::next, GNUNET_TESTBED_Host::rc_head, and GNUNET_TESTBED_Host::rc_tail.

Referenced by GNUNET_TESTBED_controller_connect(), and handle_add_host_confirm().

Here is the caller graph for this function:

GNUNET_TESTBED_deregister_host_at_()

void GNUNET_TESTBED_deregister_host_at_	(	struct GNUNET_TESTBED_Host *	host,
		const struct GNUNET_TESTBED_Controller *const	controller
	)

Unmarks a host registered at a controller.

Parameters

host	the host to unmark
controller	the controller at which this host has to be unmarked

Definition at line 632 of file testbed_api_hosts.c.

{
  struct RegisteredController *rc;
 
  for (rc = host->rc_head; NULL != rc; rc = rc->next)
    if (controller == rc->controller)
      break;
  if (NULL == rc)
  {
    GNUNET_break (0);
    return;
  }
  GNUNET_CONTAINER_DLL_remove (host->rc_head, host->rc_tail, rc);
  GNUNET_free (rc);
}

References RegisteredController::controller, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, RegisteredController::next, GNUNET_TESTBED_Host::rc_head, and GNUNET_TESTBED_Host::rc_tail.

Referenced by GNUNET_TESTBED_controller_disconnect().

Here is the caller graph for this function:

GNUNET_TESTBED_is_host_registered_()

int GNUNET_TESTBED_is_host_registered_	(	const struct GNUNET_TESTBED_Host *	host,
		const struct GNUNET_TESTBED_Controller *const	controller
	)

Checks whether a host has been registered with the given controller.

Parameters

host	the host to check
controller	the controller at which host's registration is checked

Returns

GNUNET_YES if registered; GNUNET_NO if not

Checks whether a host has been registered with the given controller.

Parameters

host	the host to check
controller	the controller at which host's registration is checked

Returns

GNUNET_YES if registered; GNUNET_NO if not

Definition at line 659 of file testbed_api_hosts.c.

{
  struct RegisteredController *rc;
 
  for (rc = host->rc_head; NULL != rc; rc = rc->next)
  {
    if (controller == rc->controller)   /* already registered at controller */
    {
      return GNUNET_YES;
    }
  }
  return GNUNET_NO;
}

References RegisteredController::controller, GNUNET_NO, GNUNET_YES, RegisteredController::next, and GNUNET_TESTBED_Host::rc_head.

Referenced by GNUNET_TESTBED_controller_link(), GNUNET_TESTBED_get_slave_config(), GNUNET_TESTBED_register_host(), and lcf_proc_task().

Here is the caller graph for this function:

GNUNET_TESTBED_host_queue_oc_()

void GNUNET_TESTBED_host_queue_oc_	(	struct GNUNET_TESTBED_Host *	h,
		struct GNUNET_TESTBED_Operation *	op
	)

Queues the given operation in the queue for parallel overlay connects of the given host.

Parameters

h	the host handle
op	the operation to queue in the given host's parally overlay connect queue

Definition at line 1489 of file testbed_api_hosts.c.

{
  GNUNET_TESTBED_operation_queue_insert_ (
    h->opq_parallel_overlay_connect_operations,
    op);
}

References GNUNET_TESTBED_operation_queue_insert_(), h, and op.

Referenced by GNUNET_TESTBED_overlay_connect().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTBED_controller_kill_()

void GNUNET_TESTBED_controller_kill_

(

struct GNUNET_TESTBED_ControllerProc *

cproc

)

Sends termination signal to the controller's helper process.

Parameters

cproc

the handle to the controller's helper process

Definition at line 1147 of file testbed_api_hosts.c.

{
  if (NULL != cproc->shandle)
    GNUNET_HELPER_send_cancel (cproc->shandle);
  if (NULL != cproc->helper)
    GNUNET_HELPER_kill (cproc->helper, GNUNET_YES);
}

References GNUNET_HELPER_kill(), GNUNET_HELPER_send_cancel(), GNUNET_YES, GNUNET_TESTBED_ControllerProc::helper, and GNUNET_TESTBED_ControllerProc::shandle.

Referenced by GNUNET_TESTBED_controller_stop(), and kill_slave().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTBED_controller_destroy_()

void GNUNET_TESTBED_controller_destroy_

(

struct GNUNET_TESTBED_ControllerProc *

cproc

)

Cleans-up the controller's helper process handle.

Parameters

cproc

the handle to the controller's helper process

Definition at line 1162 of file testbed_api_hosts.c.

{
  if (NULL != cproc->helper)
  {
    GNUNET_break (GNUNET_OK == GNUNET_HELPER_wait (cproc->helper));
    GNUNET_HELPER_destroy (cproc->helper);
  }
  if (NULL != cproc->helper_argv)
    free_argv (cproc->helper_argv);
  cproc->host->controller_started = GNUNET_NO;
  cproc->host->locked = GNUNET_NO;
  GNUNET_free (cproc->msg);
  GNUNET_free (cproc);
}

References GNUNET_TESTBED_Host::controller_started, free_argv(), GNUNET_break, GNUNET_free, GNUNET_HELPER_destroy(), GNUNET_HELPER_wait(), GNUNET_NO, GNUNET_OK, GNUNET_TESTBED_ControllerProc::helper, GNUNET_TESTBED_ControllerProc::helper_argv, GNUNET_TESTBED_ControllerProc::host, GNUNET_TESTBED_Host::locked, and GNUNET_TESTBED_ControllerProc::msg.

Referenced by destroy_slave(), and GNUNET_TESTBED_controller_stop().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTBED_host_resolve_()

void GNUNET_TESTBED_host_resolve_

(

struct GNUNET_TESTBED_Host *

host

)

Resolves the hostname of the host to an ip address.

Parameters

host	the host whose hostname is to be resolved

Definition at line 1504 of file testbed_api_hosts.c.

{
  char *hostname;
 
  hostname = (char *) host->hostname;
  host->hostname = simple_resolve (hostname);
  if (NULL == host->hostname)
  {
    GNUNET_break (0);
    host->hostname = hostname;
    return;
  }
  GNUNET_free (hostname);
  host->hostname = GNUNET_strdup (host->hostname);
}

References GNUNET_break, GNUNET_free, GNUNET_strdup, hostname, GNUNET_TESTBED_Host::hostname, and simple_resolve().

Referenced by host_habitable_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTBED_extract_cfg()

void GNUNET_TESTBED_extract_cfg	(	struct GNUNET_TESTBED_Host *	host,
		const struct GNUNET_MessageHeader *	message
	)