mono/sgen/gc-internal-agnostic.h

   1 /*
   2  * gc-internal-agnostic.h: Mono-agnostic GC interface.
   3  *
   4  * Copyright (C) 2015 Xamarin Inc
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License 2.0 as published by the Free Software Foundation;
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License 2.0 along with this library; if not, write to the Free
  17  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  */
  19
  20 #ifndef __MONO_METADATA_GCINTERNALAGNOSTIC_H__
  21 #define __MONO_METADATA_GCINTERNALAGNOSTIC_H__
  22
  23 #include <config.h>
  24 #include <glib.h>
  25 #include <stdio.h>
  26
  27 #include "mono/utils/mono-compiler.h"
  28 #include "mono/utils/parse.h"
  29 #include "mono/utils/memfuncs.h"
  30 #ifdef HAVE_SGEN_GC
  31 #include "mono/sgen/sgen-conf.h"
  32 #endif
  33
  34 typedef struct {
  35         guint minor_gc_count;
  36         guint major_gc_count;
  37         guint64 minor_gc_time;
  38         guint64 major_gc_time;
  39         guint64 major_gc_time_concurrent;
  40 } GCStats;
  41
  42 extern GCStats gc_stats;
  43
  44 #ifdef HAVE_SGEN_GC
  45 typedef SgenDescriptor MonoGCDescriptor;
  46 #define MONO_GC_DESCRIPTOR_NULL SGEN_DESCRIPTOR_NULL
  47 #else
  48 typedef void* MonoGCDescriptor;
  49 #define MONO_GC_DESCRIPTOR_NULL NULL
  50 #endif
  51
  52 /*
  53  * Try to register a foreign thread with the GC, if we fail or the backend
  54  * can't cope with this concept - we return FALSE.
  55  */
  56 extern gboolean mono_gc_register_thread (void *baseptr);
  57
  58 gboolean mono_gc_parse_environment_string_extract_number (const char *str, size_t *out);
  59
  60 MonoGCDescriptor mono_gc_make_descr_for_object (gsize *bitmap, int numbits, size_t obj_size);
  61 MonoGCDescriptor mono_gc_make_descr_for_array (int vector, gsize *elem_bitmap, int numbits, size_t elem_size);
  62
  63 /* simple interface for data structures needed in the runtime */
  64 MonoGCDescriptor mono_gc_make_descr_from_bitmap (gsize *bitmap, int numbits);
  65
  66 /* Return a root descriptor for a root with all refs */
  67 MonoGCDescriptor mono_gc_make_root_descr_all_refs (int numbits);
  68
  69 /* Return the bitmap encoded by a descriptor */
  70 gsize* mono_gc_get_bitmap_for_descr (MonoGCDescriptor descr, int *numbits);
  71
  72 /*
  73 These functions must be used when it's possible that either destination is not
  74 word aligned or size is not a multiple of word size.
  75 */
  76 void mono_gc_bzero_atomic (void *dest, size_t size);
  77 void mono_gc_bzero_aligned (void *dest, size_t size);
  78 void mono_gc_memmove_atomic (void *dest, const void *src, size_t size);
  79 void mono_gc_memmove_aligned (void *dest, const void *src, size_t size);
  80
  81 FILE *mono_gc_get_logfile (void);
  82
  83 #endif