missing changes to headers
[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  * @file include/gnunet_constants.h
23  * @brief "global" constants for performance tuning
24  * @author Christian Grothoff
25  */
26
27 #ifndef GNUNET_CONSTANTS_H
28 #define GNUNET_CONSTANTS_H
29
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #if 0                           /* keep Emacsens' auto-indent happy */
34 }
35 #endif
36 #endif
37
38 /**
39  * Last resort choice for configuration file name.
40  */
41 #define GNUNET_DEFAULT_USER_CONFIG_FILE "~/.config/gnunet.conf"
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  * Until which load do we consider the peer overly idle
76  * (which means that we would like to use more resources).<p>
77  *
78  * Note that we use 70 to leave some room for applications
79  * to consume resources "idly" (i.e. up to 85%) and then
80  * still have some room for "paid for" resource consumption.
81  */
82 #define GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD 70
83
84 /**
85  * For how long do we allow unused bandwidth
86  * from the past to carry over into the future? (in seconds)
87  */
88 #define GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S 5
89
90
91 /**
92  * After how long do we expire an address in a HELLO that we just
93  * validated?  This value is also used for our own addresses when we
94  * create a HELLO.
95  */
96 #define GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
97
98
99 /**
100  * How long do we cache records at most in the DHT?
101  */
102 #define GNUNET_CONSTANTS_DHT_MAX_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 24)
103
104
105 /**
106  * Size of the `struct EncryptedMessage` of the core (which
107  * is the per-message overhead of the core).
108  */
109 #define GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE (24 + sizeof (struct GNUNET_HashCode))
110
111 /**
112  * What is the maximum size for encrypted messages?  Note that this
113  * number imposes a clear limit on the maximum size of any message.
114  * Set to a value close to 64k but not so close that transports will
115  * have trouble with their headers.
116  *
117  * Could theoretically be 64k minus (#GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE +
118  * #GNUNET_CONSTANTS_TRANSPORT_SIZE_OUTBOUND_MESSAGE), but we're going
119  * to be more conservative for now.
120  */
121 #define GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE (63 * 1024)
122
123 /**
124  * Size of the CADET message overhead:
125  * + sizeof (struct GNUNET_CADET_Encrypted)
126  * + sizeof (struct GNUNET_CADET_Data)
127  * + sizeof (struct GNUNET_CADET_ACK))
128  *
129  * Checked for correcteness in gnunet-service-cadet_tunnel.c: GCT_init().
130  */
131 #define GNUNET_CONSTANTS_CADET_P2P_OVERHEAD 132
132
133 /**
134  * Maximum message size that can be sent on CADET.
135  */
136 #define GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE \
137 (GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE - GNUNET_CONSTANTS_CADET_P2P_OVERHEAD)
138
139 /**
140  * Largest block that can be stored in the DHT.
141  */
142 #define GNUNET_CONSTANTS_MAX_BLOCK_SIZE (62 * 1024)
143
144
145 /**
146  * K-value that must be used for the bloom filters in 'GET'
147  * queries.
148  */
149 #define GNUNET_CONSTANTS_BLOOMFILTER_K 16
150
151
152
153
154 #if 0                           /* keep Emacsens' auto-indent happy */
155 {
156 #endif
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif