mono/sgen/gc-internal-agnostic.h

   1 /**
   2  * \file
   3  * Mono-agnostic GC interface.
   4  *
   5  * Copyright (C) 2015 Xamarin Inc
   6  *
   7  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
   8  */
   9
  10 #ifndef __MONO_METADATA_GCINTERNALAGNOSTIC_H__
  11 #define __MONO_METADATA_GCINTERNALAGNOSTIC_H__
  12
  13 #include <config.h>
  14 #include <glib.h>
  15 #include <stdio.h>
  16
  17 #include "mono/utils/ward.h"
  18 #include "mono/utils/mono-compiler.h"
  19 #include "mono/utils/parse.h"
  20 #include "mono/utils/memfuncs.h"
  21 #ifdef HAVE_SGEN_GC
  22 #include "mono/sgen/sgen-conf.h"
  23 #endif
  24
  25 /* h indicates whether to hide or just tag.
  26  * (-!!h ^ p) is used instead of (h ? ~p : p) to avoid multiple mentions of p.
  27  */
  28 #define MONO_GC_HIDE_POINTER(p,t,h) ((gpointer)(((-(size_t)!!(h) ^ (size_t)(p)) & ~(size_t)3) | ((t) & (size_t)3)))
  29 #define MONO_GC_REVEAL_POINTER(p,h) ((gpointer)((-(size_t)!!(h) ^ (size_t)(p)) & ~(size_t)3))
  30
  31 #define MONO_GC_POINTER_TAG(p) ((size_t)(p) & (size_t)3)
  32
  33 #define MONO_GC_HANDLE_OCCUPIED_MASK (1)
  34 #define MONO_GC_HANDLE_VALID_MASK (2)
  35 #define MONO_GC_HANDLE_TAG_MASK (MONO_GC_HANDLE_OCCUPIED_MASK | MONO_GC_HANDLE_VALID_MASK)
  36
  37 #define MONO_GC_HANDLE_METADATA_POINTER(p,h) (MONO_GC_HIDE_POINTER ((p), MONO_GC_HANDLE_OCCUPIED_MASK, (h)))
  38 #define MONO_GC_HANDLE_OBJECT_POINTER(p,h) (MONO_GC_HIDE_POINTER ((p), MONO_GC_HANDLE_OCCUPIED_MASK | MONO_GC_HANDLE_VALID_MASK, (h)))
  39
  40 #define MONO_GC_HANDLE_OCCUPIED(slot) ((size_t)(slot) & MONO_GC_HANDLE_OCCUPIED_MASK)
  41 #define MONO_GC_HANDLE_VALID(slot) ((size_t)(slot) & MONO_GC_HANDLE_VALID_MASK)
  42
  43 #define MONO_GC_HANDLE_TAG(slot) ((size_t)(slot) & MONO_GC_HANDLE_TAG_MASK)
  44
  45 #define MONO_GC_HANDLE_IS_OBJECT_POINTER(slot) (MONO_GC_HANDLE_TAG (slot) == (MONO_GC_HANDLE_OCCUPIED_MASK | MONO_GC_HANDLE_VALID_MASK))
  46 #define MONO_GC_HANDLE_IS_METADATA_POINTER(slot) (MONO_GC_HANDLE_TAG (slot) == MONO_GC_HANDLE_OCCUPIED_MASK)
  47
  48 typedef enum {
  49         HANDLE_TYPE_MIN = 0,
  50         HANDLE_WEAK = HANDLE_TYPE_MIN,
  51         HANDLE_WEAK_TRACK,
  52         HANDLE_NORMAL,
  53         HANDLE_PINNED,
  54         HANDLE_TYPE_MAX
  55 } GCHandleType;
  56
  57 #define GC_HANDLE_TYPE_IS_WEAK(x) ((x) <= HANDLE_WEAK_TRACK)
  58
  59 #define MONO_GC_HANDLE_TYPE_SHIFT (3)
  60 #define MONO_GC_HANDLE_TYPE_MASK ((1 << MONO_GC_HANDLE_TYPE_SHIFT) - 1)
  61 #define MONO_GC_HANDLE_TYPE(x) ((GCHandleType)(((x) & MONO_GC_HANDLE_TYPE_MASK) - 1))
  62 #define MONO_GC_HANDLE_SLOT(x) ((x) >> MONO_GC_HANDLE_TYPE_SHIFT)
  63 #define MONO_GC_HANDLE_TYPE_IS_WEAK(x) ((x) <= HANDLE_WEAK_TRACK)
  64 #define MONO_GC_HANDLE(slot, type) (((slot) << MONO_GC_HANDLE_TYPE_SHIFT) | (((type) & MONO_GC_HANDLE_TYPE_MASK) + 1))
  65
  66 typedef struct {
  67         gint32 minor_gc_count;
  68         gint32 major_gc_count;
  69         gint64 minor_gc_time;
  70         gint64 major_gc_time;
  71         gint64 major_gc_time_concurrent;
  72 } GCStats;
  73
  74 extern GCStats gc_stats;
  75
  76 #ifdef HAVE_SGEN_GC
  77 typedef SgenDescriptor MonoGCDescriptor;
  78 #define MONO_GC_DESCRIPTOR_NULL SGEN_DESCRIPTOR_NULL
  79 #else
  80 typedef void* MonoGCDescriptor;
  81 #define MONO_GC_DESCRIPTOR_NULL NULL
  82 #endif
  83
  84 gboolean mono_gc_parse_environment_string_extract_number (const char *str, size_t *out);
  85
  86 MonoGCDescriptor mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size)
  87     MONO_PERMIT (need (sgen_lock_gc));
  88 MonoGCDescriptor mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size)
  89     MONO_PERMIT (need (sgen_lock_gc));
  90
  91 /* simple interface for data structures needed in the runtime */
  92 MonoGCDescriptor mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits)
  93     MONO_PERMIT (need (sgen_lock_gc));
  94
  95 /* Return a root descriptor for a vector with repeating refs bitmap */
  96 MonoGCDescriptor mono_gc_make_vector_descr (void);
  97
  98 /* Return a root descriptor for a root with all refs */
  99 MonoGCDescriptor mono_gc_make_root_descr_all_refs (int numbits)
 100     MONO_PERMIT (need (sgen_lock_gc));
 101
 102 /* Return the bitmap encoded by a descriptor */
 103 gsize* mono_gc_get_bitmap_for_descr (MonoGCDescriptor descr, int *numbits);
 104
 105 /*
 106 These functions must be used when it's possible that either destination is not
 107 word aligned or size is not a multiple of word size.
 108 */
 109 void mono_gc_bzero_atomic (void *dest, size_t size);
 110 void mono_gc_bzero_aligned (void *dest, size_t size);
 111 void mono_gc_memmove_atomic (void *dest, const void *src, size_t size);
 112 void mono_gc_memmove_aligned (void *dest, const void *src, size_t size);
 113
 114 FILE *mono_gc_get_logfile (void);
 115
 116 /* equivalent to options set via MONO_GC_PARAMS */
 117 void mono_gc_params_set (const char* options);
 118 /* equivalent to options set via MONO_GC_DEBUG */
 119 void mono_gc_debug_set (const char* options);
 120
 121 #endif