object_callbacks.h revision f85c2fb317399ab540854cd7551ac47690366543 
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ART_RUNTIME_OBJECT_CALLBACKS_H_
18#define ART_RUNTIME_OBJECT_CALLBACKS_H_
19
20// For ostream.
21#include <ostream>
22// For uint32_t.
23#include <stdint.h>
24// For size_t.
25#include <stdlib.h>
26
27namespace art {
28namespace mirror {
29  class Class;
30  class Object;
31  template<class MirrorType> class HeapReference;
32  class Reference;
33}  // namespace mirror
34class StackVisitor;
35
36enum RootType {
37  kRootUnknown = 0,
38  kRootJNIGlobal,
39  kRootJNILocal,
40  kRootJavaFrame,
41  kRootNativeStack,
42  kRootStickyClass,
43  kRootThreadBlock,
44  kRootMonitorUsed,
45  kRootThreadObject,
46  kRootInternedString,
47  kRootDebugger,
48  kRootVMInternal,
49  kRootJNIMonitor,
50};
51std::ostream& operator<<(std::ostream& os, const RootType& root_type);
52
53// Returns the new address of the object, returns root if it has not moved. tid and root_type are
54// only used by hprof.
55typedef void (RootCallback)(mirror::Object** root, void* arg, uint32_t thread_id,
56    RootType root_type);
57// A callback for visiting an object in the heap.
58typedef void (ObjectCallback)(mirror::Object* obj, void* arg);
59// A callback used for marking an object, returns the new address of the object if the object moved.
60typedef mirror::Object* (MarkObjectCallback)(mirror::Object* obj, void* arg)
61    __attribute__((warn_unused_result));
62// A callback for verifying roots.
63typedef void (VerifyRootCallback)(const mirror::Object* root, void* arg, size_t vreg,
64    const StackVisitor* visitor, RootType root_type);
65
66typedef void (MarkHeapReferenceCallback)(mirror::HeapReference<mirror::Object>* ref, void* arg);
67typedef void (DelayReferenceReferentCallback)(mirror::Class* klass, mirror::Reference* ref, void* arg);
68
69// A callback for testing if an object is marked, returns nullptr if not marked, otherwise the new
70// address the object (if the object didn't move, returns the object input parameter).
71typedef mirror::Object* (IsMarkedCallback)(mirror::Object* object, void* arg)
72    __attribute__((warn_unused_result));
73
74// Returns true if the object in the heap reference is marked, if it is marked and has moved the
75// callback updates the heap reference contain the new value.
76typedef bool (IsHeapReferenceMarkedCallback)(mirror::HeapReference<mirror::Object>* object,
77    void* arg) __attribute__((warn_unused_result));
78typedef void (ProcessMarkStackCallback)(void* arg);
79
80}  // namespace art
81
82#endif  // ART_RUNTIME_OBJECT_CALLBACKS_H_
83