fixing common off-by-one error with respect to maximum message size
[oweals/gnunet.git] / src / fs / test_fs_unindex_persistence.c
1 /*
2      This file is part of GNUnet.
3      (C) 2004, 2005, 2006, 2008, 2009, 2010 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 2, or (at your
8      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      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file fs/test_fs_unindex_persistence.c
23  * @brief simple testcase for simple publish + unindex operation
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_arm_service.h"
29 #include "gnunet_fs_service.h"
30
31 #define VERBOSE GNUNET_NO
32
33 #define START_ARM GNUNET_YES
34
35 /**
36  * File-size we use for testing.
37  */
38 #define FILESIZE (1024 * 1024 * 2)
39
40 /**
41  * How long until we give up on transmitting the message?
42  */
43 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
44
45 /**
46  * How long should our test-content live?
47  */ 
48 #define LIFETIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
49
50 struct PeerContext
51 {
52   struct GNUNET_CONFIGURATION_Handle *cfg;
53 #if START_ARM
54   pid_t arm_pid;
55 #endif
56 };
57
58 static struct PeerContext p1;
59
60 static struct GNUNET_TIME_Absolute start;
61
62 static struct GNUNET_SCHEDULER_Handle *sched;
63
64 static struct GNUNET_FS_Handle *fs;
65
66 static struct GNUNET_FS_UnindexContext *unindex;
67
68 static struct GNUNET_FS_PublishContext *publish;
69
70 static char *fn;
71
72 static const struct GNUNET_CONFIGURATION_Handle *cfg;
73
74 static void
75 abort_publish_task (void *cls,
76                      const struct GNUNET_SCHEDULER_TaskContext *tc)
77 {
78   GNUNET_FS_publish_stop (publish);
79   publish = NULL;
80 }
81
82
83 static void
84 abort_unindex_task (void *cls,
85                     const struct GNUNET_SCHEDULER_TaskContext *tc)
86 {
87   GNUNET_FS_unindex_stop (unindex);
88   unindex = NULL;
89   GNUNET_DISK_directory_remove (fn);
90   GNUNET_free (fn);
91   fn = NULL;
92 }
93
94
95 static void *
96 progress_cb (void *cls, 
97              const struct GNUNET_FS_ProgressInfo *event);
98
99
100 static void
101 restart_fs_task (void *cls,
102                  const struct GNUNET_SCHEDULER_TaskContext *tc)
103 {
104   GNUNET_FS_stop (fs);
105   fs = GNUNET_FS_start (sched,
106                         cfg,
107                         "test-fs-unindex-persistence",
108                         &progress_cb,
109                         NULL,
110                         GNUNET_FS_FLAGS_PERSISTENCE,
111                         GNUNET_FS_OPTIONS_END);
112 }
113
114
115 /**
116  * Consider scheduling the restart-task. 
117  * Only runs the restart task once per event 
118  * category.
119  *
120  * @param ev type of the event to consider
121  */
122 static void
123 consider_restart (int ev)
124 {
125   static int prev[32];
126   static int off;
127   int i;
128   for (i=0;i<off;i++)
129     if (prev[i] == ev)
130       return;
131   prev[off++] = ev;
132   GNUNET_SCHEDULER_add_with_priority (sched,
133                                       GNUNET_SCHEDULER_PRIORITY_URGENT,
134                                       &restart_fs_task,
135                                       NULL);
136 }
137
138
139 static void *
140 progress_cb (void *cls, 
141              const struct GNUNET_FS_ProgressInfo *event)
142 {
143   switch (event->status)
144     {
145     case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
146 #if VERBOSE
147       printf ("Publish is progressing (%llu/%llu at level %u off %llu)...\n",
148               (unsigned long long) event->value.publish.completed,
149               (unsigned long long) event->value.publish.size,
150               event->value.publish.specifics.progress.depth,
151               (unsigned long long) event->value.publish.specifics.progress.offset);
152 #endif      
153       break;
154     case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
155       printf ("Publishing complete, %llu kbps.\n",
156               (unsigned long long) (FILESIZE * 1000 / (1+GNUNET_TIME_absolute_get_duration (start).value) / 1024));
157       start = GNUNET_TIME_absolute_get ();
158       unindex = GNUNET_FS_unindex_start (fs,
159                                          fn,
160                                          "unindex");
161       GNUNET_assert (unindex != NULL);
162       break;
163     case GNUNET_FS_STATUS_UNINDEX_COMPLETED:
164       printf ("Unindex complete,  %llu kbps.\n",
165               (unsigned long long) (FILESIZE * 1000 / (1+GNUNET_TIME_absolute_get_duration (start).value) / 1024));
166       GNUNET_SCHEDULER_add_continuation (sched,
167                                          &abort_unindex_task,
168                                          NULL,
169                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
170       break;
171     case GNUNET_FS_STATUS_UNINDEX_PROGRESS:
172       consider_restart (event->status);
173       GNUNET_assert (unindex == event->value.unindex.uc);
174 #if VERBOSE
175       printf ("Unindex is progressing (%llu/%llu at level %u off %llu)...\n",
176               (unsigned long long) event->value.unindex.completed,
177               (unsigned long long) event->value.unindex.size,
178               event->value.unindex.specifics.progress.depth,
179               (unsigned long long) event->value.unindex.specifics.progress.offset);
180 #endif
181       break;
182     case GNUNET_FS_STATUS_PUBLISH_SUSPEND:
183       if  (event->value.publish.pc == publish)
184         publish = NULL;
185       break;
186     case GNUNET_FS_STATUS_PUBLISH_RESUME:
187       if (NULL == publish)
188         {
189           publish = event->value.publish.pc;
190           return "publish-context";
191         }
192       break;
193     case GNUNET_FS_STATUS_UNINDEX_SUSPEND:
194       GNUNET_assert (event->value.unindex.uc == unindex);
195       unindex = NULL;
196       break;
197     case GNUNET_FS_STATUS_UNINDEX_RESUME:
198       GNUNET_assert (NULL == unindex);
199       unindex = event->value.unindex.uc;
200       return "unindex";
201     case GNUNET_FS_STATUS_PUBLISH_ERROR:
202       fprintf (stderr,
203                "Error publishing file: %s\n",
204                event->value.publish.specifics.error.message);
205       GNUNET_break (0);
206       GNUNET_SCHEDULER_add_continuation (sched,
207                                          &abort_publish_task,
208                                          NULL,
209                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
210       break;
211     case GNUNET_FS_STATUS_UNINDEX_ERROR:
212       fprintf (stderr,
213                "Error unindexing file: %s\n",
214                event->value.unindex.specifics.error.message);
215       GNUNET_SCHEDULER_add_continuation (sched,
216                                          &abort_unindex_task,
217                                          NULL,
218                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
219       break;
220     case GNUNET_FS_STATUS_PUBLISH_START:
221       GNUNET_assert (0 == strcmp ("publish-context", event->value.publish.cctx));
222       GNUNET_assert (NULL == event->value.publish.pctx);
223       GNUNET_assert (FILESIZE == event->value.publish.size);
224       GNUNET_assert (0 == event->value.publish.completed);
225       GNUNET_assert (1 == event->value.publish.anonymity);
226       break;
227     case GNUNET_FS_STATUS_PUBLISH_STOPPED:
228       GNUNET_assert (publish == event->value.publish.pc);
229       GNUNET_assert (FILESIZE == event->value.publish.size);
230       GNUNET_assert (1 == event->value.publish.anonymity);
231       GNUNET_FS_stop (fs);
232       fs = NULL;
233       break;
234     case GNUNET_FS_STATUS_UNINDEX_START:
235       consider_restart (event->status);
236       GNUNET_assert (unindex == NULL);
237       GNUNET_assert (0 == strcmp ("unindex", event->value.unindex.cctx));
238       GNUNET_assert (0 == strcmp (fn, event->value.unindex.filename));
239       GNUNET_assert (FILESIZE == event->value.unindex.size);
240       GNUNET_assert (0 == event->value.unindex.completed);
241       break;
242     case GNUNET_FS_STATUS_UNINDEX_STOPPED:
243       GNUNET_assert (unindex == event->value.unindex.uc);
244       GNUNET_SCHEDULER_add_continuation (sched,
245                                          &abort_publish_task,
246                                          NULL,
247                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
248       break;
249     default:
250       printf ("Unexpected event: %d\n", 
251               event->status);
252       break;
253     }
254   return NULL;
255 }
256
257
258 static void
259 setup_peer (struct PeerContext *p, const char *cfgname)
260 {
261   p->cfg = GNUNET_CONFIGURATION_create ();
262 #if START_ARM
263   p->arm_pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
264                                         "gnunet-service-arm",
265 #if VERBOSE
266                                         "-L", "DEBUG",
267 #endif
268                                         "-c", cfgname, NULL);
269 #endif
270   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
271 }
272
273
274 static void
275 stop_arm (struct PeerContext *p)
276 {
277 #if START_ARM
278   if (0 != PLIBC_KILL (p->arm_pid, SIGTERM))
279     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
280   if (GNUNET_OS_process_wait(p->arm_pid) != GNUNET_OK)
281     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
282   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
283               "ARM process %u stopped\n", p->arm_pid);
284 #endif
285   GNUNET_CONFIGURATION_destroy (p->cfg);
286 }
287
288
289 static void
290 run (void *cls,
291      struct GNUNET_SCHEDULER_Handle *s,
292      char *const *args,
293      const char *cfgfile,
294      const struct GNUNET_CONFIGURATION_Handle *c)
295 {
296   const char *keywords[] = {
297     "down_foo",
298     "down_bar",
299   };
300   char *buf;
301   struct GNUNET_CONTAINER_MetaData *meta;
302   struct GNUNET_FS_Uri *kuri;
303   struct GNUNET_FS_FileInformation *fi;
304   size_t i;
305
306   sched = s;
307   cfg = c;
308   setup_peer (&p1, "test_fs_unindex_data.conf");
309   fn = GNUNET_DISK_mktemp ("gnunet-unindex-test-dst");
310   fs = GNUNET_FS_start (sched,
311                         cfg,
312                         "test-fs-unindex-persistence",
313                         &progress_cb,
314                         NULL,
315                         GNUNET_FS_FLAGS_PERSISTENCE,
316                         GNUNET_FS_OPTIONS_END);
317   GNUNET_assert (NULL != fs); 
318   buf = GNUNET_malloc (FILESIZE);
319   for (i = 0; i < FILESIZE; i++)
320     buf[i] = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 256);
321   GNUNET_assert (FILESIZE ==
322                  GNUNET_DISK_fn_write (fn,
323                                        buf,
324                                        FILESIZE,
325                                        GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE));
326   GNUNET_free (buf);
327   meta = GNUNET_CONTAINER_meta_data_create ();
328   kuri = GNUNET_FS_uri_ksk_create_from_args (2, keywords);
329   fi = GNUNET_FS_file_information_create_from_file (fs,
330                                                     "publish-context",
331                                                     fn,
332                                                     kuri,
333                                                     meta,
334                                                     GNUNET_YES,
335                                                     1,
336                                                     42,
337                                                     GNUNET_TIME_relative_to_absolute (LIFETIME)); 
338   GNUNET_FS_uri_destroy (kuri);
339   GNUNET_CONTAINER_meta_data_destroy (meta);
340   GNUNET_assert (NULL != fi);
341   start = GNUNET_TIME_absolute_get ();
342   publish = GNUNET_FS_publish_start (fs,
343                                     fi,
344                                     NULL, NULL, NULL,
345                                     GNUNET_FS_PUBLISH_OPTION_NONE);
346   GNUNET_assert (publish != NULL);
347 }
348
349
350 int
351 main (int argc, char *argv[])
352 {
353   char *const argvx[] = { 
354     "test-fs-unindex",
355     "-c",
356     "test_fs_unindex_data.conf",
357 #if VERBOSE
358     "-L", "DEBUG",
359 #endif
360     NULL
361   };
362   struct GNUNET_GETOPT_CommandLineOption options[] = {
363     GNUNET_GETOPT_OPTION_END
364   };
365
366   GNUNET_log_setup ("test_fs_unindex_persistence", 
367 #if VERBOSE
368                     "DEBUG",
369 #else
370                     "WARNING",
371 #endif
372                     NULL);
373   GNUNET_PROGRAM_run ((sizeof (argvx) / sizeof (char *)) - 1,
374                       argvx, "test-fs-unindex",
375                       "nohelp", options, &run, NULL);
376   stop_arm (&p1);
377   GNUNET_DISK_directory_remove ("/tmp/gnunet-test-fs-unindex/");
378   if (NULL != fn)
379     {
380       GNUNET_DISK_directory_remove (fn);
381       GNUNET_free (fn);
382     }
383   return 0;
384 }
385
386 /* end of test_fs_unindex_persistence.c */