source: rtems-docs/posix_users/memory_managment.rst @ fa70fd2

4.115
Last change on this file since fa70fd2 was fa70fd2, checked in by Chris Johns <chrisj@…>, on 02/26/16 at 07:22:07

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