1 /*
2  * Copyright (C) 2017 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_BASE_CALLEE_SAVE_TYPE_H_
18 #define ART_RUNTIME_BASE_CALLEE_SAVE_TYPE_H_
19 
20 #include <cstdint>
21 #include <iosfwd>
22 
23 #include "base/macros.h"
24 
25 namespace art HIDDEN {
26 
27 // Returns a special method that describes all callee saves being spilled to the stack.
28 enum class CalleeSaveType : uint32_t {
29   kSaveAllCalleeSaves,  // All callee-save registers.
30   kSaveRefsOnly,        // Only those callee-save registers that can hold references.
31   kSaveRefsAndArgs,     // References (see above) and arguments (usually caller-save registers).
32   kSaveEverything,      // All registers, including both callee-save and caller-save.
33   kSaveEverythingForClinit,    // Special kSaveEverything for clinit.
34   kSaveEverythingForSuspendCheck,  // Special kSaveEverything for suspend check.
35   kLastCalleeSaveType   // Value used for iteration.
36 };
37 std::ostream& operator<<(std::ostream& os, CalleeSaveType rhs);
38 
GetCanonicalCalleeSaveType(CalleeSaveType type)39 static inline constexpr CalleeSaveType GetCanonicalCalleeSaveType(CalleeSaveType type) {
40   if (type == CalleeSaveType::kSaveEverythingForClinit ||
41       type == CalleeSaveType::kSaveEverythingForSuspendCheck) {
42     return CalleeSaveType::kSaveEverything;
43   }
44   return type;
45 }
46 
47 }  // namespace art
48 
49 #endif  // ART_RUNTIME_BASE_CALLEE_SAVE_TYPE_H_
50