c370e4559de69ac058a9a10b4d60b04c3a5c58f1
[WebKit-https.git] / JavaScriptCore / wtf / FastMalloc.cpp
1 // Copyright (c) 2005, 2007, Google Inc.
2 // All rights reserved.
3 // 
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 // 
8 //     * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 //     * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 //     * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 // 
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 // ---
31 // Author: Sanjay Ghemawat <opensource@google.com>
32 //
33 // A malloc that uses a per-thread cache to satisfy small malloc requests.
34 // (The time for malloc/free of a small object drops from 300 ns to 50 ns.)
35 //
36 // See doc/tcmalloc.html for a high-level
37 // description of how this malloc works.
38 //
39 // SYNCHRONIZATION
40 //  1. The thread-specific lists are accessed without acquiring any locks.
41 //     This is safe because each such list is only accessed by one thread.
42 //  2. We have a lock per central free-list, and hold it while manipulating
43 //     the central free list for a particular size.
44 //  3. The central page allocator is protected by "pageheap_lock".
45 //  4. The pagemap (which maps from page-number to descriptor),
46 //     can be read without holding any locks, and written while holding
47 //     the "pageheap_lock".
48 //  5. To improve performance, a subset of the information one can get
49 //     from the pagemap is cached in a data structure, pagemap_cache_,
50 //     that atomically reads and writes its entries.  This cache can be
51 //     read and written without locking.
52 //
53 //     This multi-threaded access to the pagemap is safe for fairly
54 //     subtle reasons.  We basically assume that when an object X is
55 //     allocated by thread A and deallocated by thread B, there must
56 //     have been appropriate synchronization in the handoff of object
57 //     X from thread A to thread B.  The same logic applies to pagemap_cache_.
58 //
59 // THE PAGEID-TO-SIZECLASS CACHE
60 // Hot PageID-to-sizeclass mappings are held by pagemap_cache_.  If this cache
61 // returns 0 for a particular PageID then that means "no information," not that
62 // the sizeclass is 0.  The cache may have stale information for pages that do
63 // not hold the beginning of any free()'able object.  Staleness is eliminated
64 // in Populate() for pages with sizeclass > 0 objects, and in do_malloc() and
65 // do_memalign() for all other relevant pages.
66 //
67 // TODO: Bias reclamation to larger addresses
68 // TODO: implement mallinfo/mallopt
69 // TODO: Better testing
70 //
71 // 9/28/2003 (new page-level allocator replaces ptmalloc2):
72 // * malloc/free of small objects goes from ~300 ns to ~50 ns.
73 // * allocation of a reasonably complicated struct
74 //   goes from about 1100 ns to about 300 ns.
75
76 #include "config.h"
77 #include "FastMalloc.h"
78
79 #include "Assertions.h"
80 #if USE(MULTIPLE_THREADS)
81 #include <pthread.h>
82 #endif
83
84 #ifndef NO_TCMALLOC_SAMPLES
85 #ifdef WTF_CHANGES
86 #define NO_TCMALLOC_SAMPLES
87 #endif
88 #endif
89
90 #if !defined(USE_SYSTEM_MALLOC) && defined(NDEBUG)
91 #define FORCE_SYSTEM_MALLOC 0
92 #else
93 #define FORCE_SYSTEM_MALLOC 1
94 #endif
95
96 #ifndef NDEBUG
97 namespace WTF {
98
99 #if USE(MULTIPLE_THREADS)
100 static pthread_key_t isForbiddenKey;
101 static pthread_once_t isForbiddenKeyOnce = PTHREAD_ONCE_INIT;
102 static void initializeIsForbiddenKey()
103 {
104   pthread_key_create(&isForbiddenKey, 0);
105 }
106
107 static bool isForbidden()
108 {
109     pthread_once(&isForbiddenKeyOnce, initializeIsForbiddenKey);
110     return !!pthread_getspecific(isForbiddenKey);
111 }
112
113 void fastMallocForbid()
114 {
115     pthread_once(&isForbiddenKeyOnce, initializeIsForbiddenKey);
116     pthread_setspecific(isForbiddenKey, &isForbiddenKey);
117 }
118
119 void fastMallocAllow()
120 {
121     pthread_once(&isForbiddenKeyOnce, initializeIsForbiddenKey);
122     pthread_setspecific(isForbiddenKey, 0);
123 }
124
125 #else
126
127 static bool staticIsForbidden;
128 static bool isForbidden()
129 {
130     return staticIsForbidden;
131 }
132
133 void fastMallocForbid()
134 {
135     staticIsForbidden = true;
136 }
137
138 void fastMallocAllow()
139 {
140     staticIsForbidden = false;
141 }
142 #endif // USE(MULTIPLE_THREADS)
143
144 } // namespace WTF
145 #endif // NDEBUG
146
147 #include <string.h>
148
149 namespace WTF {
150 void *fastZeroedMalloc(size_t n) 
151 {
152     void *result = fastMalloc(n);
153     if (!result)
154         return 0;
155     memset(result, 0, n);
156 #ifndef WTF_CHANGES
157     MallocHook::InvokeNewHook(result, n);
158 #endif
159     return result;
160 }
161     
162 }
163
164 #if FORCE_SYSTEM_MALLOC
165
166 #include <stdlib.h>
167 #if !PLATFORM(WIN_OS)
168     #include <pthread.h>
169 #endif
170
171 namespace WTF {
172     
173 void *fastMalloc(size_t n) 
174 {
175     ASSERT(!isForbidden());
176     return malloc(n);
177 }
178
179 void *fastCalloc(size_t n_elements, size_t element_size)
180 {
181     ASSERT(!isForbidden());
182     return calloc(n_elements, element_size);
183 }
184
185 void fastFree(void* p)
186 {
187     ASSERT(!isForbidden());
188     free(p);
189 }
190
191 void *fastRealloc(void* p, size_t n)
192 {
193     ASSERT(!isForbidden());
194     return realloc(p, n);
195 }
196
197 } // namespace WTF
198
199 #if PLATFORM(DARWIN)
200 // This symbol is present in the JavaScriptCore exports file even when FastMalloc is disabled.
201 // It will never be used in this case, so it's type and value are less interesting than its presence.
202 extern "C" const int jscore_fastmalloc_introspection = 0;
203 #endif
204
205 #else
206
207 #if HAVE(STDINT_H)
208 #include <stdint.h>
209 #elif HAVE(INTTYPES_H)
210 #include <inttypes.h>
211 #else
212 #include <sys/types.h>
213 #endif
214
215 #include "AlwaysInline.h"
216 #include "Assertions.h"
217 #include "TCPackedCache.h"
218 #include "TCPageMap.h"
219 #include "TCSpinLock.h"
220 #include "TCSystemAlloc.h"
221 #include <algorithm>
222 #include <errno.h>
223 #include <new>
224 #include <pthread.h>
225 #include <stdarg.h>
226 #include <stddef.h>
227 #include <stdio.h>
228 #if COMPILER(MSVC)
229 #define WIN32_LEAN_AND_MEAN
230 #include <windows.h>
231 #endif
232
233 #if WTF_CHANGES
234
235 #if PLATFORM(DARWIN)
236 #include "MallocZoneSupport.h"
237 #endif
238
239 #ifndef PRIuS
240 #define PRIuS "zu"
241 #endif
242
243 // Calling pthread_getspecific through a global function pointer is faster than a normal
244 // call to the function on Mac OS X, and it's used in performance-critical code. So we
245 // use a function pointer. But that's not necessarily faster on other platforms, and we had
246 // problems with this technique on Windows, so we'll do this only on Mac OS X.
247 #if PLATFORM(DARWIN)
248 static void* (*pthread_getspecific_function_pointer)(pthread_key_t) = pthread_getspecific;
249 #define pthread_getspecific(key) pthread_getspecific_function_pointer(key)
250 #endif
251
252 #define DEFINE_VARIABLE(type, name, value, meaning) \
253   namespace FLAG__namespace_do_not_use_directly_use_DECLARE_##type##_instead {  \
254   type FLAGS_##name(value);                                \
255   char FLAGS_no##name;                                                        \
256   }                                                                           \
257   using FLAG__namespace_do_not_use_directly_use_DECLARE_##type##_instead::FLAGS_##name
258   
259 #define DEFINE_int64(name, value, meaning) \
260   DEFINE_VARIABLE(int64_t, name, value, meaning)
261   
262 #define DEFINE_double(name, value, meaning) \
263   DEFINE_VARIABLE(double, name, value, meaning)
264
265 namespace WTF {
266
267 #define malloc fastMalloc
268 #define calloc fastCalloc
269 #define free fastFree
270 #define realloc fastRealloc
271
272 #define MESSAGE LOG_ERROR
273 #define CHECK_CONDITION ASSERT
274
275 #if PLATFORM(DARWIN)
276 class TCMalloc_PageHeap;
277 class TCMalloc_ThreadCache;
278 class TCMalloc_Central_FreeListPadded;
279
280 class FastMallocZone {
281 public:
282     static void init();
283
284     static kern_return_t enumerate(task_t, void*, unsigned typeMmask, vm_address_t zoneAddress, memory_reader_t, vm_range_recorder_t);
285     static size_t goodSize(malloc_zone_t*, size_t size) { return size; }
286     static boolean_t check(malloc_zone_t*) { return true; }
287     static void  print(malloc_zone_t*, boolean_t) { }
288     static void log(malloc_zone_t*, void*) { }
289     static void forceLock(malloc_zone_t*) { }
290     static void forceUnlock(malloc_zone_t*) { }
291     static void statistics(malloc_zone_t*, malloc_statistics_t*) { }
292
293 private:
294     FastMallocZone(TCMalloc_PageHeap*, TCMalloc_ThreadCache**, TCMalloc_Central_FreeListPadded*);
295     static size_t size(malloc_zone_t*, const void*);
296     static void* zoneMalloc(malloc_zone_t*, size_t);
297     static void* zoneCalloc(malloc_zone_t*, size_t numItems, size_t size);
298     static void zoneFree(malloc_zone_t*, void*);
299     static void* zoneRealloc(malloc_zone_t*, void*, size_t);
300     static void* zoneValloc(malloc_zone_t*, size_t) { LOG_ERROR("valloc is not supported"); return 0; }
301     static void zoneDestroy(malloc_zone_t*) { }
302
303     malloc_zone_t m_zone;
304     TCMalloc_PageHeap* m_pageHeap;
305     TCMalloc_ThreadCache** m_threadHeaps;
306     TCMalloc_Central_FreeListPadded* m_centralCaches;
307 };
308
309 #endif
310
311 #endif
312
313 #ifndef WTF_CHANGES
314 // This #ifdef should almost never be set.  Set NO_TCMALLOC_SAMPLES if
315 // you're porting to a system where you really can't get a stacktrace.
316 #ifdef NO_TCMALLOC_SAMPLES
317 // We use #define so code compiles even if you #include stacktrace.h somehow.
318 # define GetStackTrace(stack, depth, skip)  (0)
319 #else
320 # include <google/stacktrace.h>
321 #endif
322 #endif
323
324 // Even if we have support for thread-local storage in the compiler
325 // and linker, the OS may not support it.  We need to check that at
326 // runtime.  Right now, we have to keep a manual set of "bad" OSes.
327 #if defined(HAVE_TLS)
328   static bool kernel_supports_tls = false;      // be conservative
329   static inline bool KernelSupportsTLS() {
330     return kernel_supports_tls;
331   }
332 # if !HAVE_DECL_UNAME   // if too old for uname, probably too old for TLS
333     static void CheckIfKernelSupportsTLS() {
334       kernel_supports_tls = false;
335     }
336 # else
337 #   include <sys/utsname.h>    // DECL_UNAME checked for <sys/utsname.h> too
338     static void CheckIfKernelSupportsTLS() {
339       struct utsname buf;
340       if (uname(&buf) != 0) {   // should be impossible
341         MESSAGE("uname failed assuming no TLS support (errno=%d)\n", errno);
342         kernel_supports_tls = false;
343       } else if (strcasecmp(buf.sysname, "linux") == 0) {
344         // The linux case: the first kernel to support TLS was 2.6.0
345         if (buf.release[0] < '2' && buf.release[1] == '.')    // 0.x or 1.x
346           kernel_supports_tls = false;
347         else if (buf.release[0] == '2' && buf.release[1] == '.' &&
348                  buf.release[2] >= '0' && buf.release[2] < '6' &&
349                  buf.release[3] == '.')                       // 2.0 - 2.5
350           kernel_supports_tls = false;
351         else
352           kernel_supports_tls = true;
353       } else {        // some other kernel, we'll be optimisitic
354         kernel_supports_tls = true;
355       }
356       // TODO(csilvers): VLOG(1) the tls status once we support RAW_VLOG
357     }
358 #  endif  // HAVE_DECL_UNAME
359 #endif    // HAVE_TLS
360
361 // __THROW is defined in glibc systems.  It means, counter-intuitively,
362 // "This function will never throw an exception."  It's an optional
363 // optimization tool, but we may need to use it to match glibc prototypes.
364 #ifndef __THROW    // I guess we're not on a glibc system
365 # define __THROW   // __THROW is just an optimization, so ok to make it ""
366 #endif
367
368 //-------------------------------------------------------------------
369 // Configuration
370 //-------------------------------------------------------------------
371
372 // Not all possible combinations of the following parameters make
373 // sense.  In particular, if kMaxSize increases, you may have to
374 // increase kNumClasses as well.
375 static const size_t kPageShift  = 12;
376 static const size_t kPageSize   = 1 << kPageShift;
377 static const size_t kMaxSize    = 8u * kPageSize;
378 static const size_t kAlignShift = 3;
379 static const size_t kAlignment  = 1 << kAlignShift;
380 static const size_t kNumClasses = 68;
381
382 // Allocates a big block of memory for the pagemap once we reach more than
383 // 128MB
384 static const size_t kPageMapBigAllocationThreshold = 128 << 20;
385
386 // Minimum number of pages to fetch from system at a time.  Must be
387 // significantly bigger than kBlockSize to amortize system-call
388 // overhead, and also to reduce external fragementation.  Also, we
389 // should keep this value big because various incarnations of Linux
390 // have small limits on the number of mmap() regions per
391 // address-space.
392 static const size_t kMinSystemAlloc = 1 << (20 - kPageShift);
393
394 // Number of objects to move between a per-thread list and a central
395 // list in one shot.  We want this to be not too small so we can
396 // amortize the lock overhead for accessing the central list.  Making
397 // it too big may temporarily cause unnecessary memory wastage in the
398 // per-thread free list until the scavenger cleans up the list.
399 static int num_objects_to_move[kNumClasses];
400
401 // Maximum length we allow a per-thread free-list to have before we
402 // move objects from it into the corresponding central free-list.  We
403 // want this big to avoid locking the central free-list too often.  It
404 // should not hurt to make this list somewhat big because the
405 // scavenging code will shrink it down when its contents are not in use.
406 static const int kMaxFreeListLength = 256;
407
408 // Lower and upper bounds on the per-thread cache sizes
409 static const size_t kMinThreadCacheSize = kMaxSize * 2;
410 static const size_t kMaxThreadCacheSize = 2 << 20;
411
412 // Default bound on the total amount of thread caches
413 static const size_t kDefaultOverallThreadCacheSize = 16 << 20;
414
415 // For all span-lengths < kMaxPages we keep an exact-size list.
416 // REQUIRED: kMaxPages >= kMinSystemAlloc;
417 static const size_t kMaxPages = kMinSystemAlloc;
418
419 /* The smallest prime > 2^n */
420 static int primes_list[] = {
421     // Small values might cause high rates of sampling
422     // and hence commented out.
423     // 2, 5, 11, 17, 37, 67, 131, 257,
424     // 521, 1031, 2053, 4099, 8209, 16411,
425     32771, 65537, 131101, 262147, 524309, 1048583,
426     2097169, 4194319, 8388617, 16777259, 33554467 };
427
428 // Twice the approximate gap between sampling actions.
429 // I.e., we take one sample approximately once every
430 //      tcmalloc_sample_parameter/2
431 // bytes of allocation, i.e., ~ once every 128KB.
432 // Must be a prime number.
433 #ifdef NO_TCMALLOC_SAMPLES
434 DEFINE_int64(tcmalloc_sample_parameter, 0,
435              "Unused: code is compiled with NO_TCMALLOC_SAMPLES");
436 static size_t sample_period = 0;
437 #else
438 DEFINE_int64(tcmalloc_sample_parameter, 262147,
439          "Twice the approximate gap between sampling actions."
440          " Must be a prime number. Otherwise will be rounded up to a "
441          " larger prime number");
442 static size_t sample_period = 262147;
443 #endif
444
445 // Protects sample_period above
446 static SpinLock sample_period_lock = SPINLOCK_INITIALIZER;
447
448 // Parameters for controlling how fast memory is returned to the OS.
449
450 DEFINE_double(tcmalloc_release_rate, 1,
451               "Rate at which we release unused memory to the system.  "
452               "Zero means we never release memory back to the system.  "
453               "Increase this flag to return memory faster; decrease it "
454               "to return memory slower.  Reasonable rates are in the "
455               "range [0,10]");
456
457 //-------------------------------------------------------------------
458 // Mapping from size to size_class and vice versa
459 //-------------------------------------------------------------------
460
461 // Sizes <= 1024 have an alignment >= 8.  So for such sizes we have an
462 // array indexed by ceil(size/8).  Sizes > 1024 have an alignment >= 128.
463 // So for these larger sizes we have an array indexed by ceil(size/128).
464 //
465 // We flatten both logical arrays into one physical array and use
466 // arithmetic to compute an appropriate index.  The constants used by
467 // ClassIndex() were selected to make the flattening work.
468 //
469 // Examples:
470 //   Size       Expression                      Index
471 //   -------------------------------------------------------
472 //   0          (0 + 7) / 8                     0
473 //   1          (1 + 7) / 8                     1
474 //   ...
475 //   1024       (1024 + 7) / 8                  128
476 //   1025       (1025 + 127 + (120<<7)) / 128   129
477 //   ...
478 //   32768      (32768 + 127 + (120<<7)) / 128  376
479 static const size_t kMaxSmallSize = 1024;
480 static const int shift_amount[2] = { 3, 7 };  // For divides by 8 or 128
481 static const int add_amount[2] = { 7, 127 + (120 << 7) };
482 static unsigned char class_array[377];
483
484 // Compute index of the class_array[] entry for a given size
485 static inline int ClassIndex(size_t s) {
486   const int i = (s > kMaxSmallSize);
487   return static_cast<int>((s + add_amount[i]) >> shift_amount[i]);
488 }
489
490 // Mapping from size class to max size storable in that class
491 static size_t class_to_size[kNumClasses];
492
493 // Mapping from size class to number of pages to allocate at a time
494 static size_t class_to_pages[kNumClasses];
495
496 // TransferCache is used to cache transfers of num_objects_to_move[size_class]
497 // back and forth between thread caches and the central cache for a given size
498 // class.
499 struct TCEntry {
500   void *head;  // Head of chain of objects.
501   void *tail;  // Tail of chain of objects.
502 };
503 // A central cache freelist can have anywhere from 0 to kNumTransferEntries
504 // slots to put link list chains into.  To keep memory usage bounded the total
505 // number of TCEntries across size classes is fixed.  Currently each size
506 // class is initially given one TCEntry which also means that the maximum any
507 // one class can have is kNumClasses.
508 static const int kNumTransferEntries = kNumClasses;
509
510 // Note: the following only works for "n"s that fit in 32-bits, but
511 // that is fine since we only use it for small sizes.
512 static inline int LgFloor(size_t n) {
513   int log = 0;
514   for (int i = 4; i >= 0; --i) {
515     int shift = (1 << i);
516     size_t x = n >> shift;
517     if (x != 0) {
518       n = x;
519       log += shift;
520     }
521   }
522   ASSERT(n == 1);
523   return log;
524 }
525
526 // Some very basic linked list functions for dealing with using void * as
527 // storage.
528
529 static inline void *SLL_Next(void *t) {
530   return *(reinterpret_cast<void**>(t));
531 }
532
533 static inline void SLL_SetNext(void *t, void *n) {
534   *(reinterpret_cast<void**>(t)) = n;
535 }
536
537 static inline void SLL_Push(void **list, void *element) {
538   SLL_SetNext(element, *list);
539   *list = element;
540 }
541
542 static inline void *SLL_Pop(void **list) {
543   void *result = *list;
544   *list = SLL_Next(*list);
545   return result;
546 }
547
548
549 // Remove N elements from a linked list to which head points.  head will be
550 // modified to point to the new head.  start and end will point to the first
551 // and last nodes of the range.  Note that end will point to NULL after this
552 // function is called.
553 static inline void SLL_PopRange(void **head, int N, void **start, void **end) {
554   if (N == 0) {
555     *start = NULL;
556     *end = NULL;
557     return;
558   }
559
560   void *tmp = *head;
561   for (int i = 1; i < N; ++i) {
562     tmp = SLL_Next(tmp);
563   }
564
565   *start = *head;
566   *end = tmp;
567   *head = SLL_Next(tmp);
568   // Unlink range from list.
569   SLL_SetNext(tmp, NULL);
570 }
571
572 static inline void SLL_PushRange(void **head, void *start, void *end) {
573   if (!start) return;
574   SLL_SetNext(end, *head);
575   *head = start;
576 }
577
578 static inline size_t SLL_Size(void *head) {
579   int count = 0;
580   while (head) {
581     count++;
582     head = SLL_Next(head);
583   }
584   return count;
585 }
586
587 // Setup helper functions.
588
589 static ALWAYS_INLINE size_t SizeClass(size_t size) {
590   return class_array[ClassIndex(size)];
591 }
592
593 // Get the byte-size for a specified class
594 static ALWAYS_INLINE size_t ByteSizeForClass(size_t cl) {
595   return class_to_size[cl];
596 }
597 static int NumMoveSize(size_t size) {
598   if (size == 0) return 0;
599   // Use approx 64k transfers between thread and central caches.
600   int num = static_cast<int>(64.0 * 1024.0 / size);
601   if (num < 2) num = 2;
602   // Clamp well below kMaxFreeListLength to avoid ping pong between central
603   // and thread caches.
604   if (num > static_cast<int>(0.8 * kMaxFreeListLength))
605     num = static_cast<int>(0.8 * kMaxFreeListLength);
606
607   // Also, avoid bringing in too many objects into small object free
608   // lists.  There are lots of such lists, and if we allow each one to
609   // fetch too many at a time, we end up having to scavenge too often
610   // (especially when there are lots of threads and each thread gets a
611   // small allowance for its thread cache).
612   //
613   // TODO: Make thread cache free list sizes dynamic so that we do not
614   // have to equally divide a fixed resource amongst lots of threads.
615   if (num > 32) num = 32;
616
617   return num;
618 }
619
620 // Initialize the mapping arrays
621 static void InitSizeClasses() {
622   // Do some sanity checking on add_amount[]/shift_amount[]/class_array[]
623   if (ClassIndex(0) < 0) {
624     MESSAGE("Invalid class index %d for size 0\n", ClassIndex(0));
625     abort();
626   }
627   if (static_cast<size_t>(ClassIndex(kMaxSize)) >= sizeof(class_array)) {
628     MESSAGE("Invalid class index %d for kMaxSize\n", ClassIndex(kMaxSize));
629     abort();
630   }
631
632   // Compute the size classes we want to use
633   size_t sc = 1;   // Next size class to assign
634   unsigned char alignshift = kAlignShift;
635   int last_lg = -1;
636   for (size_t size = kAlignment; size <= kMaxSize; size += (1 << alignshift)) {
637     int lg = LgFloor(size);
638     if (lg > last_lg) {
639       // Increase alignment every so often.
640       //
641       // Since we double the alignment every time size doubles and
642       // size >= 128, this means that space wasted due to alignment is
643       // at most 16/128 i.e., 12.5%.  Plus we cap the alignment at 256
644       // bytes, so the space wasted as a percentage starts falling for
645       // sizes > 2K.
646       if ((lg >= 7) && (alignshift < 8)) {
647         alignshift++;
648       }
649       last_lg = lg;
650     }
651
652     // Allocate enough pages so leftover is less than 1/8 of total.
653     // This bounds wasted space to at most 12.5%.
654     size_t psize = kPageSize;
655     while ((psize % size) > (psize >> 3)) {
656       psize += kPageSize;
657     }
658     const size_t my_pages = psize >> kPageShift;
659
660     if (sc > 1 && my_pages == class_to_pages[sc-1]) {
661       // See if we can merge this into the previous class without
662       // increasing the fragmentation of the previous class.
663       const size_t my_objects = (my_pages << kPageShift) / size;
664       const size_t prev_objects = (class_to_pages[sc-1] << kPageShift)
665                                   / class_to_size[sc-1];
666       if (my_objects == prev_objects) {
667         // Adjust last class to include this size
668         class_to_size[sc-1] = size;
669         continue;
670       }
671     }
672
673     // Add new class
674     class_to_pages[sc] = my_pages;
675     class_to_size[sc] = size;
676     sc++;
677   }
678   if (sc != kNumClasses) {
679     MESSAGE("wrong number of size classes: found %" PRIuS " instead of %d\n",
680             sc, int(kNumClasses));
681     abort();
682   }
683
684   // Initialize the mapping arrays
685   int next_size = 0;
686   for (unsigned char c = 1; c < kNumClasses; c++) {
687     const size_t max_size_in_class = class_to_size[c];
688     for (size_t s = next_size; s <= max_size_in_class; s += kAlignment) {
689       class_array[ClassIndex(s)] = c;
690     }
691     next_size = static_cast<int>(max_size_in_class + kAlignment);
692   }
693
694   // Double-check sizes just to be safe
695   for (size_t size = 0; size <= kMaxSize; size++) {
696     const size_t sc = SizeClass(size);
697     if (sc == 0) {
698       MESSAGE("Bad size class %" PRIuS " for %" PRIuS "\n", sc, size);
699       abort();
700     }
701     if (sc > 1 && size <= class_to_size[sc-1]) {
702       MESSAGE("Allocating unnecessarily large class %" PRIuS " for %" PRIuS
703               "\n", sc, size);
704       abort();
705     }
706     if (sc >= kNumClasses) {
707       MESSAGE("Bad size class %" PRIuS " for %" PRIuS "\n", sc, size);
708       abort();
709     }
710     const size_t s = class_to_size[sc];
711     if (size > s) {
712      MESSAGE("Bad size %" PRIuS " for %" PRIuS " (sc = %" PRIuS ")\n", s, size, sc);
713       abort();
714     }
715     if (s == 0) {
716       MESSAGE("Bad size %" PRIuS " for %" PRIuS " (sc = %" PRIuS ")\n", s, size, sc);
717       abort();
718     }
719   }
720
721   // Initialize the num_objects_to_move array.
722   for (size_t cl = 1; cl  < kNumClasses; ++cl) {
723     num_objects_to_move[cl] = NumMoveSize(ByteSizeForClass(cl));
724   }
725
726 #ifndef WTF_CHANGES
727   if (false) {
728     // Dump class sizes and maximum external wastage per size class
729     for (size_t cl = 1; cl  < kNumClasses; ++cl) {
730       const int alloc_size = class_to_pages[cl] << kPageShift;
731       const int alloc_objs = alloc_size / class_to_size[cl];
732       const int min_used = (class_to_size[cl-1] + 1) * alloc_objs;
733       const int max_waste = alloc_size - min_used;
734       MESSAGE("SC %3d [ %8d .. %8d ] from %8d ; %2.0f%% maxwaste\n",
735               int(cl),
736               int(class_to_size[cl-1] + 1),
737               int(class_to_size[cl]),
738               int(class_to_pages[cl] << kPageShift),
739               max_waste * 100.0 / alloc_size
740               );
741     }
742   }
743 #endif
744 }
745
746 // -------------------------------------------------------------------------
747 // Simple allocator for objects of a specified type.  External locking
748 // is required before accessing one of these objects.
749 // -------------------------------------------------------------------------
750
751 // Metadata allocator -- keeps stats about how many bytes allocated
752 static uint64_t metadata_system_bytes = 0;
753 static void* MetaDataAlloc(size_t bytes) {
754   void* result = TCMalloc_SystemAlloc(bytes, 0);
755   if (result != NULL) {
756     metadata_system_bytes += bytes;
757   }
758   return result;
759 }
760
761 template <class T>
762 class PageHeapAllocator {
763  private:
764   // How much to allocate from system at a time
765   static const size_t kAllocIncrement = 32 << 10;
766
767   // Aligned size of T
768   static const size_t kAlignedSize
769   = (((sizeof(T) + kAlignment - 1) / kAlignment) * kAlignment);
770
771   // Free area from which to carve new objects
772   char* free_area_;
773   size_t free_avail_;
774
775   // Free list of already carved objects
776   void* free_list_;
777
778   // Number of allocated but unfreed objects
779   int inuse_;
780
781  public:
782   void Init() {
783     ASSERT(kAlignedSize <= kAllocIncrement);
784     inuse_ = 0;
785     free_area_ = NULL;
786     free_avail_ = 0;
787     free_list_ = NULL;
788   }
789
790   T* New() {
791     // Consult free list
792     void* result;
793     if (free_list_ != NULL) {
794       result = free_list_;
795       free_list_ = *(reinterpret_cast<void**>(result));
796     } else {
797       if (free_avail_ < kAlignedSize) {
798         // Need more room
799         free_area_ = reinterpret_cast<char*>(MetaDataAlloc(kAllocIncrement));
800         if (free_area_ == NULL) abort();
801         free_avail_ = kAllocIncrement;
802       }
803       result = free_area_;
804       free_area_ += kAlignedSize;
805       free_avail_ -= kAlignedSize;
806     }
807     inuse_++;
808     return reinterpret_cast<T*>(result);
809   }
810
811   void Delete(T* p) {
812     *(reinterpret_cast<void**>(p)) = free_list_;
813     free_list_ = p;
814     inuse_--;
815   }
816
817   int inuse() const { return inuse_; }
818 };
819
820 // -------------------------------------------------------------------------
821 // Span - a contiguous run of pages
822 // -------------------------------------------------------------------------
823
824 // Type that can hold a page number
825 typedef uintptr_t PageID;
826
827 // Type that can hold the length of a run of pages
828 typedef uintptr_t Length;
829
830 static const Length kMaxValidPages = (~static_cast<Length>(0)) >> kPageShift;
831
832 // Convert byte size into pages.  This won't overflow, but may return
833 // an unreasonably large value if bytes is huge enough.
834 static inline Length pages(size_t bytes) {
835   return (bytes >> kPageShift) +
836       ((bytes & (kPageSize - 1)) > 0 ? 1 : 0);
837 }
838
839 // Convert a user size into the number of bytes that will actually be
840 // allocated
841 static size_t AllocationSize(size_t bytes) {
842   if (bytes > kMaxSize) {
843     // Large object: we allocate an integral number of pages
844     ASSERT(bytes <= (kMaxValidPages << kPageShift));
845     return pages(bytes) << kPageShift;
846   } else {
847     // Small object: find the size class to which it belongs
848     return ByteSizeForClass(SizeClass(bytes));
849   }
850 }
851
852 // Information kept for a span (a contiguous run of pages).
853 struct Span {
854   PageID        start;          // Starting page number
855   Length        length;         // Number of pages in span
856   Span*         next;           // Used when in link list
857   Span*         prev;           // Used when in link list
858   void*         objects;        // Linked list of free objects
859   unsigned int  free : 1;       // Is the span free
860   unsigned int  sample : 1;     // Sampled object?
861   unsigned int  sizeclass : 8;  // Size-class for small objects (or 0)
862   unsigned int  refcount : 11;  // Number of non-free objects
863
864 #undef SPAN_HISTORY
865 #ifdef SPAN_HISTORY
866   // For debugging, we can keep a log events per span
867   int nexthistory;
868   char history[64];
869   int value[64];
870 #endif
871 };
872
873 #ifdef SPAN_HISTORY
874 void Event(Span* span, char op, int v = 0) {
875   span->history[span->nexthistory] = op;
876   span->value[span->nexthistory] = v;
877   span->nexthistory++;
878   if (span->nexthistory == sizeof(span->history)) span->nexthistory = 0;
879 }
880 #else
881 #define Event(s,o,v) ((void) 0)
882 #endif
883
884 // Allocator/deallocator for spans
885 static PageHeapAllocator<Span> span_allocator;
886 static Span* NewSpan(PageID p, Length len) {
887   Span* result = span_allocator.New();
888   memset(result, 0, sizeof(*result));
889   result->start = p;
890   result->length = len;
891 #ifdef SPAN_HISTORY
892   result->nexthistory = 0;
893 #endif
894   return result;
895 }
896
897 static inline void DeleteSpan(Span* span) {
898 #ifndef NDEBUG
899   // In debug mode, trash the contents of deleted Spans
900   memset(span, 0x3f, sizeof(*span));
901 #endif
902   span_allocator.Delete(span);
903 }
904
905 // -------------------------------------------------------------------------
906 // Doubly linked list of spans.
907 // -------------------------------------------------------------------------
908
909 static inline void DLL_Init(Span* list) {
910   list->next = list;
911   list->prev = list;
912 }
913
914 static inline void DLL_Remove(Span* span) {
915   span->prev->next = span->next;
916   span->next->prev = span->prev;
917   span->prev = NULL;
918   span->next = NULL;
919 }
920
921 static ALWAYS_INLINE bool DLL_IsEmpty(const Span* list) {
922   return list->next == list;
923 }
924
925 #ifndef WTF_CHANGES
926 static int DLL_Length(const Span* list) {
927   int result = 0;
928   for (Span* s = list->next; s != list; s = s->next) {
929     result++;
930   }
931   return result;
932 }
933 #endif
934
935 #if 0 /* Not needed at the moment -- causes compiler warnings if not used */
936 static void DLL_Print(const char* label, const Span* list) {
937   MESSAGE("%-10s %p:", label, list);
938   for (const Span* s = list->next; s != list; s = s->next) {
939     MESSAGE(" <%p,%u,%u>", s, s->start, s->length);
940   }
941   MESSAGE("\n");
942 }
943 #endif
944
945 static inline void DLL_Prepend(Span* list, Span* span) {
946   ASSERT(span->next == NULL);
947   ASSERT(span->prev == NULL);
948   span->next = list->next;
949   span->prev = list;
950   list->next->prev = span;
951   list->next = span;
952 }
953
954 // -------------------------------------------------------------------------
955 // Stack traces kept for sampled allocations
956 //   The following state is protected by pageheap_lock_.
957 // -------------------------------------------------------------------------
958
959 // size/depth are made the same size as a pointer so that some generic
960 // code below can conveniently cast them back and forth to void*.
961 static const int kMaxStackDepth = 31;
962 struct StackTrace {
963   uintptr_t size;          // Size of object
964   uintptr_t depth;         // Number of PC values stored in array below
965   void*     stack[kMaxStackDepth];
966 };
967 static PageHeapAllocator<StackTrace> stacktrace_allocator;
968 static Span sampled_objects;
969
970 // -------------------------------------------------------------------------
971 // Map from page-id to per-page data
972 // -------------------------------------------------------------------------
973
974 // We use PageMap2<> for 32-bit and PageMap3<> for 64-bit machines.
975 // We also use a simple one-level cache for hot PageID-to-sizeclass mappings,
976 // because sometimes the sizeclass is all the information we need.
977
978 // Selector class -- general selector uses 3-level map
979 template <int BITS> class MapSelector {
980  public:
981   typedef TCMalloc_PageMap3<BITS-kPageShift> Type;
982   typedef PackedCache<BITS, uint64_t> CacheType;
983 };
984
985 // A two-level map for 32-bit machines
986 template <> class MapSelector<32> {
987  public:
988   typedef TCMalloc_PageMap2<32-kPageShift> Type;
989   typedef PackedCache<32-kPageShift, uint16_t> CacheType;
990 };
991
992 // -------------------------------------------------------------------------
993 // Page-level allocator
994 //  * Eager coalescing
995 //
996 // Heap for page-level allocation.  We allow allocating and freeing a
997 // contiguous runs of pages (called a "span").
998 // -------------------------------------------------------------------------
999
1000 class TCMalloc_PageHeap {
1001  public:
1002   void init();
1003
1004   // Allocate a run of "n" pages.  Returns zero if out of memory.
1005   Span* New(Length n);
1006
1007   // Delete the span "[p, p+n-1]".
1008   // REQUIRES: span was returned by earlier call to New() and
1009   //           has not yet been deleted.
1010   void Delete(Span* span);
1011
1012   // Mark an allocated span as being used for small objects of the
1013   // specified size-class.
1014   // REQUIRES: span was returned by an earlier call to New()
1015   //           and has not yet been deleted.
1016   void RegisterSizeClass(Span* span, size_t sc);
1017
1018   // Split an allocated span into two spans: one of length "n" pages
1019   // followed by another span of length "span->length - n" pages.
1020   // Modifies "*span" to point to the first span of length "n" pages.
1021   // Returns a pointer to the second span.
1022   //
1023   // REQUIRES: "0 < n < span->length"
1024   // REQUIRES: !span->free
1025   // REQUIRES: span->sizeclass == 0
1026   Span* Split(Span* span, Length n);
1027
1028   // Return the descriptor for the specified page.
1029   inline Span* GetDescriptor(PageID p) const {
1030     return reinterpret_cast<Span*>(pagemap_.get(p));
1031   }
1032
1033 #ifdef WTF_CHANGES
1034   inline Span* GetDescriptorEnsureSafe(PageID p)
1035   {
1036       pagemap_.Ensure(p, 1);
1037       return GetDescriptor(p);
1038   }
1039 #endif
1040
1041   // Dump state to stderr
1042 #ifndef WTF_CHANGES
1043   void Dump(TCMalloc_Printer* out);
1044 #endif
1045
1046   // Return number of bytes allocated from system
1047   inline uint64_t SystemBytes() const { return system_bytes_; }
1048
1049   // Return number of free bytes in heap
1050   uint64_t FreeBytes() const {
1051     return (static_cast<uint64_t>(free_pages_) << kPageShift);
1052   }
1053
1054   bool Check();
1055   bool CheckList(Span* list, Length min_pages, Length max_pages);
1056
1057   // Release all pages on the free list for reuse by the OS:
1058   void ReleaseFreePages();
1059
1060   // Return 0 if we have no information, or else the correct sizeclass for p.
1061   // Reads and writes to pagemap_cache_ do not require locking.
1062   // The entries are 64 bits on 64-bit hardware and 16 bits on
1063   // 32-bit hardware, and we don't mind raciness as long as each read of
1064   // an entry yields a valid entry, not a partially updated entry.
1065   size_t GetSizeClassIfCached(PageID p) const {
1066     return pagemap_cache_.GetOrDefault(p, 0);
1067   }
1068   void CacheSizeClass(PageID p, size_t cl) const { pagemap_cache_.Put(p, cl); }
1069
1070  private:
1071   // Pick the appropriate map and cache types based on pointer size
1072   typedef MapSelector<8*sizeof(uintptr_t)>::Type PageMap;
1073   typedef MapSelector<8*sizeof(uintptr_t)>::CacheType PageMapCache;
1074   PageMap pagemap_;
1075   mutable PageMapCache pagemap_cache_;
1076
1077   // We segregate spans of a given size into two circular linked
1078   // lists: one for normal spans, and one for spans whose memory
1079   // has been returned to the system.
1080   struct SpanList {
1081     Span        normal;
1082     Span        returned;
1083   };
1084
1085   // List of free spans of length >= kMaxPages
1086   SpanList large_;
1087
1088   // Array mapping from span length to a doubly linked list of free spans
1089   SpanList free_[kMaxPages];
1090
1091   // Number of pages kept in free lists
1092   uintptr_t free_pages_;
1093
1094   // Bytes allocated from system
1095   uint64_t system_bytes_;
1096
1097   bool GrowHeap(Length n);
1098
1099   // REQUIRES   span->length >= n
1100   // Remove span from its free list, and move any leftover part of
1101   // span into appropriate free lists.  Also update "span" to have
1102   // length exactly "n" and mark it as non-free so it can be returned
1103   // to the client.
1104   //
1105   // "released" is true iff "span" was found on a "returned" list.
1106   void Carve(Span* span, Length n, bool released);
1107
1108   void RecordSpan(Span* span) {
1109     pagemap_.set(span->start, span);
1110     if (span->length > 1) {
1111       pagemap_.set(span->start + span->length - 1, span);
1112     }
1113   }
1114   
1115     // Allocate a large span of length == n.  If successful, returns a
1116   // span of exactly the specified length.  Else, returns NULL.
1117   Span* AllocLarge(Length n);
1118
1119   // Incrementally release some memory to the system.
1120   // IncrementalScavenge(n) is called whenever n pages are freed.
1121   void IncrementalScavenge(Length n);
1122
1123   // Number of pages to deallocate before doing more scavenging
1124   int64_t scavenge_counter_;
1125
1126   // Index of last free list we scavenged
1127   size_t scavenge_index_;
1128   
1129 #if defined(WTF_CHANGES) && PLATFORM(DARWIN)
1130   friend class FastMallocZone;
1131 #endif
1132 };
1133
1134 void TCMalloc_PageHeap::init()
1135 {
1136   pagemap_.init(MetaDataAlloc);
1137   pagemap_cache_ = PageMapCache(0);
1138   free_pages_ = 0;
1139   system_bytes_ = 0;
1140   scavenge_counter_ = 0;
1141   // Start scavenging at kMaxPages list
1142   scavenge_index_ = kMaxPages-1;
1143   COMPILE_ASSERT(kNumClasses <= (1 << PageMapCache::kValuebits), valuebits);
1144   DLL_Init(&large_.normal);
1145   DLL_Init(&large_.returned);
1146   for (size_t i = 0; i < kMaxPages; i++) {
1147     DLL_Init(&free_[i].normal);
1148     DLL_Init(&free_[i].returned);
1149   }
1150 }
1151
1152 inline Span* TCMalloc_PageHeap::New(Length n) {
1153   ASSERT(Check());
1154   ASSERT(n > 0);
1155
1156   // Find first size >= n that has a non-empty list
1157   for (Length s = n; s < kMaxPages; s++) {
1158     Span* ll = NULL;
1159     bool released = false;
1160     if (!DLL_IsEmpty(&free_[s].normal)) {
1161       // Found normal span
1162       ll = &free_[s].normal;
1163     } else if (!DLL_IsEmpty(&free_[s].returned)) {
1164       // Found returned span; reallocate it
1165       ll = &free_[s].returned;
1166       released = true;
1167     } else {
1168       // Keep looking in larger classes
1169       continue;
1170     }
1171
1172     Span* result = ll->next;
1173     Carve(result, n, released);
1174     ASSERT(Check());
1175     free_pages_ -= n;
1176     return result;
1177   }
1178
1179   Span* result = AllocLarge(n);
1180   if (result != NULL) return result;
1181
1182   // Grow the heap and try again
1183   if (!GrowHeap(n)) {
1184     ASSERT(Check());
1185     return NULL;
1186   }
1187
1188   return AllocLarge(n);
1189 }
1190
1191 Span* TCMalloc_PageHeap::AllocLarge(Length n) {
1192   // find the best span (closest to n in size).
1193   // The following loops implements address-ordered best-fit.
1194   bool from_released = false;
1195   Span *best = NULL;
1196
1197   // Search through normal list
1198   for (Span* span = large_.normal.next;
1199        span != &large_.normal;
1200        span = span->next) {
1201     if (span->length >= n) {
1202       if ((best == NULL)
1203           || (span->length < best->length)
1204           || ((span->length == best->length) && (span->start < best->start))) {
1205         best = span;
1206         from_released = false;
1207       }
1208     }
1209   }
1210
1211   // Search through released list in case it has a better fit
1212   for (Span* span = large_.returned.next;
1213        span != &large_.returned;
1214        span = span->next) {
1215     if (span->length >= n) {
1216       if ((best == NULL)
1217           || (span->length < best->length)
1218           || ((span->length == best->length) && (span->start < best->start))) {
1219         best = span;
1220         from_released = true;
1221       }
1222     }
1223   }
1224
1225   if (best != NULL) {
1226     Carve(best, n, from_released);
1227     ASSERT(Check());
1228     free_pages_ -= n;
1229     return best;
1230   }
1231   return NULL;
1232 }
1233
1234 Span* TCMalloc_PageHeap::Split(Span* span, Length n) {
1235   ASSERT(0 < n);
1236   ASSERT(n < span->length);
1237   ASSERT(!span->free);
1238   ASSERT(span->sizeclass == 0);
1239   Event(span, 'T', n);
1240
1241   const Length extra = span->length - n;
1242   Span* leftover = NewSpan(span->start + n, extra);
1243   Event(leftover, 'U', extra);
1244   RecordSpan(leftover);
1245   pagemap_.set(span->start + n - 1, span); // Update map from pageid to span
1246   span->length = n;
1247
1248   return leftover;
1249 }
1250
1251 inline void TCMalloc_PageHeap::Carve(Span* span, Length n, bool released) {
1252   ASSERT(n > 0);
1253   DLL_Remove(span);
1254   span->free = 0;
1255   Event(span, 'A', n);
1256
1257   const int extra = static_cast<int>(span->length - n);
1258   ASSERT(extra >= 0);
1259   if (extra > 0) {
1260     Span* leftover = NewSpan(span->start + n, extra);
1261     leftover->free = 1;
1262     Event(leftover, 'S', extra);
1263     RecordSpan(leftover);
1264
1265     // Place leftover span on appropriate free list
1266     SpanList* listpair = (static_cast<size_t>(extra) < kMaxPages) ? &free_[extra] : &large_;
1267     Span* dst = released ? &listpair->returned : &listpair->normal;
1268     DLL_Prepend(dst, leftover);
1269
1270     span->length = n;
1271     pagemap_.set(span->start + n - 1, span);
1272   }
1273 }
1274
1275 inline void TCMalloc_PageHeap::Delete(Span* span) {
1276   ASSERT(Check());
1277   ASSERT(!span->free);
1278   ASSERT(span->length > 0);
1279   ASSERT(GetDescriptor(span->start) == span);
1280   ASSERT(GetDescriptor(span->start + span->length - 1) == span);
1281   span->sizeclass = 0;
1282   span->sample = 0;
1283
1284   // Coalesce -- we guarantee that "p" != 0, so no bounds checking
1285   // necessary.  We do not bother resetting the stale pagemap
1286   // entries for the pieces we are merging together because we only
1287   // care about the pagemap entries for the boundaries.
1288   //
1289   // Note that the spans we merge into "span" may come out of
1290   // a "returned" list.  For simplicity, we move these into the
1291   // "normal" list of the appropriate size class.
1292   const PageID p = span->start;
1293   const Length n = span->length;
1294   Span* prev = GetDescriptor(p-1);
1295   if (prev != NULL && prev->free) {
1296     // Merge preceding span into this span
1297     ASSERT(prev->start + prev->length == p);
1298     const Length len = prev->length;
1299     DLL_Remove(prev);
1300     DeleteSpan(prev);
1301     span->start -= len;
1302     span->length += len;
1303     pagemap_.set(span->start, span);
1304     Event(span, 'L', len);
1305   }
1306   Span* next = GetDescriptor(p+n);
1307   if (next != NULL && next->free) {
1308     // Merge next span into this span
1309     ASSERT(next->start == p+n);
1310     const Length len = next->length;
1311     DLL_Remove(next);
1312     DeleteSpan(next);
1313     span->length += len;
1314     pagemap_.set(span->start + span->length - 1, span);
1315     Event(span, 'R', len);
1316   }
1317
1318   Event(span, 'D', span->length);
1319   span->free = 1;
1320   if (span->length < kMaxPages) {
1321     DLL_Prepend(&free_[span->length].normal, span);
1322   } else {
1323     DLL_Prepend(&large_.normal, span);
1324   }
1325   free_pages_ += n;
1326
1327   IncrementalScavenge(n);
1328   ASSERT(Check());
1329 }
1330
1331 void TCMalloc_PageHeap::IncrementalScavenge(Length n) {
1332   // Fast path; not yet time to release memory
1333   scavenge_counter_ -= n;
1334   if (scavenge_counter_ >= 0) return;  // Not yet time to scavenge
1335
1336   // If there is nothing to release, wait for so many pages before
1337   // scavenging again.  With 4K pages, this comes to 16MB of memory.
1338   static const size_t kDefaultReleaseDelay = 1 << 8;
1339
1340   // Find index of free list to scavenge
1341   size_t index = scavenge_index_ + 1;
1342   for (size_t i = 0; i < kMaxPages+1; i++) {
1343     if (index > kMaxPages) index = 0;
1344     SpanList* slist = (index == kMaxPages) ? &large_ : &free_[index];
1345     if (!DLL_IsEmpty(&slist->normal)) {
1346       // Release the last span on the normal portion of this list
1347       Span* s = slist->normal.prev;
1348       DLL_Remove(s);
1349       TCMalloc_SystemRelease(reinterpret_cast<void*>(s->start << kPageShift),
1350                              static_cast<size_t>(s->length << kPageShift));
1351       DLL_Prepend(&slist->returned, s);
1352
1353       scavenge_counter_ = std::max<size_t>(64UL, std::min<size_t>(kDefaultReleaseDelay, kDefaultReleaseDelay - (free_pages_ / kDefaultReleaseDelay)));
1354 //      fprintf(stderr, "Released %zu pages at 0x%08zx to the system from index %zu.  Delaying for %lld pages before scavenging next.\n", s->length, s->start << kPageShift, index, scavenge_counter_);
1355
1356       if (index == kMaxPages && !DLL_IsEmpty(&slist->normal))
1357         scavenge_index_ = index - 1;
1358       else
1359         scavenge_index_ = index;
1360       return;
1361     }
1362     index++;
1363   }
1364
1365   // Nothing to scavenge, delay for a while
1366   scavenge_counter_ = kDefaultReleaseDelay;
1367 //  fprintf(stderr, "Nothing to scavenge.  Delaying for %lld pages before scavenging next.\n", scavenge_counter_);
1368 }
1369
1370 void TCMalloc_PageHeap::RegisterSizeClass(Span* span, size_t sc) {
1371   // Associate span object with all interior pages as well
1372   ASSERT(!span->free);
1373   ASSERT(GetDescriptor(span->start) == span);
1374   ASSERT(GetDescriptor(span->start+span->length-1) == span);
1375   Event(span, 'C', sc);
1376   span->sizeclass = static_cast<unsigned int>(sc);
1377   for (Length i = 1; i < span->length-1; i++) {
1378     pagemap_.set(span->start+i, span);
1379   }
1380 }
1381
1382 #ifndef WTF_CHANGES
1383 static double PagesToMB(uint64_t pages) {
1384   return (pages << kPageShift) / 1048576.0;
1385 }
1386
1387 void TCMalloc_PageHeap::Dump(TCMalloc_Printer* out) {
1388   int nonempty_sizes = 0;
1389   for (int s = 0; s < kMaxPages; s++) {
1390     if (!DLL_IsEmpty(&free_[s].normal) || !DLL_IsEmpty(&free_[s].returned)) {
1391       nonempty_sizes++;
1392     }
1393   }
1394   out->printf("------------------------------------------------\n");
1395   out->printf("PageHeap: %d sizes; %6.1f MB free\n",
1396               nonempty_sizes, PagesToMB(free_pages_));
1397   out->printf("------------------------------------------------\n");
1398   uint64_t total_normal = 0;
1399   uint64_t total_returned = 0;
1400   for (int s = 0; s < kMaxPages; s++) {
1401     const int n_length = DLL_Length(&free_[s].normal);
1402     const int r_length = DLL_Length(&free_[s].returned);
1403     if (n_length + r_length > 0) {
1404       uint64_t n_pages = s * n_length;
1405       uint64_t r_pages = s * r_length;
1406       total_normal += n_pages;
1407       total_returned += r_pages;
1408       out->printf("%6u pages * %6u spans ~ %6.1f MB; %6.1f MB cum"
1409                   "; unmapped: %6.1f MB; %6.1f MB cum\n",
1410                   s,
1411                   (n_length + r_length),
1412                   PagesToMB(n_pages + r_pages),
1413                   PagesToMB(total_normal + total_returned),
1414                   PagesToMB(r_pages),
1415                   PagesToMB(total_returned));
1416     }
1417   }
1418
1419   uint64_t n_pages = 0;
1420   uint64_t r_pages = 0;
1421   int n_spans = 0;
1422   int r_spans = 0;
1423   out->printf("Normal large spans:\n");
1424   for (Span* s = large_.normal.next; s != &large_.normal; s = s->next) {
1425     out->printf("   [ %6" PRIuS " pages ] %6.1f MB\n",
1426                 s->length, PagesToMB(s->length));
1427     n_pages += s->length;
1428     n_spans++;
1429   }
1430   out->printf("Unmapped large spans:\n");
1431   for (Span* s = large_.returned.next; s != &large_.returned; s = s->next) {
1432     out->printf("   [ %6" PRIuS " pages ] %6.1f MB\n",
1433                 s->length, PagesToMB(s->length));
1434     r_pages += s->length;
1435     r_spans++;
1436   }
1437   total_normal += n_pages;
1438   total_returned += r_pages;
1439   out->printf(">255   large * %6u spans ~ %6.1f MB; %6.1f MB cum"
1440               "; unmapped: %6.1f MB; %6.1f MB cum\n",
1441               (n_spans + r_spans),
1442               PagesToMB(n_pages + r_pages),
1443               PagesToMB(total_normal + total_returned),
1444               PagesToMB(r_pages),
1445               PagesToMB(total_returned));
1446 }
1447 #endif
1448
1449 bool TCMalloc_PageHeap::GrowHeap(Length n) {
1450   ASSERT(kMaxPages >= kMinSystemAlloc);
1451   if (n > kMaxValidPages) return false;
1452   Length ask = (n>kMinSystemAlloc) ? n : static_cast<Length>(kMinSystemAlloc);
1453   size_t actual_size;
1454   void* ptr = TCMalloc_SystemAlloc(ask << kPageShift, &actual_size, kPageSize);
1455   if (ptr == NULL) {
1456     if (n < ask) {
1457       // Try growing just "n" pages
1458       ask = n;
1459       ptr = TCMalloc_SystemAlloc(ask << kPageShift, &actual_size, kPageSize);;
1460     }
1461     if (ptr == NULL) return false;
1462   }
1463   ask = actual_size >> kPageShift;
1464
1465   uint64_t old_system_bytes = system_bytes_;
1466   system_bytes_ += (ask << kPageShift);
1467   const PageID p = reinterpret_cast<uintptr_t>(ptr) >> kPageShift;
1468   ASSERT(p > 0);
1469
1470   // If we have already a lot of pages allocated, just pre allocate a bunch of
1471   // memory for the page map. This prevents fragmentation by pagemap metadata
1472   // when a program keeps allocating and freeing large blocks.
1473
1474   if (old_system_bytes < kPageMapBigAllocationThreshold
1475       && system_bytes_ >= kPageMapBigAllocationThreshold) {
1476     pagemap_.PreallocateMoreMemory();
1477   }
1478
1479   // Make sure pagemap_ has entries for all of the new pages.
1480   // Plus ensure one before and one after so coalescing code
1481   // does not need bounds-checking.
1482   if (pagemap_.Ensure(p-1, ask+2)) {
1483     // Pretend the new area is allocated and then Delete() it to
1484     // cause any necessary coalescing to occur.
1485     //
1486     // We do not adjust free_pages_ here since Delete() will do it for us.
1487     Span* span = NewSpan(p, ask);
1488     RecordSpan(span);
1489     Delete(span);
1490     ASSERT(Check());
1491     return true;
1492   } else {
1493     // We could not allocate memory within "pagemap_"
1494     // TODO: Once we can return memory to the system, return the new span
1495     return false;
1496   }
1497 }
1498
1499 bool TCMalloc_PageHeap::Check() {
1500   ASSERT(free_[0].normal.next == &free_[0].normal);
1501   ASSERT(free_[0].returned.next == &free_[0].returned);
1502   CheckList(&large_.normal, kMaxPages, 1000000000);
1503   CheckList(&large_.returned, kMaxPages, 1000000000);
1504   for (Length s = 1; s < kMaxPages; s++) {
1505     CheckList(&free_[s].normal, s, s);
1506     CheckList(&free_[s].returned, s, s);
1507   }
1508   return true;
1509 }
1510
1511 #if ASSERT_DISABLED
1512 bool TCMalloc_PageHeap::CheckList(Span*, Length, Length) {
1513   return true;
1514 }
1515 #else
1516 bool TCMalloc_PageHeap::CheckList(Span* list, Length min_pages, Length max_pages) {
1517   for (Span* s = list->next; s != list; s = s->next) {
1518     CHECK_CONDITION(s->free);
1519     CHECK_CONDITION(s->length >= min_pages);
1520     CHECK_CONDITION(s->length <= max_pages);
1521     CHECK_CONDITION(GetDescriptor(s->start) == s);
1522     CHECK_CONDITION(GetDescriptor(s->start+s->length-1) == s);
1523   }
1524   return true;
1525 }
1526 #endif
1527
1528 static void ReleaseFreeList(Span* list, Span* returned) {
1529   // Walk backwards through list so that when we push these
1530   // spans on the "returned" list, we preserve the order.
1531   while (!DLL_IsEmpty(list)) {
1532     Span* s = list->prev;
1533     DLL_Remove(s);
1534     DLL_Prepend(returned, s);
1535     TCMalloc_SystemRelease(reinterpret_cast<void*>(s->start << kPageShift),
1536                            static_cast<size_t>(s->length << kPageShift));
1537   }
1538 }
1539
1540 void TCMalloc_PageHeap::ReleaseFreePages() {
1541   for (Length s = 0; s < kMaxPages; s++) {
1542     ReleaseFreeList(&free_[s].normal, &free_[s].returned);
1543   }
1544   ReleaseFreeList(&large_.normal, &large_.returned);
1545   ASSERT(Check());
1546 }
1547
1548 //-------------------------------------------------------------------
1549 // Free list
1550 //-------------------------------------------------------------------
1551
1552 class TCMalloc_ThreadCache_FreeList {
1553  private:
1554   void*    list_;       // Linked list of nodes
1555   uint16_t length_;     // Current length
1556   uint16_t lowater_;    // Low water mark for list length
1557
1558  public:
1559   void Init() {
1560     list_ = NULL;
1561     length_ = 0;
1562     lowater_ = 0;
1563   }
1564
1565   // Return current length of list
1566   int length() const {
1567     return length_;
1568   }
1569
1570   // Is list empty?
1571   bool empty() const {
1572     return list_ == NULL;
1573   }
1574
1575   // Low-water mark management
1576   int lowwatermark() const { return lowater_; }
1577   void clear_lowwatermark() { lowater_ = length_; }
1578
1579   ALWAYS_INLINE void Push(void* ptr) {
1580     SLL_Push(&list_, ptr);
1581     length_++;
1582   }
1583
1584   void PushRange(int N, void *start, void *end) {
1585     SLL_PushRange(&list_, start, end);
1586     length_ = length_ + static_cast<uint16_t>(N);
1587   }
1588
1589   void PopRange(int N, void **start, void **end) {
1590     SLL_PopRange(&list_, N, start, end);
1591     ASSERT(length_ >= N);
1592     length_ = length_ - static_cast<uint16_t>(N);
1593     if (length_ < lowater_) lowater_ = length_;
1594   }
1595
1596   ALWAYS_INLINE void* Pop() {
1597     ASSERT(list_ != NULL);
1598     length_--;
1599     if (length_ < lowater_) lowater_ = length_;
1600     return SLL_Pop(&list_);
1601   }
1602
1603 #ifdef WTF_CHANGES
1604   template <class Finder, class Reader>
1605   void enumerateFreeObjects(Finder& finder, const Reader& reader)
1606   {
1607       for (void* nextObject = list_; nextObject; nextObject = *reader(reinterpret_cast<void**>(nextObject)))
1608           finder.visit(nextObject);
1609   }
1610 #endif
1611 };
1612
1613 //-------------------------------------------------------------------
1614 // Data kept per thread
1615 //-------------------------------------------------------------------
1616
1617 class TCMalloc_ThreadCache {
1618  private:
1619   typedef TCMalloc_ThreadCache_FreeList FreeList;
1620 #if COMPILER(MSVC)
1621   typedef DWORD ThreadIdentifier;
1622 #else
1623   typedef pthread_t ThreadIdentifier;
1624 #endif
1625
1626   size_t        size_;                  // Combined size of data
1627   ThreadIdentifier tid_;                // Which thread owns it
1628   bool          in_setspecific_;           // Called pthread_setspecific?
1629   FreeList      list_[kNumClasses];     // Array indexed by size-class
1630
1631   // We sample allocations, biased by the size of the allocation
1632   uint32_t      rnd_;                   // Cheap random number generator
1633   size_t        bytes_until_sample_;    // Bytes until we sample next
1634
1635   // Allocate a new heap. REQUIRES: pageheap_lock is held.
1636   static inline TCMalloc_ThreadCache* NewHeap(ThreadIdentifier tid);
1637
1638   // Use only as pthread thread-specific destructor function.
1639   static void DestroyThreadCache(void* ptr);
1640  public:
1641   // All ThreadCache objects are kept in a linked list (for stats collection)
1642   TCMalloc_ThreadCache* next_;
1643   TCMalloc_ThreadCache* prev_;
1644
1645   void Init(ThreadIdentifier tid);
1646   void Cleanup();
1647
1648   // Accessors (mostly just for printing stats)
1649   int freelist_length(size_t cl) const { return list_[cl].length(); }
1650
1651   // Total byte size in cache
1652   size_t Size() const { return size_; }
1653
1654   void* Allocate(size_t size);
1655   void Deallocate(void* ptr, size_t size_class);
1656
1657   void FetchFromCentralCache(size_t cl, size_t allocationSize);
1658   void ReleaseToCentralCache(size_t cl, int N);
1659   void Scavenge();
1660   void Print() const;
1661
1662   // Record allocation of "k" bytes.  Return true iff allocation
1663   // should be sampled
1664   bool SampleAllocation(size_t k);
1665
1666   // Pick next sampling point
1667   void PickNextSample(size_t k);
1668
1669   static void                  InitModule();
1670   static void                  InitTSD();
1671   static TCMalloc_ThreadCache* GetThreadHeap();
1672   static TCMalloc_ThreadCache* GetCache();
1673   static TCMalloc_ThreadCache* GetCacheIfPresent();
1674   static TCMalloc_ThreadCache* CreateCacheIfNecessary();
1675   static void                  DeleteCache(TCMalloc_ThreadCache* heap);
1676   static void                  BecomeIdle();
1677   static void                  RecomputeThreadCacheSize();
1678
1679 #ifdef WTF_CHANGES
1680   template <class Finder, class Reader>
1681   void enumerateFreeObjects(Finder& finder, const Reader& reader)
1682   {
1683       for (unsigned sizeClass = 0; sizeClass < kNumClasses; sizeClass++)
1684           list_[sizeClass].enumerateFreeObjects(finder, reader);
1685   }
1686 #endif
1687 };
1688
1689 //-------------------------------------------------------------------
1690 // Data kept per size-class in central cache
1691 //-------------------------------------------------------------------
1692
1693 class TCMalloc_Central_FreeList {
1694  public:
1695   void Init(size_t cl);
1696
1697   // These methods all do internal locking.
1698
1699   // Insert the specified range into the central freelist.  N is the number of
1700   // elements in the range.
1701   void InsertRange(void *start, void *end, int N);
1702
1703   // Returns the actual number of fetched elements into N.
1704   void RemoveRange(void **start, void **end, int *N);
1705
1706   // Returns the number of free objects in cache.
1707   size_t length() {
1708     SpinLockHolder h(&lock_);
1709     return counter_;
1710   }
1711
1712   // Returns the number of free objects in the transfer cache.
1713   int tc_length() {
1714     SpinLockHolder h(&lock_);
1715     return used_slots_ * num_objects_to_move[size_class_];
1716   }
1717
1718 #ifdef WTF_CHANGES
1719   template <class Finder, class Reader>
1720   void enumerateFreeObjects(Finder& finder, const Reader& reader)
1721   {
1722     for (Span* span = &empty_; span && span != &empty_; span = (span->next ? reader(span->next) : 0))
1723       ASSERT(!span->objects);
1724
1725     ASSERT(!nonempty_.objects);
1726     for (Span* span = reader(nonempty_.next); span && span != &nonempty_; span = (span->next ? reader(span->next) : 0)) {
1727       for (void* nextObject = span->objects; nextObject; nextObject = *reader(reinterpret_cast<void**>(nextObject)))
1728         finder.visit(nextObject);
1729     }
1730   }
1731 #endif
1732
1733  private:
1734   // REQUIRES: lock_ is held
1735   // Remove object from cache and return.
1736   // Return NULL if no free entries in cache.
1737   void* FetchFromSpans();
1738
1739   // REQUIRES: lock_ is held
1740   // Remove object from cache and return.  Fetches
1741   // from pageheap if cache is empty.  Only returns
1742   // NULL on allocation failure.
1743   void* FetchFromSpansSafe();
1744
1745   // REQUIRES: lock_ is held
1746   // Release a linked list of objects to spans.
1747   // May temporarily release lock_.
1748   void ReleaseListToSpans(void *start);
1749
1750   // REQUIRES: lock_ is held
1751   // Release an object to spans.
1752   // May temporarily release lock_.
1753   void ReleaseToSpans(void* object);
1754
1755   // REQUIRES: lock_ is held
1756   // Populate cache by fetching from the page heap.
1757   // May temporarily release lock_.
1758   void Populate();
1759
1760   // REQUIRES: lock is held.
1761   // Tries to make room for a TCEntry.  If the cache is full it will try to
1762   // expand it at the cost of some other cache size.  Return false if there is
1763   // no space.
1764   bool MakeCacheSpace();
1765
1766   // REQUIRES: lock_ for locked_size_class is held.
1767   // Picks a "random" size class to steal TCEntry slot from.  In reality it
1768   // just iterates over the sizeclasses but does so without taking a lock.
1769   // Returns true on success.
1770   // May temporarily lock a "random" size class.
1771   static bool EvictRandomSizeClass(size_t locked_size_class, bool force);
1772
1773   // REQUIRES: lock_ is *not* held.
1774   // Tries to shrink the Cache.  If force is true it will relase objects to
1775   // spans if it allows it to shrink the cache.  Return false if it failed to
1776   // shrink the cache.  Decrements cache_size_ on succeess.
1777   // May temporarily take lock_.  If it takes lock_, the locked_size_class
1778   // lock is released to the thread from holding two size class locks
1779   // concurrently which could lead to a deadlock.
1780   bool ShrinkCache(int locked_size_class, bool force);
1781
1782   // This lock protects all the data members.  cached_entries and cache_size_
1783   // may be looked at without holding the lock.
1784   SpinLock lock_;
1785
1786   // We keep linked lists of empty and non-empty spans.
1787   size_t   size_class_;     // My size class
1788   Span     empty_;          // Dummy header for list of empty spans
1789   Span     nonempty_;       // Dummy header for list of non-empty spans
1790   size_t   counter_;        // Number of free objects in cache entry
1791
1792   // Here we reserve space for TCEntry cache slots.  Since one size class can
1793   // end up getting all the TCEntries quota in the system we just preallocate
1794   // sufficient number of entries here.
1795   TCEntry tc_slots_[kNumTransferEntries];
1796
1797   // Number of currently used cached entries in tc_slots_.  This variable is
1798   // updated under a lock but can be read without one.
1799   int32_t used_slots_;
1800   // The current number of slots for this size class.  This is an
1801   // adaptive value that is increased if there is lots of traffic
1802   // on a given size class.
1803   int32_t cache_size_;
1804 };
1805
1806 // Pad each CentralCache object to multiple of 64 bytes
1807 class TCMalloc_Central_FreeListPadded : public TCMalloc_Central_FreeList {
1808  private:
1809   char pad_[(64 - (sizeof(TCMalloc_Central_FreeList) % 64)) % 64];
1810 };
1811
1812 //-------------------------------------------------------------------
1813 // Global variables
1814 //-------------------------------------------------------------------
1815
1816 // Central cache -- a collection of free-lists, one per size-class.
1817 // We have a separate lock per free-list to reduce contention.
1818 static TCMalloc_Central_FreeListPadded central_cache[kNumClasses];
1819
1820 // Page-level allocator
1821 static SpinLock pageheap_lock = SPINLOCK_INITIALIZER;
1822 static void* pageheap_memory[(sizeof(TCMalloc_PageHeap) + sizeof(void*) - 1) / sizeof(void*)];
1823 static bool phinited = false;
1824
1825 // Avoid extra level of indirection by making "pageheap" be just an alias
1826 // of pageheap_memory.
1827 typedef union {
1828     void* m_memory;
1829     TCMalloc_PageHeap* m_pageHeap;
1830 } PageHeapUnion;
1831
1832 static inline TCMalloc_PageHeap* getPageHeap()
1833 {
1834     PageHeapUnion u = { &pageheap_memory[0] };
1835     return u.m_pageHeap;
1836 }
1837
1838 #define pageheap getPageHeap()
1839
1840 // If TLS is available, we also store a copy
1841 // of the per-thread object in a __thread variable
1842 // since __thread variables are faster to read
1843 // than pthread_getspecific().  We still need
1844 // pthread_setspecific() because __thread
1845 // variables provide no way to run cleanup
1846 // code when a thread is destroyed.
1847 #ifdef HAVE_TLS
1848 static __thread TCMalloc_ThreadCache *threadlocal_heap;
1849 #endif
1850 // Thread-specific key.  Initialization here is somewhat tricky
1851 // because some Linux startup code invokes malloc() before it
1852 // is in a good enough state to handle pthread_keycreate().
1853 // Therefore, we use TSD keys only after tsd_inited is set to true.
1854 // Until then, we use a slow path to get the heap object.
1855 static bool tsd_inited = false;
1856 static pthread_key_t heap_key;
1857 #if COMPILER(MSVC)
1858 DWORD tlsIndex = TLS_OUT_OF_INDEXES;
1859 #endif
1860
1861 static ALWAYS_INLINE void setThreadHeap(TCMalloc_ThreadCache* heap)
1862 {
1863     // still do pthread_setspecific when using MSVC fast TLS to
1864     // benefit from the delete callback.
1865     pthread_setspecific(heap_key, heap);
1866 #if COMPILER(MSVC)
1867     TlsSetValue(tlsIndex, heap);
1868 #endif
1869 }
1870
1871 // Allocator for thread heaps
1872 static PageHeapAllocator<TCMalloc_ThreadCache> threadheap_allocator;
1873
1874 // Linked list of heap objects.  Protected by pageheap_lock.
1875 static TCMalloc_ThreadCache* thread_heaps = NULL;
1876 static int thread_heap_count = 0;
1877
1878 // Overall thread cache size.  Protected by pageheap_lock.
1879 static size_t overall_thread_cache_size = kDefaultOverallThreadCacheSize;
1880
1881 // Global per-thread cache size.  Writes are protected by
1882 // pageheap_lock.  Reads are done without any locking, which should be
1883 // fine as long as size_t can be written atomically and we don't place
1884 // invariants between this variable and other pieces of state.
1885 static volatile size_t per_thread_cache_size = kMaxThreadCacheSize;
1886
1887 //-------------------------------------------------------------------
1888 // Central cache implementation
1889 //-------------------------------------------------------------------
1890
1891 void TCMalloc_Central_FreeList::Init(size_t cl) {
1892   lock_.Init();
1893   size_class_ = cl;
1894   DLL_Init(&empty_);
1895   DLL_Init(&nonempty_);
1896   counter_ = 0;
1897
1898   cache_size_ = 1;
1899   used_slots_ = 0;
1900   ASSERT(cache_size_ <= kNumTransferEntries);
1901 }
1902
1903 void TCMalloc_Central_FreeList::ReleaseListToSpans(void* start) {
1904   while (start) {
1905     void *next = SLL_Next(start);
1906     ReleaseToSpans(start);
1907     start = next;
1908   }
1909 }
1910
1911 ALWAYS_INLINE void TCMalloc_Central_FreeList::ReleaseToSpans(void* object) {
1912   const PageID p = reinterpret_cast<uintptr_t>(object) >> kPageShift;
1913   Span* span = pageheap->GetDescriptor(p);
1914   ASSERT(span != NULL);
1915   ASSERT(span->refcount > 0);
1916
1917   // If span is empty, move it to non-empty list
1918   if (span->objects == NULL) {
1919     DLL_Remove(span);
1920     DLL_Prepend(&nonempty_, span);
1921     Event(span, 'N', 0);
1922   }
1923
1924   // The following check is expensive, so it is disabled by default
1925   if (false) {
1926     // Check that object does not occur in list
1927     int got = 0;
1928     for (void* p = span->objects; p != NULL; p = *((void**) p)) {
1929       ASSERT(p != object);
1930       got++;
1931     }
1932     ASSERT(got + span->refcount ==
1933            (span->length<<kPageShift)/ByteSizeForClass(span->sizeclass));
1934   }
1935
1936   counter_++;
1937   span->refcount--;
1938   if (span->refcount == 0) {
1939     Event(span, '#', 0);
1940     counter_ -= (span->length<<kPageShift) / ByteSizeForClass(span->sizeclass);
1941     DLL_Remove(span);
1942
1943     // Release central list lock while operating on pageheap
1944     lock_.Unlock();
1945     {
1946       SpinLockHolder h(&pageheap_lock);
1947       pageheap->Delete(span);
1948     }
1949     lock_.Lock();
1950   } else {
1951     *(reinterpret_cast<void**>(object)) = span->objects;
1952     span->objects = object;
1953   }
1954 }
1955
1956 ALWAYS_INLINE bool TCMalloc_Central_FreeList::EvictRandomSizeClass(
1957     size_t locked_size_class, bool force) {
1958   static int race_counter = 0;
1959   int t = race_counter++;  // Updated without a lock, but who cares.
1960   if (t >= static_cast<int>(kNumClasses)) {
1961     while (t >= static_cast<int>(kNumClasses)) {
1962       t -= kNumClasses;
1963     }
1964     race_counter = t;
1965   }
1966   ASSERT(t >= 0);
1967   ASSERT(t < static_cast<int>(kNumClasses));
1968   if (t == static_cast<int>(locked_size_class)) return false;
1969   return central_cache[t].ShrinkCache(static_cast<int>(locked_size_class), force);
1970 }
1971
1972 bool TCMalloc_Central_FreeList::MakeCacheSpace() {
1973   // Is there room in the cache?
1974   if (used_slots_ < cache_size_) return true;
1975   // Check if we can expand this cache?
1976   if (cache_size_ == kNumTransferEntries) return false;
1977   // Ok, we'll try to grab an entry from some other size class.
1978   if (EvictRandomSizeClass(size_class_, false) ||
1979       EvictRandomSizeClass(size_class_, true)) {
1980     // Succeeded in evicting, we're going to make our cache larger.
1981     cache_size_++;
1982     return true;
1983   }
1984   return false;
1985 }
1986
1987
1988 namespace {
1989 class LockInverter {
1990  private:
1991   SpinLock *held_, *temp_;
1992  public:
1993   inline explicit LockInverter(SpinLock* held, SpinLock *temp)
1994     : held_(held), temp_(temp) { held_->Unlock(); temp_->Lock(); }
1995   inline ~LockInverter() { temp_->Unlock(); held_->Lock();  }
1996 };
1997 }
1998
1999 bool TCMalloc_Central_FreeList::ShrinkCache(int locked_size_class, bool force) {
2000   // Start with a quick check without taking a lock.
2001   if (cache_size_ == 0) return false;
2002   // We don't evict from a full cache unless we are 'forcing'.
2003   if (force == false && used_slots_ == cache_size_) return false;
2004
2005   // Grab lock, but first release the other lock held by this thread.  We use
2006   // the lock inverter to ensure that we never hold two size class locks
2007   // concurrently.  That can create a deadlock because there is no well
2008   // defined nesting order.
2009   LockInverter li(&central_cache[locked_size_class].lock_, &lock_);
2010   ASSERT(used_slots_ <= cache_size_);
2011   ASSERT(0 <= cache_size_);
2012   if (cache_size_ == 0) return false;
2013   if (used_slots_ == cache_size_) {
2014     if (force == false) return false;
2015     // ReleaseListToSpans releases the lock, so we have to make all the
2016     // updates to the central list before calling it.
2017     cache_size_--;
2018     used_slots_--;
2019     ReleaseListToSpans(tc_slots_[used_slots_].head);
2020     return true;
2021   }
2022   cache_size_--;
2023   return true;
2024 }
2025
2026 void TCMalloc_Central_FreeList::InsertRange(void *start, void *end, int N) {
2027   SpinLockHolder h(&lock_);
2028   if (N == num_objects_to_move[size_class_] &&
2029     MakeCacheSpace()) {
2030     int slot = used_slots_++;
2031     ASSERT(slot >=0);
2032     ASSERT(slot < kNumTransferEntries);
2033     TCEntry *entry = &tc_slots_[slot];
2034     entry->head = start;
2035     entry->tail = end;
2036     return;
2037   }
2038   ReleaseListToSpans(start);
2039 }
2040
2041 void TCMalloc_Central_FreeList::RemoveRange(void **start, void **end, int *N) {
2042   int num = *N;
2043   ASSERT(num > 0);
2044
2045   SpinLockHolder h(&lock_);
2046   if (num == num_objects_to_move[size_class_] && used_slots_ > 0) {
2047     int slot = --used_slots_;
2048     ASSERT(slot >= 0);
2049     TCEntry *entry = &tc_slots_[slot];
2050     *start = entry->head;
2051     *end = entry->tail;
2052     return;
2053   }
2054
2055   // TODO: Prefetch multiple TCEntries?
2056   void *tail = FetchFromSpansSafe();
2057   if (!tail) {
2058     // We are completely out of memory.
2059     *start = *end = NULL;
2060     *N = 0;
2061     return;
2062   }
2063
2064   SLL_SetNext(tail, NULL);
2065   void *head = tail;
2066   int count = 1;
2067   while (count < num) {
2068     void *t = FetchFromSpans();
2069     if (!t) break;
2070     SLL_Push(&head, t);
2071     count++;
2072   }
2073   *start = head;
2074   *end = tail;
2075   *N = count;
2076 }
2077
2078
2079 void* TCMalloc_Central_FreeList::FetchFromSpansSafe() {
2080   void *t = FetchFromSpans();
2081   if (!t) {
2082     Populate();
2083     t = FetchFromSpans();
2084   }
2085   return t;
2086 }
2087
2088 void* TCMalloc_Central_FreeList::FetchFromSpans() {
2089   if (DLL_IsEmpty(&nonempty_)) return NULL;
2090   Span* span = nonempty_.next;
2091
2092   ASSERT(span->objects != NULL);
2093   span->refcount++;
2094   void* result = span->objects;
2095   span->objects = *(reinterpret_cast<void**>(result));
2096   if (span->objects == NULL) {
2097     // Move to empty list
2098     DLL_Remove(span);
2099     DLL_Prepend(&empty_, span);
2100     Event(span, 'E', 0);
2101   }
2102   counter_--;
2103   return result;
2104 }
2105
2106 // Fetch memory from the system and add to the central cache freelist.
2107 ALWAYS_INLINE void TCMalloc_Central_FreeList::Populate() {
2108   // Release central list lock while operating on pageheap
2109   lock_.Unlock();
2110   const size_t npages = class_to_pages[size_class_];
2111
2112   Span* span;
2113   {
2114     SpinLockHolder h(&pageheap_lock);
2115     span = pageheap->New(npages);
2116     if (span) pageheap->RegisterSizeClass(span, size_class_);
2117   }
2118   if (span == NULL) {
2119     MESSAGE("allocation failed: %d\n", errno);
2120     lock_.Lock();
2121     return;
2122   }
2123   ASSERT(span->length == npages);
2124   // Cache sizeclass info eagerly.  Locking is not necessary.
2125   // (Instead of being eager, we could just replace any stale info
2126   // about this span, but that seems to be no better in practice.)
2127   for (size_t i = 0; i < npages; i++) {
2128     pageheap->CacheSizeClass(span->start + i, size_class_);
2129   }
2130
2131   // Split the block into pieces and add to the free-list
2132   // TODO: coloring of objects to avoid cache conflicts?
2133   void** tail = &span->objects;
2134   char* ptr = reinterpret_cast<char*>(span->start << kPageShift);
2135   char* limit = ptr + (npages << kPageShift);
2136   const size_t size = ByteSizeForClass(size_class_);
2137   int num = 0;
2138   char* nptr;
2139   while ((nptr = ptr + size) <= limit) {
2140     *tail = ptr;
2141     tail = reinterpret_cast<void**>(ptr);
2142     ptr = nptr;
2143     num++;
2144   }
2145   ASSERT(ptr <= limit);
2146   *tail = NULL;
2147   span->refcount = 0; // No sub-object in use yet
2148
2149   // Add span to list of non-empty spans
2150   lock_.Lock();
2151   DLL_Prepend(&nonempty_, span);
2152   counter_ += num;
2153 }
2154
2155 //-------------------------------------------------------------------
2156 // TCMalloc_ThreadCache implementation
2157 //-------------------------------------------------------------------
2158
2159 inline bool TCMalloc_ThreadCache::SampleAllocation(size_t k) {
2160   if (bytes_until_sample_ < k) {
2161     PickNextSample(k);
2162     return true;
2163   } else {
2164     bytes_until_sample_ -= k;
2165     return false;
2166   }
2167 }
2168
2169 void TCMalloc_ThreadCache::Init(ThreadIdentifier tid) {
2170   size_ = 0;
2171   next_ = NULL;
2172   prev_ = NULL;
2173   tid_  = tid;
2174   in_setspecific_ = false;
2175   for (size_t cl = 0; cl < kNumClasses; ++cl) {
2176     list_[cl].Init();
2177   }
2178
2179   // Initialize RNG -- run it for a bit to get to good values
2180   bytes_until_sample_ = 0;
2181   rnd_ = static_cast<uint32_t>(reinterpret_cast<uintptr_t>(this));
2182   for (int i = 0; i < 100; i++) {
2183     PickNextSample(static_cast<size_t>(FLAGS_tcmalloc_sample_parameter * 2));
2184   }
2185 }
2186
2187 void TCMalloc_ThreadCache::Cleanup() {
2188   // Put unused memory back into central cache
2189   for (size_t cl = 0; cl < kNumClasses; ++cl) {
2190     if (list_[cl].length() > 0) {
2191       ReleaseToCentralCache(cl, list_[cl].length());
2192     }
2193   }
2194 }
2195
2196 ALWAYS_INLINE void* TCMalloc_ThreadCache::Allocate(size_t size) {
2197   ASSERT(size <= kMaxSize);
2198   const size_t cl = SizeClass(size);
2199   FreeList* list = &list_[cl];
2200   size_t allocationSize = ByteSizeForClass(cl);
2201   if (list->empty()) {
2202     FetchFromCentralCache(cl, allocationSize);
2203     if (list->empty()) return NULL;
2204   }
2205   size_ -= allocationSize;
2206   return list->Pop();
2207 }
2208
2209 inline void TCMalloc_ThreadCache::Deallocate(void* ptr, size_t cl) {
2210   size_ += ByteSizeForClass(cl);
2211   FreeList* list = &list_[cl];
2212   list->Push(ptr);
2213   // If enough data is free, put back into central cache
2214   if (list->length() > kMaxFreeListLength) {
2215     ReleaseToCentralCache(cl, num_objects_to_move[cl]);
2216   }
2217   if (size_ >= per_thread_cache_size) Scavenge();
2218 }
2219
2220 // Remove some objects of class "cl" from central cache and add to thread heap
2221 ALWAYS_INLINE void TCMalloc_ThreadCache::FetchFromCentralCache(size_t cl, size_t allocationSize) {
2222   int fetch_count = num_objects_to_move[cl];
2223   void *start, *end;
2224   central_cache[cl].RemoveRange(&start, &end, &fetch_count);
2225   list_[cl].PushRange(fetch_count, start, end);
2226   size_ += allocationSize * fetch_count;
2227 }
2228
2229 // Remove some objects of class "cl" from thread heap and add to central cache
2230 inline void TCMalloc_ThreadCache::ReleaseToCentralCache(size_t cl, int N) {
2231   ASSERT(N > 0);
2232   FreeList* src = &list_[cl];
2233   if (N > src->length()) N = src->length();
2234   size_ -= N*ByteSizeForClass(cl);
2235
2236   // We return prepackaged chains of the correct size to the central cache.
2237   // TODO: Use the same format internally in the thread caches?
2238   int batch_size = num_objects_to_move[cl];
2239   while (N > batch_size) {
2240     void *tail, *head;
2241     src->PopRange(batch_size, &head, &tail);
2242     central_cache[cl].InsertRange(head, tail, batch_size);
2243     N -= batch_size;
2244   }
2245   void *tail, *head;
2246   src->PopRange(N, &head, &tail);
2247   central_cache[cl].InsertRange(head, tail, N);
2248 }
2249
2250 // Release idle memory to the central cache
2251 inline void TCMalloc_ThreadCache::Scavenge() {
2252   // If the low-water mark for the free list is L, it means we would
2253   // not have had to allocate anything from the central cache even if
2254   // we had reduced the free list size by L.  We aim to get closer to
2255   // that situation by dropping L/2 nodes from the free list.  This
2256   // may not release much memory, but if so we will call scavenge again
2257   // pretty soon and the low-water marks will be high on that call.
2258   //int64 start = CycleClock::Now();
2259
2260   for (size_t cl = 0; cl < kNumClasses; cl++) {
2261     FreeList* list = &list_[cl];
2262     const int lowmark = list->lowwatermark();
2263     if (lowmark > 0) {
2264       const int drop = (lowmark > 1) ? lowmark/2 : 1;
2265       ReleaseToCentralCache(cl, drop);
2266     }
2267     list->clear_lowwatermark();
2268   }
2269
2270   //int64 finish = CycleClock::Now();
2271   //CycleTimer ct;
2272   //MESSAGE("GC: %.0f ns\n", ct.CyclesToUsec(finish-start)*1000.0);
2273 }
2274
2275 void TCMalloc_ThreadCache::PickNextSample(size_t k) {
2276   // Make next "random" number
2277   // x^32+x^22+x^2+x^1+1 is a primitive polynomial for random numbers
2278   static const uint32_t kPoly = (1 << 22) | (1 << 2) | (1 << 1) | (1 << 0);
2279   uint32_t r = rnd_;
2280   rnd_ = (r << 1) ^ ((static_cast<int32_t>(r) >> 31) & kPoly);
2281
2282   // Next point is "rnd_ % (sample_period)".  I.e., average
2283   // increment is "sample_period/2".
2284   const int flag_value = static_cast<int>(FLAGS_tcmalloc_sample_parameter);
2285   static int last_flag_value = -1;
2286
2287   if (flag_value != last_flag_value) {
2288     SpinLockHolder h(&sample_period_lock);
2289     int i;
2290     for (i = 0; i < (static_cast<int>(sizeof(primes_list)/sizeof(primes_list[0])) - 1); i++) {
2291       if (primes_list[i] >= flag_value) {
2292         break;
2293       }
2294     }
2295     sample_period = primes_list[i];
2296     last_flag_value = flag_value;
2297   }
2298
2299   bytes_until_sample_ += rnd_ % sample_period;
2300
2301   if (k > (static_cast<size_t>(-1) >> 2)) {
2302     // If the user has asked for a huge allocation then it is possible
2303     // for the code below to loop infinitely.  Just return (note that
2304     // this throws off the sampling accuracy somewhat, but a user who
2305     // is allocating more than 1G of memory at a time can live with a
2306     // minor inaccuracy in profiling of small allocations, and also
2307     // would rather not wait for the loop below to terminate).
2308     return;
2309   }
2310
2311   while (bytes_until_sample_ < k) {
2312     // Increase bytes_until_sample_ by enough average sampling periods
2313     // (sample_period >> 1) to allow us to sample past the current
2314     // allocation.
2315     bytes_until_sample_ += (sample_period >> 1);
2316   }
2317
2318   bytes_until_sample_ -= k;
2319 }
2320
2321 void TCMalloc_ThreadCache::InitModule() {
2322   // There is a slight potential race here because of double-checked
2323   // locking idiom.  However, as long as the program does a small
2324   // allocation before switching to multi-threaded mode, we will be
2325   // fine.  We increase the chances of doing such a small allocation
2326   // by doing one in the constructor of the module_enter_exit_hook
2327   // object declared below.
2328   SpinLockHolder h(&pageheap_lock);
2329   if (!phinited) {
2330 #ifdef WTF_CHANGES
2331     InitTSD();
2332 #endif
2333     InitSizeClasses();
2334     threadheap_allocator.Init();
2335     span_allocator.Init();
2336     span_allocator.New(); // Reduce cache conflicts
2337     span_allocator.New(); // Reduce cache conflicts
2338     stacktrace_allocator.Init();
2339     DLL_Init(&sampled_objects);
2340     for (size_t i = 0; i < kNumClasses; ++i) {
2341       central_cache[i].Init(i);
2342     }
2343     pageheap->init();
2344     phinited = 1;
2345 #if defined(WTF_CHANGES) && PLATFORM(DARWIN)
2346     FastMallocZone::init();
2347 #endif
2348   }
2349 }
2350
2351 inline TCMalloc_ThreadCache* TCMalloc_ThreadCache::NewHeap(ThreadIdentifier tid) {
2352   // Create the heap and add it to the linked list
2353   TCMalloc_ThreadCache *heap = threadheap_allocator.New();
2354   heap->Init(tid);
2355   heap->next_ = thread_heaps;
2356   heap->prev_ = NULL;
2357   if (thread_heaps != NULL) thread_heaps->prev_ = heap;
2358   thread_heaps = heap;
2359   thread_heap_count++;
2360   RecomputeThreadCacheSize();
2361   return heap;
2362 }
2363
2364 inline TCMalloc_ThreadCache* TCMalloc_ThreadCache::GetThreadHeap() {
2365 #ifdef HAVE_TLS
2366     // __thread is faster, but only when the kernel supports it
2367   if (KernelSupportsTLS())
2368     return threadlocal_heap;
2369 #elif COMPILER(MSVC)
2370     return static_cast<TCMalloc_ThreadCache*>(TlsGetValue(tlsIndex));
2371 #else
2372     return static_cast<TCMalloc_ThreadCache*>(pthread_getspecific(heap_key));
2373 #endif
2374 }
2375
2376 inline TCMalloc_ThreadCache* TCMalloc_ThreadCache::GetCache() {
2377   TCMalloc_ThreadCache* ptr = NULL;
2378   if (!tsd_inited) {
2379     InitModule();
2380   } else {
2381     ptr = GetThreadHeap();
2382   }
2383   if (ptr == NULL) ptr = CreateCacheIfNecessary();
2384   return ptr;
2385 }
2386
2387 // In deletion paths, we do not try to create a thread-cache.  This is
2388 // because we may be in the thread destruction code and may have
2389 // already cleaned up the cache for this thread.
2390 inline TCMalloc_ThreadCache* TCMalloc_ThreadCache::GetCacheIfPresent() {
2391   if (!tsd_inited) return NULL;
2392   void* const p = GetThreadHeap();
2393   return reinterpret_cast<TCMalloc_ThreadCache*>(p);
2394 }
2395
2396 void TCMalloc_ThreadCache::InitTSD() {
2397   ASSERT(!tsd_inited);
2398   pthread_key_create(&heap_key, DestroyThreadCache);
2399 #if COMPILER(MSVC)
2400   tlsIndex = TlsAlloc();
2401 #endif
2402   tsd_inited = true;
2403     
2404 #if !COMPILER(MSVC)
2405   // We may have used a fake pthread_t for the main thread.  Fix it.
2406   pthread_t zero;
2407   memset(&zero, 0, sizeof(zero));
2408 #endif
2409 #ifndef WTF_CHANGES
2410   SpinLockHolder h(&pageheap_lock);
2411 #else
2412   ASSERT(pageheap_lock.IsHeld());
2413 #endif
2414   for (TCMalloc_ThreadCache* h = thread_heaps; h != NULL; h = h->next_) {
2415 #if COMPILER(MSVC)
2416     if (h->tid_ == 0) {
2417       h->tid_ = GetCurrentThreadId();
2418     }
2419 #else
2420     if (pthread_equal(h->tid_, zero)) {
2421       h->tid_ = pthread_self();
2422     }
2423 #endif
2424   }
2425 }
2426
2427 TCMalloc_ThreadCache* TCMalloc_ThreadCache::CreateCacheIfNecessary() {
2428   // Initialize per-thread data if necessary
2429   TCMalloc_ThreadCache* heap = NULL;
2430   {
2431     SpinLockHolder h(&pageheap_lock);
2432
2433 #if COMPILER(MSVC)
2434     DWORD me;
2435     if (!tsd_inited) {
2436       me = 0;
2437     } else {
2438       me = GetCurrentThreadId();
2439     }
2440 #else
2441     // Early on in glibc's life, we cannot even call pthread_self()
2442     pthread_t me;
2443     if (!tsd_inited) {
2444       memset(&me, 0, sizeof(me));
2445     } else {
2446       me = pthread_self();
2447     }
2448 #endif
2449
2450     // This may be a recursive malloc call from pthread_setspecific()
2451     // In that case, the heap for this thread has already been created
2452     // and added to the linked list.  So we search for that first.
2453     for (TCMalloc_ThreadCache* h = thread_heaps; h != NULL; h = h->next_) {
2454 #if COMPILER(MSVC)
2455       if (h->tid_ == me) {
2456 #else
2457       if (pthread_equal(h->tid_, me)) {
2458 #endif
2459         heap = h;
2460         break;
2461       }
2462     }
2463
2464     if (heap == NULL) heap = NewHeap(me);
2465   }
2466
2467   // We call pthread_setspecific() outside the lock because it may
2468   // call malloc() recursively.  The recursive call will never get
2469   // here again because it will find the already allocated heap in the
2470   // linked list of heaps.
2471   if (!heap->in_setspecific_ && tsd_inited) {
2472     heap->in_setspecific_ = true;
2473     setThreadHeap(heap);
2474   }
2475   return heap;
2476 }
2477
2478 void TCMalloc_ThreadCache::BecomeIdle() {
2479   if (!tsd_inited) return;              // No caches yet
2480   TCMalloc_ThreadCache* heap = GetThreadHeap();
2481   if (heap == NULL) return;             // No thread cache to remove
2482   if (heap->in_setspecific_) return;    // Do not disturb the active caller
2483
2484   heap->in_setspecific_ = true;
2485   pthread_setspecific(heap_key, NULL);
2486 #ifdef HAVE_TLS
2487   // Also update the copy in __thread
2488   threadlocal_heap = NULL;
2489 #endif
2490   heap->in_setspecific_ = false;
2491   if (GetThreadHeap() == heap) {
2492     // Somehow heap got reinstated by a recursive call to malloc
2493     // from pthread_setspecific.  We give up in this case.
2494     return;
2495   }
2496
2497   // We can now get rid of the heap
2498   DeleteCache(heap);
2499 }
2500
2501 void TCMalloc_ThreadCache::DestroyThreadCache(void* ptr) {
2502   // Note that "ptr" cannot be NULL since pthread promises not
2503   // to invoke the destructor on NULL values, but for safety,
2504   // we check anyway.
2505   if (ptr == NULL) return;
2506 #ifdef HAVE_TLS
2507   // Prevent fast path of GetThreadHeap() from returning heap.
2508   threadlocal_heap = NULL;
2509 #endif
2510   DeleteCache(reinterpret_cast<TCMalloc_ThreadCache*>(ptr));
2511 }
2512
2513 void TCMalloc_ThreadCache::DeleteCache(TCMalloc_ThreadCache* heap) {
2514   // Remove all memory from heap
2515   heap->Cleanup();
2516
2517   // Remove from linked list
2518   SpinLockHolder h(&pageheap_lock);
2519   if (heap->next_ != NULL) heap->next_->prev_ = heap->prev_;
2520   if (heap->prev_ != NULL) heap->prev_->next_ = heap->next_;
2521   if (thread_heaps == heap) thread_heaps = heap->next_;
2522   thread_heap_count--;
2523   RecomputeThreadCacheSize();
2524
2525   threadheap_allocator.Delete(heap);
2526 }
2527
2528 void TCMalloc_ThreadCache::RecomputeThreadCacheSize() {
2529   // Divide available space across threads
2530   int n = thread_heap_count > 0 ? thread_heap_count : 1;
2531   size_t space = overall_thread_cache_size / n;
2532
2533   // Limit to allowed range
2534   if (space < kMinThreadCacheSize) space = kMinThreadCacheSize;
2535   if (space > kMaxThreadCacheSize) space = kMaxThreadCacheSize;
2536
2537   per_thread_cache_size = space;
2538 }
2539
2540 void TCMalloc_ThreadCache::Print() const {
2541   for (size_t cl = 0; cl < kNumClasses; ++cl) {
2542     MESSAGE("      %5" PRIuS " : %4d len; %4d lo\n",
2543             ByteSizeForClass(cl),
2544             list_[cl].length(),
2545             list_[cl].lowwatermark());
2546   }
2547 }
2548
2549 // Extract interesting stats
2550 struct TCMallocStats {
2551   uint64_t system_bytes;        // Bytes alloced from system
2552   uint64_t thread_bytes;        // Bytes in thread caches
2553   uint64_t central_bytes;       // Bytes in central cache
2554   uint64_t transfer_bytes;      // Bytes in central transfer cache
2555   uint64_t pageheap_bytes;      // Bytes in page heap
2556   uint64_t metadata_bytes;      // Bytes alloced for metadata
2557 };
2558
2559 #ifndef WTF_CHANGES
2560 // Get stats into "r".  Also get per-size-class counts if class_count != NULL
2561 static void ExtractStats(TCMallocStats* r, uint64_t* class_count) {
2562   r->central_bytes = 0;
2563   r->transfer_bytes = 0;
2564   for (int cl = 0; cl < kNumClasses; ++cl) {
2565     const int length = central_cache[cl].length();
2566     const int tc_length = central_cache[cl].tc_length();
2567     r->central_bytes += static_cast<uint64_t>(ByteSizeForClass(cl)) * length;
2568     r->transfer_bytes +=
2569       static_cast<uint64_t>(ByteSizeForClass(cl)) * tc_length;
2570     if (class_count) class_count[cl] = length + tc_length;
2571   }
2572
2573   // Add stats from per-thread heaps
2574   r->thread_bytes = 0;
2575   { // scope
2576     SpinLockHolder h(&pageheap_lock);
2577     for (TCMalloc_ThreadCache* h = thread_heaps; h != NULL; h = h->next_) {
2578       r->thread_bytes += h->Size();
2579       if (class_count) {
2580         for (size_t cl = 0; cl < kNumClasses; ++cl) {
2581           class_count[cl] += h->freelist_length(cl);
2582         }
2583       }
2584     }
2585   }
2586
2587   { //scope
2588     SpinLockHolder h(&pageheap_lock);
2589     r->system_bytes = pageheap->SystemBytes();
2590     r->metadata_bytes = metadata_system_bytes;
2591     r->pageheap_bytes = pageheap->FreeBytes();
2592   }
2593 }
2594 #endif
2595
2596 #ifndef WTF_CHANGES
2597 // WRITE stats to "out"
2598 static void DumpStats(TCMalloc_Printer* out, int level) {
2599   TCMallocStats stats;
2600   uint64_t class_count[kNumClasses];
2601   ExtractStats(&stats, (level >= 2 ? class_count : NULL));
2602
2603   if (level >= 2) {
2604     out->printf("------------------------------------------------\n");
2605     uint64_t cumulative = 0;
2606     for (int cl = 0; cl < kNumClasses; ++cl) {
2607       if (class_count[cl] > 0) {
2608         uint64_t class_bytes = class_count[cl] * ByteSizeForClass(cl);
2609         cumulative += class_bytes;
2610         out->printf("class %3d [ %8" PRIuS " bytes ] : "
2611                 "%8" PRIu64 " objs; %5.1f MB; %5.1f cum MB\n",
2612                 cl, ByteSizeForClass(cl),
2613                 class_count[cl],
2614                 class_bytes / 1048576.0,
2615                 cumulative / 1048576.0);
2616       }
2617     }
2618
2619     SpinLockHolder h(&pageheap_lock);
2620     pageheap->Dump(out);
2621   }
2622
2623   const uint64_t bytes_in_use = stats.system_bytes
2624                                 - stats.pageheap_bytes
2625                                 - stats.central_bytes
2626                                 - stats.transfer_bytes
2627                                 - stats.thread_bytes;
2628
2629   out->printf("------------------------------------------------\n"
2630               "MALLOC: %12" PRIu64 " Heap size\n"
2631               "MALLOC: %12" PRIu64 " Bytes in use by application\n"
2632               "MALLOC: %12" PRIu64 " Bytes free in page heap\n"
2633               "MALLOC: %12" PRIu64 " Bytes free in central cache\n"
2634               "MALLOC: %12" PRIu64 " Bytes free in transfer cache\n"
2635               "MALLOC: %12" PRIu64 " Bytes free in thread caches\n"
2636               "MALLOC: %12" PRIu64 " Spans in use\n"
2637               "MALLOC: %12" PRIu64 " Thread heaps in use\n"
2638               "MALLOC: %12" PRIu64 " Metadata allocated\n"
2639               "------------------------------------------------\n",
2640               stats.system_bytes,
2641               bytes_in_use,
2642               stats.pageheap_bytes,
2643               stats.central_bytes,
2644               stats.transfer_bytes,
2645               stats.thread_bytes,
2646               uint64_t(span_allocator.inuse()),
2647               uint64_t(threadheap_allocator.inuse()),
2648               stats.metadata_bytes);
2649 }
2650
2651 static void PrintStats(int level) {
2652   const int kBufferSize = 16 << 10;
2653   char* buffer = new char[kBufferSize];
2654   TCMalloc_Printer printer(buffer, kBufferSize);
2655   DumpStats(&printer, level);
2656   write(STDERR_FILENO, buffer, strlen(buffer));
2657   delete[] buffer;
2658 }
2659
2660 static void** DumpStackTraces() {
2661   // Count how much space we need
2662   int needed_slots = 0;
2663   {
2664     SpinLockHolder h(&pageheap_lock);
2665     for (Span* s = sampled_objects.next; s != &sampled_objects; s = s->next) {
2666       StackTrace* stack = reinterpret_cast<StackTrace*>(s->objects);
2667       needed_slots += 3 + stack->depth;
2668     }
2669     needed_slots += 100;            // Slop in case sample grows
2670     needed_slots += needed_slots/8; // An extra 12.5% slop
2671   }
2672
2673   void** result = new void*[needed_slots];
2674   if (result == NULL) {
2675     MESSAGE("tcmalloc: could not allocate %d slots for stack traces\n",
2676             needed_slots);
2677     return NULL;
2678   }
2679
2680   SpinLockHolder h(&pageheap_lock);
2681   int used_slots = 0;
2682   for (Span* s = sampled_objects.next; s != &sampled_objects; s = s->next) {
2683     ASSERT(used_slots < needed_slots);  // Need to leave room for terminator
2684     StackTrace* stack = reinterpret_cast<StackTrace*>(s->objects);
2685     if (used_slots + 3 + stack->depth >= needed_slots) {
2686       // No more room
2687       break;
2688     }
2689
2690     result[used_slots+0] = reinterpret_cast<void*>(static_cast<uintptr_t>(1));
2691     result[used_slots+1] = reinterpret_cast<void*>(stack->size);
2692     result[used_slots+2] = reinterpret_cast<void*>(stack->depth);
2693     for (int d = 0; d < stack->depth; d++) {
2694       result[used_slots+3+d] = stack->stack[d];
2695     }
2696     used_slots += 3 + stack->depth;
2697   }
2698   result[used_slots] = reinterpret_cast<void*>(static_cast<uintptr_t>(0));
2699   return result;
2700 }
2701 #endif
2702
2703 #ifndef WTF_CHANGES
2704
2705 // TCMalloc's support for extra malloc interfaces
2706 class TCMallocImplementation : public MallocExtension {
2707  public:
2708   virtual void GetStats(char* buffer, int buffer_length) {
2709     ASSERT(buffer_length > 0);
2710     TCMalloc_Printer printer(buffer, buffer_length);
2711
2712     // Print level one stats unless lots of space is available
2713     if (buffer_length < 10000) {
2714       DumpStats(&printer, 1);
2715     } else {
2716       DumpStats(&printer, 2);
2717     }
2718   }
2719
2720   virtual void** ReadStackTraces() {
2721     return DumpStackTraces();
2722   }
2723
2724   virtual bool GetNumericProperty(const char* name, size_t* value) {
2725     ASSERT(name != NULL);
2726
2727     if (strcmp(name, "generic.current_allocated_bytes") == 0) {
2728       TCMallocStats stats;
2729       ExtractStats(&stats, NULL);
2730       *value = stats.system_bytes
2731                - stats.thread_bytes
2732                - stats.central_bytes
2733                - stats.pageheap_bytes;
2734       return true;
2735     }
2736
2737     if (strcmp(name, "generic.heap_size") == 0) {
2738       TCMallocStats stats;
2739       ExtractStats(&stats, NULL);
2740       *value = stats.system_bytes;
2741       return true;
2742     }
2743
2744     if (strcmp(name, "tcmalloc.slack_bytes") == 0) {
2745       // We assume that bytes in the page heap are not fragmented too
2746       // badly, and are therefore available for allocation.
2747       SpinLockHolder l(&pageheap_lock);
2748       *value = pageheap->FreeBytes();
2749       return true;
2750     }
2751
2752     if (strcmp(name, "tcmalloc.max_total_thread_cache_bytes") == 0) {
2753       SpinLockHolder l(&pageheap_lock);
2754       *value = overall_thread_cache_size;
2755       return true;
2756     }
2757
2758     if (strcmp(name, "tcmalloc.current_total_thread_cache_bytes") == 0) {
2759       TCMallocStats stats;
2760       ExtractStats(&stats, NULL);
2761       *value = stats.thread_bytes;
2762       return true;
2763     }
2764
2765     return false;
2766   }
2767
2768   virtual bool SetNumericProperty(const char* name, size_t value) {
2769     ASSERT(name != NULL);
2770
2771     if (strcmp(name, "tcmalloc.max_total_thread_cache_bytes") == 0) {
2772       // Clip the value to a reasonable range
2773       if (value < kMinThreadCacheSize) value = kMinThreadCacheSize;
2774       if (value > (1<<30)) value = (1<<30);     // Limit to 1GB
2775
2776       SpinLockHolder l(&pageheap_lock);
2777       overall_thread_cache_size = static_cast<size_t>(value);
2778       TCMalloc_ThreadCache::RecomputeThreadCacheSize();
2779       return true;
2780     }
2781
2782     return false;
2783   }
2784
2785   virtual void MarkThreadIdle() {
2786     TCMalloc_ThreadCache::BecomeIdle();
2787   }
2788
2789   virtual void ReleaseFreeMemory() {
2790     SpinLockHolder h(&pageheap_lock);
2791     pageheap->ReleaseFreePages();
2792   }
2793 };
2794 #endif
2795
2796 // The constructor allocates an object to ensure that initialization
2797 // runs before main(), and therefore we do not have a chance to become
2798 // multi-threaded before initialization.  We also create the TSD key
2799 // here.  Presumably by the time this constructor runs, glibc is in
2800 // good enough shape to handle pthread_key_create().
2801 //
2802 // The constructor also takes the opportunity to tell STL to use
2803 // tcmalloc.  We want to do this early, before construct time, so
2804 // all user STL allocations go through tcmalloc (which works really
2805 // well for STL).
2806 //
2807 // The destructor prints stats when the program exits.
2808 class TCMallocGuard {
2809  public:
2810
2811   TCMallocGuard() {
2812 #ifdef HAVE_TLS    // this is true if the cc/ld/libc combo support TLS
2813     // Check whether the kernel also supports TLS (needs to happen at runtime)
2814     CheckIfKernelSupportsTLS();
2815 #endif
2816 #ifndef WTF_CHANGES
2817 #ifdef WIN32                    // patch the windows VirtualAlloc, etc.
2818     PatchWindowsFunctions();    // defined in windows/patch_functions.cc
2819 #endif
2820 #endif
2821     free(malloc(1));
2822     TCMalloc_ThreadCache::InitTSD();
2823     free(malloc(1));
2824 #ifndef WTF_CHANGES
2825     MallocExtension::Register(new TCMallocImplementation);
2826 #endif
2827   }
2828
2829 #ifndef WTF_CHANGES
2830   ~TCMallocGuard() {
2831     const char* env = getenv("MALLOCSTATS");
2832     if (env != NULL) {
2833       int level = atoi(env);
2834       if (level < 1) level = 1;
2835       PrintStats(level);
2836     }
2837 #ifdef WIN32
2838     UnpatchWindowsFunctions();
2839 #endif
2840   }
2841 #endif
2842 };
2843
2844 #ifndef WTF_CHANGES
2845 static TCMallocGuard module_enter_exit_hook;
2846 #endif
2847
2848
2849 //-------------------------------------------------------------------
2850 // Helpers for the exported routines below
2851 //-------------------------------------------------------------------
2852
2853 #ifndef WTF_CHANGES
2854
2855 static Span* DoSampledAllocation(size_t size) {
2856
2857   // Grab the stack trace outside the heap lock
2858   StackTrace tmp;
2859   tmp.depth = GetStackTrace(tmp.stack, kMaxStackDepth, 1);
2860   tmp.size = size;
2861
2862   SpinLockHolder h(&pageheap_lock);
2863   // Allocate span
2864   Span *span = pageheap->New(pages(size == 0 ? 1 : size));
2865   if (span == NULL) {
2866     return NULL;
2867   }
2868
2869   // Allocate stack trace
2870   StackTrace *stack = stacktrace_allocator.New();
2871   if (stack == NULL) {
2872     // Sampling failed because of lack of memory
2873     return span;
2874   }
2875
2876   *stack = tmp;
2877   span->sample = 1;
2878   span->objects = stack;
2879   DLL_Prepend(&sampled_objects, span);
2880
2881   return span;
2882 }
2883 #endif
2884
2885 static inline bool CheckCachedSizeClass(void *ptr) {
2886   PageID p = reinterpret_cast<uintptr_t>(ptr) >> kPageShift;
2887   size_t cached_value = pageheap->GetSizeClassIfCached(p);
2888   return cached_value == 0 ||
2889       cached_value == pageheap->GetDescriptor(p)->sizeclass;
2890 }
2891
2892 static inline void* CheckedMallocResult(void *result)
2893 {
2894   ASSERT(result == 0 || CheckCachedSizeClass(result));
2895   return result;
2896 }
2897
2898 static inline void* SpanToMallocResult(Span *span) {
2899   pageheap->CacheSizeClass(span->start, 0);
2900   return
2901       CheckedMallocResult(reinterpret_cast<void*>(span->start << kPageShift));
2902 }
2903
2904 static ALWAYS_INLINE void* do_malloc(size_t size) {
2905   void* ret = NULL;
2906
2907 #ifdef WTF_CHANGES
2908     ASSERT(!isForbidden());
2909 #endif
2910
2911   // The following call forces module initialization
2912   TCMalloc_ThreadCache* heap = TCMalloc_ThreadCache::GetCache();
2913 #ifndef WTF_CHANGES
2914   if ((FLAGS_tcmalloc_sample_parameter > 0) && heap->SampleAllocation(size)) {
2915     Span* span = DoSampledAllocation(size);
2916     if (span != NULL) {
2917       ret = SpanToMallocResult(span);
2918     }
2919   } else
2920 #endif
2921   if (size > kMaxSize) {
2922     // Use page-level allocator
2923     SpinLockHolder h(&pageheap_lock);
2924     Span* span = pageheap->New(pages(size));
2925     if (span != NULL) {
2926       ret = SpanToMallocResult(span);
2927     }
2928   } else {
2929     // The common case, and also the simplest.  This just pops the
2930     // size-appropriate freelist, afer replenishing it if it's empty.
2931     ret = CheckedMallocResult(heap->Allocate(size));
2932   }
2933   if (ret == NULL) errno = ENOMEM;
2934   return ret;
2935 }
2936
2937 static ALWAYS_INLINE void do_free(void* ptr) {
2938   if (ptr == NULL) return;
2939   ASSERT(pageheap != NULL);  // Should not call free() before malloc()
2940   const PageID p = reinterpret_cast<uintptr_t>(ptr) >> kPageShift;
2941   Span* span = NULL;
2942   size_t cl = pageheap->GetSizeClassIfCached(p);
2943
2944   if (cl == 0) {
2945     span = pageheap->GetDescriptor(p);
2946     cl = span->sizeclass;
2947     pageheap->CacheSizeClass(p, cl);
2948   }
2949   if (cl != 0) {
2950     ASSERT(!pageheap->GetDescriptor(p)->sample);
2951     TCMalloc_ThreadCache* heap = TCMalloc_ThreadCache::GetCacheIfPresent();
2952     if (heap != NULL) {
2953       heap->Deallocate(ptr, cl);
2954     } else {
2955       // Delete directly into central cache
2956       SLL_SetNext(ptr, NULL);
2957       central_cache[cl].InsertRange(ptr, ptr, 1);
2958     }
2959   } else {
2960     SpinLockHolder h(&pageheap_lock);
2961     ASSERT(reinterpret_cast<uintptr_t>(ptr) % kPageSize == 0);
2962     ASSERT(span != NULL && span->start == p);
2963     if (span->sample) {
2964       DLL_Remove(span);
2965       stacktrace_allocator.Delete(reinterpret_cast<StackTrace*>(span->objects));
2966       span->objects = NULL;
2967     }
2968     pageheap->Delete(span);
2969   }
2970 }
2971
2972 #ifndef WTF_CHANGES
2973 // For use by exported routines below that want specific alignments
2974 //
2975 // Note: this code can be slow, and can significantly fragment memory.
2976 // The expectation is that memalign/posix_memalign/valloc/pvalloc will
2977 // not be invoked very often.  This requirement simplifies our
2978 // implementation and allows us to tune for expected allocation
2979 // patterns.
2980 static void* do_memalign(size_t align, size_t size) {
2981   ASSERT((align & (align - 1)) == 0);
2982   ASSERT(align > 0);
2983   if (pageheap == NULL) TCMalloc_ThreadCache::InitModule();
2984
2985   // Allocate at least one byte to avoid boundary conditions below
2986   if (size == 0) size = 1;
2987
2988   if (size <= kMaxSize && align < kPageSize) {
2989     // Search through acceptable size classes looking for one with
2990     // enough alignment.  This depends on the fact that
2991     // InitSizeClasses() currently produces several size classes that
2992     // are aligned at powers of two.  We will waste time and space if
2993     // we miss in the size class array, but that is deemed acceptable
2994     // since memalign() should be used rarely.
2995     size_t cl = SizeClass(size);
2996     while (cl < kNumClasses && ((class_to_size[cl] & (align - 1)) != 0)) {
2997       cl++;
2998     }
2999     if (cl < kNumClasses) {
3000       TCMalloc_ThreadCache* heap = TCMalloc_ThreadCache::GetCache();
3001       return CheckedMallocResult(heap->Allocate(class_to_size[cl]));
3002     }
3003   }
3004
3005   // We will allocate directly from the page heap
3006   SpinLockHolder h(&pageheap_lock);
3007
3008   if (align <= kPageSize) {
3009     // Any page-level allocation will be fine
3010     // TODO: We could put the rest of this page in the appropriate
3011     // TODO: cache but it does not seem worth it.
3012     Span* span = pageheap->New(pages(size));
3013     return span == NULL ? NULL : SpanToMallocResult(span);
3014   }
3015
3016   // Allocate extra pages and carve off an aligned portion
3017   const Length alloc = pages(size + align);
3018   Span* span = pageheap->New(alloc);
3019   if (span == NULL) return NULL;
3020
3021   // Skip starting portion so that we end up aligned
3022   Length skip = 0;
3023   while ((((span->start+skip) << kPageShift) & (align - 1)) != 0) {
3024     skip++;
3025   }
3026   ASSERT(skip < alloc);
3027   if (skip > 0) {
3028     Span* rest = pageheap->Split(span, skip);
3029     pageheap->Delete(span);
3030     span = rest;
3031   }
3032
3033   // Skip trailing portion that we do not need to return
3034   const Length needed = pages(size);
3035   ASSERT(span->length >= needed);
3036   if (span->length > needed) {
3037     Span* trailer = pageheap->Split(span, needed);
3038     pageheap->Delete(trailer);
3039   }
3040   return SpanToMallocResult(span);
3041 }
3042 #endif
3043
3044 // Helpers for use by exported routines below:
3045
3046 #ifndef WTF_CHANGES
3047 static inline void do_malloc_stats() {
3048   PrintStats(1);
3049 }
3050 #endif
3051
3052 static inline int do_mallopt(int, int) {
3053   return 1;     // Indicates error
3054 }
3055
3056 #ifdef HAVE_STRUCT_MALLINFO  // mallinfo isn't defined on freebsd, for instance
3057 static inline struct mallinfo do_mallinfo() {
3058   TCMallocStats stats;
3059   ExtractStats(&stats, NULL);
3060
3061   // Just some of the fields are filled in.
3062   struct mallinfo info;
3063   memset(&info, 0, sizeof(info));
3064
3065   // Unfortunately, the struct contains "int" field, so some of the
3066   // size values will be truncated.
3067   info.arena     = static_cast<int>(stats.system_bytes);
3068   info.fsmblks   = static_cast<int>(stats.thread_bytes
3069                                     + stats.central_bytes
3070                                     + stats.transfer_bytes);
3071   info.fordblks  = static_cast<int>(stats.pageheap_bytes);
3072   info.uordblks  = static_cast<int>(stats.system_bytes
3073                                     - stats.thread_bytes
3074                                     - stats.central_bytes
3075                                     - stats.transfer_bytes
3076                                     - stats.pageheap_bytes);
3077
3078   return info;
3079 }
3080 #endif
3081
3082 //-------------------------------------------------------------------
3083 // Exported routines
3084 //-------------------------------------------------------------------
3085
3086 // CAVEAT: The code structure below ensures that MallocHook methods are always
3087 //         called from the stack frame of the invoked allocation function.
3088 //         heap-checker.cc depends on this to start a stack trace from
3089 //         the call to the (de)allocation function.
3090
3091 #ifndef WTF_CHANGES
3092 extern "C" 
3093 #endif
3094 void* malloc(size_t size) {
3095   void* result = do_malloc(size);
3096 #ifndef WTF_CHANGES
3097   MallocHook::InvokeNewHook(result, size);
3098 #endif
3099   return result;
3100 }
3101
3102 #ifndef WTF_CHANGES
3103 extern "C" 
3104 #endif
3105 void free(void* ptr) {
3106 #ifndef WTF_CHANGES
3107   MallocHook::InvokeDeleteHook(ptr);
3108 #endif
3109   do_free(ptr);
3110 }
3111
3112 #ifndef WTF_CHANGES
3113 extern "C" 
3114 #endif
3115 void* calloc(size_t n, size_t elem_size) {
3116   const size_t totalBytes = n * elem_size;
3117     
3118   // Protect against overflow
3119   if (n > 1 && elem_size && (totalBytes / elem_size) != n)
3120     return 0;
3121     
3122   void* result = do_malloc(totalBytes);
3123   if (result != NULL) {
3124     memset(result, 0, totalBytes);
3125   }
3126 #ifndef WTF_CHANGES
3127   MallocHook::InvokeNewHook(result, totalBytes);
3128 #endif
3129   return result;
3130 }
3131
3132 #ifndef WTF_CHANGES
3133 extern "C" 
3134 #endif
3135 void cfree(void* ptr) {
3136 #ifndef WTF_CHANGES
3137     MallocHook::InvokeDeleteHook(ptr);
3138 #endif
3139   do_free(ptr);
3140 }
3141
3142 #ifndef WTF_CHANGES
3143 extern "C" 
3144 #endif
3145 void* realloc(void* old_ptr, size_t new_size) {
3146   if (old_ptr == NULL) {
3147     void* result = do_malloc(new_size);
3148 #ifndef WTF_CHANGES
3149     MallocHook::InvokeNewHook(result, new_size);
3150 #endif
3151     return result;
3152   }
3153   if (new_size == 0) {
3154 #ifndef WTF_CHANGES
3155     MallocHook::InvokeDeleteHook(old_ptr);
3156 #endif
3157     free(old_ptr);
3158     return NULL;
3159   }
3160
3161   // Get the size of the old entry
3162   const PageID p = reinterpret_cast<uintptr_t>(old_ptr) >> kPageShift;
3163   size_t cl = pageheap->GetSizeClassIfCached(p);
3164   Span *span = NULL;
3165   size_t old_size;
3166   if (cl == 0) {
3167     span = pageheap->GetDescriptor(p);
3168     cl = span->sizeclass;
3169     pageheap->CacheSizeClass(p, cl);
3170   }
3171   if (cl != 0) {
3172     old_size = ByteSizeForClass(cl);
3173   } else {
3174     ASSERT(span != NULL);
3175     old_size = span->length << kPageShift;
3176   }
3177
3178   // Reallocate if the new size is larger than the old size,
3179   // or if the new size is significantly smaller than the old size.
3180   if ((new_size > old_size) || (AllocationSize(new_size) < old_size)) {
3181     // Need to reallocate
3182     void* new_ptr = do_malloc(new_size);
3183     if (new_ptr == NULL) {
3184       return NULL;
3185     }
3186 #ifndef WTF_CHANGES
3187     MallocHook::InvokeNewHook(new_ptr, new_size);
3188 #endif
3189     memcpy(new_ptr, old_ptr, ((old_size < new_size) ? old_size : new_size));
3190 #ifndef WTF_CHANGES
3191     MallocHook::InvokeDeleteHook(old_ptr);
3192 #endif
3193     // We could use a variant of do_free() that leverages the fact
3194     // that we already know the sizeclass of old_ptr.  The benefit
3195     // would be small, so don't bother.
3196     do_free(old_ptr);
3197     return new_ptr;
3198   } else {
3199     return old_ptr;
3200   }
3201 }
3202
3203 #ifndef WTF_CHANGES
3204
3205 static SpinLock set_new_handler_lock = SPINLOCK_INITIALIZER;
3206
3207 static inline void* cpp_alloc(size_t size, bool nothrow) {
3208   for (;;) {
3209     void* p = do_malloc(size);
3210 #ifdef PREANSINEW
3211     return p;
3212 #else
3213     if (p == NULL) {  // allocation failed
3214       // Get the current new handler.  NB: this function is not
3215       // thread-safe.  We make a feeble stab at making it so here, but
3216       // this lock only protects against tcmalloc interfering with
3217       // itself, not with other libraries calling set_new_handler.
3218       std::new_handler nh;
3219       {
3220         SpinLockHolder h(&set_new_handler_lock);
3221         nh = std::set_new_handler(0);
3222         (void) std::set_new_handler(nh);
3223       }
3224       // If no new_handler is established, the allocation failed.
3225       if (!nh) {
3226         if (nothrow) return 0;
3227         throw std::bad_alloc();
3228       }
3229       // Otherwise, try the new_handler.  If it returns, retry the
3230       // allocation.  If it throws std::bad_alloc, fail the allocation.
3231       // if it throws something else, don't interfere.
3232       try {
3233         (*nh)();
3234       } catch (const std::bad_alloc&) {
3235         if (!nothrow) throw;
3236         return p;
3237       }
3238     } else {  // allocation success
3239       return p;
3240     }
3241 #endif
3242   }
3243 }
3244
3245 void* operator new(size_t size) {
3246   void* p = cpp_alloc(size, false);
3247   // We keep this next instruction out of cpp_alloc for a reason: when
3248   // it's in, and new just calls cpp_alloc, the optimizer may fold the
3249   // new call into cpp_alloc, which messes up our whole section-based
3250   // stacktracing (see ATTRIBUTE_SECTION, above).  This ensures cpp_alloc
3251   // isn't the last thing this fn calls, and prevents the folding.
3252   MallocHook::InvokeNewHook(p, size);
3253   return p;
3254 }
3255
3256 void* operator new(size_t size, const std::nothrow_t&) __THROW {
3257   void* p = cpp_alloc(size, true);
3258   MallocHook::InvokeNewHook(p, size);
3259   return p;
3260 }
3261
3262 void operator delete(void* p) __THROW {
3263   MallocHook::InvokeDeleteHook(p);
3264   do_free(p);
3265 }
3266
3267 void operator delete(void* p, const std::nothrow_t&) __THROW {
3268   MallocHook::InvokeDeleteHook(p);
3269   do_free(p);
3270 }
3271
3272 void* operator new[](size_t size) {
3273   void* p = cpp_alloc(size, false);
3274   // We keep this next instruction out of cpp_alloc for a reason: when
3275   // it's in, and new just calls cpp_alloc, the optimizer may fold the
3276   // new call into cpp_alloc, which messes up our whole section-based
3277   // stacktracing (see ATTRIBUTE_SECTION, above).  This ensures cpp_alloc
3278   // isn't the last thing this fn calls, and prevents the folding.
3279   MallocHook::InvokeNewHook(p, size);
3280   return p;
3281 }
3282
3283 void* operator new[](size_t size, const std::nothrow_t&) __THROW {
3284   void* p = cpp_alloc(size, true);
3285   MallocHook::InvokeNewHook(p, size);
3286   return p;
3287 }
3288
3289 void operator delete[](void* p) __THROW {
3290   MallocHook::InvokeDeleteHook(p);
3291   do_free(p);
3292 }
3293
3294 void operator delete[](void* p, const std::nothrow_t&) __THROW {
3295   MallocHook::InvokeDeleteHook(p);
3296   do_free(p);
3297 }
3298
3299 extern "C" void* memalign(size_t align, size_t size) __THROW {
3300   void* result = do_memalign(align, size);
3301   MallocHook::InvokeNewHook(result, size);
3302   return result;
3303 }
3304
3305 extern "C" int posix_memalign(void** result_ptr, size_t align, size_t size)
3306     __THROW {
3307   if (((align % sizeof(void*)) != 0) ||
3308       ((align & (align - 1)) != 0) ||
3309       (align == 0)) {
3310     return EINVAL;
3311   }
3312
3313   void* result = do_memalign(align, size);
3314   MallocHook::InvokeNewHook(result, size);
3315   if (result == NULL) {
3316     return ENOMEM;
3317   } else {
3318     *result_ptr = result;
3319     return 0;
3320   }
3321 }
3322
3323 static size_t pagesize = 0;
3324
3325 extern "C" void* valloc(size_t size) __THROW {
3326   // Allocate page-aligned object of length >= size bytes
3327   if (pagesize == 0) pagesize = getpagesize();
3328   void* result = do_memalign(pagesize, size);
3329   MallocHook::InvokeNewHook(result, size);
3330   return result;
3331 }
3332
3333 extern "C" void* pvalloc(size_t size) __THROW {
3334   // Round up size to a multiple of pagesize
3335   if (pagesize == 0) pagesize = getpagesize();
3336   size = (size + pagesize - 1) & ~(pagesize - 1);
3337   void* result = do_memalign(pagesize, size);
3338   MallocHook::InvokeNewHook(result, size);
3339   return result;
3340 }
3341
3342 extern "C" void malloc_stats(void) {
3343   do_malloc_stats();
3344 }
3345
3346 extern "C" int mallopt(int cmd, int value) {
3347   return do_mallopt(cmd, value);
3348 }
3349
3350 #ifdef HAVE_STRUCT_MALLINFO
3351 extern "C" struct mallinfo mallinfo(void) {
3352   return do_mallinfo();
3353 }
3354 #endif
3355
3356 //-------------------------------------------------------------------
3357 // Some library routines on RedHat 9 allocate memory using malloc()
3358 // and free it using __libc_free() (or vice-versa).  Since we provide
3359 // our own implementations of malloc/free, we need to make sure that
3360 // the __libc_XXX variants (defined as part of glibc) also point to
3361 // the same implementations.
3362 //-------------------------------------------------------------------
3363
3364 #if defined(__GLIBC__)
3365 extern "C" {
3366 # if defined(__GNUC__) && !defined(__MACH__) && defined(HAVE___ATTRIBUTE__)
3367   // Potentially faster variants that use the gcc alias extension.
3368   // Mach-O (Darwin) does not support weak aliases, hence the __MACH__ check.
3369 # define ALIAS(x) __attribute__ ((weak, alias (x)))
3370   void* __libc_malloc(size_t size)              ALIAS("malloc");
3371   void  __libc_free(void* ptr)                  ALIAS("free");
3372   void* __libc_realloc(void* ptr, size_t size)  ALIAS("realloc");
3373   void* __libc_calloc(size_t n, size_t size)    ALIAS("calloc");
3374   void  __libc_cfree(void* ptr)                 ALIAS("cfree");
3375   void* __libc_memalign(size_t align, size_t s) ALIAS("memalign");
3376   void* __libc_valloc(size_t size)              ALIAS("valloc");
3377   void* __libc_pvalloc(size_t size)             ALIAS("pvalloc");
3378   int __posix_memalign(void** r, size_t a, size_t s) ALIAS("posix_memalign");
3379 # undef ALIAS
3380 # else   /* not __GNUC__ */
3381   // Portable wrappers
3382   void* __libc_malloc(size_t size)              { return malloc(size);       }
3383   void  __libc_free(void* ptr)                  { free(ptr);                 }
3384   void* __libc_realloc(void* ptr, size_t size)  { return realloc(ptr, size); }
3385   void* __libc_calloc(size_t n, size_t size)    { return calloc(n, size);    }
3386   void  __libc_cfree(void* ptr)                 { cfree(ptr);                }
3387   void* __libc_memalign(size_t align, size_t s) { return memalign(align, s); }
3388   void* __libc_valloc(size_t size)              { return valloc(size);       }
3389   void* __libc_pvalloc(size_t size)             { return pvalloc(size);      }
3390   int __posix_memalign(void** r, size_t a, size_t s) {
3391     return posix_memalign(r, a, s);
3392   }
3393 # endif  /* __GNUC__ */
3394 }
3395 #endif   /* __GLIBC__ */
3396
3397 // Override __libc_memalign in libc on linux boxes specially.
3398 // They have a bug in libc that causes them to (very rarely) allocate
3399 // with __libc_memalign() yet deallocate with free() and the
3400 // definitions above don't catch it.
3401 // This function is an exception to the rule of calling MallocHook method
3402 // from the stack frame of the allocation function;
3403 // heap-checker handles this special case explicitly.
3404 static void *MemalignOverride(size_t align, size_t size, const void *caller)
3405     __THROW {
3406   void* result = do_memalign(align, size);
3407   MallocHook::InvokeNewHook(result, size);
3408   return result;
3409 }
3410 void *(*__memalign_hook)(size_t, size_t, const void *) = MemalignOverride;
3411
3412 #endif
3413
3414 #if defined(WTF_CHANGES) && PLATFORM(DARWIN)
3415 #include <wtf/HashSet.h>
3416
3417 class FreeObjectFinder {
3418     const RemoteMemoryReader& m_reader;
3419     HashSet<void*> m_freeObjects;
3420
3421 public:
3422     FreeObjectFinder(const RemoteMemoryReader& reader) : m_reader(reader) { }
3423
3424     void visit(void* ptr) { m_freeObjects.add(ptr); }
3425     bool isFreeObject(void* ptr) const { return m_freeObjects.contains(ptr); }
3426     size_t freeObjectCount() const { return m_freeObjects.size(); }
3427
3428     void findFreeObjects(TCMalloc_ThreadCache* threadCache)
3429     {
3430         for (; threadCache; threadCache = (threadCache->next_ ? m_reader(threadCache->next_) : 0))
3431             threadCache->enumerateFreeObjects(*this, m_reader);
3432     }
3433
3434     void findFreeObjects(TCMalloc_Central_FreeListPadded* centralFreeList, size_t numSizes)
3435     {
3436         for (unsigned i = 0; i < numSizes; i++)
3437             centralFreeList[i].enumerateFreeObjects(*this, m_reader);
3438     }
3439 };
3440
3441 class PageMapFreeObjectFinder {
3442     const RemoteMemoryReader& m_reader;
3443     FreeObjectFinder& m_freeObjectFinder;
3444
3445 public:
3446     PageMapFreeObjectFinder(const RemoteMemoryReader& reader, FreeObjectFinder& freeObjectFinder)
3447         : m_reader(reader)
3448         , m_freeObjectFinder(freeObjectFinder)
3449     { }
3450
3451     int visit(void* ptr) const
3452     {
3453         if (!ptr)
3454             return 1;
3455
3456         Span* span = m_reader(reinterpret_cast<Span*>(ptr));
3457         if (span->free) {
3458             void* ptr = reinterpret_cast<void*>(span->start << kPageShift);
3459             m_freeObjectFinder.visit(ptr);
3460         } else if (span->sizeclass) {
3461             // Walk the free list of the small-object span, keeping track of each object seen
3462             for (void* nextObject = span->objects; nextObject; nextObject = *m_reader(reinterpret_cast<void**>(nextObject)))
3463                 m_freeObjectFinder.visit(nextObject);
3464         }
3465         return span->length;
3466     }
3467 };
3468
3469 class PageMapMemoryUsageRecorder {
3470     task_t m_task;
3471     void* m_context;
3472     unsigned m_typeMask;
3473     vm_range_recorder_t* m_recorder;
3474     const RemoteMemoryReader& m_reader;
3475     const FreeObjectFinder& m_freeObjectFinder;
3476     mutable HashSet<void*> m_seenPointers;
3477
3478 public:
3479     PageMapMemoryUsageRecorder(task_t task, void* context, unsigned typeMask, vm_range_recorder_t* recorder, const RemoteMemoryReader& reader, const FreeObjectFinder& freeObjectFinder)
3480         : m_task(task)
3481         , m_context(context)
3482         , m_typeMask(typeMask)
3483         , m_recorder(recorder)
3484         , m_reader(reader)
3485         , m_freeObjectFinder(freeObjectFinder)
3486     { }
3487
3488     int visit(void* ptr) const
3489     {
3490         if (!ptr)
3491             return 1;
3492
3493         Span* span = m_reader(reinterpret_cast<Span*>(ptr));
3494         if (m_seenPointers.contains(ptr))
3495             return span->length;
3496         m_seenPointers.add(ptr);
3497
3498         // Mark the memory used for the Span itself as an administrative region
3499         vm_range_t ptrRange = { reinterpret_cast<vm_address_t>(ptr), sizeof(Span) };
3500         if (m_typeMask & (MALLOC_PTR_REGION_RANGE_TYPE | MALLOC_ADMIN_REGION_RANGE_TYPE))
3501             (*m_recorder)(m_task, m_context, MALLOC_ADMIN_REGION_RANGE_TYPE, &ptrRange, 1);
3502
3503         ptrRange.address = span->start << kPageShift;
3504         ptrRange.size = span->length * kPageSize;
3505
3506         // Mark the memory region the span represents as candidates for containing pointers
3507         if (m_typeMask & (MALLOC_PTR_REGION_RANGE_TYPE | MALLOC_ADMIN_REGION_RANGE_TYPE))
3508             (*m_recorder)(m_task, m_context, MALLOC_PTR_REGION_RANGE_TYPE, &ptrRange, 1);
3509
3510         if (!span->free && (m_typeMask & MALLOC_PTR_IN_USE_RANGE_TYPE)) {
3511             // If it's an allocated large object span, mark it as in use
3512             if (span->sizeclass == 0 && !m_freeObjectFinder.isFreeObject(reinterpret_cast<void*>(ptrRange.address)))
3513                 (*m_recorder)(m_task, m_context, MALLOC_PTR_IN_USE_RANGE_TYPE, &ptrRange, 1);
3514             else if (span->sizeclass) {
3515                 const size_t byteSize = ByteSizeForClass(span->sizeclass);
3516                 unsigned totalObjects = (span->length << kPageShift) / byteSize;
3517                 ASSERT(span->refcount <= totalObjects);
3518                 char* ptr = reinterpret_cast<char*>(span->start << kPageShift);
3519
3520                 // Mark each allocated small object within the span as in use
3521                 for (unsigned i = 0; i < totalObjects; i++) {
3522                     char* thisObject = ptr + (i * byteSize);
3523                     if (m_freeObjectFinder.isFreeObject(thisObject))
3524                         continue;
3525
3526                     vm_range_t objectRange = { reinterpret_cast<vm_address_t>(thisObject), byteSize };
3527                     (*m_recorder)(m_task, m_context, MALLOC_PTR_IN_USE_RANGE_TYPE, &objectRange, 1);
3528                 }
3529             }
3530         }
3531
3532         return span->length;
3533     }
3534 };
3535
3536 kern_return_t FastMallocZone::enumerate(task_t task, void* context, unsigned typeMask, vm_address_t zoneAddress, memory_reader_t reader, vm_range_recorder_t recorder)
3537 {
3538     RemoteMemoryReader memoryReader(task, reader);
3539
3540     InitSizeClasses();
3541
3542     FastMallocZone* mzone = memoryReader(reinterpret_cast<FastMallocZone*>(zoneAddress));
3543     TCMalloc_PageHeap* pageHeap = memoryReader(mzone->m_pageHeap);
3544     TCMalloc_ThreadCache** threadHeapsPointer = memoryReader(mzone->m_threadHeaps);
3545     TCMalloc_ThreadCache* threadHeaps = memoryReader(*threadHeapsPointer);
3546
3547     TCMalloc_Central_FreeListPadded* centralCaches = memoryReader(mzone->m_centralCaches, sizeof(TCMalloc_Central_FreeListPadded) * kNumClasses);
3548
3549     FreeObjectFinder finder(memoryReader);
3550     finder.findFreeObjects(threadHeaps);
3551     finder.findFreeObjects(centralCaches, kNumClasses);
3552
3553     TCMalloc_PageHeap::PageMap* pageMap = &pageHeap->pagemap_;
3554     PageMapFreeObjectFinder pageMapFinder(memoryReader, finder);
3555     pageMap->visit(pageMapFinder, memoryReader);
3556
3557     PageMapMemoryUsageRecorder usageRecorder(task, context, typeMask, recorder, memoryReader, finder);
3558     pageMap->visit(usageRecorder, memoryReader);
3559
3560     return 0;
3561 }
3562
3563 size_t FastMallocZone::size(malloc_zone_t*, const void*)
3564 {
3565     return 0;
3566 }
3567
3568 void* FastMallocZone::zoneMalloc(malloc_zone_t*, size_t)
3569 {
3570     return 0;
3571 }
3572
3573 void* FastMallocZone::zoneCalloc(malloc_zone_t*, size_t, size_t)
3574 {
3575     return 0;
3576 }
3577
3578 void FastMallocZone::zoneFree(malloc_zone_t*, void*)
3579 {
3580 }
3581
3582 void* FastMallocZone::zoneRealloc(malloc_zone_t*, void*, size_t)
3583 {
3584     return 0;
3585 }
3586
3587
3588 #undef malloc
3589 #undef free
3590 #undef realloc
3591 #undef calloc
3592
3593 extern "C" {
3594 malloc_introspection_t jscore_fastmalloc_introspection = { &FastMallocZone::enumerate, &FastMallocZone::goodSize, &FastMallocZone::check, &FastMallocZone::print,
3595     &FastMallocZone::log, &FastMallocZone::forceLock, &FastMallocZone::forceUnlock, &FastMallocZone::statistics };
3596 }
3597
3598 FastMallocZone::FastMallocZone(TCMalloc_PageHeap* pageHeap, TCMalloc_ThreadCache** threadHeaps, TCMalloc_Central_FreeListPadded* centralCaches)
3599     : m_pageHeap(pageHeap)
3600     , m_threadHeaps(threadHeaps)
3601     , m_centralCaches(centralCaches)
3602 {
3603     memset(&m_zone, 0, sizeof(m_zone));
3604     m_zone.zone_name = "JavaScriptCore FastMalloc";
3605     m_zone.size = &FastMallocZone::size;
3606     m_zone.malloc = &FastMallocZone::zoneMalloc;
3607     m_zone.calloc = &FastMallocZone::zoneCalloc;
3608     m_zone.realloc = &FastMallocZone::zoneRealloc;
3609     m_zone.free = &FastMallocZone::zoneFree;
3610     m_zone.valloc = &FastMallocZone::zoneValloc;
3611     m_zone.destroy = &FastMallocZone::zoneDestroy;
3612     m_zone.introspect = &jscore_fastmalloc_introspection;
3613     malloc_zone_register(&m_zone);
3614 }
3615
3616
3617 void FastMallocZone::init()
3618 {
3619     static FastMallocZone zone(pageheap, &thread_heaps, static_cast<TCMalloc_Central_FreeListPadded*>(central_cache));
3620 }
3621
3622 #endif
3623
3624 #if WTF_CHANGES
3625 } // namespace WTF
3626 #endif
3627
3628 #endif // USE_SYSTEM_MALLOC