Have the two malloc zones print useful diagnostics if their free method are unexpecte...
[WebKit.git] / JavaScriptCore / kjs / CollectorHeapIntrospector.h
1 /*
2  * Copyright (C) 2007 Apple Inc.  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
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef CollectorHeapIntrospector_h
30 #define CollectorHeapIntrospector_h
31
32 #include <malloc/malloc.h>
33 #include "Assertions.h"
34
35 namespace KJS {
36
37 struct CollectorHeap;
38     
39 class CollectorHeapIntrospector {
40 public:
41     static void init(CollectorHeap*, CollectorHeap*);
42     static kern_return_t enumerate(task_t, void* context, unsigned typeMask, vm_address_t zoneAddress, memory_reader_t, vm_range_recorder_t);
43     static size_t goodSize(malloc_zone_t*, size_t size) { return size; }
44     static boolean_t check(malloc_zone_t*) { return true; }
45     static void  print(malloc_zone_t*, boolean_t) { }
46     static void log(malloc_zone_t*, void*) { }
47     static void forceLock(malloc_zone_t*) { }
48     static void forceUnlock(malloc_zone_t*) { }
49     static void statistics(malloc_zone_t*, malloc_statistics_t*) { }
50
51 private:
52     CollectorHeapIntrospector(CollectorHeap*, CollectorHeap*);
53     static size_t size(malloc_zone_t*, const void*) { return 0; }
54     static void* zoneMalloc(malloc_zone_t*, size_t) { LOG_ERROR("malloc is not supported"); return 0; }
55     static void* zoneCalloc(malloc_zone_t*, size_t, size_t) { LOG_ERROR("calloc is not supported"); return 0; }
56     static void* zoneRealloc(malloc_zone_t*, void*, size_t) { LOG_ERROR("realloc is not supported"); return 0; }
57     static void* zoneValloc(malloc_zone_t*, size_t) { LOG_ERROR("valloc is not supported"); return 0; }
58     static void zoneDestroy(malloc_zone_t*) { }
59
60     static void zoneFree(malloc_zone_t*, void* ptr)
61     {
62         // Due to <rdar://problem/5671357> zoneFree may be called by the system free even if the pointer
63         // is not in this zone.  When this happens, the pointer being freed was not allocated by any
64         // zone so we need to print a useful error for the application developer.
65         malloc_printf("*** error for object %p: pointer being freed was not allocated\n", ptr);
66     }
67
68     malloc_zone_t m_zone;
69     CollectorHeap* m_primaryHeap;
70     CollectorHeap* m_numberHeap;
71 };
72
73 }
74
75 #endif // CollectorHeapIntrospector_h