You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
57 lines
2.1 KiB
57 lines
2.1 KiB
/*BEGIN_LEGAL
|
|
Copyright 2002-2019 Intel Corporation.
|
|
|
|
This software and the related documents are Intel copyrighted materials, and your
|
|
use of them is governed by the express license under which they were provided to
|
|
you ("License"). Unless the License provides otherwise, you may not use, modify,
|
|
copy, publish, distribute, disclose or transmit this software or the related
|
|
documents without Intel's prior written permission.
|
|
|
|
This software and the related documents are provided as is, with no express or
|
|
implied warranties, other than those that are expressly stated in the License.
|
|
END_LEGAL */
|
|
|
|
/// @file xed-ild.h
|
|
/// instruction length decoder
|
|
|
|
#if !defined(XED_ILD_H)
|
|
# define XED_ILD_H
|
|
#include "xed-common-hdrs.h"
|
|
#include "xed-common-defs.h"
|
|
#include "xed-portability.h"
|
|
#include "xed-types.h"
|
|
#include "xed-decoded-inst.h"
|
|
|
|
#include "xed-operand-accessors.h"
|
|
|
|
|
|
/// This function just does instruction length decoding.
|
|
/// It does not return a fully decoded instruction.
|
|
/// @param xedd the decoded instruction of type #xed_decoded_inst_t .
|
|
/// Mode/state sent in via xedd; See the #xed_state_t .
|
|
/// @param itext the pointer to the array of instruction text bytes
|
|
/// @param bytes the length of the itext input array.
|
|
/// 1 to 15 bytes, anything more is ignored.
|
|
/// @return #xed_error_enum_t indicating success (#XED_ERROR_NONE) or
|
|
/// failure.
|
|
/// Only two failure codes are valid for this function:
|
|
/// #XED_ERROR_BUFFER_TOO_SHORT and #XED_ERROR_GENERAL_ERROR.
|
|
/// In general this function cannot tell if the instruction is valid or
|
|
/// not. For valid instructions, XED can figure out if enough bytes were
|
|
/// provided to decode the instruction. If not enough were provided,
|
|
/// XED returns #XED_ERROR_BUFFER_TOO_SHORT.
|
|
/// From this function, the #XED_ERROR_GENERAL_ERROR is an indication
|
|
/// that XED could not decode the instruction's length because the
|
|
/// instruction was so invalid that even its length
|
|
/// may across implmentations.
|
|
///
|
|
/// @ingroup DEC
|
|
XED_DLL_EXPORT xed_error_enum_t
|
|
xed_ild_decode(xed_decoded_inst_t* xedd,
|
|
const xed_uint8_t* itext,
|
|
const unsigned int bytes);
|
|
|
|
|
|
#endif
|
|
|