GNUnet  0.11.x
Data Structures | Functions | Variables
gnunet-service-statistics.c File Reference

program that tracks statistics More...

#include "platform.h"
#include "gnunet_bio_lib.h"
#include "gnunet_container_lib.h"
#include "gnunet_disk_lib.h"
#include "gnunet_getopt_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_service_lib.h"
#include "gnunet_statistics_service.h"
#include "gnunet_strings_lib.h"
#include "gnunet_time_lib.h"
#include "statistics.h"
Include dependency graph for gnunet-service-statistics.c:

Go to the source code of this file.

Data Structures

struct  WatchEntry
 Watch entry. More...
 
struct  StatsEntry
 Entry in the statistics list. More...
 
struct  SubsystemEntry
 We keep the statistics organized by subsystem for faster lookup during SET operations. More...
 
struct  ClientEntry
 Information about one of our clients. More...
 

Functions

static void save ()
 Write persistent statistics to disk. More...
 
static void transmit (struct ClientEntry *ce, const struct StatsEntry *e)
 Transmit the given stats value. 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 int check_get (void *cls, const struct GNUNET_MessageHeader *message)
 Check integrity of GET-message. More...
 
static void handle_get (void *cls, const struct GNUNET_MessageHeader *message)
 Handle GET-message. More...
 
static void notify_change (struct StatsEntry *se)
 Notify all clients listening about a change to a value. More...
 
static struct SubsystemEntryfind_subsystem_entry (struct ClientEntry *ce, const char *service)
 Find the subsystem entry of the given name for the specified client. More...
 
static struct StatsEntryfind_stat_entry (struct SubsystemEntry *se, const char *name)
 Find the statistics entry of the given subsystem. More...
 
static int check_set (void *cls, const struct GNUNET_STATISTICS_SetMessage *msg)
 Check format of SET-message. More...
 
static void handle_set (void *cls, const struct GNUNET_STATISTICS_SetMessage *msg)
 Handle SET-message. More...
 
static int check_watch (void *cls, const struct GNUNET_MessageHeader *message)
 Check integrity of WATCH-message. More...
 
static void handle_watch (void *cls, const struct GNUNET_MessageHeader *message)
 Handle WATCH-message. More...
 
static void handle_disconnect (void *cls, const struct GNUNET_MessageHeader *message)
 Handle DISCONNECT-message. More...
 
static void do_shutdown ()
 Actually perform the shutdown. More...
 
static void shutdown_task (void *cls)
 Task run during shutdown. More...
 
static void client_disconnect_cb (void *cls, struct GNUNET_SERVICE_Client *client, void *app_cls)
 A client disconnected. More...
 
static int inject_message (void *cls, const struct GNUNET_MessageHeader *message)
 We've read a struct GNUNET_STATISTICS_SetMessage * from disk. More...
 
static void load ()
 Load persistent values from disk. More...
 
static void run (void *cls, const struct GNUNET_CONFIGURATION_Handle *c, struct GNUNET_SERVICE_Handle *service)
 Process statistics requests. More...
 
 GNUNET_SERVICE_MAIN ("statistics", GNUNET_SERVICE_OPTION_SOFT_SHUTDOWN, &run, &client_connect_cb, &client_disconnect_cb, NULL, GNUNET_MQ_hd_var_size(set, GNUNET_MESSAGE_TYPE_STATISTICS_SET, struct GNUNET_STATISTICS_SetMessage, NULL), GNUNET_MQ_hd_var_size(get, GNUNET_MESSAGE_TYPE_STATISTICS_GET, struct GNUNET_MessageHeader, NULL), GNUNET_MQ_hd_var_size(watch, GNUNET_MESSAGE_TYPE_STATISTICS_WATCH, struct GNUNET_MessageHeader, NULL), GNUNET_MQ_hd_fixed_size(disconnect, GNUNET_MESSAGE_TYPE_STATISTICS_DISCONNECT, struct GNUNET_MessageHeader, NULL), GNUNET_MQ_handler_end())
 Define "main" method using service macro. More...
 

Variables

static const struct GNUNET_CONFIGURATION_Handlecfg
 Our configuration. More...
 
static struct SubsystemEntrysub_head
 Head of linked list of subsystems with active statistics. More...
 
static struct SubsystemEntrysub_tail
 Tail of linked list of subsystems with active statistics. More...
 
static unsigned int client_count
 Number of connected clients. More...
 
static struct GNUNET_NotificationContextnc
 Our notification context. More...
 
static uint32_t uidgen
 Counter used to generate unique values. More...
 
static int in_shutdown
 Set to GNUNET_YES if we are shutting down as soon as possible. More...
 

Detailed Description

program that tracks statistics

Author
Christian Grothoff

Definition in file gnunet-service-statistics.c.

Function Documentation

◆ save()

static void save ( )
static

Write persistent statistics to disk.

Definition at line 243 of file gnunet-service-statistics.c.

244 {
245  struct SubsystemEntry *se;
246  struct StatsEntry *pos;
247  char *fn;
248  struct GNUNET_BIO_WriteHandle *wh;
249  uint16_t size;
250  unsigned long long total;
251  size_t nlen;
252  size_t slen;
254 
256  "STATISTICS",
257  "DATABASE",
258  &fn))
259  {
261  "STATISTICS",
262  "DATABASE");
263  return;
264  }
267  total = 0;
268  while (NULL != (se = sub_head))
269  {
271  slen = strlen (se->service) + 1;
272  while (NULL != (pos = se->stat_head))
273  {
275  if ((pos->persistent) && (NULL != wh))
276  {
277  nlen = strlen (pos->name) + 1;
278  size = sizeof(struct GNUNET_STATISTICS_SetMessage) + nlen + slen;
279  GNUNET_assert (size < UINT16_MAX);
280  msg = GNUNET_malloc (size);
281 
282  msg->header.size = htons ((uint16_t) size);
283  msg->header.type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_SET);
284  GNUNET_assert (nlen + slen ==
285  GNUNET_STRINGS_buffer_fill ((char *) &msg[1],
286  nlen + slen,
287  2,
288  se->service,
289  pos->name));
290  msg->flags =
292  msg->value = GNUNET_htonll (pos->value);
293  if (GNUNET_OK != GNUNET_BIO_write (wh, "statistics-save-msg", msg,
294  size))
295  {
297  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
299  wh = NULL;
300  }
301  else
302  {
303  total += size;
304  }
305  GNUNET_free (msg);
306  }
307  GNUNET_free (pos);
308  }
309  GNUNET_free (se);
310  }
311  if (NULL != wh)
312  {
313  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
315  if (0 == total)
316  GNUNET_break (0 == unlink (fn));
317  else
319  _ ("Wrote %llu bytes of statistics to `%s'\n"),
320  total,
321  fn);
322  }
323  GNUNET_free (fn);
324 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
static struct SubsystemEntry * sub_tail
Tail of linked list of subsystems with active statistics.
static struct SubsystemEntry * sub_head
Head of linked list of subsystems with active statistics.
static struct GNUNET_TESTBED_BarrierWaitHandle * wh
Our barrier wait handle.
#define GNUNET_log(kind,...)
uint64_t GNUNET_htonll(uint64_t n)
Convert unsigned 64-bit integer to network byte order.
Definition: common_endian.c:36
@ GNUNET_OK
Definition: gnunet_common.h:95
static char * fn
Filename of the unique file.
int GNUNET_BIO_write(struct GNUNET_BIO_WriteHandle *h, const char *what, const void *buffer, size_t n)
Write a buffer to a handle.
Definition: bio.c:795
int GNUNET_BIO_write_close(struct GNUNET_BIO_WriteHandle *h, char **emsg)
Close an IO handle.
Definition: bio.c:608
struct GNUNET_BIO_WriteHandle * GNUNET_BIO_write_open_file(const char *fn)
Open a file for writing.
Definition: bio.c:559
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create_for_file(const char *filename)
Create the directory structure for storing a file.
Definition: disk.c:582
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
@ GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_INFO
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
#define GNUNET_MESSAGE_TYPE_STATISTICS_SET
Set a statistical value.
size_t GNUNET_STRINGS_buffer_fill(char *buffer, size_t size, unsigned int count,...)
Fill a buffer of the given size with count 0-terminated strings (given as varargs).
Definition: strings.c:45
static unsigned int size
Size of the "table".
Definition: peer.c:67
#define _(String)
GNU gettext support macro.
Definition: platform.h:177
#define GNUNET_STATISTICS_SETFLAG_PERSISTENT
The value being set is to be persistent (note that this bit can be combined with GNUNET_STATISTICS_SE...
Definition: statistics.h:83
Handle for buffered writing.
Definition: bio.c:517
uint16_t type
The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.
Message to set a statistic.
Definition: statistics.h:92
Entry in the statistics list.
uint64_t value
Our value.
int persistent
Is this value persistent?
const char * name
Name for the value stored by this entry, allocated at the end of this struct.
We keep the statistics organized by subsystem for faster lookup during SET operations.
struct StatsEntry * stat_head
Head of list of values kept for this subsystem.
struct StatsEntry * stat_tail
Tail of list of values kept for this subsystem.
const char * service
Name of the subsystem this entry is for, allocated at the end of this struct, do not free().

References _, cfg, fn, GNUNET_assert, GNUNET_BIO_write(), GNUNET_BIO_write_close(), GNUNET_BIO_write_open_file(), GNUNET_break, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONTAINER_DLL_remove, GNUNET_DISK_directory_create_for_file(), GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_htonll(), GNUNET_log, GNUNET_log_config_missing(), GNUNET_log_strerror_file, GNUNET_malloc, GNUNET_MESSAGE_TYPE_STATISTICS_SET, GNUNET_OK, GNUNET_STATISTICS_SETFLAG_PERSISTENT, GNUNET_STRINGS_buffer_fill(), msg, StatsEntry::name, StatsEntry::persistent, SubsystemEntry::service, GNUNET_MessageHeader::size, size, SubsystemEntry::stat_head, SubsystemEntry::stat_tail, sub_head, sub_tail, GNUNET_MessageHeader::type, StatsEntry::value, and wh.

Referenced by do_shutdown(), GNUNET_STRINGS_parse_ipv6_policy(), iterate_save_entries(), iterate_save_links(), iterate_save_messages(), and save_message_store().

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

◆ transmit()

static void transmit ( struct ClientEntry ce,
const struct StatsEntry e 
)
static

Transmit the given stats value.

Parameters
clientreceiver of the value
evalue to transmit

Definition at line 334 of file gnunet-service-statistics.c.

335 {
336  struct GNUNET_MQ_Envelope *env;
338  size_t size;
339 
340  size = strlen (e->subsystem->service) + 1 + strlen (e->name) + 1;
343  m->uid = htonl (e->uid);
344  if (e->persistent)
345  m->uid |= htonl (GNUNET_STATISTICS_PERSIST_BIT);
346  m->value = GNUNET_htonll (e->value);
348  size,
349  2,
350  e->subsystem->service,
351  e->name));
353  "Transmitting value for `%s:%s' (%d): %llu\n",
354  e->subsystem->service,
355  e->name,
356  e->persistent,
357  (unsigned long long) e->value);
358  GNUNET_MQ_send (ce->mq, env);
359 }
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:104
static struct Experiment * e
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message,...
@ GNUNET_ERROR_TYPE_DEBUG
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:355
#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:52
#define GNUNET_MESSAGE_TYPE_STATISTICS_VALUE
Response to a STATISTICS_GET message (with value).
#define GNUNET_STATISTICS_PERSIST_BIT
Flag for the struct GNUNET_STATISTICS_ReplyMessage UID only.
Definition: statistics.h:65
struct GNUNET_MQ_Handle * mq
Queue for transmissions to client.
Statistics message.
Definition: statistics.h:41

References e, env, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_htonll(), GNUNET_log, GNUNET_MAX_MESSAGE_SIZE, GNUNET_MESSAGE_TYPE_STATISTICS_VALUE, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_STATISTICS_PERSIST_BIT, GNUNET_STRINGS_buffer_fill(), m, ClientEntry::mq, Experiment::name, and size.

Referenced by handle_get().

Here is the call graph for this function:
Here is the caller 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 371 of file gnunet-service-statistics.c.

374 {
375  struct ClientEntry *ce;
376 
377  ce = GNUNET_new (struct ClientEntry);
378  ce->client = c;
379  ce->mq = mq;
380  client_count++;
382  return ce;
383 }
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
static unsigned int client_count
Number of connected clients.
static struct GNUNET_NotificationContext * nc
Our notification context.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
void GNUNET_notification_context_add(struct GNUNET_NotificationContext *nc, struct GNUNET_MQ_Handle *mq)
Add a subscriber to the notification context.
Definition: nc.c:160
Information about one of our clients.
struct GNUNET_SERVICE_Client * client
Handle identifying the client.

References ClientEntry::client, client_count, GNUNET_new, GNUNET_notification_context_add(), mq, ClientEntry::mq, and nc.

Here is the call graph for this function:

◆ check_get()

static int check_get ( void *  cls,
const struct GNUNET_MessageHeader message 
)
static

Check integrity of GET-message.

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

Definition at line 394 of file gnunet-service-statistics.c.

395 {
396  const char *service;
397  const char *name;
398  size_t size;
399 
400  size = ntohs (message->size) - sizeof(struct GNUNET_MessageHeader);
401  if (size != GNUNET_STRINGS_buffer_tokenize ((const char *) &message[1],
402  size,
403  2,
404  &service,
405  &name))
406  {
407  GNUNET_break (0);
408  return GNUNET_SYSERR;
409  }
410  return GNUNET_OK;
411 }
static struct GNUNET_SERVICE_Handle * service
Handle to our service instance.
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
unsigned int GNUNET_STRINGS_buffer_tokenize(const char *buffer, size_t size, unsigned int count,...)
Given a buffer of a given size, find "count" 0-terminated strings in the buffer and assign the count ...
Definition: strings.c:96
const char * name
Header for all communications.

References GNUNET_break, GNUNET_OK, GNUNET_STRINGS_buffer_tokenize(), GNUNET_SYSERR, name, service, GNUNET_MessageHeader::size, and size.

Here is the call graph for this function:

◆ handle_get()

static void handle_get ( void *  cls,
const struct GNUNET_MessageHeader message 
)
static

Handle GET-message.

Parameters
clsidentification of the client
messagethe actual message

Definition at line 421 of file gnunet-service-statistics.c.

422 {
423  struct ClientEntry *ce = cls;
424  struct GNUNET_MQ_Envelope *env;
425  struct GNUNET_MessageHeader *end;
426  const char *service;
427  const char *name;
428  size_t slen;
429  size_t nlen;
430  struct SubsystemEntry *se;
431  struct StatsEntry *pos;
432  size_t size;
433 
434  size = ntohs (message->size) - sizeof(struct GNUNET_MessageHeader);
435  GNUNET_assert (size ==
436  GNUNET_STRINGS_buffer_tokenize ((const char *) &message[1],
437  size,
438  2,
439  &service,
440  &name));
441  slen = strlen (service);
442  nlen = strlen (name);
444  "Received request for statistics on `%s:%s'\n",
445  slen ? service : "*",
446  nlen ? name : "*");
447  for (se = sub_head; NULL != se; se = se->next)
448  {
449  if (! ((0 == slen) || (0 == strcmp (service, se->service))))
450  continue;
451  for (pos = se->stat_head; NULL != pos; pos = pos->next)
452  {
453  if (! ((0 == nlen) || (0 == strcmp (name, pos->name))))
454  continue;
455  transmit (ce, pos);
456  }
457  }
459  GNUNET_MQ_send (ce->mq, env);
461 }
static int end
Set if we are to shutdown all services (including ARM).
Definition: gnunet-arm.c:34
static void transmit(struct ClientEntry *ce, const struct StatsEntry *e)
Transmit the given stats value.
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:67
#define GNUNET_MESSAGE_TYPE_STATISTICS_END
Response to a STATISTICS_GET message (end of value stream).
void GNUNET_SERVICE_client_continue(struct GNUNET_SERVICE_Client *c)
Continue receiving further messages from the given client.
Definition: service.c:2244
struct StatsEntry * next
This is a linked list.
struct SubsystemEntry * next
Subsystems are kept in a DLL.

References ClientEntry::client, end, env, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_MESSAGE_TYPE_STATISTICS_END, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_SERVICE_client_continue(), GNUNET_STRINGS_buffer_tokenize(), ClientEntry::mq, name, StatsEntry::name, StatsEntry::next, SubsystemEntry::next, service, SubsystemEntry::service, GNUNET_MessageHeader::size, size, SubsystemEntry::stat_head, sub_head, and transmit().

Here is the call graph for this function:

◆ notify_change()

static void notify_change ( struct StatsEntry se)
static

Notify all clients listening about a change to a value.

Parameters
sevalue that changed

Definition at line 470 of file gnunet-service-statistics.c.

471 {
472  struct GNUNET_MQ_Envelope *env;
474  struct WatchEntry *pos;
475 
476  for (pos = se->we_head; NULL != pos; pos = pos->next)
477  {
478  if (GNUNET_YES == pos->last_value_set)
479  {
480  if (pos->last_value == se->value)
481  continue;
482  }
483  else
484  {
485  pos->last_value_set = GNUNET_YES;
486  }
488  wvm->flags =
490  wvm->wid = htonl (pos->wid);
491  wvm->reserved = htonl (0);
492  wvm->value = GNUNET_htonll (se->value);
493  GNUNET_MQ_send (pos->ce->mq, env);
494  pos->last_value = se->value;
495  }
496 }
@ GNUNET_YES
Definition: gnunet_common.h:97
#define GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE
Changes to a watched value.
Message transmitted if a watched value changes.
Definition: statistics.h:116
uint32_t reserved
Reserved (always 0).
Definition: statistics.h:139
uint32_t flags
0 for absolute value, 1 for relative value; 2 to make persistent (see GNUNET_STATISTICS_SETFLAG_*).
Definition: statistics.h:126
uint32_t wid
Unique watch identification number (watch requests are enumerated in the order they are received,...
Definition: statistics.h:134
struct WatchEntry * we_head
Watch context for changes to this value, or NULL for none.
struct WatchEntry * next
Watch entries are kept in a linked list.
uint64_t last_value
Last value we communicated to the client for this watch entry.
int last_value_set
Is last_value valid GNUNET_NO : last_value is n/a, GNUNET_YES: last_value is valid.
uint32_t wid
Unique watch number for this client and this watched value.
struct ClientEntry * ce
For which client is this watch entry?

References WatchEntry::ce, env, GNUNET_STATISTICS_WatchValueMessage::flags, GNUNET_htonll(), GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_STATISTICS_SETFLAG_PERSISTENT, GNUNET_YES, WatchEntry::last_value, WatchEntry::last_value_set, ClientEntry::mq, WatchEntry::next, StatsEntry::persistent, GNUNET_STATISTICS_WatchValueMessage::reserved, StatsEntry::value, GNUNET_STATISTICS_WatchValueMessage::value, StatsEntry::we_head, WatchEntry::wid, and GNUNET_STATISTICS_WatchValueMessage::wid.

Referenced by handle_set(), and handle_watch().

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

◆ find_subsystem_entry()

static struct SubsystemEntry* find_subsystem_entry ( struct ClientEntry ce,
const char *  service 
)
static

Find the subsystem entry of the given name for the specified client.

Parameters
ceclient looking for the subsystem, may contain a hint to find the entry faster, can be NULL
servicename of the subsystem to look for
Returns
subsystem entry, never NULL (subsystem entry is created if necessary)

Definition at line 508 of file gnunet-service-statistics.c.

509 {
510  size_t slen;
511  struct SubsystemEntry *se;
512 
513  if (NULL != ce)
514  se = ce->subsystem;
515  else
516  se = NULL;
517  if ((NULL == se) || (0 != strcmp (service, se->service)))
518  {
519  for (se = sub_head; NULL != se; se = se->next)
520  if (0 == strcmp (service, se->service))
521  break;
522  if (NULL != ce)
523  ce->subsystem = se;
524  }
525  if (NULL != se)
526  return se;
528  "Allocating new subsystem entry `%s'\n",
529  service);
530  slen = strlen (service) + 1;
531  se = GNUNET_malloc (sizeof(struct SubsystemEntry) + slen);
532  GNUNET_memcpy (&se[1], service, slen);
533  se->service = (const char *) &se[1];
535  if (NULL != ce)
536  ce->subsystem = se;
537  return se;
538 }
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
struct SubsystemEntry * subsystem
Which subsystem is this client writing to (SET/UPDATE)?

References GNUNET_CONTAINER_DLL_insert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_malloc, GNUNET_memcpy, SubsystemEntry::next, service, SubsystemEntry::service, sub_head, sub_tail, and ClientEntry::subsystem.

Referenced by handle_set(), and handle_watch().

Here is the caller graph for this function:

◆ find_stat_entry()

static struct StatsEntry* find_stat_entry ( struct SubsystemEntry se,
const char *  name 
)
static

Find the statistics entry of the given subsystem.

Parameters
subsystemsubsystem to look in
namename of the entry to look for
Returns
statistis entry, or NULL if not found

Definition at line 549 of file gnunet-service-statistics.c.

550 {
551  struct StatsEntry *pos;
552 
553  for (pos = se->stat_head; NULL != pos; pos = pos->next)
554  if (0 == strcmp (name, pos->name))
555  return pos;
556  return NULL;
557 }

References name, StatsEntry::name, StatsEntry::next, and SubsystemEntry::stat_head.

Referenced by handle_set(), and handle_watch().

Here is the caller graph for this function:

◆ check_set()

static int check_set ( void *  cls,
const struct GNUNET_STATISTICS_SetMessage msg 
)
static

Check format of SET-message.

Parameters
clsthe struct ClientEntry
messagethe actual message
Returns
GNUNET_OK if message is well-formed

Definition at line 568 of file gnunet-service-statistics.c.

569 {
570  const char *service;
571  const char *name;
572  size_t msize;
573 
574  msize = ntohs (msg->header.size) - sizeof(*msg);
575  if (msize != GNUNET_STRINGS_buffer_tokenize ((const char *) &msg[1],
576  msize,
577  2,
578  &service,
579  &name))
580  {
581  GNUNET_break (0);
582  return GNUNET_SYSERR;
583  }
584  return GNUNET_OK;
585 }

References GNUNET_break, GNUNET_OK, GNUNET_STRINGS_buffer_tokenize(), GNUNET_SYSERR, msg, name, service, and GNUNET_MessageHeader::size.

Referenced by inject_message().

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

◆ handle_set()

static void handle_set ( void *  cls,
const struct GNUNET_STATISTICS_SetMessage msg 
)
static

Handle SET-message.

Parameters
clsthe struct ClientEntry
messagethe actual message

Definition at line 595 of file gnunet-service-statistics.c.

596 {
597  struct ClientEntry *ce = cls;
598  const char *service;
599  const char *name;
600  size_t nlen;
601  uint16_t msize;
602  uint16_t size;
603  struct SubsystemEntry *se;
604  struct StatsEntry *pos;
605  uint32_t flags;
606  uint64_t value;
607  int64_t delta;
608  int changed;
609  int initial_set;
610 
611  msize = ntohs (msg->header.size);
612  size = msize - sizeof(struct GNUNET_STATISTICS_SetMessage);
613  GNUNET_assert (size == GNUNET_STRINGS_buffer_tokenize ((const char *) &msg[1],
614  size,
615  2,
616  &service,
617  &name));
618  se = find_subsystem_entry (ce, service);
619  flags = ntohl (msg->flags);
620  value = GNUNET_ntohll (msg->value);
622  "Received request to update statistic on `%s:%s' (%u) to/by %llu\n",
623  service,
624  name,
625  (unsigned int) flags,
626  (unsigned long long) value);
627  pos = find_stat_entry (se, name);
628  if (NULL != pos)
629  {
630  initial_set = 0;
632  {
633  changed = (pos->value != value);
634  pos->value = value;
635  }
636  else
637  {
638  delta = (int64_t) value;
639  if ((delta < 0) && (pos->value < -delta))
640  {
641  changed = (0 != pos->value);
642  pos->value = 0;
643  }
644  else
645  {
646  changed = (0 != delta);
647  GNUNET_break ((delta <= 0) || (pos->value + delta > pos->value));
648  pos->value += delta;
649  }
650  }
651  if (GNUNET_NO == pos->set)
652  {
653  pos->set = GNUNET_YES;
654  initial_set = 1;
655  }
657  if (pos != se->stat_head)
658  {
659  /* move to front for faster setting next time! */
662  }
664  "Statistic `%s:%s' updated to value %llu (%d).\n",
665  service,
666  name,
667  (unsigned long long) pos->value,
668  pos->persistent);
669  if ((changed) || (1 == initial_set))
670  notify_change (pos);
672  return;
673  }
674  /* not found, create a new entry */
675  nlen = strlen (name) + 1;
676  pos = GNUNET_malloc (sizeof(struct StatsEntry) + nlen);
677  GNUNET_memcpy (&pos[1], name, nlen);
678  pos->name = (const char *) &pos[1];
679  pos->subsystem = se;
680  if ((0 == (flags & GNUNET_STATISTICS_SETFLAG_RELATIVE)) ||
681  (0 < (int64_t) GNUNET_ntohll (msg->value)))
682  {
683  pos->value = GNUNET_ntohll (msg->value);
684  pos->set = GNUNET_YES;
685  }
686  else
687  {
688  pos->set = GNUNET_NO;
689  }
690  pos->uid = uidgen++;
694  "New statistic on `%s:%s' with value %llu created.\n",
695  service,
696  name,
697  (unsigned long long) pos->value);
698  if (NULL != ce)
700 }
static char * value
Value of the record to add/remove.
static struct StatsEntry * find_stat_entry(struct SubsystemEntry *se, const char *name)
Find the statistics entry of the given subsystem.
static struct SubsystemEntry * find_subsystem_entry(struct ClientEntry *ce, const char *service)
Find the subsystem entry of the given name for the specified client.
static void notify_change(struct StatsEntry *se)
Notify all clients listening about a change to a value.
static uint32_t uidgen
Counter used to generate unique values.
uint64_t GNUNET_ntohll(uint64_t n)
Convert unsigned 64-bit integer to host byte order.
Definition: common_endian.c:53
@ GNUNET_NO
Definition: gnunet_common.h:94
static struct GNUNET_TIME_Relative delta
Definition: speedup.c:35
#define GNUNET_STATISTICS_SETFLAG_RELATIVE
The value being set is a relative change.
Definition: statistics.h:75
uint32_t flags
0 for absolute value, 1 for relative value; 2 to make persistent (see GNUNET_STATISTICS_SETFLAG_*).
Definition: statistics.h:102
struct SubsystemEntry * subsystem
Subsystem this entry belongs to.
uint32_t uid
Unique ID.
int set
Is this value set? GNUNET_NO: value is n/a, GNUNET_YES: value is valid.

References ClientEntry::client, delta, find_stat_entry(), find_subsystem_entry(), GNUNET_STATISTICS_SetMessage::flags, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_DLL_insert, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_malloc, GNUNET_memcpy, GNUNET_NO, GNUNET_ntohll(), GNUNET_SERVICE_client_continue(), GNUNET_STATISTICS_SETFLAG_PERSISTENT, GNUNET_STATISTICS_SETFLAG_RELATIVE, GNUNET_STRINGS_buffer_tokenize(), GNUNET_YES, msg, name, StatsEntry::name, notify_change(), StatsEntry::persistent, service, StatsEntry::set, GNUNET_MessageHeader::size, size, SubsystemEntry::stat_head, SubsystemEntry::stat_tail, StatsEntry::subsystem, StatsEntry::uid, uidgen, value, and StatsEntry::value.

Referenced by inject_message().

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

◆ check_watch()

static int check_watch ( void *  cls,
const struct GNUNET_MessageHeader message 
)
static

Check integrity of WATCH-message.

Parameters
clsthe struct ClientEntry *
messagethe actual message
Returns
GNUNET_OK if message is well-formed

Definition at line 711 of file gnunet-service-statistics.c.

712 {
713  size_t size;
714  const char *service;
715  const char *name;
716 
717  size = ntohs (message->size) - sizeof(struct GNUNET_MessageHeader);
718  if (size != GNUNET_STRINGS_buffer_tokenize ((const char *) &message[1],
719  size,
720  2,
721  &service,
722  &name))
723  {
724  GNUNET_break (0);
725  return GNUNET_SYSERR;
726  }
727  return GNUNET_OK;
728 }

References GNUNET_break, GNUNET_OK, GNUNET_STRINGS_buffer_tokenize(), GNUNET_SYSERR, name, service, GNUNET_MessageHeader::size, and size.

Here is the call graph for this function:

◆ handle_watch()

static void handle_watch ( void *  cls,
const struct GNUNET_MessageHeader message 
)
static

Handle WATCH-message.

Parameters
clsthe struct ClientEntry *
messagethe actual message

Definition at line 738 of file gnunet-service-statistics.c.

739 {
740  struct ClientEntry *ce = cls;
741  const char *service;
742  const char *name;
743  uint16_t msize;
744  uint16_t size;
745  struct SubsystemEntry *se;
746  struct StatsEntry *pos;
747  struct WatchEntry *we;
748  size_t nlen;
749 
750  if (NULL == nc)
751  {
753  return;
754  }
756  msize = ntohs (message->size);
757  size = msize - sizeof(struct GNUNET_MessageHeader);
758  GNUNET_assert (size ==
759  GNUNET_STRINGS_buffer_tokenize ((const char *) &message[1],
760  size,
761  2,
762  &service,
763  &name));
765  "Received request to watch statistic on `%s:%s'\n",
766  service,
767  name);
768  se = find_subsystem_entry (ce, service);
769  pos = find_stat_entry (se, name);
770  if (NULL == pos)
771  {
772  nlen = strlen (name) + 1;
773  pos = GNUNET_malloc (sizeof(struct StatsEntry) + nlen);
774  GNUNET_memcpy (&pos[1], name, nlen);
775  pos->name = (const char *) &pos[1];
776  pos->subsystem = se;
778  pos->uid = uidgen++;
779  pos->set = GNUNET_NO;
781  "New statistic on `%s:%s' with value %llu created.\n",
782  service,
783  name,
784  (unsigned long long) pos->value);
785  }
786  we = GNUNET_new (struct WatchEntry);
787  we->ce = ce;
789  we->wid = ce->max_wid++;
791  if (0 != pos->value)
792  notify_change (pos);
794 }
void GNUNET_SERVICE_client_mark_monitor(struct GNUNET_SERVICE_Client *c)
Set the 'monitor' flag on this client.
Definition: service.c:2408
void GNUNET_SERVICE_client_drop(struct GNUNET_SERVICE_Client *c)
Ask the server to disconnect from the given client.
Definition: service.c:2325
uint32_t max_wid
Maximum watch ID used by this client so far.
struct WatchEntry * we_tail
Watch context for changes to this value, or NULL for none.

References WatchEntry::ce, ClientEntry::client, find_stat_entry(), find_subsystem_entry(), GNUNET_assert, GNUNET_CONTAINER_DLL_insert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_malloc, GNUNET_memcpy, GNUNET_new, GNUNET_NO, GNUNET_SERVICE_client_continue(), GNUNET_SERVICE_client_drop(), GNUNET_SERVICE_client_mark_monitor(), GNUNET_STRINGS_buffer_tokenize(), WatchEntry::last_value_set, ClientEntry::max_wid, name, StatsEntry::name, nc, notify_change(), service, StatsEntry::set, GNUNET_MessageHeader::size, size, SubsystemEntry::stat_head, SubsystemEntry::stat_tail, StatsEntry::subsystem, StatsEntry::uid, uidgen, StatsEntry::value, StatsEntry::we_head, StatsEntry::we_tail, and WatchEntry::wid.

Here is the call graph for this function:

◆ handle_disconnect()

static void handle_disconnect ( void *  cls,
const struct GNUNET_MessageHeader message 
)
static

Handle DISCONNECT-message.

Sync to disk and send back a GNUNET_MESSAGE_TYPE_STATISTICS_DISCONNECT_CONFIRM message.

Parameters
clsthe struct ClientEntry *
messagethe actual message

Definition at line 806 of file gnunet-service-statistics.c.

807 {
808  struct ClientEntry *ce = cls;
809  struct GNUNET_MQ_Envelope *env;
810  struct GNUNET_MessageHeader *msg;
811 
813  GNUNET_MQ_send (ce->mq, env);
815 }
#define GNUNET_MESSAGE_TYPE_STATISTICS_DISCONNECT_CONFIRM
Service confirms disconnect and that it is done processing all requests from the client.

References ClientEntry::client, env, GNUNET_MESSAGE_TYPE_STATISTICS_DISCONNECT_CONFIRM, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_SERVICE_client_continue(), ClientEntry::mq, and msg.

Here is the call graph for this function:

◆ do_shutdown()

static void do_shutdown ( )
static

Actually perform the shutdown.

Definition at line 822 of file gnunet-service-statistics.c.

823 {
824  struct WatchEntry *we;
825  struct StatsEntry *pos;
826  struct SubsystemEntry *se;
827 
828  if (NULL == nc)
829  return;
830  save ();
832  nc = NULL;
834  while (NULL != (se = sub_head))
835  {
837  while (NULL != (pos = se->stat_head))
838  {
840  while (NULL != (we = pos->we_head))
841  {
842  GNUNET_break (0);
844  GNUNET_free (we);
845  }
846  GNUNET_free (pos);
847  }
848  GNUNET_free (se);
849  }
850 }
static void save()
Write persistent statistics to disk.
void GNUNET_notification_context_destroy(struct GNUNET_NotificationContext *nc)
Destroy the context, force disconnect for all subscribers.
Definition: nc.c:137

References client_count, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_notification_context_destroy(), nc, save(), SubsystemEntry::stat_head, SubsystemEntry::stat_tail, sub_head, sub_tail, StatsEntry::we_head, and StatsEntry::we_tail.

Referenced by client_disconnect_cb(), and shutdown_task().

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

◆ shutdown_task()

static void shutdown_task ( void *  cls)
static

Task run during shutdown.

Parameters
clsunused

Definition at line 859 of file gnunet-service-statistics.c.

860 {
862  if (0 != client_count)
863  return;
864  do_shutdown ();
865 }
static int in_shutdown
Set to GNUNET_YES if we are shutting down as soon as possible.
static void do_shutdown()
Actually perform the shutdown.

References client_count, do_shutdown(), GNUNET_YES, and in_shutdown.

Referenced by run().

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

◆ client_disconnect_cb()

static void client_disconnect_cb ( void *  cls,
struct GNUNET_SERVICE_Client client,
void *  app_cls 
)
static

A client disconnected.

Remove all of its data structure entries.

Parameters
clsclosure, NULL
clientidentification of the client
app_clsthe struct ClientEntry *

Definition at line 876 of file gnunet-service-statistics.c.

879 {
880  struct ClientEntry *ce = app_cls;
881  struct WatchEntry *we;
882  struct WatchEntry *wen;
883  struct StatsEntry *pos;
884  struct SubsystemEntry *se;
885 
886  client_count--;
887  for (se = sub_head; NULL != se; se = se->next)
888  {
889  for (pos = se->stat_head; NULL != pos; pos = pos->next)
890  {
891  wen = pos->we_head;
892  while (NULL != (we = wen))
893  {
894  wen = we->next;
895  if (we->ce != ce)
896  continue;
898  GNUNET_free (we);
899  }
900  }
901  }
902  GNUNET_free (ce);
903  if ((0 == client_count) && (GNUNET_YES == in_shutdown))
904  do_shutdown ();
905 }

References WatchEntry::ce, client_count, do_shutdown(), GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_YES, in_shutdown, WatchEntry::next, StatsEntry::next, SubsystemEntry::next, SubsystemEntry::stat_head, sub_head, StatsEntry::we_head, and StatsEntry::we_tail.

Here is the call graph for this function:

◆ inject_message()

static int inject_message ( void *  cls,
const struct GNUNET_MessageHeader message 
)
static

We've read a struct GNUNET_STATISTICS_SetMessage * from disk.

Check that it is well-formed, and if so pass it to the handler for set messages.

Parameters
clsNULL
messagethe message found on disk
Returns
GNUNET_OK on success, GNUNET_NO to stop further processing (no error) GNUNET_SYSERR to stop further processing with error

Definition at line 920 of file gnunet-service-statistics.c.

921 {
922  uint16_t msize = ntohs (message->size);
923  const struct GNUNET_STATISTICS_SetMessage *sm;
924 
925  sm = (const struct GNUNET_STATISTICS_SetMessage *) message;
926  if ((sizeof(struct GNUNET_STATISTICS_SetMessage) > msize) ||
927  (GNUNET_OK != check_set (NULL, sm)))
928  {
929  GNUNET_break (0);
930  return GNUNET_SYSERR;
931  }
932  handle_set (NULL, sm);
933  return GNUNET_OK;
934 }
static void handle_set(void *cls, const struct GNUNET_STATISTICS_SetMessage *msg)
Handle SET-message.
static int check_set(void *cls, const struct GNUNET_STATISTICS_SetMessage *msg)
Check format of SET-message.

References check_set(), GNUNET_break, GNUNET_OK, GNUNET_SYSERR, handle_set(), and GNUNET_MessageHeader::size.

Referenced by load().

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

◆ load()

static void load ( )
static

Load persistent values from disk.

Disk format is exactly the same format that we also use for setting the values over the network.

Definition at line 942 of file gnunet-service-statistics.c.

943 {
944  char *fn;
945  struct GNUNET_BIO_ReadHandle *rh;
946  uint64_t fsize;
947  char *buf;
948  struct GNUNET_MessageStreamTokenizer *mst;
949 
951  "STATISTICS",
952  "DATABASE",
953  &fn))
954  {
956  "STATISTICS",
957  "DATABASE");
958  return;
959  }
960  if ((GNUNET_OK !=
962  (0 == fsize))
963  {
964  GNUNET_free (fn);
965  return;
966  }
967  buf = GNUNET_malloc (fsize);
969  if (! rh)
970  {
971  GNUNET_free (buf);
972  GNUNET_free (fn);
973  return;
974  }
975  if (GNUNET_OK != GNUNET_BIO_read (rh, fn, buf, fsize))
976  {
979  GNUNET_free (buf);
980  GNUNET_free (fn);
981  return;
982  }
984  _ ("Loading %llu bytes of statistics from `%s'\n"),
985  (unsigned long long) fsize,
986  fn);
987  mst = GNUNET_MST_create (&inject_message, NULL);
988  GNUNET_break (
989  GNUNET_OK ==
990  GNUNET_MST_from_buffer (mst, buf, (size_t) fsize, GNUNET_YES, GNUNET_NO));
991  GNUNET_MST_destroy (mst);
992  GNUNET_free (buf);
994  GNUNET_free (fn);
995 }
static int inject_message(void *cls, const struct GNUNET_MessageHeader *message)
We've read a struct GNUNET_STATISTICS_SetMessage * from disk.
static char buf[2048]
struct GNUNET_BIO_ReadHandle * GNUNET_BIO_read_open_file(const char *fn)
Open a file for reading.
Definition: bio.c:119
int GNUNET_BIO_read_close(struct GNUNET_BIO_ReadHandle *h, char **emsg)
Close an open handle.
Definition: bio.c:166
int GNUNET_BIO_read(struct GNUNET_BIO_ReadHandle *h, const char *what, void *result, size_t len)
Read some contents into a buffer.
Definition: bio.c:287
enum GNUNET_GenericReturnValue GNUNET_DISK_file_size(const char *filename, uint64_t *size, int include_symbolic_links, int single_file_mode)
Get the size of the file (or directory) of the given file (in bytes).
Definition: disk.c:222
void GNUNET_MST_destroy(struct GNUNET_MessageStreamTokenizer *mst)
Destroys a tokenizer.
Definition: mst.c:411
struct GNUNET_MessageStreamTokenizer * GNUNET_MST_create(GNUNET_MessageTokenizerCallback cb, void *cb_cls)
Create a message stream tokenizer.
Definition: mst.c:85
int GNUNET_MST_from_buffer(struct GNUNET_MessageStreamTokenizer *mst, const char *buf, size_t size, int purge, int one_shot)
Add incoming data to the receive buffer and call the callback for all complete messages.
Definition: mst.c:114
Handle for buffered reading.
Definition: bio.c:74
Handle to a message stream tokenizer.
Definition: mst.c:44

References _, buf, cfg, fn, GNUNET_BIO_read(), GNUNET_BIO_read_close(), GNUNET_BIO_read_open_file(), GNUNET_break, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_DISK_file_size(), GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_config_missing(), GNUNET_log_strerror_file, GNUNET_malloc, GNUNET_MST_create(), GNUNET_MST_destroy(), GNUNET_MST_from_buffer(), GNUNET_NO, GNUNET_OK, GNUNET_YES, and inject_message().

Referenced by calculate_load(), GNUNET_LOAD_get_average(), GNUNET_LOAD_get_load(), GNUNET_LOAD_value_set_decline(), internal_update(), and run().

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

◆ run()

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

Process statistics requests.

Parameters
clsclosure
cconfiguration to use
servicethe initialized service

Definition at line 1006 of file gnunet-service-statistics.c.

1009 {
1010  cfg = c;
1012  load ();
1014 }
static void shutdown_task(void *cls)
Task run during shutdown.
static void load()
Load persistent values from disk.
struct GNUNET_NotificationContext * GNUNET_notification_context_create(unsigned int queue_length)
Create a new notification context.
Definition: nc.c:121
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:1331

References cfg, GNUNET_notification_context_create(), GNUNET_SCHEDULER_add_shutdown(), load(), nc, and shutdown_task().

Here is the call graph for this function:

◆ GNUNET_SERVICE_MAIN()

Define "main" method using service macro.

Variable Documentation

◆ cfg

const struct GNUNET_CONFIGURATION_Handle* cfg
static

Our configuration.

Definition at line 206 of file gnunet-service-statistics.c.

Referenced by load(), run(), and save().

◆ sub_head

struct SubsystemEntry* sub_head
static

Head of linked list of subsystems with active statistics.

Definition at line 211 of file gnunet-service-statistics.c.

Referenced by client_disconnect_cb(), do_shutdown(), find_subsystem_entry(), handle_get(), and save().

◆ sub_tail

struct SubsystemEntry* sub_tail
static

Tail of linked list of subsystems with active statistics.

Definition at line 216 of file gnunet-service-statistics.c.

Referenced by do_shutdown(), find_subsystem_entry(), and save().

◆ client_count

unsigned int client_count
static

Number of connected clients.

Definition at line 221 of file gnunet-service-statistics.c.

Referenced by client_connect_cb(), client_disconnect_cb(), do_shutdown(), and shutdown_task().

◆ nc

struct GNUNET_NotificationContext* nc
static

Our notification context.

Definition at line 226 of file gnunet-service-statistics.c.

Referenced by client_connect_cb(), do_shutdown(), handle_watch(), and run().

◆ uidgen

uint32_t uidgen
static

Counter used to generate unique values.

Definition at line 231 of file gnunet-service-statistics.c.

Referenced by handle_set(), and handle_watch().

◆ in_shutdown

int in_shutdown
static

Set to GNUNET_YES if we are shutting down as soon as possible.

Definition at line 236 of file gnunet-service-statistics.c.

Referenced by client_disconnect_cb(), and shutdown_task().