|
2720
|
1 /* New allocator for XEmacs.
|
|
|
2 Copyright (C) 2005 Marcus Crestani.
|
|
|
3
|
|
|
4 This file is part of XEmacs.
|
|
|
5
|
|
|
6 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
7 under the terms of the GNU General Public License as published by the
|
|
|
8 Free Software Foundation; either version 2, or (at your option) any
|
|
|
9 later version.
|
|
|
10
|
|
|
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
14 for more details.
|
|
|
15
|
|
|
16 You should have received a copy of the GNU General Public License
|
|
|
17 along with XEmacs; see the file COPYING. If not, write to
|
|
|
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
19 Boston, MA 02111-1307, USA. */
|
|
|
20
|
|
|
21 /* Synched up with: Not in FSF. */
|
|
|
22
|
|
|
23 #ifndef INCLUDED_mc_alloc_h_
|
|
|
24 #define INCLUDED_mc_alloc_h_
|
|
|
25
|
|
|
26 /*--- prototypes -------------------------------------------------------*/
|
|
|
27
|
|
|
28 BEGIN_C_DECLS
|
|
|
29
|
|
3305
|
30 /* Set to 1 if memory becomes short. */
|
|
|
31 extern EMACS_INT memory_shortage;
|
|
2720
|
32
|
|
|
33
|
|
3092
|
34 /* Internal Allocator Functions: */
|
|
2720
|
35
|
|
3092
|
36 /* Initialize the allocator. This has to be called prior to
|
|
|
37 requesting memory. */
|
|
2720
|
38 void init_mc_allocator (void);
|
|
|
39
|
|
3092
|
40 /* Allocate a block of memory of given size and return the pointer to
|
|
|
41 it. */
|
|
2720
|
42 void *mc_alloc (size_t size);
|
|
|
43
|
|
3092
|
44 /* Allocate a block of memory as an array with elemcount elements of
|
|
|
45 given size and return the pointer to it. Arrays contain several
|
|
|
46 objects that are allocated in one consecutive block of memory with
|
|
|
47 each element being a fully qualified object---that is, it has a
|
|
|
48 Lisp object header and a mark bit. Objects like hash tables and
|
|
|
49 dynamic arrays use this function. */
|
|
|
50 void *mc_alloc_array (size_t size, EMACS_INT elemcount);
|
|
|
51
|
|
|
52 /* Free the object pointed to by ptr and make its memory re-usable
|
|
|
53 again. The memory must have been returned by a previous call to
|
|
|
54 mc_alloc(). This can be used to free memory explicitly, outside a
|
|
|
55 garbage collection. */
|
|
2720
|
56 void mc_free (void *ptr);
|
|
|
57
|
|
3092
|
58 /* Modify the size of the memory block pointed to by ptr. Return the
|
|
|
59 address of the new block of given size. The content of the memory
|
|
|
60 block will be unchanged to the minimum of the old and new sizes: if
|
|
|
61 the new size is smaller, the overlaying data is cut off; if the new
|
|
|
62 size is bigger, the newly allocated memory will be uninitialized.*/
|
|
2720
|
63 void *mc_realloc (void *ptr, size_t size);
|
|
|
64
|
|
3092
|
65 /* Modify the size of the array pointed to by ptr. Return the address
|
|
|
66 of the new array block with elemcount elements of given size. The
|
|
|
67 content of the memory block will be unchanged to the minimum of the
|
|
|
68 old and new sizes: if the new size is smaller, the overlaying data
|
|
|
69 is cut off; if the new size is bigger, the newly allocated memory
|
|
|
70 will be uninitialized.*/
|
|
|
71 void *mc_realloc_array (void *ptr, size_t size, EMACS_INT elemcount);
|
|
|
72
|
|
2720
|
73
|
|
|
74
|
|
|
75 /* Garbage collection related functions and macros: */
|
|
|
76
|
|
3092
|
77 enum mark_bit_colors
|
|
|
78 {
|
|
|
79 WHITE = 0,
|
|
|
80 BLACK = 1,
|
|
|
81 GREY = 2
|
|
|
82 };
|
|
|
83
|
|
|
84 /* Set the mark bit of the object pointed to by ptr to value.*/
|
|
|
85 void set_mark_bit (void *ptr, EMACS_INT value);
|
|
|
86
|
|
|
87 /* Return the mark bit of the object pointed to by ptr. */
|
|
|
88 EMACS_INT get_mark_bit (void *ptr);
|
|
|
89
|
|
|
90 /* mark bit macros */
|
|
|
91 /* Returns true if the mark bit of the object pointed to by ptr is set. */
|
|
|
92 #define MARKED_P(ptr) (get_mark_bit (ptr) != WHITE)
|
|
|
93
|
|
|
94 /* Marks the object pointed to by ptr (sets the mark bit to 1). */
|
|
|
95 #define MARK(ptr) set_mark_bit (ptr, BLACK)
|
|
|
96
|
|
|
97 /* Unmarks the object pointed to by ptr (sets the mark bit to 0). */
|
|
|
98 #define UNMARK(ptr) set_mark_bit (ptr, WHITE)
|
|
|
99
|
|
|
100 #define MARK_WHITE(ptr) set_mark_bit (ptr, WHITE)
|
|
|
101 #define MARK_GREY(ptr) set_mark_bit (ptr, GREY)
|
|
|
102 #define MARK_BLACK(ptr) set_mark_bit (ptr, BLACK)
|
|
|
103
|
|
|
104 #define MARKED_WHITE_P(ptr) (get_mark_bit (ptr) == WHITE)
|
|
|
105 #define MARKED_GREY_P(ptr) (get_mark_bit (ptr) == GREY)
|
|
|
106 #define MARKED_BLACK_P(ptr) (get_mark_bit (ptr) == BLACK)
|
|
2720
|
107
|
|
3092
|
108 /* The finalizer of every not marked object is called. The macro
|
|
2720
|
109 MC_ALLOC_CALL_FINALIZER has to be defined and call the finalizer of
|
|
3303
|
110 the object. Returns number of processed pages. */
|
|
|
111 EMACS_INT mc_finalize (void);
|
|
2720
|
112
|
|
3303
|
113 /* All not marked objects of the used heap are freed. Returns number
|
|
|
114 of processed pages. */
|
|
|
115 EMACS_INT mc_sweep (void);
|
|
2720
|
116
|
|
|
117
|
|
|
118
|
|
|
119 /* Portable dumper related functions and macros: */
|
|
|
120
|
|
|
121 /* The finalizer for disksave of every object is called to shrink the
|
|
3092
|
122 dump image. The macro MC_ALLOC_CALL_FINALIZER_FOR_DISKSAVE has to
|
|
3303
|
123 be defined and call the finalizer for disksave of the object.
|
|
|
124 Returns number of processed pages. */
|
|
|
125 EMACS_INT mc_finalize_for_disksave (void);
|
|
2720
|
126
|
|
|
127
|
|
|
128
|
|
|
129 /* Functions and macros related with allocation statistics: */
|
|
|
130
|
|
|
131 #ifdef MEMORY_USAGE_STATS
|
|
|
132 /* Returns the real size, including overhead, which is actually alloced
|
|
|
133 for an object with given claimed_size. */
|
|
|
134 Bytecount mc_alloced_storage_size (Bytecount claimed_size,
|
|
|
135 struct overhead_stats *stats);
|
|
|
136 #endif /* MEMORY_USAGE_STATS */
|
|
|
137
|
|
3092
|
138
|
|
|
139 /* Incremental Garbage Collector / Write Barrier Support: */
|
|
|
140
|
|
|
141 /* Return the PAGESIZE the allocator uses. Generally equals to the
|
|
|
142 system's PAGESIZE. */
|
|
|
143 EMACS_INT mc_get_page_size (void);
|
|
|
144
|
|
|
145 /* Is the fault at ptr on a protected page? */
|
|
|
146 EMACS_INT fault_on_protected_page (void *ptr);
|
|
|
147
|
|
3303
|
148 /* Remove protection (if there) of heap page of given page header ph.
|
|
|
149 Returns number of processed pages. */
|
|
|
150 EMACS_INT protect_heap_pages (void);
|
|
3092
|
151
|
|
3303
|
152 /* Remove protection for all heap pages which are protected. Returns
|
|
|
153 number of processed pages. */
|
|
|
154 EMACS_INT unprotect_heap_pages (void);
|
|
3092
|
155
|
|
|
156 /* Remove protection and mark page dirty. */
|
|
|
157 void unprotect_page_and_mark_dirty (void *ptr);
|
|
|
158
|
|
|
159 /* Repush all objects on dirty pages onto the mark stack. Return
|
|
|
160 number of repushed objects. */
|
|
|
161 int repush_all_objects_on_page (void *ptr);
|
|
|
162
|
|
|
163 /* Mark black if object is currently grey. */
|
|
|
164 EMACS_INT maybe_mark_black (void *ptr);
|
|
|
165
|
|
|
166 /* Only for debugging---not used anywhere in the sources. */
|
|
|
167 EMACS_INT object_on_heap_p (void *ptr);
|
|
|
168
|
|
2720
|
169 END_C_DECLS
|
|
|
170
|
|
|
171 #endif /* INCLUDED_mc_alloc_h_ */
|
