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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
Filesystem Configuration
========================
This section describes configuration options related to filesytems.
By default, the In-Memory Filesystem (IMFS) is used as the base filesystem (also
known as root filesystem). In order to save some memory for your application,
you can disable the filesystem support with the
:ref:`CONFIGURE_APPLICATION_DISABLE_FILESYSTEM` configuration option.
Alternatively, you can strip down the features of the base filesystem with the
:ref:`CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM` and
:ref:`CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM` configuration options. These
three configuration options are mutually exclusive. They are intended for an
advanced application configuration.
Features of the IMFS can be disabled and enabled with the following
configuration options:
* :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`
* :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`
* :ref:`CONFIGURE_IMFS_DISABLE_LINK`
* :ref:`CONFIGURE_IMFS_DISABLE_MKNOD`
* :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`
* :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`
* :ref:`CONFIGURE_IMFS_DISABLE_READDIR`
* :ref:`CONFIGURE_IMFS_DISABLE_READLINK`
* :ref:`CONFIGURE_IMFS_DISABLE_RENAME`
* :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`
* :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`
* :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`
* :ref:`CONFIGURE_IMFS_DISABLE_UTIME`
* :ref:`CONFIGURE_IMFS_ENABLE_MKFIFO`
.. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
.. _CONFIGURE_APPLICATION_DISABLE_FILESYSTEM:
CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
----------------------------------------
CONSTANT:
``CONFIGURE_APPLICATION_DISABLE_FILESYSTEM``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then a base filesystem and the
configured filesystems are initialized during system initialization.
DESCRIPTION:
In case this configuration option is defined, then **no** base filesystem is
initialized during system initialization and **no** filesystems are
configured.
NOTES:
Filesystems must be initialized to support file descriptor based device
drivers and basic input/output functions such as :c:func:`printf`.
Filesystems can be disabled to reduce the memory footprint of an application.
.. index:: CONFIGURE_IMFS_DISABLE_CHMOD
.. _CONFIGURE_IMFS_DISABLE_CHMOD:
CONFIGURE_IMFS_DISABLE_CHMOD
----------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_CHMOD``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
changing the mode of files.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support changing the mode of files (no support for :c:func:`chmod`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_CHOWN
.. _CONFIGURE_IMFS_DISABLE_CHOWN:
CONFIGURE_IMFS_DISABLE_CHOWN
----------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_CHOWN``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
changing the ownership of files.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support changing the ownership of files (no support for :c:func:`chown`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_LINK
.. _CONFIGURE_IMFS_DISABLE_LINK:
CONFIGURE_IMFS_DISABLE_LINK
---------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_LINK``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports hard
links.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support hard links (no support for :c:func:`link`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD
.. _CONFIGURE_IMFS_DISABLE_MKNOD:
CONFIGURE_IMFS_DISABLE_MKNOD
----------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_MKNOD``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports making
files.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support making files (no support for :c:func:`mknod`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
.. _CONFIGURE_IMFS_DISABLE_MKNOD_FILE:
CONFIGURE_IMFS_DISABLE_MKNOD_FILE
---------------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_MKNOD_FILE``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports making
regular files.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support making regular files.
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_MOUNT
.. _CONFIGURE_IMFS_DISABLE_MOUNT:
CONFIGURE_IMFS_DISABLE_MOUNT
----------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_MOUNT``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
mounting other filesystems.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support mounting other filesystems (no support for :c:func:`mount`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_READDIR
.. _CONFIGURE_IMFS_DISABLE_READDIR:
CONFIGURE_IMFS_DISABLE_READDIR
------------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_READDIR``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
reading directories.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support reading directories (no support for :c:func:`readdir`). It is still
possible to open files in a directory.
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_READLINK
.. _CONFIGURE_IMFS_DISABLE_READLINK:
CONFIGURE_IMFS_DISABLE_READLINK
-------------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_READLINK``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
reading symbolic links.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support reading symbolic links (no support for :c:func:`readlink`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_RENAME
.. _CONFIGURE_IMFS_DISABLE_RENAME:
CONFIGURE_IMFS_DISABLE_RENAME
-----------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_RENAME``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
renaming files.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support renaming files (no support for :c:func:`rename`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_RMNOD
.. _CONFIGURE_IMFS_DISABLE_RMNOD:
CONFIGURE_IMFS_DISABLE_RMNOD
----------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_RMNOD``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
removing files.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support removing files (no support for :c:func:`rmnod`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
.. _CONFIGURE_IMFS_DISABLE_SYMLINK:
CONFIGURE_IMFS_DISABLE_SYMLINK
------------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_SYMLINK``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
creating symbolic links.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support creating symbolic links (no support for :c:func:`symlink`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
.. _CONFIGURE_IMFS_DISABLE_UNMOUNT:
CONFIGURE_IMFS_DISABLE_UNMOUNT
------------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_UNMOUNT``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
unmounting other filesystems.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support unmounting other filesystems (no support for :c:func:`unmount`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_DISABLE_UTIME
.. _CONFIGURE_IMFS_DISABLE_UTIME:
CONFIGURE_IMFS_DISABLE_UTIME
----------------------------
CONSTANT:
``CONFIGURE_IMFS_DISABLE_UTIME``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS supports
changing file times.
DESCRIPTION:
In case this configuration option is defined, then the root IMFS does not
support changing file times (no support for :c:func:`utime`).
NOTES:
None.
.. index:: CONFIGURE_IMFS_ENABLE_MKFIFO
.. _CONFIGURE_IMFS_ENABLE_MKFIFO:
CONFIGURE_IMFS_ENABLE_MKFIFO
----------------------------
CONSTANT:
``CONFIGURE_IMFS_ENABLE_MKFIFO``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the root IMFS does not
support making FIFOs (no support for :c:func:`mkfifo`).
DESCRIPTION:
In case this configuration option is defined, then the root IMFS supports
making FIFOs.
NOTES:
None.
.. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
.. _CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK:
CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
--------------------------------------
CONSTANT:
``CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK``
DATA TYPE:
Boolean feature macro.
RANGE:
Valid values for this configuration parameter are a power of two (2)
between 16 and 512 inclusive. In other words, valid values are 16, 32, 64,
128, 256,and 512.
DEFAULT VALUE:
The default IMFS block size is 128 bytes.
DESCRIPTION:
This configuration parameter specifies the block size for in-memory files
managed by the IMFS. The configured block size has two impacts. The first
is the average amount of unused memory in the last block of each file. For
example, when the block size is 512, on average one-half of the last block
of each file will remain unused and the memory is wasted. In contrast, when
the block size is 16, the average unused memory per file is only 8
bytes. However, it requires more allocations for the same size file and
thus more overhead per block for the dynamic memory management.
Second, the block size has an impact on the maximum size file that can be
stored in the IMFS. With smaller block size, the maximum file size is
correspondingly smaller. The following shows the maximum file size possible
based on the configured block size:
- when the block size is 16 bytes, the maximum file size is 1,328 bytes.
- when the block size is 32 bytes, the maximum file size is 18,656 bytes.
- when the block size is 64 bytes, the maximum file size is 279,488 bytes.
- when the block size is 128 bytes, the maximum file size is 4,329,344 bytes.
- when the block size is 256 bytes, the maximum file size is 68,173,568 bytes.
- when the block size is 512 bytes, the maximum file size is 1,082,195,456
bytes.
NOTES:
None.
.. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
.. _CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM:
CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
--------------------------------------
CONSTANT:
``CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the described feature is not
enabled.
DESCRIPTION:
In case this configuration option is defined, then an IMFS with a reduced
feature set will be the base filesystem (also known as root filesystem).
NOTES:
In case this configuration option is defined, then the following
configuration options will be defined as well
- :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
- :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
- :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
- :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`,
- :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`,
- :ref:`CONFIGURE_IMFS_DISABLE_READDIR`,
- :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
- :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
- :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`,
- :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
- :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
- :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
In addition, a simplified path evaluation is enabled. It allows only a look
up of absolute paths.
This configuration of the IMFS is basically a device-only filesystem. It is
comparable in functionality to the pseudo-filesystem name space provided
before RTEMS release 4.5.0.
.. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
.. _CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM:
CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
-----------------------------------------
CONSTANT:
``CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM``
OPTION TYPE:
This configuration option is a boolean feature define.
DEFAULT CONFIGURATION:
If this configuration option is undefined, then the described feature is not
enabled.
DESCRIPTION:
In case this configuration option is defined, then an IMFS with a reduced
feature set will be the base filesystem (also known as root filesystem).
NOTES:
In case this configuration option is defined, then the following
configuration options will be defined as well
- :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
- :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
- :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
- :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
- :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
- :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
- :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
- :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
|
