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