Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/include/GNUstep/Foundation/
Upload File :
Current File : //usr/include/GNUstep/Foundation/NSZone.h
/** Zone memory management. -*- Mode: ObjC -*-
Copyright (C) 1997,1998,1999 Free Software Foundation, Inc.
Written by: Yoo C. Chung <wacko@laplace.snu.ac.kr>
Date: January 1997
This file is part of the GNUstep Base Library.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02111 USA.
AutogsdocSource: NSZone.m
AutogsdocSource: NSPage.m
*/
#ifndef __NSZone_h_GNUSTEP_BASE_INCLUDE
#define __NSZone_h_GNUSTEP_BASE_INCLUDE
#import "GNUstepBase/GSVersionMacros.h"
/**
* Primary structure representing an <code>NSZone</code>. Technically it
* consists of a set of function pointers for zone upkeep functions plus some
* other things-
<example>
{
// Functions for zone.
void *(*malloc)(struct _NSZone *zone, size_t size);
void *(*realloc)(struct _NSZone *zone, void *ptr, size_t size);
void (*free)(struct _NSZone *zone, void *ptr);
void (*recycle)(struct _NSZone *zone);
BOOL (*check)(struct _NSZone *zone);
BOOL (*lookup)(struct _NSZone *zone, void *ptr);
// Zone statistics (not always maintained).
struct NSZoneStats (*stats)(struct _NSZone *zone);
size_t gran; // Zone granularity (passed in on initialization)
NSString *name; // Name of zone (default is 'nil')
NSZone *next; // Pointer used for internal management of multiple zones.
}</example>
*/
typedef struct _NSZone NSZone;
#import <Foundation/NSObjCRuntime.h>
@class NSString;
#if defined(__cplusplus)
extern "C" {
#endif
struct _NSZone
{
/* Functions for zone. */
void *(*malloc)(struct _NSZone *zone, size_t size);
void *(*realloc)(struct _NSZone *zone, void *ptr, size_t size);
void (*free)(struct _NSZone *zone, void *ptr);
void (*recycle)(struct _NSZone *zone);
BOOL (*check)(struct _NSZone *zone);
BOOL (*lookup)(struct _NSZone *zone, void *ptr);
struct NSZoneStats (*stats)(struct _NSZone *zone);
size_t gran; // Zone granularity
__unsafe_unretained NSString *name; // Name of zone (default is 'nil')
NSZone *next;
};
/**
* Creates a new zone of start bytes, which will grow and shrink by
* granularity bytes. If canFree is 0, memory in zone is allocated but
* never freed, meaning allocation will be very fast. The whole zone can
* still be freed with NSRecycleZone(), and you should still call NSZoneFree
* on memory in the zone that is no longer needed, since a count of allocated
* pointers is kept and must reach zero before freeing the zone.<br />
* If Garbage Collection is enabled, this function does nothing other than
* log a warning and return the same value as the NSDefaultMallocZone()
* function.
*/
GS_EXPORT NSZone*
NSCreateZone (NSUInteger start, NSUInteger gran, BOOL canFree);
/** Returns the default zone for memory allocation. Memory created in this
* zone is the same as memory allocates using the system malloc() function.
*/
GS_EXPORT NSZone*
NSDefaultMallocZone (void);
/**
* Searches and finds the zone ptr was allocated from. The speed depends
* upon the number of zones and their size.<br />
* If Garbage Collection is enabled, this function always returns the
* same as the NSDefaultMallocZone() function.
*/
GS_EXPORT NSZone*
NSZoneFromPointer (void *ptr);
/**
* Allocates and returns memory for elems items of size bytes, in the
* given zone. Returns NULL if allocation of size 0 requested. Raises
* <code>NSMallocException</code> if not enough free memory in zone to
* allocate and no more can be obtained from system, unless using the
* default zone, in which case NULL is returned.<br />
* If Garbage Collection is enabled, this function always allocates
* non-scanned, non-collectable memory in the NSDefaultMallocZone() and
* the zone argument is ignored.
*/
GS_EXPORT void*
NSZoneMalloc (NSZone *zone, NSUInteger size);
/**
* Allocates and returns cleared memory for elems items of size bytes, in the
* given zone. Returns NULL if allocation of size 0 requested. Raises
* <code>NSMallocException</code> if not enough free memory in zone to
* allocate and no more can be obtained from system, unless using the
* default zone, in which case NULL is returned.<br />
* If Garbage Collection is enabled, this function always allocates
* non-scanned, non-collectable memory in the NSDefaultMallocZone() and
* the zone argument is ignored.
*/
GS_EXPORT void*
NSZoneCalloc (NSZone *zone, NSUInteger elems, NSUInteger bytes);
/**
* Reallocates the chunk of memory in zone pointed to by ptr to a new one of
* size bytes. Existing contents in ptr are copied over. Raises an
* <code>NSMallocException</code> if insufficient memory is available in the
* zone and no more memory can be obtained from the system, unless using the
* default zone, in which case NULL is returned.<br />
* If Garbage Collection is enabled, the zone argument is ignored.
*/
GS_EXPORT void*
NSZoneRealloc (NSZone *zone, void *ptr, NSUInteger size);
/**
* Return memory for an entire zone to system. In fact, this will not be done
* unless all memory in the zone has been explicitly freed (by calls to
* NSZoneFree()). For "non-freeable" zones, the number of NSZoneFree() calls
* must simply equal the number of allocation calls. The default zone, on the
* other hand, cannot be recycled.<br />
* If Garbage Collection is enabled, this function has not effect.
*/
GS_EXPORT void
NSRecycleZone (NSZone *zone);
/**
* Frees memory pointed to by ptr (which should have been allocated by a
* previous call to NSZoneMalloc(), NSZoneCalloc(), or NSZoneRealloc()) and
* returns it to zone. Note, if this is a nonfreeable zone, the memory is
* not actually freed, but the count of number of free()s is updated.<br />
* If Garbage Collection is enabled, the zone argument is ignored and this
* function causes ptr to be deallocated immediately.
*/
GS_EXPORT void
NSZoneFree (NSZone *zone, void *ptr);
/**
* Sets name of the given zone (useful for debugging and logging).
*/
GS_EXPORT void
NSSetZoneName (NSZone *zone, NSString *name);
/**
* Returns the name of the given zone (useful for debugging and logging).
*/
GS_EXPORT NSString*
NSZoneName (NSZone *zone);
#if OS_API_VERSION(GS_API_NONE, GS_API_NONE)
/** Deprecated ...<br />
* Checks integrity of a zone. Not defined by OpenStep or OS X.
*/
BOOL
NSZoneCheck (NSZone *zone);
/**
* <code>NSZoneStats</code> is the structure returned by the NSZoneStats()
* function that summarizes the current usage of a zone. It is similar to
* the structure <em>mstats</em> in the GNU C library. It has 5 fields of
* type <code>size_t</code>-
* <deflist>
* <term><code>bytes_total</code></term>
* <desc>
* This is the total size of memory managed by the zone, in bytes.</desc>
* <term><code>chunks_used</code></term>
* <desc>This is the number of memory chunks in use in the zone.</desc>
* <term><code>bytes_used</code></term>
* <desc>This is the number of bytes in use.</desc>
* <term><code>chunks_free</code></term>
* <desc>This is the number of memory chunks that are not in use.</desc>
* <term><code>bytes_free</code></term>
* <desc>
* This is the number of bytes managed by the zone that are not in use.
* </desc>
* </deflist>
*/
struct NSZoneStats
{
size_t bytes_total;
size_t chunks_used;
size_t bytes_used;
size_t chunks_free;
size_t bytes_free;
};
/** Deprecated ...<br />
* Obtain statistics about the zone. Implementation emphasis is on
* correctness, not speed. Not defined by OpenStep or OS X.
*/
struct NSZoneStats
NSZoneStats (NSZone *zone);
/**
* Try to get more memory - the normal process has failed.
* If we can't do anything, just return a null pointer.
* Try to do some logging if possible.
*/
void*
GSOutOfMemory(NSUInteger size, BOOL retry);
/**
* Called during +initialize to tell the class that instances created
* in future should have the specified instance variable as a weak
* pointer for garbage collection.<br />
* NB. making a pointer weak does not mean that it is automatically
* zeroed when the object it points to is garbage collected. To get that
* behavior you must asign values to the pointer using the
* GSAssignZeroingWeakPointer() function.<br />
* This function has no effect if the system is
* not built for garbage collection.
*/
GS_EXPORT void
GSMakeWeakPointer(Class theClass, const char *iVarName);
/**
* This function must be used to assign a value to a zeroing weak pointer.<br />
* A zeroing weak pointer is one where, when the garbage collector collects
* the object pointed to, it also clears the weak pointer.<br />
* Assigning zero (nil) will always succeed and has the effect of telling the
* garbage collector that it no longer needs to track the previously assigned
* object. Apart from that case, a source needs to be garbage collectable for
* this function to work, and using a non-garbage collectable value will
* cause the function to return NO.<br />
* If the destination object (the weak pointer watching the source object)
* belongs to a chunk of memory which may be collected before the source
* object is collected, it is important that it is finalised and the
* finalisation code assigns zero to the pointer.<br />
* If garbage collection is not in use, this function performs a simple
* assignment returning YES, unless destination is null in which case it
* returns NO.
*/
GS_EXPORT BOOL
GSAssignZeroingWeakPointer(void **destination, void *source);
#endif
GS_EXPORT NSUInteger
NSPageSize (void) __attribute__ ((const));
GS_EXPORT NSUInteger
NSLogPageSize (void) __attribute__ ((const));
GS_EXPORT NSUInteger
NSRoundDownToMultipleOfPageSize (NSUInteger bytes) __attribute__ ((const));
GS_EXPORT NSUInteger
NSRoundUpToMultipleOfPageSize (NSUInteger bytes) __attribute__ ((const));
GS_EXPORT NSUInteger
NSRealMemoryAvailable (void);
GS_EXPORT void*
NSAllocateMemoryPages (NSUInteger bytes);
GS_EXPORT void
NSDeallocateMemoryPages (void *ptr, NSUInteger bytes);
GS_EXPORT void
NSCopyMemoryPages (const void *src, void *dest, NSUInteger bytes);
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4, OS_API_LATEST)
enum {
NSScannedOption = (1<<0),
NSCollectorDisabledOption = (1<<1)
};
/** Allocate memory. If garbage collection is not enabled this uses the
* default malloc zone and the options are ignored.<br />
* If garbage collection is enabled, the allocate memory is normally not
* scanned for pointers but is itsself garbage collectable. The options
* argument is a bitmask in which NSScannedOption sets the memory to be
* scanned for pointers by the garbage collector, and
* NSCollectorDisabledOption causes the memory to be excempt from being
* garbage collected itsself.<br />
* In any case the memory returned is zero'ed.
*/
GS_EXPORT void *
NSAllocateCollectable(NSUInteger size, NSUInteger options);
/** Reallocate memory to be of a different size and/or to have different
* options settings. The behavior of options is as for
* the NSAllocateCollectable() function.
*/
GS_EXPORT void *
NSReallocateCollectable(void *ptr, NSUInteger size, NSUInteger options);
#endif
static inline id NSMakeCollectable(const void *cf) {
#if __has_feature(objc_arc)
return nil;
#else
return (id)cf; // Unimplemented; garbage collection is deprecated.
#endif
}
#if defined(__cplusplus)
}
#endif
#endif /* not __NSZone_h_GNUSTEP_BASE_INCLUDE */
Server : Apache/2.4.41 (Ubuntu)