GNUnet 0.21.1
gnunet-service-regex.c File Reference

service to advertise capabilities described as regex and to lookup capabilities by regex More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "regex_internal_lib.h"
#include "regex_ipc.h"
Include dependency graph for gnunet-service-regex.c:

Go to the source code of this file.

Data Structures

struct  ClientEntry
 Information about one of our clients. More...
 

Functions

static void cleanup_task (void *cls)
 Task run during shutdown. More...
 
static void reannounce (void *cls)
 Periodic task to refresh our announcement of the regex. More...
 
static int check_announce (void *cls, const struct AnnounceMessage *am)
 Check ANNOUNCE message. More...
 
static void handle_announce (void *cls, const struct AnnounceMessage *am)
 Handle ANNOUNCE message. More...
 
static void handle_search_result (void *cls, const struct GNUNET_PeerIdentity *id, const struct GNUNET_DHT_PathElement *get_path, unsigned int get_path_length, const struct GNUNET_DHT_PathElement *put_path, unsigned int put_path_length)
 Handle result, pass it back to the client. More...
 
static int check_search (void *cls, const struct RegexSearchMessage *sm)
 Check SEARCH message. More...
 
static void handle_search (void *cls, const struct RegexSearchMessage *sm)
 Handle SEARCH message. More...
 
static void run (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg, struct GNUNET_SERVICE_Handle *service)
 Process regex requests. More...
 
static void * client_connect_cb (void *cls, struct GNUNET_SERVICE_Client *c, struct GNUNET_MQ_Handle *mq)
 Callback called when a client connects to the service. More...
 
static void client_disconnect_cb (void *cls, struct GNUNET_SERVICE_Client *c, void *internal_cls)
 Callback called when a client disconnected from the service. More...
 
 GNUNET_SERVICE_MAIN ("regex", GNUNET_SERVICE_OPTION_NONE, &run, &client_connect_cb, &client_disconnect_cb, NULL, GNUNET_MQ_hd_var_size(announce, GNUNET_MESSAGE_TYPE_REGEX_ANNOUNCE, struct AnnounceMessage, NULL), GNUNET_MQ_hd_var_size(search, GNUNET_MESSAGE_TYPE_REGEX_SEARCH, struct RegexSearchMessage, NULL), GNUNET_MQ_handler_end())
 Define "main" method using service macro. More...
 

Variables

static struct GNUNET_DHT_Handledht
 Connection to the DHT. More...
 
static struct GNUNET_STATISTICS_Handlestats
 Handle for doing statistics. More...
 
static struct GNUNET_CRYPTO_EddsaPrivateKeymy_private_key
 Private key for this peer. More...
 

Detailed Description

service to advertise capabilities described as regex and to lookup capabilities by regex

Author
Christian Grothoff

Definition in file gnunet-service-regex.c.

Function Documentation

◆ cleanup_task()

static void cleanup_task ( void *  cls)
static

Task run during shutdown.

Parameters
clsunused

Definition at line 92 of file gnunet-service-regex.c.

93{
95 dht = NULL;
97 GNUNET_NO);
98 stats = NULL;
100 my_private_key = NULL;
101}
static struct GNUNET_DHT_Handle * dht
Connection to the DHT.
static struct GNUNET_STATISTICS_Handle * stats
Handle for doing statistics.
static struct GNUNET_CRYPTO_EddsaPrivateKey * my_private_key
Private key for this peer.
void GNUNET_DHT_disconnect(struct GNUNET_DHT_Handle *handle)
Shutdown connection with the DHT service.
Definition: dht_api.c:1060
@ GNUNET_NO
#define GNUNET_free(ptr)
Wrapper around free.
void GNUNET_STATISTICS_destroy(struct GNUNET_STATISTICS_Handle *h, int sync_first)
Destroy a handle (free all state associated with it).

References dht, GNUNET_DHT_disconnect(), GNUNET_free, GNUNET_NO, GNUNET_STATISTICS_destroy(), my_private_key, and stats.

Referenced by run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reannounce()

static void reannounce ( void *  cls)
static

Periodic task to refresh our announcement of the regex.

Parameters
clsthe struct ClientEntry * of the client that triggered the announcement

Definition at line 111 of file gnunet-service-regex.c.

112{
113 struct ClientEntry *ce = cls;
114
117 &reannounce,
118 ce);
119}
static void reannounce(void *cls)
Periodic task to refresh our announcement of the regex.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1278
void REGEX_INTERNAL_reannounce(struct REGEX_INTERNAL_Announcement *h)
Announce again a regular expression previously announced.
Information about one of our clients.
struct REGEX_INTERNAL_Announcement * ah
Announcement handle (if this client is announcing).
struct GNUNET_TIME_Relative frequency
Refresh frequency for announcements.
struct GNUNET_SCHEDULER_Task * refresh_task
Task for re-announcing.

References ClientEntry::ah, ClientEntry::frequency, GNUNET_SCHEDULER_add_delayed(), reannounce(), ClientEntry::refresh_task, and REGEX_INTERNAL_reannounce().

Referenced by handle_announce(), and reannounce().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_announce()

static int check_announce ( void *  cls,
const struct AnnounceMessage am 
)
static

Check ANNOUNCE message.

Parameters
clsidentification of the client
amthe actual message
Returns
GNUNET_OK if am is well-formed

Definition at line 130 of file gnunet-service-regex.c.

132{
133 struct ClientEntry *ce = cls;
134
136 if (NULL != ce->ah)
137 {
138 /* only one announcement per client allowed */
139 GNUNET_break (0);
140 return GNUNET_SYSERR;
141 }
142 return GNUNET_OK;
143}
@ GNUNET_OK
@ GNUNET_SYSERR
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#define GNUNET_MQ_check_zero_termination(m)
Insert code for a "check_" function that verifies that a given variable-length message received over ...

References ClientEntry::ah, GNUNET_break, GNUNET_MQ_check_zero_termination, GNUNET_OK, and GNUNET_SYSERR.

◆ handle_announce()

static void handle_announce ( void *  cls,
const struct AnnounceMessage am 
)
static

Handle ANNOUNCE message.

Parameters
clsidentification of the client
amthe actual message

Definition at line 153 of file gnunet-service-regex.c.

155{
156 struct ClientEntry *ce = cls;
157 const char *regex;
158
159 regex = (const char *) &am[1];
162 &reannounce,
163 ce);
165 "Starting to announce regex `%s' every %s\n",
166 regex,
168 GNUNET_NO));
171 regex,
172 ntohs (am->compression),
173 stats);
174 if (NULL == ce->ah)
175 {
176 GNUNET_break (0);
178 ce->refresh_task = NULL;
180 return;
181 }
183}
#define GNUNET_log(kind,...)
@ GNUNET_ERROR_TYPE_DEBUG
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:981
void GNUNET_SERVICE_client_drop(struct GNUNET_SERVICE_Client *c)
Ask the server to disconnect from the given client.
Definition: service.c:2484
void GNUNET_SERVICE_client_continue(struct GNUNET_SERVICE_Client *c)
Continue receiving further messages from the given client.
Definition: service.c:2455
struct GNUNET_TIME_Relative GNUNET_TIME_relative_ntoh(struct GNUNET_TIME_RelativeNBO a)
Convert relative time from network byte order.
Definition: time.c:628
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:570
struct REGEX_INTERNAL_Announcement * REGEX_INTERNAL_announce(struct GNUNET_DHT_Handle *dht, const struct GNUNET_CRYPTO_EddsaPrivateKey *priv, const char *regex, uint16_t compression, struct GNUNET_STATISTICS_Handle *stats)
Announce a regular expression: put all states of the automaton in the DHT.
struct GNUNET_TIME_RelativeNBO refresh_delay
Delay between repeated announcements.
Definition: regex_ipc.h:54
uint16_t compression
How many characters can we squeeze per edge?
Definition: regex_ipc.h:44
struct GNUNET_SERVICE_Client * client
Handle identifying the client.

References ClientEntry::ah, ClientEntry::client, AnnounceMessage::compression, dht, ClientEntry::frequency, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_NO, GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_cancel(), GNUNET_SERVICE_client_continue(), GNUNET_SERVICE_client_drop(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_relative_ntoh(), my_private_key, reannounce(), AnnounceMessage::refresh_delay, ClientEntry::refresh_task, REGEX_INTERNAL_announce(), and stats.

Here is the call graph for this function:

◆ handle_search_result()

static void handle_search_result ( void *  cls,
const struct GNUNET_PeerIdentity id,
const struct GNUNET_DHT_PathElement get_path,
unsigned int  get_path_length,
const struct GNUNET_DHT_PathElement put_path,
unsigned int  put_path_length 
)
static

Handle result, pass it back to the client.

Parameters
clsthe struct ClientEntry of the client searching
idPeer providing a regex that matches the string.
get_pathPath of the get request.
get_path_lengthLength of get_path.
put_pathPath of the put request.
put_path_lengthLength of the put_path.

Definition at line 197 of file gnunet-service-regex.c.

203{
204 struct ClientEntry *ce = cls;
205 struct GNUNET_MQ_Envelope *env;
206 struct ResultMessage *result;
207 struct GNUNET_PeerIdentity *gp;
208 uint16_t size;
209
210 if ((get_path_length >= 65536) ||
211 (put_path_length >= 65536) ||
212 ( ((get_path_length + put_path_length)
213 * sizeof(struct GNUNET_PeerIdentity))
214 + sizeof(struct ResultMessage) >= GNUNET_MAX_MESSAGE_SIZE) )
215 {
216 GNUNET_break (0);
217 return;
218 }
219 size = (get_path_length + put_path_length)
220 * sizeof(struct GNUNET_PeerIdentity);
222 size,
224 result->get_path_length = htons ((uint16_t) get_path_length);
225 result->put_path_length = htons ((uint16_t) put_path_length);
226 result->id = *id;
227 gp = &result->id;
228 for (unsigned int i = 0; i<get_path_length; i++)
229 gp[i + 1] = get_path[i].pred;
230 for (unsigned int i = 0; i<put_path_length; i++)
231 gp[i + get_path_length + 1] = put_path[i].pred;
232 GNUNET_MQ_send (ce->mq,
233 env);
234}
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static struct GNUNET_IDENTITY_Handle * id
Handle to IDENTITY.
static int result
Global testing status.
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message,...
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:304
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct.
Definition: gnunet_mq_lib.h:63
#define GNUNET_MESSAGE_TYPE_REGEX_RESULT
Result in response to regex search.
static unsigned int size
Size of the "table".
Definition: peer.c:68
struct GNUNET_MQ_Handle * mq
Queue for transmissions to client.
The identity of the host (wraps the signing key of the peer).
Result from regex search.
Definition: regex_ipc.h:78

References env, GNUNET_break, GNUNET_MAX_MESSAGE_SIZE, GNUNET_MESSAGE_TYPE_REGEX_RESULT, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), id, ClientEntry::mq, result, and size.

Referenced by handle_search().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_search()

static int check_search ( void *  cls,
const struct RegexSearchMessage sm 
)
static

Check SEARCH message.

Parameters
clsidentification of the client
smthe actual message

Definition at line 244 of file gnunet-service-regex.c.

246{
247 struct ClientEntry *ce = cls;
248 const char *string;
249 uint16_t size;
250
251 size = ntohs (sm->header.size) - sizeof(*sm);
252 string = (const char *) &sm[1];
253 if ('\0' != string[size - 1])
254 {
255 GNUNET_break (0);
256 return GNUNET_SYSERR;
257 }
258 if (NULL != ce->sh)
259 {
260 /* only one search allowed per client */
261 GNUNET_break (0);
262 return GNUNET_SYSERR;
263 }
264 return GNUNET_OK;
265}
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.
struct REGEX_INTERNAL_Search * sh
Search handle (if this client is searching).
struct GNUNET_MessageHeader header
Type is GNUNET_MESSAGE_TYPE_REGEX_SEARCH.
Definition: regex_ipc.h:68

References GNUNET_break, GNUNET_OK, GNUNET_SYSERR, RegexSearchMessage::header, ClientEntry::sh, GNUNET_MessageHeader::size, and size.

◆ handle_search()

static void handle_search ( void *  cls,
const struct RegexSearchMessage sm 
)
static

Handle SEARCH message.

Parameters
clsidentification of the client
smthe actual message

Definition at line 275 of file gnunet-service-regex.c.

277{
278 struct ClientEntry *ce = cls;
279 const char *string;
280
281 string = (const char *) &sm[1];
283 "Starting to search for `%s'\n",
284 string);
286 string,
288 ce,
289 stats);
290 if (NULL == ce->sh)
291 {
292 GNUNET_break (0);
294 return;
295 }
297}
static void handle_search_result(void *cls, const struct GNUNET_PeerIdentity *id, const struct GNUNET_DHT_PathElement *get_path, unsigned int get_path_length, const struct GNUNET_DHT_PathElement *put_path, unsigned int put_path_length)
Handle result, pass it back to the client.
struct REGEX_INTERNAL_Search * REGEX_INTERNAL_search(struct GNUNET_DHT_Handle *dht, const char *string, REGEX_INTERNAL_Found callback, void *callback_cls, struct GNUNET_STATISTICS_Handle *stats)
Search for a peer offering a regex matching certain string in the DHT.

References ClientEntry::client, dht, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_SERVICE_client_continue(), GNUNET_SERVICE_client_drop(), handle_search_result(), REGEX_INTERNAL_search(), ClientEntry::sh, and stats.

Here is the call graph for this function:

◆ run()

static void run ( void *  cls,
const struct GNUNET_CONFIGURATION_Handle cfg,
struct GNUNET_SERVICE_Handle service 
)
static

Process regex requests.

Parameters
clsclosure
cfgconfiguration to use
servicethe initialized service

Definition at line 308 of file gnunet-service-regex.c.

311{
313 if (NULL == my_private_key)
314 {
316 return;
317 }
318 dht = GNUNET_DHT_connect (cfg, 1024);
319 if (NULL == dht)
320 {
322 my_private_key = NULL;
324 return;
325 }
327 NULL);
329}
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:109
static void cleanup_task(void *cls)
Task run during shutdown.
struct GNUNET_CRYPTO_EddsaPrivateKey * GNUNET_CRYPTO_eddsa_key_create_from_configuration(const struct GNUNET_CONFIGURATION_Handle *cfg)
Create a new private key by reading our peer's key from the file specified in the configuration.
struct GNUNET_DHT_Handle * GNUNET_DHT_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned int ht_len)
Initialize the connection with the DHT service.
Definition: dht_api.c:1037
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:567
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received,...
Definition: scheduler.c:1340
struct GNUNET_STATISTICS_Handle * GNUNET_STATISTICS_create(const char *subsystem, const struct GNUNET_CONFIGURATION_Handle *cfg)
Get handle for the statistics service.

References cfg, cleanup_task(), dht, GNUNET_CRYPTO_eddsa_key_create_from_configuration(), GNUNET_DHT_connect(), GNUNET_free, GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_shutdown(), GNUNET_STATISTICS_create(), my_private_key, and stats.

Here is the call graph for this function:

◆ client_connect_cb()

static void * client_connect_cb ( void *  cls,
struct GNUNET_SERVICE_Client c,
struct GNUNET_MQ_Handle mq 
)
static

Callback called when a client connects to the service.

Parameters
clsclosure for the service
cthe new client that connected to the service
mqthe message queue used to send messages to the client
Returns
c

Definition at line 341 of file gnunet-service-regex.c.

344{
345 struct ClientEntry *ce;
346
347 ce = GNUNET_new (struct ClientEntry);
348 ce->client = c;
349 ce->mq = mq;
350 return ce;
351}
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
#define GNUNET_new(type)
Allocate a struct or union of the given type.

References ClientEntry::client, GNUNET_new, mq, and ClientEntry::mq.

◆ client_disconnect_cb()

static void client_disconnect_cb ( void *  cls,
struct GNUNET_SERVICE_Client c,
void *  internal_cls 
)
static

Callback called when a client disconnected from the service.

Parameters
clsclosure for the service
cthe client that disconnected
internal_clsshould be equal to c

Definition at line 362 of file gnunet-service-regex.c.

365{
366 struct ClientEntry *ce = internal_cls;
367
368 if (NULL != ce->refresh_task)
369 {
371 ce->refresh_task = NULL;
372 }
373 if (NULL != ce->ah)
374 {
376 ce->ah = NULL;
377 }
378 if (NULL != ce->sh)
379 {
381 ce->sh = NULL;
382 }
383 GNUNET_free (ce);
384}
void REGEX_INTERNAL_search_cancel(struct REGEX_INTERNAL_Search *h)
Cancel an ongoing regex search in the DHT and free all resources.
void REGEX_INTERNAL_announce_cancel(struct REGEX_INTERNAL_Announcement *h)
Clear all cached data used by a regex announce.

References ClientEntry::ah, GNUNET_free, GNUNET_SCHEDULER_cancel(), ClientEntry::refresh_task, REGEX_INTERNAL_announce_cancel(), REGEX_INTERNAL_search_cancel(), and ClientEntry::sh.

Here is the call graph for this function:

◆ GNUNET_SERVICE_MAIN()

GNUNET_SERVICE_MAIN ( "regex"  ,
GNUNET_SERVICE_OPTION_NONE  ,
run,
client_connect_cb,
client_disconnect_cb,
NULL  ,
GNUNET_MQ_hd_var_size(announce, GNUNET_MESSAGE_TYPE_REGEX_ANNOUNCE, struct AnnounceMessage, NULL)  ,
GNUNET_MQ_hd_var_size(search, GNUNET_MESSAGE_TYPE_REGEX_SEARCH, struct RegexSearchMessage, NULL)  ,
GNUNET_MQ_handler_end()   
)

Define "main" method using service macro.

Variable Documentation

◆ dht

struct GNUNET_DHT_Handle* dht
static

Connection to the DHT.

Definition at line 73 of file gnunet-service-regex.c.

Referenced by cleanup_task(), handle_announce(), handle_search(), and run().

◆ stats

struct GNUNET_STATISTICS_Handle* stats
static

Handle for doing statistics.

Definition at line 78 of file gnunet-service-regex.c.

Referenced by cleanup_task(), handle_announce(), handle_search(), and run().

◆ my_private_key

struct GNUNET_CRYPTO_EddsaPrivateKey* my_private_key
static

Private key for this peer.

Definition at line 83 of file gnunet-service-regex.c.

Referenced by cleanup_task(), handle_announce(), and run().