[GNUnet-SVN] r14369 - gnunet/src/fs

[gnunet]

Author: grothoff
Date: 2011-02-08 01:10:36 +0100 (Tue, 08 Feb 2011)
New Revision: 14369

Added:
   gnunet/src/fs/gnunet-service-fs_pr.c
Modified:
   gnunet/src/fs/gnunet-service-fs_cp.c
   gnunet/src/fs/gnunet-service-fs_cp.h
   gnunet/src/fs/gnunet-service-fs_lc.c
   gnunet/src/fs/gnunet-service-fs_lc.h
   gnunet/src/fs/gnunet-service-fs_pr.h
Log:
stuff

Modified: gnunet/src/fs/gnunet-service-fs_cp.c
===================================================================
--- gnunet/src/fs/gnunet-service-fs_cp.c        2011-02-07 22:44:36 UTC (rev 
14368)
+++ gnunet/src/fs/gnunet-service-fs_cp.c        2011-02-08 00:10:36 UTC (rev 
14369)
@@ -427,6 +427,28 @@
 
 
 /**
+ * Handle P2P "QUERY" message.
+ *
+ * @param other the other peer involved (sender or receiver, NULL
+ *        for loopback messages where we are both sender and receiver)
+ * @param message the actual message
+ * @return pending request handle, NULL on error
+ */
+struct GSF_PendingRequest *
+GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
+                      const struct GNUNET_MessageHeader *message)
+{
+  // FIXME!
+  // parse request
+  // setup pending request
+  // track pending request to cancel it on peer disconnect (!)
+  // return it!
+  // (actual planning & execution up to caller!)
+  return NULL;
+}
+
+
+/**
  * Function called if there has been a timeout trying to satisfy
  * a transmission request.
  *

Modified: gnunet/src/fs/gnunet-service-fs_cp.h
===================================================================
--- gnunet/src/fs/gnunet-service-fs_cp.h        2011-02-07 22:44:36 UTC (rev 
14368)
+++ gnunet/src/fs/gnunet-service-fs_cp.h        2011-02-08 00:10:36 UTC (rev 
14369)
@@ -249,6 +249,22 @@
 
 
 /**
+ * Handle P2P "QUERY" message.  Only responsible for creating the
+ * request entry itself and setting up reply callback and cancellation
+ * on peer disconnect.  Does NOT execute the actual request strategy
+ * (planning).
+ *
+ * @param other the other peer involved (sender or receiver, NULL
+ *        for loopback messages where we are both sender and receiver)
+ * @param message the actual message
+ * @return pending request handle, NULL on error
+ */
+struct GSF_PendingRequest *
+GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
+                      const struct GNUNET_MessageHeader *message);
+
+
+/**
  * A peer disconnected from us.  Tear down the connected peer
  * record.
  *

Modified: gnunet/src/fs/gnunet-service-fs_lc.c
===================================================================
--- gnunet/src/fs/gnunet-service-fs_lc.c        2011-02-07 22:44:36 UTC (rev 
14368)
+++ gnunet/src/fs/gnunet-service-fs_lc.c        2011-02-08 00:10:36 UTC (rev 
14369)
@@ -181,13 +181,12 @@
 /**
  * Handle START_SEARCH-message (search request from local client).
  *
- * @param cls closure
  * @param client identification of the client
  * @param message the actual message
+ * @return pending request handle for the request, NULL on error
  */
-void
-GSF_local_client_start_search_handler_ (void *cls,
-                                       struct GNUNET_SERVER_Client *client,
+struct GSF_PendingRequest *
+GSF_local_client_start_search_handler_ (struct GNUNET_SERVER_Client *client,
                                        const struct GNUNET_MessageHeader 
*message)
 {
   static GNUNET_HashCode all_zeros;
@@ -207,7 +206,7 @@
       GNUNET_break (0);
       GNUNET_SERVER_receive_done (client,
                                  GNUNET_SYSERR);
-      return;
+      return NULL;
     }
   GNUNET_STATISTICS_update (stats,
                            gettext_noop ("# client searches received"),
@@ -224,7 +223,6 @@
 #endif
   lc = GSF_local_client_lookup_ (client);
 
-
   /* detect duplicate KBLOCK requests */
   if ( (type == GNUNET_BLOCK_TYPE_FS_KBLOCK) ||
        (type == GNUNET_BLOCK_TYPE_FS_NBLOCK) ||
@@ -252,7 +250,7 @@
                                    GNUNET_NO);
          GNUNET_SERVER_receive_done (client,
                                      GNUNET_OK);
-         return;
+         return NULL;
        }
     }
 
@@ -268,25 +266,24 @@
   options = GSF_PRO_LOCAL_REQUEST;  
   if (0 != (1 & ntohl (sm->options)))
     options |= GSF_PRO_LOCAL_ONLY;
-  cr->pr = GSF_pending_request_create (options,
-                                      
-                                      type,
-                                      &sm->query,
-                                      (type == GNUNET_BLOCK_TYPE_SBLOCK)
-                                      ? &sm->target /* namespace */
-                                      : NULL,
-                                      (0 != memcmp (&sm->target,
-                                                    &all_zeros,
-                                                    sizeof (GNUNET_HashCode)))
-                                      ? &sm->target,
-                                      : NULL,
-                                      NULL /* bf */, 0 /* mingle */,
-                                      ntohl (sm->anonymity_level),
-                                      0 /* priority */,
-                                      &sm[1], sc,
-                                      &client_response_handler,
-                                      cr);
-  // FIXME: start local processing and/or P2P processing?
+  cr->pr = GSF_pending_request_create_ (options,
+                                       type,
+                                       &sm->query,
+                                       (type == GNUNET_BLOCK_TYPE_SBLOCK)
+                                       ? &sm->target /* namespace */
+                                       : NULL,
+                                       (0 != memcmp (&sm->target,
+                                                     &all_zeros,
+                                                     sizeof (GNUNET_HashCode)))
+                                       ? &sm->target,
+                                       : NULL,
+                                       NULL /* bf */, 0 /* mingle */,
+                                       ntohl (sm->anonymity_level),
+                                       0 /* priority */,
+                                       &sm[1], sc,
+                                       &client_response_handler,
+                                       cr);
+  return cr->pr;
 }
 
 

Modified: gnunet/src/fs/gnunet-service-fs_lc.h
===================================================================
--- gnunet/src/fs/gnunet-service-fs_lc.h        2011-02-07 22:44:36 UTC (rev 
14368)
+++ gnunet/src/fs/gnunet-service-fs_lc.h        2011-02-08 00:10:36 UTC (rev 
14369)
@@ -42,14 +42,16 @@
 
 /**
  * Handle START_SEARCH-message (search request from local client).
+ * Only responsible for creating the request entry itself and setting
+ * up reply callback and cancellation on client disconnect.  Does NOT
+ * execute the actual request strategy (planning).
  *
- * @param cls closure
  * @param client identification of the client
  * @param message the actual message
+ * @return pending request handle for the request, NULL on error
  */
-void
-GSF_local_client_start_search_handler_ (void *cls,
-                                       struct GNUNET_SERVER_Client *client,
+struct GSF_PendingRequest *
+GSF_local_client_start_search_handler_ (struct GNUNET_SERVER_Client *client,
                                        const struct GNUNET_MessageHeader 
*message);
 
 

Added: gnunet/src/fs/gnunet-service-fs_pr.c
===================================================================
--- gnunet/src/fs/gnunet-service-fs_pr.c                                (rev 0)
+++ gnunet/src/fs/gnunet-service-fs_pr.c        2011-02-08 00:10:36 UTC (rev 
14369)
@@ -0,0 +1,195 @@
+/*
+     This file is part of GNUnet.
+     (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
+
+     GNUnet is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published
+     by the Free Software Foundation; either version 3, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     You should have received a copy of the GNU General Public License
+     along with GNUnet; see the file COPYING.  If not, write to the
+     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+     Boston, MA 02111-1307, USA.
+*/
+
+/**
+ * @file fs/gnunet-service-fs_pr.c
+ * @brief API to handle pending requests
+ * @author Christian Grothoff
+ */
+#include "platform.h"
+#include "gnunet-service-fs_pr.h"
+
+
+/**
+ * Create a new pending request.  
+ *
+ * @param options request options
+ * @param type type of the block that is being requested
+ * @param query key for the lookup
+ * @param namespace namespace to lookup, NULL for no namespace
+ * @param target preferred target for the request, NULL for none
+ * @param bf bloom filter for known replies, can be NULL
+ * @param mingle mingle value for bf
+ * @param anonymity_level desired anonymity level
+ * @param priority maximum outgoing cummulative request priority to use
+ * @param replies_seen hash codes of known local replies
+ * @param replies_seen_count size of the 'replies_seen' array
+ * @param rh handle to call when we get a reply
+ * @param rh_cls closure for rh
+ * @return handle for the new pending request
+ */
+struct GSF_PendingRequest *
+GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
+                            enum GNUNET_BLOCK_Type type,
+                            const GNUNET_HashCode *query,
+                            const GNUNET_HashCode *namespace,
+                            const struct GNUNET_PeerIdentity *target,
+                            struct GNUNET_CONTAINER_BloomFilter *bf,
+                            int32_t mingle,
+                            uint32_t anonymity_level,
+                            uint32_t priority,
+                            const GNUNET_HashCode *replies_seen,
+                            unsigned int replies_seen_count,
+                            GSF_PendingRequestReplyHandler rh,
+                            void *rh_cls)
+{
+  return NULL; // FIXME
+}
+
+
+/**
+ * Update a given pending request with additional replies
+ * that have been seen.
+ *
+ * @param pr request to update
+ * @param replies_seen hash codes of replies that we've seen
+ * @param replies_seen_count size of the replies_seen array
+ */
+void
+GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
+                            const GNUNET_HashCode *replies_seen,
+                            unsigned int replies_seen_count)
+{
+  // FIXME
+}
+
+
+
+/**
+ * Get the query for a given pending request.
+ *
+ * @param pr the request
+ * @return pointer to the query (only valid as long as pr is valid)
+ */
+const GNUNET_HashCode *
+GSF_pending_request_get_query_ (const struct GSF_PendingRequest *pr)
+{
+  return NULL; // FIXME
+}
+
+
+/**
+ * Get the type of a given pending request.
+ *
+ * @param pr the request
+ * @return query type
+ */
+enum GNUNET_BLOCK_Type
+GSF_pending_request_get_type_ (const struct GSF_PendingRequest *pr)
+{
+  return 0; // FIXME
+}
+
+
+/**
+ * Generate the message corresponding to the given pending request for
+ * transmission to other peers (or at least determine its size).
+ *
+ * @param pr request to generate the message for
+ * @param buf_size number of bytes available in buf
+ * @param buf where to copy the message (can be NULL)
+ * @return number of bytes needed (if > buf_size) or used
+ */
+size_t
+GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
+                                 size_t buf_size,
+                                 void *buf)
+{
+  return 0; // FIXME
+}
+
+
+/**
+ * Explicitly cancel a pending request.
+ *
+ * @param pr request to cancel
+ */
+void
+GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr)
+{
+}
+
+
+/**
+ * Iterate over all pending requests.
+ *
+ * @param it function to call for each request
+ * @param cls closure for it
+ */
+void
+GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
+                              void *cls)
+{
+  // FIXME
+}
+
+
+/**
+ * Handle P2P "CONTENT" message.  Checks that the message is
+ * well-formed and then checks if there are any pending requests for
+ * this content and possibly passes it on (to local clients or other
+ * peers).  Does NOT perform migration (content caching at this peer).
+ *
+ * @param other the other peer involved (sender or receiver, NULL
+ *        for loopback messages where we are both sender and receiver)
+ * @param message the actual message
+ * @return how valueable was the content to us (0 for not at all),
+ *         GNUNET_SYSERR if the message was malformed (close connection,
+ *         do not cache under any circumstances)
+ */
+int
+GSF_handle_p2p_content_ (const struct GNUNET_PeerIdentity *other,
+                        const struct GNUNET_MessageHeader *message)
+{
+  return GNUNET_SYSERR; // FIXME
+}
+
+
+/**
+ * Setup the subsystem.
+ */
+void
+GSF_pending_request_init_ ()
+{
+  // FIXME
+}
+
+
+/**
+ * Shutdown the subsystem.
+ */
+void
+GSF_pending_request_done_ ()
+{
+  // FIXME
+}
+
+
+/* end of gnunet-service-fs_pr.c */

Modified: gnunet/src/fs/gnunet-service-fs_pr.h
===================================================================
--- gnunet/src/fs/gnunet-service-fs_pr.h        2011-02-07 22:44:36 UTC (rev 
14368)
+++ gnunet/src/fs/gnunet-service-fs_pr.h        2011-02-08 00:10:36 UTC (rev 
14369)
@@ -200,6 +200,37 @@
                               void *cls);
 
 
+/**
+ * Handle P2P "CONTENT" message.  Checks that the message is
+ * well-formed and then checks if there are any pending requests for
+ * this content and possibly passes it on (to local clients or other
+ * peers).  Does NOT perform migration (content caching at this peer).
+ *
+ * @param other the other peer involved (sender or receiver, NULL
+ *        for loopback messages where we are both sender and receiver)
+ * @param message the actual message
+ * @return how valueable was the content to us (0 for not at all),
+ *         GNUNET_SYSERR if the message was malformed (close connection,
+ *         do not cache under any circumstances)
+ */
+int
+GSF_handle_p2p_content_ (const struct GNUNET_PeerIdentity *other,
+                        const struct GNUNET_MessageHeader *message);
 
+
+/**
+ * Setup the subsystem.
+ */
+void
+GSF_pending_request_init_ (void);
+
+
+/**
+ * Shutdown the subsystem.
+ */
+void
+GSF_pending_request_done_ (void);
+
+
 #endif
 /* end of gnunet-service-fs_pr.h */