[docs] Enable documentation for sgen.
[mono.git] / mono / sgen / sgen-minor-scan-object.h
1 /**
2  * \file
3  * Object scanning in the nursery collectors.
4  *
5  * Copyright 2001-2003 Ximian, Inc
6  * Copyright 2003-2010 Novell, Inc.
7  * Copyright (C) 2012 Xamarin Inc
8  *
9  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
10  */
11
12 extern guint64 stat_scan_object_called_nursery;
13
14 #undef SERIAL_SCAN_OBJECT
15 #undef SERIAL_SCAN_VTYPE
16 #undef SERIAL_SCAN_PTR_FIELD
17 #undef SERIAL_DRAIN_GRAY_STACK
18
19 #if defined(SGEN_SIMPLE_NURSERY)
20
21 #ifdef SGEN_CONCURRENT_MAJOR
22 #define SERIAL_SCAN_OBJECT simple_nursery_serial_with_concurrent_major_scan_object
23 #define SERIAL_SCAN_VTYPE simple_nursery_serial_with_concurrent_major_scan_vtype
24 #define SERIAL_SCAN_PTR_FIELD simple_nursery_serial_with_concurrent_major_scan_ptr_field
25 #define SERIAL_DRAIN_GRAY_STACK simple_nursery_serial_with_concurrent_major_drain_gray_stack
26 #else
27 #define SERIAL_SCAN_OBJECT simple_nursery_serial_scan_object
28 #define SERIAL_SCAN_VTYPE simple_nursery_serial_scan_vtype
29 #define SERIAL_SCAN_PTR_FIELD simple_nursery_serial_scan_ptr_field
30 #define SERIAL_DRAIN_GRAY_STACK simple_nursery_serial_drain_gray_stack
31 #endif
32
33 #elif defined (SGEN_SPLIT_NURSERY)
34
35 #ifdef SGEN_CONCURRENT_MAJOR
36 #define SERIAL_SCAN_OBJECT split_nursery_serial_with_concurrent_major_scan_object
37 #define SERIAL_SCAN_VTYPE split_nursery_serial_with_concurrent_major_scan_vtype
38 #define SERIAL_SCAN_PTR_FIELD split_nursery_serial_with_concurrent_major_scan_ptr_field
39 #define SERIAL_DRAIN_GRAY_STACK split_nursery_serial_with_concurrent_major_drain_gray_stack
40 #else
41 #define SERIAL_SCAN_OBJECT split_nursery_serial_scan_object
42 #define SERIAL_SCAN_VTYPE split_nursery_serial_scan_vtype
43 #define SERIAL_SCAN_PTR_FIELD split_nursery_serial_scan_ptr_field
44 #define SERIAL_DRAIN_GRAY_STACK split_nursery_serial_drain_gray_stack
45 #endif
46
47 #else
48 #error "No nursery configuration specified"
49 #endif
50
51 #undef HANDLE_PTR
52 /* Global remsets are handled in SERIAL_COPY_OBJECT_FROM_OBJ */
53 #define HANDLE_PTR(ptr,obj)     do {    \
54                 void *__old = *(ptr);   \
55                 SGEN_OBJECT_LAYOUT_STATISTICS_MARK_BITMAP ((obj), (ptr)); \
56                 binary_protocol_scan_process_reference ((full_object), (ptr), __old); \
57                 if (__old) {    \
58                         SERIAL_COPY_OBJECT_FROM_OBJ ((ptr), queue);     \
59                         SGEN_COND_LOG (9, __old != *(ptr), "Overwrote field at %p with %p (was: %p)", (ptr), *(ptr), __old); \
60                 }       \
61         } while (0)
62
63 static void
64 SERIAL_SCAN_OBJECT (GCObject *full_object, SgenDescriptor desc, SgenGrayQueue *queue)
65 {
66         char *start = (char*)full_object;
67
68         SGEN_OBJECT_LAYOUT_STATISTICS_DECLARE_BITMAP;
69
70 #ifdef HEAVY_STATISTICS
71         sgen_descriptor_count_scanned_object (desc);
72 #endif
73
74         SGEN_ASSERT (9, sgen_get_current_collection_generation () == GENERATION_NURSERY, "Must not use minor scan during major collection.");
75
76 #define SCAN_OBJECT_PROTOCOL
77 #include "sgen-scan-object.h"
78
79         SGEN_OBJECT_LAYOUT_STATISTICS_COMMIT_BITMAP;
80         HEAVY_STAT (++stat_scan_object_called_nursery);
81 }
82
83 static void
84 SERIAL_SCAN_VTYPE (GCObject *full_object, char *start, SgenDescriptor desc, SgenGrayQueue *queue BINARY_PROTOCOL_ARG (size_t size))
85 {
86         SGEN_OBJECT_LAYOUT_STATISTICS_DECLARE_BITMAP;
87
88         SGEN_ASSERT (9, sgen_get_current_collection_generation () == GENERATION_NURSERY, "Must not use minor scan during major collection.");
89
90         /* The descriptors include info about the MonoObject header as well */
91         start -= SGEN_CLIENT_OBJECT_HEADER_SIZE;
92
93 #define SCAN_OBJECT_NOVTABLE
94 #define SCAN_OBJECT_PROTOCOL
95 #include "sgen-scan-object.h"
96 }
97
98 static void
99 SERIAL_SCAN_PTR_FIELD (GCObject *full_object, GCObject **ptr, SgenGrayQueue *queue)
100 {
101         HANDLE_PTR (ptr, NULL);
102 }
103
104 static gboolean
105 SERIAL_DRAIN_GRAY_STACK (SgenGrayQueue *queue)
106 {
107         for (;;) {
108                 GCObject *obj;
109                 SgenDescriptor desc;
110
111                 GRAY_OBJECT_DEQUEUE_SERIAL (queue, &obj, &desc);
112                 if (!obj)
113                         return TRUE;
114
115                 SERIAL_SCAN_OBJECT (obj, desc, queue);
116         }
117 }
118
119 #define FILL_MINOR_COLLECTOR_SCAN_OBJECT(ops)   do {                    \
120                 (ops)->scan_object = SERIAL_SCAN_OBJECT;                        \
121                 (ops)->scan_vtype = SERIAL_SCAN_VTYPE;                  \
122                 (ops)->scan_ptr_field = SERIAL_SCAN_PTR_FIELD;          \
123                 (ops)->drain_gray_stack = SERIAL_DRAIN_GRAY_STACK;      \
124         } while (0)