1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/*
This file is part of GNUnet
Copyright (C) 2008--2013 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 testbed/testbed_api_hosts.h
* @brief internal API to access the 'hosts' subsystem
* @author Christian Grothoff
*/
#ifndef TESTBED_API_HOSTS_H
#define TESTBED_API_HOSTS_H
// #include "gnunet_testbed_service.h"
// #include "testbed_helper.h"
#include "testbed.h"
/**
* handle for host registration
*/
struct GNUNET_TESTBED_HostRegistrationHandle
{
/**
* The host being registered
*/
struct GNUNET_TESTBED_Host *host;
/**
* The controller at which this host is being registered
*/
struct GNUNET_TESTBED_Controller *c;
/**
* The Registartion completion callback
*/
GNUNET_TESTBED_HostRegistrationCompletion cc;
/**
* The closure for above callback
*/
void *cc_cls;
};
/**
* Lookup a host by ID.
*
* @param id global host ID assigned to the host; 0 is
* reserved to always mean 'localhost'
* @return handle to the host, NULL on error
*/
struct GNUNET_TESTBED_Host *
GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id);
/**
* 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.
*
* @param id global host ID assigned to the host; 0 is
* reserved to always mean 'localhost'
* @param 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
* @return handle to the host, NULL on error
*/
struct GNUNET_TESTBED_Host *
GNUNET_TESTBED_host_create_by_id_ (uint32_t id,
const struct GNUNET_CONFIGURATION_Handle
*cfg);
/**
* Obtain a host's unique global ID.
*
* @param host handle to the host, NULL means 'localhost'
* @return id global host ID assigned to the host (0 is
* 'localhost', but then obviously not globally unique)
*/
uint32_t
GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host);
/**
* Obtain the host's username
*
* @param host handle to the host, NULL means 'localhost'
* @return username to login to the host
*/
const char *
GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host);
/**
* Obtain the host's ssh port
*
* @param host handle to the host, NULL means 'localhost'
* @return username to login to the host
*/
uint16_t
GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host);
/**
* Obtain the host's configuration template
*
* @param host handle to the host
* @return the host's configuration template
*/
const struct GNUNET_CONFIGURATION_Handle *
GNUNET_TESTBED_host_get_cfg_ (const struct GNUNET_TESTBED_Host *host);
/**
* Function to replace host's configuration
*
* @param host the host handle
* @param new_cfg the new configuration to replace the old one
*/
void
GNUNET_TESTBED_host_replace_cfg_ (struct GNUNET_TESTBED_Host *host,
const struct
GNUNET_CONFIGURATION_Handle *new_cfg);
/**
* Marks a host as registered with a controller
*
* @param host the host to mark
* @param controller the controller at which this host is registered
*/
void
GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
const struct GNUNET_TESTBED_Controller
*controller);
/**
* Unmarks a host registered at a controller
*
* @param host the host to unmark
* @param controller the controller at which this host has to be unmarked
*/
void
GNUNET_TESTBED_deregister_host_at_ (struct GNUNET_TESTBED_Host *host,
const struct GNUNET_TESTBED_Controller
*const controller);
/**
* Checks whether a host has been registered with the given controller
*
* @param host the host to check
* @param controller the controller at which host's registration is checked
* @return GNUNET_YES if registered; GNUNET_NO if not
*/
int
GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
const struct GNUNET_TESTBED_Controller
*controller);
/**
* Queues the given operation in the queue for parallel overlay connects of the
* given host
*
* @param h the host handle
* @param op the operation to queue in the given host's parally overlay connect
* queue
*/
void
GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h,
struct GNUNET_TESTBED_Operation *op);
/**
* Sends termination signal to the controller's helper process
*
* @param cproc the handle to the controller's helper process
*/
void
GNUNET_TESTBED_controller_kill_ (struct GNUNET_TESTBED_ControllerProc *cproc);
/**
* Cleans-up the controller's helper process handle
*
* @param cproc the handle to the controller's helper process
*/
void
GNUNET_TESTBED_controller_destroy_ (struct GNUNET_TESTBED_ControllerProc
*cproc);
/**
* Resolves the hostname of the host to an ip address
*
* @param host the host whose hostname is to be resolved
*/
void
GNUNET_TESTBED_host_resolve_ (struct GNUNET_TESTBED_Host *host);
#endif
/* end of testbed_api_hosts.h */
|
