fix
[oweals/gnunet.git] / src / fs / fs.h
index 52fbee4c14f49ae0f574aab18b84eb71a6c79009..a7ae457d56eae82c0c70be64d92cf397c1817d52 100644 (file)
@@ -1,3 +1,4 @@
+
 /*
      This file is part of GNUnet.
      (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
 #include "gnunet_fs_service.h"
 #include "gnunet_block_lib.h"
 
+/**
+ * Maximum size of the datastore queue for P2P operations.
+ */
+#define MAX_DATASTORE_QUEUE 16
+
+/**
+ * Maximum number of blocks we keep in memory for migration.
+ */
+#define MAX_MIGRATION_QUEUE 32
+
+/**
+ * How many peers do we select as possible
+ * targets per block obtained for migration?
+ */
+#define MIGRATION_LIST_SIZE 4
+
+/**
+ * To how many peers do we forward each migration block ultimately?
+ * This number must be smaller or equal to MIGRATION_LIST_SIZE.  Using
+ * a smaller value allows for variation in available bandwidth (for
+ * migration) between the peers.
+ */
+#define MIGRATION_TARGET_COUNT 2
+
+/**
+ * Ratio for moving average delay calculation.  The previous
+ * average goes in with a factor of (n-1) into the calculation.
+ * Must be > 0.
+ */
+#define RUNAVG_DELAY_N 16
+
 /**
  * Size of the individual blocks used for file-sharing.
  */
  */
 #define IDLE_LOAD_THRESHOLD ((100 + GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD) / 2)
 
+/**
+ * Name of the directory with top-level searches.
+ */
+#define GNUNET_FS_SYNC_PATH_MASTER_SEARCH "search"
+
+/**
+ * Name of the directory with sub-searches (namespace-updates).
+ */
+#define GNUNET_FS_SYNC_PATH_CHILD_SEARCH "search-child"
+
+/**
+ * Name of the directory with master downloads (not associated
+ * with search or part of another download).
+ */
+#define GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD "download"
+
+/**
+ * Name of the directory with downloads that are part of another
+ * download or a search.
+ */
+#define GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD "download-child"
+
+/**
+ * Name of the directory with publishing operations.
+ */
+#define GNUNET_FS_SYNC_PATH_MASTER_PUBLISH "publish"
+
+/**
+ * Name of the directory with files that are being published
+ */
+#define GNUNET_FS_SYNC_PATH_FILE_INFO "publish-file"
+
+/**
+ * Name of the directory with unindex operations.
+ */
+#define GNUNET_FS_SYNC_PATH_MASTER_UNINDEX "unindex"
 
 
 /**
@@ -610,11 +678,15 @@ struct GNUNET_FS_SearchResult
   /**
    * ID of an associated download based on this search result (or
    * NULL for none).
-   *
-   * FIXME: not yet serialized.
    */
   struct GNUNET_FS_DownloadContext *download;
 
+  /**
+   * If this search result triggered an update search, this field
+   * links to the update search.
+   */
+  struct GNUNET_FS_SearchContext *update_search;
+
   /**
    * Name under which this search result is stored on disk.
    */
@@ -978,6 +1050,41 @@ GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr);
 void
 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc);
 
+/**
+ * Create SUSPEND event for the given publish operation
+ * and then clean up our state (without stop signal).
+ *
+ * @param cls the 'struct GNUNET_FS_PublishContext' to signal for
+ */
+void
+GNUNET_FS_publish_signal_suspend_ (void *cls);
+
+/**
+ * Create SUSPEND event for the given search operation
+ * and then clean up our state (without stop signal).
+ *
+ * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
+ */
+void
+GNUNET_FS_search_signal_suspend_ (void *cls);
+
+/**
+ * Create SUSPEND event for the given download operation
+ * and then clean up our state (without stop signal).
+ *
+ * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
+ */
+void
+GNUNET_FS_download_signal_suspend_ (void *cls);
+
+/**
+ * Create SUSPEND event for the given unindex operation
+ * and then clean up our state (without stop signal).
+ *
+ * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
+ */
+void
+GNUNET_FS_unindex_signal_suspend_ (void *cls);
 
 /**
  * Function signature of the functions that can be called
@@ -1041,15 +1148,6 @@ GNUNET_FS_end_top (struct GNUNET_FS_Handle *h,
                   struct TopLevelActivity *top);
 
 
-/**
- * Create SUSPEND event for the given download operation
- * and then clean up our state (without stop signal).
- *
- * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
- */
-void
-GNUNET_FS_download_signal_suspend_ (void *cls);
-
 
 /**
  * Master context for most FS operations.
@@ -1081,11 +1179,6 @@ struct GNUNET_FS_Handle
    */
   void *upcb_cls;
 
-  /**
-   * Connection to the FS service.
-   */
-  struct GNUNET_CLIENT_Connection *client;
-
   /**
    * Head of DLL of top-level activities.
    */
@@ -1259,16 +1352,16 @@ enum UnindexState
     UNINDEX_STATE_HASHING = 0,
 
     /**
-     * We're notifying the FS service about
-     * the unindexing.
+     * We're telling the datastore to delete
+     * the respective entries.
      */
-    UNINDEX_STATE_FS_NOTIFY = 1,
+    UNINDEX_STATE_DS_REMOVE = 1,
 
     /**
-     * We're telling the datastore to delete
-     * the respective entries.
+     * We're notifying the FS service about
+     * the unindexing.
      */
-    UNINDEX_STATE_DS_REMOVE = 2,
+    UNINDEX_STATE_FS_NOTIFY = 2,
 
     /**
      * We're done.
@@ -1278,13 +1371,8 @@ enum UnindexState
     /**
      * We've encountered a fatal error.
      */
-    UNINDEX_STATE_ERROR = 4,
+    UNINDEX_STATE_ERROR = 4
 
-    /**
-     * We've been aborted.  The next callback should clean up the
-     * struct.
-     */
-    UNINDEX_STATE_ABORTED = 5
   };
 
 
@@ -1346,6 +1434,11 @@ struct GNUNET_FS_UnindexContext
    */
   char *emsg;
 
+  /**
+   * Context for hashing of the file.
+   */
+  struct GNUNET_CRYPTO_FileHashContext *fhc;
+
   /**
    * Overall size of the file.
    */ 
@@ -1426,34 +1519,10 @@ struct GNUNET_FS_SearchContext
   struct GNUNET_FS_Uri *uri;
 
   /**
-   * For update-searches, link to the base-SKS search that triggered
+   * For update-searches, link to the search result that triggered
    * the update search; otherwise NULL.
    */
-  struct GNUNET_FS_SearchContext *parent;
-
-  /**
-   * For update-searches, link to the first child search that
-   * triggered the update search; otherwise NULL.
-   */
-  struct GNUNET_FS_SearchContext *child_head;
-
-  /**
-   * For update-searches, link to the last child search that triggered
-   * the update search; otherwise NULL.
-   */
-  struct GNUNET_FS_SearchContext *child_tail;
-
-  /**
-   * For update-searches, link to the next child belonging to the same
-   * parent.
-   */
-  struct GNUNET_FS_SearchContext *next;
-
-  /**
-   * For update-searches, link to the previous child belonging to the
-   * same parent.
-   */
-  struct GNUNET_FS_SearchContext *prev;
+  struct GNUNET_FS_SearchResult *psearch_result;
 
   /**
    * Connection to the FS service.
@@ -1587,8 +1656,6 @@ struct GNUNET_FS_DownloadContext
   /**
    * Associated search (used when downloading files
    * based on search results), or NULL for none.
-   *
-   * FIXME: not yet serialized
    */
   struct GNUNET_FS_SearchResult *search;