X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Ffs%2Ffs_api.c;h=f539c7910f1f5f7c220ef82fd0e223c766b132bc;hb=ed51bc86aad5044b88ce4fc3641cc920c8186863;hp=3b8d125ad347e9581ecc35c4aad629a6c1df60ee;hpb=e0ca7357cd0bfedc5c29cb731b56279fef8da059;p=oweals%2Fgnunet.git diff --git a/src/fs/fs_api.c b/src/fs/fs_api.c index 3b8d125ad..f539c7910 100644 --- a/src/fs/fs_api.c +++ b/src/fs/fs_api.c @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - (C) 2001--2012 Christian Grothoff (and other contributing authors) + Copyright (C) 2001--2012 Christian Grothoff (and other contributing authors) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -65,9 +65,13 @@ start_job (struct GNUNET_FS_QueueEntry *qe) "Starting job %p (%u active)\n", qe, qe->h->active_downloads); - GNUNET_CONTAINER_DLL_remove (qe->h->pending_head, qe->h->pending_tail, qe); - GNUNET_CONTAINER_DLL_insert_after (qe->h->running_head, qe->h->running_tail, - qe->h->running_tail, qe); + GNUNET_CONTAINER_DLL_remove (qe->h->pending_head, + qe->h->pending_tail, + qe); + GNUNET_CONTAINER_DLL_insert_after (qe->h->running_head, + qe->h->running_tail, + qe->h->running_tail, + qe); } @@ -103,11 +107,12 @@ stop_job (struct GNUNET_FS_QueueEntry *qe) * Process the jobs in the job queue, possibly starting some * and stopping others. * - * @param cls the 'struct GNUNET_FS_Handle' + * @param cls the `struct GNUNET_FS_Handle *` * @param tc scheduler context */ static void -process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) +process_job_queue (void *cls, + const struct GNUNET_SCHEDULER_TaskContext *tc) { struct GNUNET_FS_Handle *h = cls; struct GNUNET_FS_QueueEntry *qe; @@ -126,7 +131,7 @@ process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) int num_downloads_change; int block_limit_hit; - h->queue_job = GNUNET_SCHEDULER_NO_TASK; + h->queue_job = NULL; /* restart_at will be set to the time when it makes sense to re-evaluate the job queue (unless, of course, jobs complete or are added, then we'll be triggered immediately */ @@ -197,6 +202,8 @@ process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) break; } } + GNUNET_break (h->active_downloads == + num_downloads_active + num_probes_active); GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "PA: %u, PE: %u, PW: %u; DA: %u, DE: %u, DW: %u\n", num_probes_active, @@ -205,26 +212,36 @@ process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) num_downloads_active, num_downloads_expired, num_downloads_waiting); + GNUNET_break (h->active_downloads + num_probes_active <= + h->max_parallel_downloads); /* calculate start/stop decisions */ - if (h->active_downloads + num_downloads_waiting > h->max_parallel_requests) + if (h->active_downloads + num_downloads_waiting > h->max_parallel_downloads) { - /* stop probes if possible */ - num_probes_change = - num_probes_active; - num_downloads_change = h->max_parallel_requests - h->active_downloads; + /* stop as many probes as there are downloads and probes */ + num_probes_change = - GNUNET_MIN (num_probes_active, + num_downloads_waiting); + /* start as many downloads as there are free slots, including those + we just opened up */ + num_downloads_change = h->max_parallel_downloads - h->active_downloads - num_probes_change; } else { - /* start all downloads */ + /* start all downloads (we can) */ num_downloads_change = num_downloads_waiting; - /* start as many probes as we can */ - num_probes_change = GNUNET_MIN (num_probes_waiting, - h->max_parallel_requests - (h->active_downloads + num_downloads_waiting)); - } - + /* also start probes if there is room, but use a lower cap of (mpd/4) + 1 */ + if (1 + h->max_parallel_downloads / 4 >= (h->active_downloads + num_downloads_change)) + num_probes_change = GNUNET_MIN (num_probes_waiting, + (1 + h->max_parallel_downloads / 4) - (h->active_downloads + num_downloads_change)); + else + num_probes_change = 0; + } + GNUNET_break (num_downloads_change <= num_downloads_waiting); GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, - "Changing %d probes and %d downloads\n", + "Changing %d probes and %d/%u/%u downloads\n", num_probes_change, - num_downloads_change); + num_downloads_change, + (unsigned int) h->active_downloads, + (unsigned int) h->max_parallel_downloads); /* actually stop probes */ next = h->running_head; while (NULL != (qe = next)) @@ -278,7 +295,8 @@ process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) break; } } - GNUNET_break ( (0 == num_downloads_change) || (GNUNET_YES == block_limit_hit) ); + GNUNET_break ( (0 == num_downloads_change) || + (GNUNET_YES == block_limit_hit) ); GNUNET_break (0 == num_probes_change); GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, @@ -307,8 +325,10 @@ process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) * @return queue handle */ struct GNUNET_FS_QueueEntry * -GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start, - GNUNET_FS_QueueStop stop, void *cls, unsigned int blocks, +GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, + GNUNET_FS_QueueStart start, + GNUNET_FS_QueueStop stop, void *cls, + unsigned int blocks, enum GNUNET_FS_QueuePriority priority) { struct GNUNET_FS_QueueEntry *qe; @@ -323,7 +343,7 @@ GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start, qe->priority = priority; GNUNET_CONTAINER_DLL_insert_after (h->pending_head, h->pending_tail, h->pending_tail, qe); - if (h->queue_job != GNUNET_SCHEDULER_NO_TASK) + if (h->queue_job != NULL) GNUNET_SCHEDULER_cancel (h->queue_job); h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h); GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, @@ -351,7 +371,7 @@ GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe) stop_job (qe); GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, qe); GNUNET_free (qe); - if (h->queue_job != GNUNET_SCHEDULER_NO_TASK) + if (h->queue_job != NULL) GNUNET_SCHEDULER_cancel (h->queue_job); h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h); } @@ -362,11 +382,12 @@ GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe) * * @param h global fs handle * @param ssf suspend signal function to use - * @param ssf_cls closure for ssf + * @param ssf_cls closure for @a ssf * @return fresh top-level activity handle */ struct TopLevelActivity * -GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf, +GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, + SuspendSignalFunction ssf, void *ssf_cls) { struct TopLevelActivity *ret; @@ -386,16 +407,16 @@ GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf, * @param top top level activity entry */ void -GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top) +GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, + struct TopLevelActivity *top) { GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top); GNUNET_free (top); } - /** - * Closure for "data_reader_file". + * Closure for #GNUNET_FS_data_reader_file_(). */ struct FileInfo { @@ -414,25 +435,28 @@ struct FileInfo /** * Function that provides data by reading from a file. * - * @param cls closure (points to the file information) + * @param cls closure with the `struct FileInfo *` * @param offset offset to read from; it is possible * that the caller might need to go backwards - * a bit at times; set to UINT64_MAX to tell + * a bit at times; set to `UINT64_MAX` to tell * the reader that we won't be reading for a while * (used to close the file descriptor but NOT fully * clean up the reader's state); in this case, - * a value of '0' for max should be ignored + * a value of '0' for @a max should be ignored * @param max maximum number of bytes that should be - * copied to buf; readers are not allowed + * copied to @a buf; readers are not allowed * to provide less data unless there is an error; * a value of "0" will be used at the end to allow * the reader to clean up its internal state * @param buf where the reader should write the data * @param emsg location for the reader to store an error message - * @return number of bytes written, usually "max", 0 on error + * @return number of bytes written, usually @a max, 0 on error */ size_t -GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf, +GNUNET_FS_data_reader_file_ (void *cls, + uint64_t offset, + size_t max, + void *buf, char **emsg) { struct FileInfo *fi = cls; @@ -458,11 +482,14 @@ GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf, if (NULL == fi->fd) { fi->fd = - GNUNET_DISK_file_open (fi->filename, GNUNET_DISK_OPEN_READ, + GNUNET_DISK_file_open (fi->filename, + GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE); if (NULL == fi->fd) { - GNUNET_asprintf (emsg, _("Could not open file `%s': %s"), fi->filename, + GNUNET_asprintf (emsg, + _("Could not open file `%s': %s"), + fi->filename, STRERROR (errno)); return 0; } @@ -471,13 +498,16 @@ GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf, GNUNET_DISK_file_seek (fi->fd, offset, GNUNET_DISK_SEEK_SET)) || (-1 == (ret = GNUNET_DISK_file_read (fi->fd, buf, max))) ) { - GNUNET_asprintf (emsg, _("Could not read file `%s': %s"), fi->filename, + GNUNET_asprintf (emsg, + _("Could not read file `%s': %s"), + fi->filename, STRERROR (errno)); return 0; } if (ret != max) { - GNUNET_asprintf (emsg, _("Short read reading from file `%s'!"), + GNUNET_asprintf (emsg, + _("Short read reading from file `%s'!"), fi->filename); return 0; } @@ -486,7 +516,7 @@ GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf, /** - * Create the closure for the 'GNUNET_FS_data_reader_file_' callback. + * Create the closure for the #GNUNET_FS_data_reader_file_() callback. * * @param filename file to read * @return closure to use, NULL on error @@ -513,22 +543,25 @@ GNUNET_FS_make_file_reader_context_ (const char *filename) * @param cls closure (points to the buffer) * @param offset offset to read from; it is possible * that the caller might need to go backwards - * a bit at times; set to UINT64_MAX to tell + * a bit at times; set to `UINT64_MAX` to tell * the reader that we won't be reading for a while * (used to close the file descriptor but NOT fully * clean up the reader's state); in this case, - * a value of '0' for max should be ignored + * a value of '0' for @a max should be ignored * @param max maximum number of bytes that should be - * copied to buf; readers are not allowed + * copied to @a buf; readers are not allowed * to provide less data unless there is an error; * a value of "0" will be used at the end to allow * the reader to clean up its internal state * @param buf where the reader should write the data * @param emsg location for the reader to store an error message - * @return number of bytes written, usually "max", 0 on error + * @return number of bytes written, usually @a max, 0 on error */ size_t -GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf, +GNUNET_FS_data_reader_copy_ (void *cls, + uint64_t offset, + size_t max, + void *buf, char **emsg) { char *data = cls; @@ -555,7 +588,8 @@ GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf, * @return NULL on error */ static char * -get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext, +get_serialization_file_name (struct GNUNET_FS_Handle *h, + const char *ext, const char *ent) { char *basename; @@ -587,8 +621,10 @@ get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext, * @return NULL on error */ static char * -get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext, - const char *uni, const char *ent) +get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, + const char *ext, + const char *uni, + const char *ent) { char *basename; char *ret; @@ -616,7 +652,9 @@ get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext, * @return NULL on error */ static struct GNUNET_BIO_ReadHandle * -get_read_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent) +get_read_handle (struct GNUNET_FS_Handle *h, + const char *ext, + const char *ent) { char *fn; struct GNUNET_BIO_ReadHandle *ret; @@ -639,7 +677,9 @@ get_read_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent) * @return NULL on error */ static struct GNUNET_BIO_WriteHandle * -get_write_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent) +get_write_handle (struct GNUNET_FS_Handle *h, + const char *ext, + const char *ent) { char *fn; struct GNUNET_BIO_WriteHandle *ret; @@ -687,7 +727,8 @@ get_write_handle_in_dir (struct GNUNET_FS_Handle *h, const char *ext, * @param ent entity identifier */ void -GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext, +GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, + const char *ext, const char *ent) { char *filename; @@ -700,7 +741,8 @@ GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext, filename = get_serialization_file_name (h, ext, ent); if (NULL != filename) { - if (0 != UNLINK (filename)) + if ( (0 != UNLINK (filename)) && + (ENOENT != errno) ) GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename); GNUNET_free (filename); } @@ -716,7 +758,8 @@ GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext, * @param ent entity identifier */ static void -remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext, +remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, + const char *ext, const char *uni, const char *ent) { char *filename; @@ -743,7 +786,8 @@ remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext, * @param uni unique name of parent */ void -GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext, +GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, + const char *ext, const char *uni) { char *dn; @@ -761,7 +805,7 @@ GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext, /** - * Serialize a 'start_time'. Since we use start-times to + * Serialize a start-time. Since we use start-times to * calculate the duration of some operation, we actually * do not serialize the absolute time but the (relative) * duration since the start time. When we then @@ -772,7 +816,7 @@ GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext, * * @param wh handle for writing * @param timestamp time to serialize - * @return GNUNET_OK on success + * @return #GNUNET_OK on success */ static int write_start_time (struct GNUNET_BIO_WriteHandle *wh, @@ -786,10 +830,10 @@ write_start_time (struct GNUNET_BIO_WriteHandle *wh, /** - * Serialize a 'start_time'. Since we use start-times to + * Deserialize a start-time. Since we use start-times to * calculate the duration of some operation, we actually * do not serialize the absolute time but the (relative) - * duration since the start time. When we then + * duration since the start time. Thus, when we then * deserialize the start time, we take the current time and * subtract that duration so that we get again an absolute * time stamp that will result in correct performance @@ -822,7 +866,8 @@ read_start_time (struct GNUNET_BIO_ReadHandle *rh, * @return NULL on error */ static struct GNUNET_FS_FileInformation * -deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename); +deserialize_file_information (struct GNUNET_FS_Handle *h, + const char *filename); /** @@ -836,7 +881,8 @@ deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename); * @return NULL on error */ static struct GNUNET_FS_FileInformation * -deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn, +deserialize_fi_node (struct GNUNET_FS_Handle *h, + const char *fn, struct GNUNET_BIO_ReadHandle *rh) { struct GNUNET_FS_FileInformation *ret; @@ -844,6 +890,7 @@ deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn, char b; char *ksks; char *chks; + char *skss; char *filename; uint32_t dsize; @@ -856,6 +903,7 @@ deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn, ret->h = h; ksks = NULL; chks = NULL; + skss = NULL; filename = NULL; if ((GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) || (GNUNET_OK != GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32 * 1024)) || @@ -866,6 +914,10 @@ deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn, ( (NULL != chks) && ( (NULL == (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) || (GNUNET_YES != GNUNET_FS_uri_test_chk (ret->chk_uri))) ) || + (GNUNET_OK != GNUNET_BIO_read_string (rh, "sks-uri", &skss, 1024)) || + ( (NULL != skss) && + ( (NULL == (ret->sks_uri = GNUNET_FS_uri_parse (skss, NULL))) || + (GNUNET_YES != GNUNET_FS_uri_test_sks (ret->sks_uri))) ) || (GNUNET_OK != read_start_time (rh, &ret->start_time)) || (GNUNET_OK != GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16 * 1024)) || (GNUNET_OK != @@ -1025,11 +1077,13 @@ deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn, filename = NULL; } GNUNET_free_non_null (ksks); + GNUNET_free_non_null (skss); GNUNET_free_non_null (chks); return ret; cleanup: GNUNET_free_non_null (ksks); GNUNET_free_non_null (chks); + GNUNET_free_non_null (skss); GNUNET_free_non_null (filename); GNUNET_FS_file_information_destroy (ret, NULL, NULL); return NULL; @@ -1122,7 +1176,8 @@ get_serialization_short_name (const char *fullname) * @return NULL on errror */ static char * -make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext) +make_serialization_file_name (struct GNUNET_FS_Handle *h, + const char *ext) { char *fn; char *dn; @@ -1159,7 +1214,8 @@ make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext) */ static char * make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, - const char *ext, const char *uni) + const char *ext, + const char *uni) { char *fn; char *dn; @@ -1224,7 +1280,7 @@ copy_from_reader (struct GNUNET_BIO_WriteHandle *wh, /** * Create a temporary file on disk to store the current - * state of "fi" in. + * state of @a fi in. * * @param fi file information to sync with disk */ @@ -1236,6 +1292,7 @@ GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi) char b; char *ksks; char *chks; + char *skss; if (NULL == fi->serialization) fi->serialization = @@ -1268,10 +1325,15 @@ GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi) chks = GNUNET_FS_uri_to_string (fi->chk_uri); else chks = NULL; + if (NULL != fi->sks_uri) + skss = GNUNET_FS_uri_to_string (fi->sks_uri); + else + skss = NULL; if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) || (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) || (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) || + (GNUNET_OK != GNUNET_BIO_write_string (wh, skss)) || (GNUNET_OK != write_start_time (wh, fi->start_time)) || (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) || (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) || @@ -1288,6 +1350,8 @@ GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi) chks = NULL; GNUNET_free_non_null (ksks); ksks = NULL; + GNUNET_free_non_null (skss); + skss = NULL; switch (b) { @@ -1379,6 +1443,7 @@ cleanup: (void) GNUNET_BIO_write_close (wh); GNUNET_free_non_null (chks); GNUNET_free_non_null (ksks); + GNUNET_free_non_null (skss); fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO, fi->serialization); if (NULL != fn) @@ -1435,10 +1500,13 @@ find_file_position (struct GNUNET_FS_FileInformation *pos, * @return #GNUNET_OK to continue (always) */ static int -fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi, - uint64_t length, struct GNUNET_CONTAINER_MetaData *meta, +fip_signal_resume (void *cls, + struct GNUNET_FS_FileInformation *fi, + uint64_t length, + struct GNUNET_CONTAINER_MetaData *meta, struct GNUNET_FS_Uri **uri, - struct GNUNET_FS_BlockOptions *bo, int *do_index, + struct GNUNET_FS_BlockOptions *bo, + int *do_index, void **client_info) { struct GNUNET_FS_PublishContext *pc = cls; @@ -1472,7 +1540,8 @@ fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi, * @return #GNUNET_OK (continue to iterate) */ static int -deserialize_publish_file (void *cls, const char *filename) +deserialize_publish_file (void *cls, + const char *filename) { struct GNUNET_FS_Handle *h = cls; struct GNUNET_BIO_ReadHandle *rh; @@ -1557,7 +1626,7 @@ deserialize_publish_file (void *cls, const char *filename) /* re-start publishing (if needed)... */ if (GNUNET_YES != pc->all_done) { - GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task); + GNUNET_assert (NULL == pc->upload_task); pc->upload_task = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_BACKGROUND, @@ -1731,7 +1800,7 @@ cleanup: /** * Serialize a download request. * - * @param wh the `struct GNUNET_BIO_WriteHandle*` + * @param wh handle for writing the download request to disk * @param dr the the request to write to disk * @return #GNUNET_YES on success, #GNUNET_NO on error */ @@ -1760,7 +1829,7 @@ write_download_request (struct GNUNET_BIO_WriteHandle *wh, /** * Read a download request tree. * - * @param rh mesh to read from + * @param rh cadet to read from * @return value the download request read from disk, NULL on error */ static struct DownloadRequest * @@ -1774,10 +1843,9 @@ read_download_request (struct GNUNET_BIO_ReadHandle *rh) (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) || (dr->num_children > CHK_PER_INODE) || - (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((0 == dr->depth) - && - (dr->num_children - > 0)) || + (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || + ( (0 == dr->depth) && + (dr->num_children > 0) ) || ((dr->depth > 0) && (0 == dr->num_children))) { GNUNET_break (0); @@ -1831,7 +1899,8 @@ cleanup: */ static char * get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc, - const char *uni, const char *ext) + const char *uni, + const char *ext) { char *par; char *epar; @@ -2078,7 +2147,7 @@ GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc) GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) || (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri))); uris = GNUNET_FS_uri_to_string (sc->uri); - in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0'; + in_pause = (sc->task != NULL) ? 'r' : '\0'; if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) || (GNUNET_OK != write_start_time (wh, sc->start_time)) || (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) || @@ -2112,12 +2181,13 @@ cleanup: * Function called with a filename of serialized unindexing operation * to deserialize. * - * @param cls the 'struct GNUNET_FS_Handle*' + * @param cls the `struct GNUNET_FS_Handle *` * @param filename complete filename (absolute path) - * @return GNUNET_OK (continue to iterate) + * @return #GNUNET_OK (continue to iterate) */ static int -deserialize_unindex_file (void *cls, const char *filename) +deserialize_unindex_file (void *cls, + const char *filename) { struct GNUNET_FS_Handle *h = cls; struct GNUNET_BIO_ReadHandle *rh; @@ -2247,7 +2317,8 @@ cleanup: if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))) { GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - _("Failed to resume unindexing operation `%s': %s\n"), filename, + _("Failed to resume unindexing operation `%s': %s\n"), + filename, emsg); GNUNET_free (emsg); } @@ -2296,12 +2367,13 @@ deserialize_search (struct GNUNET_FS_Handle *h, * Function called with a filename of serialized search result * to deserialize. * - * @param cls the 'struct GNUNET_FS_SearchContext*' + * @param cls the `struct GNUNET_FS_SearchContext *` * @param filename complete filename (absolute path) * @return #GNUNET_OK (continue to iterate) */ static int -deserialize_search_result (void *cls, const char *filename) +deserialize_search_result (void *cls, + const char *filename) { struct GNUNET_FS_SearchContext *sc = cls; char *ser; @@ -2373,7 +2445,8 @@ deserialize_search_result (void *cls, const char *filename) if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg)) { GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - _("Failed to resume sub-download `%s': %s\n"), download, + _("Failed to resume sub-download `%s': %s\n"), + download, emsg); GNUNET_free (emsg); } @@ -2390,7 +2463,8 @@ deserialize_search_result (void *cls, const char *filename) if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg)) { GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - _("Failed to resume sub-search `%s': %s\n"), update_srch, + _("Failed to resume sub-search `%s': %s\n"), + update_srch, emsg); GNUNET_free (emsg); } @@ -2474,13 +2548,15 @@ signal_search_resume (struct GNUNET_FS_SearchContext *sc); * Iterator over search results signaling resume to the client for * each result. * - * @param cls closure, the 'struct GNUNET_FS_SearchContext' + * @param cls closure, the `struct GNUNET_FS_SearchContext *` * @param key current key code - * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult' - * @return GNUNET_YES (we should continue to iterate) + * @param value value in the hash map, the `struct GNUNET_FS_SearchResult *` + * @return #GNUNET_YES (we should continue to iterate) */ static int -signal_result_resume (void *cls, const struct GNUNET_HashCode * key, void *value) +signal_result_resume (void *cls, + const struct GNUNET_HashCode *key, + void *value) { struct GNUNET_FS_SearchContext *sc = cls; struct GNUNET_FS_ProgressInfo pi; @@ -2526,13 +2602,15 @@ free_search_context (struct GNUNET_FS_SearchContext *sc); /** * Iterator over search results freeing each. * - * @param cls closure, the 'struct GNUNET_FS_SearchContext' + * @param cls closure, the `struct GNUNET_FS_SearchContext *` * @param key current key code - * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult' - * @return GNUNET_YES (we should continue to iterate) + * @param value value in the hash map, the `struct GNUNET_FS_SearchResult *` + * @return #GNUNET_YES (we should continue to iterate) */ static int -free_result (void *cls, const struct GNUNET_HashCode * key, void *value) +free_result (void *cls, + const struct GNUNET_HashCode *key, + void *value) { struct GNUNET_FS_SearchResult *sr = value; @@ -2587,12 +2665,13 @@ free_search_context (struct GNUNET_FS_SearchContext *sc) * Function called with a filename of serialized sub-download * to deserialize. * - * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent) + * @param cls the `struct GNUNET_FS_DownloadContext *` (parent) * @param filename complete filename (absolute path) * @return #GNUNET_OK (continue to iterate) */ static int -deserialize_subdownload (void *cls, const char *filename) +deserialize_subdownload (void *cls, + const char *filename) { struct GNUNET_FS_DownloadContext *parent = cls; char *ser; @@ -2604,9 +2683,9 @@ deserialize_subdownload (void *cls, const char *filename) if (NULL == rh) { GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - _ - ("Failed to resume sub-download `%s': could not open file `%s'\n"), - ser, filename); + _("Failed to resume sub-download `%s': could not open file `%s'\n"), + ser, + filename); GNUNET_free (ser); return GNUNET_OK; } @@ -2614,7 +2693,9 @@ deserialize_subdownload (void *cls, const char *filename) if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)) { GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - _("Failed to resume sub-download `%s': %s\n"), ser, emsg); + _("Failed to resume sub-download `%s': %s\n"), + ser, + emsg); GNUNET_free (emsg); } GNUNET_free (ser); @@ -2644,7 +2725,9 @@ free_download_context (struct GNUNET_FS_DownloadContext *dc) GNUNET_free_non_null (dc->serialization); while (NULL != (dcc = dc->child_head)) { - GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc); + GNUNET_CONTAINER_DLL_remove (dc->child_head, + dc->child_tail, + dcc); free_download_context (dcc); } GNUNET_FS_free_download_request_ (dc->top_request); @@ -2816,8 +2899,9 @@ deserialize_search (struct GNUNET_FS_Handle *h, } sc->h = h; sc->serialization = GNUNET_strdup (serialization); - if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024)) - || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) || + if ((GNUNET_OK != + GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024)) || + (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) || ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) && (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) || (GNUNET_OK != read_start_time (rh, &sc->start_time)) || @@ -2834,8 +2918,7 @@ deserialize_search (struct GNUNET_FS_Handle *h, sc->options = (enum GNUNET_FS_SearchOptions) options; sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_NO); dn = get_serialization_file_name_in_dir (h, - (sc->psearch_result == - NULL) ? + (NULL == sc->psearch_result) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH : GNUNET_FS_SYNC_PATH_CHILD_SEARCH, sc->serialization, ""); @@ -2849,8 +2932,7 @@ deserialize_search (struct GNUNET_FS_Handle *h, (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc))) { GNUNET_log (GNUNET_ERROR_TYPE_WARNING, - _ - ("Could not resume running search, will resume as paused search\n")); + _("Could not resume running search, will resume as paused search\n")); } signal_search_resume (sc); GNUNET_free (uris); @@ -2867,12 +2949,13 @@ cleanup: * Function called with a filename of serialized search operation * to deserialize. * - * @param cls the 'struct GNUNET_FS_Handle*' + * @param cls the `struct GNUNET_FS_Handle *` * @param filename complete filename (absolute path) * @return #GNUNET_OK (continue to iterate) */ static int -deserialize_search_file (void *cls, const char *filename) +deserialize_search_file (void *cls, + const char *filename) { struct GNUNET_FS_Handle *h = cls; char *ser; @@ -2918,7 +3001,7 @@ deserialize_search_file (void *cls, const char *filename) * Function called with a filename of serialized download operation * to deserialize. * - * @param cls the 'struct GNUNET_FS_Handle*' + * @param cls the `struct GNUNET_FS_Handle *` * @param filename complete filename (absolute path) * @return #GNUNET_OK (continue to iterate) */ @@ -2980,15 +3063,17 @@ deserialization_master (const char *master_path, GNUNET_FileNameCallback proc, * @param cfg configuration to use * @param client_name unique identifier for this client * @param upcb function to call to notify about FS actions - * @param upcb_cls closure for upcb + * @param upcb_cls closure for @a upcb * @param flags specific attributes for fs-operations - * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END + * @param ... list of optional options, terminated with #GNUNET_FS_OPTIONS_END * @return NULL on error */ struct GNUNET_FS_Handle * GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg, - const char *client_name, GNUNET_FS_ProgressCallback upcb, - void *upcb_cls, enum GNUNET_FS_Flags flags, ...) + const char *client_name, + GNUNET_FS_ProgressCallback upcb, + void *upcb_cls, + enum GNUNET_FS_Flags flags, ...) { struct GNUNET_FS_Handle *ret; enum GNUNET_FS_OPTIONS opt; @@ -3045,18 +3130,18 @@ GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg, * The callback given to GNUNET_FS_start will no longer be * called after this function returns. * - * @param h handle that was returned from GNUNET_FS_start + * @param h handle that was returned from #GNUNET_FS_start() */ void GNUNET_FS_stop (struct GNUNET_FS_Handle *h) { while (h->top_head != NULL) h->top_head->ssf (h->top_head->ssf_cls); - if (h->queue_job != GNUNET_SCHEDULER_NO_TASK) + if (h->queue_job != NULL) GNUNET_SCHEDULER_cancel (h->queue_job); GNUNET_free (h->client_name); GNUNET_free (h); } -/* end of fs.c */ +/* end of fs_api.c */