new key, new HELLO
[oweals/gnunet.git] / 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 /**
46  * Bandwidth (in/out) to assume initially (before either peer has
47  * communicated any particular preference).  Should be rather low; set
48  * so that at least one maximum-size message can be send roughly once
49  * per minute.
50  */
51 #define GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT GNUNET_BANDWIDTH_value_init (1024)
52
53 /**
54  * After how long do we consider a connection to a peer dead
55  * if we don't receive messages from the peer?
56  */
57 #define GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT GNUNET_TIME_relative_multiply (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 (GNUNET_TIME_UNIT_SECONDS, 2)
63
64 /**
65  * After how long do we consider a service unresponsive
66  * even if we assume that the service commonly does not
67  * respond instantly (DNS, Database, etc.).
68  */
69 #define GNUNET_CONSTANTS_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 10)
70
71 /**
72  * How long do we delay messages to get larger packet sizes (CORKing)?
73  */
74 #define GNUNET_CONSTANTS_MAX_CORK_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
75
76 /**
77  * After what amount of latency for a message do we print a warning?
78  */
79 #define GNUNET_CONSTANTS_LATENCY_WARN GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
80
81 /**
82  * Until which load do we consider the peer overly idle
83  * (which means that we would like to use more resources).<p>
84  *
85  * Note that we use 70 to leave some room for applications
86  * to consume resources "idly" (i.e. up to 85%) and then
87  * still have some room for "paid for" resource consumption.
88  */
89 #define GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD 70
90
91 /**
92  * For how long do we allow unused bandwidth
93  * from the past to carry over into the future? (in seconds)
94  */
95 #define GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S 5
96
97
98 /**
99  * After how long do we expire an address in a HELLO that we just
100  * validated?  This value is also used for our own addresses when we
101  * create a HELLO.
102  */
103 #define GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
104
105
106 /**
107  * How long do we cache records at most in the DHT?
108  */
109 #define GNUNET_CONSTANTS_DHT_MAX_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 24)
110
111
112 /**
113  * Size of the `struct EncryptedMessage` of the core (which
114  * is the per-message overhead of the core).
115  */
116 #define GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE (24 + sizeof (struct GNUNET_HashCode))
117
118 /**
119  * What is the maximum size for encrypted messages?  Note that this
120  * number imposes a clear limit on the maximum size of any message.
121  * Set to a value close to 64k but not so close that transports will
122  * have trouble with their headers.
123  *
124  * Could theoretically be 64k minus (#GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE +
125  * #GNUNET_CONSTANTS_TRANSPORT_SIZE_OUTBOUND_MESSAGE), but we're going
126  * to be more conservative for now.
127  */
128 #define GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE (63 * 1024)
129
130 /**
131  * Size of the CADET message overhead:
132  * = sizeof (struct GNUNET_CADET_TunnelEncryptedMessage)
133  * + sizeof (struct GNUNET_CADET_ChannelAppDataMessage)
134  * + sizeof (struct GNUNET_CADET_ConnectionEncryptedAckMessage))
135  *
136  * Checked for correcteness in gnunet-service-cadet_tunnel.c: GCT_init().
137  */
138 #define GNUNET_CONSTANTS_CADET_P2P_OVERHEAD 164
139
140 /**
141  * Maximum message size that can be sent on CADET.
142  */
143 #define GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE \
144 (GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE - GNUNET_CONSTANTS_CADET_P2P_OVERHEAD)
145
146 /**
147  * Largest block that can be stored in the DHT.
148  */
149 #define GNUNET_CONSTANTS_MAX_BLOCK_SIZE (62 * 1024)
150
151
152 /**
153  * K-value that must be used for the bloom filters in 'GET'
154  * queries.
155  */
156 #define GNUNET_CONSTANTS_BLOOMFILTER_K 16
157
158
159
160
161 #if 0                           /* keep Emacsens' auto-indent happy */
162 {
163 #endif
164 #ifdef __cplusplus
165 }
166 #endif
167
168 #endif
169
170 /** @} */  /* end of group */