xref: /art/runtime/interpreter/mterp/mterp.h

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ART_RUNTIME_INTERPRETER_MTERP_MTERP_H_
#define ART_RUNTIME_INTERPRETER_MTERP_MTERP_H_

#include <cstddef>
#include <cstdint>

/*
 * Mterp assembly handler bases
 */
extern "C" void* artMterpAsmInstructionStart[];
extern "C" void* artMterpAsmInstructionEnd[];
extern "C" void* artMterpAsmAltInstructionStart[];
extern "C" void* artMterpAsmAltInstructionEnd[];

namespace art {

class Thread;

namespace interpreter {

void InitMterpTls(Thread* self);
void CheckMterpAsmConstants();

// The return type should be 'bool' but our assembly stubs expect 'bool'
// to be zero-extended to the whole register and that's broken on x86-64
// as a 'bool' is returned in 'al' and the rest of 'rax' is garbage.
// TODO: Fix mterp and stubs and revert this workaround. http://b/30232671
extern "C" size_t MterpShouldSwitchInterpreters();

// Poison value for TestExportPC.  If we segfault with this value, it means that a mterp
// handler for a recent opcode failed to export the Dalvik PC prior to a possible exit from
// the mterp environment.
constexpr uintptr_t kExportPCPoison = 0xdead00ff;
// Set true to enable poison testing of ExportPC.  Uses Alt interpreter.
constexpr bool kTestExportPC = false;

}  // namespace interpreter
}  // namespace art

#endif  // ART_RUNTIME_INTERPRETER_MTERP_MTERP_H_