3 * SGen client interface.
5 * Copyright (C) 2014 Xamarin Inc
7 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
10 #include "mono/sgen/sgen-pointer-queue.h"
13 * Init whatever needs initing. This is called relatively early in SGen initialization.
14 * Must initialized the small ID for the current thread.
16 void sgen_client_init (void);
19 * The slow path for getting an object's size. We're passing in the vtable because we've
22 mword sgen_client_slow_object_get_size (GCVTable vtable, GCObject* o);
25 * Fill the given range with a dummy object. If the range is too short to be filled with an
26 * object, null it. Return `TRUE` if the range was filled with an object, `FALSE` if it was
29 gboolean sgen_client_array_fill_range (char *start, size_t size);
32 * This is called if the nursery clearing policy at `clear-at-gc`, which is usually only
33 * used for debugging. If `size` is large enough for the memory to have been filled with a
34 * dummy, object, zero its header. Note that there might not actually be a header there.
36 void sgen_client_zero_array_fill_header (void *p, size_t size);
39 * Return whether the given object is an array fill dummy object.
41 gboolean sgen_client_object_is_array_fill (GCObject *o);
44 * Return whether the given finalizable object's finalizer is critical, i.e., needs to run
45 * after all non-critical finalizers have run.
47 gboolean sgen_client_object_has_critical_finalizer (GCObject *obj);
50 * Called after an object is enqueued for finalization. This is a very low-level callback.
51 * It should almost certainly be a NOP.
53 * FIXME: Can we merge this with `sgen_client_object_has_critical_finalizer()`?
55 void sgen_client_object_queued_for_finalization (GCObject *obj);
58 * Run the given object's finalizer.
60 void sgen_client_run_finalize (GCObject *obj);
63 * Is called after a collection if there are objects to finalize. The world is still
64 * stopped. This will usually notify the finalizer thread that it needs to run.
66 void sgen_client_finalize_notify (void);
69 * Returns TRUE if no ephemerons have been marked. Will be called again if it returned
70 * FALSE. If ephemerons are not supported, just return TRUE.
72 gboolean sgen_client_mark_ephemerons (ScanCopyContext ctx)
73 MONO_PERMIT (need (sgen_gc_locked));
76 * Clear ephemeron pairs with unreachable keys.
77 * We pass the copy func so we can figure out if an array was promoted or not.
79 void sgen_client_clear_unreachable_ephemerons (ScanCopyContext ctx)
80 MONO_PERMIT (need (sgen_gc_locked));
83 * May return NULL. Must be an aligned pointer.
85 gpointer sgen_client_default_metadata (void);
86 gpointer sgen_client_metadata_for_object (GCObject *obj);
91 void sgen_client_gchandle_created (int handle_type, GCObject *obj, guint32 handle);
92 void sgen_client_gchandle_destroyed (int handle_type, guint32 handle);
93 void sgen_client_ensure_weak_gchandles_accessible (void);
96 * This is called for objects that are larger than one card. If it's possible to scan only
97 * parts of the object based on which cards are marked, do so and return TRUE. Otherwise,
100 gboolean sgen_client_cardtable_scan_object (GCObject *obj, guint8 *cards, ScanCopyContext ctx);
103 * Called after nursery objects have been pinned. No action is necessary.
105 void sgen_client_nursery_objects_pinned (void **definitely_pinned, int count);
108 * Called at a semi-random point during minor collections. No action is necessary.
110 void sgen_client_collecting_minor (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue);
113 * Called at semi-random points during major collections. No action is necessary.
115 void sgen_client_collecting_major_1 (void);
116 void sgen_client_collecting_major_2 (void);
117 void sgen_client_collecting_major_3 (SgenPointerQueue *fin_ready_queue, SgenPointerQueue *critical_fin_queue);
120 * Called after a LOS object has been pinned. No action is necessary.
122 void sgen_client_pinned_los_object (GCObject *obj);
125 * Called for every degraded allocation. No action is necessary.
127 void sgen_client_degraded_allocation (void);
130 * Called whenever the amount of memory allocated for the managed heap changes. No action
133 void sgen_client_total_allocated_heap_changed (size_t allocated_heap_size);
136 * If the client has registered any internal memory types, this must return a string
137 * describing the given type. Only used for debugging.
139 const char* sgen_client_description_for_internal_mem_type (int type);
142 * Only used for debugging. `sgen_client_vtable_get_namespace()` may return NULL.
144 gboolean sgen_client_vtable_is_inited (GCVTable vtable);
145 const char* sgen_client_vtable_get_namespace (GCVTable vtable);
146 const char* sgen_client_vtable_get_name (GCVTable vtable);
149 * Called before starting collections. The world is already stopped. No action is
152 void sgen_client_pre_collection_checks (void);
155 * Must set the thread's thread info to `info`. If the thread's small ID was not already
156 * initialized in `sgen_client_init()` (for the main thread, usually), it must be done here.
158 * `stack_bottom_fallback` is the value passed through via `sgen_thread_attach()`.
160 void sgen_client_thread_attach (SgenThreadInfo* info);
162 void sgen_client_thread_detach_with_lock (SgenThreadInfo *p);
165 * Called on each worker thread when it starts up. Must initialize the thread's small ID.
167 void sgen_client_thread_register_worker (void);
170 * The least this function needs to do is scan all registers and thread stacks. To do this
171 * conservatively, use `sgen_conservatively_pin_objects_from()`.
173 void sgen_client_scan_thread_data (void *start_nursery, void *end_nursery, gboolean precise, ScanCopyContext ctx);
176 * Stop and restart the world, i.e., all threads that interact with the managed heap. For
177 * single-threaded programs this is a nop.
179 void sgen_client_stop_world (int generation)
180 MONO_PERMIT (need (sgen_gc_locked));
181 void sgen_client_restart_world (int generation, gint64 *stw_time)
182 MONO_PERMIT (need (sgen_gc_locked));
185 * Must return FALSE. The bridge is not supported outside of Mono.
187 gboolean sgen_client_bridge_need_processing (void);
190 * None of these should ever be called.
192 void sgen_client_bridge_reset_data (void);
193 void sgen_client_bridge_processing_stw_step (void);
194 void sgen_client_bridge_wait_for_processing (void);
195 void sgen_client_bridge_processing_finish (int generation);
196 gboolean sgen_client_bridge_is_bridge_object (GCObject *obj);
197 void sgen_client_bridge_register_finalized_object (GCObject *object);
200 * No action is necessary.
202 void sgen_client_mark_togglerefs (char *start, char *end, ScanCopyContext ctx);
203 void sgen_client_clear_togglerefs (char *start, char *end, ScanCopyContext ctx);
206 * Called to handle `MONO_GC_PARAMS` and `MONO_GC_DEBUG` options. The `handle` functions
207 * must return TRUE if they have recognized and processed the option, FALSE otherwise.
209 gboolean sgen_client_handle_gc_param (const char *opt);
210 void sgen_client_print_gc_params_usage (void);
211 gboolean sgen_client_handle_gc_debug (const char *opt);
212 void sgen_client_print_gc_debug_usage (void);
215 * Called to obtain an identifier for the current location, such as a method pointer. This
216 * is used for logging the provenances of allocations with the heavy binary protocol.
218 gpointer sgen_client_get_provenance (void);
221 * Called by the debugging infrastructure to describe pointers that have an invalid vtable.
222 * Should usually print to `stdout`.
224 void sgen_client_describe_invalid_pointer (GCObject *ptr);
227 * These client binary protocol functions are called from the respective binary protocol
228 * functions. No action is necessary. We suggest implementing them as inline functions in
229 * the client header file so that no overhead is incurred if they don't actually do
234 #define TYPE_LONGLONG long long
235 #define TYPE_SIZE size_t
236 #define TYPE_POINTER gpointer
237 #define TYPE_BOOL gboolean
239 #define BEGIN_PROTOCOL_ENTRY0(method) \
240 void sgen_client_ ## method (void);
241 #define BEGIN_PROTOCOL_ENTRY_HEAVY0(method) \
242 void sgen_client_ ## method (void);
243 #define BEGIN_PROTOCOL_ENTRY1(method,t1,f1) \
244 void sgen_client_ ## method (t1 f1);
245 #define BEGIN_PROTOCOL_ENTRY_HEAVY1(method,t1,f1) \
246 void sgen_client_ ## method (t1 f1);
247 #define BEGIN_PROTOCOL_ENTRY2(method,t1,f1,t2,f2) \
248 void sgen_client_ ## method (t1 f1, t2 f2);
249 #define BEGIN_PROTOCOL_ENTRY_HEAVY2(method,t1,f1,t2,f2) \
250 void sgen_client_ ## method (t1 f1, t2 f2);
251 #define BEGIN_PROTOCOL_ENTRY3(method,t1,f1,t2,f2,t3,f3) \
252 void sgen_client_ ## method (t1 f1, t2 f2, t3 f3);
253 #define BEGIN_PROTOCOL_ENTRY_HEAVY3(method,t1,f1,t2,f2,t3,f3) \
254 void sgen_client_ ## method (t1 f1, t2 f2, t3 f3);
255 #define BEGIN_PROTOCOL_ENTRY4(method,t1,f1,t2,f2,t3,f3,t4,f4) \
256 void sgen_client_ ## method (t1 f1, t2 f2, t3 f3, t4 f4);
257 #define BEGIN_PROTOCOL_ENTRY_HEAVY4(method,t1,f1,t2,f2,t3,f3,t4,f4) \
258 void sgen_client_ ## method (t1 f1, t2 f2, t3 f3, t4 f4);
259 #define BEGIN_PROTOCOL_ENTRY5(method,t1,f1,t2,f2,t3,f3,t4,f4,t5,f5) \
260 void sgen_client_ ## method (t1 f1, t2 f2, t3 f3, t4 f4, t5 f5);
261 #define BEGIN_PROTOCOL_ENTRY_HEAVY5(method,t1,f1,t2,f2,t3,f3,t4,f4,t5,f5) \
262 void sgen_client_ ## method (t1 f1, t2 f2, t3 f3, t4 f4, t5 f5);
263 #define BEGIN_PROTOCOL_ENTRY6(method,t1,f1,t2,f2,t3,f3,t4,f4,t5,f5,t6,f6) \
264 void sgen_client_ ## method (t1 f1, t2 f2, t3 f3, t4 f4, t5 f5, t6 f6);
265 #define BEGIN_PROTOCOL_ENTRY_HEAVY6(method,t1,f1,t2,f2,t3,f3,t4,f4,t5,f5,t6,f6) \
266 void sgen_client_ ## method (t1 f1, t2 f2, t3 f3, t4 f4, t5 f5, t6 f6);
268 #define DEFAULT_PRINT()
269 #define CUSTOM_PRINT(_)
271 #define IS_ALWAYS_MATCH(_)
272 #define MATCH_INDEX(_)
273 #define IS_VTABLE_MATCH(_)
275 #define END_PROTOCOL_ENTRY
276 #define END_PROTOCOL_ENTRY_FLUSH
277 #define END_PROTOCOL_ENTRY_HEAVY
279 #include "sgen-protocol-def.h"
287 #ifdef SGEN_WITHOUT_MONO
289 * Get the current thread's thread info. This will only be called on managed threads.
291 SgenThreadInfo* mono_thread_info_current (void);
294 * Get the current thread's small ID. This will be called on managed and worker threads.
296 int mono_thread_info_get_small_id (void);