blob: a897fa92a89af5715104edb336879e8823610265 (
plain) (
blame)
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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://www.rtems.org/bugs.html
..
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual. The manual is provided as a part of
.. a release. For development sources please refer to the online
.. documentation at:
..
.. https://docs.rtems.org
.. Generated from spec:/acfg/if/group-bdbuf
Block Device Cache Configuration
================================
This section describes configuration options related to the Block Device Cache
(bdbuf).
.. Generated from spec:/acfg/if/appl-needs-libblock
.. raw:: latex
\clearpage
.. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
.. _CONFIGURE_APPLICATION_NEEDS_LIBBLOCK:
CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
------------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_APPLICATION_NEEDS_LIBBLOCK``
.. rubric:: OPTION TYPE:
This configuration option is a boolean feature define.
.. rubric:: DEFAULT CONFIGURATION:
If this configuration option is undefined, then the described feature is not
enabled.
.. rubric:: DESCRIPTION:
In case this configuration option is defined, then the Block Device Cache is
initialized during system initialization.
.. rubric:: NOTES:
Each option of the Block Device Cache (bdbuf) configuration can be explicitly
set by the user with the configuration options below. The Block Device Cache
is used for example by the RFS and DOSFS filesystems.
.. Generated from spec:/acfg/if/bdbuf-buffer-max-size
.. raw:: latex
\clearpage
.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
.. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE:
CONFIGURE_BDBUF_BUFFER_MAX_SIZE
-------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_BDBUF_BUFFER_MAX_SIZE``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 4096.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the maximum size of a buffer
in bytes.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be an integral multiple of
:ref:`CONFIGURE_BDBUF_BUFFER_MIN_SIZE`.
.. Generated from spec:/acfg/if/bdbuf-buffer-min-size
.. raw:: latex
\clearpage
.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
.. _CONFIGURE_BDBUF_BUFFER_MIN_SIZE:
CONFIGURE_BDBUF_BUFFER_MIN_SIZE
-------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_BDBUF_BUFFER_MIN_SIZE``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 512.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the minimum size of a buffer
in bytes.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/bdbuf-cache-memory-size
.. raw:: latex
\clearpage
.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
.. _CONFIGURE_BDBUF_CACHE_MEMORY_SIZE:
CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
---------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_BDBUF_CACHE_MEMORY_SIZE``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 32768.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the size of the cache memory
in bytes.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
.. Generated from spec:/acfg/if/bdbuf-max-read-ahead-blocks
.. raw:: latex
\clearpage
.. index:: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
.. _CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS:
CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS
-------------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 0.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the maximum blocks per
read-ahead request.
.. rubric:: NOTES:
A value of 0 disables the read-ahead task (default). The read-ahead task
will issue speculative read transfers if a sequential access pattern is
detected. This can improve the performance on some systems.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/bdbuf-max-write-blocks
.. raw:: latex
\clearpage
.. index:: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
.. _CONFIGURE_BDBUF_MAX_WRITE_BLOCKS:
CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
--------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_BDBUF_MAX_WRITE_BLOCKS``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 16.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the maximum blocks per write
request.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/bdbuf-read-ahead-task-priority
.. raw:: latex
\clearpage
.. index:: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
.. _CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY:
CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
----------------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 15.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the read-ahead task priority.
.. rubric:: CONSTRAINTS:
The value of the configuration option shall be a valid Classic API task
priority. The set of valid task priorities depends on the scheduler
configuration.
.. Generated from spec:/acfg/if/bdbuf-task-stack-size
.. raw:: latex
\clearpage
.. index:: CONFIGURE_BDBUF_TASK_STACK_SIZE
.. _CONFIGURE_BDBUF_TASK_STACK_SIZE:
CONFIGURE_BDBUF_TASK_STACK_SIZE
-------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_BDBUF_TASK_STACK_SIZE``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is :c:macro:`RTEMS_MINIMUM_STACK_SIZE`.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the task stack size of the
Block Device Cache tasks in bytes.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to
:ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
* The value of the configuration option shall be less than or equal to a
BSP-specific and application-specific value which depends on the size of the
memory available to the application.
* The value of the configuration option shall be small enough so that the task
stack space calculation carried out by ``<rtems/confdefs.h>`` does not
overflow an integer of type `uintptr_t
<https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/bdbuf-swapout-block-hold
.. raw:: latex
\clearpage
.. index:: CONFIGURE_SWAPOUT_BLOCK_HOLD
.. _CONFIGURE_SWAPOUT_BLOCK_HOLD:
CONFIGURE_SWAPOUT_BLOCK_HOLD
----------------------------
.. rubric:: CONSTANT:
``CONFIGURE_SWAPOUT_BLOCK_HOLD``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 1000.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the swapout task maximum block
hold time in milliseconds.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/bdbuf-swapout-swap-period
.. raw:: latex
\clearpage
.. index:: CONFIGURE_SWAPOUT_SWAP_PERIOD
.. _CONFIGURE_SWAPOUT_SWAP_PERIOD:
CONFIGURE_SWAPOUT_SWAP_PERIOD
-----------------------------
.. rubric:: CONSTANT:
``CONFIGURE_SWAPOUT_SWAP_PERIOD``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 250.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the swapout task swap period
in milliseconds.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/bdbuf-swapout-task-priority
.. raw:: latex
\clearpage
.. index:: CONFIGURE_SWAPOUT_TASK_PRIORITY
.. _CONFIGURE_SWAPOUT_TASK_PRIORITY:
CONFIGURE_SWAPOUT_TASK_PRIORITY
-------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_SWAPOUT_TASK_PRIORITY``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 15.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the swapout task priority.
.. rubric:: CONSTRAINTS:
The value of the configuration option shall be a valid Classic API task
priority. The set of valid task priorities depends on the scheduler
configuration.
.. Generated from spec:/acfg/if/bdbuf-swapout-worker-tasks
.. raw:: latex
\clearpage
.. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
.. _CONFIGURE_SWAPOUT_WORKER_TASKS:
CONFIGURE_SWAPOUT_WORKER_TASKS
------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_SWAPOUT_WORKER_TASKS``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 0.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the swapout worker task count.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/bdbuf-swapout-worker-taskp-riority
.. raw:: latex
\clearpage
.. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
.. _CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY:
CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
--------------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 15.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the swapout worker task
priority.
.. rubric:: CONSTRAINTS:
The value of the configuration option shall be a valid Classic API task
priority. The set of valid task priorities depends on the scheduler
configuration.
|
