diff options
| author | Russ Cox <rsc@golang.org> | 2009-06-06 22:04:39 -0700 |
|---|---|---|
| committer | Russ Cox <rsc@golang.org> | 2009-06-06 22:04:39 -0700 |
| commit | 3f6acf11200e54d98fef9b4fa42361b690e12d6e (patch) | |
| tree | 1195452c472b99bfd365ee1cc057e870178e63e0 /src/runtime/malloc.h | |
| parent | f52c02641ebe494240d6d396246a7a794dc11890 (diff) | |
| download | go-3f6acf11200e54d98fef9b4fa42361b690e12d6e.tar.xz | |
move src/runtime -> src/lib/runtime;
only automatic g4 mv here.
R=r
OCL=30002
CL=30007
Diffstat (limited to 'src/runtime/malloc.h')
| -rw-r--r-- | src/runtime/malloc.h | 308 |
1 files changed, 0 insertions, 308 deletions
diff --git a/src/runtime/malloc.h b/src/runtime/malloc.h deleted file mode 100644 index 9b3d6b811c..0000000000 --- a/src/runtime/malloc.h +++ /dev/null @@ -1,308 +0,0 @@ -// Copyright 2009 The Go Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Memory allocator, based on tcmalloc. -// http://goog-perftools.sourceforge.net/doc/tcmalloc.html - -// The main allocator works in runs of pages. -// Small allocation sizes (up to and including 32 kB) are -// rounded to one of about 100 size classes, each of which -// has its own free list of objects of exactly that size. -// Any free page of memory can be split into a set of objects -// of one size class, which are then managed using free list -// allocators. -// -// The allocator's data structures are: -// -// FixAlloc: a free-list allocator for fixed-size objects, -// used to manage storage used by the allocator. -// MHeap: the malloc heap, managed at page (4096-byte) granularity. -// MSpan: a run of pages managed by the MHeap. -// MHeapMap: a mapping from page IDs to MSpans. -// MHeapMapCache: a small cache of MHeapMap mapping page IDs -// to size classes for pages used for small objects. -// MCentral: a shared free list for a given size class. -// MCache: a per-thread (in Go, per-M) cache for small objects. -// MStats: allocation statistics. -// -// Allocating a small object proceeds up a hierarchy of caches: -// -// 1. Round the size up to one of the small size classes -// and look in the corresponding MCache free list. -// If the list is not empty, allocate an object from it. -// This can all be done without acquiring a lock. -// -// 2. If the MCache free list is empty, replenish it by -// taking a bunch of objects from the MCentral free list. -// Moving a bunch amortizes the cost of acquiring the MCentral lock. -// -// 3. If the MCentral free list is empty, replenish it by -// allocating a run of pages from the MHeap and then -// chopping that memory into a objects of the given size. -// Allocating many objects amortizes the cost of locking -// the heap. -// -// 4. If the MHeap is empty or has no page runs large enough, -// allocate a new group of pages (at least 1MB) from the -// operating system. Allocating a large run of pages -// amortizes the cost of talking to the operating system. -// -// Freeing a small object proceeds up the same hierarchy: -// -// 1. Look up the size class for the object and add it to -// the MCache free list. -// -// 2. If the MCache free list is too long or the MCache has -// too much memory, return some to the MCentral free lists. -// -// 3. If all the objects in a given span have returned to -// the MCentral list, return that span to the page heap. -// -// 4. If the heap has too much memory, return some to the -// operating system. -// -// TODO(rsc): Step 4 is not implemented. -// -// Allocating and freeing a large object uses the page heap -// directly, bypassing the MCache and MCentral free lists. -// -// This C code was written with an eye toward translating to Go -// in the future. Methods have the form Type_Method(Type *t, ...). - - -typedef struct FixAlloc FixAlloc; -typedef struct MCentral MCentral; -typedef struct MHeap MHeap; -typedef struct MHeapMap MHeapMap; -typedef struct MHeapMapCache MHeapMapCache; -typedef struct MSpan MSpan; -typedef struct MStats MStats; -typedef struct MLink MLink; - -enum -{ - PageShift = 12, - PageSize = 1<<PageShift, - PageMask = PageSize - 1, -}; -typedef uintptr PageID; // address >> PageShift - -enum -{ - // Tunable constants. - NumSizeClasses = 67, // Number of size classes (must match msize.c) - MaxSmallSize = 32<<10, - - FixAllocChunk = 128<<10, // Chunk size for FixAlloc - MaxMCacheListLen = 256, // Maximum objects on MCacheList - MaxMCacheSize = 2<<20, // Maximum bytes in one MCache - MaxMHeapList = 1<<(20 - PageShift), // Maximum page length for fixed-size list in MHeap. - HeapAllocChunk = 1<<20, // Chunk size for heap growth -}; - -#ifdef _64BIT -#include "mheapmap64.h" -#else -#include "mheapmap32.h" -#endif - -// A generic linked list of blocks. (Typically the block is bigger than sizeof(MLink).) -struct MLink -{ - MLink *next; -}; - -// SysAlloc obtains a large chunk of memory from the operating system, -// typically on the order of a hundred kilobytes or a megabyte. -// -// SysUnused notifies the operating system that the contents -// of the memory region are no longer needed and can be reused -// for other purposes. The program reserves the right to start -// accessing those pages in the future. -// -// SysFree returns it unconditionally; this is only used if -// an out-of-memory error has been detected midway through -// an allocation. It is okay if SysFree is a no-op. - -void* SysAlloc(uintptr nbytes); -void SysFree(void *v, uintptr nbytes); -void SysUnused(void *v, uintptr nbytes); - - -// FixAlloc is a simple free-list allocator for fixed size objects. -// Malloc uses a FixAlloc wrapped around SysAlloc to manages its -// MCache and MSpan objects. -// -// Memory returned by FixAlloc_Alloc is not zeroed. -// The caller is responsible for locking around FixAlloc calls. -// Callers can keep state in the object but the first word is -// smashed by freeing and reallocating. -struct FixAlloc -{ - uintptr size; - void *(*alloc)(uintptr); - void (*first)(void *arg, byte *p); // called first time p is returned - void *arg; - MLink *list; - byte *chunk; - uint32 nchunk; -}; - -void FixAlloc_Init(FixAlloc *f, uintptr size, void *(*alloc)(uintptr), void (*first)(void*, byte*), void *arg); -void* FixAlloc_Alloc(FixAlloc *f); -void FixAlloc_Free(FixAlloc *f, void *p); - - -// Statistics. -// Shared with Go: if you edit this structure, also edit ../lib/malloc.go. -struct MStats -{ - uint64 alloc; - uint64 sys; - uint64 stacks; - uint64 inuse_pages; // protected by mheap.Lock - uint64 next_gc; // protected by mheap.Lock - bool enablegc; -}; -extern MStats mstats; - - -// Size classes. Computed and initialized by InitSizes. -// -// SizeToClass(0 <= n <= MaxSmallSize) returns the size class, -// 1 <= sizeclass < NumSizeClasses, for n. -// Size class 0 is reserved to mean "not small". -// -// class_to_size[i] = largest size in class i -// class_to_allocnpages[i] = number of pages to allocate when -// making new objects in class i -// class_to_transfercount[i] = number of objects to move when -// taking a bunch of objects out of the central lists -// and putting them in the thread free list. - -int32 SizeToClass(int32); -extern int32 class_to_size[NumSizeClasses]; -extern int32 class_to_allocnpages[NumSizeClasses]; -extern int32 class_to_transfercount[NumSizeClasses]; -extern void InitSizes(void); - - -// Per-thread (in Go, per-M) cache for small objects. -// No locking needed because it is per-thread (per-M). -typedef struct MCacheList MCacheList; -struct MCacheList -{ - MLink *list; - uint32 nlist; - uint32 nlistmin; -}; - -struct MCache -{ - MCacheList list[NumSizeClasses]; - uint64 size; -}; - -void* MCache_Alloc(MCache *c, int32 sizeclass, uintptr size); -void MCache_Free(MCache *c, void *p, int32 sizeclass, uintptr size); - - -// An MSpan is a run of pages. -enum -{ - MSpanInUse = 0, - MSpanFree, - MSpanListHead, - MSpanDead, -}; -struct MSpan -{ - MSpan *next; // in a span linked list - MSpan *prev; // in a span linked list - MSpan *allnext; // in the list of all spans - PageID start; // starting page number - uintptr npages; // number of pages in span - MLink *freelist; // list of free objects - uint32 ref; // number of allocated objects in this span - uint32 sizeclass; // size class - uint32 state; // MSpanInUse etc - union { - uint32 *gcref; // sizeclass > 0 - uint32 gcref0; // sizeclass == 0 - }; -}; - -void MSpan_Init(MSpan *span, PageID start, uintptr npages); - -// Every MSpan is in one doubly-linked list, -// either one of the MHeap's free lists or one of the -// MCentral's span lists. We use empty MSpan structures as list heads. -void MSpanList_Init(MSpan *list); -bool MSpanList_IsEmpty(MSpan *list); -void MSpanList_Insert(MSpan *list, MSpan *span); -void MSpanList_Remove(MSpan *span); // from whatever list it is in - - -// Central list of free objects of a given size. -struct MCentral -{ - Lock; - int32 sizeclass; - MSpan nonempty; - MSpan empty; - int32 nfree; -}; - -void MCentral_Init(MCentral *c, int32 sizeclass); -int32 MCentral_AllocList(MCentral *c, int32 n, MLink **first); -void MCentral_FreeList(MCentral *c, int32 n, MLink *first); - -// Main malloc heap. -// The heap itself is the "free[]" and "large" arrays, -// but all the other global data is here too. -struct MHeap -{ - Lock; - MSpan free[MaxMHeapList]; // free lists of given length - MSpan large; // free lists length >= MaxMHeapList - MSpan *allspans; - - // span lookup - MHeapMap map; - MHeapMapCache mapcache; - - // central free lists for small size classes. - // the union makes sure that the MCentrals are - // spaced 64 bytes apart, so that each MCentral.Lock - // gets its own cache line. - union { - MCentral; - byte pad[64]; - } central[NumSizeClasses]; - - FixAlloc spanalloc; // allocator for Span* - FixAlloc cachealloc; // allocator for MCache* -}; -extern MHeap mheap; - -void MHeap_Init(MHeap *h, void *(*allocator)(uintptr)); -MSpan* MHeap_Alloc(MHeap *h, uintptr npage, int32 sizeclass); -void MHeap_Free(MHeap *h, MSpan *s); -MSpan* MHeap_Lookup(MHeap *h, PageID p); -MSpan* MHeap_LookupMaybe(MHeap *h, PageID p); - -int32 mlookup(void *v, byte **base, uintptr *size, uint32 **ref); -void gc(int32 force); - -enum -{ - RefcountOverhead = 4, // one uint32 per object - - RefFree = 0, // must be zero - RefManual, // manual allocation - don't free - RefStack, // stack segment - don't free and don't scan for pointers - RefNone, // no references - RefSome, // some references -}; - |
