[489740f] | 1 | .. comment SPDX-License-Identifier: CC-BY-SA-4.0 |
---|
| 2 | |
---|
[fa70fd2] | 3 | .. COMMENT: COPYRIGHT (c) 1988-2002. |
---|
| 4 | .. COMMENT: On-Line Applications Research Corporation (OAR). |
---|
| 5 | .. COMMENT: All rights reserved. |
---|
| 6 | |
---|
[1264a8f] | 7 | Memory Management Manager |
---|
| 8 | ######################### |
---|
| 9 | |
---|
| 10 | Introduction |
---|
| 11 | ============ |
---|
| 12 | |
---|
| 13 | The |
---|
| 14 | memory management manager is ... |
---|
| 15 | |
---|
| 16 | The directives provided by the memory management manager are: |
---|
| 17 | |
---|
[fa70fd2] | 18 | - mlockall_ - Lock the Address Space of a Process |
---|
[1264a8f] | 19 | |
---|
[fa70fd2] | 20 | - munlockall_ - Unlock the Address Space of a Process |
---|
[1264a8f] | 21 | |
---|
[fa70fd2] | 22 | - mlock_ - Lock a Range of the Process Address Space |
---|
[1264a8f] | 23 | |
---|
[fa70fd2] | 24 | - munlock_ - Unlock a Range of the Process Address Space |
---|
[1264a8f] | 25 | |
---|
[fa70fd2] | 26 | - mmap_ - Map Process Addresses to a Memory Object |
---|
[1264a8f] | 27 | |
---|
[fa70fd2] | 28 | - munmap_ - Unmap Previously Mapped Addresses |
---|
[1264a8f] | 29 | |
---|
[fa70fd2] | 30 | - mprotect_ - Change Memory Protection |
---|
[1264a8f] | 31 | |
---|
[fa70fd2] | 32 | - msync_ - Memory Object Synchronization |
---|
[1264a8f] | 33 | |
---|
[fa70fd2] | 34 | - shm_open_ - Open a Shared Memory Object |
---|
[1264a8f] | 35 | |
---|
[fa70fd2] | 36 | - shm_unlink_ - Remove a Shared Memory Object |
---|
[1264a8f] | 37 | |
---|
| 38 | Background |
---|
| 39 | ========== |
---|
| 40 | |
---|
| 41 | There is currently no text in this section. |
---|
| 42 | |
---|
| 43 | Operations |
---|
| 44 | ========== |
---|
| 45 | |
---|
| 46 | There is currently no text in this section. |
---|
| 47 | |
---|
| 48 | Directives |
---|
| 49 | ========== |
---|
| 50 | |
---|
[fa70fd2] | 51 | This section details the memory management manager's directives. A subsection |
---|
| 52 | is dedicated to each of this manager's directives and describes the calling |
---|
| 53 | sequence, related constants, usage, and status codes. |
---|
| 54 | |
---|
| 55 | .. _mlockall: |
---|
[1264a8f] | 56 | |
---|
| 57 | mlockall - Lock the Address Space of a Process |
---|
| 58 | ---------------------------------------------- |
---|
| 59 | .. index:: mlockall |
---|
| 60 | .. index:: lock the address space of a process |
---|
| 61 | |
---|
| 62 | **CALLING SEQUENCE:** |
---|
| 63 | |
---|
[fa70fd2] | 64 | .. code-block:: c |
---|
[1264a8f] | 65 | |
---|
| 66 | int mlockall( |
---|
| 67 | ); |
---|
| 68 | |
---|
| 69 | **STATUS CODES:** |
---|
| 70 | |
---|
[fa70fd2] | 71 | .. list-table:: |
---|
| 72 | :class: rtems-table |
---|
| 73 | |
---|
| 74 | * - ``E`` |
---|
| 75 | - The |
---|
[1264a8f] | 76 | |
---|
| 77 | **DESCRIPTION:** |
---|
| 78 | |
---|
| 79 | **NOTES:** |
---|
| 80 | |
---|
[fa70fd2] | 81 | .. _munlockall: |
---|
| 82 | |
---|
[1264a8f] | 83 | munlockall - Unlock the Address Space of a Process |
---|
| 84 | -------------------------------------------------- |
---|
| 85 | .. index:: munlockall |
---|
| 86 | .. index:: unlock the address space of a process |
---|
| 87 | |
---|
| 88 | **CALLING SEQUENCE:** |
---|
| 89 | |
---|
[fa70fd2] | 90 | .. code-block:: c |
---|
[1264a8f] | 91 | |
---|
| 92 | int munlockall( |
---|
| 93 | ); |
---|
| 94 | |
---|
| 95 | **STATUS CODES:** |
---|
| 96 | |
---|
[fa70fd2] | 97 | .. list-table:: |
---|
| 98 | :class: rtems-table |
---|
| 99 | |
---|
| 100 | * - ``E`` |
---|
| 101 | - The |
---|
[1264a8f] | 102 | |
---|
| 103 | **DESCRIPTION:** |
---|
| 104 | |
---|
| 105 | **NOTES:** |
---|
| 106 | |
---|
[fa70fd2] | 107 | .. _mlock: |
---|
| 108 | |
---|
[1264a8f] | 109 | mlock - Lock a Range of the Process Address Space |
---|
| 110 | ------------------------------------------------- |
---|
| 111 | .. index:: mlock |
---|
| 112 | .. index:: lock a range of the process address space |
---|
| 113 | |
---|
| 114 | **CALLING SEQUENCE:** |
---|
| 115 | |
---|
[fa70fd2] | 116 | .. code-block:: c |
---|
[1264a8f] | 117 | |
---|
| 118 | int mlock( |
---|
| 119 | ); |
---|
| 120 | |
---|
| 121 | **STATUS CODES:** |
---|
| 122 | |
---|
[fa70fd2] | 123 | .. list-table:: |
---|
| 124 | :class: rtems-table |
---|
| 125 | |
---|
| 126 | * - ``E`` |
---|
| 127 | - The |
---|
[1264a8f] | 128 | |
---|
| 129 | **DESCRIPTION:** |
---|
| 130 | |
---|
| 131 | **NOTES:** |
---|
| 132 | |
---|
[fa70fd2] | 133 | .. _munlock: |
---|
| 134 | |
---|
[1264a8f] | 135 | munlock - Unlock a Range of the Process Address Space |
---|
| 136 | ----------------------------------------------------- |
---|
| 137 | .. index:: munlock |
---|
| 138 | .. index:: unlock a range of the process address space |
---|
| 139 | |
---|
| 140 | **CALLING SEQUENCE:** |
---|
| 141 | |
---|
[fa70fd2] | 142 | .. code-block:: c |
---|
[1264a8f] | 143 | |
---|
| 144 | int munlock( |
---|
| 145 | ); |
---|
| 146 | |
---|
| 147 | **STATUS CODES:** |
---|
| 148 | |
---|
[fa70fd2] | 149 | .. list-table:: |
---|
| 150 | :class: rtems-table |
---|
| 151 | |
---|
| 152 | * - ``E`` |
---|
| 153 | - The |
---|
[1264a8f] | 154 | |
---|
| 155 | **DESCRIPTION:** |
---|
| 156 | |
---|
| 157 | **NOTES:** |
---|
| 158 | |
---|
[fa70fd2] | 159 | .. _mmap: |
---|
| 160 | |
---|
[1264a8f] | 161 | mmap - Map Process Addresses to a Memory Object |
---|
| 162 | ----------------------------------------------- |
---|
| 163 | .. index:: mmap |
---|
| 164 | .. index:: map process addresses to a memory object |
---|
| 165 | |
---|
| 166 | **CALLING SEQUENCE:** |
---|
| 167 | |
---|
[fa70fd2] | 168 | .. code-block:: c |
---|
[1264a8f] | 169 | |
---|
| 170 | int mmap( |
---|
| 171 | ); |
---|
| 172 | |
---|
| 173 | **STATUS CODES:** |
---|
| 174 | |
---|
[fa70fd2] | 175 | .. list-table:: |
---|
| 176 | :class: rtems-table |
---|
| 177 | |
---|
| 178 | * - ``E`` |
---|
| 179 | - The |
---|
[1264a8f] | 180 | |
---|
| 181 | **DESCRIPTION:** |
---|
| 182 | |
---|
| 183 | **NOTES:** |
---|
| 184 | |
---|
[fa70fd2] | 185 | .. _munmap: |
---|
| 186 | |
---|
[1264a8f] | 187 | munmap - Unmap Previously Mapped Addresses |
---|
| 188 | ------------------------------------------ |
---|
| 189 | .. index:: munmap |
---|
| 190 | .. index:: unmap previously mapped addresses |
---|
| 191 | |
---|
| 192 | **CALLING SEQUENCE:** |
---|
| 193 | |
---|
[fa70fd2] | 194 | .. code-block:: c |
---|
[1264a8f] | 195 | |
---|
| 196 | int munmap( |
---|
| 197 | ); |
---|
| 198 | |
---|
| 199 | **STATUS CODES:** |
---|
| 200 | |
---|
[fa70fd2] | 201 | .. list-table:: |
---|
| 202 | :class: rtems-table |
---|
| 203 | |
---|
| 204 | * - ``E`` |
---|
| 205 | - The |
---|
[1264a8f] | 206 | |
---|
| 207 | **DESCRIPTION:** |
---|
| 208 | |
---|
| 209 | **NOTES:** |
---|
| 210 | |
---|
[fa70fd2] | 211 | .. _mprotect: |
---|
| 212 | |
---|
[1264a8f] | 213 | mprotect - Change Memory Protection |
---|
| 214 | ----------------------------------- |
---|
| 215 | .. index:: mprotect |
---|
| 216 | .. index:: change memory protection |
---|
| 217 | |
---|
| 218 | **CALLING SEQUENCE:** |
---|
| 219 | |
---|
[fa70fd2] | 220 | .. code-block:: c |
---|
[1264a8f] | 221 | |
---|
| 222 | int mprotect( |
---|
| 223 | ); |
---|
| 224 | |
---|
| 225 | **STATUS CODES:** |
---|
| 226 | |
---|
[fa70fd2] | 227 | .. list-table:: |
---|
| 228 | :class: rtems-table |
---|
| 229 | |
---|
| 230 | * - ``E`` |
---|
| 231 | - The |
---|
[1264a8f] | 232 | |
---|
| 233 | **DESCRIPTION:** |
---|
| 234 | |
---|
| 235 | **NOTES:** |
---|
| 236 | |
---|
[fa70fd2] | 237 | .. _msync: |
---|
| 238 | |
---|
[1264a8f] | 239 | msync - Memory Object Synchronization |
---|
| 240 | ------------------------------------- |
---|
| 241 | .. index:: msync |
---|
| 242 | .. index:: memory object synchronization |
---|
| 243 | |
---|
| 244 | **CALLING SEQUENCE:** |
---|
| 245 | |
---|
[fa70fd2] | 246 | .. code-block:: c |
---|
[1264a8f] | 247 | |
---|
| 248 | int msync( |
---|
| 249 | ); |
---|
| 250 | |
---|
| 251 | **STATUS CODES:** |
---|
| 252 | |
---|
[fa70fd2] | 253 | .. list-table:: |
---|
| 254 | :class: rtems-table |
---|
| 255 | |
---|
| 256 | * - ``E`` |
---|
| 257 | - The |
---|
[1264a8f] | 258 | |
---|
| 259 | **DESCRIPTION:** |
---|
| 260 | |
---|
| 261 | **NOTES:** |
---|
| 262 | |
---|
[fa70fd2] | 263 | .. _shm_open: |
---|
| 264 | |
---|
[1264a8f] | 265 | shm_open - Open a Shared Memory Object |
---|
| 266 | -------------------------------------- |
---|
| 267 | .. index:: shm_open |
---|
| 268 | .. index:: open a shared memory object |
---|
| 269 | |
---|
| 270 | **CALLING SEQUENCE:** |
---|
| 271 | |
---|
[fa70fd2] | 272 | .. code-block:: c |
---|
[1264a8f] | 273 | |
---|
| 274 | int shm_open( |
---|
| 275 | ); |
---|
| 276 | |
---|
| 277 | **STATUS CODES:** |
---|
| 278 | |
---|
[fa70fd2] | 279 | .. list-table:: |
---|
| 280 | :class: rtems-table |
---|
| 281 | |
---|
| 282 | * - ``E`` |
---|
| 283 | - The |
---|
[1264a8f] | 284 | |
---|
| 285 | **DESCRIPTION:** |
---|
| 286 | |
---|
| 287 | **NOTES:** |
---|
| 288 | |
---|
[fa70fd2] | 289 | .. _shm_unlink: |
---|
| 290 | |
---|
[1264a8f] | 291 | shm_unlink - Remove a Shared Memory Object |
---|
| 292 | ------------------------------------------ |
---|
| 293 | .. index:: shm_unlink |
---|
| 294 | .. index:: remove a shared memory object |
---|
| 295 | |
---|
| 296 | **CALLING SEQUENCE:** |
---|
| 297 | |
---|
[fa70fd2] | 298 | .. code-block:: c |
---|
[1264a8f] | 299 | |
---|
| 300 | int shm_unlink( |
---|
| 301 | ); |
---|
| 302 | |
---|
| 303 | **STATUS CODES:** |
---|
| 304 | |
---|
[fa70fd2] | 305 | .. list-table:: |
---|
| 306 | :class: rtems-table |
---|
| 307 | |
---|
| 308 | * - ``E`` |
---|
| 309 | - The |
---|
[1264a8f] | 310 | |
---|
| 311 | **DESCRIPTION:** |
---|
| 312 | |
---|
| 313 | **NOTES:** |
---|