GNUnet  0.17.5
gnunet-service-messenger_operation_store.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2021 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
27 
30 
31 void
33  struct GNUNET_MESSENGER_SrvRoom *room)
34 {
35  GNUNET_assert((store) && (room));
36 
37  store->room = room;
39 }
40 
41 static int
43  const struct GNUNET_HashCode *key,
44  void *value)
45 {
47 
49 
50  return GNUNET_YES;
51 }
52 
53 void
55 {
57 
60 }
61 
62 static int
64  const char *filename)
65 {
66  struct GNUNET_MESSENGER_OperationStore *store = cls;
67 
69  return GNUNET_OK;
70 
71  if ((strlen(filename) <= 4) || (0 != strcmp(filename + strlen(filename) - 4, ".cfg")))
72  return GNUNET_OK;
73 
75 
78  &(op->hash), op,
80  {
82  }
83 
84  return GNUNET_OK;
85 }
86 
87 void
89  const char *directory)
90 {
91  GNUNET_assert ((store) && (directory));
92 
93  char* load_dir;
94  GNUNET_asprintf (&load_dir, "%s%s%c", directory, "operations", DIR_SEPARATOR);
95 
98 
99  GNUNET_free(load_dir);
100 }
101 
102 static int
104  const struct GNUNET_HashCode *key,
105  void *value)
106 {
107  const char *save_dir = cls;
108 
110 
111  if (!op)
112  return GNUNET_YES;
113 
114  char *op_dir;
115  GNUNET_asprintf (&op_dir, "%s%s.cfg", save_dir, GNUNET_h2s(key));
116  save_operation(op, op_dir);
117 
118  GNUNET_free(op_dir);
119  return GNUNET_YES;
120 }
121 
122 void
124  const char *directory)
125 {
126  GNUNET_assert ((store) && (directory));
127 
128  char* save_dir;
129  GNUNET_asprintf (&save_dir, "%s%s%c", directory, "operations", DIR_SEPARATOR);
130 
131  if ((GNUNET_YES == GNUNET_DISK_directory_test (save_dir, GNUNET_NO)) ||
132  (GNUNET_OK == GNUNET_DISK_directory_create (save_dir)))
134 
135  GNUNET_free(save_dir);
136 }
137 
140  const struct GNUNET_HashCode *hash)
141 {
142  GNUNET_assert((store) && (hash));
143 
145 
146  if (!op)
148 
149  return op->type;
150 }
151 
152 int
154  const struct GNUNET_HashCode *hash,
157 {
158  GNUNET_assert((store) && (hash));
159 
161 
162  if (op)
163  goto use_op;
164 
166 
168  {
170 
171  return GNUNET_SYSERR;
172  }
173 
174 use_op:
175  if ((op->type != GNUNET_MESSENGER_OP_UNKNOWN) &&
177  stop_operation (op);
178 
179  return start_operation(op, type, store, delay);
180 }
181 
182 void
184  const struct GNUNET_HashCode *hash)
185 {
186  GNUNET_assert((store) && (hash));
187 
189 
190  if (!op)
191  return;
192 
194 
196  GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Canceled operation could not be removed: %s\n",
197  GNUNET_h2s(hash));
198 
200 }
201 
202 extern void
204  const struct GNUNET_HashCode *hash);
205 
206 extern void
208  const struct GNUNET_HashCode *hash);
209 
210 void
213  const struct GNUNET_HashCode *hash)
214 {
215  GNUNET_assert((store) && (hash));
216 
217  struct GNUNET_HashCode op_hash;
218  GNUNET_memcpy(&op_hash, hash, sizeof(op_hash));
219  cancel_store_operation (store, &op_hash);
220 
221  struct GNUNET_MESSENGER_SrvRoom *room = store->room;
222 
223  switch (type)
224  {
226  break;
228  callback_room_deletion (room, &op_hash);
229  break;
231  callback_room_merge (room, &op_hash);
232  break;
233  default:
234  break;
235  }
236 }
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:144
struct GNUNET_HashCode key
The key used in the DHT.
static char * filename
static char * value
Value of the record to add/remove.
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
int start_operation(struct GNUNET_MESSENGER_Operation *op, enum GNUNET_MESSENGER_OperationType type, struct GNUNET_MESSENGER_OperationStore *store, struct GNUNET_TIME_Relative delay)
Starts an inactive operation with a given delay in a specific operation store.
int stop_operation(struct GNUNET_MESSENGER_Operation *op)
Stops an active operation and resets its type to be GNUNET_MESSENGER_OP_UNKNOWN.
struct GNUNET_MESSENGER_Operation * load_operation(struct GNUNET_MESSENGER_OperationStore *store, const char *path)
Loads data from a configuration file at a selected path into a new allocated and created operation fo...
void save_operation(const struct GNUNET_MESSENGER_Operation *op, const char *path)
Saves data from an operation into a configuration file at a selected path which can be load to restor...
void destroy_operation(struct GNUNET_MESSENGER_Operation *op)
Destroys an operation and frees its memory fully.
struct GNUNET_MESSENGER_Operation * create_operation(const struct GNUNET_HashCode *hash)
Creates and allocates a new operation under a given hash.
GNUnet MESSENGER service.
void cancel_store_operation(struct GNUNET_MESSENGER_OperationStore *store, const struct GNUNET_HashCode *hash)
Stops any active operation under a given hash in a specific operation store.
void save_operation_store(const struct GNUNET_MESSENGER_OperationStore *store, const char *directory)
Saves operations from an operation store into a directory.
void clear_operation_store(struct GNUNET_MESSENGER_OperationStore *store)
Clears an operation store, stops all operations and deallocates its memory.
void callback_store_operation(struct GNUNET_MESSENGER_OperationStore *store, enum GNUNET_MESSENGER_OperationType type, const struct GNUNET_HashCode *hash)
static int iterate_save_operations(void *cls, const struct GNUNET_HashCode *key, void *value)
static int callback_scan_for_operations(void *cls, const char *filename)
void load_operation_store(struct GNUNET_MESSENGER_OperationStore *store, const char *directory)
Loads operations from a directory into an operation store.
enum GNUNET_MESSENGER_OperationType get_store_operation_type(const struct GNUNET_MESSENGER_OperationStore *store, const struct GNUNET_HashCode *hash)
Returns the type of the active operation under a given hash in a specific operation store.
void init_operation_store(struct GNUNET_MESSENGER_OperationStore *store, struct GNUNET_MESSENGER_SrvRoom *room)
Initializes an operation store as fully empty with a given room.
static int iterate_destroy_operations(void *cls, const struct GNUNET_HashCode *key, void *value)
void callback_room_deletion(struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_HashCode *hash)
void callback_room_merge(struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_HashCode *hash)
int use_store_operation(struct GNUNET_MESSENGER_OperationStore *store, const struct GNUNET_HashCode *hash, enum GNUNET_MESSENGER_OperationType type, struct GNUNET_TIME_Relative delay)
Tries to use an operation under a given hash in a specific operation store.
GNUnet MESSENGER service.
enum GNUNET_GenericReturnValue GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory).
Definition: disk.c:482
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_test(const char *fil, int is_readable)
Test if fil is a directory and listable.
Definition: disk.c:404
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create(const char *dir)
Implementation of "mkdir -p".
Definition: disk.c:496
int GNUNET_DISK_directory_scan(const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
Scan a directory for files.
Definition: disk.c:814
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap_remove(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, const void *value)
Remove the given key-value pair from the map.
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap_put(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
void * GNUNET_CONTAINER_multihashmap_get(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Given a key find a value in the map matching the key.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
, ' bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE...
#define GNUNET_log(kind,...)
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
@ GNUNET_OK
Definition: gnunet_common.h:99
@ GNUNET_YES
@ GNUNET_NO
Definition: gnunet_common.h:98
@ GNUNET_SYSERR
Definition: gnunet_common.h:97
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
@ GNUNET_ERROR_TYPE_WARNING
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define GNUNET_free(ptr)
Wrapper around free.
#define DIR_SEPARATOR
Definition: platform.h:164
A 512-bit hashcode.
struct GNUNET_CONTAINER_MultiHashMap * operations
struct GNUNET_MESSENGER_OperationStore * store
Time for relative time used by GNUnet, in microseconds.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model