GNUnet  0.11.x
gnunet-service-messenger_operation.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 
29 
32 {
33  GNUNET_assert(hash);
34 
36 
38  GNUNET_memcpy(&(op->hash), hash, sizeof(*hash));
40  op->store = NULL;
41  op->task = NULL;
42 
43  return op;
44 }
45 
46 void
48 {
49  GNUNET_assert(op);
50 
51  if (op->task)
53 
54  GNUNET_free(op);
55 }
56 
57 static void
58 callback_operation (void *cls);
59 
62 {
63  GNUNET_assert((store) && (path));
64 
66  struct GNUNET_MESSENGER_Operation* op = NULL;
67 
68  if (GNUNET_OK != GNUNET_CONFIGURATION_parse(cfg, path))
69  goto destroy_config;
70 
71  struct GNUNET_HashCode hash;
72 
73  if (GNUNET_OK != GNUNET_CONFIGURATION_get_data (cfg, "operation", "hash", &hash, sizeof(hash)))
74  goto destroy_config;
75 
76  op = create_operation(&hash);
77 
78  unsigned long long type_number;
79  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number(cfg, "operation", "type", &type_number))
80  switch (type_number)
81  {
84  break;
87  break;
90  break;
91  default:
92  break;
93  }
94 
95  if ((GNUNET_MESSENGER_OP_UNKNOWN == op->type) ||
96  (GNUNET_OK != GNUNET_CONFIGURATION_get_data (cfg, "operation", "timestamp", &(op->timestamp), sizeof(op->timestamp))))
97  {
99  op = NULL;
100  goto destroy_config;
101  }
102 
104 
106  delay,
109  op
110  );
111 
112  op->store = store;
113 
114 destroy_config:
116 
117  return op;
118 }
119 
120 void
121 save_operation (const struct GNUNET_MESSENGER_Operation *op, const char *path)
122 {
123  GNUNET_assert((path) && (op));
124 
126 
127  char *hash_data;
128  hash_data = GNUNET_STRINGS_data_to_string_alloc (&(op->hash), sizeof(op->hash));
129 
130  if (hash_data)
131  {
132  GNUNET_CONFIGURATION_set_value_string (cfg, "operation", "hash", hash_data);
133 
134  GNUNET_free(hash_data);
135  }
136 
137  GNUNET_CONFIGURATION_set_value_number(cfg, "operation", "type", op->type);
138 
139  char *timestamp_data;
140  timestamp_data = GNUNET_STRINGS_data_to_string_alloc (&(op->timestamp), sizeof(op->timestamp));
141 
142  if (timestamp_data)
143  {
144  GNUNET_CONFIGURATION_set_value_string (cfg, "operation", "timestamp", timestamp_data);
145 
146  GNUNET_free(timestamp_data);
147  }
148 
149  GNUNET_CONFIGURATION_write (cfg, path);
151 }
152 
153 extern void
156  const struct GNUNET_HashCode *hash);
157 
158 static void
160 {
161  struct GNUNET_MESSENGER_Operation *op = cls;
162 
163  op->task = NULL;
164 
165  callback_store_operation (op->store, op->type, &(op->hash));
166 }
167 
168 int
171  struct GNUNET_MESSENGER_OperationStore *store,
173 {
174  GNUNET_assert((op) && (store));
175 
176  if (op->task)
177  return GNUNET_SYSERR;
178 
179  const struct GNUNET_TIME_Absolute timestamp = GNUNET_TIME_absolute_add(
181  delay
182  );
183 
185  delay,
188  op
189  );
190 
191  op->type = type;
192  op->timestamp = timestamp;
193  op->store = store;
194 
195  return GNUNET_OK;
196 }
197 
198 int
200 {
201  GNUNET_assert(op);
202 
203  if (!op->task)
204  return GNUNET_SYSERR;
205 
207  op->task = NULL;
208 
211  op->store = NULL;
212 
213  return GNUNET_OK;
214 }
enum GNUNET_MESSENGER_OperationType type
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.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
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...
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed_with_priority(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1199
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_parse(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Parse a configuration file, add all of the options in the file to the configuration environment...
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
void GNUNET_CONFIGURATION_set_value_number(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long number)
Set a configuration value that should be a number.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
void destroy_operation(struct GNUNET_MESSENGER_Operation *op)
Destroys an operation and frees its memory fully.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_add(struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Relative duration)
Add a given relative duration to the given start time.
Definition: time.c:277
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
Run as background job (higher than idle, lower than default).
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_data(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, void *buf, size_t buf_size)
Get Crockford32-encoded fixed-size binary data from a configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Write configuration file.
struct GNUNET_MESSENGER_Operation * create_operation(const struct GNUNET_HashCode *hash)
Creates and allocates a new operation under a given hash.
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...
struct GNUNET_MESSENGER_OperationStore * store
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get_zero_(void)
Return absolute time of 0ms.
Definition: time.c:109
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
A 512-bit hashcode.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:86
GNUnet MESSENGER service.
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
configuration data
Definition: configuration.c:84
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:232
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Time for absolute times used by GNUnet, in microseconds.
char * GNUNET_STRINGS_data_to_string_alloc(const void *buf, size_t size)
Return the base32crockford encoding of the given buffer.
Definition: strings.c:937
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:144
static void callback_operation(void *cls)
#define GNUNET_free(ptr)
Wrapper around free.
Time for relative time used by GNUnet, in microseconds.
void callback_store_operation(struct GNUNET_MESSENGER_OperationStore *store, enum GNUNET_MESSENGER_OperationType type, const struct GNUNET_HashCode *hash)
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:972