2 * Functions that are in the (historical) embedding API
3 * but must not be used by the runtime. Often
4 * just a thin wrapper mono_foo => mono_foo_internal.
6 * Copyright 2018 Microsoft
7 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
10 // FIXME In order to confirm this is all extern_only,
11 // a variant of the runtime should be linked without it.
14 #include "class-internals.h"
15 #include "domain-internals.h"
16 #include "mono-hash-internals.h"
17 #include "mono-config-internals.h"
18 #include "object-internals.h"
19 #include "class-init.h"
22 #include "assembly-internals.h"
23 #include "external-only.h"
25 #include "threads-types.h"
29 * \param obj managed object to get a handle for
30 * \param pinned whether the object should be pinned
31 * This returns a handle that wraps the object, this is used to keep a
32 * reference to a managed object from the unmanaged world and preventing the
33 * object from being disposed.
35 * If \p pinned is false the address of the object can not be obtained, if it is
36 * true the address of the object can be obtained. This will also pin the
37 * object so it will not be possible by a moving garbage collector to move the
40 * \returns a handle that can be used to access the object from unmanaged code.
43 mono_gchandle_new (MonoObject
*obj
, mono_bool pinned
)
45 MONO_EXTERNAL_ONLY_GC_UNSAFE (uint32_t, mono_gchandle_new_internal (obj
, pinned
));
49 * mono_gchandle_new_weakref:
50 * \param obj managed object to get a handle for
51 * \param track_resurrection Determines how long to track the object, if this is set to TRUE, the object is tracked after finalization, if FALSE, the object is only tracked up until the point of finalization.
53 * This returns a weak handle that wraps the object, this is used to
54 * keep a reference to a managed object from the unmanaged world.
55 * Unlike the \c mono_gchandle_new_internal the object can be reclaimed by the
56 * garbage collector. In this case the value of the GCHandle will be
59 * If \p track_resurrection is TRUE the object will be tracked through
60 * finalization and if the object is resurrected during the execution
61 * of the finalizer, then the returned weakref will continue to hold
62 * a reference to the object. If \p track_resurrection is FALSE, then
63 * the weak reference's target will become NULL as soon as the object
64 * is passed on to the finalizer.
66 * \returns a handle that can be used to access the object from
70 mono_gchandle_new_weakref (MonoObject
*obj
, mono_bool track_resurrection
)
72 MONO_EXTERNAL_ONLY_GC_UNSAFE (uint32_t, mono_gchandle_new_weakref_internal (obj
, track_resurrection
));
76 * mono_gchandle_get_target:
77 * \param gchandle a GCHandle's handle.
79 * The handle was previously created by calling \c mono_gchandle_new or
80 * \c mono_gchandle_new_weakref.
82 * \returns a pointer to the \c MonoObject* represented by the handle or
83 * NULL for a collected object if using a weakref handle.
86 mono_gchandle_get_target (uint32_t gchandle
)
88 MONO_EXTERNAL_ONLY_GC_UNSAFE (MonoObject
*, mono_gchandle_get_target_internal (gchandle
));
93 * \param gchandle a GCHandle's handle.
95 * Frees the \p gchandle handle. If there are no outstanding
96 * references, the garbage collector can reclaim the memory of the
100 mono_gchandle_free (uint32_t gchandle
)
102 /* Xamarin.Mac and Xamarin.iOS can call this from a worker thread
103 * that's not attached to the runtime. This is okay for SGen because
104 * the gchandle code is lockfree. SGen calls back into Mono which
105 * fires a profiler event, so the profiler must be prepared to be
106 * called from threads that aren't attached to Mono. */
107 MONO_EXTERNAL_ONLY_VOID (mono_gchandle_free_internal (gchandle
));
110 /* GC write barriers support */
113 * mono_gc_wbarrier_set_field:
114 * \param obj object containing the destination field
115 * \param field_ptr address of field inside the object
116 * \param value reference to the object to be stored
117 * Stores an object reference inside another object, executing a write barrier
121 mono_gc_wbarrier_set_field (MonoObject
*obj
, void* field_ptr
, MonoObject
* value
)
123 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_gc_wbarrier_set_field_internal (obj
, field_ptr
, value
));
127 * mono_gc_wbarrier_set_arrayref:
128 * \param arr array containing the destination slot
129 * \param slot_ptr address of slot inside the array
130 * \param value reference to the object to be stored
131 * Stores an object reference inside an array of objects, executing a write
135 mono_gc_wbarrier_set_arrayref (MonoArray
*arr
, void* slot_ptr
, MonoObject
* value
)
137 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_gc_wbarrier_set_arrayref_internal (arr
, slot_ptr
, value
));
141 * mono_gc_wbarrier_arrayref_copy:
142 * \param dest_ptr destination slot address
143 * \param src_ptr source slot address
144 * \param count number of references to copy
145 * Copies \p count references from one array to another, executing a write
149 mono_gc_wbarrier_arrayref_copy (void* dest_ptr
, /*const*/ void* src_ptr
, int count
)
151 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_gc_wbarrier_arrayref_copy_internal (dest_ptr
, src_ptr
, count
));
155 * mono_gc_wbarrier_generic_store:
156 * \param ptr address of field
157 * \param obj object to store
158 * Stores the \p value object inside the field represented by \p ptr,
159 * executing a write barrier if needed.
162 mono_gc_wbarrier_generic_store (void* ptr
, MonoObject
* value
)
164 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_gc_wbarrier_generic_store_internal (ptr
, value
));
168 * mono_gc_wbarrier_generic_store_atomic:
169 * Same as \c mono_gc_wbarrier_generic_store but performs the store
170 * as an atomic operation with release semantics.
173 mono_gc_wbarrier_generic_store_atomic (void *ptr
, MonoObject
*value
)
175 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_gc_wbarrier_generic_store_atomic_internal (ptr
, value
));
179 * mono_gc_wbarrier_generic_nostore:
180 * Executes a write barrier for an address, informing the GC that
181 * the reference stored at that address has been changed.
184 mono_gc_wbarrier_generic_nostore (void* ptr
)
186 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_gc_wbarrier_generic_nostore_internal (ptr
));
190 * mono_gc_wbarrier_object_copy:
191 * \param dest destination address
192 * \param src source address
193 * \param count number of elements to copy
194 * \param klass type of elements to copy
195 * Copies \p count elements of type \p klass from \p src address to
196 * \dest address, executing any necessary write barriers.
199 mono_gc_wbarrier_value_copy (void* dest
, /*const*/ void* src
, int count
, MonoClass
*klass
)
201 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_gc_wbarrier_value_copy_internal (dest
, src
, count
, klass
));
205 * mono_gc_wbarrier_object_copy:
206 * \param obj destination object
207 * \param src source object
208 * Copies contents of \p src to \p obj, executing any necessary write
212 mono_gc_wbarrier_object_copy (MonoObject
* obj
, MonoObject
*src
)
214 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_gc_wbarrier_object_copy_internal (obj
, src
));
219 * \param klass the class to initialize
221 * Compute the \c instance_size, \c class_size and other infos that cannot be
222 * computed at \c mono_class_get time. Also compute vtable_size if possible.
223 * Initializes the following fields in \p klass:
224 * - all the fields initialized by \c mono_class_init_sizes
229 * LOCKING: Acquires the loader lock.
231 * \returns TRUE on success or FALSE if there was a problem in loading
232 * the type (incorrect assemblies, missing assemblies, methods, etc).
235 mono_class_init (MonoClass
*klass
)
237 MONO_EXTERNAL_ONLY_GC_UNSAFE (gboolean
, mono_class_init_internal (klass
));
241 * mono_g_hash_table_new_type:
244 mono_g_hash_table_new_type (GHashFunc hash_func
, GEqualFunc key_equal_func
, MonoGHashGCType type
, MonoGCRootSource source
, void *key
, const char *msg
)
246 MONO_EXTERNAL_ONLY_GC_UNSAFE (MonoGHashTable
*, mono_g_hash_table_new_type_internal (hash_func
, key_equal_func
, type
, source
, key
, msg
));
250 * mono_config_for_assembly:
253 mono_config_for_assembly (MonoImage
*assembly
)
255 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_config_for_assembly_internal (assembly
));
259 * mono_class_get_property_from_name:
260 * \param klass a class
261 * \param name name of the property to lookup in the specified class
263 * Use this method to lookup a property in a class
264 * \returns the \c MonoProperty with the given name, or NULL if the property
265 * does not exist on the \p klass.
268 mono_class_get_property_from_name (MonoClass
*klass
, const char *name
)
270 MONO_EXTERNAL_ONLY_GC_UNSAFE (MonoProperty
*, mono_class_get_property_from_name_internal (klass
, name
));
274 * mono_class_is_subclass_of:
275 * \param klass class to probe if it is a subclass of another one
276 * \param klassc the class we suspect is the base class
277 * \param check_interfaces whether we should perform interface checks
279 * This method determines whether \p klass is a subclass of \p klassc.
281 * If the \p check_interfaces flag is set, then if \p klassc is an interface
282 * this method return TRUE if the \p klass implements the interface or
283 * if \p klass is an interface, if one of its base classes is \p klass.
285 * If \p check_interfaces is false, then if \p klass is not an interface,
286 * it returns TRUE if the \p klass is a subclass of \p klassc.
288 * if \p klass is an interface and \p klassc is \c System.Object, then this function
293 mono_class_is_subclass_of (MonoClass
*klass
, MonoClass
*klassc
, gboolean check_interfaces
)
295 MONO_EXTERNAL_ONLY_GC_UNSAFE (gboolean
, mono_class_is_subclass_of_internal (klass
, klassc
, check_interfaces
));
299 * mono_domain_set_internal:
300 * \param domain the new domain
302 * Sets the current domain to \p domain.
305 mono_domain_set_internal (MonoDomain
*domain
)
307 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_domain_set_internal_with_options (domain
, TRUE
));
312 * \param domain domain
313 * \param force force setting.
315 * Set the current appdomain to \p domain. If \p force is set, set it even
316 * if it is being unloaded.
318 * \returns TRUE on success; FALSE if the domain is unloaded
321 mono_domain_set (MonoDomain
*domain
, gboolean force
)
323 if (!force
&& domain
->state
== MONO_APPDOMAIN_UNLOADED
)
326 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_domain_set_internal_with_options (domain
, TRUE
));
331 * mono_assembly_name_free:
332 * \param aname assembly name to free
334 * Frees the provided assembly name object.
335 * (it does not frees the object itself, only the name members).
338 mono_assembly_name_free (MonoAssemblyName
*aname
)
342 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_assembly_name_free_internal (aname
));
346 * mono_thread_manage:
350 mono_thread_manage (void)
352 MONO_EXTERNAL_ONLY_GC_UNSAFE_VOID (mono_thread_manage_internal ());