doxygen: group/module definitions (part 1)
[oweals/gnunet.git] / src / include / gnunet_constants.h
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2009 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      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      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, USA.
19 */
20
21 /**
22  * @author Christian Grothoff
23  *
24  * @file
25  * "Global" constants for performance tuning
26  */
27
28 #ifndef GNUNET_CONSTANTS_H
29 #define GNUNET_CONSTANTS_H
30
31 #ifdef __cplusplus
32 extern "C"
33 {
34 #if 0                           /* keep Emacsens' auto-indent happy */
35 }
36 #endif
37 #endif
38
39 /**
40  * Last resort choice for configuration file name.
41  */
42 #define GNUNET_DEFAULT_USER_CONFIG_FILE "~/.config/gnunet.conf"
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 (GNUNET_TIME_UNIT_MINUTES, 5)
57
58 /**
59  * How long do we delay reading more from a peer after a quota violation?
60  */
61 #define GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
62
63 /**
64  * After how long do we consider a service unresponsive
65  * even if we assume that the service commonly does not
66  * respond instantly (DNS, Database, etc.).
67  */
68 #define GNUNET_CONSTANTS_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 10)
69
70 /**
71  * How long do we delay messages to get larger packet sizes (CORKing)?
72  */
73 #define GNUNET_CONSTANTS_MAX_CORK_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
74
75 /**
76  * After what amount of latency for a message do we print a warning?
77  */
78 #define GNUNET_CONSTANTS_LATENCY_WARN GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
79
80 /**
81  * Until which load do we consider the peer overly idle
82  * (which means that we would like to use more resources).<p>
83  *
84  * Note that we use 70 to leave some room for applications
85  * to consume resources "idly" (i.e. up to 85%) and then
86  * still have some room for "paid for" resource consumption.
87  */
88 #define GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD 70
89
90 /**
91  * For how long do we allow unused bandwidth
92  * from the past to carry over into the future? (in seconds)
93  */
94 #define GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S 5
95
96
97 /**
98  * After how long do we expire an address in a HELLO that we just
99  * validated?  This value is also used for our own addresses when we
100  * create a HELLO.
101  */
102 #define GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
103
104
105 /**
106  * How long do we cache records at most in the DHT?
107  */
108 #define GNUNET_CONSTANTS_DHT_MAX_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 24)
109
110
111 /**
112  * Size of the `struct EncryptedMessage` of the core (which
113  * is the per-message overhead of the core).
114  */
115 #define GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE (24 + sizeof (struct GNUNET_HashCode))
116
117 /**
118  * What is the maximum size for encrypted messages?  Note that this
119  * number imposes a clear limit on the maximum size of any message.
120  * Set to a value close to 64k but not so close that transports will
121  * have trouble with their headers.
122  *
123  * Could theoretically be 64k minus (#GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE +
124  * #GNUNET_CONSTANTS_TRANSPORT_SIZE_OUTBOUND_MESSAGE), but we're going
125  * to be more conservative for now.
126  */
127 #define GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE (63 * 1024)
128
129 /**
130  * Size of the CADET message overhead:
131  * + sizeof (struct GNUNET_CADET_Encrypted)
132  * + sizeof (struct GNUNET_CADET_Data)
133  * + sizeof (struct GNUNET_CADET_ACK))
134  *
135  * Checked for correcteness in gnunet-service-cadet_tunnel.c: GCT_init().
136  */
137 #define GNUNET_CONSTANTS_CADET_P2P_OVERHEAD 132
138
139 /**
140  * Maximum message size that can be sent on CADET.
141  */
142 #define GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE \
143 (GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE - GNUNET_CONSTANTS_CADET_P2P_OVERHEAD)
144
145 /**
146  * Largest block that can be stored in the DHT.
147  */
148 #define GNUNET_CONSTANTS_MAX_BLOCK_SIZE (62 * 1024)
149
150
151 /**
152  * K-value that must be used for the bloom filters in 'GET'
153  * queries.
154  */
155 #define GNUNET_CONSTANTS_BLOOMFILTER_K 16
156
157
158
159
160 #if 0                           /* keep Emacsens' auto-indent happy */
161 {
162 #endif
163 #ifdef __cplusplus
164 }
165 #endif
166
167 #endif