gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-22 16:33:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Some documentation of memory management functions.

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@15435 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2002-12-31 19:31:46 +00:00
parent d6ed3ea87e
commit 8822be632d
3 changed files with 43 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
ChangeLog
View file

@ -1,3 +1,7 @@
2002-12-31 Richard Frith-Macdonald <rfm@gnu.org>
* Source/NSPage.m: Document all functions.
2002-12-31 Kelvin <kelvin@xbar.org>
* Source/NSPage.m (NSRealMemoryAvailable): Add support for MINGW

9
Headers/gnustep/base/NSZone.h
View file

@ -1,4 +1,4 @@
/* Zone memory management. -*- Mode: ObjC -*-
/** Zone memory management. -*- Mode: ObjC -*-
Copyright (C) 1997,1998,1999 Free Software Foundation, Inc.
Written by: Yoo C. Chung <wacko@laplace.snu.ac.kr>
@ -18,7 +18,12 @@
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
AutogsdocSource: NSZone.m
AutogsdocSource: NSPage.m
*/
#ifndef __NSZone_h_GNUSTEP_BASE_INCLUDE
#define __NSZone_h_GNUSTEP_BASE_INCLUDE

55
Source/NSPage.m
View file

@ -77,7 +77,9 @@ getpagesize(void)
getpagesize() system call repeatedly. */
static unsigned ns_page_size = 0;
/* Return the number of bytes in a memory page. */
/**
* Return the number of bytes in a memory page.
*/
unsigned
NSPageSize (void)
{
@ -86,7 +88,9 @@ NSPageSize (void)
return ns_page_size;
}
/* Return log base 2 of the number of bytes in a memory page. */
/**
* Return log base 2 of the number of bytes in a memory page.
*/
unsigned
NSLogPageSize (void)
{
@ -98,8 +102,10 @@ NSLogPageSize (void)
return log;
}
/* Round BYTES down to the nearest multiple of the memory page size,
and return it. */
/**
* Round bytes down to the nearest multiple of the memory page size,
* and return it.
*/
unsigned
NSRoundDownToMultipleOfPageSize (unsigned bytes)
{
@ -108,8 +114,10 @@ NSRoundDownToMultipleOfPageSize (unsigned bytes)
return (bytes / a) * a;
}
/* Round BYTES up to the nearest multiple of the memory page size,
and return it. */
/**
* Round bytes up to the nearest multiple of the memory page size,
* and return it.
*/
unsigned
NSRoundUpToMultipleOfPageSize (unsigned bytes)
{
@ -122,6 +130,9 @@ NSRoundUpToMultipleOfPageSize (unsigned bytes)
#include <sys/sysinfo.h>
#endif
/**
* Return the number of bytes of real (physical) memory available.
*/
unsigned
NSRealMemoryAvailable ()
{
@ -148,6 +159,10 @@ NSRealMemoryAvailable ()
#endif
}
/**
* Allocate memory for this process and return a pointer to it (or a nul
* pointer on failure).
*/
void *
NSAllocateMemoryPages (unsigned bytes)
{
@ -171,6 +186,10 @@ NSAllocateMemoryPages (unsigned bytes)
#endif
}
/**
* Deallocate memory which was previously allocated using the
* NSAllocateMemoryPages() function.
*/
void
NSDeallocateMemoryPages (void *ptr, unsigned bytes)
{
@ -181,29 +200,19 @@ NSDeallocateMemoryPages (void *ptr, unsigned bytes)
#endif
}
/**
* Perform an efficient large scale copy of data from src to dest.
* The value bytes specifies the length of the data copied.
*/
void
NSCopyMemoryPages (const void *source, void *dest, unsigned bytes)
NSCopyMemoryPages (const void *src, void *dest, unsigned bytes)
{
#if __mach__
kern_return_t r;
r = vm_copy (mach_task_self(), source, bytes, dest);
r = vm_copy (mach_task_self(), src, bytes, dest);
NSParameterAssert (r == KERN_SUCCESS);
#else
memcpy (dest, source, bytes);
memcpy (dest, src, bytes);
#endif
}