123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477 |
- /*
- This file is part of GNUnet.
- (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
- 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.
- */
- /**
- * @author Christian Grothoff
- * @author Nathan Evans
- * @file dht/dht.h
- */
- #ifndef DHT_H
- #define DHT_H
- /**
- * Size of the bloom filter the DHT uses to filter peers.
- */
- #define DHT_BLOOM_SIZE 128
- GNUNET_NETWORK_STRUCT_BEGIN
- /**
- * Message which indicates the DHT should cancel outstanding
- * requests and discard any state.
- */
- struct GNUNET_DHT_ClientGetStopMessage
- {
- /**
- * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP
- */
- struct GNUNET_MessageHeader header;
- /**
- * Always zero.
- */
- uint32_t reserved GNUNET_PACKED;
- /**
- * Unique ID identifying this request
- */
- uint64_t unique_id GNUNET_PACKED;
- /**
- * Key of this request
- */
- struct GNUNET_HashCode key;
- };
- /**
- * DHT GET message sent from clients to service. Indicates that a GET
- * request should be issued.
- */
- struct GNUNET_DHT_ClientGetMessage
- {
- /**
- * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET
- */
- struct GNUNET_MessageHeader header;
- /**
- * Message options, actually an 'enum GNUNET_DHT_RouteOption' value.
- */
- uint32_t options GNUNET_PACKED;
- /**
- * Replication level for this message
- */
- uint32_t desired_replication_level GNUNET_PACKED;
- /**
- * The type for the data for the GET request; actually an 'enum
- * GNUNET_BLOCK_Type'.
- */
- uint32_t type GNUNET_PACKED;
- /**
- * The key to search for
- */
- struct GNUNET_HashCode key GNUNET_PACKED;
- /**
- * Unique ID identifying this request, if 0 then
- * the client will not expect a response
- */
- uint64_t unique_id GNUNET_PACKED;
- /* Possibly followed by xquery, copied to end of this dealy do */
- };
- /**
- * 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
- */
- struct GNUNET_MessageHeader header;
- /**
- * The type for the data.
- */
- uint32_t type GNUNET_PACKED;
- /**
- * Number of peers recorded in the outgoing path from source to the
- * storgage location of this message.
- */
- uint32_t put_path_length GNUNET_PACKED;
- /**
- * The number of peer identities recorded from the storage location
- * to this peer.
- */
- uint32_t get_path_length GNUNET_PACKED;
- /**
- * Unique ID of the matching GET request.
- */
- uint64_t unique_id GNUNET_PACKED;
- /**
- * When does this entry expire?
- */
- struct GNUNET_TIME_AbsoluteNBO expiration;
- /**
- * The key that was searched for
- */
- struct GNUNET_HashCode key GNUNET_PACKED;
- /* put path, get path and actual data are copied to end of this dealy do */
- };
- /**
- * Message to insert data into the DHT, sent from clients to DHT service.
- */
- struct GNUNET_DHT_ClientPutMessage
- {
- /**
- * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT
- */
- struct GNUNET_MessageHeader header;
- /**
- * The type of data to insert.
- */
- uint32_t type GNUNET_PACKED;
- /**
- * Message options, actually an 'enum GNUNET_DHT_RouteOption' value.
- */
- uint32_t options GNUNET_PACKED;
- /**
- * Replication level for this message
- */
- 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?
- */
- struct GNUNET_TIME_AbsoluteNBO expiration;
- /**
- * The key to store the value under.
- */
- struct GNUNET_HashCode key GNUNET_PACKED;
- /* DATA copied to end of this message */
- };
- /**
- * Message to confirming receipt of PUT, sent from DHT service to clients.
- */
- struct GNUNET_DHT_ClientPutConfirmationMessage
- {
- /**
- * Type: #GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK
- */
- struct GNUNET_MessageHeader header;
- /**
- * Always zero.
- */
- 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
- */
- 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 put_path_length GNUNET_PACKED;
- /**
- * How long should this data persist?
- */
- struct GNUNET_TIME_AbsoluteNBO expiration_time;
- /**
- * The key to store the value under.
- */
- struct GNUNET_HashCode key GNUNET_PACKED;
- /* put path (if tracked) */
- /* Payload */
- };
- /**
- * Message to request monitoring messages, clients -> DHT service.
- */
- struct GNUNET_DHT_MonitorStartStopMessage
- {
- /**
- * Type: #GNUNET_MESSAGE_TYPE_DHT_MONITOR_START or
- * #GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP
- */
- 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.
- */
- 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) */
- /* get path (if tracked) */
- /* Payload */
- };
- #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
|