mono/metadata/sgen-protocol.h

   1 /*
   2  * sgen-protocol.h: Binary protocol of internal activity, to aid
   3  * debugging.
   4  *
   5  * Copyright 2001-2003 Ximian, Inc
   6  * Copyright 2003-2010 Novell, Inc.
   7  * Copyright (C) 2012 Xamarin Inc
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License 2.0 as published by the Free Software Foundation;
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License 2.0 along with this library; if not, write to the Free
  20  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22
  23 #include "sgen-gc.h"
  24
  25 #ifdef SGEN_BINARY_PROTOCOL
  26
  27 enum {
  28         SGEN_PROTOCOL_COLLECTION_FORCE,
  29         SGEN_PROTOCOL_COLLECTION_BEGIN,
  30         SGEN_PROTOCOL_COLLECTION_END,
  31         SGEN_PROTOCOL_ALLOC,
  32         SGEN_PROTOCOL_COPY,
  33         SGEN_PROTOCOL_PIN,
  34         SGEN_PROTOCOL_MARK,
  35         SGEN_PROTOCOL_SCAN_BEGIN,
  36         SGEN_PROTOCOL_SCAN_VTYPE_BEGIN,
  37         SGEN_PROTOCOL_WBARRIER,
  38         SGEN_PROTOCOL_GLOBAL_REMSET,
  39         SGEN_PROTOCOL_PTR_UPDATE,
  40         SGEN_PROTOCOL_CLEANUP,
  41         SGEN_PROTOCOL_EMPTY,
  42         SGEN_PROTOCOL_THREAD_SUSPEND,
  43         SGEN_PROTOCOL_THREAD_RESTART,
  44         SGEN_PROTOCOL_THREAD_REGISTER,
  45         SGEN_PROTOCOL_THREAD_UNREGISTER,
  46         SGEN_PROTOCOL_MISSING_REMSET,
  47         SGEN_PROTOCOL_ALLOC_PINNED,
  48         SGEN_PROTOCOL_ALLOC_DEGRADED,
  49         SGEN_PROTOCOL_CARD_SCAN,
  50         SGEN_PROTOCOL_CEMENT,
  51         SGEN_PROTOCOL_CEMENT_RESET,
  52         SGEN_PROTOCOL_DISLINK_UPDATE
  53 };
  54
  55 typedef struct {
  56         int generation;
  57 } SGenProtocolCollectionForce;
  58
  59 typedef struct {
  60         int index, generation;
  61 } SGenProtocolCollection;
  62
  63 typedef struct {
  64         gpointer obj;
  65         gpointer vtable;
  66         int size;
  67 } SGenProtocolAlloc;
  68
  69 typedef struct {
  70         gpointer from;
  71         gpointer to;
  72         gpointer vtable;
  73         int size;
  74 } SGenProtocolCopy;
  75
  76 typedef struct {
  77         gpointer obj;
  78         gpointer vtable;
  79         int size;
  80 } SGenProtocolPin;
  81
  82 typedef struct {
  83         gpointer obj;
  84         gpointer vtable;
  85         int size;
  86 } SGenProtocolMark;
  87
  88 typedef struct {
  89         gpointer obj;
  90         gpointer vtable;
  91         int size;
  92 } SGenProtocolScanBegin;
  93
  94 typedef struct {
  95         gpointer obj;
  96         int size;
  97 } SGenProtocolScanVTypeBegin;
  98
  99 typedef struct {
 100         gpointer ptr;
 101         gpointer value;
 102         gpointer value_vtable;
 103 } SGenProtocolWBarrier;
 104
 105 typedef struct {
 106         gpointer ptr;
 107         gpointer value;
 108         gpointer value_vtable;
 109 } SGenProtocolGlobalRemset;
 110
 111 typedef struct {
 112         gpointer ptr;
 113         gpointer old_value;
 114         gpointer new_value;
 115         gpointer vtable;
 116         int size;
 117 } SGenProtocolPtrUpdate;
 118
 119 typedef struct {
 120         gpointer ptr;
 121         gpointer vtable;
 122         int size;
 123 } SGenProtocolCleanup;
 124
 125 typedef struct {
 126         gpointer start;
 127         int size;
 128 } SGenProtocolEmpty;
 129
 130 typedef struct {
 131         gpointer thread, stopped_ip;
 132 } SGenProtocolThreadSuspend;
 133
 134 typedef struct {
 135         gpointer thread;
 136 } SGenProtocolThreadRestart;
 137
 138 typedef struct {
 139         gpointer thread;
 140 } SGenProtocolThreadRegister;
 141
 142 typedef struct {
 143         gpointer thread;
 144 } SGenProtocolThreadUnregister;
 145
 146 typedef struct {
 147         gpointer obj;
 148         gpointer obj_vtable;
 149         int offset;
 150         gpointer value;
 151         gpointer value_vtable;
 152         int value_pinned;
 153 } SGenProtocolMissingRemset;
 154
 155 typedef struct {
 156         gpointer start;
 157         int size;
 158 } SGenProtocolCardScan;
 159
 160 typedef struct {
 161         gpointer obj;
 162         gpointer vtable;
 163         int size;
 164 } SGenProtocolCement;
 165
 166 typedef struct {
 167         gpointer link;
 168         gpointer obj;
 169         int track;
 170 } SGenProtocolDislinkUpdate;
 171
 172 /* missing: finalizers, dislinks, roots, non-store wbarriers */
 173
 174 void binary_protocol_init (const char *filename) MONO_INTERNAL;
 175 gboolean binary_protocol_is_enabled (void) MONO_INTERNAL;
 176
 177 void binary_protocol_flush_buffers (gboolean force) MONO_INTERNAL;
 178
 179 void binary_protocol_collection_force (int generation) MONO_INTERNAL;
 180 void binary_protocol_collection_begin (int index, int generation) MONO_INTERNAL;
 181 void binary_protocol_collection_end (int index, int generation) MONO_INTERNAL;
 182 void binary_protocol_alloc (gpointer obj, gpointer vtable, int size) MONO_INTERNAL;
 183 void binary_protocol_alloc_pinned (gpointer obj, gpointer vtable, int size) MONO_INTERNAL;
 184 void binary_protocol_alloc_degraded (gpointer obj, gpointer vtable, int size) MONO_INTERNAL;
 185 void binary_protocol_copy (gpointer from, gpointer to, gpointer vtable, int size) MONO_INTERNAL;
 186 void binary_protocol_pin (gpointer obj, gpointer vtable, int size) MONO_INTERNAL;
 187 void binary_protocol_mark (gpointer obj, gpointer vtable, int size) MONO_INTERNAL;
 188 void binary_protocol_scan_begin (gpointer obj, gpointer vtable, int size) MONO_INTERNAL;
 189 void binary_protocol_scan_vtype_begin (gpointer start, int size) MONO_INTERNAL;
 190 void binary_protocol_wbarrier (gpointer ptr, gpointer value, gpointer value_vtable) MONO_INTERNAL;
 191 void binary_protocol_global_remset (gpointer ptr, gpointer value, gpointer value_vtable) MONO_INTERNAL;
 192 void binary_protocol_ptr_update (gpointer ptr, gpointer old_value, gpointer new_value, gpointer vtable, int size) MONO_INTERNAL;
 193 void binary_protocol_cleanup (gpointer ptr, gpointer vtable, int size) MONO_INTERNAL;
 194 void binary_protocol_empty (gpointer start, int size) MONO_INTERNAL;
 195 void binary_protocol_thread_suspend (gpointer thread, gpointer stopped_ip) MONO_INTERNAL;
 196 void binary_protocol_thread_restart (gpointer thread) MONO_INTERNAL;
 197 void binary_protocol_thread_register (gpointer thread) MONO_INTERNAL;
 198 void binary_protocol_thread_unregister (gpointer thread) MONO_INTERNAL;
 199 void binary_protocol_missing_remset (gpointer obj, gpointer obj_vtable, int offset,
 200                 gpointer value, gpointer value_vtable, int value_pinned) MONO_INTERNAL;
 201 void binary_protocol_card_scan (gpointer start, int size) MONO_INTERNAL;
 202 void binary_protocol_cement (gpointer ptr, gpointer vtable, int size) MONO_INTERNAL;
 203 void binary_protocol_cement_reset (void) MONO_INTERNAL;
 204 void binary_protocol_dislink_update (gpointer link, gpointer obj, int track) MONO_INTERNAL;
 205
 206 #else
 207
 208 #define binary_protocol_is_enabled()    FALSE
 209
 210 #define binary_protocol_flush_buffers(force)
 211 #define binary_protocol_collection_force(generation)
 212 #define binary_protocol_collection_begin(index, generation)
 213 #define binary_protocol_collection_end(index, generation)
 214 #define binary_protocol_alloc(obj, vtable, size)
 215 #define binary_protocol_alloc_pinned(obj, vtable, size)
 216 #define binary_protocol_alloc_degraded(obj, vtable, size)
 217 #define binary_protocol_copy(from, to, vtable, size)
 218 #define binary_protocol_pin(obj, vtable, size)
 219 #define binary_protocol_mark(obj, vtable, size)
 220 #define binary_protocol_scan_begin(obj, vtable, size)
 221 #define binary_protocol_scan_vtype_begin(obj, size)
 222 #define binary_protocol_wbarrier(ptr, value, value_vtable)
 223 #define binary_protocol_global_remset(ptr, value, value_vtable)
 224 #define binary_protocol_ptr_update(ptr, old_value, new_value, vtable, size)
 225 #define binary_protocol_cleanup(ptr, vtable, size)
 226 #define binary_protocol_empty(start, size)
 227 #define binary_protocol_thread_suspend(thread, ip)
 228 #define binary_protocol_thread_restart(thread)
 229 #define binary_protocol_thread_register(thread)
 230 #define binary_protocol_thread_unregister(thread)
 231 #define binary_protocol_missing_remset(obj, obj_vtable, offset, value, value_vtable, value_pinned)
 232 #define binary_protocol_card_scan(start, size)
 233 #define binary_protocol_cement(ptr, vtable, size)
 234 #define binary_protocol_cement_reset()
 235 #define binary_protocol_dislink_update(link,obj,track)
 236
 237 #endif