6bb4ab865ca6243b373d78e534c196e1d8afde41
[oweals/gnunet.git] / src / fs / test_fs_download_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 3, 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_download_persistence.c
23  * @brief simple testcase for persistence of simple download operation
24  * @author Christian Grothoff
25  */
26
27 #include "platform.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_arm_service.h"
30 #include "gnunet_fs_service.h"
31
32 #define VERBOSE GNUNET_NO
33
34 #define START_ARM GNUNET_YES
35
36 /**
37  * File-size we use for testing.
38  */
39 #define FILESIZE (1024 * 1024 * 2)
40
41 /**
42  * How long until we give up on transmitting the message?
43  */
44 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
45
46 /**
47  * How long should our test-content live?
48  */ 
49 #define LIFETIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
50
51 struct PeerContext
52 {
53   struct GNUNET_CONFIGURATION_Handle *cfg;
54 #if START_ARM
55   GNUNET_OS_Process *arm_proc;
56 #endif
57 };
58
59 static struct PeerContext p1;
60
61 static struct GNUNET_TIME_Absolute start;
62
63 static struct GNUNET_SCHEDULER_Handle *sched;
64
65 static const struct GNUNET_CONFIGURATION_Handle *cfg;
66
67 static struct GNUNET_FS_Handle *fs;
68
69 static struct GNUNET_FS_DownloadContext *download;
70
71 static struct GNUNET_FS_PublishContext *publish;
72
73 static GNUNET_SCHEDULER_TaskIdentifier timeout_kill;
74
75 static char *fn;
76
77 static int err;
78
79 static void
80 timeout_kill_task (void *cls,
81                    const struct GNUNET_SCHEDULER_TaskContext *tc)
82 {
83   if (download != NULL)
84     {
85       GNUNET_FS_download_stop (download, GNUNET_YES);
86       download = NULL;
87     }
88   else if (publish != NULL)
89     {
90       GNUNET_FS_publish_stop (publish);
91       publish = NULL;
92     }
93   timeout_kill = GNUNET_SCHEDULER_NO_TASK;
94   err = 1;
95 }
96
97 static void
98 abort_publish_task (void *cls,
99                      const struct GNUNET_SCHEDULER_TaskContext *tc)
100 {
101   if (publish != NULL)
102     {
103       GNUNET_FS_publish_stop (publish);
104       publish = NULL;
105     }
106 }
107
108
109 static void
110 abort_download_task (void *cls,
111                      const struct GNUNET_SCHEDULER_TaskContext *tc)
112 {
113   uint64_t size;
114   
115   if (download != NULL)
116     {
117       GNUNET_FS_download_stop (download, GNUNET_YES);
118       download = NULL;
119     }
120   GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_size (fn, &size, GNUNET_YES));
121   GNUNET_assert (size == FILESIZE); 
122   GNUNET_DISK_directory_remove (fn);
123   GNUNET_free (fn);
124   fn = NULL;
125   GNUNET_SCHEDULER_cancel (sched, timeout_kill);
126   timeout_kill = GNUNET_SCHEDULER_NO_TASK;
127 }
128
129
130 static void *
131 progress_cb (void *cls, 
132              const struct GNUNET_FS_ProgressInfo *event);
133
134
135 static void
136 restart_fs_task (void *cls,
137                  const struct GNUNET_SCHEDULER_TaskContext *tc)
138 {
139   GNUNET_FS_stop (fs);
140   fs = GNUNET_FS_start (sched,
141                         cfg,
142                         "test-fs-download-persistence",
143                         &progress_cb,
144                         NULL,
145                         GNUNET_FS_FLAGS_PERSISTENCE,
146                         GNUNET_FS_OPTIONS_END);
147 }
148
149
150 /**
151  * Consider scheduling the restart-task. 
152  * Only runs the restart task once per event 
153  * category.
154  *
155  * @param ev type of the event to consider
156  */
157 static void
158 consider_restart (int ev)
159 {
160   static int prev[32];
161   static int off;
162   int i;
163   for (i=0;i<off;i++)
164     if (prev[i] == ev)
165       return;
166   prev[off++] = ev;
167   GNUNET_SCHEDULER_add_with_priority (sched,
168                                       GNUNET_SCHEDULER_PRIORITY_URGENT,
169                                       &restart_fs_task,
170                                       NULL);
171 }
172
173
174 static void *
175 progress_cb (void *cls, 
176              const struct GNUNET_FS_ProgressInfo *event)
177 {
178   switch (event->status)
179     {
180     case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
181 #if VERBOSE
182       printf ("Publish is progressing (%llu/%llu at level %u off %llu)...\n",
183               (unsigned long long) event->abs_value.publish.completed,
184               (unsigned long long) event->abs_value.publish.size,
185               event->abs_value.publish.specifics.progress.depth,
186               (unsigned long long) event->abs_value.publish.specifics.progress.offset);
187 #endif      
188       break;
189     case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
190       printf ("Publishing complete, %llu kbps.\n",
191               (unsigned long long) (FILESIZE * 1000LL / (1+GNUNET_TIME_absolute_get_duration (start).rel_value) / 1024LL));
192       fn = GNUNET_DISK_mktemp ("gnunet-download-test-dst");
193       start = GNUNET_TIME_absolute_get ();
194       GNUNET_assert (download == NULL);
195       GNUNET_FS_download_start (fs,
196                                 event->value.publish.specifics.completed.chk_uri,
197                                 NULL,
198                                 fn, NULL,
199                                 0,
200                                 FILESIZE,
201                                 1,
202                                 GNUNET_FS_DOWNLOAD_OPTION_NONE,
203                                 "download",
204                                 NULL);
205       break;
206     case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
207       consider_restart (event->status);
208       printf ("Download complete,  %llu kbps.\n",
209               (unsigned long long) (FILESIZE * 1000LL / (1+GNUNET_TIME_absolute_get_duration (start).rel_value) / 1024LL));
210       GNUNET_SCHEDULER_add_now (sched,
211                                 &abort_download_task,
212                                 NULL);
213       break;
214     case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
215       consider_restart (event->status);
216       GNUNET_assert (download == event->value.download.dc);
217 #if VERBOSE
218       printf ("Download is progressing (%llu/%llu at level %u off %llu)...\n",
219               (unsigned long long) event->abs_value.download.completed,
220               (unsigned long long) event->abs_value.download.size,
221               event->abs_value.download.specifics.progress.depth,
222               (unsigned long long) event->abs_value.download.specifics.progress.offset);
223 #endif
224       break;
225     case GNUNET_FS_STATUS_PUBLISH_ERROR:
226       fprintf (stderr,
227                "Error publishing file: %s\n",
228                event->value.publish.specifics.error.message);
229       GNUNET_break (0);
230       GNUNET_SCHEDULER_add_continuation (sched,
231                                          &abort_publish_task,
232                                          NULL,
233                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
234       break;
235     case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
236       fprintf (stderr,
237                "Error downloading file: %s\n",
238                event->value.download.specifics.error.message);
239       GNUNET_SCHEDULER_add_now (sched,
240                                 &abort_download_task,
241                                 NULL);
242       break;
243     case GNUNET_FS_STATUS_PUBLISH_SUSPEND:
244       GNUNET_assert (event->value.publish.pc == publish);
245       publish = NULL;
246       break;
247     case GNUNET_FS_STATUS_PUBLISH_RESUME:
248       GNUNET_assert (NULL == publish);
249       publish = event->value.publish.pc;
250       break;
251     case GNUNET_FS_STATUS_DOWNLOAD_SUSPEND:
252       GNUNET_assert (event->value.download.dc == download);
253       download = NULL;
254       break;
255     case GNUNET_FS_STATUS_DOWNLOAD_RESUME:
256       GNUNET_assert (NULL == download);
257       download = event->value.download.dc;
258       break;
259     case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
260       consider_restart (event->status);
261       break;
262     case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
263       consider_restart (event->status);
264       break;
265     case GNUNET_FS_STATUS_PUBLISH_START:
266       GNUNET_assert (0 == strcmp ("publish-context", event->value.publish.cctx));
267       GNUNET_assert (NULL == event->value.publish.pctx);
268       GNUNET_assert (FILESIZE == event->value.publish.size);
269       GNUNET_assert (0 == event->value.publish.completed);
270       GNUNET_assert (1 == event->value.publish.anonymity);
271       break;
272     case GNUNET_FS_STATUS_PUBLISH_STOPPED:
273       GNUNET_assert (publish == event->value.publish.pc);
274       GNUNET_assert (FILESIZE == event->value.publish.size);
275       GNUNET_assert (1 == event->value.publish.anonymity);
276       GNUNET_FS_stop (fs);
277       fs = NULL;
278       break;
279     case GNUNET_FS_STATUS_DOWNLOAD_START:
280       consider_restart (event->status);
281       GNUNET_assert (download == NULL);
282       download = event->value.download.dc;
283       GNUNET_assert (0 == strcmp ("download", event->value.download.cctx));
284       GNUNET_assert (NULL == event->value.download.pctx);
285       GNUNET_assert (NULL != event->value.download.uri);
286       GNUNET_assert (0 == strcmp (fn, event->value.download.filename));
287       GNUNET_assert (FILESIZE == event->value.download.size);
288       GNUNET_assert (0 == event->value.download.completed);
289       GNUNET_assert (1 == event->value.download.anonymity);
290       break;
291     case GNUNET_FS_STATUS_DOWNLOAD_STOPPED:
292       GNUNET_assert (download == event->value.download.dc);
293       GNUNET_SCHEDULER_add_continuation (sched,
294                                          &abort_publish_task,
295                                          NULL,
296                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
297       download = NULL;
298       break;
299     default:
300       printf ("Unexpected event: %d\n", 
301               event->status);
302       break;
303     }
304   return NULL;
305 }
306
307
308 static void
309 setup_peer (struct PeerContext *p, const char *cfgname)
310 {
311   p->cfg = GNUNET_CONFIGURATION_create ();
312 #if START_ARM
313   p->arm_proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
314                                         "gnunet-service-arm",
315 #if VERBOSE
316                                         "-L", "DEBUG",
317 #endif
318                                         "-c", cfgname, NULL);
319 #endif
320   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
321 }
322
323
324 static void
325 stop_arm (struct PeerContext *p)
326 {
327 #if START_ARM
328   if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
329     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
330   if (GNUNET_OS_process_wait(p->arm_proc) != GNUNET_OK)
331     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
332   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
333               "ARM process %u stopped\n", GNUNET_OS_process_get_pid (p->arm_proc));
334   GNUNET_OS_process_close (p->arm_proc);
335   p->arm_proc = NULL;
336 #endif
337   GNUNET_CONFIGURATION_destroy (p->cfg);
338 }
339
340
341 static void
342 run (void *cls,
343      struct GNUNET_SCHEDULER_Handle *s,
344      char *const *args,
345      const char *cfgfile,
346      const struct GNUNET_CONFIGURATION_Handle *c)
347 {
348   const char *keywords[] = {
349     "down_foo",
350     "down_bar",
351   };
352   char *buf;
353   struct GNUNET_CONTAINER_MetaData *meta;
354   struct GNUNET_FS_Uri *kuri;
355   struct GNUNET_FS_FileInformation *fi;
356   size_t i;
357
358   sched = s;
359   cfg = c;
360   setup_peer (&p1, "test_fs_download_data.conf");
361   fs = GNUNET_FS_start (sched,
362                         cfg,
363                         "test-fs-download-persistence",
364                         &progress_cb,
365                         NULL,
366                         GNUNET_FS_FLAGS_PERSISTENCE,
367                         GNUNET_FS_OPTIONS_END);
368   GNUNET_assert (NULL != fs); 
369   buf = GNUNET_malloc (FILESIZE);
370   for (i = 0; i < FILESIZE; i++)
371     buf[i] = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 256);
372   meta = GNUNET_CONTAINER_meta_data_create ();
373   kuri = GNUNET_FS_uri_ksk_create_from_args (2, keywords);
374   fi = GNUNET_FS_file_information_create_from_data (fs,
375                                                     "publish-context",
376                                                     FILESIZE,
377                                                     buf,
378                                                     kuri,
379                                                     meta,
380                                                     GNUNET_NO,
381                                                     1,
382                                                     42,
383                                                     GNUNET_TIME_relative_to_absolute (LIFETIME)); 
384   GNUNET_FS_uri_destroy (kuri);
385   GNUNET_CONTAINER_meta_data_destroy (meta);
386   GNUNET_assert (NULL != fi);
387   timeout_kill = GNUNET_SCHEDULER_add_delayed (sched,
388                                                TIMEOUT,
389                                                &timeout_kill_task,
390                                                NULL);
391   start = GNUNET_TIME_absolute_get ();
392   publish = GNUNET_FS_publish_start (fs,
393                                     fi,
394                                     NULL, NULL, NULL,
395                                     GNUNET_FS_PUBLISH_OPTION_NONE);
396   GNUNET_assert (publish != NULL);
397 }
398
399
400 int
401 main (int argc, char *argv[])
402 {
403   char *const argvx[] = { 
404     "test-fs-download-persistence",
405     "-c",
406     "test_fs_download_data.conf",
407 #if VERBOSE
408     "-L", "DEBUG",
409 #endif
410     NULL
411   };
412   struct GNUNET_GETOPT_CommandLineOption options[] = {
413     GNUNET_GETOPT_OPTION_END
414   };
415   GNUNET_log_setup ("test_fs_download_persistence", 
416 #if VERBOSE
417                     "DEBUG",
418 #else
419                     "WARNING",
420 #endif
421                     NULL);
422   GNUNET_DISK_directory_remove ("/tmp/gnunet-test-fs-download/");
423   GNUNET_PROGRAM_run ((sizeof (argvx) / sizeof (char *)) - 1,
424                       argvx, "test-fs-download-persistence",
425                       "nohelp", options, &run, NULL);
426   stop_arm (&p1);
427   GNUNET_DISK_directory_remove ("/tmp/gnunet-test-fs-download/");
428   return err;
429 }
430
431 /* end of test_fs_download_persistence.c */