gnunet-service-messenger_message_store.h File Reference

GNUnet MESSENGER service. More...

#include "platform.h"
#include "gnunet_container_lib.h"
#include "gnunet_disk_lib.h"

Include dependency graph for gnunet-service-messenger_message_store.h:

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

Go to the source code of this file.

Data Structures
struct	GNUNET_MESSENGER_MessageEntry
struct	GNUNET_MESSENGER_MessageStore

Functions
void	init_message_store (struct GNUNET_MESSENGER_MessageStore *store)
	Initializes a message store as fully empty. More...
void	clear_message_store (struct GNUNET_MESSENGER_MessageStore *store)
	Clears a message store, wipes its content and deallocates its memory. More...
void	load_message_store (struct GNUNET_MESSENGER_MessageStore *store, const char *directory)
	Loads messages from a directory into a message store. More...
void	save_message_store (struct GNUNET_MESSENGER_MessageStore *store, const char *directory)
	Saves messages from a message store into a directory. More...
int	contains_store_message (struct GNUNET_MESSENGER_MessageStore *store, const struct GNUNET_HashCode *hash)
	Checks if a message matching a given hash is stored in a message store. More...
const struct GNUNET_MESSENGER_Message *	get_store_message (struct GNUNET_MESSENGER_MessageStore *store, const struct GNUNET_HashCode *hash)
	Returns the message from a message store matching a given hash. More...
int	put_store_message (struct GNUNET_MESSENGER_MessageStore *store, const struct GNUNET_HashCode *hash, struct GNUNET_MESSENGER_Message *message)
	Stores a message into the message store. More...

Detailed Description

GNUnet MESSENGER service.

Author

Tobias Frisch

Definition in file gnunet-service-messenger_message_store.h.

Function Documentation

init_message_store()

void init_message_store

(

struct GNUNET_MESSENGER_MessageStore *

store

)

Initializes a message store as fully empty.

Parameters

store

Message store

Definition at line 30 of file gnunet-service-messenger_message_store.c.

References GNUNET_MESSENGER_MessageStore::entries, GNUNET_CONTAINER_multihashmap_create(), GNUNET_NO, GNUNET_MESSENGER_MessageStore::messages, and GNUNET_MESSENGER_MessageStore::storage_messages.

Referenced by create_room().

{
  store->storage_messages = NULL;

  store->entries = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);
  store->messages = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);
}

Here is the call graph for this function:

Here is the caller graph for this function:

clear_message_store()

void clear_message_store

(

struct GNUNET_MESSENGER_MessageStore *

store

)

Clears a message store, wipes its content and deallocates its memory.

Parameters

store

Message store

Definition at line 59 of file gnunet-service-messenger_message_store.c.

References GNUNET_MESSENGER_MessageStore::entries, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_DISK_file_close(), iterate_destroy_entries(), iterate_destroy_messages(), GNUNET_MESSENGER_MessageStore::messages, and GNUNET_MESSENGER_MessageStore::storage_messages.

Referenced by destroy_room().

{
  if (store->storage_messages)
  {
    GNUNET_DISK_file_close (store->storage_messages);

    store->storage_messages = NULL;
  }

  GNUNET_CONTAINER_multihashmap_iterate (store->entries, iterate_destroy_entries, NULL);
  GNUNET_CONTAINER_multihashmap_iterate (store->messages, iterate_destroy_messages, NULL);

  GNUNET_CONTAINER_multihashmap_destroy (store->entries);
  GNUNET_CONTAINER_multihashmap_destroy (store->messages);
}

Here is the call graph for this function:

Here is the caller graph for this function:

load_message_store()

void load_message_store	(	struct GNUNET_MESSENGER_MessageStore *	store,
		const char *	directory
	)

Loads messages from a directory into a message store.

Parameters

store	Message store
directory	Path to a directory

Definition at line 82 of file gnunet-service-messenger_message_store.c.

References GNUNET_MESSENGER_MessageStore::entries, entries, GNUNET_MESSENGER_MessageEntryStorage::entry, filename, GNUNET_asprintf(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_read(), GNUNET_DISK_file_test(), GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_free, GNUNET_memcpy, GNUNET_new, GNUNET_OK, GNUNET_YES, GNUNET_MESSENGER_MessageEntryStorage::hash, and GNUNET_MESSENGER_MessageStore::storage_messages.

Referenced by load_service_room_and_messages().

{
  enum GNUNET_DISK_AccessPermissions permission = (GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE);

  if (store->storage_messages)
    GNUNET_DISK_file_close (store->storage_messages);

  char *filename;
  GNUNET_asprintf (&filename, "%s%s", directory, "messages.store");

  if (GNUNET_YES == GNUNET_DISK_file_test (filename))
    store->storage_messages = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ, permission);
  else
    store->storage_messages = NULL;

  GNUNET_free(filename);

  if (!store->storage_messages)
    return;

  GNUNET_asprintf (&filename, "%s%s", directory, "entries.store");

  if (GNUNET_YES != GNUNET_DISK_file_test (filename))
    goto free_filename;

  struct GNUNET_DISK_FileHandle *entries = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ, permission);

  if (!entries)
    goto free_filename;

  struct GNUNET_MESSENGER_MessageEntryStorage storage;
  struct GNUNET_MESSENGER_MessageEntry *entry;

  do
  {
    entry = GNUNET_new(struct GNUNET_MESSENGER_MessageEntry);

    if (GNUNET_DISK_file_read (entries, &storage, sizeof(storage)) == sizeof(storage))
    {
      GNUNET_memcpy(entry, &(storage.entry), sizeof(*entry));

      if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (store->entries, &(storage.hash), entry,
                                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
        GNUNET_free(entry);
    }
    else
    {
      GNUNET_free(entry);

      entry = NULL;
    }
  }
  while (entry);

  GNUNET_DISK_file_close (entries);

free_filename:
  GNUNET_free(filename);
}

Here is the call graph for this function:

Here is the caller graph for this function:

save_message_store()

void save_message_store	(	struct GNUNET_MESSENGER_MessageStore *	store,
		const char *	directory
	)

Saves messages from a message store into a directory.

Parameters

store	Message store
directory	Path to a directory

Definition at line 181 of file gnunet-service-messenger_message_store.c.

References filename, GNUNET_asprintf(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_seek(), GNUNET_DISK_file_sync(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_READWRITE, GNUNET_DISK_OPEN_WRITE, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_DISK_SEEK_END, GNUNET_free, GNUNET_SYSERR, iterate_save_messages(), GNUNET_MESSENGER_MessageStore::messages, GNUNET_MESSENGER_MessageSave::storage_entries, GNUNET_MESSENGER_MessageStore::storage_messages, and GNUNET_MESSENGER_MessageSave::store.

Referenced by save_service_room_and_messages().

{
  struct GNUNET_MESSENGER_MessageSave save;

  enum GNUNET_DISK_AccessPermissions permission = (GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE);

  char *filename;
  GNUNET_asprintf (&filename, "%s%s", directory, "entries.store");

  save.store = store;
  save.storage_entries = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_CREATE, permission);

  GNUNET_free(filename);

  if (!save.storage_entries)
    return;

  if (GNUNET_SYSERR == GNUNET_DISK_file_seek (save.storage_entries, 0, GNUNET_DISK_SEEK_END))
    goto close_entries;

  if (store->storage_messages)
    GNUNET_DISK_file_close (store->storage_messages);

  GNUNET_asprintf (&filename, "%s%s", directory, "messages.store");

  store->storage_messages = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READWRITE | GNUNET_DISK_OPEN_CREATE,
                                                   permission);

  GNUNET_free(filename);

  if (store->storage_messages)
  {
    GNUNET_CONTAINER_multihashmap_iterate (store->messages, iterate_save_messages, &save);

    GNUNET_DISK_file_sync (store->storage_messages);
    GNUNET_DISK_file_sync (save.storage_entries);
  }

close_entries:
  GNUNET_DISK_file_close (save.storage_entries);
}

Here is the call graph for this function:

Here is the caller graph for this function:

contains_store_message()

int contains_store_message	(	struct GNUNET_MESSENGER_MessageStore *	store,
		const struct GNUNET_HashCode *	hash
	)

Checks if a message matching a given hash is stored in a message store.

The function returns GNUNET_YES if a match is found, GNUNET_NO otherwise.

The message has not to be loaded from disk into memory for this check!

Parameters

store	Message store
hash	Hash of message

Returns

GNUNET_YES on match, otherwise GNUNET_NO

Definition at line 224 of file gnunet-service-messenger_message_store.c.

References GNUNET_MESSENGER_MessageStore::entries, GNUNET_CONTAINER_multihashmap_contains(), GNUNET_YES, and GNUNET_MESSENGER_MessageStore::messages.

Referenced by callback_verify_room_message().

{
  if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_contains (store->messages, hash))
    return GNUNET_YES;

  return GNUNET_CONTAINER_multihashmap_contains (store->entries, hash);
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_store_message()

const struct GNUNET_MESSENGER_Message* get_store_message	(	struct GNUNET_MESSENGER_MessageStore *	store,
		const struct GNUNET_HashCode *	hash
	)

Returns the message from a message store matching a given hash.

If no matching message is found, NULL gets returned.

This function requires the message to be loaded into memory!

See also

contains_store_message()

Parameters

store	Message store
hash	Hash of message

Returns

Message or NULL

Definition at line 233 of file gnunet-service-messenger_message_store.c.

References create_message(), decode_message(), destroy_message(), GNUNET_MESSENGER_MessageStore::entries, GNUNET_CONTAINER_multihashmap_get(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_multihashmap_remove(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_DISK_file_read(), GNUNET_DISK_file_seek(), GNUNET_DISK_SEEK_SET, GNUNET_free, GNUNET_malloc, GNUNET_MESSENGER_KIND_UNKNOWN, GNUNET_OK, GNUNET_YES, GNUNET_MESSENGER_MessageEntry::length, GNUNET_MESSENGER_MessageStore::messages, GNUNET_MESSENGER_MessageEntry::offset, and GNUNET_MESSENGER_MessageStore::storage_messages.

Referenced by get_room_message().

{
  struct GNUNET_MESSENGER_Message *message = GNUNET_CONTAINER_multihashmap_get (store->messages, hash);

  if (message)
    return message;

  if (!store->storage_messages)
    return NULL;

  const struct GNUNET_MESSENGER_MessageEntry *entry = GNUNET_CONTAINER_multihashmap_get (store->entries, hash);

  if (!entry)
    return NULL;

  if (entry->offset != GNUNET_DISK_file_seek (store->storage_messages, entry->offset, GNUNET_DISK_SEEK_SET))
    return message;

  char *buffer = GNUNET_malloc(entry->length);

  if (GNUNET_DISK_file_read (store->storage_messages, buffer, entry->length) != entry->length)
    goto free_buffer;


  message = create_message (GNUNET_MESSENGER_KIND_UNKNOWN);

  if ((GNUNET_YES != decode_message (message, entry->length, buffer)) || (GNUNET_OK
      != GNUNET_CONTAINER_multihashmap_put (store->messages, hash, message,
                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST)))
  {
    destroy_message (message);

    message = NULL;

    GNUNET_CONTAINER_multihashmap_remove (store->entries, hash, entry);
  }

free_buffer:
  GNUNET_free(buffer);

  return message;
}

Here is the call graph for this function:

Here is the caller graph for this function:

put_store_message()

int put_store_message	(	struct GNUNET_MESSENGER_MessageStore *	store,
		const struct GNUNET_HashCode *	hash,
		struct GNUNET_MESSENGER_Message *	message
	)

Stores a message into the message store.

The result indicates if the operation was successful.

Parameters

store	Message store
hash	Hash of message
message	Message

Returns

GNUNET_OK on success, otherwise GNUNET_NO

Definition at line 277 of file gnunet-service-messenger_message_store.c.

References GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, and GNUNET_MESSENGER_MessageStore::messages.

Referenced by callback_room_recv(), and callback_room_sent().

{
  return GNUNET_CONTAINER_multihashmap_put (store->messages, hash, message,
                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
}

Here is the call graph for this function:

Here is the caller graph for this function: