adding Ludo's gnunet-download-manager.scm back to SVN HEAD
[oweals/gnunet.git] / src / include / gnunet_constants.h
1 /*
2      This file is part of GNUnet.
3      (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 2, 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., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, 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 #include "gnunet_bandwidth_lib.h"
39
40 /**
41  * Bandwidth (in/out) to assume initially (before either peer has
42  * communicated any particular preference).  Should be rather low; set
43  * so that at least one maximum-size message can be send roughly once
44  * per minute.
45  */
46 #define GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT GNUNET_BANDWIDTH_value_init (1024)
47
48 /**
49  * After how long do we consider a connection to a peer dead
50  * if we don't receive messages from the peer?
51  */
52 #define GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
53
54 /**
55  * After how long do we consider a connection to a peer dead
56  * if we got an explicit disconnect and were unable to reconnect?
57  */
58 #define GNUNET_CONSTANTS_DISCONNECT_SESSION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
59
60 /**
61  * How long do we delay reading more from a peer after a quota violation?
62  */
63 #define GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
64
65 /**
66  * How long do we wait after a FORK+EXEC before testing for the
67  * resulting process to be up (port open, waitpid, etc.)?
68  */
69 #define GNUNET_CONSTANTS_EXEC_WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 200)
70
71 /**
72  * After how long do we retry a service connection that was
73  * unavailable?  Used in cases where an exponential back-off
74  * seems inappropriate.
75  */
76 #define GNUNET_CONSTANTS_SERVICE_RETRY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
77
78 /**
79  * After how long do we consider a service unresponsive
80  * even if we assume that the service commonly does not
81  * respond instantly (DNS, Database, etc.).
82  */
83 #define GNUNET_CONSTANTS_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 10)
84
85 /**
86  * How long do we delay messages to get larger packet sizes (CORKing)?
87  */
88 #define GNUNET_CONSTANTS_MAX_CORK_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
89
90 /**
91  * Until which load do we consider the peer overly idle
92  * (which means that we would like to use more resources).<p>
93  *
94  * Note that we use 70 to leave some room for applications
95  * to consume resources "idly" (i.e. up to 85%) and then
96  * still have some room for "paid for" resource consumption.
97  */
98 #define GNUNET_CONSTANTS_IDLE_LOAD_THRESHOLD 70
99
100 /**
101  * For how long do we allow unused bandwidth
102  * from the past to carry over into the future? (in seconds)
103  */
104 #define GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S 5
105
106
107 /**
108  * After how long do we expire an address in a HELLO that we just
109  * validated?  This value is also used for our own addresses when we
110  * create a HELLO.
111  */
112 #define GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
113
114
115 /**
116  * Size of the 'struct EncryptedMessage' of the core (which
117  * is the per-message overhead of the core).
118  */
119 #define GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE (24 + sizeof (GNUNET_HashCode))
120
121 /**
122  * Size of the 'struct OutboundMessage' of the transport
123  * (which, in combination with the
124  * GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE) defines
125  * the headers that must be pre-pendable to all GNUnet
126  * messages.  Taking GNUNET_SERVER_MAX_MESSAGE_SIZE
127  * and subtracting these two constants defines the largest
128  * message core can handle.
129  */
130 #define GNUNET_CONSTANTS_TRANSPORT_SIZE_OUTBOUND_MESSAGE (16 + sizeof (struct GNUNET_PeerIdentity))
131
132
133 /**
134  * What is the maximum size for encrypted messages?  Note that this
135  * number imposes a clear limit on the maximum size of any message.
136  * Set to a value close to 64k but not so close that transports will
137  * have trouble with their headers.
138  *
139  * Could theoretically be 64k minus (GNUNET_CONSTANTS_CORE_SIZE_ENCRYPTED_MESSAGE +
140  * GNUNET_CONSTANTS_TRANSPORT_SIZE_OUTBOUND_MESSAGE), but we're going
141  * to be more conservative for now.
142  */
143 #define GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE (63 * 1024)
144
145
146 /**
147  * K-value that must be used for the bloom filters in 'GET'
148  * queries.
149  */
150 #define GNUNET_CONSTANTS_BLOOMFILTER_K 16
151
152
153
154 #if 0                           /* keep Emacsens' auto-indent happy */
155 {
156 #endif
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif