mono/metadata/sgen-bridge.h

   1 /*
   2  * Copyright 2011 Novell, Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sublicense, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  19  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  20  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #ifndef _MONO_SGEN_BRIDGE_H_
  25 #define _MONO_SGEN_BRIDGE_H_
  26
  27 #include <mono/utils/mono-publib.h>
  28
  29 MONO_BEGIN_DECLS
  30
  31 enum {
  32         SGEN_BRIDGE_VERSION = 4
  33 };
  34
  35 typedef enum {
  36         /* Instances of this class should be scanned when computing the transitive dependency among bridges. E.g. List<object>*/
  37         GC_BRIDGE_TRANSPARENT_CLASS,
  38         /* Instances of this class should not be scanned when computing the transitive dependency among bridges. E.g. String*/
  39         GC_BRIDGE_OPAQUE_CLASS,
  40         /* Instances of this class should be bridged and have their dependency computed. */
  41         GC_BRIDGE_TRANSPARENT_BRIDGE_CLASS,
  42         /* Instances of this class should be bridged but no dependencies should not be calculated. */
  43         GC_BRIDGE_OPAQUE_BRIDGE_CLASS,
  44 } MonoGCBridgeObjectKind;
  45
  46 typedef struct {
  47         mono_bool is_alive;     /* to be set by the cross reference callback */
  48         int num_objs;
  49         MonoObject *objs [MONO_ZERO_LEN_ARRAY];
  50 } MonoGCBridgeSCC;
  51
  52 typedef struct {
  53         int src_scc_index;
  54         int dst_scc_index;
  55 } MonoGCBridgeXRef;
  56
  57 typedef struct {
  58         int bridge_version;
  59         MonoGCBridgeObjectKind (*bridge_class_kind) (MonoClass *klass);
  60         mono_bool (*is_bridge_object) (MonoObject *object);
  61         void (*cross_references) (int num_sccs, MonoGCBridgeSCC **sccs, int num_xrefs, MonoGCBridgeXRef *xrefs);
  62 } MonoGCBridgeCallbacks;
  63
  64 MONO_API void mono_gc_register_bridge_callbacks (MonoGCBridgeCallbacks *callbacks);
  65
  66 MONO_API void mono_gc_wait_for_bridge_processing (void);
  67
  68 MONO_END_DECLS
  69
  70 #endif