GNUnet  0.17.6
Data Structures | Macros | Typedefs | Enumerations | Functions
fs_api.h File Reference

shared definitions for the FS library More...

#include "gnunet_constants.h"
#include "gnunet_datastore_service.h"
#include "gnunet_dht_service.h"
#include "gnunet_fs_service.h"
#include "gnunet_block_lib.h"
#include "block_fs.h"
#include "fs.h"
Include dependency graph for fs_api.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  FileIdentifier
 complete information needed to download a file. More...
 
struct  Location
 Information about a file and its location (peer claiming to share the file). More...
 
struct  GNUNET_FS_Uri
 A Universal Resource Identifier (URI), opaque. More...
 
struct  GNUNET_FS_FileInformation
 Information for a file or directory that is about to be published. More...
 
struct  GNUNET_FS_QueueEntry
 Entry in the job queue. More...
 
struct  GNUNET_FS_SearchResult
 Information we store for each search result. More...
 
struct  TopLevelActivity
 We track all of the top-level activities of FS so that we can signal 'suspend' on shutdown. More...
 
struct  GNUNET_FS_Handle
 Master context for most FS operations. More...
 
struct  GNUNET_FS_PublishContext
 Handle for controlling a publication process. More...
 
struct  GNUNET_FS_UnindexContext
 Handle for controlling an unindexing operation. More...
 
struct  SearchRequestEntry
 Information we keep for each keyword in a keyword search. More...
 
struct  GNUNET_FS_SearchContext
 Handle for controlling a search. More...
 
struct  DownloadRequest
 Information about an active download request. More...
 
struct  GNUNET_FS_DownloadContext
 Context for controlling a download. More...
 

Macros

#define CHK_PER_INODE   256
 Pick a multiple of 2 here to achieve 8-byte alignment! We also probably want DBlocks to have (roughly) the same size as IBlocks. More...
 
#define MAX_INLINE_SIZE   65536
 Maximum size for a file to be considered for inlining in a directory. More...
 
#define GNUNET_FS_SYNC_PATH_MASTER_SEARCH   "search"
 Name of the directory with top-level searches. More...
 
#define GNUNET_FS_SYNC_PATH_CHILD_SEARCH   "search-child"
 Name of the directory with sub-searches (namespace-updates). More...
 
#define GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD   "download"
 Name of the directory with master downloads (not associated with search or part of another download). More...
 
#define GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD   "download-child"
 Name of the directory with downloads that are part of another download or a search. More...
 
#define GNUNET_FS_SYNC_PATH_MASTER_PUBLISH   "publish"
 Name of the directory with publishing operations. More...
 
#define GNUNET_FS_SYNC_PATH_FILE_INFO   "publish-file"
 Name of the directory with files that are being published. More...
 
#define GNUNET_FS_SYNC_PATH_MASTER_UNINDEX   "unindex"
 Name of the directory with unindex operations. More...
 

Typedefs

typedef void(* SuspendSignalFunction) (void *cls)
 Function signature of the functions that can be called to trigger suspend signals and clean-up for top-level activities. More...
 

Enumerations

enum  GNUNET_FS_UriType { GNUNET_FS_URI_CHK , GNUNET_FS_URI_SKS , GNUNET_FS_URI_KSK , GNUNET_FS_URI_LOC }
 Types of URIs. More...
 
enum  GNUNET_FS_QueuePriority { GNUNET_FS_QUEUE_PRIORITY_PROBE , GNUNET_FS_QUEUE_PRIORITY_NORMAL }
 Priorities for the queue. More...
 
enum  UnindexState {
  UNINDEX_STATE_HASHING = 0 , UNINDEX_STATE_DS_REMOVE = 1 , UNINDEX_STATE_EXTRACT_KEYWORDS = 2 , UNINDEX_STATE_DS_REMOVE_KBLOCKS = 3 ,
  UNINDEX_STATE_FS_NOTIFY = 4 , UNINDEX_STATE_COMPLETE = 5 , UNINDEX_STATE_ERROR = 6
}
 Phases of unindex processing (state machine). More...
 
enum  BlockRequestState {
  BRS_INIT = 0 , BRS_RECONSTRUCT_DOWN = 1 , BRS_RECONSTRUCT_META_UP = 2 , BRS_RECONSTRUCT_UP = 3 ,
  BRS_CHK_SET = 4 , BRS_DOWNLOAD_DOWN = 5 , BRS_DOWNLOAD_UP = 6 , BRS_ERROR = 7
}
 FSM for possible states a block can go through. More...
 

Functions

struct GNUNET_FS_QueueEntryGNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_SCHEDULER_TaskCallback start, GNUNET_SCHEDULER_TaskCallback stop, void *cls, unsigned int blocks, enum GNUNET_FS_QueuePriority priority)
 Add a job to the queue. More...
 
void GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe)
 Dequeue a job from the queue. More...
 
size_t GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf, char **emsg)
 Function that provides data by reading from a file. More...
 
void * GNUNET_FS_make_file_reader_context_ (const char *filename)
 Create the closure for the GNUNET_FS_data_reader_file_() callback. More...
 
size_t GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf, char **emsg)
 Function that provides data by copying from a buffer. More...
 
void * GNUNET_FS_search_probe_progress_ (void *cls, const struct GNUNET_FS_ProgressInfo *info)
 Notification of FS that a search probe has made progress. More...
 
void GNUNET_FS_publish_main_ (void *cls)
 Main function that performs the upload. More...
 
void GNUNET_FS_unindex_process_hash_ (void *cls, const struct GNUNET_HashCode *file_id)
 Function called once the hash of the file that is being unindexed has been computed. More...
 
void GNUNET_FS_unindex_do_extract_keywords_ (struct GNUNET_FS_UnindexContext *uc)
 Extract the keywords for KBlock removal. More...
 
void GNUNET_FS_unindex_do_remove_kblocks_ (struct GNUNET_FS_UnindexContext *uc)
 If necessary, connect to the datastore and remove the KBlocks. More...
 
void * GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi, struct GNUNET_FS_PublishContext *pc, const struct GNUNET_FS_FileInformation *p, uint64_t offset)
 Fill in all of the generic fields for a publish event and call the callback. More...
 
void GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi, struct GNUNET_FS_DownloadContext *dc)
 Fill in all of the generic fields for a download event and call the callback. More...
 
void GNUNET_FS_download_start_task_ (void *cls)
 Task that creates the initial (top-level) download request for the file. More...
 
void GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi, struct GNUNET_FS_UnindexContext *uc, uint64_t offset)
 Fill in all of the generic fields for an unindex event and call the callback. More...
 
void * GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi, struct GNUNET_FS_Handle *h, struct GNUNET_FS_SearchContext *sc)
 Fill in all of the generic fields for a search event and call the callback. More...
 
void GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc)
 Connect to the datastore and remove the blocks. More...
 
int GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc)
 Build the request and actually initiate the search using the GNUnet FS service. More...
 
void GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc)
 Start the downloading process (by entering the queue). More...
 
void GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr)
 Start download probes for the given search result. More...
 
void GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
 Remove serialization/deserialization file from disk. More...
 
void GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext, const char *uni)
 Remove serialization/deserialization directory from disk. More...
 
void GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *f)
 Synchronize this file-information struct with its mirror on disk. More...
 
void GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
 Synchronize this publishing struct with its mirror on disk. More...
 
void GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
 Synchronize this unindex struct with its mirror on disk. More...
 
void GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
 Synchronize this search struct with its mirror on disk. More...
 
void GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
 Synchronize this search result with its mirror on disk. More...
 
void GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
 Synchronize this download struct with its mirror on disk. More...
 
void GNUNET_FS_publish_signal_suspend_ (void *cls)
 Create SUSPEND event for the given publish operation and then clean up our state (without stop signal). More...
 
void GNUNET_FS_search_signal_suspend_ (void *cls)
 Create SUSPEND event for the given search operation and then clean up our state (without stop signal). More...
 
void GNUNET_FS_download_signal_suspend_ (void *cls)
 Create SUSPEND event for the given download operation and then clean up our state (without stop signal). More...
 
void GNUNET_FS_unindex_signal_suspend_ (void *cls)
 Create SUSPEND event for the given unindex operation and then clean up our state (without stop signal). More...
 
struct TopLevelActivityGNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf, void *ssf_cls)
 Create a top-level activity entry. More...
 
void GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top)
 Destroy a top-level activity entry. More...
 
void GNUNET_FS_free_download_request_ (struct DownloadRequest *dr)
 (recursively) free download request structure More...
 
void GNUNET_FS_stop_probe_ping_task_ (struct GNUNET_FS_SearchResult *sr)
 Stop the ping task for this search result. More...
 

Detailed Description

shared definitions for the FS library

Author
Igor Wronsky, Christian Grothoff

Definition in file fs_api.h.

Macro Definition Documentation

◆ CHK_PER_INODE

#define CHK_PER_INODE   256

Pick a multiple of 2 here to achieve 8-byte alignment! We also probably want DBlocks to have (roughly) the same size as IBlocks.

With SHA-512, the optimal value is 32768 byte / 128 byte = 256 (128 byte = 2 * 512 bits). DO NOT CHANGE!

Definition at line 43 of file fs_api.h.

◆ MAX_INLINE_SIZE

#define MAX_INLINE_SIZE   65536

Maximum size for a file to be considered for inlining in a directory.

Definition at line 49 of file fs_api.h.

◆ GNUNET_FS_SYNC_PATH_MASTER_SEARCH

#define GNUNET_FS_SYNC_PATH_MASTER_SEARCH   "search"

Name of the directory with top-level searches.

Definition at line 54 of file fs_api.h.

◆ GNUNET_FS_SYNC_PATH_CHILD_SEARCH

#define GNUNET_FS_SYNC_PATH_CHILD_SEARCH   "search-child"

Name of the directory with sub-searches (namespace-updates).

Definition at line 59 of file fs_api.h.

◆ GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD

#define GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD   "download"

Name of the directory with master downloads (not associated with search or part of another download).

Definition at line 65 of file fs_api.h.

◆ GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD

#define GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD   "download-child"

Name of the directory with downloads that are part of another download or a search.

Definition at line 71 of file fs_api.h.

◆ GNUNET_FS_SYNC_PATH_MASTER_PUBLISH

#define GNUNET_FS_SYNC_PATH_MASTER_PUBLISH   "publish"

Name of the directory with publishing operations.

Definition at line 76 of file fs_api.h.

◆ GNUNET_FS_SYNC_PATH_FILE_INFO

#define GNUNET_FS_SYNC_PATH_FILE_INFO   "publish-file"

Name of the directory with files that are being published.

Definition at line 81 of file fs_api.h.

◆ GNUNET_FS_SYNC_PATH_MASTER_UNINDEX

#define GNUNET_FS_SYNC_PATH_MASTER_UNINDEX   "unindex"

Name of the directory with unindex operations.

Definition at line 86 of file fs_api.h.

Typedef Documentation

◆ SuspendSignalFunction

typedef void(* SuspendSignalFunction) (void *cls)

Function signature of the functions that can be called to trigger suspend signals and clean-up for top-level activities.

Parameters
clsclosure

Definition at line 1010 of file fs_api.h.

Enumeration Type Documentation

◆ GNUNET_FS_UriType

Types of URIs.

Enumerator
GNUNET_FS_URI_CHK 

Content-hash-key (simple file).

GNUNET_FS_URI_SKS 

Signed key space (file in namespace).

GNUNET_FS_URI_KSK 

Keyword search key (query with keywords).

GNUNET_FS_URI_LOC 

Location (chk with identity of hosting peer).

Definition at line 138 of file fs_api.h.

139 {
144 
149 
154 
159 };
@ GNUNET_FS_URI_LOC
Location (chk with identity of hosting peer).
Definition: fs_api.h:158
@ GNUNET_FS_URI_CHK
Content-hash-key (simple file).
Definition: fs_api.h:143
@ GNUNET_FS_URI_SKS
Signed key space (file in namespace).
Definition: fs_api.h:148
@ GNUNET_FS_URI_KSK
Keyword search key (query with keywords).
Definition: fs_api.h:153

◆ GNUNET_FS_QueuePriority

Priorities for the queue.

Enumerator
GNUNET_FS_QUEUE_PRIORITY_PROBE 

This is a probe (low priority).

GNUNET_FS_QUEUE_PRIORITY_NORMAL 

Default priority.

Definition at line 402 of file fs_api.h.

403 {
408 
413 };
@ GNUNET_FS_QUEUE_PRIORITY_NORMAL
Default priority.
Definition: fs_api.h:412
@ GNUNET_FS_QUEUE_PRIORITY_PROBE
This is a probe (low priority).
Definition: fs_api.h:407

◆ UnindexState

Phases of unindex processing (state machine).

Enumerator
UNINDEX_STATE_HASHING 

We're currently hashing the file.

UNINDEX_STATE_DS_REMOVE 

We're telling the datastore to delete the respective DBlocks and IBlocks.

UNINDEX_STATE_EXTRACT_KEYWORDS 

Find out which keywords apply.

UNINDEX_STATE_DS_REMOVE_KBLOCKS 

We're telling the datastore to remove KBlocks.

UNINDEX_STATE_FS_NOTIFY 

We're notifying the FS service about the unindexing.

UNINDEX_STATE_COMPLETE 

We're done.

UNINDEX_STATE_ERROR 

We've encountered a fatal error.

Definition at line 1305 of file fs_api.h.

1306 {
1311 
1317 
1322 
1327 
1333 
1338 
1343 };
@ UNINDEX_STATE_EXTRACT_KEYWORDS
Find out which keywords apply.
Definition: fs_api.h:1321
@ UNINDEX_STATE_COMPLETE
We're done.
Definition: fs_api.h:1337
@ UNINDEX_STATE_DS_REMOVE
We're telling the datastore to delete the respective DBlocks and IBlocks.
Definition: fs_api.h:1316
@ UNINDEX_STATE_HASHING
We're currently hashing the file.
Definition: fs_api.h:1310
@ UNINDEX_STATE_ERROR
We've encountered a fatal error.
Definition: fs_api.h:1342
@ UNINDEX_STATE_FS_NOTIFY
We're notifying the FS service about the unindexing.
Definition: fs_api.h:1332
@ UNINDEX_STATE_DS_REMOVE_KBLOCKS
We're telling the datastore to remove KBlocks.
Definition: fs_api.h:1326

◆ BlockRequestState

FSM for possible states a block can go through.

The typical order of progression is linear through the states, alternatives are documented in the comments.

Enumerator
BRS_INIT 

Initial state, block has only been allocated (since it is relevant to the overall download request).

BRS_RECONSTRUCT_DOWN 

We've checked the block on the path down the tree, and the content on disk did match the desired CHK, but not all the way down, so at the bottom some blocks will still need to be reconstructed).

BRS_RECONSTRUCT_META_UP 

We've calculated the CHK bottom-up based on the meta data.

This may work, but if it did we have to write the meta data to disk at the end (and we still need to check against the CHK set on top).

BRS_RECONSTRUCT_UP 

We've calculated the CHK bottom-up based on what we have on disk, which may not be what the desired CHK is.

If the reconstructed CHKs match whatever comes from above, we're done with the respective subtree.

BRS_CHK_SET 

We've determined the real, desired CHK for this block (full tree reconstruction failed), request is now pending.

If the CHK that bubbled up through reconstruction did match the top-level request, the state machine for the subtree would have moved to BRS_DOWNLOAD_UP.

BRS_DOWNLOAD_DOWN 

We've successfully downloaded this block, but the children still need to be either downloaded or verified (download request propagates down).

If the download fails, the state machine for this block may move to BRS_DOWNLOAD_ERROR instead.

BRS_DOWNLOAD_UP 

This block and all of its children have been downloaded successfully (full completion propagates up).

BRS_ERROR 

We got a block back that matched the query but did not hash to the key (malicious publisher or hash collision); this block can never be downloaded (error propagates up).

Definition at line 1606 of file fs_api.h.

1607 {
1612  BRS_INIT = 0,
1613 
1621 
1629 
1636  BRS_RECONSTRUCT_UP = 3,
1637 
1645  BRS_CHK_SET = 4,
1646 
1654  BRS_DOWNLOAD_DOWN = 5,
1655 
1660  BRS_DOWNLOAD_UP = 6,
1661 
1667  BRS_ERROR = 7
1668 };
@ BRS_DOWNLOAD_UP
This block and all of its children have been downloaded successfully (full completion propagates up).
Definition: fs_api.h:1660
@ BRS_RECONSTRUCT_META_UP
We've calculated the CHK bottom-up based on the meta data.
Definition: fs_api.h:1628
@ BRS_CHK_SET
We've determined the real, desired CHK for this block (full tree reconstruction failed),...
Definition: fs_api.h:1645
@ BRS_ERROR
We got a block back that matched the query but did not hash to the key (malicious publisher or hash c...
Definition: fs_api.h:1667
@ BRS_RECONSTRUCT_DOWN
We've checked the block on the path down the tree, and the content on disk did match the desired CHK,...
Definition: fs_api.h:1620
@ BRS_INIT
Initial state, block has only been allocated (since it is relevant to the overall download request).
Definition: fs_api.h:1612
@ BRS_DOWNLOAD_DOWN
We've successfully downloaded this block, but the children still need to be either downloaded or veri...
Definition: fs_api.h:1654
@ BRS_RECONSTRUCT_UP
We've calculated the CHK bottom-up based on what we have on disk, which may not be what the desired C...
Definition: fs_api.h:1636

Function Documentation

◆ GNUNET_FS_queue_()

struct GNUNET_FS_QueueEntry* GNUNET_FS_queue_ ( struct GNUNET_FS_Handle h,
GNUNET_SCHEDULER_TaskCallback  start,
GNUNET_SCHEDULER_TaskCallback  stop,
void *  cls,
unsigned int  blocks,
enum GNUNET_FS_QueuePriority  priority 
)

Add a job to the queue.

Parameters
hhandle to the overall FS state
startfunction to call to begin the job
stopfunction to call to pause the job, or on dequeue (if the job was running)
clsclosure for start and stop
blocksnumber of blocks this download has
priorityhow important is this download
Returns
queue handle

Definition at line 320 of file fs_api.c.

326 {
327  struct GNUNET_FS_QueueEntry *qe;
328 
330  qe->h = h;
331  qe->start = start;
332  qe->stop = stop;
333  qe->cls = cls;
334  qe->queue_time = GNUNET_TIME_absolute_get ();
335  qe->blocks = blocks;
336  qe->priority = priority;
337  GNUNET_CONTAINER_DLL_insert_after (h->pending_head,
338  h->pending_tail,
339  h->pending_tail,
340  qe);
341  if (NULL != h->queue_job)
342  GNUNET_SCHEDULER_cancel (h->queue_job);
344  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Queueing job %p\n", qe);
345  return qe;
346 }
static void process_job_queue(void *cls)
Process the jobs in the job queue, possibly starting some and stopping others.
Definition: fs_api.c:106
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
static int start
Set if we are to start default services (including ARM).
Definition: gnunet-arm.c:39
static struct GNUNET_DATASTORE_QueueEntry * qe
Current operation.
#define GNUNET_CONTAINER_DLL_insert_after(head, tail, other, element)
Insert an element into a DLL after the given other element.
#define GNUNET_log(kind,...)
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1281
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:957
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:110
unsigned int priority
Priority in the queue.
struct GNUNET_DATASTORE_Handle * h
Handle to the master context.
Entry in the job queue.
Definition: fs_api.h:420
GNUNET_SCHEDULER_TaskCallback stop
Function to call when the job needs to stop (or is done / dequeued).
Definition: fs_api.h:439
void * cls
Closure for start and stop.
Definition: fs_api.h:444
enum GNUNET_FS_QueuePriority priority
How important is this download?
Definition: fs_api.h:480
unsigned int blocks
How many blocks do the active downloads have?
Definition: fs_api.h:475

References GNUNET_FS_QueueEntry::blocks, GNUNET_FS_QueueEntry::cls, GNUNET_CONTAINER_DLL_insert_after, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_new, GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), GNUNET_TIME_absolute_get(), h, GNUNET_DATASTORE_QueueEntry::h, GNUNET_DATASTORE_QueueEntry::priority, GNUNET_FS_QueueEntry::priority, process_job_queue(), qe, start, and GNUNET_FS_QueueEntry::stop.

Referenced by GNUNET_FS_download_resume(), and GNUNET_FS_download_start_downloading_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_dequeue_()

void GNUNET_FS_dequeue_ ( struct GNUNET_FS_QueueEntry qe)

Dequeue a job from the queue.

Parameters
qehandle for the job

Definition at line 355 of file fs_api.c.

356 {
357  struct GNUNET_FS_Handle *h;
358 
359  h = qe->h;
360  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Dequeueing job %p\n", qe);
361  if (GNUNET_YES == qe->active)
362  stop_job (qe);
363  GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, qe);
364  GNUNET_free (qe);
365  if (NULL != h->queue_job)
366  GNUNET_SCHEDULER_cancel (h->queue_job);
368 }
static void stop_job(struct GNUNET_FS_QueueEntry *qe)
Stop the given job (send signal, remove from active queue, update counters and state).
Definition: fs_api.c:77
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
@ GNUNET_YES
#define GNUNET_free(ptr)
Wrapper around free.
Master context for most FS operations.
Definition: fs_api.h:1069

References GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), GNUNET_YES, h, GNUNET_DATASTORE_QueueEntry::h, process_job_queue(), qe, and stop_job().

Referenced by check_completed(), GNUNET_FS_download_signal_suspend_(), and process_result_with_request().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_data_reader_file_()

size_t GNUNET_FS_data_reader_file_ ( void *  cls,
uint64_t  offset,
size_t  max,
void *  buf,
char **  emsg 
)

Function that provides data by reading from a file.

Parameters
clsclosure (points to the file information)
offsetoffset to read from; it is possible that the caller might need to go backwards a bit at times
maxmaximum number of bytes that should be copied to 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
bufwhere the reader should write the data
emsglocation for the reader to store an error message
Returns
number of bytes written, usually "max", 0 on error
Parameters
clsclosure with the struct FileInfo *
offsetoffset to read from; it is possible that the caller might need to go backwards 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
maxmaximum number of bytes that should be copied to 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
bufwhere the reader should write the data
emsglocation for the reader to store an error message
Returns
number of bytes written, usually max, 0 on error

Definition at line 446 of file fs_api.c.

451 {
452  struct FileInfo *fi = cls;
453  ssize_t ret;
454 
455  if (UINT64_MAX == offset)
456  {
457  if (NULL != fi->fd)
458  {
460  fi->fd = NULL;
461  }
462  return 0;
463  }
464  if (0 == max)
465  {
466  if (NULL != fi->fd)
468  GNUNET_free (fi->filename);
469  GNUNET_free (fi);
470  return 0;
471  }
472  if (NULL == fi->fd)
473  {
474  fi->fd = GNUNET_DISK_file_open (fi->filename,
477  if (NULL == fi->fd)
478  {
479  GNUNET_asprintf (emsg,
480  _ ("Could not open file `%s': %s"),
481  fi->filename,
482  strerror (errno));
483  return 0;
484  }
485  }
486  if ((GNUNET_SYSERR ==
488  (-1 == (ret = GNUNET_DISK_file_read (fi->fd, buf, max))))
489  {
490  GNUNET_asprintf (emsg,
491  _ ("Could not read file `%s': %s"),
492  fi->filename,
493  strerror (errno));
494  return 0;
495  }
496  if (ret != max)
497  {
498  GNUNET_asprintf (emsg,
499  _ ("Short read reading from file `%s'!"),
500  fi->filename);
501  return 0;
502  }
503  return max;
504 }
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
static char buf[2048]
struct GNUNET_DISK_FileHandle * GNUNET_DISK_file_open(const char *fn, enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm)
Open a file.
Definition: disk.c:1235
off_t GNUNET_DISK_file_seek(const struct GNUNET_DISK_FileHandle *h, off_t offset, enum GNUNET_DISK_Seek whence)
Move the read/write pointer in a file.
Definition: disk.c:206
enum GNUNET_GenericReturnValue GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1306
ssize_t GNUNET_DISK_file_read(const struct GNUNET_DISK_FileHandle *h, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:622
@ GNUNET_DISK_OPEN_READ
Open the file for reading.
@ GNUNET_DISK_PERM_NONE
Nobody is allowed to do anything to the file.
@ GNUNET_DISK_SEEK_SET
Seek an absolute position (from the start of the file).
@ GNUNET_SYSERR
Definition: gnunet_common.h:97
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define max(x, y)
#define _(String)
GNU gettext support macro.
Definition: platform.h:177
Closure for GNUNET_FS_data_reader_file_().
Definition: fs_api.c:412
struct GNUNET_DISK_FileHandle * fd
File descriptor, NULL if it has not yet been opened.
Definition: fs_api.c:421
char * filename
Name of the file to read.
Definition: fs_api.c:416

References _, buf, FileInfo::fd, FileInfo::filename, GNUNET_asprintf(), GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_read(), GNUNET_DISK_file_seek(), GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE, GNUNET_DISK_SEEK_SET, GNUNET_free, GNUNET_SYSERR, max, and ret.

Referenced by block_reader(), deserialize_fi_node(), GNUNET_FS_file_information_create_from_file(), and GNUNET_FS_file_information_create_from_reader().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_make_file_reader_context_()

void* GNUNET_FS_make_file_reader_context_ ( const char *  filename)

Create the closure for the GNUNET_FS_data_reader_file_() callback.

Parameters
filenamefile to read
Returns
closure to use, NULL on error

Definition at line 508 of file fs_api.c.

509 {
510  struct FileInfo *fi;
511 
512  fi = GNUNET_new (struct FileInfo);
514  if (NULL == fi->filename)
515  {
516  GNUNET_free (fi);
517  return NULL;
518  }
519  return fi;
520 }
static char * filename
char * GNUNET_STRINGS_filename_expand(const char *fil)
Complete filename (a la shell) from abbrevition.
Definition: strings.c:495

References FileInfo::filename, filename, GNUNET_free, GNUNET_new, and GNUNET_STRINGS_filename_expand().

Referenced by deserialize_fi_node(), and GNUNET_FS_file_information_create_from_file().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_data_reader_copy_()

size_t GNUNET_FS_data_reader_copy_ ( void *  cls,
uint64_t  offset,
size_t  max,
void *  buf,
char **  emsg 
)

Function that provides data by copying from a buffer.

Parameters
clsclosure (points to the buffer)
offsetoffset to read from; it is possible that the caller might need to go backwards a bit at times
maxmaximum number of bytes that should be copied to 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
bufwhere the reader should write the data
emsglocation for the reader to store an error message
Returns
number of bytes written, usually max, 0 on error
Parameters
clsclosure (points to the buffer)
offsetoffset to read from; it is possible that the caller might need to go backwards 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
maxmaximum number of bytes that should be copied to 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
bufwhere the reader should write the data
emsglocation for the reader to store an error message
Returns
number of bytes written, usually max, 0 on error

Definition at line 544 of file fs_api.c.

549 {
550  char *data = cls;
551 
552  if (UINT64_MAX == offset)
553  return 0;
554  if (0 == max)
555  {
556  GNUNET_free (data);
557  return 0;
558  }
559  GNUNET_memcpy (buf, &data[offset], max);
560  return max;
561 }
uint32_t data
The data value.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.

References buf, data, GNUNET_free, GNUNET_memcpy, and max.

Referenced by deserialize_fi_node(), and GNUNET_FS_file_information_create_from_data().

Here is the caller graph for this function:

◆ GNUNET_FS_search_probe_progress_()

void* GNUNET_FS_search_probe_progress_ ( void *  cls,
const struct GNUNET_FS_ProgressInfo info 
)

Notification of FS that a search probe has made progress.

This function is used INSTEAD of the client's event handler for downloads where the GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.

Parameters
clsclosure, always NULL (!), actual closure is in the client-context of the info struct
infodetails about the event, specifying the event type and various bits about the event
Returns
client-context (for the next progress call for this operation; should be set to NULL for SUSPEND and STOPPED events). The value returned will be passed to future callbacks in the respective field in the struct GNUNET_FS_ProgressInfo.

Definition at line 280 of file fs_search.c.

282 {
283  struct GNUNET_FS_SearchResult *sr = info->value.download.cctx;
284  struct GNUNET_TIME_Relative dur;
285 
286  switch (info->status)
287  {
289  /* ignore */
290  break;
292  /* probes should never be resumed */
293  GNUNET_assert (0);
294  break;
296  /* probes should never be suspended */
297  GNUNET_break (0);
298  break;
300  /* ignore */
301  break;
303  if (NULL != sr->probe_cancel_task)
304  {
306  sr->probe_cancel_task = NULL;
307  }
308  sr->probe_cancel_task =
310  &probe_failure_handler, sr);
311  break;
313  if (NULL != sr->probe_cancel_task)
314  {
316  sr->probe_cancel_task = NULL;
317  }
318  sr->probe_cancel_task =
320  break;
322  if (NULL != sr->probe_cancel_task)
323  {
325  sr->probe_cancel_task = NULL;
326  }
327  sr = NULL;
328  break;
330  if (NULL == sr->probe_cancel_task)
331  {
333  sr->probe_cancel_task =
335  &probe_failure_handler, sr);
336  }
337  break;
339  if (NULL != sr->probe_cancel_task)
340  {
342  sr->probe_cancel_task = NULL;
343  }
347  if (0 == sr->remaining_probe_time.rel_value_us)
348  sr->probe_cancel_task =
351  break;
352 
353  default:
354  GNUNET_break (0);
355  return NULL;
356  }
357  return sr;
358 }
void GNUNET_FS_search_result_sync_(struct GNUNET_FS_SearchResult *sr)
Synchronize this search result with its mirror on disk.
Definition: fs_api.c:2148
static void probe_success_handler(void *cls)
Handle the case where we have gotten a response for our probe.
Definition: fs_search.c:245
static void probe_failure_handler(void *cls)
Handle the case where we have failed to receive a response for our probe.
Definition: fs_search.c:221
#define info
@ GNUNET_FS_STATUS_DOWNLOAD_INACTIVE
Notification that this download is no longer actively being pursued (back in the queue).
@ GNUNET_FS_STATUS_DOWNLOAD_ERROR
Notification that this download encountered an error.
@ GNUNET_FS_STATUS_DOWNLOAD_COMPLETED
Notification that this download completed.
@ GNUNET_FS_STATUS_DOWNLOAD_RESUME
Notification that this download is being resumed.
@ GNUNET_FS_STATUS_DOWNLOAD_SUSPEND
Notification that this download was suspended.
@ GNUNET_FS_STATUS_DOWNLOAD_START
Notification that we have started this download.
@ GNUNET_FS_STATUS_DOWNLOAD_PROGRESS
Notification about progress with this download.
@ GNUNET_FS_STATUS_DOWNLOAD_ACTIVE
Notification that this download is now actively being pursued (as opposed to waiting in the queue).
@ GNUNET_FS_STATUS_DOWNLOAD_STOPPED
Notification that this download was stopped (final event with respect to this action).
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1254
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration(struct GNUNET_TIME_Absolute whence)
Get the duration of an operation as the difference of the current time and the given start time "henc...
Definition: time.c:435
struct GNUNET_TIME_Relative GNUNET_TIME_relative_subtract(struct GNUNET_TIME_Relative a1, struct GNUNET_TIME_Relative a2)
Subtract relative timestamp from the other.
Definition: time.c:602
Information we store for each search result.
Definition: fs_api.h:498
struct GNUNET_TIME_Absolute probe_active_time
When did the current probe become active?
Definition: fs_api.h:578
struct GNUNET_TIME_Relative remaining_probe_time
How much longer should we run the current probe before giving up?
Definition: fs_api.h:583
struct GNUNET_SCHEDULER_Task * probe_cancel_task
ID of the task that will clean up the probe_ctx should it not complete on time (and that will need to...
Definition: fs_api.h:573
Time for relative time used by GNUnet, in microseconds.
uint64_t rel_value_us
The actual value.

References GNUNET_assert, GNUNET_break, GNUNET_FS_search_result_sync_(), GNUNET_FS_STATUS_DOWNLOAD_ACTIVE, GNUNET_FS_STATUS_DOWNLOAD_COMPLETED, GNUNET_FS_STATUS_DOWNLOAD_ERROR, GNUNET_FS_STATUS_DOWNLOAD_INACTIVE, GNUNET_FS_STATUS_DOWNLOAD_PROGRESS, GNUNET_FS_STATUS_DOWNLOAD_RESUME, GNUNET_FS_STATUS_DOWNLOAD_START, GNUNET_FS_STATUS_DOWNLOAD_STOPPED, GNUNET_FS_STATUS_DOWNLOAD_SUSPEND, GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), GNUNET_TIME_absolute_get(), GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_relative_subtract(), info, GNUNET_FS_SearchResult::probe_active_time, GNUNET_FS_SearchResult::probe_cancel_task, probe_failure_handler(), probe_success_handler(), GNUNET_TIME_Relative::rel_value_us, and GNUNET_FS_SearchResult::remaining_probe_time.

Referenced by GNUNET_FS_download_make_status_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_publish_main_()

void GNUNET_FS_publish_main_ ( void *  cls)

Main function that performs the upload.

Parameters
clsstruct GNUNET_FS_PublishContext identifies the upload
clsstruct GNUNET_FS_PublishContext * identifies the upload

Definition at line 1062 of file fs_publish.c.

1063 {
1064  struct GNUNET_FS_PublishContext *pc = cls;
1065  struct GNUNET_FS_ProgressInfo pi;
1066  struct GNUNET_FS_FileInformation *p;
1067  char *fn;
1068 
1069  pc->upload_task = NULL;
1070  p = pc->fi_pos;
1071  if (NULL == p)
1072  {
1074  "Publishing complete, now publishing SKS and KSK blocks.\n");
1075  /* upload of entire hierarchy complete,
1076  * publish namespace entries */
1078  publish_sblock (pc);
1079  return;
1080  }
1081  /* find starting position */
1082  while ((GNUNET_YES == p->is_directory) &&
1083  (NULL != p->data.dir.entries) &&
1084  (NULL == p->emsg) &&
1085  (NULL == p->data.dir.entries->chk_uri))
1086  {
1087  p = p->data.dir.entries;
1088  pc->fi_pos = p;
1090  }
1091  /* abort on error */
1092  if (NULL != p->emsg)
1093  {
1095  "Error uploading: %s\n",
1096  p->emsg);
1097  /* error with current file, abort all
1098  * related files as well! */
1099  while (NULL != p->dir)
1100  {
1103  p = p->dir;
1104  if (fn != NULL)
1105  {
1106  GNUNET_asprintf (&p->emsg,
1107  _ ("Recursive upload failed at `%s': %s"),
1108  fn,
1109  p->emsg);
1110  GNUNET_free (fn);
1111  }
1112  else
1113  {
1114  GNUNET_asprintf (&p->emsg,
1115  _ ("Recursive upload failed: %s"),
1116  p->emsg);
1117  }
1119  pi.value.publish.eta = GNUNET_TIME_UNIT_FOREVER_REL;
1120  pi.value.publish.specifics.error.message = p->emsg;
1121  p->client_info = GNUNET_FS_publish_make_status_ (&pi, pc, p, 0);
1122  }
1123  pc->all_done = GNUNET_YES;
1125  return;
1126  }
1127  /* handle completion */
1128  if (NULL != p->chk_uri)
1129  {
1131  "File upload complete, now publishing KSK blocks.\n");
1133 
1134  if ((0 == p->bo.anonymity_level) &&
1135  (GNUNET_YES !=
1136  GNUNET_FS_uri_test_loc (p->chk_uri)))
1137  {
1138  /* zero anonymity, box CHK URI in LOC URI */
1139  create_loc_uri (pc);
1140  }
1141  else
1142  {
1143  publish_kblocks (pc);
1144  }
1145  return;
1146  }
1147  if ((GNUNET_YES != p->is_directory) && (p->data.file.do_index))
1148  {
1149  if (NULL == p->filename)
1150  {
1151  p->data.file.do_index = GNUNET_NO;
1153  _ (
1154  "Can not index file `%s': %s. Will try to insert instead.\n"),
1155  "<no-name>",
1156  _ ("needs to be an actual file"));
1158  publish_content (pc);
1159  return;
1160  }
1161  if (p->data.file.have_hash)
1162  {
1163  hash_for_index_cb (pc, &p->data.file.file_id);
1164  }
1165  else
1166  {
1167  p->start_time = GNUNET_TIME_absolute_get ();
1168  pc->fhc =
1171  }
1172  return;
1173  }
1174  publish_content (pc);
1175 }
#define HASHING_BLOCKSIZE
Blocksize to use when hashing files for indexing (blocksize for IO, not for the DBlocks).
Definition: fs.h:47
void GNUNET_FS_file_information_sync_(struct GNUNET_FS_FileInformation *fi)
Create a temporary file on disk to store the current state of fi in.
Definition: fs_api.c:1327
void GNUNET_FS_publish_sync_(struct GNUNET_FS_PublishContext *pc)
Synchronize this publishing struct with its mirror on disk.
Definition: fs_api.c:1746
static void publish_content(struct GNUNET_FS_PublishContext *pc)
We are uploading a file or directory; load (if necessary) the next block into memory,...
Definition: fs_publish.c:615
static void create_loc_uri(struct GNUNET_FS_PublishContext *pc)
We're publishing without anonymity.
Definition: fs_publish.c:1016
static void publish_sblock(struct GNUNET_FS_PublishContext *pc)
We are almost done publishing the structure, add SBlocks (if needed).
Definition: fs_publish.c:285
static void publish_kblocks(struct GNUNET_FS_PublishContext *pc)
We've computed the CHK/LOC URI, now publish the KSKs (if applicable).
Definition: fs_publish.c:933
static void hash_for_index_cb(void *cls, const struct GNUNET_HashCode *res)
Function called once the hash computation over an indexed file has completed.
Definition: fs_publish.c:805
void * GNUNET_FS_publish_make_status_(struct GNUNET_FS_ProgressInfo *pi, struct GNUNET_FS_PublishContext *pc, const struct GNUNET_FS_FileInformation *p, uint64_t offset)
Fill in all of the generic fields for a publish event and call the callback.
Definition: fs_publish.c:47
static struct GNUNET_PEERINFO_Handle * pi
Handle to peerinfo service.
static struct GNUNET_FS_PublishContext * pc
Handle to FS-publishing operation.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-uri.c:37
int GNUNET_FS_uri_test_loc(const struct GNUNET_FS_Uri *uri)
Is this a location URI?
Definition: fs_uri.c:1400
@ GNUNET_FS_STATUS_PUBLISH_ERROR
Notification that an error was encountered sharing a file structure.
struct GNUNET_CRYPTO_FileHashContext * GNUNET_CRYPTO_hash_file(enum GNUNET_SCHEDULER_Priority priority, const char *filename, size_t blocksize, GNUNET_CRYPTO_HashCompletedCallback callback, void *callback_cls)
Compute the hash of an entire file.
@ GNUNET_SCHEDULER_PRIORITY_IDLE
Run when otherwise idle.
@ GNUNET_NO
Definition: gnunet_common.h:98
@ EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME
@ GNUNET_ERROR_TYPE_WARNING
char * GNUNET_CONTAINER_meta_data_get_by_type(const struct GNUNET_CONTAINER_MetaData *md, enum EXTRACTOR_MetaType type)
Get the first MD entry of the given type.
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
Information for a file or directory that is about to be published.
Definition: fs_api.h:227
Argument given to the progress callback with information about what is going on.
Handle for controlling a publication process.
Definition: fs_api.h:1179
struct GNUNET_CRYPTO_FileHashContext * fhc
Non-null if we are currently hashing a file.
Definition: fs_api.h:1230
struct GNUNET_FS_FileInformation * fi_pos
Current position in the file-tree for the upload.
Definition: fs_api.h:1225
int all_done
Set to GNUNET_YES if all processing has completed.
Definition: fs_api.h:1291
struct GNUNET_SCHEDULER_Task * upload_task
ID of the task performing the upload.
Definition: fs_api.h:1258

References _, GNUNET_FS_PublishContext::all_done, create_loc_uri(), EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME, GNUNET_FS_PublishContext::fhc, GNUNET_FS_PublishContext::fi_pos, GNUNET_asprintf(), GNUNET_CONTAINER_meta_data_get_by_type(), GNUNET_CRYPTO_hash_file(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_FS_file_information_sync_(), GNUNET_FS_publish_make_status_(), GNUNET_FS_publish_sync_(), GNUNET_FS_STATUS_PUBLISH_ERROR, GNUNET_FS_uri_test_loc(), GNUNET_log, GNUNET_NO, GNUNET_SCHEDULER_PRIORITY_IDLE, GNUNET_TIME_absolute_get(), GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, hash_for_index_cb(), HASHING_BLOCKSIZE, p, pc, pi, publish_content(), publish_kblocks(), publish_sblock(), and GNUNET_FS_PublishContext::upload_task.

Referenced by block_proc(), deserialize_publish_file(), ds_put_cont(), encode_cont(), finish_reserve(), GNUNET_FS_publish_start(), and publish_kblocks_cont().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_unindex_process_hash_()

void GNUNET_FS_unindex_process_hash_ ( void *  cls,
const struct GNUNET_HashCode file_id 
)

Function called once the hash of the file that is being unindexed has been computed.

Parameters
clsclosure, unindex context
file_idcomputed hash, NULL on error

Definition at line 694 of file fs_unindex.c.

696 {
697  struct GNUNET_FS_UnindexContext *uc = cls;
698 
699  uc->fhc = NULL;
701  {
703  return;
704  }
705  if (file_id == NULL)
706  {
708  uc->emsg = GNUNET_strdup (_ ("Failed to compute hash of file."));
711  return;
712  }
713  uc->file_id = *file_id;
717 }
void GNUNET_FS_unindex_sync_(struct GNUNET_FS_UnindexContext *uc)
Synchronize this unindex struct with its mirror on disk.
Definition: fs_api.c:1822
void GNUNET_FS_unindex_do_remove_(struct GNUNET_FS_UnindexContext *uc)
Connect to the datastore and remove the blocks.
Definition: fs_unindex.c:649
static void signal_unindex_error(struct GNUNET_FS_UnindexContext *uc)
We've encountered an error during unindexing.
Definition: fs_unindex.c:138
static struct GNUNET_FS_UnindexContext * uc
void GNUNET_FS_unindex_stop(struct GNUNET_FS_UnindexContext *uc)
Clean up after completion of an unindex operation.
Definition: fs_unindex.c:837
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
Handle for controlling an unindexing operation.
Definition: fs_api.h:1350
enum UnindexState state
Current operatinonal phase.
Definition: fs_api.h:1463
char * emsg
Error message, NULL on success.
Definition: fs_api.h:1438
struct GNUNET_CRYPTO_FileHashContext * fhc
Context for hashing of the file.
Definition: fs_api.h:1443
struct GNUNET_HashCode file_id
Hash of the file's contents (once computed).
Definition: fs_api.h:1458

References _, GNUNET_FS_UnindexContext::emsg, GNUNET_FS_UnindexContext::fhc, GNUNET_FS_UnindexContext::file_id, GNUNET_FS_unindex_do_remove_(), GNUNET_FS_unindex_stop(), GNUNET_FS_unindex_sync_(), GNUNET_strdup, signal_unindex_error(), GNUNET_FS_UnindexContext::state, uc, UNINDEX_STATE_DS_REMOVE, UNINDEX_STATE_ERROR, and UNINDEX_STATE_HASHING.

Referenced by deserialize_unindex_file(), and GNUNET_FS_unindex_start().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_unindex_do_extract_keywords_()

void GNUNET_FS_unindex_do_extract_keywords_ ( struct GNUNET_FS_UnindexContext uc)

Extract the keywords for KBlock removal.

Parameters
uccontext for the unindex operation.

Extract the keywords for KBlock removal.

Parameters
uccontext for the unindex operation.

Definition at line 406 of file fs_unindex.c.

407 {
408  char *ex;
409 
410  if (GNUNET_OK !=
411  GNUNET_CONFIGURATION_get_value_string (uc->h->cfg, "FS", "EXTRACTORS",
412  &ex))
413  ex = NULL;
415  GNUNET_NO, ex,
417  uc);
418  GNUNET_free (ex);
419 }
static void unindex_directory_scan_cb(void *cls, const char *filename, int is_directory, enum GNUNET_FS_DirScannerProgressUpdateReason reason)
Function called by the directory scanner as we extract keywords that we will need to remove UBlocks.
Definition: fs_unindex.c:354
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
struct GNUNET_FS_DirScanner * GNUNET_FS_directory_scan_start(const char *filename, int disable_extractor, const char *ex, GNUNET_FS_DirScannerProgressCallback cb, void *cb_cls)
Start a directory scanner thread.
@ GNUNET_OK
Definition: gnunet_common.h:99
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration to use.
Definition: fs_api.h:1073
struct GNUNET_FS_DirScanner * dscan
Directory scanner to find keywords (KBlock removal).
Definition: fs_api.h:1370
char * filename
Name of the file that we are unindexing.
Definition: fs_api.h:1385
struct GNUNET_FS_Handle * h
Global FS context.
Definition: fs_api.h:1360

References GNUNET_FS_Handle::cfg, GNUNET_FS_UnindexContext::dscan, GNUNET_FS_UnindexContext::filename, GNUNET_CONFIGURATION_get_value_string(), GNUNET_free, GNUNET_FS_directory_scan_start(), GNUNET_NO, GNUNET_OK, GNUNET_FS_UnindexContext::h, uc, and unindex_directory_scan_cb().

Referenced by deserialize_unindex_file(), and unindex_extract_keywords().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_unindex_do_remove_kblocks_()

void GNUNET_FS_unindex_do_remove_kblocks_ ( struct GNUNET_FS_UnindexContext uc)

If necessary, connect to the datastore and remove the KBlocks.

Parameters
uccontext for the unindex operation.

Definition at line 580 of file fs_unindex.c.

581 {
582  const char *keyword;
583  const struct GNUNET_CRYPTO_EcdsaPrivateKey *anon;
584  struct GNUNET_CRYPTO_EcdsaPublicKey anon_pub;
585  struct GNUNET_CRYPTO_EcdsaPublicKey dpub;
586 
587  if (NULL == uc->dsh)
589  if (NULL == uc->dsh)
590  {
592  uc->emsg = GNUNET_strdup (_ ("Failed to connect to `datastore' service."));
595  return;
596  }
597  if ((NULL == uc->ksk_uri) ||
598  (uc->ksk_offset >= uc->ksk_uri->data.ksk.keywordCount))
599  {
600  unindex_finish (uc);
601  return;
602  }
605  &anon_pub);
606  keyword = &uc->ksk_uri->data.ksk.keywords[uc->ksk_offset][1];
608  keyword,
609  "fs-ublock",
610  &dpub);
611  GNUNET_CRYPTO_hash (&dpub,
612  sizeof(dpub),
613  &uc->uquery);
615  0 /* next_uid */,
616  false /* random */,
617  &uc->uquery,
619  0 /* priority */,
620  1 /* queue size */,
622  uc);
623 }
static void unindex_finish(struct GNUNET_FS_UnindexContext *uc)
Function called when we are done with removing UBlocks.
Definition: fs_unindex.c:289
static void process_kblock_for_unindex(void *cls, const struct GNUNET_HashCode *key, size_t size, const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority, uint32_t anonymity, uint32_t replication, struct GNUNET_TIME_Absolute expiration, uint64_t uid)
Function called from datastore with result from us looking for a UBlock.
Definition: fs_unindex.c:476
@ GNUNET_BLOCK_TYPE_FS_UBLOCK
Type of a block representing any type of search result (universal).
void GNUNET_CRYPTO_ecdsa_public_key_derive(const struct GNUNET_CRYPTO_EcdsaPublicKey *pub, const char *label, const char *context, struct GNUNET_CRYPTO_EcdsaPublicKey *result)
Derive a public key from a given public key and a label.
const struct GNUNET_CRYPTO_EcdsaPrivateKey * GNUNET_CRYPTO_ecdsa_key_get_anonymous(void)
Get the shared private key we use for anonymous users.
Definition: crypto_ecc.c:481
void GNUNET_CRYPTO_ecdsa_key_get_public(const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv, struct GNUNET_CRYPTO_EcdsaPublicKey *pub)
Extract the public key for the given private key.
Definition: crypto_ecc.c:186
struct GNUNET_DATASTORE_Handle * GNUNET_DATASTORE_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Connect to the datastore service.
struct GNUNET_DATASTORE_QueueEntry * GNUNET_DATASTORE_get_key(struct GNUNET_DATASTORE_Handle *h, uint64_t next_uid, bool random, const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, unsigned int queue_priority, unsigned int max_queue_size, GNUNET_DATASTORE_DatumProcessor proc, void *proc_cls)
Get a result for a particular key from the datastore.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:41
Private ECC key encoded for transmission.
Public ECC key (always for Curve25519) encoded in a format suitable for network transmission and ECDS...
struct GNUNET_DATASTORE_QueueEntry * dqe
Handle to datastore 'get_key' operation issued for obtaining KBlocks.
Definition: fs_api.h:1423
struct GNUNET_DATASTORE_Handle * dsh
Connection to the datastore service, only valid during the UNINDEX_STATE_DS_NOTIFY phase.
Definition: fs_api.h:1402
uint32_t ksk_offset
Current offset in KSK removal.
Definition: fs_api.h:1380
struct GNUNET_HashCode uquery
Current query of 'get_key' operation.
Definition: fs_api.h:1433
struct GNUNET_FS_Uri * ksk_uri
Keywords found (telling us which KBlocks to remove).
Definition: fs_api.h:1375
struct GNUNET_FS_Uri::@13::@14 ksk
union GNUNET_FS_Uri::@13 data

References _, GNUNET_FS_Handle::cfg, GNUNET_FS_Uri::data, GNUNET_FS_UnindexContext::dqe, GNUNET_FS_UnindexContext::dsh, GNUNET_FS_UnindexContext::emsg, GNUNET_BLOCK_TYPE_FS_UBLOCK, GNUNET_CRYPTO_ecdsa_key_get_anonymous(), GNUNET_CRYPTO_ecdsa_key_get_public(), GNUNET_CRYPTO_ecdsa_public_key_derive(), GNUNET_CRYPTO_hash(), GNUNET_DATASTORE_connect(), GNUNET_DATASTORE_get_key(), GNUNET_FS_unindex_sync_(), GNUNET_strdup, GNUNET_FS_UnindexContext::h, GNUNET_FS_Uri::ksk, GNUNET_FS_UnindexContext::ksk_offset, GNUNET_FS_UnindexContext::ksk_uri, process_kblock_for_unindex(), signal_unindex_error(), GNUNET_FS_UnindexContext::state, uc, unindex_finish(), UNINDEX_STATE_ERROR, and GNUNET_FS_UnindexContext::uquery.

Referenced by continue_after_remove(), deserialize_unindex_file(), process_kblock_for_unindex(), and unindex_directory_scan_cb().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_publish_make_status_()

void* GNUNET_FS_publish_make_status_ ( struct GNUNET_FS_ProgressInfo pi,
struct GNUNET_FS_PublishContext pc,
const struct GNUNET_FS_FileInformation p,
uint64_t  offset 
)

Fill in all of the generic fields for a publish event and call the callback.

Parameters
pistructure to fill in
pcoverall publishing context
pfile information for the file being published
offsetwhere in the file are we so far
Returns
value returned from callback

Definition at line 47 of file fs_publish.c.

51 {
52  pi->value.publish.pc = pc;
53  pi->value.publish.fi = p;
54  pi->value.publish.cctx = p->client_info;
55  pi->value.publish.pctx = (NULL == p->dir) ? NULL : p->dir->client_info;
56  pi->value.publish.filename = p->filename;
57  pi->value.publish.size =
58  (GNUNET_YES == p->is_directory) ? p->data.dir.dir_size :
59  p->data.file.file_size;
60  pi->value.publish.eta =
61  GNUNET_TIME_calculate_eta (p->start_time, offset,
62  pi->value.publish.size);
63  pi->value.publish.completed = offset;
64  pi->value.publish.duration =
66  pi->value.publish.anonymity = p->bo.anonymity_level;
67  pi->fsh = pc->h;
68  return pc->h->upcb (pc->h->upcb_cls, pi);
69 }
struct GNUNET_TIME_Relative GNUNET_TIME_calculate_eta(struct GNUNET_TIME_Absolute start, uint64_t finished, uint64_t total)
Calculate the estimate time of arrival/completion for an operation.
Definition: time.c:563
void * upcb_cls
Closure for upcb.
Definition: fs_api.h:1088
GNUNET_FS_ProgressCallback upcb
Function to call with updates on our progress.
Definition: fs_api.h:1083
struct GNUNET_FS_Handle * h
Handle to the global fs context.
Definition: fs_api.h:1183

References GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_calculate_eta(), GNUNET_YES, GNUNET_FS_PublishContext::h, p, pc, pi, GNUNET_FS_Handle::upcb, and GNUNET_FS_Handle::upcb_cls.

Referenced by ds_put_cont(), encode_cont(), fip_signal_resume(), fip_signal_start(), fip_signal_stop(), GNUNET_FS_publish_main_(), GNUNET_FS_publish_stop(), progress_proc(), signal_publish_completion(), signal_publish_error(), and suspend_operation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_download_make_status_()

void GNUNET_FS_download_make_status_ ( struct GNUNET_FS_ProgressInfo pi,
struct GNUNET_FS_DownloadContext dc 
)

Fill in all of the generic fields for a download event and call the callback.

Parameters
pistructure to fill in
dcoverall download context

Definition at line 103 of file fs_download.c.

105 {
106  pi->value.download.dc = dc;
107  pi->value.download.cctx = dc->client_info;
108  pi->value.download.pctx =
109  (NULL == dc->parent) ? NULL : dc->parent->client_info;
110  pi->value.download.sctx =
111  (NULL == dc->search) ? NULL : dc->search->client_info;
112  pi->value.download.uri = dc->uri;
113  pi->value.download.filename = dc->filename;
114  pi->value.download.size = dc->length;
115  /* FIXME: Fix duration calculation to account for pauses */
116  pi->value.download.duration =
118  pi->value.download.completed = dc->completed;
119  pi->value.download.anonymity = dc->anonymity;
120  pi->value.download.eta =
122  pi->value.download.is_active = (NULL == dc->mq) ? GNUNET_NO : GNUNET_YES;
123  pi->fsh = dc->h;
124  if (0 == (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
125  dc->client_info = dc->h->upcb (dc->h->upcb_cls, pi);
126  else
128 }
void * GNUNET_FS_search_probe_progress_(void *cls, const struct GNUNET_FS_ProgressInfo *info)
Notification of FS that a search probe has made progress.
Definition: fs_search.c:280
static struct GNUNET_FS_DownloadContext * dc
@ GNUNET_FS_DOWNLOAD_IS_PROBE
Internal option used to flag this download as a 'probe' for a search result.
char * filename
Where are we writing the data (name of the file, can be NULL!).
Definition: fs_api.h:1821
struct GNUNET_FS_Uri * uri
URI that identifies the file that we are downloading.
Definition: fs_api.h:1799
void * client_info
Context kept for the client.
Definition: fs_api.h:1794
uint64_t completed
How many bytes have we already received within the specified range (DBlocks only).
Definition: fs_api.h:1889
struct GNUNET_FS_SearchResult * search
Associated search (used when downloading files based on search results), or NULL for none.
Definition: fs_api.h:1769
uint64_t length
How many bytes starting from offset are desired? This is NOT the overall length of the file!
Definition: fs_api.h:1883
struct GNUNET_MQ_Handle * mq
Connection to the FS service.
Definition: fs_api.h:1757
uint32_t anonymity
Desired level of anonymity.
Definition: fs_api.h:1912
struct GNUNET_FS_DownloadContext * parent
Parent download (used when downloading files in directories).
Definition: fs_api.h:1763
enum GNUNET_FS_DownloadOptions options
Options for the download.
Definition: fs_api.h:1922
struct GNUNET_FS_Handle * h
Global FS context.
Definition: fs_api.h:1747
struct GNUNET_TIME_Absolute start_time
Time download was started.
Definition: fs_api.h:1902
void * client_info
Client info for this search result.
Definition: fs_api.h:533

References GNUNET_FS_DownloadContext::anonymity, GNUNET_FS_SearchResult::client_info, GNUNET_FS_DownloadContext::client_info, GNUNET_FS_DownloadContext::completed, dc, GNUNET_FS_DownloadContext::filename, GNUNET_FS_DOWNLOAD_IS_PROBE, GNUNET_FS_search_probe_progress_(), GNUNET_NO, GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_calculate_eta(), GNUNET_YES, GNUNET_FS_DownloadContext::h, GNUNET_FS_DownloadContext::length, GNUNET_FS_DownloadContext::mq, GNUNET_FS_DownloadContext::options, GNUNET_FS_DownloadContext::parent, pi, GNUNET_FS_DownloadContext::search, GNUNET_FS_DownloadContext::start_time, GNUNET_FS_Handle::upcb, GNUNET_FS_Handle::upcb_cls, and GNUNET_FS_DownloadContext::uri.

Referenced by activate_fs_download(), check_completed(), deactivate_fs_download(), GNUNET_FS_download_resume(), GNUNET_FS_download_signal_suspend_(), GNUNET_FS_download_start_task_(), process_result_with_request(), reconstruct_cb(), search_result_stop(), signal_download_resume(), and try_match_block().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_download_start_task_()

void GNUNET_FS_download_start_task_ ( void *  cls)

Task that creates the initial (top-level) download request for the file.

Parameters
clsthe 'struct GNUNET_FS_DownloadContext'

Definition at line 1800 of file fs_download.c.

1801 {
1802  struct GNUNET_FS_DownloadContext *dc = cls;
1803  struct GNUNET_FS_ProgressInfo pi;
1804  struct GNUNET_DISK_FileHandle *fh;
1805 
1806  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start task running...\n");
1807  dc->task = NULL;
1808  if (0 == dc->length)
1809  {
1810  /* no bytes required! */
1811  if (NULL != dc->filename)
1812  {
1816  | ((0 ==
1819  : 0),
1825  }
1828  pi.value.download.specifics.start.meta = dc->meta;
1830  check_completed (dc);
1831  return;
1832  }
1833  if (NULL != dc->emsg)
1834  return;
1835  if (NULL == dc->top_request)
1836  {
1838  0,
1839  dc->treedepth - 1,
1840  0,
1841  dc->offset,
1842  dc->length);
1845  ? dc->uri->data.chk.chk
1846  : dc->uri->data.loc.fi.chk;
1847  /* signal start */
1849  if (NULL != dc->search)
1852  pi.value.download.specifics.start.meta = dc->meta;
1854  }
1856  /* attempt reconstruction from disk */
1861  if (dc->top_request->state == BRS_CHK_SET)
1862  {
1863  if (NULL != dc->rfh)
1864  {
1865  /* first, try top-down */
1867  "Trying top-down reconstruction for `%s'\n",
1868  dc->filename);
1870  switch (dc->top_request->state)
1871  {
1872  case BRS_CHK_SET:
1873  break; /* normal */
1874 
1875  case BRS_DOWNLOAD_DOWN:
1876  break; /* normal, some blocks already down */
1877 
1878  case BRS_DOWNLOAD_UP:
1879  /* already done entirely, party! */
1880  if (NULL != dc->rfh)
1881  {
1882  /* avoid hanging on to file handle longer than
1883  * necessary */
1885  dc->rfh = NULL;
1886  }
1887  return;
1888 
1889  case BRS_ERROR:
1890  GNUNET_asprintf (&dc->emsg, _ ("Invalid URI"));
1893  pi.value.download.specifics.error.message = dc->emsg;
1895  return;
1896 
1897  default:
1898  GNUNET_assert (0);
1899  break;
1900  }
1901  }
1902  }
1903  /* attempt reconstruction from meta data */
1905  (NULL != dc->meta))
1906  {
1907  GNUNET_log (
1909  "Trying to find embedded meta data for download of size %llu with %u bytes MD\n",
1910  (unsigned long long) GNUNET_FS_uri_chk_get_file_size (dc->uri),
1914  {
1915  if (NULL != dc->rfh)
1916  {
1917  /* avoid hanging on to file handle longer than
1918  * necessary */
1920  dc->rfh = NULL;
1921  }
1922  return; /* finished, status update was already done for us */
1923  }
1924  }
1925  if (NULL != dc->rfh)
1926  {
1927  /* finally, actually run bottom-up */
1929  "Trying bottom-up reconstruction of file `%s'\n",
1930  dc->filename);
1931  dc->te =
1934  dc,
1935  &fh_reader,
1936  &reconstruct_cb,
1937  NULL,
1938  &reconstruct_cont);
1940  }
1941  else
1942  {
1943  /* simple, top-level download */
1946  }
1948  check_completed (dc);
1949 }
void GNUNET_FS_download_sync_(struct GNUNET_FS_DownloadContext *dc)
Synchronize this download struct with its mirror on disk.
Definition: fs_api.c:2035
#define MAX_INLINE_SIZE
Maximum size for a file to be considered for inlining in a directory.
Definition: fs_api.h:49
static void reconstruct_cb(void *cls, const struct ContentHashKey *chk, uint64_t offset, unsigned int depth, enum GNUNET_BLOCK_Type type, const void *block, uint16_t block_size)
Function called asking for the current (encoded) block to be processed.
Definition: fs_download.c:1616
static void check_completed(struct GNUNET_FS_DownloadContext *dc)
Check if all child-downloads have completed (or trigger them if necessary) and once we're completely ...
Definition: fs_download.c:375
static size_t fh_reader(void *cls, uint64_t offset, size_t max, void *buf, char **emsg)
Function called by the tree encoder to obtain a block of plaintext data (for the lowest level of the ...
Definition: fs_download.c:1768
static void try_top_down_reconstruction(struct GNUNET_FS_DownloadContext *dc, struct DownloadRequest *dr)
Try top-down reconstruction.
Definition: fs_download.c:662
static int match_full_data(void *cls, const char *plugin_name, enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format, const char *data_mime_type, const char *data, size_t data_len)
Type of a function that libextractor calls for each meta data item found.
Definition: fs_download.c:601
void GNUNET_FS_download_make_status_(struct GNUNET_FS_ProgressInfo *pi, struct GNUNET_FS_DownloadContext *dc)
Fill in all of the generic fields for a download event and call the callback.
Definition: fs_download.c:103
static void reconstruct_cont(void *cls)
Continuation after a possible attempt to reconstruct the current IBlock from the existing file.
Definition: fs_download.c:1561
static struct DownloadRequest * create_download_request(struct DownloadRequest *parent, unsigned int chk_idx, unsigned int depth, uint64_t dr_offset, uint64_t file_start_offset, uint64_t desired_length)
(recursively) Create a download request structure.
Definition: fs_download.c:1485
void GNUNET_FS_download_start_downloading_(struct GNUNET_FS_DownloadContext *dc)
Start the downloading process (by entering the queue).
Definition: fs_download.c:2248
static void get_next_block(void *cls)
Task requesting the next block from the tree encoder.
Definition: fs_download.c:1589
static void schedule_block_download(struct GNUNET_FS_DownloadContext *dc, struct DownloadRequest *dr)
Schedule the download of the specified block in the tree.
Definition: fs_download.c:777
struct GNUNET_FS_TreeEncoder * GNUNET_FS_tree_encoder_create(struct GNUNET_FS_Handle *h, uint64_t size, void *cls, GNUNET_FS_DataReader reader, GNUNET_FS_TreeBlockProcessor proc, GNUNET_FS_TreeProgressCallback progress, GNUNET_SCHEDULER_TaskCallback cont)
Initialize a tree encoder.
Definition: fs_tree.c:258
static struct GNUNET_DISK_FileHandle * fh
File handle to STDIN, for reading restart/quit commands.
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
@ GNUNET_DISK_OPEN_TRUNCATE
Truncate file if it exists.
@ GNUNET_DISK_OPEN_CREATE
Create file if it doesn't exist.
@ GNUNET_DISK_OPEN_READWRITE
Open the file for both reading and writing.
@ GNUNET_DISK_PERM_USER_READ
Owner can read.
@ GNUNET_DISK_PERM_GROUP_READ
Group can read.
@ GNUNET_DISK_PERM_USER_WRITE
Owner can write.
@ GNUNET_DISK_PERM_OTHER_READ
Everybody can read.
uint64_t GNUNET_FS_uri_chk_get_file_size(const struct GNUNET_FS_Uri *uri)
What is the size of the file that this URI refers to?
Definition: fs_uri.c:1376
int GNUNET_CONTAINER_meta_data_iterate(const struct GNUNET_CONTAINER_MetaData *md, EXTRACTOR_MetaDataProcessor iter, void *iter_cls)
Iterate over MD entries.
ssize_t GNUNET_CONTAINER_meta_data_get_serialized_size(const struct GNUNET_CONTAINER_MetaData *md)
Get the size of the full meta-data in serialized form.
enum BlockRequestState state
State in the FSM.
Definition: fs_api.h:1717
struct ContentHashKey chk
CHK for the request for this block (set during reconstruction to what we have on disk,...
Definition: fs_api.h:1690
struct ContentHashKey chk
Query and key of the top GNUNET_EC_IBlock.
Definition: fs_api.h:103
Handle used to access files (and pipes).
Context for controlling a download.
Definition: fs_api.h:1743
unsigned int treedepth
The depth of the file-tree.
Definition: fs_api.h:1917
struct GNUNET_DISK_FileHandle * rfh
File handle for reading data from an existing file (to pass to tree encoder).
Definition: fs_api.h:1844
int issue_requests
Are we ready to issue requests (reconstructions are finished)?
Definition: fs_api.h:1934
uint64_t offset
What is the first offset that we're interested in?
Definition: fs_api.h:1877
char * emsg
Error message, NULL if we're doing OK.
Definition: fs_api.h:1809
struct GNUNET_SCHEDULER_Task * task
ID of a task that is using this struct and that must be cancelled when the download is being stopped ...
Definition: fs_api.h:1871
struct GNUNET_FS_TreeEncoder * te
Tree encoder used for the reconstruction.
Definition: fs_api.h:1838
struct DownloadRequest * top_request
Top-level download request.
Definition: fs_api.h:1855
struct GNUNET_CONTAINER_MetaData * meta
Known meta-data for the file (can be NULL).
Definition: fs_api.h:1804
enum GNUNET_FS_UriType type
Type of the URI.
Definition: fs_api.h:170
struct Location loc
Information needed to retrieve a file including signed location (identity of a peer) of the content.
Definition: fs_api.h:217
struct FileIdentifier chk
Information needed to retrieve a file (content-hash-key plus file size).
Definition: fs_api.h:211
struct FileIdentifier fi
Information about the shared file.
Definition: fs_api.h:116

References _, BRS_CHK_SET, BRS_DOWNLOAD_DOWN, BRS_DOWNLOAD_UP, BRS_ERROR, check_completed(), GNUNET_FS_Uri::chk, FileIdentifier::chk, DownloadRequest::chk, create_download_request(), GNUNET_FS_Uri::data, dc, GNUNET_FS_DownloadContext::emsg, fh, fh_reader(), Location::fi, GNUNET_FS_DownloadContext::filename, get_next_block(), GNUNET_asprintf(), GNUNET_assert, GNUNET_CONTAINER_meta_data_get_serialized_size(), GNUNET_CONTAINER_meta_data_iterate(), GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_test(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_READ, GNUNET_DISK_OPEN_READWRITE, GNUNET_DISK_OPEN_TRUNCATE, GNUNET_DISK_PERM_GROUP_READ, GNUNET_DISK_PERM_NONE, GNUNET_DISK_PERM_OTHER_READ, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_ERROR_TYPE_DEBUG, GNUNET_FS_download_make_status_(), GNUNET_FS_download_start_downloading_(), GNUNET_FS_download_sync_(), GNUNET_FS_search_result_sync_(), GNUNET_FS_STATUS_DOWNLOAD_ERROR, GNUNET_FS_STATUS_DOWNLOAD_START, GNUNET_FS_tree_encoder_create(), GNUNET_FS_URI_CHK, GNUNET_FS_uri_chk_get_file_size(), GNUNET_log, GNUNET_SCHEDULER_add_now(), GNUNET_YES, GNUNET_FS_DownloadContext::h, GNUNET_FS_DownloadContext::issue_requests, GNUNET_FS_DownloadContext::length, GNUNET_FS_Uri::loc, match_full_data(), MAX_INLINE_SIZE, GNUNET_FS_DownloadContext::meta, GNUNET_FS_DownloadContext::offset, pi, reconstruct_cb(), reconstruct_cont(), GNUNET_FS_DownloadContext::rfh, schedule_block_download(), GNUNET_FS_DownloadContext::search, DownloadRequest::state, GNUNET_FS_DownloadContext::task, GNUNET_FS_DownloadContext::te, GNUNET_FS_DownloadContext::top_request, GNUNET_FS_DownloadContext::treedepth, try_top_down_reconstruction(), GNUNET_FS_Uri::type, and GNUNET_FS_DownloadContext::uri.

Referenced by create_download_context(), and deserialize_download().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_unindex_make_status_()

void GNUNET_FS_unindex_make_status_ ( struct GNUNET_FS_ProgressInfo pi,
struct GNUNET_FS_UnindexContext uc,
uint64_t  offset 
)

Fill in all of the generic fields for an unindex event and call the callback.

Parameters
pistructure to fill in
ucoverall unindex context
offsetwhere we are in the file (for progress)

Definition at line 84 of file fs_unindex.c.

87 {
88  pi->value.unindex.uc = uc;
89  pi->value.unindex.cctx = uc->client_info;
90  pi->value.unindex.filename = uc->filename;
91  pi->value.unindex.size = uc->file_size;
92  pi->value.unindex.eta =
94  pi->value.unindex.duration =
96  pi->value.unindex.completed = offset;
97  pi->fsh = uc->h;
98  uc->client_info = uc->h->upcb (uc->h->upcb_cls, pi);
99 }
void * client_info
Pointer kept for the client.
Definition: fs_api.h:1407
struct GNUNET_TIME_Absolute start_time
When did we start?
Definition: fs_api.h:1453
uint64_t file_size
Overall size of the file.
Definition: fs_api.h:1448

References GNUNET_FS_UnindexContext::client_info, GNUNET_FS_UnindexContext::file_size, GNUNET_FS_UnindexContext::filename, GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_calculate_eta(), GNUNET_FS_UnindexContext::h, pi, GNUNET_FS_UnindexContext::start_time, uc, GNUNET_FS_Handle::upcb, and GNUNET_FS_Handle::upcb_cls.

Referenced by deserialize_unindex_file(), GNUNET_FS_unindex_signal_suspend_(), GNUNET_FS_unindex_start(), GNUNET_FS_unindex_stop(), handle_unindex_response(), signal_unindex_error(), and unindex_progress().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_search_make_status_()

void* GNUNET_FS_search_make_status_ ( struct GNUNET_FS_ProgressInfo pi,
struct GNUNET_FS_Handle h,
struct GNUNET_FS_SearchContext sc 
)

Fill in all of the generic fields for a search event and call the callback.

Parameters
pistructure to fill in
hfile-sharing handle
scoverall search context
Returns
value returned by the callback

Definition at line 48 of file fs_search.c.

51 {
52  void *ret;
53 
54  pi->value.search.sc = sc;
55  pi->value.search.cctx = (NULL != sc) ? sc->client_info : NULL;
56  pi->value.search.pctx =
57  ((NULL == sc) || (NULL == sc->psearch_result))
58  ? NULL
60  pi->value.search.query = (NULL != sc) ? sc->uri : NULL;
61  pi->value.search.duration = (NULL != sc)
63  sc->start_time)
65  pi->value.search.anonymity = (NULL != sc) ? sc->anonymity : 0;
66  pi->fsh = h;
67  ret = h->upcb (h->upcb_cls, pi);
68  return ret;
69 }
static struct GNUNET_FS_SearchContext * sc
Definition: gnunet-search.c:84
#define GNUNET_TIME_UNIT_ZERO
Relative time zero.
void * client_info
Pointer we keep for the client.
Definition: fs_api.h:1540
struct GNUNET_FS_SearchResult * psearch_result
For update-searches, link to the search result that triggered the update search; otherwise NULL.
Definition: fs_api.h:1530
uint32_t anonymity
Anonymity level for the search.
Definition: fs_api.h:1587
struct GNUNET_FS_Uri * uri
List of keywords that we're looking for.
Definition: fs_api.h:1524
struct GNUNET_TIME_Absolute start_time
When did we start?
Definition: fs_api.h:1569

References GNUNET_FS_SearchContext::anonymity, GNUNET_FS_SearchResult::client_info, GNUNET_FS_SearchContext::client_info, GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_UNIT_ZERO, h, pi, GNUNET_FS_SearchContext::psearch_result, ret, sc, GNUNET_FS_SearchContext::start_time, and GNUNET_FS_SearchContext::uri.

Referenced by GNUNET_FS_search_continue(), GNUNET_FS_search_pause(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_stop(), notify_client_chk_result(), notify_client_chk_update(), search_result_stop(), search_result_suspend(), search_start(), signal_probe_result(), signal_result_resume(), and signal_search_resume().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_unindex_do_remove_()

void GNUNET_FS_unindex_do_remove_ ( struct GNUNET_FS_UnindexContext uc)

Connect to the datastore and remove the blocks.

Parameters
uccontext for the unindex operation.

Definition at line 649 of file fs_unindex.c.

650 {
651  if (NULL == uc->dsh)
653  if (NULL == uc->dsh)
654  {
656  uc->emsg = GNUNET_strdup (_ ("Failed to connect to `datastore' service."));
659  return;
660  }
661  uc->fh =
664  if (NULL == uc->fh)
665  {
667  uc->dsh = NULL;
669  uc->emsg = GNUNET_strdup (_ ("Failed to open file for unindexing."));
672  return;
673  }
674  uc->tc =
676  uc->file_size,
677  uc,
683 }
void GNUNET_FS_tree_encoder_next(struct GNUNET_FS_TreeEncoder *te)
Encrypt the next block of the file (and call proc and progress accordingly; or of course "cont" if we...
Definition: fs_tree.c:320
static void unindex_progress(void *cls, uint64_t offset, const void *pt_block, size_t pt_size, unsigned int depth)
Function called with information about our progress in computing the tree encoding.
Definition: fs_unindex.c:113
static size_t unindex_reader(void *cls, uint64_t offset, size_t max, void *buf, char **emsg)
Function called by the tree encoder to obtain a block of plaintext data (for the lowest level of the ...
Definition: fs_unindex.c:51
static void unindex_process(void *cls, const struct ContentHashKey *chk, uint64_t offset, unsigned int depth, enum GNUNET_BLOCK_Type type, const void *block, uint16_t block_size)
Function called asking for the current (encoded) block to be processed.
Definition: fs_unindex.c:193
static void unindex_extract_keywords(void *cls)
Function called when the tree encoder has processed all blocks.
Definition: fs_unindex.c:633
void GNUNET_DATASTORE_disconnect(struct GNUNET_DATASTORE_Handle *h, int drop)
Disconnect from the datastore service (and free associated resources).
struct GNUNET_FS_TreeEncoder * tc
Merkle-ish tree encoder context.
Definition: fs_api.h:1412
struct GNUNET_DISK_FileHandle * fh
Handle used to read the file.
Definition: fs_api.h:1417

References _, GNUNET_FS_Handle::cfg, GNUNET_FS_UnindexContext::dsh, GNUNET_FS_UnindexContext::emsg, GNUNET_FS_UnindexContext::fh, GNUNET_FS_UnindexContext::file_size, GNUNET_FS_UnindexContext::filename, GNUNET_DATASTORE_connect(), GNUNET_DATASTORE_disconnect(), GNUNET_DISK_file_open(), GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE, GNUNET_FS_tree_encoder_create(), GNUNET_FS_tree_encoder_next(), GNUNET_FS_unindex_sync_(), GNUNET_NO, GNUNET_strdup, GNUNET_FS_UnindexContext::h, signal_unindex_error(), GNUNET_FS_UnindexContext::state, GNUNET_FS_UnindexContext::tc, uc, unindex_extract_keywords(), unindex_process(), unindex_progress(), unindex_reader(), and UNINDEX_STATE_ERROR.

Referenced by deserialize_unindex_file(), and GNUNET_FS_unindex_process_hash_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_search_start_searching_()

int GNUNET_FS_search_start_searching_ ( struct GNUNET_FS_SearchContext sc)

Build the request and actually initiate the search using the GNUnet FS service.

Parameters
scsearch context
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1401 of file fs_search.c.

1402 {
1403  unsigned int i;
1404  const char *keyword;
1405  const struct GNUNET_CRYPTO_EcdsaPrivateKey *anon;
1406  struct GNUNET_CRYPTO_EcdsaPublicKey anon_pub;
1407  struct SearchRequestEntry *sre;
1408 
1409  GNUNET_assert (NULL == sc->mq);
1410  if (GNUNET_FS_uri_test_ksk (sc->uri))
1411  {
1412  GNUNET_assert (0 != sc->uri->data.ksk.keywordCount);
1414  GNUNET_CRYPTO_ecdsa_key_get_public (anon, &anon_pub);
1415  sc->requests
1416  = GNUNET_new_array (sc->uri->data.ksk.keywordCount,
1417  struct SearchRequestEntry);
1418 
1419  for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1420  {
1421  keyword = &sc->uri->data.ksk.keywords[i][1];
1422  sre = &sc->requests[i];
1423  sre->keyword = GNUNET_strdup (keyword);
1425  keyword,
1426  "fs-ublock",
1427  &sre->dpub);
1428  GNUNET_CRYPTO_hash (&sre->dpub,
1429  sizeof(struct GNUNET_CRYPTO_EcdsaPublicKey),
1430  &sre->uquery);
1431  sre->mandatory = (sc->uri->data.ksk.keywords[i][0] == '+');
1432  if (sre->mandatory)
1433  sc->mandatory_count++;
1435  }
1438  sc);
1439  }
1440  GNUNET_assert (NULL == sc->task);
1441  do_reconnect (sc);
1442  if (NULL == sc->mq)
1443  {
1445  sc->task = NULL;
1446  return GNUNET_SYSERR;
1447  }
1448  return GNUNET_OK;
1449 }
static int update_sre_result_maps(void *cls, const struct GNUNET_HashCode *key, void *value)
Update the 'results' map for the individual keywords with the results from the 'global' result set.
Definition: fs_search.c:1380
static void do_reconnect(void *cls)
Reconnect to the FS service and transmit our queries NOW.
Definition: fs_search.c:1271
int GNUNET_FS_uri_test_ksk(const struct GNUNET_FS_Uri *uri)
Is this a keyword URI?
Definition: fs_uri.c:1340
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.
#define GNUNET_new_array(n, type)
Allocate a size n array with structs or unions of the given type.
struct GNUNET_CONTAINER_MultiHashMap * master_result_map
Map that contains a struct GNUNET_FS_SearchResult for each result that was found in the search.
Definition: fs_api.h:1558
struct SearchRequestEntry * requests
Per-keyword information for a keyword search.
Definition: fs_api.h:1564
struct GNUNET_SCHEDULER_Task * task
ID of a task that is using this struct and that must be cancelled when the search is being stopped (i...
Definition: fs_api.h:1582
uint32_t mandatory_count
Number of mandatory keywords in this query.
Definition: fs_api.h:1592
struct GNUNET_MQ_Handle * mq
Connection to the FS service.
Definition: fs_api.h:1535
Information we keep for each keyword in a keyword search.
Definition: fs_api.h:1471
int mandatory
Is this keyword a mandatory keyword (started with '+')?
Definition: fs_api.h:1502
struct GNUNET_CONTAINER_MultiHashMap * results
Map that contains a "struct GNUNET_FS_SearchResult" for each result that was found under this keyword...
Definition: fs_api.h:1496
struct GNUNET_CRYPTO_EcdsaPublicKey dpub
Derived public key, hashes to 'uquery'.
Definition: fs_api.h:1480
char * keyword
The original keyword, used to derive the key (for decrypting the UBlock).
Definition: fs_api.h:1486
struct GNUNET_HashCode uquery
Hash of the public key, also known as the query.
Definition: fs_api.h:1475

References GNUNET_FS_Uri::data, do_reconnect(), SearchRequestEntry::dpub, GNUNET_assert, GNUNET_CONTAINER_multihashmap_create(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_CRYPTO_ecdsa_key_get_anonymous(), GNUNET_CRYPTO_ecdsa_key_get_public(), GNUNET_CRYPTO_ecdsa_public_key_derive(), GNUNET_CRYPTO_hash(), GNUNET_FS_uri_test_ksk(), GNUNET_new_array, GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_cancel(), GNUNET_strdup, GNUNET_SYSERR, SearchRequestEntry::keyword, GNUNET_FS_Uri::ksk, SearchRequestEntry::mandatory, GNUNET_FS_SearchContext::mandatory_count, GNUNET_FS_SearchContext::master_result_map, GNUNET_FS_SearchContext::mq, GNUNET_FS_SearchContext::requests, SearchRequestEntry::results, sc, GNUNET_FS_SearchContext::task, update_sre_result_maps(), SearchRequestEntry::uquery, and GNUNET_FS_SearchContext::uri.

Referenced by deserialize_search(), and search_start().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_download_start_downloading_()

void GNUNET_FS_download_start_downloading_ ( struct GNUNET_FS_DownloadContext dc)

Start the downloading process (by entering the queue).

Parameters
dcour download context

Definition at line 2248 of file fs_download.c.

2249 {
2250  if (dc->completed == dc->length)
2251  return;
2252  if (NULL != dc->mq)
2253  return; /* already running */
2254  GNUNET_assert (NULL == dc->job_queue);
2255  GNUNET_assert (NULL == dc->task);
2256  GNUNET_assert (NULL != dc->active);
2257  dc->job_queue =
2258  GNUNET_FS_queue_ (dc->h,
2261  dc,
2262  (dc->length + DBLOCK_SIZE - 1) / DBLOCK_SIZE,
2267  "Download %p put into queue as job %p\n",
2268  dc,
2269  dc->job_queue);
2270 }
#define DBLOCK_SIZE
Size of the individual blocks used for file-sharing.
Definition: fs.h:40
struct GNUNET_FS_QueueEntry * GNUNET_FS_queue_(struct GNUNET_FS_Handle *h, GNUNET_SCHEDULER_TaskCallback start, GNUNET_SCHEDULER_TaskCallback stop, void *cls, unsigned int blocks, enum GNUNET_FS_QueuePriority priority)
Add a job to the queue.
Definition: fs_api.c:320
static void activate_fs_download(void *cls)
We're allowed to ask the FS service for our blocks.
Definition: fs_download.c:1428
static void deactivate_fs_download(void *cls)
We must stop to ask the FS service for our blocks.
Definition: fs_download.c:1449
struct GNUNET_FS_QueueEntry * job_queue
Our entry in the job queue.
Definition: fs_api.h:1833
struct GNUNET_CONTAINER_MultiHashMap * active
Map of active requests (those waiting for a response).
Definition: fs_api.h:1850

References activate_fs_download(), GNUNET_FS_DownloadContext::active, GNUNET_FS_DownloadContext::completed, DBLOCK_SIZE, dc, deactivate_fs_download(), GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_FS_DOWNLOAD_IS_PROBE, GNUNET_FS_queue_(), GNUNET_FS_QUEUE_PRIORITY_NORMAL, GNUNET_FS_QUEUE_PRIORITY_PROBE, GNUNET_log, GNUNET_FS_DownloadContext::h, GNUNET_FS_DownloadContext::job_queue, GNUNET_FS_DownloadContext::length, GNUNET_FS_DownloadContext::mq, GNUNET_FS_DownloadContext::options, and GNUNET_FS_DownloadContext::task.

Referenced by GNUNET_FS_download_start_task_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_search_start_probe_()

void GNUNET_FS_search_start_probe_ ( struct GNUNET_FS_SearchResult sr)

Start download probes for the given search result.

Parameters
srthe search result

Definition at line 430 of file fs_search.c.

431 {
432  uint64_t off;
433  uint64_t len;
434 
435  if (NULL != sr->probe_ctx)
436  return;
437  if (NULL != sr->download)
438  return;
439  if (0 == (sr->h->flags & GNUNET_FS_FLAGS_DO_PROBES))
440  return;
442  return;
443  if ( (GNUNET_FS_URI_CHK != sr->uri->type) &&
444  (GNUNET_FS_URI_LOC != sr->uri->type) )
445  return;
447  if (0 == len)
448  return;
449  if ((len <= DBLOCK_SIZE) && (sr->availability_success > 0))
450  return;
451  off = len / DBLOCK_SIZE;
452  if (off > 0)
454  off *= DBLOCK_SIZE;
455  if (len - off < DBLOCK_SIZE)
456  len = len - off;
457  else
458  len = DBLOCK_SIZE;
460  "Starting probe #%u (at offset %llu) for search result %p\n",
461  sr->availability_trials + 1,
462  (unsigned long long) off,
463  sr);
466  2 * (1
467  + sr->availability_trials));
468  sr->probe_ctx =
469  GNUNET_FS_download_start (sr->h, sr->uri, sr->meta, NULL, NULL, off,
470  len, sr->anonymity,
472  | GNUNET_FS_DOWNLOAD_IS_PROBE, sr, NULL);
474 }
#define AVAILABILITY_TRIALS_MAX
Number of availability trials we perform per search result.
Definition: fs_search.c:36
static void start_probe_ping_task(struct GNUNET_FS_SearchResult *sr)
Start the ping task for this search result.
Definition: fs_search.c:389
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...
uint32_t GNUNET_CRYPTO_random_u32(enum GNUNET_CRYPTO_Quality mode, uint32_t i)
Produce a random value.
@ GNUNET_CRYPTO_QUALITY_WEAK
No good quality of the operation is needed (i.e., random numbers can be pseudo-random).
struct GNUNET_FS_DownloadContext * GNUNET_FS_download_start(struct GNUNET_FS_Handle *h, const struct GNUNET_FS_Uri *uri, const struct GNUNET_CONTAINER_MetaData *meta, const char *filename, const char *tempname, uint64_t offset, uint64_t length, uint32_t anonymity, enum GNUNET_FS_DownloadOptions options, void *cctx, struct GNUNET_FS_DownloadContext *parent)
Download parts of a file.
Definition: fs_download.c:2130
@ GNUNET_FS_FLAGS_DO_PROBES
Should we automatically trigger probes for search results to determine availability?...
@ GNUNET_FS_DOWNLOAD_NO_TEMPORARIES
Do not append temporary data to the target file (for the IBlocks).
struct GNUNET_TIME_Relative GNUNET_TIME_relative_saturating_multiply(struct GNUNET_TIME_Relative rel, unsigned long long factor)
Saturating multiply relative time by a given factor.
Definition: time.c:530
enum GNUNET_FS_Flags flags
General flags.
Definition: fs_api.h:1161
struct GNUNET_TIME_Relative avg_block_latency
Average time we take for a single request to be satisfied.
Definition: fs_api.h:1146
struct GNUNET_FS_DownloadContext * download
ID of an associated download based on this search result (or NULL for none).
Definition: fs_api.h:545
struct GNUNET_FS_DownloadContext * probe_ctx
ID of a job that is currently probing this results' availability (NULL if we are not currently probin...
Definition: fs_api.h:539
uint32_t availability_trials
Number of availability trials that we have performed for this search result.
Definition: fs_api.h:612
struct GNUNET_FS_Uri * uri
URI to which this search result refers to.
Definition: fs_api.h:523
struct GNUNET_FS_Handle * h
File-sharing context this result belongs to.
Definition: fs_api.h:502
struct GNUNET_CONTAINER_MetaData * meta
Metadata for the search result.
Definition: fs_api.h:528
uint32_t anonymity
Anonymity level to use for probes using this search result.
Definition: fs_api.h:588
uint32_t availability_success
Number of availability tests that have succeeded for this result.
Definition: fs_api.h:606

References GNUNET_FS_SearchResult::anonymity, GNUNET_FS_SearchResult::availability_success, GNUNET_FS_SearchResult::availability_trials, AVAILABILITY_TRIALS_MAX, GNUNET_FS_Handle::avg_block_latency, DBLOCK_SIZE, GNUNET_FS_SearchResult::download, GNUNET_FS_Handle::flags, GNUNET_CRYPTO_QUALITY_WEAK, GNUNET_CRYPTO_random_u32(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_FS_DOWNLOAD_IS_PROBE, GNUNET_FS_DOWNLOAD_NO_TEMPORARIES, GNUNET_FS_download_start(), GNUNET_FS_FLAGS_DO_PROBES, GNUNET_FS_URI_CHK, GNUNET_FS_uri_chk_get_file_size(), GNUNET_FS_URI_LOC, GNUNET_log, GNUNET_TIME_relative_saturating_multiply(), GNUNET_FS_SearchResult::h, len, GNUNET_FS_SearchResult::meta, GNUNET_FS_SearchResult::probe_ctx, GNUNET_FS_SearchResult::remaining_probe_time, start_probe_ping_task(), GNUNET_FS_Uri::type, and GNUNET_FS_SearchResult::uri.

Referenced by GNUNET_FS_probe(), process_ksk_result(), process_sks_result(), search_result_resume_probes(), signal_probe_result(), and signal_result_resume().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_remove_sync_file_()

void GNUNET_FS_remove_sync_file_ ( struct GNUNET_FS_Handle h,
const char *  ext,
const char *  ent 
)

Remove serialization/deserialization file from disk.

Parameters
hmaster context
extcomponent of the path
ententity identifier

Definition at line 727 of file fs_api.c.

730 {
731  char *filename;
732 
733  if ((NULL == ent) || (0 == strlen (ent)))
734  {
735  GNUNET_break (0);
736  return;
737  }
738  filename = get_serialization_file_name (h, ext, ent);
739  if (NULL != filename)
740  {
741  if ((0 != unlink (filename)) && (ENOENT != errno))
744  }
745 }
static char * get_serialization_file_name(struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
Return the full filename where we would store state information (for serialization/deserialization).
Definition: fs_api.c:574
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...

References filename, get_serialization_file_name(), GNUNET_break, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log_strerror_file, and h.

Referenced by deserialize_search_file(), deserialize_unindex_file(), fip_signal_stop(), free_search_context(), GNUNET_FS_publish_stop(), GNUNET_FS_publish_sync_(), GNUNET_FS_search_stop(), GNUNET_FS_search_sync_(), GNUNET_FS_unindex_stop(), GNUNET_FS_unindex_sync_(), and search_result_stop().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_remove_sync_dir_()

void GNUNET_FS_remove_sync_dir_ ( struct GNUNET_FS_Handle h,
const char *  ext,
const char *  uni 
)

Remove serialization/deserialization directory from disk.

Parameters
hmaster context
extcomponent of the path
uniunique name of parent

Definition at line 786 of file fs_api.c.

789 {
790  char *dn;
791 
792  if (NULL == uni)
793  return;
794  dn = get_serialization_file_name_in_dir (h, ext, uni, "");
795  if (NULL == dn)
796  return;
800  GNUNET_free (dn);
801 }
static char * get_serialization_file_name_in_dir(struct GNUNET_FS_Handle *h, const char *ext, const char *uni, const char *ent)
Return the full filename where we would store state information (for serialization/deserialization) t...
Definition: fs_api.c:614
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_remove(const char *filename)
Remove all files in a directory (rm -rf).
Definition: disk.c:1085
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

References get_serialization_file_name_in_dir(), GNUNET_DISK_directory_remove(), GNUNET_DISK_directory_test(), GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log_strerror_file, GNUNET_OK, GNUNET_YES, and h.

Referenced by free_search_context(), and GNUNET_FS_search_stop().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_file_information_sync_()

void GNUNET_FS_file_information_sync_ ( struct GNUNET_FS_FileInformation fi)

Synchronize this file-information struct with its mirror on disk.

Note that all internal FS-operations that change file information data should already call "sync" internally, so this function is likely not useful for clients.

Parameters
fithe struct to sync

Synchronize this file-information struct with its mirror on disk.

Parameters
fifile information to sync with disk

Definition at line 1327 of file fs_api.c.

1328 {
1329  char *fn;
1330  struct GNUNET_BIO_WriteHandle *wh;
1331  char b;
1332  char *ksks;
1333  char *chks;
1334  char *skss;
1335 
1336  if (NULL == fi->serialization)
1337  fi->serialization =
1339  if (NULL == fi->serialization)
1340  return;
1341  wh =
1343  if (NULL == wh)
1344  {
1345  GNUNET_free (fi->serialization);
1346  fi->serialization = NULL;
1347  return;
1348  }
1349  if (GNUNET_YES == fi->is_directory)
1350  b = 4;
1351  else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1352  b = 3;
1353  else if (GNUNET_YES == fi->data.file.have_hash)
1354  b = 2;
1355  else if (GNUNET_YES == fi->data.file.do_index)
1356  b = 1;
1357  else
1358  b = 0;
1359  if (NULL != fi->keywords)
1360  ksks = GNUNET_FS_uri_to_string (fi->keywords);
1361  else
1362  ksks = NULL;
1363  if (NULL != fi->chk_uri)
1364  chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1365  else
1366  chks = NULL;
1367  if (NULL != fi->sks_uri)
1368  skss = GNUNET_FS_uri_to_string (fi->sks_uri);
1369  else
1370  skss = NULL;
1371  struct GNUNET_BIO_WriteSpec ws1[] = {
1372  GNUNET_BIO_write_spec_object ("b", &b, sizeof (b)),
1373  GNUNET_BIO_write_spec_meta_data ("meta", fi->meta),
1374  GNUNET_BIO_write_spec_string ("ksks", ksks),
1375  GNUNET_BIO_write_spec_string ("chks", chks),
1376  GNUNET_BIO_write_spec_string ("skss", skss),
1378  };
1379  struct GNUNET_BIO_WriteSpec ws2[] = {
1380  GNUNET_BIO_write_spec_string ("emsg", fi->emsg),
1381  GNUNET_BIO_write_spec_string ("filename", fi->filename),
1383  "expiration time",
1384  (int64_t *) &fi->bo.expiration_time.abs_value_us),
1386  "anonymity level",
1387  (int32_t *) &fi->bo.anonymity_level),
1389  "content priority",
1390  (int32_t *) &fi->bo.content_priority),
1392  "replication level",
1393  (int32_t *) &fi->bo.replication_level),
1395  };
1396  if ((GNUNET_OK != GNUNET_BIO_write_spec_commit (wh, ws1)) ||
1397  (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1399  {
1400  GNUNET_break (0);
1401  goto cleanup;
1402  }
1403  GNUNET_free (chks);
1404  chks = NULL;
1405  GNUNET_free (ksks);
1406  ksks = NULL;
1407  GNUNET_free (skss);
1408  skss = NULL;
1409 
1410  switch (b)
1411  {
1412  case 0: /* file-insert */
1413  if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, "file size",
1414  fi->data.file.file_size))
1415  {
1416  GNUNET_break (0);
1417  goto cleanup;
1418  }
1419  if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1420  if (GNUNET_OK != copy_from_reader (wh, fi))
1421  {
1422  GNUNET_break (0);
1423  goto cleanup;
1424  }
1425  break;
1426 
1427  case 1: /* file-index, no hash */
1428  if (NULL == fi->filename)
1429  {
1430  GNUNET_break (0);
1431  goto cleanup;
1432  }
1433  if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, "file size",
1434  fi->data.file.file_size))
1435  {
1436  GNUNET_break (0);
1437  goto cleanup;
1438  }
1439  break;
1440 
1441  case 2: /* file-index-with-hash */
1442  case 3: /* file-index-with-hash-confirmed */
1443  if (NULL == fi->filename)
1444  {
1445  GNUNET_break (0);
1446  goto cleanup;
1447  }
1448  if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, "file size",
1449  fi->data.file.file_size)) ||
1451  "file id",
1452  &fi->data.file.file_id,
1453  sizeof(struct GNUNET_HashCode))))
1454  {
1455  GNUNET_break (0);
1456  goto cleanup;
1457  }
1458  break;
1459 
1460  case 4: /* directory */
1461  if ((NULL != fi->data.dir.entries) &&
1462  (NULL == fi->data.dir.entries->serialization))
1464  struct GNUNET_BIO_WriteSpec ws[] = {
1465  GNUNET_BIO_write_spec_int32 ("dir size",
1466  (int32_t *) &fi->data.dir.dir_size),
1468  "contents completed",
1469  (int64_t *) &fi->data.dir.contents_completed),
1470  GNUNET_BIO_write_spec_int64 ("contents size",
1471  (int64_t *) &fi->data.dir.contents_size),
1472  GNUNET_BIO_write_spec_object ("dir data",
1473  fi->data.dir.dir_data,
1474  (uint32_t) fi->data.dir.dir_size),
1475  GNUNET_BIO_write_spec_string ("dir entries",
1476  (fi->data.dir.entries == NULL)
1477  ? NULL
1478  : fi->data.dir.entries->serialization),
1480  };
1481  if ((GNUNET_OK != GNUNET_BIO_write_spec_commit (wh, ws)))
1482  {
1483  GNUNET_break (0);
1484  goto cleanup;
1485  }
1486  break;
1487 
1488  default:
1489  GNUNET_assert (0);
1490  goto cleanup;
1491  }
1492  if ((NULL != fi->next) && (NULL == fi->next->serialization))
1495  "serialization",
1496  (fi->next != NULL)
1497  ? fi->next->serialization
1498  : NULL))
1499  {
1500  GNUNET_break (0);
1501  goto cleanup;
1502  }
1503  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
1504  {
1505  wh = NULL;
1506  GNUNET_break (0);
1507  goto cleanup;
1508  }
1509  return; /* done! */
1510 cleanup:
1511  if (NULL != wh)
1512  (void) GNUNET_BIO_write_close (wh, NULL);
1513  GNUNET_free (chks);
1514  GNUNET_free (ksks);
1515  GNUNET_free (skss);
1516  fn = get_serialization_file_name (fi->h,
1518  fi->serialization);
1519  if (NULL != fn)
1520  {
1521  if (0 != unlink (fn))
1523  GNUNET_free (fn);
1524  }
1525  GNUNET_free (fi->serialization);
1526  fi->serialization = NULL;
1527 }
static int copy_from_reader(struct GNUNET_BIO_WriteHandle *wh, struct GNUNET_FS_FileInformation *fi)
Copy all of the data from the reader to the write handle.
Definition: fs_api.c:1291
static char * make_serialization_file_name(struct GNUNET_FS_Handle *h, const char *ext)
Create a new random name for serialization.
Definition: fs_api.c:1219
static int write_start_time(struct GNUNET_BIO_WriteHandle *wh, struct GNUNET_TIME_Absolute timestamp)
Serialize a start-time.
Definition: fs_api.c:819
static struct GNUNET_BIO_WriteHandle * get_write_handle(struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
Return a write handle for serialization.
Definition: fs_api.c:677
#define GNUNET_FS_SYNC_PATH_FILE_INFO
Name of the directory with files that are being published.
Definition: fs_api.h:81
static void cleanup(void *cls)
Function scheduled as very last function, cleans up after us.
static struct GNUNET_TESTBED_BarrierWaitHandle * wh
Our barrier wait handle.
int GNUNET_BIO_write_spec_commit(struct GNUNET_BIO_WriteHandle *h, struct GNUNET_BIO_WriteSpec *ws)
Execute the write specifications in order.
Definition: bio.c:1540
int GNUNET_BIO_write(struct GNUNET_BIO_WriteHandle *h, const char *what, const void *buffer, size_t n)
Write a buffer to a handle.
Definition: bio.c:796
int GNUNET_BIO_write_string(struct GNUNET_BIO_WriteHandle *h, const char *what, const char *s)
Write a 0-terminated string.
Definition: bio.c:833
int GNUNET_BIO_write_close(struct GNUNET_BIO_WriteHandle *h, char **emsg)
Close an IO handle.
Definition: bio.c:609
struct GNUNET_BIO_WriteSpec GNUNET_BIO_write_spec_string(const char *what, const char *s)
Create the specification to write a 0-terminated string.
Definition: bio.c:1336
#define GNUNET_BIO_write_spec_end()
End of specifications marker.
int GNUNET_BIO_write_int64(struct GNUNET_BIO_WriteHandle *h, const char *what, int64_t i)
Write an (u)int64_t.
Definition: bio.c:957
struct GNUNET_BIO_WriteSpec GNUNET_BIO_write_spec_object(const char *what, void *source, size_t size)
Create the specification to read some bytes.
Definition: bio.c:1289
struct GNUNET_BIO_WriteSpec GNUNET_BIO_write_spec_meta_data(const char *what, const struct GNUNET_CONTAINER_MetaData *m)
Create the specification to write a metadata container.
Definition: bio.c:1382
struct GNUNET_BIO_WriteSpec GNUNET_BIO_write_spec_int32(const char *what, int32_t *i)
Create the specification to write an (u)int32_t.
Definition: bio.c:1427
struct GNUNET_BIO_WriteSpec GNUNET_BIO_write_spec_int64(const char *what, int64_t *i)
Create the specification to write an (u)int64_t.
Definition: bio.c:1472
char * GNUNET_FS_uri_to_string(const struct GNUNET_FS_Uri *uri)
Convert a URI to a UTF-8 String.
Definition: fs_uri.c:2033
Handle for buffered writing.
Definition: bio.c:518
Structure specifying a writing operation on an IO handle.
uint32_t anonymity_level
At which anonymity level should the block be shared? (0: no anonymity, 1: normal GAP,...
uint32_t content_priority
How important is it for us to store the block? If we run out of space, the highest-priority,...
uint32_t replication_level
How often should we try to migrate the block to other peers? Only used if "CONTENT_PUSHING" is set to...
struct GNUNET_TIME_Absolute expiration_time
At what time should the block expire? Data blocks (DBLOCKS and IBLOCKS) may still be used even if the...
char * serialization
Under what filename is this struct serialized (for operational persistence).
Definition: fs_api.h:286
struct GNUNET_FS_Uri * keywords
Keywords to use for KBlocks.
Definition: fs_api.h:257
char * filename
Name of the file or directory (must be an absolute path).
Definition: fs_api.h:301
size_t dir_size
Size of the directory itself (in bytes); 0 if the size has not yet been calculated.
Definition: fs_api.h:367
uint64_t contents_completed
How much of the directory have we published (relative to contents_size).
Definition: fs_api.h:378
struct GNUNET_FS_FileInformation::@16::@17 file
Data for a file.
char * emsg
Error message (non-NULL if this operation failed).
Definition: fs_api.h:296
struct GNUNET_FS_FileInformation * next
Files in a directory are kept as a linked list.
Definition: fs_api.h:231
struct GNUNET_FS_BlockOptions bo
Block options for the file.
Definition: fs_api.h:274
struct GNUNET_CONTAINER_MetaData * meta
Metadata to use for the file.
Definition: fs_api.h:252
int is_published
Are we done publishing this file?
Definition: fs_api.h:395
struct GNUNET_FS_Uri * sks_uri
SKS URI for this file or directory.
Definition: fs_api.h:269
void * dir_data
Pointer to the data for the directory (or NULL if not available).
Definition: fs_api.h:373
uint64_t contents_size
Sum of all of the sizes of all of the files in the directory.
Definition: fs_api.h:383
union GNUNET_FS_FileInformation::@16 data
Data describing either the file or the directory.
struct GNUNET_FS_Handle * h
Handle to the master context.
Definition: fs_api.h:242
struct GNUNET_TIME_Absolute start_time
At what time did we start this upload?
Definition: fs_api.h:279
struct GNUNET_FS_FileInformation * entries
Linked list of entries in the directory.
Definition: fs_api.h:361
struct GNUNET_FS_FileInformation * dir
If this is a file in a directory, "dir" refers to the directory; otherwise NULL.
Definition: fs_api.h:237
struct GNUNET_FS_Uri * chk_uri
CHK for this file or directory.
Definition: fs_api.h:263
int is_directory
Is this struct for a file or directory?
Definition: fs_api.h:390
A 512-bit hashcode.
uint64_t abs_value_us
The actual value.

References GNUNET_TIME_Absolute::abs_value_us, GNUNET_FS_BlockOptions::anonymity_level, GNUNET_FS_FileInformation::bo, GNUNET_FS_FileInformation::chk_uri, cleanup(), GNUNET_FS_BlockOptions::content_priority, GNUNET_FS_FileInformation::contents_completed, GNUNET_FS_FileInformation::contents_size, copy_from_reader(), GNUNET_FS_FileInformation::data, GNUNET_FS_FileInformation::dir, GNUNET_FS_FileInformation::dir_data, GNUNET_FS_FileInformation::dir_size, GNUNET_FS_FileInformation::emsg, GNUNET_FS_FileInformation::entries, GNUNET_FS_BlockOptions::expiration_time, GNUNET_FS_FileInformation::file, GNUNET_FS_FileInformation::filename, get_serialization_file_name(), get_write_handle(), GNUNET_assert, GNUNET_BIO_write(), GNUNET_BIO_write_close(), GNUNET_BIO_write_int64(), GNUNET_BIO_write_spec_commit(), GNUNET_BIO_write_spec_end, GNUNET_BIO_write_spec_int32(), GNUNET_BIO_write_spec_int64(), GNUNET_BIO_write_spec_meta_data(), GNUNET_BIO_write_spec_object(), GNUNET_BIO_write_spec_string(), GNUNET_BIO_write_string(), GNUNET_break, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_FS_SYNC_PATH_FILE_INFO, GNUNET_FS_uri_to_string(), GNUNET_log_strerror_file, GNUNET_NO, GNUNET_OK, GNUNET_YES, GNUNET_FS_FileInformation::h, GNUNET_FS_FileInformation::is_directory, GNUNET_FS_FileInformation::is_published, GNUNET_FS_FileInformation::keywords, make_serialization_file_name(), GNUNET_FS_FileInformation::meta, GNUNET_FS_FileInformation::next, GNUNET_FS_BlockOptions::replication_level, GNUNET_FS_FileInformation::serialization, GNUNET_FS_FileInformation::sks_uri, GNUNET_FS_FileInformation::start_time, wh, and write_start_time().

Referenced by encode_cont(), fip_signal_start(), GNUNET_FS_publish_main_(), handle_index_start_failed(), handle_index_start_ok(), handle_signature_response(), hash_for_index_cb(), index_mq_error_handler(), publish_content(), and publish_kblocks_cont().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_publish_sync_()

void GNUNET_FS_publish_sync_ ( struct GNUNET_FS_PublishContext pc)

Synchronize this publishing struct with its mirror on disk.

Note that all internal FS-operations that change publishing structs should already call "sync" internally, so this function is likely not useful for clients.

Parameters
pcthe struct to sync

Definition at line 1746 of file fs_api.c.

1747 {
1748  struct GNUNET_BIO_WriteHandle *wh;
1749  int32_t have_ns;
1750 
1751  if (NULL == pc->serialization)
1752  pc->serialization =
1754  if (NULL == pc->serialization)
1755  return;
1756  if (NULL == pc->fi)
1757  return;
1758  if (NULL == pc->fi->serialization)
1759  {
1760  GNUNET_break (0);
1761  return;
1762  }
1763  wh = get_write_handle (pc->h,
1765  pc->serialization);
1766  if (NULL == wh)
1767  {
1768  GNUNET_break (0);
1769  goto cleanup;
1770  }
1771  have_ns = (NULL != pc->ns) ? GNUNET_YES : GNUNET_NO;
1772  struct GNUNET_BIO_WriteSpec ws[] = {
1775  GNUNET_BIO_write_spec_int32 ("options", (int32_t *) &pc->options),
1776  GNUNET_BIO_write_spec_int32 ("all done", &pc->all_done),
1777  GNUNET_BIO_write_spec_int32 ("have ns", &have_ns),
1778  GNUNET_BIO_write_spec_string ("serialization", pc->fi->serialization),
1779  GNUNET_BIO_write_spec_string ("pos serialization", (NULL == pc->fi_pos)
1780  ? NULL
1781  : pc->fi_pos->serialization),
1783  };
1784  if ((GNUNET_OK != GNUNET_BIO_write_spec_commit (wh, ws)) ||
1785  ((NULL != pc->ns) &&
1786  (GNUNET_OK !=
1788  "ns",
1789  pc->ns,
1790  sizeof(struct GNUNET_CRYPTO_EcdsaPrivateKey)))))
1791  {
1792  GNUNET_break (0);
1793  goto cleanup;
1794  }
1795  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
1796  {
1797  wh = NULL;
1798  GNUNET_break (0);
1799  goto cleanup;
1800  }
1801  return;
1802 cleanup:
1803  if (NULL != wh)
1804  (void) GNUNET_BIO_write_close (wh, NULL);
1807  pc->serialization);
1809  pc->serialization = NULL;
1810 }
void GNUNET_FS_remove_sync_file_(struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
Remove serialization/deserialization file from disk.
Definition: fs_api.c:727
#define GNUNET_FS_SYNC_PATH_MASTER_PUBLISH
Name of the directory with publishing operations.
Definition: fs_api.h:76
#define GNUNET_BIO_read_spec_end()
End of specifications marker.
enum GNUNET_FS_PublishOptions options
Options for publishing.
Definition: fs_api.h:1274
char * nuid
ID for future updates, NULL if we have no namespace or no updates.
Definition: fs_api.h:1208
struct GNUNET_FS_FileInformation * fi
File-structure that is being shared.
Definition: fs_api.h:1193
char * nid
ID of the content in the namespace, NULL if we have no namespace.
Definition: fs_api.h:1203
struct GNUNET_CRYPTO_EcdsaPrivateKey * ns
Namespace that we are publishing in, NULL if we have no namespace.
Definition: fs_api.h:1198
char * serialization
Filename used for serializing information about this operation (should be determined using 'mktemp').
Definition: fs_api.h:1214

References GNUNET_FS_PublishContext::all_done, cleanup(), GNUNET_FS_PublishContext::fi, GNUNET_FS_PublishContext::fi_pos, get_write_handle(), GNUNET_BIO_read_spec_end, GNUNET_BIO_write(), GNUNET_BIO_write_close(), GNUNET_BIO_write_spec_commit(), GNUNET_BIO_write_spec_int32(), GNUNET_BIO_write_spec_string(), GNUNET_break, GNUNET_free, GNUNET_FS_remove_sync_file_(), GNUNET_FS_SYNC_PATH_MASTER_PUBLISH, GNUNET_NO, GNUNET_OK, GNUNET_YES, GNUNET_FS_PublishContext::h, make_serialization_file_name(), GNUNET_FS_PublishContext::nid, GNUNET_FS_PublishContext::ns, GNUNET_FS_PublishContext::nuid, GNUNET_FS_PublishContext::options, pc, GNUNET_FS_FileInformation::serialization, GNUNET_FS_PublishContext::serialization, and wh.

Referenced by finish_release_reserve(), GNUNET_FS_publish_main_(), GNUNET_FS_publish_start(), handle_index_start_failed(), handle_signature_response(), publish_kblocks_cont(), and publish_sblocks_cont().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_unindex_sync_()

void GNUNET_FS_unindex_sync_ ( struct GNUNET_FS_UnindexContext uc)

Synchronize this unindex struct with its mirror on disk.

Note that all internal FS-operations that change publishing structs should already call "sync" internally, so this function is likely not useful for clients.

Parameters
ucthe struct to sync

Definition at line 1822 of file fs_api.c.

1823 {
1824  struct GNUNET_BIO_WriteHandle *wh;
1825  char *uris;
1826 
1827  if (NULL == uc->serialization)
1828  uc->serialization =
1830  if (NULL == uc->serialization)
1831  return;
1832  wh = get_write_handle (uc->h,
1834  uc->serialization);
1835  if (NULL == wh)
1836  {
1837  GNUNET_break (0);
1838  goto cleanup;
1839  }
1840  if (NULL != uc->ksk_uri)
1842  else
1843  uris = NULL;
1844  struct GNUNET_BIO_WriteSpec ws1[] = {
1845  GNUNET_BIO_write_spec_string ("filename", uc->filename),
1846  GNUNET_BIO_write_spec_int64 ("file size", (int64_t *) &uc->file_size),
1848  };
1849  struct GNUNET_BIO_WriteSpec ws2[] = {
1850  GNUNET_BIO_write_spec_int32 ("state", (int32_t *) &uc->state),
1851  GNUNET_BIO_write_spec_object ("hashkey", &uc->chk,
1852  sizeof (struct ContentHashKey)),
1853  GNUNET_BIO_write_spec_string ("uris", uris),
1854  GNUNET_BIO_write_spec_int32 ("ksk offset", (int32_t *) &uc->ksk_offset),
1856  };
1857  if ((GNUNET_OK != GNUNET_BIO_write_spec_commit (wh, ws1)) ||
1860  ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1862  "file id",
1863  &uc->file_id,
1864  sizeof(struct GNUNET_HashCode)))) ||
1865  ((uc->state == UNINDEX_STATE_ERROR) &&
1866  (GNUNET_OK != GNUNET_BIO_write_string (wh, "emsg", uc->emsg))))
1867  {
1868  GNUNET_break (0);
1869  goto cleanup;
1870  }
1871  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
1872  {
1873  wh = NULL;
1874  GNUNET_break (0);
1875  goto cleanup;
1876  }
1877  return;
1878 cleanup:
1879  if (NULL != wh)
1880  (void) GNUNET_BIO_write_close (wh, NULL);
1883  uc->serialization);
1885  uc->serialization = NULL;
1886 }
#define GNUNET_FS_SYNC_PATH_MASTER_UNINDEX
Name of the directory with unindex operations.
Definition: fs_api.h:86
content hash key
Definition: fs.h:54
struct ContentHashKey chk
The content hash key of the last block we processed, will in the end be set to the CHK from the URI.
Definition: fs_api.h:1355
char * serialization
Short name under which we are serializing the state of this operation.
Definition: fs_api.h:1390

References GNUNET_FS_UnindexContext::chk, cleanup(), GNUNET_FS_UnindexContext::emsg, GNUNET_FS_UnindexContext::file_id, GNUNET_FS_UnindexContext::file_size, GNUNET_FS_UnindexContext::filename, get_write_handle(), GNUNET_BIO_write(), GNUNET_BIO_write_close(), GNUNET_BIO_write_spec_commit(), GNUNET_BIO_write_spec_end, GNUNET_BIO_write_spec_int32(), GNUNET_BIO_write_spec_int64(), GNUNET_BIO_write_spec_object(), GNUNET_BIO_write_spec_string(), GNUNET_BIO_write_string(), GNUNET_break, GNUNET_free, GNUNET_FS_remove_sync_file_(), GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, GNUNET_FS_uri_to_string(), GNUNET_OK, GNUNET_FS_UnindexContext::h, GNUNET_FS_UnindexContext::ksk_offset, GNUNET_FS_UnindexContext::ksk_uri, make_serialization_file_name(), GNUNET_FS_UnindexContext::serialization, GNUNET_FS_UnindexContext::start_time, GNUNET_FS_UnindexContext::state, uc, UNINDEX_STATE_ERROR, UNINDEX_STATE_FS_NOTIFY, wh, and write_start_time().

Referenced by GNUNET_FS_unindex_do_remove_(), GNUNET_FS_unindex_do_remove_kblocks_(), GNUNET_FS_unindex_process_hash_(), GNUNET_FS_unindex_start(), handle_unindex_response(), unindex_directory_scan_cb(), unindex_extract_keywords(), unindex_finish(), and unindex_mq_error_handler().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_search_sync_()

void GNUNET_FS_search_sync_ ( struct GNUNET_FS_SearchContext sc)

Synchronize this search struct with its mirror on disk.

Note that all internal FS-operations that change publishing structs should already call "sync" internally, so this function is likely not useful for clients.

Parameters
scthe struct to sync

Definition at line 2247 of file fs_api.c.

2248 {
2249  struct GNUNET_BIO_WriteHandle *wh;
2250  char *uris;
2251  char in_pause;
2252  const char *category;
2253 
2254  category = (NULL == sc->psearch_result) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2256  if (NULL == sc->serialization)
2258  if (NULL == sc->serialization)
2259  return;
2260  uris = NULL;
2261  wh = get_write_handle (sc->h, category, sc->serialization);
2262  if (NULL == wh)
2263  {
2264  GNUNET_break (0);
2265  goto cleanup;
2266  }
2269  uris = GNUNET_FS_uri_to_string (sc->uri);
2270  in_pause = (sc->task != NULL) ? 'r' : '\0';
2271  if ((GNUNET_OK != GNUNET_BIO_write_string (wh, "uris", uris)) ||
2273  (GNUNET_OK != GNUNET_BIO_write_string (wh, "emsg", sc->emsg)) ||
2274  (GNUNET_OK != GNUNET_BIO_write_int32 (wh, "options",
2275  (uint32_t) sc->options)) ||
2276  (GNUNET_OK != GNUNET_BIO_write (wh, "in pause",
2277  &in_pause, sizeof(in_pause))) ||
2278  (GNUNET_OK != GNUNET_BIO_write_int32 (wh, "anonymity", sc->anonymity)))
2279  {
2280  GNUNET_break (0);
2281  goto cleanup;
2282  }
2283  GNUNET_free (uris);
2284  uris = NULL;
2285  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
2286  {
2287  wh = NULL;
2288  GNUNET_break (0);
2289  goto cleanup;
2290  }
2291  return;
2292 cleanup:
2293  if (NULL != wh)
2294  (void) GNUNET_BIO_write_close (wh, NULL);
2295  GNUNET_free (uris);
2298  sc->serialization = NULL;
2299 }
#define GNUNET_FS_SYNC_PATH_MASTER_SEARCH
Name of the directory with top-level searches.
Definition: fs_api.h:54
#define GNUNET_FS_SYNC_PATH_CHILD_SEARCH
Name of the directory with sub-searches (namespace-updates).
Definition: fs_api.h:59
int GNUNET_BIO_write_int32(struct GNUNET_BIO_WriteHandle *h, const char *what, int32_t i)
Write an (u)int32_t.
Definition: bio.c:937
int GNUNET_FS_uri_test_sks(const struct GNUNET_FS_Uri *uri)
Is this a namespace URI?
Definition: fs_uri.c:1287
char * emsg
Error message (non-NULL if this operation failed).
Definition: fs_api.h:1550
char * serialization
Name of the file on disk we use for persistence.
Definition: fs_api.h:1545
enum GNUNET_FS_SearchOptions options
Options for the search.
Definition: fs_api.h:1597
struct GNUNET_FS_Handle * h
Handle to the global FS context.
Definition: fs_api.h:1514

References GNUNET_FS_SearchContext::anonymity, cleanup(), GNUNET_FS_SearchContext::emsg, get_write_handle(), GNUNET_assert, GNUNET_BIO_write(), GNUNET_BIO_write_close(), GNUNET_BIO_write_int32(), GNUNET_BIO_write_string(), GNUNET_break, GNUNET_free, GNUNET_FS_remove_sync_file_(), GNUNET_FS_SYNC_PATH_CHILD_SEARCH, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, GNUNET_FS_uri_test_ksk(), GNUNET_FS_uri_test_sks(), GNUNET_FS_uri_to_string(), GNUNET_OK, GNUNET_YES, GNUNET_FS_SearchContext::h, make_serialization_file_name(), GNUNET_FS_SearchContext::options, GNUNET_FS_SearchContext::psearch_result, sc, GNUNET_FS_SearchContext::serialization, GNUNET_FS_SearchContext::start_time, GNUNET_FS_SearchContext::task, GNUNET_FS_SearchContext::uri, wh, and write_start_time().

Referenced by GNUNET_FS_search_continue(), GNUNET_FS_search_pause(), and search_start().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_search_result_sync_()

void GNUNET_FS_search_result_sync_ ( struct GNUNET_FS_SearchResult sr)

Synchronize this search result with its mirror on disk.

Note that all internal FS-operations that change publishing structs should already call "sync" internally, so this function is likely not useful for clients.

Parameters
srthe struct to sync

Definition at line 2148 of file fs_api.c.

2149 {
2150  struct GNUNET_BIO_WriteHandle *wh;
2151  char *uris;
2152 
2153  if (NULL == sr->sc)
2154  return;
2155  uris = NULL;
2156  if (NULL == sr->serialization)
2157  sr->serialization =
2159  (sr->sc->psearch_result == NULL)
2162  sr->sc->serialization);
2163  if (NULL == sr->serialization)
2164  return;
2165  wh = get_write_handle_in_dir (sr->h,
2166  (sr->sc->psearch_result == NULL)
2169  sr->sc->serialization,
2170  sr->serialization);
2171  if (NULL == wh)
2172  {
2173  GNUNET_break (0);
2174  goto cleanup;
2175  }
2176  uris = GNUNET_FS_uri_to_string (sr->uri);
2177  struct GNUNET_BIO_WriteSpec ws[] = {
2178  GNUNET_BIO_write_spec_string ("uris", uris),
2179  GNUNET_BIO_write_spec_string ("download serialization",
2180  (sr->download != NULL)
2181  ? sr->download->serialization
2182  : NULL),
2183  GNUNET_BIO_write_spec_string ("update search serialization",
2184  (sr->update_search != NULL)
2186  : NULL),
2187  GNUNET_BIO_write_spec_meta_data ("metadata", sr->meta),
2188  GNUNET_BIO_write_spec_object ("key", &sr->key,
2189  sizeof(struct GNUNET_HashCode)),
2190  GNUNET_BIO_write_spec_int32 ("mandatory missing",
2191  (int32_t *) &sr->mandatory_missing),
2192  GNUNET_BIO_write_spec_int32 ("optional support",
2193  (int32_t *) &sr->optional_support),
2194  GNUNET_BIO_write_spec_int32 ("availability success",
2195  (int32_t *) &sr->availability_success),
2196  GNUNET_BIO_write_spec_int32 ("availability trials",
2197  (int32_t *) &sr->availability_trials),
2199  };
2200  if ((GNUNET_OK != GNUNET_BIO_write_spec_commit (wh, ws)))
2201  {
2202  GNUNET_break (0);
2203  goto cleanup;
2204  }
2205  if ((NULL != sr->uri) && (GNUNET_FS_URI_KSK == sr->sc->uri->type) &&
2206  (GNUNET_OK !=
2208  "keyword bitmap",
2209  sr->keyword_bitmap,
2210  (sr->sc->uri->data.ksk.keywordCount + 7) / 8)))
2211  {
2212  GNUNET_break (0);
2213  goto cleanup;
2214  }
2215  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
2216  {
2217  wh = NULL;
2218  GNUNET_break (0);
2219  goto cleanup;
2220  }
2221  GNUNET_free (uris);
2222  return;
2223 cleanup:
2224  GNUNET_free (uris);
2225  if (NULL != wh)
2226  (void) GNUNET_BIO_write_close (wh, NULL);
2228  (NULL == sr->sc->psearch_result)
2231  sr->sc->serialization,
2232  sr->serialization);
2233  GNUNET_free (sr->serialization);
2234  sr->serialization = NULL;
2235 }
static void remove_sync_file_in_dir(struct GNUNET_FS_Handle *h, const char *ext, const char *uni, const char *ent)
Remove serialization/deserialization file from disk.
Definition: fs_api.c:757
static char * make_serialization_file_name_in_dir(struct GNUNET_FS_Handle *h, const char *ext, const char *uni)
Create a new random name for serialization.
Definition: fs_api.c:1255
static struct GNUNET_BIO_WriteHandle * get_write_handle_in_dir(struct GNUNET_FS_Handle *h, const char *ext, const char *uni, const char *ent)
Return a write handle for serialization.
Definition: fs_api.c:702
char * serialization
Random portion of filename we use for syncing state of this download.
Definition: fs_api.h:1815
uint32_t optional_support
Number of optional keywords under which this result was also found.
Definition: fs_api.h:601
struct GNUNET_FS_SearchContext * update_search
If this search result triggered an update search, this field links to the update search.
Definition: fs_api.h:551
uint8_t * keyword_bitmap
Bitmap that specifies precisely which keywords have been matched already.
Definition: fs_api.h:561
struct GNUNET_HashCode key
Key for the search result based on the URI.
Definition: fs_api.h:566
char * serialization
Name under which this search result is stored on disk.
Definition: fs_api.h:556
struct GNUNET_FS_SearchContext * sc
Search context this result belongs to; can be NULL for probes that come from a directory result.
Definition: fs_api.h:518
uint32_t mandatory_missing
Number of mandatory keywords for which we have NOT yet found the search result; when this value hits ...
Definition: fs_api.h:595

References GNUNET_FS_SearchResult::availability_success, GNUNET_FS_SearchResult::availability_trials, cleanup(), GNUNET_FS_Uri::data, GNUNET_FS_SearchResult::download, get_write_handle_in_dir(), GNUNET_BIO_write(), GNUNET_BIO_write_close(), GNUNET_BIO_write_spec_commit(), GNUNET_BIO_write_spec_end, GNUNET_BIO_write_spec_int32(), GNUNET_BIO_write_spec_meta_data(), GNUNET_BIO_write_spec_object(), GNUNET_BIO_write_spec_string(), GNUNET_break, GNUNET_free, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, GNUNET_FS_URI_KSK, GNUNET_FS_uri_to_string(), GNUNET_OK, GNUNET_FS_SearchResult::h, GNUNET_FS_SearchResult::key, GNUNET_FS_SearchResult::keyword_bitmap, GNUNET_FS_Uri::ksk, make_serialization_file_name_in_dir(), GNUNET_FS_SearchResult::mandatory_missing, GNUNET_FS_SearchResult::meta, GNUNET_FS_SearchResult::optional_support, GNUNET_FS_SearchContext::psearch_result, remove_sync_file_in_dir(), GNUNET_FS_SearchResult::sc, GNUNET_FS_SearchResult::serialization, GNUNET_FS_SearchContext::serialization, GNUNET_FS_DownloadContext::serialization, GNUNET_FS_Uri::type, GNUNET_FS_SearchResult::update_search, GNUNET_FS_SearchResult::uri, GNUNET_FS_SearchContext::uri, and wh.

Referenced by GNUNET_FS_download_start_task_(), GNUNET_FS_search_probe_progress_(), probe_failure_handler(), probe_success_handler(), process_ksk_result(), and process_sks_result().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_download_sync_()

void GNUNET_FS_download_sync_ ( struct GNUNET_FS_DownloadContext dc)

Synchronize this download struct with its mirror on disk.

Note that all internal FS-operations that change publishing structs should already call "sync" internally, so this function is likely not useful for clients.

Parameters
dcthe struct to sync

Definition at line 2035 of file fs_api.c.

2036 {
2037  struct GNUNET_BIO_WriteHandle *wh;
2038  char *uris;
2039  char *fn;
2040  char *dir;
2041 
2042  if (0 != (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
2043  return; /* we don't sync probes */
2044  if (NULL == dc->serialization)
2045  {
2046  dir = get_download_sync_filename (dc, "", "");
2047  if (NULL == dir)
2048  return;
2050  {
2051  GNUNET_free (dir);
2052  return;
2053  }
2054  fn = GNUNET_DISK_mktemp (dir);
2055  GNUNET_free (dir);
2056  if (NULL == fn)
2057  return;
2059  }
2060  else
2061  {
2063  if (NULL == fn)
2064  {
2066  dc->serialization = NULL;
2067  GNUNET_free (fn);
2068  return;
2069  }
2070  }
2072  if (NULL == wh)
2073  {
2075  dc->serialization = NULL;
2076  GNUNET_free (fn);
2077  return;
2078  }
2081  uris = GNUNET_FS_uri_to_string (dc->uri);
2082  struct GNUNET_BIO_WriteSpec ws1[] = {
2083  GNUNET_BIO_write_spec_string ("uris", uris),
2084  GNUNET_BIO_write_spec_meta_data ("metadata", dc->meta),
2086  GNUNET_BIO_write_spec_string ("filename", dc->filename),
2087  GNUNET_BIO_write_spec_string ("temp filename", dc->temp_filename),
2088  GNUNET_BIO_write_spec_int64 ("old file size",
2089  (int64_t *) &dc->old_file_size),
2090  GNUNET_BIO_write_spec_int64 ("offset", (int64_t *) &dc->offset),
2091  GNUNET_BIO_write_spec_int64 ("length", (int64_t *) &dc->length),
2092  GNUNET_BIO_write_spec_int64 ("completed", (int64_t *) &dc->completed),
2094  };
2095  struct GNUNET_BIO_WriteSpec ws2[] = {
2096  GNUNET_BIO_write_spec_int32 ("anonymity", (int32_t *) &dc->anonymity),
2097  GNUNET_BIO_write_spec_int32 ("options", (int32_t *) &dc->options),
2098  GNUNET_BIO_write_spec_int32 ("has finished", (int32_t *) &dc->has_finished),
2100  };
2101  if ((GNUNET_OK != GNUNET_BIO_write_spec_commit (wh, ws1)) ||
2104  {
2105  GNUNET_break (0);
2106  goto cleanup;
2107  }
2108  if (NULL == dc->emsg)
2109  {
2110  GNUNET_assert (dc->top_request != NULL);
2112  {
2113  GNUNET_break (0);
2114  goto cleanup;
2115  }
2116  }
2117  GNUNET_free (uris);
2118  uris = NULL;
2119  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
2120  {
2121  wh = NULL;
2122  GNUNET_break (0);
2123  goto cleanup;
2124  }
2125  GNUNET_free (fn);
2126  return;
2127 cleanup:
2128  if (NULL != wh)
2129  (void) GNUNET_BIO_write_close (wh, NULL);
2130  GNUNET_free (uris);
2131  if (0 != unlink (fn))
2133  GNUNET_free (fn);
2135  dc->serialization = NULL;
2136 }
static int write_download_request(struct GNUNET_BIO_WriteHandle *wh, struct DownloadRequest *dr)
Serialize a download request.
Definition: fs_api.c:1897
static char * get_download_sync_filename(struct GNUNET_FS_DownloadContext *dc, const char *uni, const char *ext)
Compute the name of the sync file (or directory) for the given download context.
Definition: fs_api.c:2002
static char * get_serialization_short_name(const char *fullname)
Given a serialization name (full absolute path), return the basename of the file (without the path),...
Definition: fs_api.c:1185
static char * dir
Set to the directory where runtime files are stored.
Definition: gnunet-arm.c:89
struct GNUNET_BIO_WriteHandle * GNUNET_BIO_write_open_file(const char *fn)
Open a file for writing.
Definition: bio.c:560
char * GNUNET_DISK_mktemp(const char *t)
Create an (empty) temporary file on disk.
Definition: disk.c:381
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create_for_file(const char *filename)
Create the directory structure for storing a file.
Definition: disk.c:582
int GNUNET_FS_uri_test_chk(const struct GNUNET_FS_Uri *uri)
Is this a file (or directory) URI?
Definition: fs_uri.c:1362
int has_finished
Flag set upon transitive completion (includes child downloads).
Definition: fs_api.h:1929
uint64_t old_file_size
What was the size of the file on disk that we're downloading before we started? Used to detect if the...
Definition: fs_api.h:1897
char * temp_filename
Where are we writing the data temporarily (name of the file, can be NULL!); used if we do not have a ...
Definition: fs_api.h:1828

References GNUNET_FS_DownloadContext::anonymity, cleanup(), GNUNET_FS_DownloadContext::completed, dc, dir, GNUNET_FS_DownloadContext::emsg, GNUNET_FS_DownloadContext::filename, get_download_sync_filename(), get_serialization_short_name(), GNUNET_assert, GNUNET_BIO_write_close(), GNUNET_BIO_write_open_file(), GNUNET_BIO_write_spec_commit(), GNUNET_BIO_write_spec_end, GNUNET_BIO_write_spec_int32(), GNUNET_BIO_write_spec_int64(), GNUNET_BIO_write_spec_meta_data(), GNUNET_BIO_write_spec_string(), GNUNET_break, GNUNET_DISK_directory_create_for_file(), GNUNET_DISK_mktemp(), GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_FS_DOWNLOAD_IS_PROBE, GNUNET_FS_uri_test_chk(), GNUNET_FS_uri_test_loc(), GNUNET_FS_uri_to_string(), GNUNET_log_strerror_file, GNUNET_OK, GNUNET_YES, GNUNET_FS_DownloadContext::has_finished, GNUNET_FS_DownloadContext::length, GNUNET_FS_DownloadContext::meta, GNUNET_FS_DownloadContext::offset, GNUNET_FS_DownloadContext::old_file_size, GNUNET_FS_DownloadContext::options, GNUNET_FS_DownloadContext::serialization, GNUNET_FS_DownloadContext::start_time, GNUNET_FS_DownloadContext::temp_filename, GNUNET_FS_DownloadContext::top_request, GNUNET_FS_DownloadContext::uri, wh, write_download_request(), and write_start_time().

Referenced by check_completed(), GNUNET_FS_download_start_task_(), process_result_with_request(), search_result_stop(), and try_match_block().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_publish_signal_suspend_()

void GNUNET_FS_publish_signal_suspend_ ( void *  cls)

Create SUSPEND event for the given publish operation and then clean up our state (without stop signal).

Parameters
clsthe struct GNUNET_FS_PublishContext to signal for

Definition at line 1354 of file fs_publish.c.

1355 {
1356  struct GNUNET_FS_PublishContext *pc = cls;
1357 
1358  if (NULL != pc->upload_task)
1359  {
1361  pc->upload_task = NULL;
1362  }
1365  suspend_operation (pc->fi, pc);
1366  GNUNET_FS_end_top (pc->h, pc->top);
1367  pc->top = NULL;
1368  publish_cleanup (pc);
1369 }
void GNUNET_FS_end_top(struct GNUNET_FS_Handle *h, struct TopLevelActivity *top)
Destroy a top-level activity entry.
Definition: fs_api.c:401
static int fip_signal_suspend(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, void **client_info)
Signal the FS's progress function that we are suspending an upload.
Definition: fs_publish.c:1319
static void publish_cleanup(struct GNUNET_FS_PublishContext *pc)
Cleanup the publish context, we're done with it.
Definition: fs_publish.c:78
static void suspend_operation(struct GNUNET_FS_FileInformation *fi, struct GNUNET_FS_PublishContext *pc)
Actually signal the FS's progress function that we are suspending an upload.
Definition: fs_publish.c:1266
void GNUNET_FS_file_information_inspect(struct GNUNET_FS_FileInformation *dir, GNUNET_FS_FileInformationProcessor proc, void *proc_cls)
Inspect a file or directory in a publish-structure.
int skip_next_fi_callback
Flag set to GNUNET_YES if the next callback from GNUNET_FS_file_information_inspect should be skipped...
Definition: fs_api.h:1298
struct TopLevelActivity * top
Our top-level activity entry (if we are top-level, otherwise NULL).
Definition: fs_api.h:1188

References GNUNET_FS_PublishContext::fi, fip_signal_suspend(), GNUNET_FS_end_top(), GNUNET_FS_file_information_inspect(), GNUNET_SCHEDULER_cancel(), GNUNET_YES, GNUNET_FS_PublishContext::h, pc, publish_cleanup(), GNUNET_FS_PublishContext::skip_next_fi_callback, suspend_operation(), GNUNET_FS_PublishContext::top, and GNUNET_FS_PublishContext::upload_task.

Referenced by deserialize_publish_file(), and GNUNET_FS_publish_start().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_search_signal_suspend_()

void GNUNET_FS_search_signal_suspend_ ( void *  cls)

Create SUSPEND event for the given search operation and then clean up our state (without stop signal).

Parameters
clsthe 'struct GNUNET_FS_SearchContext' to signal for

Definition at line 1554 of file fs_search.c.

1555 {
1556  struct GNUNET_FS_SearchContext *sc = cls;
1557  struct GNUNET_FS_ProgressInfo pi;
1558  unsigned int i;
1559 
1560  GNUNET_FS_end_top (sc->h, sc->top);
1565  GNUNET_break (NULL == sc->client_info);
1566  if (sc->task != NULL)
1567  {
1569  sc->task = NULL;
1570  }
1571  if (NULL != sc->mq)
1572  {
1573  GNUNET_MQ_destroy (sc->mq);
1574  sc->mq = NULL;
1575  }
1577  if (NULL != sc->requests)
1578  {
1580  for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1581  {
1584  }
1585  }
1586  GNUNET_free (sc->requests);
1587  GNUNET_free (sc->emsg);
1590  GNUNET_free (sc);
1591 }
void * GNUNET_FS_search_make_status_(struct GNUNET_FS_ProgressInfo *pi, struct GNUNET_FS_Handle *h, struct GNUNET_FS_SearchContext *sc)
Fill in all of the generic fields for a search event and call the callback.
Definition: fs_search.c:48
static int search_result_suspend(void *cls, const struct GNUNET_HashCode *key, void *value)
Signal suspend and free the given search result.
Definition: fs_search.c:1515
void GNUNET_FS_uri_destroy(struct GNUNET_FS_Uri *uri)
Free URI.
Definition: fs_uri.c:684
@ GNUNET_FS_STATUS_SEARCH_SUSPEND
Last event when a search is being suspended; note that "GNUNET_FS_SEARCH_STOPPED" will not be generat...
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:685
Handle for controlling a search.
Definition: fs_api.h:1510
struct TopLevelActivity * top
Our top-level activity entry (if we are top-level, otherwise NULL).
Definition: fs_api.h:1519

References GNUNET_FS_SearchContext::client_info, GNUNET_FS_Uri::data, GNUNET_FS_SearchContext::emsg, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_free, GNUNET_FS_end_top(), GNUNET_FS_search_make_status_(), GNUNET_FS_STATUS_SEARCH_SUSPEND, GNUNET_FS_uri_destroy(), GNUNET_FS_uri_test_ksk(), GNUNET_MQ_destroy(), GNUNET_SCHEDULER_cancel(), GNUNET_FS_SearchContext::h, SearchRequestEntry::keyword, GNUNET_FS_Uri::ksk, GNUNET_FS_SearchContext::master_result_map, GNUNET_FS_SearchContext::mq, pi, GNUNET_FS_SearchContext::requests, SearchRequestEntry::results, sc, search_result_suspend(), GNUNET_FS_SearchContext::serialization, GNUNET_FS_SearchContext::task, GNUNET_FS_SearchContext::top, and GNUNET_FS_SearchContext::uri.

Referenced by deserialize_search_file(), GNUNET_FS_search_start(), and search_result_suspend().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_download_signal_suspend_()

void GNUNET_FS_download_signal_suspend_ ( void *  cls)

Create SUSPEND event for the given download operation and then clean up our state (without stop signal).

Parameters
clsthe struct GNUNET_FS_DownloadContext to signal for

Definition at line 1953 of file fs_download.c.

1954 {
1955  struct GNUNET_FS_DownloadContext *dc = cls;
1956  struct GNUNET_FS_ProgressInfo pi;
1957 
1958  if (NULL != dc->top)
1959  GNUNET_FS_end_top (dc->h, dc->top);
1960  while (NULL != dc->child_head)
1962  if (NULL != dc->search)
1963  {
1964  dc->search->download = NULL;
1965  dc->search = NULL;
1966  }
1967  if (NULL != dc->job_queue)
1968  {
1970  dc->job_queue = NULL;
1971  }
1972  if (NULL != dc->parent)
1974  dc->parent->child_tail,
1975  dc);
1976  if (NULL != dc->task)
1977  {
1979  dc->task = NULL;
1980  }
1983  if (NULL != dc->te)
1984  {
1986  dc->te = NULL;
1987  }
1988  if (NULL != dc->rfh)
1989  {
1991  dc->rfh = NULL;
1992  }
1994  if (NULL != dc->active)
1995  {
1997  dc->active = NULL;
1998  }
1999  GNUNET_free (dc->filename);
2004  GNUNET_assert (NULL == dc->job_queue);
2005  GNUNET_free (dc);
2006 }
void GNUNET_FS_dequeue_(struct GNUNET_FS_QueueEntry *qe)
Dequeue a job from the queue.
Definition: fs_api.c:355
void GNUNET_FS_download_signal_suspend_(void *cls)
Create SUSPEND event for the given download operation and then clean up our state (without stop signa...
Definition: fs_download.c:1953
void GNUNET_FS_free_download_request_(struct DownloadRequest *dr)
(recursively) free download request structure
Definition: fs_download.c:996
void GNUNET_FS_tree_encoder_finish(struct GNUNET_FS_TreeEncoder *te, char **emsg)
Clean up a tree encoder and return information about possible errors.
Definition: fs_tree.c:432
void GNUNET_CONTAINER_meta_data_destroy(struct GNUNET_CONTAINER_MetaData *md)
Free meta data.
struct GNUNET_FS_DownloadContext * child_tail
Tail of list of child downloads.
Definition: fs_api.h:1779
struct GNUNET_FS_DownloadContext * child_head
Head of list of child downloads.
Definition: fs_api.h:1774
struct TopLevelActivity * top
Our top-level activity entry (if we are top-level, otherwise NULL).
Definition: fs_api.h:1752

References GNUNET_FS_DownloadContext::active, GNUNET_FS_DownloadContext::child_head, GNUNET_FS_DownloadContext::child_tail, dc, GNUNET_FS_SearchResult::download, GNUNET_FS_DownloadContext::filename, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_meta_data_destroy(), GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_DISK_file_close(), GNUNET_free, GNUNET_FS_dequeue_(), GNUNET_FS_download_make_status_(), GNUNET_FS_download_signal_suspend_(), GNUNET_FS_end_top(), GNUNET_FS_free_download_request_(), GNUNET_FS_STATUS_DOWNLOAD_SUSPEND, GNUNET_FS_tree_encoder_finish(), GNUNET_FS_uri_destroy(), GNUNET_SCHEDULER_cancel(), GNUNET_FS_DownloadContext::h, GNUNET_FS_DownloadContext::job_queue, GNUNET_FS_DownloadContext::meta, GNUNET_FS_DownloadContext::parent, pi, GNUNET_FS_DownloadContext::rfh, GNUNET_FS_DownloadContext::search, GNUNET_FS_DownloadContext::serialization, GNUNET_FS_DownloadContext::task, GNUNET_FS_DownloadContext::te, GNUNET_FS_DownloadContext::temp_filename, GNUNET_FS_DownloadContext::top, GNUNET_FS_DownloadContext::top_request, and GNUNET_FS_DownloadContext::uri.

Referenced by deserialize_download(), GNUNET_FS_download_signal_suspend_(), GNUNET_FS_download_start(), search_result_stop(), and search_result_suspend().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_unindex_signal_suspend_()

void GNUNET_FS_unindex_signal_suspend_ ( void *  cls)

Create SUSPEND event for the given unindex operation and then clean up our state (without stop signal).

Parameters
clsthe struct GNUNET_FS_UnindexContext to signal for

Definition at line 727 of file fs_unindex.c.

728 {
729  struct GNUNET_FS_UnindexContext *uc = cls;
730  struct GNUNET_FS_ProgressInfo pi;
731 
732  /* FIXME: lots of duplication with unindex_stop here! */
733  if (uc->dscan != NULL)
734  {
736  uc->dscan = NULL;
737  }
738  if (NULL != uc->dqe)
739  {
741  uc->dqe = NULL;
742  }
743  if (uc->fhc != NULL)
744  {
746  uc->fhc = NULL;
747  }
748  if (NULL != uc->ksk_uri)
749  {
751  uc->ksk_uri = NULL;
752  }
753  if (NULL != uc->mq)
754  {
756  uc->mq = NULL;
757  }
758  if (NULL != uc->dsh)
759  {
761  uc->dsh = NULL;
762  }
763  if (NULL != uc->tc)
764  {
766  uc->tc = NULL;
767  }
768  if (uc->fh != NULL)
769  {
771  uc->fh = NULL;
772  }
773  GNUNET_FS_end_top (uc->h, uc->top);
776  (uc->state ==
778  GNUNET_break (NULL == uc->client_info);
781  GNUNET_free (uc->emsg);
782  GNUNET_free (uc);
783 }
void GNUNET_FS_unindex_make_status_(struct GNUNET_FS_ProgressInfo *pi, struct GNUNET_FS_UnindexContext *uc, uint64_t offset)
Fill in all of the generic fields for an unindex event and call the callback.
Definition: fs_unindex.c:84
void GNUNET_DATASTORE_cancel(struct GNUNET_DATASTORE_QueueEntry *qe)
Cancel a datastore operation.
void GNUNET_FS_directory_scan_abort(struct GNUNET_FS_DirScanner *ds)
Abort the scan.
@ GNUNET_FS_STATUS_UNINDEX_SUSPEND
Notification that we suspended unindexing a file.
void GNUNET_CRYPTO_hash_file_cancel(struct GNUNET_CRYPTO_FileHashContext *fhc)
Cancel a file hashing operation.
struct TopLevelActivity * top
Our top-level activity entry.
Definition: fs_api.h:1365
struct GNUNET_MQ_Handle * mq
Connection to the FS service, only valid during the UNINDEX_STATE_FS_NOTIFY phase.
Definition: fs_api.h:1396

References GNUNET_FS_UnindexContext::client_info, GNUNET_FS_UnindexContext::dqe, GNUNET_FS_UnindexContext::dscan, GNUNET_FS_UnindexContext::dsh, GNUNET_FS_UnindexContext::emsg, GNUNET_FS_UnindexContext::fh, GNUNET_FS_UnindexContext::fhc, GNUNET_FS_UnindexContext::file_size, GNUNET_FS_UnindexContext::filename, GNUNET_break, GNUNET_CRYPTO_hash_file_cancel(), GNUNET_DATASTORE_cancel(), GNUNET_DATASTORE_disconnect(), GNUNET_DISK_file_close(), GNUNET_free, GNUNET_FS_directory_scan_abort(), GNUNET_FS_end_top(), GNUNET_FS_STATUS_UNINDEX_SUSPEND, GNUNET_FS_tree_encoder_finish(), GNUNET_FS_unindex_make_status_(), GNUNET_FS_uri_destroy(), GNUNET_MQ_destroy(), GNUNET_NO, GNUNET_FS_UnindexContext::h, GNUNET_FS_UnindexContext::ksk_uri, GNUNET_FS_UnindexContext::mq, pi, GNUNET_FS_UnindexContext::serialization, GNUNET_FS_UnindexContext::state, GNUNET_FS_UnindexContext::tc, GNUNET_FS_UnindexContext::top, uc, and UNINDEX_STATE_COMPLETE.

Referenced by deserialize_unindex_file(), and GNUNET_FS_unindex_start().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_make_top()

struct TopLevelActivity* GNUNET_FS_make_top ( struct GNUNET_FS_Handle h,
SuspendSignalFunction  ssf,
void *  ssf_cls 
)

Create a top-level activity entry.

Parameters
hglobal fs handle
ssfsuspend signal function to use
ssf_clsclosure for ssf
Returns
fresh top-level activity handle

Definition at line 380 of file fs_api.c.

383 {
384  struct TopLevelActivity *ret;
385 
386  ret = GNUNET_new (struct TopLevelActivity);
387  ret->ssf = ssf;
388  ret->ssf_cls = ssf_cls;
389  GNUNET_CONTAINER_DLL_insert (h->top_head, h->top_tail, ret);
390  return ret;
391 }
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
We track all of the top-level activities of FS so that we can signal 'suspend' on shutdown.
Definition: fs_api.h:1017
void * ssf_cls
Closure for 'ssf' (some struct GNUNET_FS_XXXHandle*)
Definition: fs_api.h:1036
SuspendSignalFunction ssf
Function to call for suspend-signalling and clean up.
Definition: fs_api.h:1031

References GNUNET_CONTAINER_DLL_insert, GNUNET_new, h, ret, TopLevelActivity::ssf, and TopLevelActivity::ssf_cls.

Referenced by deserialize_download(), deserialize_publish_file(), deserialize_search_file(), deserialize_unindex_file(), GNUNET_FS_download_start(), GNUNET_FS_publish_start(), GNUNET_FS_search_start(), GNUNET_FS_unindex_start(), and search_result_stop().

Here is the caller graph for this function:

◆ GNUNET_FS_end_top()

void GNUNET_FS_end_top ( struct GNUNET_FS_Handle h,
struct TopLevelActivity top 
)

Destroy a top-level activity entry.

Parameters
hglobal fs handle
toptop level activity entry

Definition at line 401 of file fs_api.c.

402 {
403  GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top);
404  GNUNET_free (top);
405 }

References GNUNET_CONTAINER_DLL_remove, GNUNET_free, and h.

Referenced by GNUNET_FS_download_signal_suspend_(), GNUNET_FS_publish_signal_suspend_(), GNUNET_FS_publish_stop(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_stop(), GNUNET_FS_unindex_signal_suspend_(), and GNUNET_FS_unindex_stop().

Here is the caller graph for this function:

◆ GNUNET_FS_free_download_request_()

void GNUNET_FS_free_download_request_ ( struct DownloadRequest dr)

(recursively) free download request structure

Parameters
drrequest to free

Definition at line 996 of file fs_download.c.

997 {
998  if (NULL == dr)
999  return;
1000  for (unsigned int i = 0; i < dr->num_children; i++)
1002  GNUNET_free (dr->children);
1003  GNUNET_free (dr);
1004 }
struct DownloadRequest ** children
Array (!) of child-requests, or NULL for the bottom of the tree.
Definition: fs_api.h:1684
unsigned int num_children
Number of entries in children array.
Definition: fs_api.h:1702

References DownloadRequest::children, GNUNET_free, GNUNET_FS_free_download_request_(), and DownloadRequest::num_children.

Referenced by free_download_context(), GNUNET_FS_download_signal_suspend_(), GNUNET_FS_free_download_request_(), process_result_with_request(), and read_download_request().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FS_stop_probe_ping_task_()

void GNUNET_FS_stop_probe_ping_task_ ( struct GNUNET_FS_SearchResult sr)

Stop the ping task for this search result.

Parameters
srresult to start pinging for.

Definition at line 409 of file fs_search.c.

410 {
411  struct GNUNET_FS_Handle *h = sr->h;
412 
413  GNUNET_CONTAINER_DLL_remove (h->probes_head,
414  h->probes_tail,
415  sr);
416  if (NULL == h->probes_head)
417  {
418  GNUNET_SCHEDULER_cancel (h->probe_ping_task);
419  h->probe_ping_task = NULL;
420  }
421 }

References GNUNET_CONTAINER_DLL_remove, GNUNET_SCHEDULER_cancel(), h, and GNUNET_FS_SearchResult::h.

Referenced by GNUNET_FS_download_start_from_search(), GNUNET_FS_search_stop_probe_(), probe_failure_handler(), probe_success_handler(), and search_result_freeze_probes().

Here is the call graph for this function:
Here is the caller graph for this function: