disassembler/Disassembler.h

   1 /*
   2  * Copyright (C) 2012, 2013, 2015 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef Disassembler_h
  27 #define Disassembler_h
  28
  29 #include <functional>
  30 #include <wtf/PrintStream.h>
  31 #include <wtf/text/CString.h>
  32
  33 namespace JSC {
  34
  35 class MacroAssemblerCodePtr;
  36 class MacroAssemblerCodeRef;
  37
  38 enum InstructionSubsetHint { MacroAssemblerSubset, LLVMSubset };
  39
  40 #if ENABLE(DISASSEMBLER)
  41 bool tryToDisassemble(const MacroAssemblerCodePtr&, size_t, const char* prefix, PrintStream&, InstructionSubsetHint = MacroAssemblerSubset);
  42 #else
  43 inline bool tryToDisassemble(const MacroAssemblerCodePtr&, size_t, const char*, PrintStream&, InstructionSubsetHint = MacroAssemblerSubset)
  44 {
  45     return false;
  46 }
  47 #endif
  48
  49 // Prints either the disassembly, or a line of text indicating that disassembly failed and
  50 // the range of machine code addresses.
  51 void disassemble(const MacroAssemblerCodePtr&, size_t, const char* prefix, PrintStream& out, InstructionSubsetHint = MacroAssemblerSubset);
  52
  53 // Asynchronous disassembly. This happens on another thread, and calls the provided
  54 // callback when the disassembly is done.
  55 void disassembleAsynchronously(
  56     const CString& header, const MacroAssemblerCodeRef&, size_t, const char* prefix,
  57     InstructionSubsetHint = MacroAssemblerSubset);
  58
  59 JS_EXPORT_PRIVATE void waitForAsynchronousDisassembly();
  60
  61 } // namespace JSC
  62
  63 #endif // Disassembler_h
  64