misc/decoder_test/XED2/include/xed-disas.h

   1 /*BEGIN_LEGAL
   2 Intel Open Source License
   3
   4 Copyright (c) 2002-2007 Intel Corporation
   5 All rights reserved.
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are
   8 met:
   9
  10 Redistributions of source code must retain the above copyright notice,
  11 this list of conditions and the following disclaimer.  Redistributions
  12 in binary form must reproduce the above copyright notice, this list of
  13 conditions and the following disclaimer in the documentation and/or
  14 other materials provided with the distribution.  Neither the name of
  15 the Intel Corporation nor the names of its contributors may be used to
  16 endorse or promote products derived from this software without
  17 specific prior written permission.
  18
  19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
  23 ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 END_LEGAL */
  31 /// @file xed-disas.h
  32 /// @author Mark Charney <mark.charney@intel.com>
  33
  34 #if !defined(_XED_DISAS_H_)
  35 # define _XED_DISAS_H_
  36
  37 #include "xed-types.h"
  38
  39 /// @ingroup PRINT
  40 /// A #xed_disassembly_callback_fn_t takes an address, a pointer to a
  41 /// symbol buffer of buffer_length bytes, and a pointer to an offset. The
  42 /// function fills in the symbol_buffer and sets the offset to the desired
  43 /// offset for that symbol.  If the function succeeds, it returns 1.
  44 //  The call back should return 0 if the buffer is not long enough to
  45 //  include the null termination.If no symbolic information is
  46 //  located, the function returns zero.
  47 ///  @param address The input address for which we want symbolic name and offset
  48 ///  @param symbol_buffer A buffer to hold the symbol name. The callback function should fill this in and terminate
  49 ///                       with a null byte.
  50 ///  @param buffer_length The maximum length of the symbol_buffer including then null
  51 ///  @param offset A pointer to a xed_uint64_t to old the offset from the provided symbol.
  52 ///  @param context This void* pointer passed to the disassembler's new interface so that the caller can identify
  53 ///                     the proper context against which to resolve the symbols.
  54 ///                     The disassembler passes this value to
  55 ///                     the callback. The legacy formatters
  56 ///                     that do not have context will pass zero for this parameter.
  57 ///  @return 0 on failure, 1 on success.
  58 typedef  int XED_DLL_EXPORT (*xed_disassembly_callback_fn_t)(
  59     xed_uint64_t  address,
  60     char*         symbol_buffer,
  61     xed_uint32_t  buffer_length,
  62     xed_uint64_t* offset,
  63     void*         context);
  64
  65 /// @ingroup PRINT
  66 /// Register a disassembly call back function of type
  67 /// #xed_disassembly_callback_fn_t to get called when the disassembler
  68 /// needs to get a symbol and offset for an address.
  69 XED_DLL_EXPORT void xed_register_disassembly_callback(xed_disassembly_callback_fn_t f);
  70
  71 #endif