src/include/gnunet_constants.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @author Christian Grothoff
  23  *
  24  * @file
  25  * Global constants for performance tuning
  26  *
  27  * @defgroup constants  Constant definitions
  28  * Global constants for performance tuning
  29  * @{
  30  */
  31
  32 #ifndef GNUNET_CONSTANTS_H
  33 #define GNUNET_CONSTANTS_H
  34
  35 #ifdef __cplusplus
  36 extern "C"
  37 {
  38 #if 0                           /* keep Emacsens' auto-indent happy */
  39 }
  40 #endif
  41 #endif
  42
  43
  44 /**
  45  * Bandwidth (in/out) to assume initially (before either peer has
  46  * communicated any particular preference).  Should be rather low; set
  47  * so that at least one maximum-size message can be send roughly once
  48  * per minute.
  49  */
  50 #define GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT GNUNET_BANDWIDTH_value_init (1024)
  51
  52 /**
  53  * After how long do we consider a connection to a peer dead
  54  * if we don't receive messages from the peer?
  55  */
  56 #define GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT GNUNET_TIME_relative_multiply ( \
  57     GNUNET_TIME_UNIT_MINUTES, 5)
  58
  59 /**
  60  * How long do we delay reading more from a peer after a quota violation?
  61  */
  62 #define GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT GNUNET_TIME_relative_multiply ( \
  63     GNUNET_TIME_UNIT_SECONDS, 2)
  64
  65 /**
  66  * After how long do we consider a service unresponsive
  67  * even if we assume that the service commonly does not
  68  * respond instantly (DNS, Database, etc.).
  69  */
  70 #define GNUNET_CONSTANTS_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply ( \
  71     GNUNET_TIME_UNIT_MINUTES, 10)
  72
  73 /**
  74  * How long do we delay messages to get larger packet sizes (CORKing)?
  75  */
  76 #define GNUNET_CONSTANTS_MAX_CORK_DELAY GNUNET_TIME_relative_multiply ( \
  77     GNUNET_TIME_UNIT_SECONDS, 1)
  78
  79 /**
  80  * After what amount of latency for a message do we print a warning?
  81  */
  82 #define GNUNET_CONSTANTS_LATENCY_WARN GNUNET_TIME_relative_multiply ( \
  83     GNUNET_TIME_UNIT_SECONDS, 3)
  84
  85 /**
  86  * Until which load do we consider the peer overly idle
  87  * (which means that we would like to use more resources).<p>
  88  *
  89  * Note that we use 70 to leave some room for applications
  90  * to consume resources "idly" (i.e. up to 85%) and then
  91  * still have some room for "paid for" resource consumption.
  92  */
  93 #define GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD 70
  94
  95 /**
  96  * For how long do we allow unused bandwidth
  97  * from the past to carry over into the future? (in seconds)
  98  */
  99 #define GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S 5
 100
 101
 102 /**
 103  * After how long do we expire an address in a HELLO that we just
 104  * validated?  This value is also used for our own addresses when we
 105  * create a HELLO.
 106  */
 107 #define GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply ( \
 108     GNUNET_TIME_UNIT_HOURS, 12)
 109
 110
 111 /**
 112  * How long do we cache records at most in the DHT?
 113  */
 114 #define GNUNET_CONSTANTS_DHT_MAX_EXPIRATION GNUNET_TIME_relative_multiply ( \
 115     GNUNET_TIME_UNIT_HOURS, 24)
 116
 117
 118 /**
 119  * Size of the `struct EncryptedMessage` of the core (which
 120  * is the per-message overhead of the core).
 121  */
 122 #define GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE (24 + sizeof(struct \
 123                                                                   GNUNET_HashCode))
 124
 125 /**
 126  * What is the maximum size for encrypted messages?  Note that this
 127  * number imposes a clear limit on the maximum size of any message.
 128  * Set to a value close to 64k but not so close that transports will
 129  * have trouble with their headers.
 130  *
 131  * Could theoretically be 64k minus (#GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE +
 132  * #GNUNET_CONSTANTS_TRANSPORT_SIZE_OUTBOUND_MESSAGE), but we're going
 133  * to be more conservative for now.
 134  */
 135 #define GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE (63 * 1024)
 136
 137 /**
 138  * Size of the CADET message overhead:
 139  * = sizeof (struct GNUNET_CADET_TunnelEncryptedMessage)
 140  * + sizeof (struct GNUNET_CADET_ChannelAppDataMessage)
 141  * + sizeof (struct GNUNET_CADET_ConnectionEncryptedAckMessage))
 142  *
 143  * Checked for correcteness in gnunet-service-cadet_tunnel.c: GCT_init().
 144  */
 145 #define GNUNET_CONSTANTS_CADET_P2P_OVERHEAD 164
 146
 147 /**
 148  * Maximum message size that can be sent on CADET.
 149  */
 150 #define GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE \
 151   (GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE \
 152    - GNUNET_CONSTANTS_CADET_P2P_OVERHEAD)
 153
 154 /**
 155  * Largest block that can be stored in the DHT.
 156  */
 157 #define GNUNET_CONSTANTS_MAX_BLOCK_SIZE (62 * 1024)
 158
 159
 160 /**
 161  * K-value that must be used for the bloom filters in 'GET'
 162  * queries.
 163  */
 164 #define GNUNET_CONSTANTS_BLOOMFILTER_K 16
 165
 166
 167 #if 0                           /* keep Emacsens' auto-indent happy */
 168 {
 169 #endif
 170 #ifdef __cplusplus
 171 }
 172 #endif
 173
 174 #endif
 175
 176 /** @} */  /* end of group */