spec/acfg/if/init-task-construct-storage-size.yml


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

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
appl-config-option-type: integer
copyrights:
- Copyright (C) 2020 embedded brains GmbH & Co. KG
default-value: |
  This configuration option has no default value.  If it is not specified, then
  the Classic API initialization task will be created with the stack size
  defined by the ${init-task-stack-size:/name} configuration option.
description: |
  The value of this configuration option defines the task storage size of the
  Classic API initialization task.
enabled-by: true
index-entries: []
interface-type: appl-config-option
links:
- role: interface-placement
  uid: domain
- role: interface-ingroup
  uid: group-classicinit
- role: constraint
  uid: ../constraint/min-task-stack-size
- role: constraint
  uid: ../constraint/use-task-storage-size
name: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
notes: |
  If this configuration option is specified, then

  * a task storage area of the specified size is statically allocated by
    ${header-confdefs:/path} for the Classic API initialization task,

  * the Classic API initialization task is constructed by
    ${/rtems/task/if/construct:/name} instead of using
    ${/rtems/task/if/create:/name},

  * the maximum thread-local storage size defined by
    ${max-thread-local-storage-size:/name} is used for the Classic API
    initialization task,

  * the Classic API initialization task should be accounted for in
    ${min-tasks-with-user-provided-storage:/name}, and

  * the task storage area used for the Classic API initialization task is not
    reclaimed by the system if the task is deleted.

  The

  * ${init-task-stack-size:/name} and

  * ``CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE``

  configuration options are mutually exclusive.
type: interface