From fa70fd20878e402610c263f129266593d31a0376 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Fri, 26 Feb 2016 18:22:07 +1100 Subject: POSIX User clean up. --- posix_users/memory_managment.rst | 148 +++++++++++++++++++++++++-------------- 1 file changed, 97 insertions(+), 51 deletions(-) (limited to 'posix_users/memory_managment.rst') diff --git a/posix_users/memory_managment.rst b/posix_users/memory_managment.rst index 1095b39..38e8542 100644 --- a/posix_users/memory_managment.rst +++ b/posix_users/memory_managment.rst @@ -1,3 +1,7 @@ +.. COMMENT: COPYRIGHT (c) 1988-2002. +.. COMMENT: On-Line Applications Research Corporation (OAR). +.. COMMENT: All rights reserved. + Memory Management Manager ######################### @@ -9,25 +13,25 @@ memory management manager is ... The directives provided by the memory management manager are: -- ``mlockall`` - Lock the Address Space of a Process +- mlockall_ - Lock the Address Space of a Process -- ``munlockall`` - Unlock the Address Space of a Process +- munlockall_ - Unlock the Address Space of a Process -- ``mlock`` - Lock a Range of the Process Address Space +- mlock_ - Lock a Range of the Process Address Space -- ``munlock`` - Unlock a Range of the Process Address Space +- munlock_ - Unlock a Range of the Process Address Space -- ``mmap`` - Map Process Addresses to a Memory Object +- mmap_ - Map Process Addresses to a Memory Object -- ``munmap`` - Unmap Previously Mapped Addresses +- munmap_ - Unmap Previously Mapped Addresses -- ``mprotect`` - Change Memory Protection +- mprotect_ - Change Memory Protection -- ``msync`` - Memory Object Synchronization +- msync_ - Memory Object Synchronization -- ``shm_open`` - Open a Shared Memory Object +- shm_open_ - Open a Shared Memory Object -- ``shm_unlink`` - Remove a Shared Memory Object +- shm_unlink_ - Remove a Shared Memory Object Background ========== @@ -42,10 +46,11 @@ There is currently no text in this section. Directives ========== -This section details the memory management manager's directives. -A subsection is dedicated to each of this manager's directives -and describes the calling sequence, related constants, usage, -and status codes. +This section details the memory management manager's directives. A subsection +is dedicated to each of this manager's directives and describes the calling +sequence, related constants, usage, and status codes. + +.. _mlockall: mlockall - Lock the Address Space of a Process ---------------------------------------------- @@ -54,20 +59,25 @@ mlockall - Lock the Address Space of a Process **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int mlockall( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _munlockall: + munlockall - Unlock the Address Space of a Process -------------------------------------------------- .. index:: munlockall @@ -75,20 +85,25 @@ munlockall - Unlock the Address Space of a Process **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int munlockall( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _mlock: + mlock - Lock a Range of the Process Address Space ------------------------------------------------- .. index:: mlock @@ -96,20 +111,25 @@ mlock - Lock a Range of the Process Address Space **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int mlock( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _munlock: + munlock - Unlock a Range of the Process Address Space ----------------------------------------------------- .. index:: munlock @@ -117,20 +137,25 @@ munlock - Unlock a Range of the Process Address Space **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int munlock( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _mmap: + mmap - Map Process Addresses to a Memory Object ----------------------------------------------- .. index:: mmap @@ -138,20 +163,25 @@ mmap - Map Process Addresses to a Memory Object **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int mmap( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _munmap: + munmap - Unmap Previously Mapped Addresses ------------------------------------------ .. index:: munmap @@ -159,20 +189,25 @@ munmap - Unmap Previously Mapped Addresses **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int munmap( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _mprotect: + mprotect - Change Memory Protection ----------------------------------- .. index:: mprotect @@ -180,20 +215,25 @@ mprotect - Change Memory Protection **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int mprotect( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _msync: + msync - Memory Object Synchronization ------------------------------------- .. index:: msync @@ -201,20 +241,25 @@ msync - Memory Object Synchronization **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int msync( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _shm_open: + shm_open - Open a Shared Memory Object -------------------------------------- .. index:: shm_open @@ -222,20 +267,25 @@ shm_open - Open a Shared Memory Object **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int shm_open( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _shm_unlink: + shm_unlink - Remove a Shared Memory Object ------------------------------------------ .. index:: shm_unlink @@ -243,23 +293,19 @@ shm_unlink - Remove a Shared Memory Object **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int shm_unlink( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** - -.. COMMENT: COPYRIGHT (c) 1988-2002. - -.. COMMENT: On-Line Applications Research Corporation (OAR). - -.. COMMENT: All rights reserved. - -- cgit v1.2.3