Penguin

Differences between current version and predecessor to the previous major change of mremap(2).

Other diffs: Previous Revision, Previous Author, or view the Annotated Edit History

Newer page: version 2 Last edited on Saturday, March 15, 2003 1:07:49 am by PerryLorier
Older page: version 1 Last edited on Tuesday, June 4, 2002 12:23:43 am by perry Revert
@@ -1,130 +1,43 @@
-MREMAP  
-!!!MREMAP  
-NAME  
-SYNOPSIS  
-DESCRIPTION  
-FLAGS  
-RETURN VALUE  
-ERRORS  
-CONFORMING TO  
-SEE ALSO  
-----  
 !!NAME 
-  
-  
 mremap - re-map a virtual memory address 
 !!SYNOPSIS 
  
+ __#include <unistd.h>__  
+ __#include <sys/mman.h>__  
  
-__#include __  
-#include __  
-  
-  
- __void * mremap(void *__ ''old_address''__,  
- size_t__ ''old_size'' __, size_t__  
- ''new_size''__, unsigned long__  
- ''flags''__);__ 
+ __void * mremap(void *__ ''old_address''__, size_t__ ''old_size'' __, size_t__ ''new_size''__, unsigned long__ ''flags''__);__ 
 !!DESCRIPTION 
-  
-  
- __mremap__ expands (or shrinks) an existing memory  
- mapping, potentially moving it at the same time (controlled  
- by the ''flags'' argument and the available virtual 
+__mremap__ expands (or shrinks) an existing memory mapping, potentially moving it at the same time (controlled by the ''flags'' argument and the available virtual 
 address space). 
  
-  
- ''old_address'' is the old address of the virtual memory  
- block that you want to expand (or shrink). Note that  
- ''old_address'' has to be page aligned. ''old_size''  
-is the old size of the virtual memory block. ''new_size''  
- is the requested size of the virtual memory block after the 
+''old_address'' is the old address of the virtual memory block that you want to expand (or shrink). Note that ''old_address'' has to be page aligned. ''old_size''  
+is the old size of the virtual memory block. ''new_size'' is the requested size of the virtual memory block after the 
 resize. 
-  
  
 The ''flags'' argument is a bitmap of flags. 
  
-  
- In Linux the memory is divided into pages. A user process  
- has (one or) several linear virtual memory segments. Each  
- virtual memory segment has one or more mappings to real  
- memory pages (in the page table). Each virtual memory  
- segment has its own protection (access rights), which may  
- cause a segmentation violation if the memory is accessed  
- incorrectly (e.g., writing to a read-only segment).  
- Accessing virtual memory outside of the segments will also 
+In Linux the memory is divided into pages. A user process has (one or) several linear virtual memory segments. Each virtual memory segment has one or more mappings to real memory pages (in the page table). Each virtual memory segment has its own protection (access rights), which may cause a segmentation violation if the memory is accessed incorrectly (e.g., writing to a read-only segment). Accessing virtual memory outside of the segments will also 
 cause a segmentation violation. 
  
+__mremap__ uses the Linux page table scheme. __mremap__ changes the mapping between virtual addresses and memory pages. This can be used to implement a very  
+efficient __realloc__.  
  
-__mremap__ uses the Linux page table scheme.  
-__mremap__ changes the mapping between virtual addresses  
-and memory pages. This can be used to implement a very  
-efficient __realloc__.  
 !!FLAGS 
-  
-  
- __MREMAP_MAYMOVE__  
-  
-  
- indicates if the operation should fail, or change the  
- virtual address if the resize cannot be done at the current  
- virtual address. 
+; __MREMAP_MAYMOVE__: indicates if the operation should fail, or change the virtual address if the resize cannot be done at the current virtual address. 
 !!RETURN VALUE 
-  
-  
- On success __mremap__ returns a pointer to the new  
- virtual memory area. On error, -1 is returned, and  
- ''errno'' is set appropriately. 
+On success __mremap__ returns a pointer to the new virtual memory area. On error, -1 is returned, and ''errno'' is set appropriately. 
 !!ERRORS 
+;[EINVAL]: An invalid argument was given. Most likely ''old_address'' was not page aligned.  
+;[EFAULT]: old_address'' to ''old_address''+''old_size'' is an invalid virtual memory address for this process. You can also get EFAULT even if there exist mappings that cover the whole address space requested, but those mappings are of different types.  
+;[EAGAIN]: The memory segment is locked and cannot be re-mapped.  
+;[ENOMEM]: The memory area cannot be expanded at the current virtual address, and the ''MREMAP_MAYMOVE'' flag is not set in ''flags''. Or, there is not enough (virtual) memory available.  
  
-  
-__EINVAL__  
-  
-  
-An invalid argument was given. Most likely  
-''old_address'' was not page aligned.  
-  
-  
-__EFAULT__  
-  
-  
-old_address'' to ''old_address''+''old_size'' is  
-an invalid virtual memory address for this process. You can  
-also get EFAULT even if there exist mappings that cover the  
-whole address space requested, but those mappings are of  
-different types.  
-  
-  
-__EAGAIN__  
-  
-  
-The memory segment is locked and cannot be  
-re-mapped.  
-  
-  
-__ENOMEM__  
-  
-  
-The memory area cannot be expanded at the current virtual  
-address, and the ''MREMAP_MAYMOVE'' flag is not set in  
-''flags''. Or, there is not enough (virtual) memory  
-available.  
 !!CONFORMING TO 
+This call is Linux-specific, and should not be used in programs intended to be portable. 4.2BSD had a (never actually implemented) mremap(2) call with completely  
+different semantics.  
  
-  
-This call is Linux-specific, and should not be used in  
-programs intended to be portable. 4.2BSD had a (never  
-actually implemented) mremap(2) call with completely  
-different semantics.  
 !!SEE ALSO 
+getpagesize(2), realloc(3), malloc(3), brk(2), sbrk(2), mmap(2)  
  
-  
-getpagesize(2), realloc(3), malloc(3),  
-brk(2), sbrk(2), mmap(2)  
-  
-  
- Your favorite OS text book for more information on paged  
- memory. (''Modern Operating Systems'' by Andrew S.  
- Tannenbaum, ''Inside Linux'' by Randolf Bentson, ''The  
-Design of the UNIX Operating System'' by Maurice J.  
- Bach.)  
-----  
+Your favorite OS text book for more information on paged memory. (''Modern Operating Systems'' by Andrew S. Tannenbaum, ''Inside Linux'' by Randolf Bentson, ''The  
+Design of the UNIX Operating System'' by Maurice J. Bach.) 
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.