Start implementation of some functions.
[oweals/gnunet.git] / src / dht / dht.h
index 9894be89c6f9209ab3ad328ddf091c5a6a93e5d5..c2728cd4348c712e7d095bf1c5b1d721a63cefad 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2003, 2004, 2009, 2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001, 2002, 2003, 2004, 2009, 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
@@ -43,7 +43,7 @@ GNUNET_NETWORK_STRUCT_BEGIN
 struct GNUNET_DHT_ClientGetStopMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_DHT_GET_STOP
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP
    */
   struct GNUNET_MessageHeader header;
 
@@ -60,7 +60,7 @@ struct GNUNET_DHT_ClientGetStopMessage
   /**
    * Key of this request
    */
-  GNUNET_HashCode key;
+  struct GNUNET_HashCode key;
 
 };
 
@@ -72,7 +72,7 @@ struct GNUNET_DHT_ClientGetStopMessage
 struct GNUNET_DHT_ClientGetMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET
    */
   struct GNUNET_MessageHeader header;
 
@@ -90,12 +90,12 @@ struct GNUNET_DHT_ClientGetMessage
    * The type for the data for the GET request; actually an 'enum
    * GNUNET_BLOCK_Type'.
    */
-  uint32_t type;
+  uint32_t type GNUNET_PACKED;
 
   /**
    * The key to search for
    */
-  GNUNET_HashCode key;
+  struct GNUNET_HashCode key GNUNET_PACKED;
 
   /**
    * Unique ID identifying this request, if 0 then
@@ -108,20 +108,53 @@ struct GNUNET_DHT_ClientGetMessage
 };
 
 
+/**
+ * DHT GET RESULTS KNOWN message sent from clients to service. Indicates that a GET
+ * request should exclude certain results which are already known.
+ */
+struct GNUNET_DHT_ClientGetResultSeenMessage
+{
+  /**
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Reserved, always 0.
+   */
+  uint32_t reserved GNUNET_PACKED;
+
+  /**
+   * The key we are searching for (to make it easy to find the corresponding
+   * GET inside the service).
+   */
+  struct GNUNET_HashCode key GNUNET_PACKED;
+
+  /**
+   * Unique ID identifying this request.
+   */
+  uint64_t unique_id GNUNET_PACKED;
+
+  /* Followed by an array of the hash codes of known results */
+
+};
+
+
+
 /**
  * Reply to a GET send from the service to a client.
  */
 struct GNUNET_DHT_ClientResultMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT
    */
   struct GNUNET_MessageHeader header;
 
   /**
    * The type for the data.
    */
-  uint32_t type;
+  uint32_t type GNUNET_PACKED;
 
   /**
    * Number of peers recorded in the outgoing path from source to the
@@ -148,7 +181,7 @@ struct GNUNET_DHT_ClientResultMessage
   /**
    * The key that was searched for
    */
-  GNUNET_HashCode key;
+  struct GNUNET_HashCode key GNUNET_PACKED;
 
   /* put path, get path and actual data are copied to end of this dealy do */
 
@@ -161,7 +194,7 @@ struct GNUNET_DHT_ClientResultMessage
 struct GNUNET_DHT_ClientPutMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT
    */
   struct GNUNET_MessageHeader header;
 
@@ -180,6 +213,11 @@ struct GNUNET_DHT_ClientPutMessage
    */
   uint32_t desired_replication_level GNUNET_PACKED;
 
+  /**
+   * Unique ID for the PUT message.
+   */
+  uint64_t unique_id GNUNET_PACKED;
+
   /**
    * How long should this data persist?
    */
@@ -188,7 +226,7 @@ struct GNUNET_DHT_ClientPutMessage
   /**
    * The key to store the value under.
    */
-  GNUNET_HashCode key;
+  struct GNUNET_HashCode key GNUNET_PACKED;
 
   /* DATA copied to end of this message */
 
@@ -196,26 +234,54 @@ struct GNUNET_DHT_ClientPutMessage
 
 
 /**
- * Message to monitor requests going through peer, clients <--> DHT service.
+ * Message to confirming receipt of PUT, sent from DHT service to clients.
  */
-struct GNUNET_DHT_MonitorMessage
+struct GNUNET_DHT_ClientPutConfirmationMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_DHT_MONITOR_{GET, PUT, GET_RESP, PUT_RESP*}
-   * (*) not yet implemented, necessary for key randomization
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * The type of data in the request.
+   * Always zero.
    */
-  uint32_t type GNUNET_PACKED;
+  uint32_t reserved GNUNET_PACKED;
+
+  /**
+   * Unique ID from the PUT message that is being confirmed.
+   */
+  uint64_t unique_id GNUNET_PACKED;
+
+};
+
+
+
+/**
+ * Message to monitor put requests going through peer, DHT service -> clients.
+ */
+struct GNUNET_DHT_MonitorPutMessage
+{
+  /**
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT
+   */
+  struct GNUNET_MessageHeader header;
 
   /**
    * Message options, actually an 'enum GNUNET_DHT_RouteOption' value.
    */
   uint32_t options GNUNET_PACKED;
 
+  /**
+   * The type of data in the request.
+   */
+  uint32_t type GNUNET_PACKED;
+
+  /**
+   * Hop count so far.
+   */
+  uint32_t hop_count GNUNET_PACKED;
+
   /**
    * Replication level for this message
    */
@@ -223,30 +289,149 @@ struct GNUNET_DHT_MonitorMessage
 
   /**
    * Number of peers recorded in the outgoing path from source to the
-   * storgage location of this message.
+   * storage location of this message.
    */
   uint32_t put_path_length GNUNET_PACKED;
 
   /**
-   * The number of peer identities recorded from the storage location
-   * to this peer.
+   * How long should this data persist?
    */
-  uint32_t get_path_length GNUNET_PACKED;
+  struct GNUNET_TIME_AbsoluteNBO expiration_time;
 
   /**
-   * Unique ID for GET / GET responses.
+   * The key to store the value under.
    */
-  uint64_t unique_id GNUNET_PACKED;
+  struct GNUNET_HashCode key GNUNET_PACKED;
+
+  /* put path (if tracked) */
+
+  /* Payload */
 
+};
+
+
+/**
+ * Message to request monitoring messages, clients -> DHT service.
+ */
+struct GNUNET_DHT_MonitorStartStopMessage
+{
   /**
-   * How long should this data persist?
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_MONITOR_START or
+   * #GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP
    */
-  struct GNUNET_TIME_AbsoluteNBO expiration;
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * The type of data desired, GNUNET_BLOCK_TYPE_ANY for all.
+   */
+  uint32_t type GNUNET_PACKED;
+
+  /**
+   * Flag whether to notify about GET messages.
+   */
+  int16_t get GNUNET_PACKED;
+
+  /**
+   * Flag whether to notify about GET_REPONSE messages.
+   */
+  int16_t get_resp GNUNET_PACKED;
+
+  /**
+   * Flag whether to notify about PUT messages.
+   */
+  int16_t put GNUNET_PACKED;
+
+  /**
+   * Flag whether to use the provided key to filter messages.
+   */
+  int16_t filter_key GNUNET_PACKED;
+
+  /**
+   * The key to filter messages by.
+   */
+  struct GNUNET_HashCode key GNUNET_PACKED;
+};
+
+
+/**
+ * Message to monitor get requests going through peer, DHT service -> clients.
+ */
+struct GNUNET_DHT_MonitorGetMessage
+{
+  /**
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Message options, actually an 'enum GNUNET_DHT_RouteOption' value.
+   */
+  uint32_t options GNUNET_PACKED;
+
+  /**
+   * The type of data in the request.
+   */
+  uint32_t type GNUNET_PACKED;
+
+  /**
+   * Hop count
+   */
+  uint32_t hop_count GNUNET_PACKED;
+
+  /**
+   * Replication level for this message
+   */
+  uint32_t desired_replication_level GNUNET_PACKED;
+
+  /**
+   * Number of peers recorded in the outgoing path from source to the
+   * storage location of this message.
+   */
+  uint32_t get_path_length GNUNET_PACKED;
 
   /**
    * The key to store the value under.
    */
-  GNUNET_HashCode key;
+  struct GNUNET_HashCode key GNUNET_PACKED;
+
+  /* get path (if tracked) */
+
+};
+
+/**
+ * Message to monitor get results going through peer, DHT service -> clients.
+ */
+struct GNUNET_DHT_MonitorGetRespMessage
+{
+  /**
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_P2P_RESULT
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Content type.
+   */
+  uint32_t type GNUNET_PACKED;
+
+  /**
+   * Length of the PUT path that follows (if tracked).
+   */
+  uint32_t put_path_length GNUNET_PACKED;
+
+  /**
+   * Length of the GET path that follows (if tracked).
+   */
+  uint32_t get_path_length GNUNET_PACKED;
+
+  /**
+   * When does the content expire?
+   */
+  struct GNUNET_TIME_AbsoluteNBO expiration_time;
+
+  /**
+   * The key of the corresponding GET request.
+   */
+  struct GNUNET_HashCode key GNUNET_PACKED;
 
   /* put path (if tracked) */
 
@@ -256,6 +441,37 @@ struct GNUNET_DHT_MonitorMessage
 
 };
 
+#if ENABLE_MALICIOUS
+
+/**
+ * Message to confirming receipt of ACT MALICIOUS, sent from DHT service to clients.
+ */
+struct GNUNET_DHT_ClientActMaliciousConfirmationMessage
+{
+  /**
+   * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK
+   */
+  struct GNUNET_MessageHeader header;
+};
+
+
+/**
+ * Message to turn the service malicious
+ */
+struct GNUNET_DHT_ActMaliciousMessage
+{
+  /**
+   * Type: #GNUNET_MESSAGE_TYPE_ACT_MALICIOUS
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * If set to 1, act maliciously
+   */
+  uint32_t action;
+};
+#endif
+
 GNUNET_NETWORK_STRUCT_END
 
 #endif