2 * sgen-protocol.c: Binary protocol of internal activity, to aid
5 * Copyright 2001-2003 Ximian, Inc
6 * Copyright 2003-2010 Novell, Inc.
7 * Copyright (C) 2012 Xamarin Inc
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;
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.
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.
27 #include "sgen-protocol.h"
28 #include "sgen-memory-governor.h"
29 #include "utils/mono-mmap.h"
30 #include "utils/mono-threads.h"
32 /* If not null, dump binary protocol to this file */
33 static FILE *binary_protocol_file = NULL;
35 /* We set this to -1 to indicate an exclusive lock */
36 static volatile int binary_protocol_use_count = 0;
38 #define BINARY_PROTOCOL_BUFFER_SIZE (65536 - 2 * 8)
40 typedef struct _BinaryProtocolBuffer BinaryProtocolBuffer;
41 struct _BinaryProtocolBuffer {
42 BinaryProtocolBuffer * volatile next;
44 unsigned char buffer [BINARY_PROTOCOL_BUFFER_SIZE];
47 static BinaryProtocolBuffer * volatile binary_protocol_buffers = NULL;
50 binary_protocol_init (const char *filename)
52 binary_protocol_file = fopen (filename, "w");
56 binary_protocol_is_enabled (void)
58 return binary_protocol_file != NULL;
62 try_lock_exclusive (void)
65 if (binary_protocol_use_count)
67 } while (InterlockedCompareExchange (&binary_protocol_use_count, -1, 0) != 0);
68 mono_memory_barrier ();
73 unlock_exclusive (void)
75 mono_memory_barrier ();
76 SGEN_ASSERT (0, binary_protocol_use_count == -1, "Exclusively locked count must be -1");
77 if (InterlockedCompareExchange (&binary_protocol_use_count, 0, -1) != -1)
78 SGEN_ASSERT (0, FALSE, "Somebody messed with the exclusive lock");
87 old_count = binary_protocol_use_count;
89 /* Exclusively locked - retry */
90 /* FIXME: short back-off */
93 } while (InterlockedCompareExchange (&binary_protocol_use_count, old_count + 1, old_count) != old_count);
94 mono_memory_barrier ();
98 unlock_recursive (void)
101 mono_memory_barrier ();
103 old_count = binary_protocol_use_count;
104 SGEN_ASSERT (0, old_count > 0, "Locked use count must be at least 1");
105 } while (InterlockedCompareExchange (&binary_protocol_use_count, old_count - 1, old_count) != old_count);
109 binary_protocol_flush_buffer (BinaryProtocolBuffer *buffer)
111 g_assert (buffer->index > 0);
112 fwrite (buffer->buffer, 1, buffer->index, binary_protocol_file);
114 sgen_free_os_memory (buffer, sizeof (BinaryProtocolBuffer), SGEN_ALLOC_INTERNAL);
118 binary_protocol_flush_buffers (gboolean force)
120 int num_buffers = 0, i;
121 BinaryProtocolBuffer *buf;
122 BinaryProtocolBuffer **bufs;
124 if (!binary_protocol_file)
127 if (!force && !try_lock_exclusive ())
130 for (buf = binary_protocol_buffers; buf != NULL; buf = buf->next)
132 bufs = sgen_alloc_internal_dynamic (num_buffers * sizeof (BinaryProtocolBuffer*), INTERNAL_MEM_BINARY_PROTOCOL, TRUE);
133 for (buf = binary_protocol_buffers, i = 0; buf != NULL; buf = buf->next, i++)
135 SGEN_ASSERT (0, i == num_buffers, "Binary protocol buffer count error");
137 binary_protocol_buffers = NULL;
139 for (i = num_buffers - 1; i >= 0; --i)
140 binary_protocol_flush_buffer (bufs [i]);
142 sgen_free_internal_dynamic (buf, num_buffers * sizeof (BinaryProtocolBuffer*), INTERNAL_MEM_BINARY_PROTOCOL);
147 fflush (binary_protocol_file);
150 static BinaryProtocolBuffer*
151 binary_protocol_get_buffer (int length)
153 BinaryProtocolBuffer *buffer, *new_buffer;
156 buffer = binary_protocol_buffers;
157 if (buffer && buffer->index + length <= BINARY_PROTOCOL_BUFFER_SIZE)
160 new_buffer = sgen_alloc_os_memory (sizeof (BinaryProtocolBuffer), SGEN_ALLOC_INTERNAL | SGEN_ALLOC_ACTIVATE, "debugging memory");
161 new_buffer->next = buffer;
162 new_buffer->index = 0;
164 if (InterlockedCompareExchangePointer ((void**)&binary_protocol_buffers, new_buffer, buffer) != buffer) {
165 sgen_free_os_memory (new_buffer, sizeof (BinaryProtocolBuffer), SGEN_ALLOC_INTERNAL);
174 protocol_entry (unsigned char type, gpointer data, int size)
177 BinaryProtocolBuffer *buffer;
179 if (!binary_protocol_file)
182 if (sgen_is_worker_thread (mono_native_thread_id_get ()))
188 buffer = binary_protocol_get_buffer (size + 1);
190 index = buffer->index;
191 if (index + 1 + size > BINARY_PROTOCOL_BUFFER_SIZE)
194 if (InterlockedCompareExchange (&buffer->index, index + 1 + size, index) != index)
195 goto retry_same_buffer;
197 /* FIXME: if we're interrupted at this point, we have a buffer
198 entry that contains random data. */
200 buffer->buffer [index++] = type;
201 memcpy (buffer->buffer + index, data, size);
204 g_assert (index <= BINARY_PROTOCOL_BUFFER_SIZE);
210 binary_protocol_collection_force (int generation)
212 SGenProtocolCollectionForce entry = { generation };
213 binary_protocol_flush_buffers (FALSE);
214 protocol_entry (SGEN_PROTOCOL_COLLECTION_FORCE, &entry, sizeof (SGenProtocolCollectionForce));
218 binary_protocol_collection_begin (int index, int generation)
220 SGenProtocolCollection entry = { index, generation };
221 binary_protocol_flush_buffers (FALSE);
222 protocol_entry (SGEN_PROTOCOL_COLLECTION_BEGIN, &entry, sizeof (SGenProtocolCollection));
226 binary_protocol_collection_end (int index, int generation)
228 SGenProtocolCollection entry = { index, generation };
229 binary_protocol_flush_buffers (FALSE);
230 protocol_entry (SGEN_PROTOCOL_COLLECTION_END, &entry, sizeof (SGenProtocolCollection));
234 binary_protocol_concurrent_start (void)
236 protocol_entry (SGEN_PROTOCOL_CONCURRENT_START, NULL, 0);
240 binary_protocol_concurrent_update_finish (void)
242 protocol_entry (SGEN_PROTOCOL_CONCURRENT_UPDATE_FINISH, NULL, 0);
246 binary_protocol_world_stopping (long long timestamp)
248 SGenProtocolWorldStopping entry = { timestamp };
249 protocol_entry (SGEN_PROTOCOL_WORLD_STOPPING, &entry, sizeof (SGenProtocolWorldStopping));
253 binary_protocol_world_stopped (long long timestamp, long long total_major_cards,
254 long long marked_major_cards, long long total_los_cards, long long marked_los_cards)
256 SGenProtocolWorldStopped entry = { timestamp, total_major_cards, marked_major_cards, total_los_cards, marked_los_cards };
257 protocol_entry (SGEN_PROTOCOL_WORLD_STOPPED, &entry, sizeof (SGenProtocolWorldStopped));
261 binary_protocol_world_restarting (int generation, long long timestamp,
262 long long total_major_cards, long long marked_major_cards, long long total_los_cards, long long marked_los_cards)
264 SGenProtocolWorldRestarting entry = { generation, timestamp, total_major_cards, marked_major_cards, total_los_cards, marked_los_cards };
265 protocol_entry (SGEN_PROTOCOL_WORLD_RESTARTING, &entry, sizeof (SGenProtocolWorldRestarting));
269 binary_protocol_world_restarted (int generation, long long timestamp)
271 SGenProtocolWorldRestarted entry = { generation, timestamp };
272 protocol_entry (SGEN_PROTOCOL_WORLD_RESTARTED, &entry, sizeof (SGenProtocolWorldRestarted));
276 binary_protocol_thread_suspend (gpointer thread, gpointer stopped_ip)
278 SGenProtocolThreadSuspend entry = { thread, stopped_ip };
279 protocol_entry (SGEN_PROTOCOL_THREAD_SUSPEND, &entry, sizeof (SGenProtocolThreadSuspend));
283 binary_protocol_thread_restart (gpointer thread)
285 SGenProtocolThreadRestart entry = { thread };
286 protocol_entry (SGEN_PROTOCOL_THREAD_RESTART, &entry, sizeof (SGenProtocolThreadRestart));
290 binary_protocol_thread_register (gpointer thread)
292 SGenProtocolThreadRegister entry = { thread };
293 protocol_entry (SGEN_PROTOCOL_THREAD_REGISTER, &entry, sizeof (SGenProtocolThreadRegister));
298 binary_protocol_thread_unregister (gpointer thread)
300 SGenProtocolThreadUnregister entry = { thread };
301 protocol_entry (SGEN_PROTOCOL_THREAD_UNREGISTER, &entry, sizeof (SGenProtocolThreadUnregister));
306 binary_protocol_missing_remset (gpointer obj, gpointer obj_vtable, int offset, gpointer value, gpointer value_vtable, int value_pinned)
308 SGenProtocolMissingRemset entry = { obj, obj_vtable, offset, value, value_vtable, value_pinned };
309 protocol_entry (SGEN_PROTOCOL_MISSING_REMSET, &entry, sizeof (SGenProtocolMissingRemset));
314 binary_protocol_cement (gpointer obj, gpointer vtable, int size)
316 SGenProtocolCement entry = { obj, vtable, size };
317 protocol_entry (SGEN_PROTOCOL_CEMENT, &entry, sizeof (SGenProtocolCement));
321 binary_protocol_cement_reset (void)
323 protocol_entry (SGEN_PROTOCOL_CEMENT_RESET, NULL, 0);
327 binary_protocol_domain_unload_begin (gpointer domain)
329 SGenProtocolDomainUnload entry = { domain };
330 protocol_entry (SGEN_PROTOCOL_DOMAIN_UNLOAD_BEGIN, &entry, sizeof (SGenProtocolDomainUnload));
334 binary_protocol_domain_unload_end (gpointer domain)
336 SGenProtocolDomainUnload entry = { domain };
337 protocol_entry (SGEN_PROTOCOL_DOMAIN_UNLOAD_END, &entry, sizeof (SGenProtocolDomainUnload));
340 #ifdef SGEN_HEAVY_BINARY_PROTOCOL
342 binary_protocol_alloc (gpointer obj, gpointer vtable, int size)
344 SGenProtocolAlloc entry = { obj, vtable, size };
345 protocol_entry (SGEN_PROTOCOL_ALLOC, &entry, sizeof (SGenProtocolAlloc));
349 binary_protocol_alloc_pinned (gpointer obj, gpointer vtable, int size)
351 SGenProtocolAlloc entry = { obj, vtable, size };
352 protocol_entry (SGEN_PROTOCOL_ALLOC_PINNED, &entry, sizeof (SGenProtocolAlloc));
356 binary_protocol_alloc_degraded (gpointer obj, gpointer vtable, int size)
358 SGenProtocolAlloc entry = { obj, vtable, size };
359 protocol_entry (SGEN_PROTOCOL_ALLOC_DEGRADED, &entry, sizeof (SGenProtocolAlloc));
363 binary_protocol_copy (gpointer from, gpointer to, gpointer vtable, int size)
365 SGenProtocolCopy entry = { from, to, vtable, size };
366 protocol_entry (SGEN_PROTOCOL_COPY, &entry, sizeof (SGenProtocolCopy));
370 binary_protocol_pin (gpointer obj, gpointer vtable, int size)
372 SGenProtocolPin entry = { obj, vtable, size };
373 protocol_entry (SGEN_PROTOCOL_PIN, &entry, sizeof (SGenProtocolPin));
377 binary_protocol_mark (gpointer obj, gpointer vtable, int size)
379 SGenProtocolMark entry = { obj, vtable, size };
380 protocol_entry (SGEN_PROTOCOL_MARK, &entry, sizeof (SGenProtocolMark));
384 binary_protocol_scan_begin (gpointer obj, gpointer vtable, int size)
386 SGenProtocolScanBegin entry = { obj, vtable, size };
387 protocol_entry (SGEN_PROTOCOL_SCAN_BEGIN, &entry, sizeof (SGenProtocolScanBegin));
391 binary_protocol_scan_vtype_begin (gpointer obj, int size)
393 SGenProtocolScanVTypeBegin entry = { obj, size };
394 protocol_entry (SGEN_PROTOCOL_SCAN_VTYPE_BEGIN, &entry, sizeof (SGenProtocolScanVTypeBegin));
398 binary_protocol_wbarrier (gpointer ptr, gpointer value, gpointer value_vtable)
400 SGenProtocolWBarrier entry = { ptr, value, value_vtable };
401 protocol_entry (SGEN_PROTOCOL_WBARRIER, &entry, sizeof (SGenProtocolWBarrier));
405 binary_protocol_global_remset (gpointer ptr, gpointer value, gpointer value_vtable)
407 SGenProtocolGlobalRemset entry = { ptr, value, value_vtable };
408 protocol_entry (SGEN_PROTOCOL_GLOBAL_REMSET, &entry, sizeof (SGenProtocolGlobalRemset));
412 binary_protocol_ptr_update (gpointer ptr, gpointer old_value, gpointer new_value, gpointer vtable, int size)
414 SGenProtocolPtrUpdate entry = { ptr, old_value, new_value, vtable, size };
415 protocol_entry (SGEN_PROTOCOL_PTR_UPDATE, &entry, sizeof (SGenProtocolPtrUpdate));
419 binary_protocol_cleanup (gpointer ptr, gpointer vtable, int size)
421 SGenProtocolCleanup entry = { ptr, vtable, size };
422 protocol_entry (SGEN_PROTOCOL_CLEANUP, &entry, sizeof (SGenProtocolCleanup));
426 binary_protocol_empty (gpointer start, int size)
428 SGenProtocolEmpty entry = { start, size };
429 protocol_entry (SGEN_PROTOCOL_EMPTY, &entry, sizeof (SGenProtocolEmpty));
433 binary_protocol_card_scan (gpointer start, int size)
435 SGenProtocolCardScan entry = { start, size };
436 protocol_entry (SGEN_PROTOCOL_CARD_SCAN, &entry, sizeof (SGenProtocolCardScan));
440 binary_protocol_dislink_update (gpointer link, gpointer obj, int track, int staged)
442 SGenProtocolDislinkUpdate entry = { link, obj, track, staged };
443 protocol_entry (SGEN_PROTOCOL_DISLINK_UPDATE, &entry, sizeof (SGenProtocolDislinkUpdate));
447 binary_protocol_dislink_update_staged (gpointer link, gpointer obj, int track, int index)
449 SGenProtocolDislinkUpdateStaged entry = { link, obj, track, index };
450 protocol_entry (SGEN_PROTOCOL_DISLINK_UPDATE_STAGED, &entry, sizeof (SGenProtocolDislinkUpdateStaged));
454 binary_protocol_dislink_process_staged (gpointer link, gpointer obj, int index)
456 SGenProtocolDislinkProcessStaged entry = { link, obj, index };
457 protocol_entry (SGEN_PROTOCOL_DISLINK_PROCESS_STAGED, &entry, sizeof (SGenProtocolDislinkProcessStaged));
461 binary_protocol_gray_enqueue (gpointer queue, gpointer cursor, gpointer value)
463 SGenProtocolGrayQueue entry = { queue, cursor, value };
464 protocol_entry (SGEN_PROTOCOL_GRAY_ENQUEUE, &entry, sizeof (SGenProtocolGrayQueue));
468 binary_protocol_gray_dequeue (gpointer queue, gpointer cursor, gpointer value)
470 SGenProtocolGrayQueue entry = { queue, cursor, value };
471 protocol_entry (SGEN_PROTOCOL_GRAY_DEQUEUE, &entry, sizeof (SGenProtocolGrayQueue));
475 #endif /* HAVE_SGEN_GC */