source: rtems-docs/posix-users/memory_managment.rst @ 72a62ad

4.115am
Last change on this file since 72a62ad was 72a62ad, checked in by Chris Johns <chrisj@…>, on 11/03/16 at 05:58:08

Rename all manuals with an _ to have a -. It helps released naming of files.

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