summaryrefslogtreecommitdiffstats
path: root/spec/rtems/support/if/workspace-greedy-allocate-all-except-largest.yml
blob: 80a5d1b2a23bc878c15db92a5892d0d502427a30 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Greedy allocates all blocks of the RTEMS Workspace except the largest free
  block.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${/c/if/uintptr_t:/name} *${.:/params[0]/name}
    return: void *
  variants: []
description: |
  Afterwards the heap has at most one allocatable block.  This block is the
  largest free block if it exists.  The allocatable size of this block is
  stored in ${.:/params[0]/name}.  All other blocks are used.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-devinit
- role: constraint
  uid: /constraint/directive-ctx-task
- role: constraint
  uid: /constraint/object-allocator
name: rtems_workspace_greedy_allocate_all_except_largest
notes: |
  This directive is intended to be used by tests of the RTEMS test suites.
params:
- description: |
    is the remaining allocatable size.
  dir: null
  name: allocatable_size
return:
  return: |
    The returned pointer value may be used to free the greedy allocation by
    calling ${workspace-greedy-free:/name}.
  return-values: []
type: interface