aboutsummaryrefslogtreecommitdiff
path: root/content/en/docs/Reference/compopt.html
blob: 4c4459c12cd63b258c2a255505e8cfd652c5915c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
---
title: "Compilation options"
date:  2019-06-22
draft: false
---

<p>
  Below is a list of the compile-time configuration options for
  Ouroboros. These can be set using
</p>
<pre><code>$ cmake -D&lt;option&gt;=&lt;value&gt; ..</code></pre>
<p>or using</p>
<pre><code>ccmake .</code></pre>
<p>
  Options will only show up in ccmake if they are relevant for
  your system configuration. The default value for each option
  is <u>underlined</u>. Boolean values will print as ON/OFF in
  ccmake instead of True/False.
</p>
<table>
  <tr>
    <th>Option</th>
    <th>Description</th>
    <th>Values</th>
  </tr>
  <tr>
    <th colspan="3">Compilation options</th>
  </tr>
  <tr>
    <td>CMAKE_BUILD_TYPE</td>
    <td>
      Set the build type for Ouroboros. Debug builds will add some
      extra logging. The debug build can further enable the
      address sanitizer (ASan) thread sanitizer (TSan) and leak
      sanitizer (LSan) options.
    </td>
    <td>
      <u>Release</u>, Debug, DebugASan, DebugTSan, DebugLSan
    </td>
  </tr>
  <tr>
    <td>CMAKE_INSTALL_PREFIX</td>
    <td>
      Set a path prefix in order to install Ouroboros in a
      sandboxed environment. Default is a system-wide install.
    </td>
    <td>
      &lt;path&gt;
    </td>
  </tr>
  <tr>
    <td>DISABLE_SWIG</td>
    <td>
      Disable SWIG support.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <th colspan="3">Library options</th>
  <tr>
  <tr>
    <td>DISABLE_FUSE</td>
    <td>
      Disable FUSE support, removing the virtual filesystem under
      &lt;FUSE_PREFIX&gt;.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>FUSE_PREFIX</td>
    <td>
      Set the path where the fuse system should be
      mounted. Default is /tmp/ouroboros.
    </td>
    <td>
      &lt;path&gt;
    </td>
  </tr>
  <tr>
    <td>DISABLE_LIBGCRYPT</td>
    <td>
      Disable support for using the libgcrypt library for
      cryptographically secure random number generation and
      hashing.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>DISABLE_OPENSSL</td>
    <td>
      Disable support for the libssl library for cryptographic
      random number generation and hashing.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>DISABLE_ROBUST_MUTEXES</td>
    <td>
      Disable
      <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutexattr_getrobust.html">
	robust mutex
      </a>
      support. Without robust mutex support, Ouroboros may lock up
      if processes are killed using SIGKILL.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>PTHREAD_COND_CLOCK</td>
    <td>
      Set the
      <a href="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/time.h.html">
	clock type
      </a>
      to use for timeouts for pthread condition variables. Default
      on Linux/FreeBSD: CLOCK_MONOTONIC.  Default on OS X:
      CLOCK_REALTIME.
    </td>
    <td>
      &lt;clock_id_t&gt;
    </td>
  </tr>
  <tr>
    <th colspan="3">Shared memory system options</th>
  <tr>
  <tr>
    <td>SHM_PREFIX</td>
    <td>
      Set a prefix for the shared memory filenames. The mandatory
      leading
      <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/shm_open.html">
	slash
      </a>
      is added by the build system. Default is "ouroboros".
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>SHM_BUFFER_SIZE</td>
    <td>
      Set the maximum total number of packet blocks Ouroboros
      can buffer at any point in time. Must be a power of 2.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>SHM_RDRB_BLOCK_SIZE</td>
    <td>
      Set the size of a packet block. Default: page size of the
      system.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>SHM_RDRB_MULTI-BLOCK</td>
    <td>
      Allow packets that are larger than a single packet block.
    </td>
    <td>
      <u>True</u>, False
    </td>
  </tr>
  <tr>
    <td>DU_BUFF_HEADSPACE</td>
    <td>
      Set the amount of space to allow for the addition of
      protocol headers when a new packet buffer is passed to the
      system. Default: 128 bytes.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>DU_BUFF_TAILSPACE</td>
    <td>
      Set the amount of space to allow for the addition of
      protocol tail information (CRCs) when a new packet buffer
      is passed to the system. Default: 32 bytes.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <th colspan="3">IRMd options</th>
  </tr>
  <tr>
    <td>SYS_MAX_FLOWS</td>
    <td>
      The maximum number of flows this Ouroboros system can
      allocate. Default: 10240.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>SOCKET_TIMEOUT</td>
    <td>
      The IRMd sends commands to IPCPs over UNIX sockets. This
      sets the timeout for such commands in milliseconds. Some
      commands can be set independently. Default: 1000.
    </td>
    <td>
      &lt;time_t&gt;
    </td>
  </tr>
  <tr>
    <td>BOOTSTRAP_TIMEOUT</td>
    <td>
      Timeout for the IRMd to wait for a response to a bootstrap
      command from an IPCP in milliseconds. Default: 5000.
    </td>
    <td>
      &lt;time_t&gt;
    </td>
  </tr>
  <tr>
    <td>ENROLL_TIMEOUT</td>
    <td>
      Timeout for the IRMd to wait for a response to an enroll
      command from an IPCP in milliseconds. Default: 60000.
    </td>
    <td>
      &lt;time_t&gt;
    </td>
  </tr>
  <tr>
    <td>CONNECT_TIMEOUT</td>
    <td>
      Timeout for the IRMd to wait for a response to a connect
      command from an IPCP in milliseconds. Default: 5000.
    </td>
    <td>
      &lt;time_t&gt;
    </td>
  </tr>
  <tr>
    <td>REG_TIMEOUT</td>
    <td>
      Timeout for the IRMd to wait for a response to a register
      command from an IPCP in milliseconds. Default: 3000.
    </td>
    <td>
      &lt;time_t&gt;
    </td>
  </tr>
  <tr>
    <td>QUERY_TIMEOUT</td>
    <td>
      Timeout for the IRMd to wait for a response to a query
      command from an IPCP in milliseconds. Default: 3000.
    </td>
    <td>
      &lt;time_t&gt;
    </td>
  </tr>
  <tr>
    <td>IRMD_MIN_THREADS</td>
    <td>
      The minimum number of threads in the threadpool the IRMd
      keeps waiting for commands. Default: 8.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>IRMD_ADD_THREADS</td>
    <td>
      The number of threads the IRMd will create if the current
      available threadpool is lower than
      IRMD_MIN_THREADS. Default: 8.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <th colspan="3">IPCP options</th>
  </tr>
  <tr>
    <td>DISABLE_RAPTOR</td>
    <td>
      Disable support for the raptor NetFPGA implementation.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>DISABLE_BPF</td>
    <td>
      Disable support for the Berkeley Packet Filter device
      interface for the Ethernet LLC layer. If no suitable
      interface is found, the LLC layer will not be built.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>DISABLE_NETMAP</td>
    <td>
      Disable <a href="http://info.iet.unipi.it/~luigi/netmap/">netmap</a>
      support for the Ethernet LLC layer. If no suitable interface
      is found, the LLC layer will not be built.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>DISABLE_RAW_SOCKETS</td>
    <td>
      Disable raw sockets support for the Ethernet LLC layer. If
      no suitable interface is found,the LLC layer will not be
      built.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>DISABLE_DDNS</td>
    <td>
      Disable Dynamic Domain Name System support for the UDP
      layer.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>
  <tr>
    <td>IPCP_SCHED_THR_MUL</td>
    <td>
      The number of scheduler threads an IPCP runs per QoS
      cube. Default is 2.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>IPCP_QOS_CUBE_BE_PRIORITY</td>
    <td>
      Priority for the best effort qos cube scheduler
      thread. This is mapped to a system value. Scheduler
      threads have at least half the system max priority value.
    </td>
    <td>
      <u>0</u>..99
    </td>
  </tr>
  <tr>
    <td>IPCP_QOS_CUBE_VIDEO_PRIORITY</td>
    <td>
      Priority for the video qos cube scheduler thread. This is
      mapped to a system value. Scheduler threads have at least
      half the system max priority value.
    </td>
    <td>
      0..<u>90</u>..99
    </td>
  </tr>
  <tr>
    <td>IPCP_QOS_CUBE_VOICE_PRIORITY</td>
    <td>
      Priority for the voice qos cube scheduler thread. This is
      mapped to a system value. Scheduler threads have at least
      half the system max priority value.
    </td>
    <td>
      0..<u>99</u>
    </td>
  </tr>
  <tr>
    <td>IPCP_FLOW_STATS</td>
    <td>
      Enable statistics for the data transfer component.
    </td>
    <td>
      True, <u>False</u>
    </td>
  </tr>

  <tr>
    <td>PFT_SIZE</td>
    <td>
      The forwarding table in the normal IPCP uses a
      hashtable. This sets the size of this hash table. Default: 4096.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>IPCP_MIN_THREADS</td>
    <td>
      The minimum number of threads in the threadpool the IPCP
      keeps waiting for commands. Default: 4.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
  <tr>
    <td>IPCP_ADD_THREADS</td>
    <td>
      The number of threads the IPCP will create if the current
      available threadpool is lower than
      IPCP_MIN_THREADS. Default:4.
    </td>
    <td>
      &lt;size_t&gt;
    </td>
  </tr>
</table>